Changeset 16508

Timestamp:

07/25/08 23:13:18 (5 years ago)

Author:

hanekomu

Message:

continued to update distribution to standard style

Location:

lang/perl/String-BlackWhiteList/trunk

Files:

• Changes (modified) (1 diff)
• MANIFEST (modified) (1 diff)
• MANIFEST.SKIP (modified) (2 diffs)
• Makefile.PL (modified) (1 diff)
• lib/String/BlackWhiteList.pm (modified) (3 diffs)

lang/perl/String-BlackWhiteList/trunk/Changes

@@ -1 +1 @@
 Revision history for Perl extension String-BlackWhiteList
+
+0.06  Thu Jul 25 15:27:43 CEST 2008 (Marcel Gruenauer <marcel@cpan.org>)
+     - Changed dist style and Changes back to standard. People didn't like it -
+       the nail that sticks out gets hammered down.
+     - Added standard test files; this will also help with CPANTS.
 
 0.05  Thu, 29 May 2008 12:07:45 -0000 (Marcel Gruenauer <marcel@cpan.org>)

lang/perl/String-BlackWhiteList/trunk/MANIFEST

@@ -9 +9 @@
 inc/Module/Install/Makefile.pm
 inc/Module/Install/Metadata.pm
-inc/Module/Install/StandardTests.pm
-inc/Module/Install/Template.pm
 inc/Module/Install/Win32.pm
 inc/Module/Install/WriteAll.pm
 inc/Test/Compile.pm
 inc/Test/More.pm
-inc/UNIVERSAL/require.pm
 lib/String/BlackWhiteList.pm
 LICENSE

lang/perl/String-BlackWhiteList/trunk/MANIFEST.SKIP

@@ -10 +10 @@
 ^Build$
 ^blib/
+^pm_to_blib/
 ^_build/
 ^MakeMaker-\d
@@ -27 +28 @@
 \.old$
 \.swp$
+\.tar$
+\.tar\.gz$
 ^#.*#$
 ^\.#

lang/perl/String-BlackWhiteList/trunk/Makefile.PL

@@ -8 +8 @@
 requires 'Class::Accessor::Complex' => '0.12';
 
-build_requires 'Test::More' => '0.70';
+recommends 'Test::Pod';
+recommends 'Test::Pod::Coverage';
 
-process_templates(
-    first_year => 2005,
-    rest_from  => "$ENV{HOME}/.mitlib/standard_pod",
-    start_tag  => '{%',
-    end_tag    => '%}',
-);
+test_requires 'Test::More' => '0.70';
+test_requires 'Test::Compile';
 
-use_standard_tests(without => 'pod_coverage');
 auto_install;
 auto_include;

lang/perl/String-BlackWhiteList/trunk/lib/String/BlackWhiteList.pm

@@ -95 +95 @@
 __END__
 
-{% USE p = PodGenerated %}
+
 
 =head1 NAME
@@ -165 +165 @@
 =over 4
 
