/ 
JIP-DataPath-0.01
River stage zero No dependents
/ JIP::DataPath

NAME

JIP::DataPath - provides a way to access data elements in a deep, complex and nested data structure.

VERSION

This document describes JIP::DataPath version 0.01.

SYNOPSIS

use JIP::DataPath qw(path);

path({foo => 42})->get(['foo']); # 42

path({foo => 42})->contains(['foo']); # True

my $document = {foo => 42};
if (path($document)->set(['foo'], 100500)) {
    path($document)->perform('get', ['foo']); # 100500
}

ATTRIBUTES

JIP::DataPath implements the following attributes.

document

my $document = $pointer->document;

Data structure to be processed.

SUBROUTINES/METHODS

new

my $data_path = JIP::DataPath->new(document => {foo => 'bar'});

Build new JIP::DataPath object.

get

# undef
JIP::DataPath->new(document => undef)->get([]);

# 42
JIP::DataPath->new(document => 42)->get([]);

# {foo => 'bar'}
JIP::DataPath->new(document => {foo => 'bar'})->get([]);

# 'bar'
JIP::DataPath->new(document => {foo => 'bar'})->get(['foo']);

# 'bar'
JIP::DataPath->new(document => ['foo', 'bar'])->get([1]);

Extract value from "document" identified by the given path.

set

# True
JIP::DataPath->new(document => undef)->set([], {foo => undef});
JIP::DataPath->new(document => {foo => undef})->set(['foo'], {bar => undef});
JIP::DataPath->new(document => {foo => {bar => undef}})->set(['foo', 'bar'], []);
JIP::DataPath->new(document => {foo => {bar => []}})->set(['foo', 'bar'], [undef]);
JIP::DataPath->new(document => {foo => {bar => [undef]}})->set(['foo', 'bar', 0], 42);

Sets the value at the specified path.

contains

# True
JIP::DataPath->new(document => undef)->contains([]);
JIP::DataPath->new(document => 42)->contains([]);
JIP::DataPath->new(document => {foo => 'bar'})->contains([]);
JIP::DataPath->new(document => {foo => 'bar'})->contains(['foo']);
JIP::DataPath->new(document => ['foo', 'bar'])->contains([1]);

# False
JIP::DataPath->new(document => {foo => 'bar'})->contains(['wtf']);
JIP::DataPath->new(document => ['foo', 'bar'])->contains([42]);

Check if "document" contains a value that can be identified with the given path.

perform

# 42
JIP::DataPath->new(document => 42)->perform('get', []);

# True
JIP::DataPath->new(document => 42)->perform('set', [], 100500);
JIP::DataPath->new(document => 42)->perform('contains', []);

EXPORTABLE FUNCTIONS

These functions are exported only by request.

path

use JIP::DataPath;

JIP::DataPath::path({foo => 42})->get(['foo']);
JIP::DataPath::path({foo => 42})->set(['foo'], 100500);
JIP::DataPath::path({foo => 42})->contains(['foo']);
JIP::DataPath::path({foo => 42})->perform('contains', ['foo']);

or exported on demand via

use JIP::DataPath qw(path);

path({foo => 42})->get(['foo']);
path({foo => 42})->set(['foo'], 100500);
path({foo => 42})->contains(['foo']);
path({foo => 42})->perform('contains', ['foo']);

Alias of JIP::DataPath->new(document => {}). It creates a JIP::DataPath object.

DIAGNOSTICS

None.

CONFIGURATION AND ENVIRONMENT

JIP::DataPath requires no configuration files or environment variables.

SEE ALSO

Data::Focus, Data::PathSimple, Data::SimplePath

AUTHOR

Vladimir Zhavoronkov, <flyweight at yandex.ru>

LICENSE AND COPYRIGHT

Copyright 2018 Vladimir Zhavoronkov.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.