/ 
Sah-Schemas-JSON-0.007
River stage three • 10 direct dependents • 155 total dependents
/ Sah::Schema::json_str

NAME

Sah::Schema::json_str - A string that contains valid JSON

VERSION

This document describes version 0.007 of Sah::Schema::json_str (from Perl distribution Sah-Schemas-JSON), released on 2022-11-15.

SYNOPSIS

Sample data and validation results against this schema

""  # INVALID (Empty string is not a valid JSON)

1  # valid

"true"  # valid

"foo"  # INVALID (Not a valid JSON literal)

"\"foo\""  # valid (A JSON-encoded string)

"[1,2,3,{}]"  # valid

"[1,2"  # INVALID (Missing closing square bracket)

"[1,2,]"  # INVALID (Dangling comma)

Using with Data::Sah

To check data against this schema (requires Data::Sah):

use Data::Sah qw(gen_validator);
my $validator = gen_validator("json_str*");
say $validator->($data) ? "valid" : "INVALID!";

The above schema returns a boolean result (true if data is valid, false if otherwise). To return an error message string instead (empty string if data is valid, a non-empty error message otherwise):

my $validator = gen_validator("json_str", {return_type=>'str_errmsg'});
my $errmsg = $validator->($data);

# a sample valid data
$data = "[1,2,3,{}]";
my $errmsg = $validator->($data); # => ""

# a sample invalid data
$data = "[1,2,]";
my $errmsg = $validator->($data); # => "String is not a valid JSON: malformed JSON string, neither tag, array, object, number, string or atom, at character offset 5 (before \"]\") at (eval 2551) line 13.\n"

Often a schema has coercion rule or default value, so after validation the validated value is different. To return the validated (set-as-default, coerced, prefiltered) value:

my $validator = gen_validator("json_str", {return_type=>'str_errmsg+val'});
my $res = $validator->($data); # [$errmsg, $validated_val]

# a sample valid data
$data = "[1,2,3,{}]";
my $res = $validator->($data); # => ["","[1,2,3,{}]"]

# a sample invalid data
$data = "[1,2,]";
my $res = $validator->($data); # => ["String is not a valid JSON: malformed JSON string, neither tag, array, object, number, string or atom, at character offset 5 (before \"]\") at (eval 2557) line 13.\n","[1,2,]"]

Data::Sah can also create validator that returns a hash of detailed error message. Data::Sah can even create validator that targets other language, like JavaScript, from the same schema. Other things Data::Sah can do: show source code for validator, generate a validator code with debug comments and/or log statements, generate human text from schema. See its documentation for more details.

Using with Params::Sah

To validate function parameters against this schema (requires Params::Sah):

use Params::Sah qw(gen_validator);

sub myfunc {
    my @args = @_;
    state $validator = gen_validator("json_str*");
    $validator->(\@args);
    ...
}

Using with Perinci::CmdLine::Lite

To specify schema in Rinci function metadata and use the metadata with Perinci::CmdLine (Perinci::CmdLine::Lite) to create a CLI:

# in lib/MyApp.pm
package
  MyApp;
our %SPEC;
$SPEC{myfunc} = {
    v => 1.1,
    summary => 'Routine to do blah ...',
    args => {
        arg1 => {
            summary => 'The blah blah argument',
            schema => ['json_str*'],
        },
        ...
    },
};
sub myfunc {
    my %args = @_;
    ...
}
1;

# in myapp.pl
package
  main;
use Perinci::CmdLine::Any;
Perinci::CmdLine::Any->new(url=>'/MyApp/myfunc')->run;

# in command-line
% ./myapp.pl --help
myapp - Routine to do blah ...
...

% ./myapp.pl --version

% ./myapp.pl --arg1 ...

Using with Type::Tiny

To create a type constraint and type library from a schema:

package My::Types {
    use Type::Library -base;
    use Type::FromSah qw( sah2type );

    __PACKAGE__->add_type(
        sah2type('$sch_name*', name=>'JsonStr')
    );
}

use My::Types qw(JsonStr);
JsonStr->assert_valid($data);

DESCRIPTION

This schema can be used if you want to accept a string that contains valid JSON. The JSON string will not be decoded (e.g. a JSON-encoded array will not beome an array) but you know that the string contains a valid JSON. Data will not be valid if the string does not contain valid JSON.

See also related schema: json_or_str, str::encoded_json, str::escaped_json.

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-Sah-Schemas-JSON.

SEE ALSO

Sah::Schema::json_or_str

Sah::Schema::str::encoded_json

Sah::Schema::str::escaped_json

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2021 by perlancar <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.

BUGS

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

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.