1File::Find::Object::RulUes:e:rExCtoenntdriinbgu(t3e)d PeFrilleD:o:cFuimnedn:t:aOtbijoenct::Rule::Extending(3)
2
6 File::Find::Object::Rule::Extending - the mini-guide to extending
7 File::Find::Object::Rule
8
10 version 0.0310
11
13 package File::Find::Object::Rule::Random;
14 use strict;
16 use warnings;
17 # take useful things from File::Find::Object::Rule
19 use base 'File::Find::Object::Rule';
20 # and force our crack into the main namespace
22 sub File::Find::Object::Rule::random () {
23 my $self = shift()->_force_object;
24 $self->exec( sub { rand > 0.5 } );
25 }
26 1;
28
30 File::Find::Object::Rule inherits File::Find::Rule's extensibility. It
31 is now possible to extend it, using the following conventions.
32 Declare your package
34 package File::Find::Object::Rule::Random;
35 use strict;
37 use warnings;
38 Inherit methods from File::Find::Object::Rule
40 # take useful things from File::Find::Object::Rule
41 use base 'File::Find::Object::Rule';
42 Force your madness into the main package
44 # and force our crack into the main namespace
46 sub File::Find::Object::Rule::random () {
47 my $self = shift()->_force_object;
48 $self->exec( sub { rand > 0.5 } );
49 }
50 Yes, we're being very cavalier here and defining things into the main
52 File::Find::Object::Rule namespace. This is due to lack of
53 imaginiation on my part - I simply can't find a way for the functional
54 and oo interface to work without doing this or some kind of
55 inheritance, and inheritance stops you using two
56 File::Find::Object::Rule::Foo modules together.
57 For this reason try and pick distinct names for your extensions. If
59 this becomes a problem then I may institute a semi-official registry of
60 taken names.
61 Taking no arguments.
63 Note the null prototype on random. This is a cheat for the procedural
64 interface to know that your sub takes no arguments, and so allows this
65 to happen:
66 find( random => in => '.' );
68 If you hadn't declared "random" with a null prototype it would have
70 consumed "in" as a parameter to it, then got all confused as it doesn't
71 know about a '.' rule.
72
74 version 0.0310
75
77 The callback can access the File::Find::Object::Result using
78 "$self->finder->item_obj()".
79
81 Richard Clamp <richardc@unixbeard.net>
82
84 Copyright (C) 2002 Richard Clamp. All Rights Reserved.
85 This module is free software; you can redistribute it and/or modify it
87 under the same terms as Perl itself.
88
90 File::Find::Object::Rule
91 File::Find::::Rule::MMagic was the first extension module for
93 File::Find::Rule, so maybe check that out.
94
96 · Richard Clamp <richardc@unixbeard.net> with input gained from this
97 · and Andy Lester andy@petdance.com.
99
101 This software is copyright (c) 2019 by Richard Clampwith input gained
102 from this.
103 This is free software; you can redistribute it and/or modify it under
105 the same terms as the Perl 5 programming language system itself.
106
108 Please report any bugs or feature requests on the bugtracker website
109 <https://github.com/shlomif/file-find-object-rule/issues>
110 When submitting a bug or request, please include a test-file or a patch
112 to an existing test-file that illustrates the bug or desired feature.
113
115 Websites
116 The following websites have more information about this module, and may
117 be of help to you. As always, in addition to those websites please use
118 your favorite search engine to discover more resources.
119 · MetaCPAN
121 A modern, open-source CPAN search engine, useful to view POD in
123 HTML format.
124 <https://metacpan.org/release/File-Find-Object-Rule>
126 · Search CPAN
128 The default CPAN search engine, useful to view POD in HTML format.
130 <http://search.cpan.org/dist/File-Find-Object-Rule>
132 · RT: CPAN's Bug Tracker
134 The RT ( Request Tracker ) website is the default bug/issue
136 tracking system for CPAN.
137 <https://rt.cpan.org/Public/Dist/Display.html?Name=File-Find-Object-Rule>
139 · AnnoCPAN
141 The AnnoCPAN is a website that allows community annotations of Perl
143 module documentation.
144 <http://annocpan.org/dist/File-Find-Object-Rule>
146 · CPAN Ratings
148 The CPAN Ratings is a website that allows community ratings and
150 reviews of Perl modules.
151 <http://cpanratings.perl.org/d/File-Find-Object-Rule>
153 · CPANTS
155 The CPANTS is a website that analyzes the Kwalitee ( code metrics )
157 of a distribution.
158 <http://cpants.cpanauthors.org/dist/File-Find-Object-Rule>
160 · CPAN Testers
162 The CPAN Testers is a network of smoke testers who run automated
164 tests on uploaded CPAN distributions.
165 <http://www.cpantesters.org/distro/F/File-Find-Object-Rule>
167 · CPAN Testers Matrix
169 The CPAN Testers Matrix is a website that provides a visual
171 overview of the test results for a distribution on various
172 Perls/platforms.
173 <http://matrix.cpantesters.org/?dist=File-Find-Object-Rule>
175 · CPAN Testers Dependencies
177 The CPAN Testers Dependencies is a website that shows a chart of
179 the test results of all dependencies for a distribution.
180 <http://deps.cpantesters.org/?module=File::Find::Object::Rule>
182 Bugs / Feature Requests
184 Please report any bugs or feature requests by email to
185 "bug-file-find-object-rule at rt.cpan.org", or through the web
186 interface at
187 <https://rt.cpan.org/Public/Bug/Report.html?Queue=File-Find-Object-Rule>.
188 You will be automatically notified of any progress on the request by
189 the system.
190 Source Code
192 The code is open to the world, and available for you to hack on. Please
193 feel free to browse it and play with it, or whatever. If you want to
194 contribute patches, please send me a diff or prod me to pull from your
195 repository :)
196 <https://github.com/shlomif/file-find-object-rule>
198 git clone http://bitbucket.org/shlomif/perl-file-find-object-rule
200perl v5.28.1 2019-04F-i0l6e::Find::Object::Rule::Extending(3)