All packaged up for CPAN

2015-02-21 04:09:33 +00:00 · 2015-02-21 04:09:33 +00:00 · a5dbd5f0ef
parent 4175f04ed1
commit a5dbd5f0ef
12 changed files with 469 additions and 0 deletions
--- a/.gitignore
+++ b/.gitignore
@ -0,0 +1 @@
+Makefile.old
--- a/5
+++ b/5
@ -0,0 +1,5 @@
+Revision history for POE-Component-DirWatch-WithCaller
+
+1.00    21 Feb, 2015
+        First version, released on an unsuspecting world.
+
--- a/9
+++ b/9
@ -0,0 +1,9 @@
+Changes
+lib/POE/Component/DirWatch/WithCaller.pm
+Makefile.PL
+MANIFEST			This list of files
+README
+t/00-load.t
+t/manifest.t
+t/pod-coverage.t
+t/pod.t
--- a/Makefile.PL
+++ b/Makefile.PL
@ -0,0 +1,25 @@
+use 5.006;
+use strict;
+use warnings;
+use ExtUtils::MakeMaker;
+
+WriteMakefile(
+    NAME             => 'POE::Component::DirWatch::WithCaller',
+    AUTHOR           => q{Matthew Connelly <maff@cpan.org>},
+    VERSION_FROM     => 'lib/POE/Component/DirWatch/WithCaller.pm',
+    ABSTRACT_FROM    => 'lib/POE/Component/DirWatch/WithCaller.pm',
+    LICENSE          => 'artistic_2',
+    PL_FILES         => {},
+    MIN_PERL_VERSION => 5.006,
+    CONFIGURE_REQUIRES => {
+        'ExtUtils::MakeMaker' => 0,
+    },
+    BUILD_REQUIRES => {
+        'Test::More' => 0,
+    },
+    PREREQ_PM => {
+		'POE::Component::DirWatch'	=> 0.300001,
+    },
+    dist  => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
+    clean => { FILES => 'POE-Component-DirWatch-WithCaller-*' },
+);
--- a/76
+++ b/76
@ -0,0 +1,76 @@
+POE-Component-DirWatch-WithCaller
+
+This module extends POE::Component::DirWatch to make life easier for those who wish to dynamically create DirWatch sessions which share common callbacks and filters. Functionality has also been included to allow previously-seen files to be filtered, hopefully improving poll performance.
+
+
+INSTALLATION
+
+To install this module, run the following commands:
+
+	perl Makefile.PL
+	make
+	make test
+	make install
+
+SUPPORT AND DOCUMENTATION
+
+After installing, you can find documentation for this module with the
+perldoc command.
+
+    perldoc POE::Component::DirWatch::WithCaller
+
+You can also look for information at:
+
+    RT, CPAN's request tracker (report bugs here)
+        http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-DirWatch-WithCaller
+
+    AnnoCPAN, Annotated CPAN documentation
+        http://annocpan.org/dist/POE-Component-DirWatch-WithCaller
+
+    CPAN Ratings
+        http://cpanratings.perl.org/d/POE-Component-DirWatch-WithCaller
+
+    Search CPAN
+        http://search.cpan.org/dist/POE-Component-DirWatch-WithCaller/
+
+
+LICENSE AND COPYRIGHT
+
+Copyright (C) 2015 Matthew Connelly
+
+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:
+
+L<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.
+
--- a/ignore.txt
+++ b/ignore.txt
@ -0,0 +1,18 @@
+Makefile
+Makefile.old
+Build
+Build.bat
+META.*
+MYMETA.*
+.build/
+_build/
+cover_db/
+blib/
+inc/
+.lwpcookies
+.last_cover_stats
+nytprof.out
+pod2htm*.tmp
+pm_to_blib
+POE-Component-DirWatch-WithCaller-*
+POE-Component-DirWatch-WithCaller-*.tar.gz
--- a/lib/POE/Component/DirWatch/WithCaller.pm
+++ b/lib/POE/Component/DirWatch/WithCaller.pm
@ -0,0 +1,210 @@
+package POE::Component::DirWatch::WithCaller;
+
+our $VERSION = "1.00";
+
+use 5.006;
+use strict;
+use warnings;
+use Moose;
+use POE;
+
+extends 'POE::Component::DirWatch';
+
+has ignore_seen => (
+	is => 'ro',
+	isa => 'Int',
+	required => 1,
+	default => 0,
+);
+has ensure_seen => (
+	is => 'ro',
+	isa => 'Int',
+	required => 0,
+	default => 0,
+);
+has seen_files => (
+	is => 'rw',
+	isa => 'HashRef',
+	default => sub{{}},
+);
+
+override '_poll' => sub {
+	# the vast majority of this is copied from POE::Component::DirWatch's _poll subroutine by virtue of not being able to call super
+	my ($self, $kernel) = @_[OBJECT, KERNEL];
+	$self->clear_next_poll;
+
+	# seen_files portions borrowed from POE::Component::DirWatch::Object::NewFile
+	%{ $self->seen_files } = map {$_ => $self->seen_files->{$_} } grep {-e $_ } keys %{ $self->seen_files };
+	my $filter = $self->has_filter ? $self->filter : undef;
+	my $has_dir_cb  = $self->has_dir_callback;
+	my $has_file_cb = $self->has_file_callback;
+
+	while (my $child = $self->directory->next) {
+		if($child->is_dir) {
+			next unless $has_dir_cb;
+			next if ref $filter && !$filter->($self->alias, $child);
+			$kernel->yield(dir_callback => $child);
+		} else {
+			next unless $has_file_cb;
+			next if $child->basename =~ /^\.+$/;
+			$self->seen_files->{"$child"} = 0 if not defined $self->seen_files->{"$child"};
+			next unless $self->seen_files->{"$child"} == 0 or $self->seen_files->{"$child"} > 120 or not $self->ignore_seen;
+			$self->seen_files->{"$child"}++ unless ($self->seen_files->{"$child"}*$self->interval) > 120 and $self->seen_files->{"$child"} = -1;
+			$self->seen_files->{"$child"} = 1 if $self->ignore_seen and not $self->ensure_seen;
+			next if ref $filter && !$filter->($self->alias, $child);
+			$kernel->yield(file_callback => $child);
+		}
+	}
+	$self->next_poll( $kernel->delay_set(poll => $self->interval) );
+};
+
+override '_file_callback' => sub {
+	my ($self, $kernel, $file) = @_[OBJECT, KERNEL, ARG0];
+	$self->file_callback->($self->alias, $file);
+};
+
+override '_dir_callback' => sub {
+	my ($self, $kernel, $dir) = @_[OBJECT, KERNEL, ARG0];
+	$self->dir_callback->($self->alias, $dir);
+};
+
+1;
+__END__
+
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+POE::Component::DirWatch::WithCaller - An extension to POE::Component::DirWatch to pass through the name of the calling DirWatch instance, useful for cases where DirWatch sessions may be dynamically created while sharing callback functions whose behaviour may differ in small ways depending on the caller.
+
+=head1 VERSION
+
+Version 1.00
+
+=head1 SYNOPSIS
+
+Somewhat simple extension to L<POE::Component::DirWatch> that passes the name of the calling DirWatch session to callback functions.
+
+	sub filter { my ($caller,$file) = @_; return 1; }
+	sub file { my ($caller,$file) = @_; }
+	my $monitor = POE::Component::DirWatch::WithCaller->new(
+		alias			=> 'mymonitor',
+		directory		=> '/my/path',
+		filter			=> \&filter,
+		file_callback	=> \&file,
+		interval		=> 5,
+	);
+
+Filtering already-seen files can be achieved as such:
+
+	sub filter { my ($caller,$file) = @_; return 1; }
+	sub file { my ($caller,$file) = @_; }
+	my $monitor = POE::Component::DirWatch::WithCaller->new(
+		alias			=> 'mymonitor',
+		directory		=> '/my/path',
+		filter			=> \&filter,
+		file_callback	=> \&file,
+		interval		=> 5,
+		ignore_seen		=> 1,
+	);
+
+In some instances, using C<ignore_seen> may result in some files being internally marked as 'seen' without being filtered or sent through callbacks, see below.
+
+=head1 FILTERING PREVIOUSLY-SEEN FILES
+
+Depending on use case, it may be beneficial or necessary to filter out previously-seen files, either for performance reasons when monitoring highly populous directories for specific files, or for avoiding reprocessing files in the event that they are left in the directory after initial processing.
+In this case, simply specifying C<ignore_seen =E<gt> 1> as a named argument when creating the DirWatch::WithCaller object will enable this behaviour.
+While testing this feature, however, it was observed that some edge cases exist in which a file will be considered 'seen' when it has not been processed despite matching a defined monitor. To account for this, each file that has been considered 'seen' will be reprocessed once around 120 seconds after it was first 'seen'. This behaviour may not be desirable, and as such is disabled by default, and can be enabled by specifying C<ensure_seen =E<gt> 1> when creating the object.
+
+
+=head1 AUTHOR
+
+Matthew Connelly, C<< <maff at cpan.org> >>
+
+=head1 BUGS
+
+Please report any bugs or feature requests to C<bug-poe-component-dirwatch-withcaller at rt.cpan.org>, or through
+the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POE-Component-DirWatch-WithCaller>.  I will be notified, and then you'll
+automatically be notified of progress on your bug as I make changes.
+
+=head1 SUPPORT
+
+You can find documentation for this module with the perldoc command.
+
+    perldoc POE::Component::DirWatch::WithCaller
+
+
+You can also look for information at:
+
+=over 4
+
+=item * RT: CPAN's request tracker (report bugs here)
+
+L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-DirWatch-WithCaller>
+
+=item * AnnoCPAN: Annotated CPAN documentation
+
+L<http://annocpan.org/dist/POE-Component-DirWatch-WithCaller>
+
+=item * CPAN Ratings
+
+L<http://cpanratings.perl.org/d/POE-Component-DirWatch-WithCaller>
+
+=item * Search CPAN
+
+L<http://search.cpan.org/dist/POE-Component-DirWatch-WithCaller/>
+
+=back
+
+
+=head1 ACKNOWLEDGEMENTS
+
+Guillermo Roditi, <groditi@cpan.org>
+Robert Rothenberg, <rrwo@cpan.org>
+
+=head1 SEE ALSO
+
+L<POE::Component::DirWatch>, L<POE::Component::DirWatch::Object::NewFile>
+
+=head1 LICENSE AND COPYRIGHT
+
+Copyright 2015 Matthew Connelly.
+
+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:
+
+L<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.
+
--- a/t/00-load.t
+++ b/t/00-load.t
@ -0,0 +1,13 @@
+#!perl -T
+use 5.006;
+use strict;
+use warnings;
+use Test::More;
+
+plan tests => 1;
+
+BEGIN {
+    use_ok( 'POE::Component::DirWatch::WithCaller' ) || print "Bail out!\n";
+}
+
+diag( "Testing POE::Component::DirWatch::WithCaller $POE::Component::DirWatch::WithCaller::VERSION, Perl $], $^X" );
--- a/t/manifest.t
+++ b/t/manifest.t
@ -0,0 +1,15 @@
+#!perl -T
+use 5.006;
+use strict;
+use warnings;
+use Test::More;
+
+unless ( $ENV{RELEASE_TESTING} ) {
+    plan( skip_all => "Author tests not required for installation" );
+}
+
+my $min_tcm = 0.9;
+eval "use Test::CheckManifest $min_tcm";
+plan skip_all => "Test::CheckManifest $min_tcm required" if $@;
+
+ok_manifest();
--- a/t/pod-coverage.t
+++ b/t/pod-coverage.t
@ -0,0 +1,24 @@
+#!perl -T
+use 5.006;
+use strict;
+use warnings;
+use Test::More;
+
+unless ( $ENV{RELEASE_TESTING} ) {
+    plan( skip_all => "Author tests not required for installation" );
+}
+
+# Ensure a recent version of Test::Pod::Coverage
+my $min_tpc = 1.08;
+eval "use Test::Pod::Coverage $min_tpc";
+plan skip_all => "Test::Pod::Coverage $min_tpc required for testing POD coverage"
+    if $@;
+
+# Test::Pod::Coverage doesn't require a minimum Pod::Coverage version,
+# but older versions don't recognize some common documentation styles
+my $min_pc = 0.18;
+eval "use Pod::Coverage $min_pc";
+plan skip_all => "Pod::Coverage $min_pc required for testing POD coverage"
+    if $@;
+
+all_pod_coverage_ok();
--- a/t/pod.t
+++ b/t/pod.t
@ -0,0 +1,16 @@
+#!perl -T
+use 5.006;
+use strict;
+use warnings;
+use Test::More;
+
+unless ( $ENV{RELEASE_TESTING} ) {
+    plan( skip_all => "Author tests not required for installation" );
+}
+
+# Ensure a recent version of Test::Pod
+my $min_tp = 1.22;
+eval "use Test::Pod $min_tp";
+plan skip_all => "Test::Pod $min_tp required for testing POD" if $@;
+
+all_pod_files_ok();
--- a/xt/boilerplate.t
+++ b/xt/boilerplate.t
@ -0,0 +1,57 @@
+#!perl -T
+use 5.006;
+use strict;
+use warnings;
+use Test::More;
+
+plan tests => 3;
+
+sub not_in_file_ok {
+    my ($filename, %regex) = @_;
+    open( my $fh, '<', $filename )
+        or die "couldn't open $filename for reading: $!";
+
+    my %violated;
+
+    while (my $line = <$fh>) {
+        while (my ($desc, $regex) = each %regex) {
+            if ($line =~ $regex) {
+                push @{$violated{$desc}||=[]}, $.;
+            }
+        }
+    }
+
+    if (%violated) {
+        fail("$filename contains boilerplate text");
+        diag "$_ appears on lines @{$violated{$_}}" for keys %violated;
+    } else {
+        pass("$filename contains no boilerplate text");
+    }
+}
+
+sub module_boilerplate_ok {
+    my ($module) = @_;
+    not_in_file_ok($module =>
+        'the great new $MODULENAME'   => qr/ - The great new /,
+        'boilerplate description'     => qr/Quick summary of what the module/,
+        'stub function definition'    => qr/function[12]/,
+    );
+}
+
+TODO: {
+  local $TODO = "Need to replace the boilerplate text";
+
+  not_in_file_ok(README =>
+    "The README is used..."       => qr/The README is used/,
+    "'version information here'"  => qr/to provide version information/,
+  );
+
+  not_in_file_ok(Changes =>
+    "placeholder date/time"       => qr(Date/time)
+  );
+
+  module_boilerplate_ok('lib/POE/Component/DirWatch/WithCaller.pm');
+
+
+}
+