Params-Coerce-0.14/0000755000175000017500000000000010512625552012450 5ustar adamadamParams-Coerce-0.14/inc/0000755000175000017500000000000010512625552013221 5ustar adamadamParams-Coerce-0.14/inc/Module/0000755000175000017500000000000010512625552014446 5ustar adamadamParams-Coerce-0.14/inc/Module/Install.pm0000644000175000017500000001761110512625547016424 0ustar adamadam#line 1 package Module::Install; # For any maintainers: # The load order for Module::Install is a bit magic. # It goes something like this... # # IF ( host has Module::Install installed, creating author mode ) { # 1. Makefile.PL calls "use inc::Module::Install" # 2. $INC{inc/Module/Install.pm} set to installed version of inc::Module::Install # 3. The installed version of inc::Module::Install loads # 4. inc::Module::Install calls "require Module::Install" # 5. The ./inc/ version of Module::Install loads # } ELSE { # 1. Makefile.PL calls "use inc::Module::Install" # 2. $INC{inc/Module/Install.pm} set to ./inc/ version of Module::Install # 3. The ./inc/ version of Module::Install loads # } use 5.004; use strict 'vars'; use vars qw{$VERSION}; BEGIN { # All Module::Install core packages now require synchronised versions. # This will be used to ensure we don't accidentally load old or # different versions of modules. # This is not enforced yet, but will be some time in the next few # releases once we can make sure it won't clash with custom # Module::Install extensions. $VERSION = '0.64'; } # Whether or not inc::Module::Install is actually loaded, the # $INC{inc/Module/Install.pm} is what will still get set as long as # the caller loaded module this in the documented manner. # If not set, the caller may NOT have loaded the bundled version, and thus # they may not have a MI version that works with the Makefile.PL. This would # result in false errors or unexpected behaviour. And we don't want that. my $file = join( '/', 'inc', split /::/, __PACKAGE__ ) . '.pm'; unless ( $INC{$file} ) { die <<"END_DIE"; Please invoke ${\__PACKAGE__} with: use inc::${\__PACKAGE__}; not: use ${\__PACKAGE__}; END_DIE } # If the script that is loading Module::Install is from the future, # then make will detect this and cause it to re-run over and over # again. This is bad. Rather than taking action to touch it (which # is unreliable on some platforms and requires write permissions) # for now we should catch this and refuse to run. if ( -f $0 and (stat($0))[9] > time ) { die << "END_DIE"; Your installer $0 has a modification time in the future. This is known to create infinite loops in make. Please correct this, then run $0 again. END_DIE } use Cwd (); use File::Find (); use File::Path (); use FindBin; *inc::Module::Install::VERSION = *VERSION; @inc::Module::Install::ISA = __PACKAGE__; sub autoload { my $self = shift; my $who = $self->_caller; my $cwd = Cwd::cwd(); my $sym = "${who}::AUTOLOAD"; $sym->{$cwd} = sub { my $pwd = Cwd::cwd(); if ( my $code = $sym->{$pwd} ) { # delegate back to parent dirs goto &$code unless $cwd eq $pwd; } $$sym =~ /([^:]+)$/ or die "Cannot autoload $who - $sym"; unshift @_, ($self, $1); goto &{$self->can('call')} unless uc($1) eq $1; }; } sub import { my $class = shift; my $self = $class->new(@_); my $who = $self->_caller; unless ( -f $self->{file} ) { require "$self->{path}/$self->{dispatch}.pm"; File::Path::mkpath("$self->{prefix}/$self->{author}"); $self->{admin} = "$self->{name}::$self->{dispatch}"->new( _top => $self ); $self->{admin}->init; @_ = ($class, _self => $self); goto &{"$self->{name}::import"}; } *{"${who}::AUTOLOAD"} = $self->autoload; $self->preload; # Unregister loader and worker packages so subdirs can use them again delete $INC{"$self->{file}"}; delete $INC{"$self->{path}.pm"}; } sub preload { my ($self) = @_; unless ( $self->{extensions} ) { $self->load_extensions( "$self->{prefix}/$self->{path}", $self ); } my @exts = @{$self->{extensions}}; unless ( @exts ) { my $admin = $self->{admin}; @exts = $admin->load_all_extensions; } my %seen; foreach my $obj ( @exts ) { while (my ($method, $glob) = each %{ref($obj) . '::'}) { next unless $obj->can($method); next if $method =~ /^_/; next if $method eq uc($method); $seen{$method}++; } } my $who = $self->_caller; foreach my $name ( sort keys %seen ) { *{"${who}::$name"} = sub { ${"${who}::AUTOLOAD"} = "${who}::$name"; goto &{"${who}::AUTOLOAD"}; }; } } sub new { my ($class, %args) = @_; # ignore the prefix on extension modules built from top level. my $base_path = Cwd::abs_path($FindBin::Bin); unless ( Cwd::abs_path(Cwd::cwd()) eq $base_path ) { delete $args{prefix}; } return $args{_self} if $args{_self}; $args{dispatch} ||= 'Admin'; $args{prefix} ||= 'inc'; $args{author} ||= ($^O eq 'VMS' ? '_author' : '.author'); $args{bundle} ||= 'inc/BUNDLES'; $args{base} ||= $base_path; $class =~ s/^\Q$args{prefix}\E:://; $args{name} ||= $class; $args{version} ||= $class->VERSION; unless ( $args{path} ) { $args{path} = $args{name}; $args{path} =~ s!::!/!g; } $args{file} ||= "$args{base}/$args{prefix}/$args{path}.pm"; bless( \%args, $class ); } sub call { my ($self, $method) = @_; my $obj = $self->load($method) or return; splice(@_, 0, 2, $obj); goto &{$obj->can($method)}; } sub load { my ($self, $method) = @_; $self->load_extensions( "$self->{prefix}/$self->{path}", $self ) unless $self->{extensions}; foreach my $obj (@{$self->{extensions}}) { return $obj if $obj->can($method); } my $admin = $self->{admin} or die <<"END_DIE"; The '$method' method does not exist in the '$self->{prefix}' path! Please remove the '$self->{prefix}' directory and run $0 again to load it. END_DIE my $obj = $admin->load($method, 1); push @{$self->{extensions}}, $obj; $obj; } sub load_extensions { my ($self, $path, $top) = @_; unless ( grep { lc $_ eq lc $self->{prefix} } @INC ) { unshift @INC, $self->{prefix}; } foreach my $rv ( $self->find_extensions($path) ) { my ($file, $pkg) = @{$rv}; next if $self->{pathnames}{$pkg}; local $@; my $new = eval { require $file; $pkg->can('new') }; unless ( $new ) { warn $@ if $@; next; } $self->{pathnames}{$pkg} = delete $INC{$file}; push @{$self->{extensions}}, &{$new}($pkg, _top => $top ); } $self->{extensions} ||= []; } sub find_extensions { my ($self, $path) = @_; my @found; File::Find::find( sub { my $file = $File::Find::name; return unless $file =~ m!^\Q$path\E/(.+)\.pm\Z!is; my $subpath = $1; return if lc($subpath) eq lc($self->{dispatch}); $file = "$self->{path}/$subpath.pm"; my $pkg = "$self->{name}::$subpath"; $pkg =~ s!/!::!g; # If we have a mixed-case package name, assume case has been preserved # correctly. Otherwise, root through the file to locate the case-preserved # version of the package name. if ( $subpath eq lc($subpath) || $subpath eq uc($subpath) ) { open PKGFILE, "<$subpath.pm" or die "find_extensions: Can't open $subpath.pm: $!"; my $in_pod = 0; while ( ) { $in_pod = 1 if /^=\w/; $in_pod = 0 if /^=cut/; next if ($in_pod || /^=cut/); # skip pod text next if /^\s*#/; # and comments if ( m/^\s*package\s+($pkg)\s*;/i ) { $pkg = $1; last; } } close PKGFILE; } push @found, [ $file, $pkg ]; }, $path ) if -d $path; @found; } sub _caller { my $depth = 0; my $call = caller($depth); while ( $call eq __PACKAGE__ ) { $depth++; $call = caller($depth); } return $call; } 1; Params-Coerce-0.14/inc/Module/Install/0000755000175000017500000000000010512625552016054 5ustar adamadamParams-Coerce-0.14/inc/Module/Install/Fetch.pm0000644000175000017500000000463010512625550017444 0ustar adamadam#line 1 package Module::Install::Fetch; use strict; use Module::Install::Base; use vars qw{$VERSION $ISCORE @ISA}; BEGIN { $VERSION = '0.64'; $ISCORE = 1; @ISA = qw{Module::Install::Base}; } sub get_file { my ($self, %args) = @_; my ($scheme, $host, $path, $file) = $args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return; if ( $scheme eq 'http' and ! eval { require LWP::Simple; 1 } ) { $args{url} = $args{ftp_url} or (warn("LWP support unavailable!\n"), return); ($scheme, $host, $path, $file) = $args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return; } $|++; print "Fetching '$file' from $host... "; unless (eval { require Socket; Socket::inet_aton($host) }) { warn "'$host' resolve failed!\n"; return; } return unless $scheme eq 'ftp' or $scheme eq 'http'; require Cwd; my $dir = Cwd::getcwd(); chdir $args{local_dir} or return if exists $args{local_dir}; if (eval { require LWP::Simple; 1 }) { LWP::Simple::mirror($args{url}, $file); } elsif (eval { require Net::FTP; 1 }) { eval { # use Net::FTP to get past firewall my $ftp = Net::FTP->new($host, Passive => 1, Timeout => 600); $ftp->login("anonymous", 'anonymous@example.com'); $ftp->cwd($path); $ftp->binary; $ftp->get($file) or (warn("$!\n"), return); $ftp->quit; } } elsif (my $ftp = $self->can_run('ftp')) { eval { # no Net::FTP, fallback to ftp.exe require FileHandle; my $fh = FileHandle->new; local $SIG{CHLD} = 'IGNORE'; unless ($fh->open("|$ftp -n")) { warn "Couldn't open ftp: $!\n"; chdir $dir; return; } my @dialog = split(/\n/, <<"END_FTP"); open $host user anonymous anonymous\@example.com cd $path binary get $file $file quit END_FTP foreach (@dialog) { $fh->print("$_\n") } $fh->close; } } else { warn "No working 'ftp' program available!\n"; chdir $dir; return; } unless (-f $file) { warn "Fetching failed: $@\n"; chdir $dir; return; } return if exists $args{size} and -s $file != $args{size}; system($args{run}) if exists $args{run}; unlink($file) if $args{remove}; print(((!exists $args{check_for} or -e $args{check_for}) ? "done!" : "failed! ($!)"), "\n"); chdir $dir; return !$?; } 1; Params-Coerce-0.14/inc/Module/Install/Makefile.pm0000644000175000017500000001337310512625550020134 0ustar adamadam#line 1 package Module::Install::Makefile; use strict 'vars'; use Module::Install::Base; use ExtUtils::MakeMaker (); use vars qw{$VERSION $ISCORE @ISA}; BEGIN { $VERSION = '0.64'; $ISCORE = 1; @ISA = qw{Module::Install::Base}; } sub Makefile { $_[0] } my %seen = (); sub prompt { shift; # Infinite loop protection my @c = caller(); if ( ++$seen{"$c[1]|$c[2]|$_[0]"} > 3 ) { die "Caught an potential prompt infinite loop ($c[1]|$c[2]|$_[0])"; } # In automated testing, always use defaults if ( $ENV{AUTOMATED_TESTING} and ! $ENV{PERL_MM_USE_DEFAULT} ) { local $ENV{PERL_MM_USE_DEFAULT} = 1; goto &ExtUtils::MakeMaker::prompt; } else { goto &ExtUtils::MakeMaker::prompt; } } sub makemaker_args { my $self = shift; my $args = ($self->{makemaker_args} ||= {}); %$args = ( %$args, @_ ) if @_; $args; } # For mm args that take multiple space-seperated args, # append an argument to the current list. sub makemaker_append { my $self = shift; my $name = shift; my $args = $self->makemaker_args; $args->{name} = defined $args->{$name} ? join( ' ', $args->{name}, @_ ) : join( ' ', @_ ); } sub build_subdirs { my $self = shift; my $subdirs = $self->makemaker_args->{DIR} ||= []; for my $subdir (@_) { push @$subdirs, $subdir; } } sub clean_files { my $self = shift; my $clean = $self->makemaker_args->{clean} ||= {}; %$clean = ( %$clean, FILES => join(' ', grep length, $clean->{FILES}, @_), ); } sub realclean_files { my $self = shift; my $realclean = $self->makemaker_args->{realclean} ||= {}; %$realclean = ( %$realclean, FILES => join(' ', grep length, $realclean->{FILES}, @_), ); } sub libs { my $self = shift; my $libs = ref $_[0] ? shift : [ shift ]; $self->makemaker_args( LIBS => $libs ); } sub inc { my $self = shift; $self->makemaker_args( INC => shift ); } sub write { my $self = shift; die "&Makefile->write() takes no arguments\n" if @_; my $args = $self->makemaker_args; $args->{DISTNAME} = $self->name; $args->{NAME} = $self->module_name || $self->name || $self->determine_NAME($args); $args->{VERSION} = $self->version || $self->determine_VERSION($args); $args->{NAME} =~ s/-/::/g; if ( $self->tests ) { $args->{test} = { TESTS => $self->tests }; } if ($] >= 5.005) { $args->{ABSTRACT} = $self->abstract; $args->{AUTHOR} = $self->author; } if ( eval($ExtUtils::MakeMaker::VERSION) >= 6.10 ) { $args->{NO_META} = 1; } if ( eval($ExtUtils::MakeMaker::VERSION) > 6.17 and $self->sign ) { $args->{SIGN} = 1; } unless ( $self->is_admin ) { delete $args->{SIGN}; } # merge both kinds of requires into prereq_pm my $prereq = ($args->{PREREQ_PM} ||= {}); %$prereq = ( %$prereq, map { @$_ } map { @$_ } grep $_, ($self->build_requires, $self->requires) ); # merge both kinds of requires into prereq_pm my $subdirs = ($args->{DIR} ||= []); if ($self->bundles) { foreach my $bundle (@{ $self->bundles }) { my ($file, $dir) = @$bundle; push @$subdirs, $dir if -d $dir; delete $prereq->{$file}; } } if ( my $perl_version = $self->perl_version ) { eval "use $perl_version; 1" or die "ERROR: perl: Version $] is installed, " . "but we need version >= $perl_version"; } my %args = map { ( $_ => $args->{$_} ) } grep {defined($args->{$_})} keys %$args; if ($self->admin->preop) { $args{dist} = $self->admin->preop; } my $mm = ExtUtils::MakeMaker::WriteMakefile(%args); $self->fix_up_makefile($mm->{FIRST_MAKEFILE} || 'Makefile'); } sub fix_up_makefile { my $self = shift; my $makefile_name = shift; my $top_class = ref($self->_top) || ''; my $top_version = $self->_top->VERSION || ''; my $preamble = $self->preamble ? "# Preamble by $top_class $top_version\n" . $self->preamble : ''; my $postamble = "# Postamble by $top_class $top_version\n" . ($self->postamble || ''); local *MAKEFILE; open MAKEFILE, "< $makefile_name" or die "fix_up_makefile: Couldn't open $makefile_name: $!"; my $makefile = do { local $/; }; close MAKEFILE or die $!; $makefile =~ s/\b(test_harness\(\$\(TEST_VERBOSE\), )/$1'inc', /; $makefile =~ s/( -I\$\(INST_ARCHLIB\))/ -Iinc$1/g; $makefile =~ s/( "-I\$\(INST_LIB\)")/ "-Iinc"$1/g; $makefile =~ s/^(FULLPERL = .*)/$1 "-Iinc"/m; $makefile =~ s/^(PERL = .*)/$1 "-Iinc"/m; # Module::Install will never be used to build the Core Perl # Sometimes PERL_LIB and PERL_ARCHLIB get written anyway, which breaks # PREFIX/PERL5LIB, and thus, install_share. Blank them if they exist $makefile =~ s/^PERL_LIB = .+/PERL_LIB =/m; #$makefile =~ s/^PERL_ARCHLIB = .+/PERL_ARCHLIB =/m; # Perl 5.005 mentions PERL_LIB explicitly, so we have to remove that as well. $makefile =~ s/("?)-I\$\(PERL_LIB\)\1//g; # XXX - This is currently unused; not sure if it breaks other MM-users # $makefile =~ s/^pm_to_blib\s+:\s+/pm_to_blib :: /mg; open MAKEFILE, "> $makefile_name" or die "fix_up_makefile: Couldn't open $makefile_name: $!"; print MAKEFILE "$preamble$makefile$postamble" or die $!; close MAKEFILE or die $!; 1; } sub preamble { my ($self, $text) = @_; $self->{preamble} = $text . $self->{preamble} if defined $text; $self->{preamble}; } sub postamble { my ($self, $text) = @_; $self->{postamble} ||= $self->admin->postamble; $self->{postamble} .= $text if defined $text; $self->{postamble} } 1; __END__ #line 334 Params-Coerce-0.14/inc/Module/Install/Base.pm0000644000175000017500000000203510512625550017262 0ustar adamadam#line 1 package Module::Install::Base; $VERSION = '0.64'; # Suspend handler for "redefined" warnings BEGIN { my $w = $SIG{__WARN__}; $SIG{__WARN__} = sub { $w }; } ### This is the ONLY module that shouldn't have strict on # use strict; #line 41 sub new { my ($class, %args) = @_; foreach my $method ( qw(call load) ) { *{"$class\::$method"} = sub { shift()->_top->$method(@_); } unless defined &{"$class\::$method"}; } bless( \%args, $class ); } #line 61 sub AUTOLOAD { my $self = shift; local $@; my $autoload = eval { $self->_top->autoload } or return; goto &$autoload; } #line 76 sub _top { $_[0]->{_top} } #line 89 sub admin { $_[0]->_top->{admin} or Module::Install::Base::FakeAdmin->new; } sub is_admin { $_[0]->admin->VERSION; } sub DESTROY {} package Module::Install::Base::FakeAdmin; my $Fake; sub new { $Fake ||= bless(\@_, $_[0]) } sub AUTOLOAD {} sub DESTROY {} # Restore warning handler BEGIN { $SIG{__WARN__} = $SIG{__WARN__}->(); } 1; #line 138 Params-Coerce-0.14/inc/Module/Install/Metadata.pm0000644000175000017500000001747610512625550020147 0ustar adamadam#line 1 package Module::Install::Metadata; use strict 'vars'; use Module::Install::Base; use vars qw{$VERSION $ISCORE @ISA}; BEGIN { $VERSION = '0.64'; $ISCORE = 1; @ISA = qw{Module::Install::Base}; } my @scalar_keys = qw{ name module_name abstract author version license distribution_type perl_version tests }; my @tuple_keys = qw{ build_requires requires recommends bundles }; sub Meta { shift } sub Meta_ScalarKeys { @scalar_keys } sub Meta_TupleKeys { @tuple_keys } foreach my $key (@scalar_keys) { *$key = sub { my $self = shift; return $self->{values}{$key} if defined wantarray and !@_; $self->{values}{$key} = shift; return $self; }; } foreach my $key (@tuple_keys) { *$key = sub { my $self = shift; return $self->{values}{$key} unless @_; my @rv; while (@_) { my $module = shift or last; my $version = shift || 0; if ( $module eq 'perl' ) { $version =~ s{^(\d+)\.(\d+)\.(\d+)} {$1 + $2/1_000 + $3/1_000_000}e; $self->perl_version($version); next; } my $rv = [ $module, $version ]; push @rv, $rv; } push @{ $self->{values}{$key} }, @rv; @rv; }; } sub sign { my $self = shift; return $self->{'values'}{'sign'} if defined wantarray and !@_; $self->{'values'}{'sign'} = ( @_ ? $_[0] : 1 ); return $self; } sub dynamic_config { my $self = shift; unless ( @_ ) { warn "You MUST provide an explicit true/false value to dynamic_config, skipping\n"; return $self; } $self->{'values'}{'dynamic_config'} = $_[0] ? 1 : 0; return $self; } sub all_from { my ( $self, $file ) = @_; unless ( defined($file) ) { my $name = $self->name or die "all_from called with no args without setting name() first"; $file = join('/', 'lib', split(/-/, $name)) . '.pm'; $file =~ s{.*/}{} unless -e $file; die "all_from: cannot find $file from $name" unless -e $file; } $self->version_from($file) unless $self->version; $self->perl_version_from($file) unless $self->perl_version; # The remaining probes read from POD sections; if the file # has an accompanying .pod, use that instead my $pod = $file; if ( $pod =~ s/\.pm$/.pod/i and -e $pod ) { $file = $pod; } $self->author_from($file) unless $self->author; $self->license_from($file) unless $self->license; $self->abstract_from($file) unless $self->abstract; } sub provides { my $self = shift; my $provides = ( $self->{values}{provides} ||= {} ); %$provides = (%$provides, @_) if @_; return $provides; } sub auto_provides { my $self = shift; return $self unless $self->is_admin; unless (-e 'MANIFEST') { warn "Cannot deduce auto_provides without a MANIFEST, skipping\n"; return $self; } # Avoid spurious warnings as we are not checking manifest here. local $SIG{__WARN__} = sub {1}; require ExtUtils::Manifest; local *ExtUtils::Manifest::manicheck = sub { return }; require Module::Build; my $build = Module::Build->new( dist_name => $self->name, dist_version => $self->version, license => $self->license, ); $self->provides(%{ $build->find_dist_packages || {} }); } sub feature { my $self = shift; my $name = shift; my $features = ( $self->{values}{features} ||= [] ); my $mods; if ( @_ == 1 and ref( $_[0] ) ) { # The user used ->feature like ->features by passing in the second # argument as a reference. Accomodate for that. $mods = $_[0]; } else { $mods = \@_; } my $count = 0; push @$features, ( $name => [ map { ref($_) ? ( ref($_) eq 'HASH' ) ? %$_ : @$_ : $_ } @$mods ] ); return @$features; } sub features { my $self = shift; while ( my ( $name, $mods ) = splice( @_, 0, 2 ) ) { $self->feature( $name, @$mods ); } return $self->{values}->{features} ? @{ $self->{values}->{features} } : (); } sub no_index { my $self = shift; my $type = shift; push @{ $self->{values}{no_index}{$type} }, @_ if $type; return $self->{values}{no_index}; } sub read { my $self = shift; $self->include_deps( 'YAML', 0 ); require YAML; my $data = YAML::LoadFile('META.yml'); # Call methods explicitly in case user has already set some values. while ( my ( $key, $value ) = each %$data ) { next unless $self->can($key); if ( ref $value eq 'HASH' ) { while ( my ( $module, $version ) = each %$value ) { $self->can($key)->($self, $module => $version ); } } else { $self->can($key)->($self, $value); } } return $self; } sub write { my $self = shift; return $self unless $self->is_admin; $self->admin->write_meta; return $self; } sub version_from { my ( $self, $file ) = @_; require ExtUtils::MM_Unix; $self->version( ExtUtils::MM_Unix->parse_version($file) ); } sub abstract_from { my ( $self, $file ) = @_; require ExtUtils::MM_Unix; $self->abstract( bless( { DISTNAME => $self->name }, 'ExtUtils::MM_Unix' )->parse_abstract($file) ); } sub _slurp { my ( $self, $file ) = @_; local *FH; open FH, "< $file" or die "Cannot open $file.pod: $!"; do { local $/; }; } sub perl_version_from { my ( $self, $file ) = @_; if ( $self->_slurp($file) =~ m/ ^ use \s* v? ([\d_\.]+) \s* ; /ixms ) { my $v = $1; $v =~ s{_}{}g; $self->perl_version($1); } else { warn "Cannot determine perl version info from $file\n"; return; } } sub author_from { my ( $self, $file ) = @_; my $content = $self->_slurp($file); if ($content =~ m/ =head \d \s+ (?:authors?)\b \s* ([^\n]*) | =head \d \s+ (?:licen[cs]e|licensing|copyright|legal)\b \s* .*? copyright .*? \d\d\d[\d.]+ \s* (?:\bby\b)? \s* ([^\n]*) /ixms) { my $author = $1 || $2; $author =~ s{E}{<}g; $author =~ s{E}{>}g; $self->author($author); } else { warn "Cannot determine author info from $file\n"; } } sub license_from { my ( $self, $file ) = @_; if ( $self->_slurp($file) =~ m/ =head \d \s+ (?:licen[cs]e|licensing|copyright|legal)\b (.*?) (=head\\d.*|=cut.*|) \z /ixms ) { my $license_text = $1; my @phrases = ( 'under the same (?:terms|license) as perl itself' => 'perl', 'GNU public license' => 'gpl', 'GNU lesser public license' => 'gpl', 'BSD license' => 'bsd', 'Artistic license' => 'artistic', 'GPL' => 'gpl', 'LGPL' => 'lgpl', 'BSD' => 'bsd', 'Artistic' => 'artistic', ); while ( my ( $pattern, $license ) = splice( @phrases, 0, 2 ) ) { $pattern =~ s{\s+}{\\s+}g; if ( $license_text =~ /\b$pattern\b/i ) { $self->license($license); return 1; } } } warn "Cannot determine license info from $file\n"; return 'unknown'; } 1; Params-Coerce-0.14/inc/Module/Install/Can.pm0000644000175000017500000000337410512625550017120 0ustar adamadam#line 1 package Module::Install::Can; use strict; use Module::Install::Base; use Config (); ### This adds a 5.005 Perl version dependency. ### This is a bug and will be fixed. use File::Spec (); use ExtUtils::MakeMaker (); use vars qw{$VERSION $ISCORE @ISA}; BEGIN { $VERSION = '0.64'; $ISCORE = 1; @ISA = qw{Module::Install::Base}; } # check if we can load some module ### Upgrade this to not have to load the module if possible sub can_use { my ($self, $mod, $ver) = @_; $mod =~ s{::|\\}{/}g; $mod .= '.pm' unless $mod =~ /\.pm$/i; my $pkg = $mod; $pkg =~ s{/}{::}g; $pkg =~ s{\.pm$}{}i; local $@; eval { require $mod; $pkg->VERSION($ver || 0); 1 }; } # check if we can run some command sub can_run { my ($self, $cmd) = @_; my $_cmd = $cmd; return $_cmd if (-x $_cmd or $_cmd = MM->maybe_command($_cmd)); for my $dir ((split /$Config::Config{path_sep}/, $ENV{PATH}), '.') { my $abs = File::Spec->catfile($dir, $_[1]); return $abs if (-x $abs or $abs = MM->maybe_command($abs)); } return; } # can we locate a (the) C compiler sub can_cc { my $self = shift; my @chunks = split(/ /, $Config::Config{cc}) or return; # $Config{cc} may contain args; try to find out the program part while (@chunks) { return $self->can_run("@chunks") || (pop(@chunks), next); } return; } # Fix Cygwin bug on maybe_command(); if ( $^O eq 'cygwin' ) { require ExtUtils::MM_Cygwin; require ExtUtils::MM_Win32; if ( ! defined(&ExtUtils::MM_Cygwin::maybe_command) ) { *ExtUtils::MM_Cygwin::maybe_command = sub { my ($self, $file) = @_; if ($file =~ m{^/cygdrive/}i and ExtUtils::MM_Win32->can('maybe_command')) { ExtUtils::MM_Win32->maybe_command($file); } else { ExtUtils::MM_Unix->maybe_command($file); } } } } 1; __END__ #line 157 Params-Coerce-0.14/inc/Module/Install/WriteAll.pm0000644000175000017500000000162410512625550020136 0ustar adamadam#line 1 package Module::Install::WriteAll; use strict; use Module::Install::Base; use vars qw{$VERSION $ISCORE @ISA}; BEGIN { $VERSION = '0.64'; $ISCORE = 1; @ISA = qw{Module::Install::Base}; } sub WriteAll { my $self = shift; my %args = ( meta => 1, sign => 0, inline => 0, check_nmake => 1, @_ ); $self->sign(1) if $args{sign}; $self->Meta->write if $args{meta}; $self->admin->WriteAll(%args) if $self->is_admin; if ( $0 =~ /Build.PL$/i ) { $self->Build->write; } else { $self->check_nmake if $args{check_nmake}; unless ( $self->makemaker_args->{'PL_FILES'} ) { $self->makemaker_args( PL_FILES => {} ); } if ($args{inline}) { $self->Inline->write; } else { $self->Makefile->write; } } } 1; Params-Coerce-0.14/inc/Module/Install/Win32.pm0000644000175000017500000000341610512625550017316 0ustar adamadam#line 1 package Module::Install::Win32; use strict; use Module::Install::Base; use vars qw{$VERSION $ISCORE @ISA}; BEGIN { $VERSION = '0.64'; $ISCORE = 1; @ISA = qw{Module::Install::Base}; } # determine if the user needs nmake, and download it if needed sub check_nmake { my $self = shift; $self->load('can_run'); $self->load('get_file'); require Config; return unless ( $^O eq 'MSWin32' and $Config::Config{make} and $Config::Config{make} =~ /^nmake\b/i and ! $self->can_run('nmake') ); print "The required 'nmake' executable not found, fetching it...\n"; require File::Basename; my $rv = $self->get_file( url => 'http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe', ftp_url => 'ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe', local_dir => File::Basename::dirname($^X), size => 51928, run => 'Nmake15.exe /o > nul', check_for => 'Nmake.exe', remove => 1, ); if (!$rv) { die <<'END_MESSAGE'; ------------------------------------------------------------------------------- Since you are using Microsoft Windows, you will need the 'nmake' utility before installation. It's available at: http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe or ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe Please download the file manually, save it to a directory in %PATH% (e.g. C:\WINDOWS\COMMAND\), then launch the MS-DOS command line shell, "cd" to that directory, and run "Nmake15.exe" from there; that will create the 'nmake.exe' file needed by this module. You may then resume the installation process described in README. ------------------------------------------------------------------------------- END_MESSAGE } } 1; Params-Coerce-0.14/Changes0000644000175000017500000000232610512625547013752 0ustar adamadamRevision history for Perl extension Param::Coerce 0.14 Tue 10 Oct 2006 - Moving from old CVS to new SVN repository - Cleaning up tests to remove the File::Spec dependency - Upgrading to Module::Install 0.64 0.13 Fri Jun 10 2005 - Converting a number of dies to Carp::croak (like they should be) 0.12 Fri Jun 10 2005 - Made ->from work sanely with sub-classes 0.11 Sun Jun 5 2005 - Added the ->from constructor to be imported - Converted to Params::Util 0.10 Sat Apr 23 2005 - Allowing param coercion methods to also work as functions 0.09 Fri Apr 22 2005 - Updating the author email to that META.yaml doesn't break 0.08 Fri Apr 22 2005 - Moved to Params::Coerce in line with other similar modules 0.07 Tue Feb 15 2005 - Removing braindead Build.PL 0.06 Mon Oct 11 2004 - Fixed a class loading bug 0.05 Wed Oct 6 2004 - Moved to a more flexible hint format 0.04 Sun Oct 4 2004 - Added support for __from methods - Cut load overhead down to 52k 0.03 Sat Oct 3 2004 - Cut load overhead down to 56k 0.02 Sat Oct 3 2004 - Tried to make the documentation a bit more readable 0.01 Sat Oct 2 2004 - Completed the first implementation 0.01_01 Sat Oct 2 2004 - Create the specification for the module Params-Coerce-0.14/MANIFEST0000644000175000017500000000060410512625550013577 0ustar adamadamChanges inc/Module/Install.pm inc/Module/Install/Base.pm inc/Module/Install/Can.pm inc/Module/Install/Fetch.pm inc/Module/Install/Makefile.pm inc/Module/Install/Metadata.pm inc/Module/Install/Win32.pm inc/Module/Install/WriteAll.pm lib/Params/Coerce.pm LICENSE Makefile.PL MANIFEST This list of files META.yml README t/01_compile.t t/02_support.t t/03_usage.t t/04_from.t t/99_author.t Params-Coerce-0.14/lib/0000755000175000017500000000000010512625552013216 5ustar adamadamParams-Coerce-0.14/lib/Params/0000755000175000017500000000000010512625552014441 5ustar adamadamParams-Coerce-0.14/lib/Params/Coerce.pm0000644000175000017500000002650610512625547016214 0ustar adamadampackage Params::Coerce; =pod =head1 NAME Params::Coerce - Allows your classes to do coercion of parameters =head1 SYNOPSIS # Coerce a object of class Foo to a Bar my $bar = Params::Coerce::coerce('Bar', $Foo) # Create a coercion param function use Params::Coerce '_Bar' => 'Bar'; my $bar = _Bar($Foo); # Usage when Bar has a 'from' method my $bar = Bar->from($Foo); Real world example using L. # My class needs a URI package Web::Spider; use URI; use Params::Coerce 'coerce'; sub new { my $class = shift; # Where do we start spidering my $start = coerce('URI', shift) or die "Wasn't passed a URI"; bless { root => $start }, $class; } ############################################# # Now we can do the following # Pass a URI as normal my $URI = URI->new('http://ali.as/'); my $Spider1 = Web::Spider->new( $URI ); # We can also pass anything that can be coerced into being a URI my $Website = HTML::Location->new( '/home/adam/public_html', 'http://ali.as' ); my $Spider2 = Web::Spider->new( $Website ); =head1 DESCRIPTION A big part of good API design is that we should be able to be flexible in the ways that we take parameters. Params::Coerce attempts to encourage this, by making it easier to take a variety of different arguments, while adding negligable additional complexity to your code. =head2 What is Coercion "Coercion" in computing terms generally referse to "implicit type conversion". This is where data and object are converted from one type to another behind the scenes, and you just just magically get what you need. The L pragma, and its string overloading is the form of coercion you are most likely to have encountered in Perl programming. In this case, your object is automatically (within perl itself) coerced into a string. C is intended for higher-order coercion between various types of different objects, for use mainly in subroutine and (mostly) method parameters, particularly on external APIs. =head2 __as_Another_Class Methods At the heart of C is the ability to transform objects from one thing to another. This can be done by a variety of different mechanisms. The prefered mechanism for this is by creating a specially named method in a class that indicates it can be coerced into another type of object. As an example, L provides an object method that returns an equivalent L object. # In the package HTML::Location # Coerce to a URI sub __as_URI { my $self = shift; return URI->new( $self->uri ); } =head2 __from_Another_Class Methods From version 0.04 of C, you may now also provide __from_Another_Class methods as well. In the above example, rather then having to define a method in L, you may instead define one in L. The following code has an identical effect. # In the package URI # Coerce from a HTML::Location sub __from_HTML_Location { my $Location = shift; return URI->new( $Location->uri ); } C will only look for the __from method, if it does not find a __as method. =head2 Loading Classes One thing to note with the C<__as_Another_Class> methods is that you are B required to load the class you are converting to in the class you are converting from. In the above example, L does B have to load the URI class. The need to load the classes for every object we might some day need to be coerced to would result in highly excessive resource usage. Instead, C guarentees that the class you are converting to C be loaded before it calls the __as_Another_Class method. Of course, in most situations you will have already loaded it for another purpose in either the From or To classes and this won't be an issue. If you make use of some class B the class you are being coerced to in the __as_Another_Class method, you will need to make sure that is loaded in your code, but it is suggested that you do it at run-time with a C if you are not using it already elsewhere. =head2 Coercing a Parameter The most explicit way of accessing the coercion functionality is with the Params::Coerce::coerce function. It takes as its first argument the name of the class you wish to coerce B, followed by the parameter to which you wish to apply the coercion. package My::Class; use URI (); use Params::Coerce '_URI' => 'URI'; sub new { my $class = shift; # Take a URI argument my $URI = Params::Coerce::coerce('URI', shift) or return; ... } For people doing procedural programming, you may also import this function. # Import the coerce function use Params::Coerce 'coerce'; Please note thatThe C function is the B function that can be imported, and that the two argument pragma (or the passing of two or more arguments to ->import) means something different entirely. =head2 Importing Parameter Coercion Methods The second way of using Params::Coerce, and the more common one for Object-Oriented programming, is to create method specifically for taking parameters in a coercing manner. package My::Class; use URI (); use Params::Coerce '_URI' => 'URI'; sub new { my $class = shift; # Take a URI as parameter my $URI1 = $class->_URI(shift) or return; my $URI2 = _URI(shift) or return; ... } =head2 The C Constructor From version C<0.11> of C, an additional mechanism is available with the importable C constructor. package My::Class; use Params::Coerce 'from'; package Other::Class; sub method { my $self = shift; my $My = My::Class->from(shift) or die "Bad param"; ... } This is mainly a convenience. The above is equivalent to package My::Class; use Params::Coerce 'from' => 'Params::Coerce'; In future versions, this C<-Efrom> syntax may also tweak the resolution order of the coercion. =head2 Chained Coercion While it is intended that Params::Coerce will eventually support coercion using multiple steps, like C<__as_HTML_Location->__as_URI>>, it is not currently capable of this. At this time only a single coercion step is supported. =head1 FUNCTIONS =cut use 5.005; use strict; use Carp (); use Scalar::Util (); use Params::Util '_IDENTIFIER', '_INSTANCE', '_CLASS'; # Load Overhead: 52k use vars qw{$VERSION}; BEGIN { $VERSION = '0.14'; } # The hint cache my %hints = (); ##################################################################### # Use as a Pragma sub import { my $class = shift; my @param = @_ or return; Carp::croak("Too many parameters") if @param > 2; # Um, what? # We'll need to know who is calling us my $pkg = caller(); # We export them the coerce function if they want it if ( @param == 1 ) { if ( $param[0] eq 'coerce' ) { no strict 'refs'; *{"${pkg}::coerce"} = *coerce; return 1; } elsif ( $param[0] eq 'from' ) { # They want a from constructor no strict 'refs'; *{"${pkg}::from"} = *from; return 1; } else { Carp::croak "Params::Coerce does not export '$_[0]'"; } } # The two argument form is 'method' => 'class' # Check the values given to us. my $method = _IDENTIFIER($param[0]) or Carp::croak "Illegal method name '$param[0]'"; my $want = _CLASS($param[1]) or Carp::croak "Illegal class name '$param[1]'"; _function_exists($pkg, $method) and Carp::croak "Cannot create '${pkg}::$method'. It already exists"; # Make sure the class is loaded unless ( _loaded($want) ) { eval "require $want"; croak($@) if $@; } # Create the method in our caller eval "package $pkg;\nsub $method {\n\tParams::Coerce::_coerce('$want', \$_[-1])\n}"; Carp::croak("Failed to create coercion method '$method' in $pkg': $@") if $@; 1; } =pod =head2 coerce $class, $param The C function takes a class name and a single parameter and attempts to coerce the parameter into the intended class, or one of its subclasses. Please note that it is the responsibility of the consuming class to ensure that the class you wish to coerce to is loaded. C will check this and die is it is not loaded. Returns an instance of the class you specify, or one of its subclasses. Returns C if the parameter cannot be coerced into the class you wish. =cut sub coerce($$) { # Check what they want properly first my $want = _CLASS($_[0]) or Carp::croak("Illegal class name '$_[0]'"); _loaded($want) or Carp::croak("Tried to coerce to unloaded class '$want'"); # Now call the real function _coerce($want, $_[1]); } # The from method that is imported into the classes sub from { @_ == 2 or Carp::croak("'->from must be called as a method with a single param"); _coerce(@_); } # Internal version with less checks. Should ONLY be called once # the first argument is FULLY validated. sub _coerce { my $want = shift; my $have = Scalar::Util::blessed($_[0]) ? shift : return undef; # In the simplest case it is already what we need return $have if $have->isa($want); # Is there a coercion hint for this combination my $key = ref($have) . ',' . $want; my $hint = exists $hints{$key} ? $hints{$key} : _resolve($want, ref($have), $key) or return undef; # Call the coercion function my $type = substr($hint, 0, 1, ''); if ( $type eq '>' ) { # Direct Push $have = $have->$hint(); } elsif ( $type eq '<' ) { # Direct Pull $have = $want->$hint($have); } elsif ( $type eq '^' ) { # Third party my ($pkg, $function) = $hint =~ m/^(.*)::(.*)$/s; require $pkg; no strict 'refs'; $have = &{"${pkg}::${function}"}($have); } else { Carp::croak("Unknown coercion hint '$type$hint'"); } # Did we get what we wanted? _INSTANCE($have, $want); } # Try to work out how to get from one class to the other class sub _resolve { my ($want, $have, $key) = @_; # Look for a __as method my $method = "__as_$want"; $method =~ s/::/_/g; return _hint($key, ">$method") if $have->can($method); # Look for a direct __from method $method = "__from_$have"; $method =~ s/::/_/g; return _hint($key, "<$method") if $want->can($method); # Give up (and don't try again). # We use zero specifically so it will return false in boolean context _hint($key, '0'); } # For now just save to the memory hash. # Later, this may also involve saving to a database somewhere. sub _hint { $hints{$_[0]} = $_[1]; } ##################################################################### # Support Functions # Is a class loaded. sub _loaded { no strict 'refs'; foreach ( keys %{"$_[0]::"} ) { return 1 unless substr($_, -2, 2) eq '::'; } ''; } # Does a function exist. sub _function_exists { no strict 'refs'; defined &{"$_[0]::$_[1]"}; } 1; =pod =head1 TO DO - Write more unit tests - Implement chained coercion - Provide a way to coerce to string, int, etc that is compatible with L and other types of things. =head1 SUPPORT Bugs should always be submitted via the CPAN bug tracker L For other issues, contact the maintainer =head1 AUTHORS Adam Kennedy Eadamk@cpan.orgE =head1 COPYRIGHT Copyright 2004 - 2006 Adam Kennedy. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module. =cut Params-Coerce-0.14/META.yml0000644000175000017500000000056210512625550013722 0ustar adamadamabstract: Allows your classes to do coercion of parameters author: Adam Kennedy build_requires: Test::More: 0.47 distribution_type: module generated_by: Module::Install version 0.64 license: perl name: Params-Coerce no_index: directory: - inc - t requires: Carp: 0 Params::Util: 0.05 Scalar::Util: 1.11 perl: 5.005 version: 0.14 Params-Coerce-0.14/t/0000755000175000017500000000000010512625552012713 5ustar adamadamParams-Coerce-0.14/t/01_compile.t0000644000175000017500000000030610512625547015033 0ustar adamadam#!/usr/bin/perl -w # Load testing for Params::Coerce use strict; BEGIN { $| = 1; $^W = 1; } use Test::More tests => 2; ok( $] >= 5.005, "Your perl is new enough" ); use_ok('Params::Coerce'); Params-Coerce-0.14/t/02_support.t0000644000175000017500000000155310512625547015125 0ustar adamadam#!/usr/bin/perl -w # Support method testing for Params::Coerce use strict; BEGIN { $| = 1; $^W = 1; } use Test::More tests => 5; use Params::Coerce (); ##################################################################### # Begin testing support methods # Test _loaded ok( Params::Coerce::_loaded('Params::Coerce'), '_loaded returns true for Params::Coerce' ); ok( ! Params::Coerce::_loaded('Params::Coerce::Bad'), '_loaded returns false for Params::Coerce::Bad' ); # Test _function_exists ok( Params::Coerce::_function_exists('Params::Coerce', '_function_exists'), '_function_exists sees itself' ); ok( ! Params::Coerce::_function_exists('Foo', 'bar'), '_function_exists doesn\' see non-existant function' ); ok( ! Params::Coerce::_function_exists('Params::Coerce', 'VERSION'), '_function_exists does not return true for other variable types' ); exit(0); Params-Coerce-0.14/t/04_from.t0000644000175000017500000000167510512625547014363 0ustar adamadam#!/usr/bin/perl -w # Using Params::Coerce the correct way, and "does stuff happen" tests use strict; BEGIN { $| = 1; $^W = 1; } use Test::More tests => 6; use Params::Coerce; ##################################################################### # Check the behaviour of ->from with subclasses my $Foo = Foo->new; isa_ok( $Foo, 'Foo' ); my $Bar = Bar->from($Foo); isa_ok( $Bar, 'Bar' ); isa_ok( $Bar->was, 'Foo' ); my $Baz = Bar::Baz->from($Foo); isa_ok( $Baz, 'Bar' ); isa_ok( $Baz, 'Bar::Baz' ); isa_ok( $Baz->was, 'Foo' ); ##################################################################### # Create all the testing packages we needed for this package Foo; sub new { bless {}, shift; } sub __as_Bar { bless { was => shift }, 'Bar'; } sub __as_Bar_Baz { bless { was => shift }, 'Bar::Baz'; } package Bar; use Params::Coerce 'from'; sub was { $_[0]->{was} } package Bar::Baz; use vars qw{@ISA}; BEGIN { @ISA = 'Bar'; } 1; Params-Coerce-0.14/t/99_author.t0000644000175000017500000000247610512625547014740 0ustar adamadam#!/usr/bin/perl -w use strict; BEGIN { $| = 1; $^W = 1; } use Test::More; # Skip if doing a regular install unless ( $ENV{AUTOMATED_TESTING} ) { plan( skip_all => "Author tests not required for installation" ); } # Can we run the POD tests? eval "use Test::Pod 1.00"; if ( $@ ) { plan( skip_all => "Test::Pod 1.00 required for testing POD" ); } ##################################################################### # WARNING: INSANE BLACK MAGIC ##################################################################### # Hack Pod::Simple::BlackBox to ignore the Test::Inline # "Extended Begin" syntax. # For example, "=begin has more than one word errors" my $begin = \&Pod::Simple::BlackBox::_ponder_begin; sub mybegin { my $para = $_[1]; my $content = join ' ', splice @$para, 2; $content =~ s/^\s+//s; $content =~ s/\s+$//s; my @words = split /\s+/, $content; if ( $words[0] =~ /^test(?:ing)?\z/s ) { foreach ( 2 .. $#$para ) { $para->[$_] = ''; } $para->[2] = $words[0]; } # Continue as normal push @$para, @words; return &$begin(@_); } SCOPE: { local $^W = 0; *Pod::Simple::BlackBox::_ponder_begin = \&mybegin; } ##################################################################### # END BLACK MAGIC ##################################################################### # Test POD all_pod_files_ok(); Params-Coerce-0.14/t/03_usage.t0000644000175000017500000000721210512625547014514 0ustar adamadam#!/usr/bin/perl -w # Using Params::Coerce the correct way, and "does stuff happen" tests use strict; BEGIN { $| = 1; $^W = 1; } use Test::More tests => 34; use Params::Coerce; ##################################################################### # Did various things get created ok( Params::Coerce::_function_exists('Foo::Bar::Usage2', 'coerce'), "use Params::Coerce 'coerce'; # Imported something" ); ok( Params::Coerce::_function_exists('Foo::Bar::Usage3', '_Bar'), "use Params::Coerce '_Bar' => 'Bar'; # Created something" ); ##################################################################### # Test the usage of the various ways { # Usage 1 my $Bar = Bar->new; isa_ok( $Bar, 'Bar' ); my $Foo = Foo->new; isa_ok( $Foo, 'Foo' ); my $Usage = Foo::Bar::Usage1->new( $Bar ); isa_ok( $Usage, 'Foo::Bar::Usage1' ); isa_ok( $Usage->{Bar}, 'Bar' ); $Usage = Foo::Bar::Usage1->new( $Foo ); isa_ok( $Usage, 'Foo::Bar::Usage1' ); isa_ok( $Usage->{Bar}, 'Bar' ); } { # Usage 2 my $Bar = Bar->new; isa_ok( $Bar, 'Bar' ); my $Foo = Foo->new; isa_ok( $Foo, 'Foo' ); my $Usage = Foo::Bar::Usage2->new( $Bar ); isa_ok( $Usage, 'Foo::Bar::Usage2' ); isa_ok( $Usage->{Bar}, 'Bar' ); $Usage = Foo::Bar::Usage2->new( $Foo ); isa_ok( $Usage, 'Foo::Bar::Usage2' ); isa_ok( $Usage->{Bar}, 'Bar' ); } { # Usage 3 my $Bar = Bar->new; isa_ok( $Bar, 'Bar' ); my $Foo = Foo->new; isa_ok( $Foo, 'Foo' ); my $Usage = Foo::Bar::Usage3->new( $Bar ); isa_ok( $Usage, 'Foo::Bar::Usage3' ); isa_ok( $Usage->{Bar}, 'Bar' ); $Usage = Foo::Bar::Usage3->new( $Foo ); isa_ok( $Usage, 'Foo::Bar::Usage3' ); isa_ok( $Usage->{Bar}, 'Bar' ); } { # Usage 4 my $Bar = Bar->new; isa_ok( $Bar, 'Bar' ); my $Foo = Foo->new; isa_ok( $Foo, 'Foo' ); my $Usage = Foo::Bar::Usage4->new( $Bar ); isa_ok( $Usage, 'Foo::Bar::Usage4' ); isa_ok( $Usage->{Bar}, 'Bar' ); $Usage = Foo::Bar::Usage4->new( $Foo ); isa_ok( $Usage, 'Foo::Bar::Usage4' ); isa_ok( $Usage->{Bar}, 'Bar' ); } { # Usage 5 my $Bar = Bar->new; isa_ok( $Bar, 'Bar' ); my $Foo = Foo->new; isa_ok( $Foo, 'Foo' ); my $Usage = Foo::Bar::Usage5->new( $Bar ); isa_ok( $Usage, 'Foo::Bar::Usage5' ); isa_ok( $Usage->{Bar}, 'Bar' ); $Usage = Foo::Bar::Usage5->new( $Foo ); isa_ok( $Usage, 'Foo::Bar::Usage5' ); isa_ok( $Usage->{Bar}, 'Bar' ); } { # __from coercion my $Bar = Bar->new; isa_ok( $Bar, 'Bar' ); my $Foo = Params::Coerce::coerce 'Foo', $Bar; isa_ok( $Foo, 'Foo' ); } ##################################################################### # Create all the testing packages we needed for this package Bar; use Params::Coerce 'from'; sub new { bless { }, shift; } package Foo; sub new { bless {}, shift; } sub __as_Bar { Bar->new } sub __from_Bar { Foo->new } package Foo::Bar::Usage1; use Params::Coerce; sub new { my $class = shift; my $Bar = Params::Coerce::coerce 'Bar', shift or die 'Params::Coerce::coerce usage test failed'; bless { Bar => $Bar }, $class; } package Foo::Bar::Usage2; use Params::Coerce 'coerce'; sub new { my $class = shift; my $Bar = coerce 'Bar', shift or die 'Imported coerce usage test failed'; bless { Bar => $Bar }, $class; } package Foo::Bar::Usage3; use Params::Coerce '_Bar' => 'Bar'; sub new { my $class = shift; my $Bar = $class->_Bar(shift) or die 'Method usage test failed'; bless { Bar => $Bar }, $class; } package Foo::Bar::Usage4; use Params::Coerce '_Bar' => 'Bar'; sub new { my $class = shift; my $Bar = _Bar(shift) or die 'Method usage test failed'; bless { Bar => $Bar }, $class; } package Foo::Bar::Usage5; sub new { my $class = shift; my $Bar = Bar->from(shift) or die 'Method usage test failed'; bless { Bar => $Bar }, $class; } 1; Params-Coerce-0.14/LICENSE0000644000175000017500000004737110512625547013475 0ustar adamadam Terms of Perl itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" ---------------------------------------------------------------------------- The General Public License (GPL) Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave, Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS ---------------------------------------------------------------------------- The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End Params-Coerce-0.14/Makefile.PL0000644000175000017500000000044510512625547014431 0ustar adamadamuse strict; use inc::Module::Install; name 'Params-Coerce'; all_from 'lib/Params/Coerce.pm'; requires 'Carp' => 0 ; requires 'Scalar::Util' => '1.11'; requires 'Params::Util' => '0.05'; build_requires 'Test::More' => '0.47'; WriteAll; Params-Coerce-0.14/README0000644000175000017500000001754010512625547013343 0ustar adamadamNAME Params::Coerce - Allows your classes to do coercion of parameters SYNOPSIS # Coerce a object of class Foo to a Bar my $bar = Params::Coerce::coerce('Bar', $Foo) # Create a coercion param function use Params::Coerce '_Bar' => 'Bar'; my $bar = _Bar($Foo); # Usage when Bar has a 'from' method my $bar = Bar->from($Foo); Real world example using HTML::Location. # My class needs a URI package Web::Spider; use URI; use Params::Coerce 'coerce'; sub new { my $class = shift; # Where do we start spidering my $start = coerce('URI', shift) or die "Wasn't passed a URI"; bless { root => $start }, $class; } ############################################# # Now we can do the following # Pass a URI as normal my $URI = URI->new('http://ali.as/'); my $Spider1 = Web::Spider->new( $URI ); # We can also pass anything that can be coerced into being a URI my $Website = HTML::Location->new( '/home/adam/public_html', 'http://ali.as' ); my $Spider2 = Web::Spider->new( $Website ); DESCRIPTION A big part of good API design is that we should be able to be flexible in the ways that we take parameters. Params::Coerce attempts to encourage this, by making it easier to take a variety of different arguments, while adding negligable additional complexity to your code. What is Coercion "Coercion" in computing terms generally referse to "implicit type conversion". This is where data and object are converted from one type to another behind the scenes, and you just just magically get what you need. The overload pragma, and its string overloading is the form of coercion you are most likely to have encountered in Perl programming. In this case, your object is automatically (within perl itself) coerced into a string. "Params::Coerce" is intended for higher-order coercion between various types of different objects, for use mainly in subroutine and (mostly) method parameters, particularly on external APIs. __as_Another_Class Methods At the heart of "Params::Coerce" is the ability to transform objects from one thing to another. This can be done by a variety of different mechanisms. The prefered mechanism for this is by creating a specially named method in a class that indicates it can be coerced into another type of object. As an example, HTML::Location provides an object method that returns an equivalent URI object. # In the package HTML::Location # Coerce to a URI sub __as_URI { my $self = shift; return URI->new( $self->uri ); } __from_Another_Class Methods From version 0.04 of "Params::Coerce", you may now also provide __from_Another_Class methods as well. In the above example, rather then having to define a method in HTML::Location, you may instead define one in URI. The following code has an identical effect. # In the package URI # Coerce from a HTML::Location sub __from_HTML_Location { my $Location = shift; return URI->new( $Location->uri ); } "Params::Coerce" will only look for the __from method, if it does not find a __as method. Loading Classes One thing to note with the "__as_Another_Class" methods is that you are not required to load the class you are converting to in the class you are converting from. In the above example, HTML::Location does not have to load the URI class. The need to load the classes for every object we might some day need to be coerced to would result in highly excessive resource usage. Instead, "Params::Coerce" guarentees that the class you are converting to "will" be loaded before it calls the __as_Another_Class method. Of course, in most situations you will have already loaded it for another purpose in either the From or To classes and this won't be an issue. If you make use of some class other than the class you are being coerced to in the __as_Another_Class method, you will need to make sure that is loaded in your code, but it is suggested that you do it at run-time with a "require" if you are not using it already elsewhere. Coercing a Parameter The most explicit way of accessing the coercion functionality is with the Params::Coerce::coerce function. It takes as its first argument the name of the class you wish to coerce to, followed by the parameter to which you wish to apply the coercion. package My::Class; use URI (); use Params::Coerce '_URI' => 'URI'; sub new { my $class = shift; # Take a URI argument my $URI = Params::Coerce::coerce('URI', shift) or return; ... } For people doing procedural programming, you may also import this function. # Import the coerce function use Params::Coerce 'coerce'; Please note thatThe "coerce|Params::Coerce" function is the only function that can be imported, and that the two argument pragma (or the passing of two or more arguments to ->import) means something different entirely. Importing Parameter Coercion Methods The second way of using Params::Coerce, and the more common one for Object-Oriented programming, is to create method specifically for taking parameters in a coercing manner. package My::Class; use URI (); use Params::Coerce '_URI' => 'URI'; sub new { my $class = shift; # Take a URI as parameter my $URI1 = $class->_URI(shift) or return; my $URI2 = _URI(shift) or return; ... } The "from" Constructor From version 0.11 of "Params::Coerce", an additional mechanism is available with the importable "from" constructor. package My::Class; use Params::Coerce 'from'; package Other::Class; sub method { my $self = shift; my $My = My::Class->from(shift) or die "Bad param"; ... } This is mainly a convenience. The above is equivalent to package My::Class; use Params::Coerce 'from' => 'Params::Coerce'; In future versions, this "->from" syntax may also tweak the resolution order of the coercion. Chained Coercion While it is intended that Params::Coerce will eventually support coercion using multiple steps, like "__as_URI>>, it is not currently capable of this. At this time only a single coercion step is supported. FUNCTIONS coerce $class, $param The "coerce" function takes a class name and a single parameter and attempts to coerce the parameter into the intended class, or one of its subclasses. Please note that it is the responsibility of the consuming class to ensure that the class you wish to coerce to is loaded. "coerce" will check this and die is it is not loaded. Returns an instance of the class you specify, or one of its subclasses. Returns "undef" if the parameter cannot be coerced into the class you wish. TO DO - Write more unit tests - Implement chained coercion - Provide a way to coerce to string, int, etc that is compatible with overload and other types of things. SUPPORT Bugs should always be submitted via the CPAN bug tracker For other issues, contact the maintainer AUTHORS Adam Kennedy COPYRIGHT Copyright 2004 - 2006 Adam Kennedy. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module.