blib/lib/Class/Mix.pm

filter: Statementstmt 98.6% 74 / 75 Branchbran 93.3% 28 / 30 Conditioncond 93.1% 27 / 29 MC/DCmcdc 78.5% 11 / 14 Subroutinesub 92.8% 13 / 14 Podpod 100% 2 / 2 totaltotal 94.5% 155 / 164 CC 29 SCAR 27.6
CC
29
Cov
96%
mix_class
25.0
genpkg
5.0
__ANON__
2.0
CRAP 15.8
↑ Summary
1 =head1 NAME
2  
3 Class::Mix - dynamic class mixing
4  
5 =head1 SYNOPSIS
6  
7 use Class::Mix qw(mix_class);
8  
9 $foobar_object = mix_class("Foo", "Bar")->new;
10 $digest_class = mix_class("Foo", "Bar", {prefix=>"Digest::"});
11  
12 use Class::Mix qw(genpkg);
13  
14 $package = genpkg;
15 $package = genpkg("Digest::Foo::");
16  
17 =head1 DESCRIPTION
18  
19 The C<mix_class> function provided by this module dynamically generates
20 `anonymous' classes with specified inheritance.
21  
22 =cut
23  
24 package Class::Mix;
25  
26 4 ▶{ use 5.006; }
Subroutine BEGIN: called CC=1 SCAR=0.0
27 4 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
28 4 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
29  
30 4 ▶use constant _DO_MRO => "$]" >= 5.009005;
Subroutine BEGIN: called CC=1 SCAR=0.0
31  
32 4 ▶use Carp qw(croak);
Subroutine BEGIN: called CC=1 SCAR=0.0
33 4 ▶use Params::Classify 0.000 qw(is_undef is_string is_ref);
Subroutine BEGIN: called CC=1 SCAR=0.0
34 4 ▶use if _DO_MRO, "mro";
Subroutine BEGIN: called CC=1 SCAR=0.0
35  
36 4 our $VERSION = "0.006";
37  
38 4 ▶use parent "Exporter";
Subroutine BEGIN: called CC=1 SCAR=0.0
39 4 our @EXPORT_OK = qw(mix_class genpkg);
40  
41 4 ▶BEGIN {
Subroutine BEGIN: called CC=1 SCAR=0.0
42 4 if(_DO_MRO) {
43 4 *_get_mro = \&mro::get_mro;
44 } else {
45 0 ▶ *_get_mro = sub ($) { "dfs" };
Subroutine __ANON__: not called CC=1 SCAR=6.9
46 }
47 }
48  
49 4 my $prefix_rx = qr/(?:[a-zA-Z_][0-9a-zA-Z_]*::(?:[0-9a-zA-Z_]+::)*)?/;
50  
51 =head1 FUNCTIONS
52  
53 =over
54  
55 =item mix_class(ITEMS ...)
56  
57 This function is used to dynamically generate `anonymous' classes by
58 mixing pre-existing classes. This is useful where an incomplete class
59 requires use of a mixin in order to become instantiable, several suitable
60 mixins are available, and it is desired to make the choice between mixins
61 at runtime.
62  
63 Each I<ITEM> in the argument list is either the name of a class to inherit
64 from (a parent class) or a reference to a hash of options. The C<@ISA>
65 list of the mixture class is set to the list of parent class names,
66 in the order supplied. The options that may be supplied are:
67  
68 =over
69  
70 =item B<mro>
71  
72 Specifies the desired method resolution order (MRO) of the mixture class.
73 See L<mro> for details of the valid values and the default determined
74 by Perl. Typically, this should be set to B<c3> if mixing into an
75 existing C3-based class hierarchy.
76  
77 =item B<prefix>
78  
79 Specifies where the resulting package will go. May be C<undef> to
80 indicate that the caller doesn't care (which is the default state).
81 Otherwise it must be either the empty string (to create a top-level
82 package) or a bareword followed by "::" (to create a package under
83 that name). For example, "Digest::" could be specified to ensure that
84 the resulting package has a name starting with "Digest::", so that C<<
85 Digest->new >> will accept it as the name of a message digest algorithm.
86  
87 =back
88  
89 The function generates a class of the form described by the arguments, and
90 returns its name. The same class will be returned by repeated invocations
91 with the same parent class list and options. The returned name may be
92 used to call a constructor or other class methods of the mixed class.
93  
94 A class name must be returned because there is no such thing as an
95 anonymous class in Perl. Classes are referenced by name. The names
96 that are generated by this function are unique and insignificant.
97 See C<genpkg> below for more information.
98  
99 If fewer than two classes to inherit from are specified, the function
100 tries to avoid generating a separate class for the mixture. If only
101 one parent class is specified then that class may be returned, and if
102 no parent classes are specified then C<UNIVERSAL> may be returned.
103 This provides the desired inheritance without creating superfluous
104 classes. These special cases only apply if the options are compatible
105 with the pre-existing class.
106  
107 This function relies on the classes it returns remaining unmodified in
108 order to be returned by future invocations. If you want to modify your
109 dynamically-generated `anonymous' classes, use C<genpkg> (below).
110  
111 =cut
112  
113 sub genpkg(;$);
114  
115 4 my %mixtures;
116 62 ▶sub mix_class(@) {
Subroutine mix_class: called CC=25 SCAR=32.2
Pod documented
117 62 my @parents;
118 my %options;
119 62 foreach(@_) {
120 110 ▶ if(is_string($_)) {
Branch: 2 branches
BranchTrueFalseTotal
if (rand $_) { } 63 47 110
elsif (rand $_) { } 45 2 47
121 63 push @parents, $_;
122 } elsif(is_ref($_, "HASH")) {
123 45 foreach my $k (keys %$_) {
124 croak "clashing option `$k'"
125 39 ▶ if exists $options{$k};
Branch: 1 branch
BranchTrueFalseTotal
if exists $options{$k} 0 39 39
126 39 $options{$k} = $_->{$k};
127 }
128 } else {
129 2 croak "bad argument for mix_class";
130 }
131 }
132 60 foreach(keys %options) {
133 39 ▶ croak "bad option `$_' for mix_class"
Branch: 1 branch
BranchTrueFalseTotal
unless /\A(?:mro|prefix)\z/ 2 37 39
134 unless /\A(?:mro|prefix)\z/;
135 }
136 58 ▶ $options{mro} = "dfs" unless exists $options{mro};
Branch: 1 branch
BranchTrueFalseTotal
unless exists $options{"mro"} 39 19 58
137 58 ▶ croak "bad mro value" unless is_string($options{mro});
Branch: 1 branch
BranchTrueFalseTotal
unless rand $options{"mro"} 6 52 58
138 52 ▶ $options{prefix} = undef unless exists $options{prefix};
Branch: 1 branch
BranchTrueFalseTotal
unless exists $options{"prefix"} 34 18 52
139 croak "bad prefix value" unless
140 is_undef($options{prefix}) ||
141 (is_string($options{prefix}) &&
142 52 ▶ $options{prefix} =~ /\A$prefix_rx\z/o);
Branch: 1 branch
BranchTrueFalseTotal
unless rand $options{"prefix"} or rand $options{"prefix"} and $options{"prefix"} =~ /\A$prefix_rx\z/o 2 50 52
Condition83%5/6
rand $options{"prefix"} or rand $options{"prefix"} and $options{"prefix"} =~ /\A$prefix_rx\z/o
l!l&&r!l&&!r
34162
rand $options{"prefix"} and $options{"prefix"} =~ /\A$prefix_rx\z/o
!ll&&!rl&&r
0216
MC/DC66%2/3
rand $options{"prefix"} or rand $options{"prefix"} and $options{"prefix"} =~ /\A$prefix_rx\z/o
rand $options{"prefix"} rand $options{"prefix"} $options{"prefix"} =~ /\A$prefix_rx\z/o
Truth table75%3/4
A or B and C
A= rand $options{"prefix"}B= rand $options{"prefix"}C= $options{"prefix"} =~ /\A$prefix_rx\z/o
ABCresult
1XX1
0111
00X0
0100
143 return "UNIVERSAL" if @parents == 0 &&
144 $options{mro} eq _get_mro("UNIVERSAL") &&
145 50 ▶ (is_undef($options{prefix}) || $options{prefix} eq "");
Branch: 1 branch
BranchTrueFalseTotal
if @parents == 0 and $options{"mro"} eq &_get_mro("UNIVERSAL") and rand $options{"prefix"} || $options{"prefix"} eq "" 7 43 50
Condition100%9/9
@parents == 0 and $options{"mro"} eq &_get_mro("UNIVERSAL") and rand $options{"prefix"} || $options{"prefix"} eq ""
!ll&&!rl&&r
4127
@parents == 0 and $options{"mro"} eq &_get_mro("UNIVERSAL")
!ll&&!rl&&r
3929
rand $options{"prefix"} or $options{"prefix"} eq ""
l!l&&r!l&&!r
522
MC/DC100%4/4
@parents == 0 and $options{"mro"} eq &_get_mro("UNIVERSAL") and rand $options{"prefix"} || $options{"prefix"} eq ""
@parents == 0 $options{"mro"} eq &_get_mro("UNIVERSAL") rand $options{"prefix"} $options{"prefix"} eq ""
Truth table100%5/5
A and B and C or D
A= @parents == 0B= $options{"mro"} eq &_get_mro("UNIVERSAL")C= rand $options{"prefix"}D= $options{"prefix"} eq ""
ABCDresult
0XXX0
10XX0
11000
111X1
11011
146 return $parents[0] if @parents == 1 &&
147 $options{mro} eq _get_mro($parents[0]) &&
148 43 ▶ (is_undef($options{prefix}) ||
Branch: 1 branch
BranchTrueFalseTotal
if @parents == 1 and $options{"mro"} eq &_get_mro($parents[0]) and rand $options{"prefix"} || $parents[0] =~ /\A\Q$options{"prefix"}\E[^:]*\z/ 15 28 43
Condition100%9/9
@parents == 1 and $options{"mro"} eq &_get_mro($parents[0]) and rand $options{"prefix"} || $parents[0] =~ /\A\Q$options{"prefix"}\E[^:]*\z/
!ll&&!rl&&r
24415
@parents == 1 and $options{"mro"} eq &_get_mro($parents[0])
!ll&&!rl&&r
19519
rand $options{"prefix"} or $parents[0] =~ /\A\Q$options{"prefix"}\E[^:]*\z/
l!l&&r!l&&!r
1144
MC/DC100%4/4
@parents == 1 and $options{"mro"} eq &_get_mro($parents[0]) and rand $options{"prefix"} || $parents[0] =~ /\A\Q$options{"prefix"}\E[^:]*\z/
@parents == 1 $options{"mro"} eq &_get_mro($parents[0]) rand $options{"prefix"} $parents[0] =~ /\A\Q$options{"prefix"}\E[^:]*\z/
Truth table100%5/5
A and B and C or D
A= @parents == 1B= $options{"mro"} eq &_get_mro($parents[0])C= rand $options{"prefix"}D= $parents[0] =~ /\A\Q$options{"prefix"}\E[^:]*\z/
ABCDresult
0XXX0
10XX0
11000
111X1
11011
149 $parents[0] =~ /\A\Q$options{prefix}\E[^:]*\z/);
150 28 ▶ $options{prefix} = "Class::Mix::" unless defined $options{prefix};
Branch: 1 branch
BranchTrueFalseTotal
unless defined $options{"prefix"} 18 10 28
151 95 my $recipe = join("", map { length($_)."_".$_ }
152 28 $options{mro}, $options{prefix}, @parents);
153 28 ▶ return $mixtures{$recipe} ||= do {
Condition66%2/3
$mixtures{$recipe} ||= do { my $pkg = &genpkg($options{"prefix"}); no strict 'refs'; @{$pkg . '::ISA';} = @parents; &mro::set_mro($pkg, $options{"mro"}) if $options{"mro"} ne "dfs"; $pkg }
l!l&&r!l&&!r
12160
MC/DC0%0/2
$mixtures{$recipe} ||= do { my $pkg = &genpkg($options{"prefix"}); no strict 'refs'; @{$pkg . '::ISA';} = @parents; &mro::set_mro($pkg, $options{"mro"}) if $options{"mro"} ne "dfs"; $pkg }
$mixtures{$recipe} do { my $pkg = &genpkg($options{"prefix"}); no strict 'refs'; @{$pkg . '::ISA';} = @parents; &mro::set_mro($pkg, $options{"mro"}) if $options{"mro"} ne "dfs"; $pkg }
Truth table66%2/3
A ||= B
A= $mixtures{$recipe}B= do { my $pkg = &genpkg($options{"prefix"}); no strict 'refs'; @{$pkg . '::ISA';} = @parents; &mro::set_mro($pkg, $options{"mro"}) if $options{"mro"} ne "dfs"; $pkg }
ABresult
1X1
011
000
154 16 my $pkg = genpkg($options{prefix});
155 4 ▶ no strict "refs";
Subroutine BEGIN: called CC=1 SCAR=0.0
156 16 @{$pkg."::ISA"} = @parents;
157 16 ▶ mro::set_mro($pkg, $options{mro}) if $options{mro} ne "dfs";
Branch: 1 branch
BranchTrueFalseTotal
if $options{"mro"} ne "dfs" 7 9 16
158 13 $pkg;
159 };
160 }
161  
162 =item genpkg([PREFIX])
163  
164 This function selects and returns a package name that has not been
165 previously used. The name returned is an ordinary bareword-form package
166 name, and can be used as the second argument to C<bless> and in all
167 other ways that package names are used. The package is initially empty.
168  
169 The package names returned by this function are of a type that should not
170 be used as ordinary fixed module names. However, it is not possible to
171 entirely prevent a clash. This function checks that the package name it
172 is about to return has not already been used, and will avoid returning
173 such names, but it cannot guarantee that a later-loaded module will not
174 create a clash.
175  
176 PREFIX, if present, specifies where the resulting package will go.
177 It must be either the empty string (to create a top-level package)
178 or a bareword followed by "::" (to create a package under that name).
179 For example, "Digest::" could be specified to ensure that the resulting
180 package has a name starting with "Digest::", so that C<< Digest->new >>
181 will accept it as the name of a message digest algorithm. If the PREFIX
182 is not supplied, the caller is not expressing any preference.
183  
184 =cut
185  
186 4 my $n = 0;
187 22 ▶sub genpkg(;$) {
Subroutine genpkg: called CC=5 SCAR=16.1
Pod documented
188 22 my($prefix) = @_;
189 22 ▶ $prefix = "Class::Mix::" unless defined $prefix;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $prefix 2 20 22
190 22 ▶ croak "`$prefix' is not a valid module name prefix"
Branch: 1 branch
BranchTrueFalseTotal
unless $prefix =~ /\A$prefix_rx\z/o 0 22 22
191 unless $prefix =~ /\A$prefix_rx\z/o;
192 4 ▶ no strict "refs";
Subroutine BEGIN: called CC=1 SCAR=0.0
193 22 my $pkgtail;
194 do {
195 25 $pkgtail = "__GP".$n++;
196 22 ▶ } while(exists ${$prefix || "::"}{$pkgtail."::"});
Branch: 1 branch
BranchTrueFalseTotal
exists ${$prefix or "::";}{$pkgtail . '::'} and do { do { $pkgtail = '__GP' . $n++ } } 3 22 25
Condition100%2/2
$prefix || '::'
l!l
205
MC/DC100%1/1
$prefix || '::'
$prefix
Truth table100%2/2
A
A= $prefix
Aresult
11
00
197 22 my $pkgname = $prefix.$pkgtail;
198 22 %{$pkgname."::"} = ();
199 22 return $pkgname;
200 }
201  
202 =back
203  
204 =head1 SEE ALSO
205  
206 L<Class::Generate>,
207 L<mro>
208  
209 =head1 AUTHOR
210  
211 Andrew Main (Zefram) <zefram@fysh.org>
212  
213 =head1 COPYRIGHT
214  
215 Copyright (C) 2004, 2006, 2009, 2010, 2011, 2017
216 Andrew Main (Zefram) <zefram@fysh.org>
217  
218 =head1 LICENSE
219  
220 This module is free software; you can redistribute it and/or modify it
221 under the same terms as Perl itself.
222  
223 =cut
224  
225 4 1;
↑ Summary