NAME

Data::Sah::Resolve - Resolve Sah schema

VERSION

This document describes version 0.005 of Data::Sah::Resolve (from Perl distribution Data-Sah-Resolve), released on 2017-04-16.

SYNOPSIS

use Data::Sah::Resolve qw(resolve_schema);

my $sch = resolve_schema("int");
# => ["int", []]

my $sch = resolve_schema("posint*");
# => ["int", [{min=>1}, {req=>1}]

my $sch = resolve_schema([posint => div_by => 3]);
# => ["int", {min=>1}, {div_by=>3}]

my $sch = resolve_schema(["posint", "merge.delete.min"=>undef, div_by => 3]);
# => ["int", {div_by=>3}]

DESCRIPTION

FUNCTIONS

resolve_schema([ \%opts, ] $sch) => sch

Sah schemas can be defined in terms of other schema. The resolving process follows the base schema recursively until it finds a builtin type as the base.

This routine: 1) normalizes the schema (unless schema_is_normalized option is true, in which case schema is assumed to be normalized already); 2) checks schema's type to see if it's the name of another schema (searched in Sah::Schema::<name> module); 3) if schema's type is another schema then retrieve the base schema and repeat the process while accumulating/ and/or merging the clause sets; 4) if schema's type is a known builtin type, stop; 5) if schema's type is neither, die.

Returns [base_type, clause_sets]. If return_intermediates option is true, then the third elements will be the list of intermediate schema names.

Known options:

  • schema_is_normalized => bool (default: 0)

    When set to true, function will skip normalizing schema and assume input schema is normalized.

  • merge_clause_sets => bool (default: 1)

  • return_intermediates => bool

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Data-Sah-Resolve.

SOURCE

Source repository is at https://github.com/perlancar/perl-Data-Sah-Resolve.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Sah-Resolve

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

Sah, Data::Sah

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017, 2016 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.