File Coverage

blib/lib/Venus/Schema.pm

Criterion	Covered	Total	%
statement	32	33	96.9
branch	1	4	25.0
condition	3	6	50.0
subroutine	10	10	100.0
pod	5	6	83.3
total	51	59	86.4

package Venus::Schema;

use 5.018;

use strict;
use warnings;

use Venus::Class 'attr', 'base';

base 'Venus::Kind::Utility';

# ATTRIBUTES

attr 'definition';

# BUILDERS

sub build_args {
  my ($self, $data) = @_;

  if (keys %$data == 1 && exists $data->{definition}) {
    return $data;
  }
  return {
    definition => $data,
  };
}

# METHODS

sub assert {
  my ($self) = @_;

  require Venus::Assert;

  my $assert = Venus::Assert->new('schema');

  return $assert->expression($assert->render('hashkeys', $self->definition));
}

sub check {
  my ($self, $data) = @_;

  my $assert = $self->assert;

  return $assert->check($data);
}

sub deduce {
  my ($self, $data) = @_;

  require Venus::Type;

  my $assert = $self->assert;

  return Venus::Type->new($assert->validate($data))->deduce_deep;
}

sub error {
  my ($self, $data) = @_;

  my $error = $self->catch('validate', $data);

  die $error if $error && !$error->isa('Venus::Assert::Error');

  return $error;
}

sub validate {
  my ($self, $data) = @_;

  my $assert = $self->assert;

  return $assert->validate($data);
}

1;



=head1 NAME

Venus::Schema - Schema Class

=cut

=head1 ABSTRACT

Schema Class for Perl 5

=cut

=head1 SYNOPSIS

  package main;

  use Venus::Schema;

  my $schema = Venus::Schema->new;

  # bless({...}, 'Venus::Schema')

=cut

=head1 DESCRIPTION

This package provides methods for validating whether objects and complex data
structures conform to a schema.

=cut

=head1 ATTRIBUTES

This package has the following attributes:

=cut

=head2 definition

  definition(HashRef $data) (HashRef)

The definition attribute is read-write, accepts C<(HashRef)> values, and is
optional.

I>

=over 4

=item definition example 1

  # given: synopsis

  package main;

  my $definition = $schema->definition({});

  # {}

=back

=over 4

=item definition example 2

  # given: synopsis

  # given: example-1 definition

  package main;

  $definition = $schema->definition;

  # {}

=back

=cut

=head1 INHERITS

This package inherits behaviors from:

L

=cut

=head1 METHODS

This package provides the following methods:

=cut

=head2 assert

  assert() (Assert)

The assert method builds and returns a L object based on the
L.

I>

=over 4

=item assert example 1

  # given: synopsis

  package main;

  my $assert = $schema->assert;

  # bless({...}, 'Venus::Assert')

=back

=over 4

=item assert example 2

  # given: synopsis

  package main;

  $schema->definition({
    name => 'string',
  });

  my $assert = $schema->assert;

  # bless({...}, 'Venus::Assert')

=back

=cut

=head2 check

  check(HashRef $data) (Bool)

The check method builds an assert object using L and returns the
result of the L method.

I>

=over 4

=item check example 1

  # given: synopsis

  package main;

  my $check = $schema->check;

  # 0

=back

=over 4

=item check example 2

  # given: synopsis

  package main;

  $schema->definition({
    name => 'string',
    role => {
      title => 'string',
      level => 'number',
    },
  });

  my $check = $schema->check({});

  # 0

=back

=over 4

=item check example 3

  # given: synopsis

  package main;

  $schema->definition({
    name => 'string',
    role => {
      title => 'string',
      level => 'number',
    },
  });

  my $check = $schema->check({
    name => 'someone',
    role => {},
  });

  # 0

=back

=over 4

=item check example 4

  # given: synopsis

  package main;

  $schema->definition({
    name => 'string',
    role => {
      title => 'string',
      level => 'number',
    },
  });

  my $check = $schema->check({
    name => 'someone',
    role => {
      title => 'engineer',
      level => 1,
    },
  });

  # 1

=back

=cut

=head2 deduce

  deduce(HashRef $data) (Hash)

