/ 
Data-Morph-1.112760
River stage zero No dependents
/ Data::Morph::Role::Backend

NAME

Data::Morph::Role::Backend - Provides a role to consume to develop specialized backends

VERSION

version 1.112760

SYNOPSIS

package Data::Morph::Backend::Object;
use Moose;
use MooseX::Types::Moose(':all');
use MooseX::Params::Validate;
use namespace::autoclean;

sub epilogue { }

with 'Data::Morph::Role::Backend' =>
{
    input_type => Object,
    get_val => sub
    {
        my ($obj, $key) = @_;
        return $obj->$key;
    },
    set_val => sub
    {
        my ($obj, $key, $val) = @_;
        $obj->$key($val);
    },
};

1;

DESCRIPTION

This module provides a simple composable behavior that backend authors must consume and fill out so that it operates seamlessly within a Data::Morph transformation

ROLE_PARAMETERS

input_type

isa: Moose::Meta::TypeConstraint
required: 1

To properly constrain "store" and "retrieve", a type constraint must be made available. This must match what "new_instance" generates.

set_val

isa: CodeRef, required: 1

This coderef should implement a set accessor to the type configured in "input_type". The coderef will receive the instance, the key, and the value as arguments and be executed in a void context.

get_val

isa: CodeRef, required: 1

This coderef should implement a get accessor to the type configured in "input_type". The coderef will receive the instance and the key as arguments. The return value will then be used by the system.

ROLE_REQUIRES

epilogue

This method is required for all backends (even if it is a no-op). Once processing is complete this method will be called with the final, populated instance. If additional processing should take place on the instance as a whole rather on individual properties of it, do it here.

PUBLIC_ATTRIBUTES

new_instance

is: ro, isa: CodeRef, required: 1

Each backend should provide a coderef or require one upon construction that is an instance factory. The instances returned must match "input_type". The instance factory will receive the raw input as the only argument to allow for dynamic instance creation.

input_type

is: ro, isa: Moose::Meta::TypeConstraint, default: role parameter

This attribute is provided so that users of the backend can process different types other than the default provided at role consumption

PUBLIC_METHODS

generate_instance

This method access "new_instance" and invokes it with the provided raw input as an argument, returning its return value

retrieve

(INSTANCE, Maybe[Str], CodeRef?)

This method is what fetches the value from the instance using "get_val". The optional coderef parameter is what is passed in from the map if it is defined for a read operation. The coderef must be called with the return value from "get_val". And its return value returned.

If an undefined key is given but a coderef is defined, the result from the coderef will be returned

store

(INSTANCE, Any, Str, CodeRef?)

This method takes the Defined value and sets it into the instance using the Str key. The optional coderef parameter is what is passed if defined in the map in a write operation. If it is provided, it must be called with the value and its return value ultimately used in the storage operation, "set_val"

AUTHOR

Nicholas R. Perez <nperez@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Nicholas R. Perez <nperez@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.