File Coverage

blib/lib/BenchmarkAnything/Schema.pm

Criterion	Covered	Total	%
statement	25	25	100.0
branch	2	2	100.0
condition	2	3	66.6
subroutine	4	4	100.0
pod	1	1	100.0
total	34	35	97.1

use 5.008;
use strict;
use warnings;
package BenchmarkAnything::Schema;
# git description: v0.002-1-g978c3c0

our $AUTHORITY = 'cpan:SCHWIGON';
# ABSTRACT: Tooling to handle the "BenchmarkAnything" schema
$BenchmarkAnything::Schema::VERSION = '0.004';


sub valid_json_schema {
    my ($data_or_json) = @_;

    require File::Slurper;
    require File::ShareDir;
    require JSON::MaybeXS;
    require JSON::Schema;
    require Scalar::Util;

    # decode JSON unless already given a HASH or ARRAY reference
    my $data;
    my $ref = Scalar::Util::reftype($data_or_json);
    if ($ref and $ref =~ /^HASH|ARRAY$/) {
        $data = $data_or_json;
    } else {
        $data = JSON::MaybeXS::decode_json($data_or_json);
    }

    my $schema_file = File::ShareDir::dist_file('BenchmarkAnything-Schema', 'benchmark-anything-schema.json');
    my $schema_json = File::Slurper::read_text($schema_file);
    my $schema      = JSON::MaybeXS::decode_json($schema_json);
    my $validator   = JSON::Schema->new($schema);
    my $result      = $validator->validate($data);

    return $result;
}

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

BenchmarkAnything::Schema - Tooling to handle the "BenchmarkAnything" schema

=head1 SYNOPSIS

 require BenchmarkAnything::Schema;

 if (my $result = BenchmarkAnything::Schema::valid_json_schema($input_data__or__raw_json_text))
 {
     print "Data structure is valid BenchmarkAnything data.\n";
 } else {
     print STDERR "JSON schema errors:\n";
     print STDERR " - $_\n" foreach $result->errors;
 }

=head2 valid_json_schema($data_or_json)

Validate if $data_or_json conforms to the BenchmarkAnything schema.

Returns a L<JSON::Schema::Result|JSON::Schema::Result> object which is
overloaded to behave and stringify sensibly, and also provides error
details.

=head1 AUTHOR

Steffen Schwigon <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Steffen Schwigon.

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

=cut