-{% p.write_methods %}
+=item new
+
+    my $obj = String::BlackWhiteList->new;
+    my $obj = String::BlackWhiteList->new(%args);
+
+Creates and returns a new object. The constructor will accept as arguments a
+list of pairs, from component name to initial value. For each pair, the named
+component is initialized by calling the method of the same name with the given
+value. If called with a single hash reference, it is dereferenced and its
+key/value pairs are set as described before.
+
+=item black_re
+
+    my $value = $obj->black_re;
+    $obj->black_re($value);
+
+A basic getter/setter method. If called without an argument, it returns the
+value. If called with a single argument, it sets the value.
+
+=item black_re_clear
+
+    $obj->black_re_clear;
+
+Clears the value.
+
+=item blacklist
+
+    my @values    = $obj->blacklist;
+    my $array_ref = $obj->blacklist;
+    $obj->blacklist(@values);
+    $obj->blacklist($array_ref);
+
+Get or set the array values. If called without an arguments, it returns the
+array in list context, or a reference to the array in scalar context. If
+called with arguments, it expands array references found therein and sets the
+values.
+
+=item blacklist_clear
+
+    $obj->blacklist_clear;
+
+Deletes all elements from the array.
+
+=item blacklist_count
+
+    my $count = $obj->blacklist_count;
+
+Returns the number of elements in the array.
+
+=item blacklist_index
+
+    my $element   = $obj->blacklist_index(3);
+    my @elements  = $obj->blacklist_index(@indices);
+    my $array_ref = $obj->blacklist_index(@indices);
+
+Takes a list of indices and returns the elements indicated by those indices.
+If only one index is given, the corresponding array element is returned. If
+several indices are given, the result is returned as an array in list context
+or as an array reference in scalar context.
+
+=item blacklist_pop
+
+    my $value = $obj->blacklist_pop;
+
+Pops the last element off the array, returning it.
+
+=item blacklist_push
+
+    $obj->blacklist_push(@values);
+
+Pushes elements onto the end of the array.
+
+=item blacklist_set
+
+    $obj->blacklist_set(1 => $x, 5 => $y);
+
+Takes a list of index/value pairs and for each pair it sets the array element
+at the indicated index to the indicated value. Returns the number of elements
+that have been set.
+
+=item blacklist_shift
+
+    my $value = $obj->blacklist_shift;
+
+Shifts the first element off the array, returning it.
+
+=item blacklist_splice
+
+    $obj->blacklist_splice(2, 1, $x, $y);
+    $obj->blacklist_splice(-1);
+    $obj->blacklist_splice(0, -1);
+
+Takes three arguments: An offset, a length and a list.
+
+Removes the elements designated by the offset and the length from the array,
+and replaces them with the elements of the list, if any. In list context,
+returns the elements removed from the array. In scalar context, returns the
+last element removed, or C<undef> if no elements are removed. The array grows
+or shrinks as necessary. If the offset is negative then it starts that far
+from the end of the array. If the length is omitted, removes everything from
+the offset onward. If the length is negative, removes the elements from the
+offset onward except for -length elements at the end of the array. If both the
+offset and the length are omitted, removes everything. If the offset is past
+the end of the array, it issues a warning, and splices at the end of the
+array.
+
+=item blacklist_unshift
+
+    $obj->blacklist_unshift(@values);
+
+Unshifts elements onto the beginning of the array.
+
+=item clear_black_re
+
+    $obj->clear_black_re;
+
+Clears the value.
+
+=item clear_blacklist
+
+    $obj->clear_blacklist;
+
+Deletes all elements from the array.
+
+=item clear_is_literal_text
+
+    $obj->clear_is_literal_text;
+
+Clears the boolean value by setting it to 0.
+
+=item clear_white_re
+
+    $obj->clear_white_re;
+
+Clears the value.
+
+=item clear_whitelist
+
+    $obj->clear_whitelist;
+
+Deletes all elements from the array.
+
+=item count_blacklist
+
+    my $count = $obj->count_blacklist;
+
+Returns the number of elements in the array.
+
+=item count_whitelist
+
+    my $count = $obj->count_whitelist;
+
+Returns the number of elements in the array.
+
+=item index_blacklist
+
+    my $element   = $obj->index_blacklist(3);
+    my @elements  = $obj->index_blacklist(@indices);
+    my $array_ref = $obj->index_blacklist(@indices);
+
+Takes a list of indices and returns the elements indicated by those indices.
+If only one index is given, the corresponding array element is returned. If
+several indices are given, the result is returned as an array in list context
+or as an array reference in scalar context.
+
+=item index_whitelist
+
+    my $element   = $obj->index_whitelist(3);
+    my @elements  = $obj->index_whitelist(@indices);
+    my $array_ref = $obj->index_whitelist(@indices);
+
+Takes a list of indices and returns the elements indicated by those indices.
+If only one index is given, the corresponding array element is returned. If
+several indices are given, the result is returned as an array in list context
+or as an array reference in scalar context.
+
+=item is_literal_text
+
+    $obj->is_literal_text($value);
+    my $value = $obj->is_literal_text;
+
+If called without an argument, returns the boolean value (0 or 1). If called
+with an argument, it normalizes it to the boolean value. That is, the values
+0, undef and the empty string become 0; everything else becomes 1.
+
+=item is_literal_text_clear
+
+    $obj->is_literal_text_clear;
+
+Clears the boolean value by setting it to 0.
+
+=item is_literal_text_set
+
+    $obj->is_literal_text_set;
+
+Sets the boolean value to 1.
+
+=item pop_blacklist
+
+    my $value = $obj->pop_blacklist;
+
+Pops the last element off the array, returning it.
+
+=item pop_whitelist
+
+    my $value = $obj->pop_whitelist;
+
+Pops the last element off the array, returning it.
+
+=item push_blacklist
+
+    $obj->push_blacklist(@values);
+
+Pushes elements onto the end of the array.
+
+=item push_whitelist
+
+    $obj->push_whitelist(@values);
+
+Pushes elements onto the end of the array.
+
+=item set_blacklist
+
+    $obj->set_blacklist(1 => $x, 5 => $y);
+
+Takes a list of index/value pairs and for each pair it sets the array element
+at the indicated index to the indicated value. Returns the number of elements
+that have been set.
+
+=item set_is_literal_text
+
+    $obj->set_is_literal_text;
+
+Sets the boolean value to 1.
+
+=item set_whitelist
+
+    $obj->set_whitelist(1 => $x, 5 => $y);
+
+Takes a list of index/value pairs and for each pair it sets the array element
+at the indicated index to the indicated value. Returns the number of elements
+that have been set.
+
+=item shift_blacklist
+
+    my $value = $obj->shift_blacklist;
+
+Shifts the first element off the array, returning it.
+
+=item shift_whitelist
+
+    my $value = $obj->shift_whitelist;
+
+Shifts the first element off the array, returning it.
+
+=item splice_blacklist
+
+    $obj->splice_blacklist(2, 1, $x, $y);
+    $obj->splice_blacklist(-1);
+    $obj->splice_blacklist(0, -1);
+
+Takes three arguments: An offset, a length and a list.
+
+Removes the elements designated by the offset and the length from the array,
+and replaces them with the elements of the list, if any. In list context,
+returns the elements removed from the array. In scalar context, returns the
+last element removed, or C<undef> if no elements are removed. The array grows
+or shrinks as necessary. If the offset is negative then it starts that far
+from the end of the array. If the length is omitted, removes everything from
+the offset onward. If the length is negative, removes the elements from the
+offset onward except for -length elements at the end of the array. If both the
+offset and the length are omitted, removes everything. If the offset is past
+the end of the array, it issues a warning, and splices at the end of the
+array.
+
+=item splice_whitelist
+
+    $obj->splice_whitelist(2, 1, $x, $y);
+    $obj->splice_whitelist(-1);
+    $obj->splice_whitelist(0, -1);
+
+Takes three arguments: An offset, a length and a list.
+
+Removes the elements designated by the offset and the length from the array,
+and replaces them with the elements of the list, if any. In list context,
+returns the elements removed from the array. In scalar context, returns the
+last element removed, or C<undef> if no elements are removed. The array grows
+or shrinks as necessary. If the offset is negative then it starts that far
+from the end of the array. If the length is omitted, removes everything from
+the offset onward. If the length is negative, removes the elements from the
+offset onward except for -length elements at the end of the array. If both the
+offset and the length are omitted, removes everything. If the offset is past
+the end of the array, it issues a warning, and splices at the end of the
+array.
+
+=item unshift_blacklist
+
+    $obj->unshift_blacklist(@values);
+
+Unshifts elements onto the beginning of the array.
+
+=item unshift_whitelist
+
+    $obj->unshift_whitelist(@values);
+
+Unshifts elements onto the beginning of the array.
+
+=item white_re
+
+    my $value = $obj->white_re;
+    $obj->white_re($value);
+
+A basic getter/setter method. If called without an argument, it returns the
+value. If called with a single argument, it sets the value.
+
+=item white_re_clear
+
+    $obj->white_re_clear;
+
+Clears the value.
+
+=item whitelist
+
+    my @values    = $obj->whitelist;
+    my $array_ref = $obj->whitelist;
+    $obj->whitelist(@values);
+    $obj->whitelist($array_ref);
+
+Get or set the array values. If called without an arguments, it returns the
+array in list context, or a reference to the array in scalar context. If
+called with arguments, it expands array references found therein and sets the
+values.
+
+=item whitelist_clear
+
+    $obj->whitelist_clear;
+
+Deletes all elements from the array.
+
+=item whitelist_count
+
+    my $count = $obj->whitelist_count;
+
+Returns the number of elements in the array.
+
+=item whitelist_index
+
+    my $element   = $obj->whitelist_index(3);
+    my @elements  = $obj->whitelist_index(@indices);
+    my $array_ref = $obj->whitelist_index(@indices);
+
+Takes a list of indices and returns the elements indicated by those indices.
+If only one index is given, the corresponding array element is returned. If
+several indices are given, the result is returned as an array in list context
+or as an array reference in scalar context.
+
+=item whitelist_pop
+
+    my $value = $obj->whitelist_pop;
+
+Pops the last element off the array, returning it.
+
+=item whitelist_push
+
+    $obj->whitelist_push(@values);
+
+Pushes elements onto the end of the array.
+
+=item whitelist_set
+
+    $obj->whitelist_set(1 => $x, 5 => $y);
+
+Takes a list of index/value pairs and for each pair it sets the array element
+at the indicated index to the indicated value. Returns the number of elements
+that have been set.
+
+=item whitelist_shift
+
+    my $value = $obj->whitelist_shift;
+
+Shifts the first element off the array, returning it.
+
+=item whitelist_splice
+
+    $obj->whitelist_splice(2, 1, $x, $y);
+    $obj->whitelist_splice(-1);
+    $obj->whitelist_splice(0, -1);
+
+Takes three arguments: An offset, a length and a list.
+
+Removes the elements designated by the offset and the length from the array,
+and replaces them with the elements of the list, if any. In list context,
+returns the elements removed from the array. In scalar context, returns the
+last element removed, or C<undef> if no elements are removed. The array grows
+or shrinks as necessary. If the offset is negative then it starts that far
+from the end of the array. If the length is omitted, removes everything from
+the offset onward. If the length is negative, removes the elements from the
+offset onward except for -length elements at the end of the array. If both the
+offset and the length are omitted, removes everything. If the offset is past
+the end of the array, it issues a warning, and splices at the end of the
+array.
+
+=item whitelist_unshift
+
+    $obj->whitelist_unshift(@values);
+
+Unshifts elements onto the beginning of the array.
 
 =item black_re