The deduce method builds an assert object using L and validates the
value provided using L, passing the result to
L unless the validation throws an exception.

I>

=over 4

=item deduce example 1

  # given: synopsis

  package main;

  my $deduce = $schema->deduce;

  # Exception! (isa Venus::Assert::Error)

=back

=over 4

=item deduce example 2

  # given: synopsis

  package main;

  $schema->definition({
    name => 'string',
    role => {
      title => 'string',
      level => 'number',
    },
  });

  my $deduce = $schema->deduce({});

  # Exception! (isa Venus::Assert::Error)

=back

=over 4

=item deduce example 3

  # given: synopsis

  package main;

  $schema->definition({
    name => 'string',
    role => {
      title => 'string',
      level => 'number',
    },
  });

  my $deduce = $schema->deduce({
    name => 'someone',
    role => {},
  });

  # Exception! (isa Venus::Assert::Error)

=back

=over 4

=item deduce example 4

  # given: synopsis

  package main;

  $schema->definition({
    name => 'string',
    role => {
      title => 'string',
      level => 'number',
    },
  });

  my $deduce = $schema->deduce({
    name => 'someone',
    role => {
      title => 'engineer',
      level => 1,
    },
  });

  # bless({...}, 'Venus::Hash')

=back

=cut

=head2 error

  error(HashRef $data) (Error)

The error method builds an assert object using L and validates the
value provided using L, catching any error thrown and
returning it, otherwise returning undefined.

I>

=over 4

=item error example 1

  # given: synopsis

  package main;

  my $error = $schema->error;

  # Exception! (isa Venus::Assert::Error)

=back

=over 4

=item error example 2

  # given: synopsis

  package main;

  $schema->definition({
    name => 'string',
    role => {
      title => 'string',
      level => 'number',
    },
  });

  my $error = $schema->error({});

  # Exception! (isa Venus::Assert::Error)

=back

=over 4

=item error example 3

  # given: synopsis

  package main;

  $schema->definition({
    name => 'string',
    role => {
      title => 'string',
      level => 'number',
    },
  });

  my $error = $schema->error({
    name => 'someone',
    role => {},
  });

  # Exception! (isa Venus::Assert::Error)

=back

=over 4

=item error example 4

  # given: synopsis

  package main;

  $schema->definition({
    name => 'string',
    role => {
      title => 'string',
      level => 'number',
    },
  });

  my $error = $schema->error({
    name => 'someone',
    role => {
      title => 'engineer',
      level => 1,
    },
  });

  # undef

=back

=cut

=head2 validate

  validate(HashRef $data) (HashRef)

The validate method builds an assert object using L and validates the
value provided using L, returning the result unless the
validation throws an exception.

I>

=over 4

=item validate example 1

  # given: synopsis

  package main;

  my $validate = $schema->validate;

  # Exception! (isa Venus::Assert::Error)

=back

=over 4

=item validate example 2

  # given: synopsis

  package main;

  $schema->definition({
    name => 'string',
    role => {
      title => 'string',
      level => 'number',
    },
  });

  my $validate = $schema->validate({});

  # Exception! (isa Venus::Assert::Error)

=back

=over 4

=item validate example 3

  # given: synopsis

  package main;

  $schema->definition({
    name => 'string',
    role => {
      title => 'string',
      level => 'number',
    },
  });

  my $validate = $schema->validate({
    name => 'someone',
    role => {},
  });

  # Exception! (isa Venus::Assert::Error)

=back

=over 4

=item validate example 4

  # given: synopsis

  package main;

  $schema->definition({
    name => 'string',
    role => {
      title => 'string',
      level => 'number',
    },
  });

  my $validate = $schema->validate({
    name => 'someone',
    role => {
      title => 'engineer',
      level => 1,
    },
  });

  # {name => 'someone', role => {title => 'engineer', level => 1,},}

=back

=cut

=head1 AUTHORS

Awncorp, C

=cut

=head1 LICENSE

Copyright (C) 2000, Al Newkirk.

This program is free software, you can redistribute it and/or modify it under
the terms of the Apache license version 2.0.

=cut