++ed by:
KEEDI

1 PAUSE user(s)
1 non-PAUSE user(s).

Dave Rolsky

NAME

Specio::Constraint::Simple - Class for simple (non-parameterized or specialized) types

VERSION

version 0.11

SYNOPSIS

    my $str = t('Str');

    print $str->name(); # Str

    my $parent = $str->parent();

    if ( $str->value_is_valid($value) ) { ... }

    $str->validate_or_die($value);

    my $code = $str->inline_coercion_and_check('$_[0]');

DESCRIPTION

This class implements simple type constraints, constraints without special properties or parameterization.

It does not actually contain any real code of its own. The entire implementation is provided by the Specio::Constraint::Role::Interface role, but the primary API for type constraints is documented here.

All other type constraint classes in this distribution implement this API, except where otherwise noted.

API

This class provides the following methods.

Specio::Constraint::Simple->new(...)

This creates a new constraint. It accepts the following named parameters:

  • name => $name

    This is the type's name. The name is optional, but if provided it must be a string.

  • parent => $type

    The type's parent type. This must be an object which does the Specio::Constraint::Role::Interface role.

    This parameter is optional.

  • constraint => sub { ... }

    A subroutine reference implementing the constraint. It will be called as a method on the object and passed a single argument, the value to check.

    It should return true or false to indicate whether the value matches the constraint.

    This parameter is mutually exclusive with inline_generator.

    You can also pass this option with the key where in the parameter list.

  • inline_generator => sub { ... }

    This should be a subroutine reference which returns a string containing a single term. This code should not end in a semicolon. This code should implement the constraint.

    The generator will be called as a method on the constraint with a single argument. That argument is the name of the variable being coerced, something like '$_[0]' or '$var'.

    The inline generator is expected to include code to implement both the current type and all its parents. Typically, the easiest way to do this is to write a subroutine something like this:

      sub {
          my $self = shift;
          my $var  = shift;
    
          return $_[0]->parent()->inline_check( $_[1] )
              . ' and more checking code goes here';
      }

    This parameter is mutually exclusive with constraint.

    You can also pass this option with the key inline in the parameter list.

  • inline_environment => {}

    This should be a hash reference of variable names (with sigils) and values for that variable. The values should be references to the values of the variables.

    This environment will be used when compiling the constraint as part of a subroutine. The named variables will be captured as closures in the generated subroutine, using Eval::Closure.

    It should be very rare to need to set this in the constructor. It's more likely that a special type subclass would need to provide values that it generates internally.

    If you do set this, you are responsible for generating variable names that won't clash with anything else in the inlined code.

    This parameter defaults to an empty hash reference.

  • message_generator => sub { ... }

    A subroutine to generate an error message when the type check fails. The default message says something like "Validation failed for type named Int declared in package Specio::Library::Builtins (.../Specio/blib/lib/Specio/Library/Builtins.pm) at line 147 in sub named (eval) with value 1.1".

    You can override this to provide something more specific about the way the type failed.

    The subroutine you provide will be called as a subroutine, not as a method, with two arguments. The first is the description of the type (the bit in the message above that starts with "type named Int ..." and ends with "... in sub named (eval)". This description says what the thing is and where it was defined.

    The second argument is the value that failed the type check, after any coercions that might have been applied.

    You can also pass this option with the key message in the parameter list.

  • declared_at => $declared_at

    This parameter must be a Specio::DeclaredAt object.

    This parameter is required.

It is possible to create a type without a constraint of its own.

$type->name(), $type->parent()

Returns the value of these parameters as they were passed to the constructor.

$type->is_anon()

Returns false for named types, true otherwise.

$type->is_a_type_of($other_type)

Given a type object, this returns true if the type this method is called on is a descendant of that type or is that type.

$type->is_same_type_as($other_type)

Given a type object, this returns true if the type this method is called on is the same as that type.

$type->coercions()

Returns a list of Specio::Coercion objects which belong to this constraint.

$type->coercion_from_type($name)

Given a type name, this method returns a Specio::Coercion object which coerces from that type, if such a coercion exists.

$type->validate_or_die($value)

This method does nothing if the value is valid. If it is not, it throws a Specio::Exception.

$type->value_is_valid($value)

Returns true or false depending on whether the $value passes the type constraint.

$type->has_real_constraint()

This returns true if the type was created with a constraint or inline_generator parameter. This is used internally to skip type checks for types that don't actually implement a constraint.

$type->inline_check($var)

Given a variable name, this returns a string of code that implements the constraint. If the type is not inlinable, this method throws an error.

$type->id()

This is a unique id for the type as a string. This is useful if you need to make a hash key based on a type, for example.

$type->add_coercion($coercion)

This adds a new Specio::Coercion to the type. If the type already has a coercion from the same type as the new coercion, it will throw an error.

$type->has_coercion_from_type($other_type)

This method returns true if the type can coerce from the other type.

$type->coerce_value($value)

This attempts to coerce a value into a new value that matches the type. It checks all of the type's coercions. If it finds one which has a "from" type that accepts the value, it runs the coercion and returns the new value.

If it cannot find a matching coercion it returns the original value.

$type->inline_coercion_and_check($var)

Given a variable name, this returns a string of code and an environment hash that implements all of the type's coercions as well as the type check itself.

This will throw an exception unless both the type and all of its coercions are inlinable.

The generated code will throw a Specio::Exception if the type constraint fails. If the constraint passes, then the generated code returns the (possibly coerced) value.

The return value is a two-element list. The first element is the code. The second is a hash reference containing variables which need to be in scope for the code to work. This is intended to be passed to Eval::Closure's eval_closure subroutine.

The returned code is a single do { } block without a terminating semicolon.

$type->coercion_sub()

This method returns a sub ref that takes a single argument and applied all relevant coercions to it. This sub ref will use Sub::Quote if all the type's coercions are inlinable.

This method exists primarily for the benefit of Moo.

OVERLOADING

All constraints overloading subroutine de-referencing for the benefit of Moo. The returned subroutine uses Sub::Quote if the type constraint is inlinable.

ROLES

This role does the Specio::Constraint::Role::Interface, Specio::Role::Inlinable and MooseX::Clone roles.

AUTHOR

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2014 by Dave Rolsky.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)



Hosting generously
sponsored by Bytemark