@@ -228 +634 @@
 =back
 
-{% p.write_inheritance %}
-
-{% PROCESS standard_pod %}
+String::BlackWhiteList inherits from L<Class::Accessor::Complex>.
+
+The superclass L<Class::Accessor::Complex> defines these methods and
+functions:
+
+    mk_abstract_accessors(), mk_array_accessors(), mk_boolean_accessors(),
+    mk_class_array_accessors(), mk_class_hash_accessors(),
+    mk_class_scalar_accessors(), mk_concat_accessors(),
+    mk_forward_accessors(), mk_hash_accessors(), mk_integer_accessors(),
+    mk_new(), mk_object_accessors(), mk_scalar_accessors(),
+    mk_set_accessors(), mk_singleton()
+
+The superclass L<Class::Accessor> defines these methods and functions:
+
+    _carp(), _croak(), _mk_accessors(), accessor_name_for(),
+    best_practice_accessor_name_for(), best_practice_mutator_name_for(),
+    follow_best_practice(), get(), make_accessor(), make_ro_accessor(),
+    make_wo_accessor(), mk_accessors(), mk_ro_accessors(),
+    mk_wo_accessors(), mutator_name_for(), set()
+
+The superclass L<Class::Accessor::Installer> defines these methods and
+functions:
+
+    install_accessor()
+
+=head1 BUGS AND LIMITATIONS
+
+No bugs have been reported.
+
+Please report any bugs or feature requests through the web interface at
+L<http://rt.cpan.org>.
+
+=head1 INSTALLATION
+
+See perlmodinstall for information and options on installing Perl modules.
+
+=head1 AVAILABILITY
+
+The latest version of this module is available from the Comprehensive Perl
+Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN
+site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.
+
+=head1 AUTHORS
+
+Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2005-2008 by the authors.
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
 
 =cut