—package
HashDataRole::Spec::Basic;
use
strict;
use
Role::Tiny;
use
Role::Tiny::With;
our
$AUTHORITY
=
'cpan:PERLANCAR'
;
# AUTHORITY
our
$DATE
=
'2024-01-22'
;
# DATE
our
$DIST
=
'HashData'
;
# DIST
our
$VERSION
=
'0.1.2'
;
# VERSION
# constructor
requires
'new'
;
# mixin
# provides
my
@role_prefixes
=
qw(HashDataRole Role::TinyCommons::Collection)
;
sub
apply_roles {
my
(
$obj
,
@unqualified_roles
) =
@_
;
my
@roles_to_apply
;
ROLE:
for
my
$ur
(
@unqualified_roles
) {
PREFIX:
for
my
$prefix
(
@role_prefixes
) {
my
(
$mod
,
$modpm
);
$mod
=
"$prefix\::$ur"
;
(
$modpm
=
"$mod.pm"
) =~ s!::!/!g;
eval
{
require
$modpm
; 1 };
unless
($@) {
#print "D:$mod\n";
push
@roles_to_apply
,
$mod
;
next
ROLE;
}
}
die
"Can't find role '$ur' to apply (searched these prefixes: "
.
join
(
", "
,
@role_prefixes
);
}
Role::Tiny->apply_roles_to_object(
$obj
,
@roles_to_apply
);
# return something useful
$obj
;
}
###
1;
# ABSTRACT: Required methods for all HashData::* classes
__END__
=pod
=encoding UTF-8
=head1 NAME
HashDataRole::Spec::Basic - Required methods for all HashData::* classes
=head1 VERSION
This document describes version 0.1.2 of HashDataRole::Spec::Basic (from Perl distribution HashData), released on 2024-01-22.
=head1 DESCRIPTION
L<HashData>::* classes let you iterate pairs using a resettable iterator
interface (L<Role::TinyCommons::Iterator::Resettable>) as well as get values by
key (L<Role::TinyCommons::Collection::GetItemByPos>), like what a regular Perl
hash lets you.
=head1 ROLES MIXED IN
L<Role::TinyCommons::Iterator::Resettable>
L<Role::TinyCommons::Collection::GetItemByKey>
=head1 REQUIRED METHODS
=head2 new
Usage:
my $ary = HashData::Foo->new([ %args ]);
Constructor. Must accept a pair of argument names and values.
=head2 get_next_item
From L<Role::TinyCommons::Iterator::Resettable>. Will return an array(ref)
containing two elements: C<< [$key, $value] >>.
=head2 has_next_item
From L<Role::TinyCommons::Iterator::Resettable>.
=head2 reset_iterator
From L<Role::TinyCommons::Iterator::Resettable>.
=head2 get_item_at_key
From L<Role::TinyCommons::Collection::GetItemByKey>.
=head2 has_item_at_key
From L<Role::TinyCommons::Collection::GetItemByKey>.
=head2 has_item_at_key
Alias for L</has_item_at_key>, From
L<Role::TinyCommons::Collection::GetItemByKey>.
=head2 get_all_keys
From L<Role::TinyCommons::Collection::GetItemByKey>.
=head1 PROVIDED METHODS
=head2 apply_roles
Usage:
$obj->apply_roles('R1', 'R2', ...)
Apply roles to object. R1, R2, ... are unqualified role names that will be
searched under C<HashDataRole::*> or C<Role::TinyCommons::Collection::*>
namespace. It's a convenience shortcut for C<< Role::Tiny->apply_roles_to_object
>>.
Return the object, so you can do something like this:
my $obj = HashData::Dict::ID::KBBI->new->apply_roles('FindItem::Iterator', 'PickItems::Iterator');
my $obj = HashData::Word::ID::KBBI->new->apply_roles('BinarySearch::LinesInHandle');
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/HashData>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-HashData>.
=head1 SEE ALSO
L<Role::TinyCommons::Iterator::Resettable>
L<Role::TinyCommons::Collection::GetItemByPos>
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull requests on
GitHub.
Most of the time, you don't need to build the distribution yourself. You can
simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your
system), you can install L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
L<Pod::Weaver::PluginBundle::Author::PERLANCAR>, and sometimes one or two other
Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond
that are considered a bug and can be reported to me.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2024, 2021 by perlancar <perlancar@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.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=HashData>
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.
=cut