File Coverage

blib/lib/Data/Zipper/API.pm

Criterion	Covered	Total	%
statement	25	25	100.0
branch			n/a
condition			n/a
subroutine	9	9	100.0
pod	4	4	100.0
total	38	38	100.0

package Data::Zipper::API;
BEGIN {
  $Data::Zipper::API::VERSION = '0.02';
}

use warnings FATAL => 'all';
use MooseX::Role::Parameterized;
use namespace::autoclean;

parameter 'type' => (
    required => 1
);

role {

use MooseX::Types::Moose qw( ArrayRef );

my $params = shift;

requires 'traverse', 'reconstruct';

has path => (
    is => 'bare',
    isa => ArrayRef[ $params->type ],
    default => sub { [] },
    traits => [ 'Array' ],
    handles => {
        path => 'elements'
    }
);

has focus => (
    is => 'ro',
    required => 1
);

around traverse => sub {
    my ($traverser, $self, @args) = @_;
    my ($focus, $path) = $self->$traverser(@args);
    return $self->meta->new_object(
        focus => $focus,
        path => [
            $path,
            $self->path
        ]
    );
};

sub set {
    my ($self, $new_value) = @_;
    return $self->meta->new_object(
        path => [ $self->path ],
        focus => $new_value
    )
}

sub set_via {
    my ($self, $code) = @_;
    local $_ = $self->focus;
    $self->set($code->($self->focus));
}

sub up {
    my $self = shift;
    my ($path, @rest) = $self->path;
    return $self->meta->new_object(
        focus => $self->reconstruct($self->focus, $path),
        path => \@rest
    );
}

sub zip {
    my $zipper = shift;

    while ($zipper->path) {
        $zipper = $zipper->up;
    }
    return $zipper->focus;
}

};

1;


__END__
=pod

=encoding utf-8

=head1 NAME

Data::Zipper::API

=head1 SYNOPSIS

    package Person;
    use Moose;

    has name => ( is => 'ro' );

    package MyApp;
    use Data::Zipper::MOP;

    my $person = Person->new( name => 'John' )
    my $sally = Data::Zipper::MOP->new( focus => $person)
        ->traverse('name')->set('Sally')
        ->up
        ->focus;

=head1 ATTRIBUTES

=head2 focus

Get the value of the current point in the data structure being focused on (as
navigated to by L<traverse>)

=head1 METHODS

=head2 traverse

Traverse deeper into the data structure under focus.

=head2 up

Move "up" a level from the current traversal. Has the effect of unwinding
the last traversal.

=head2 set

Replace the value of the current node with a new value.

=head2 set_via

Replace the value of the current node by executing a code reference.

C<$_> will be bound to the current value of the node during execution, and
the code reference will also be passed this via the first argument.

=head2 zip

Repeatedly moves back up the paths traversed, which has the effect of
returning back to the same structure as the original input.

=head1 AUTHOR

Oliver Charles

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Oliver Charles <[e-mail]>.

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