File Coverage

blib/lib/Tree/Object/Array/Glob.pm

Criterion	Covered	Total	%
statement	30	30	100.0
branch	1	2	50.0
condition			n/a
subroutine	6	6	100.0
pod			n/a
total	37	38	97.3

package Tree::Object::Array::Glob;

our $DATE = '2016-04-14'; # DATE
our $VERSION = '0.07'; # VERSION

use 5.010001;
use strict;
use warnings;

sub import {
    my ($class0, @attrs) = @_;

    my $caller = caller();

    my $code_str = "package $caller;\n";

    $code_str .= "use Class::Accessor::Array::Glob {\n";
    $code_str .= "    accessors => {\n";
    my $idx = 0;
    for (@attrs, "parent", "children") {
        $code_str .= "        '$_' => $idx,\n";
        $idx++;
    }
    $code_str .= "    },\n";
    $code_str .= "    glob_attribute => 'children',\n";
    $code_str .= "};\n";

    $code_str .= "use Role::Tiny::With;\n";
    $code_str .= "with 'Role::TinyCommons::Tree::NodeMethods';\n";

    #say $code_str;

    eval $code_str;
    die if $@;
}

1;
# ABSTRACT: An array-based tree object (variant)

__END__

=pod

=encoding UTF-8

=head1 NAME

Tree::Object::Array::Glob - An array-based tree object (variant)

=head1 VERSION

This document describes version 0.07 of Tree::Object::Array::Glob (from Perl distribution Tree-Object), released on 2016-04-14.

=head1 SYNOPSIS

In F<lib/My/ArrayTree.pm>:

 package My::ArrayTree;
 use Tree::Object::Array::Glob qw(attr1 attr2 attr3);
 1;

=head1 DESCRIPTION

This module lets you create an array-backed (instead of hash-backed) tree
object. Instead of subclassing C<Tree::Object::Hash>, you C<use> it in your
class and listing all the attributes you will need.

This module is a variation of L<Tree::Object::Array>. It uses
L<Class::Accessor::Array::Glob> instead of L<Class::Accessor::Array>. Instead
of storing data using:

 [$attr1, $attr2, ..., $parent, \@children]

it stores data as:

 [$attr1, $attr2, ..., $parent, @children]

This style of storage avoids creating an extra array for storing the children
and maintain a flat array instead. But one caveat is that your subclass won't be
able to introduce more attributes, because the C<children> attribute is a
"globbing" attribute at the end of the array.

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/Tree-Object>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-Tree-Object>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Tree-Object>

When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.

=head1 SEE ALSO

L<Tree::Object::Array>

=head1 AUTHOR

perlancar <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by [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