[Jifty-commit] r3048 - in Jifty-DBI/trunk: . lib/Jifty/DBI lib/Jifty/DBI/Filter

jifty-commit at lists.jifty.org jifty-commit at lists.jifty.org
Fri Mar 23 15:55:38 EDT 2007


Author: trs
Date: Fri Mar 23 15:55:37 2007
New Revision: 3048

Removed:
   Jifty-DBI/trunk/lib/Jifty/DBI/Filter/JiftyRecord.pm
Modified:
   Jifty-DBI/trunk/   (props changed)
   Jifty-DBI/trunk/MANIFEST
   Jifty-DBI/trunk/lib/Jifty/DBI/Collection.pm
   Jifty-DBI/trunk/lib/Jifty/DBI/Collection/Union.pm
   Jifty-DBI/trunk/lib/Jifty/DBI/Collection/Unique.pm
   Jifty-DBI/trunk/lib/Jifty/DBI/Column.pm
   Jifty-DBI/trunk/lib/Jifty/DBI/Filter/Truncate.pm
   Jifty-DBI/trunk/lib/Jifty/DBI/Handle.pm
   Jifty-DBI/trunk/lib/Jifty/DBI/Record.pm
   Jifty-DBI/trunk/lib/Jifty/DBI/Schema.pm

Log:
 r20369 at zot:  tom | 2007-03-23 15:55:16 -0400
 * Fix up and add POD so that POD coverage tests pass
 * Kill unused JiftyRecord filter


Modified: Jifty-DBI/trunk/MANIFEST
==============================================================================
--- Jifty-DBI/trunk/MANIFEST	(original)
+++ Jifty-DBI/trunk/MANIFEST	Fri Mar 23 15:55:37 2007
@@ -28,7 +28,6 @@
 lib/Jifty/DBI/Filter/base64.pm
 lib/Jifty/DBI/Filter/Date.pm
 lib/Jifty/DBI/Filter/DateTime.pm
-lib/Jifty/DBI/Filter/JiftyRecord.pm
 lib/Jifty/DBI/Filter/SaltHash.pm
 lib/Jifty/DBI/Filter/Storable.pm
 lib/Jifty/DBI/Filter/Time.pm

Modified: Jifty-DBI/trunk/lib/Jifty/DBI/Collection.pm
==============================================================================
--- Jifty-DBI/trunk/lib/Jifty/DBI/Collection.pm	(original)
+++ Jifty-DBI/trunk/lib/Jifty/DBI/Collection.pm	Fri Mar 23 15:55:37 2007
@@ -738,6 +738,13 @@
     return ( $self->{'items'} || [] );
 }
 
+=head2 new_item
+
+Should return a new object of the correct type for the current collection.
+Must be overridden by a subclassed.
+
+=cut
+
 sub new_item {
     my $self  = shift;
     my $class = $self->record_class();
@@ -1594,6 +1601,12 @@
     }
 }
 
+=head2 DEBUG
+
+Gets/sets the DEBUG flag.
+
+=cut
+
 sub DEBUG {
     my $self = shift;
     if (@_) {

Modified: Jifty-DBI/trunk/lib/Jifty/DBI/Collection/Union.pm
==============================================================================
--- Jifty-DBI/trunk/lib/Jifty/DBI/Collection/Union.pm	(original)
+++ Jifty-DBI/trunk/lib/Jifty/DBI/Collection/Union.pm	Fri Mar 23 15:55:37 2007
@@ -172,6 +172,13 @@
     $self->goto_item(0);
 }
 
+=head2 goto_item
+
+Unlike L<Jifty::DBI::Collection/goto_item>, Union only supports going to the
+first item in the collection.
+
+=cut
+
 sub goto_item {
     my $self = shift;
     my $item = shift;

Modified: Jifty-DBI/trunk/lib/Jifty/DBI/Collection/Unique.pm
==============================================================================
--- Jifty-DBI/trunk/lib/Jifty/DBI/Collection/Unique.pm	(original)
+++ Jifty-DBI/trunk/lib/Jifty/DBI/Collection/Unique.pm	Fri Mar 23 15:55:37 2007
@@ -6,6 +6,12 @@
 our @EXPORT  = qw(AddRecord);
 our $VERSION = "0.01";
 
+=head2 add_record
+
+Overrides add_record to ensure uniqueness.
+
+=cut
+
 sub add_record {
     my $self   = shift;
     my $record = shift;

Modified: Jifty-DBI/trunk/lib/Jifty/DBI/Column.pm
==============================================================================
--- Jifty-DBI/trunk/lib/Jifty/DBI/Column.pm	(original)
+++ Jifty-DBI/trunk/lib/Jifty/DBI/Column.pm	Fri Mar 23 15:55:37 2007
@@ -48,6 +48,12 @@
 
 =cut
 
+=head2 is_numeric
+
+Returns true if the column is of some numeric type, otherwise returns false.
+
+=cut
+
 sub is_numeric {
     my $self = shift;
     if ( $self->type =~ /INT|NUMERIC|DECIMAL|REAL|DOUBLE|FLOAT/i ) {
@@ -56,6 +62,12 @@
     return 0;
 }
 
+=head2 validator
+
+Gets/sets the validator coderef for the column.
+
+=cut
+
 sub validator {
     my $self = shift;
 
@@ -77,6 +89,16 @@
 *read  = \&readable;
 *write = \&writable;
 
+=head2 length
+
+DEPRECATED.  Use C<< $column->max_length >> instead.
+
+=head2 until
+
+DEPRECATED.  Use C<< $column->till >> instead.
+
+=cut
+
 sub length { Carp::croak('$column->length is no longer supported; use $column->max_length instead') }
 sub until { Carp::croak('$column->until is no longer supported; use $column->till instead') }
 

Modified: Jifty-DBI/trunk/lib/Jifty/DBI/Filter/Truncate.pm
==============================================================================
--- Jifty-DBI/trunk/lib/Jifty/DBI/Filter/Truncate.pm	(original)
+++ Jifty-DBI/trunk/lib/Jifty/DBI/Filter/Truncate.pm	Fri Mar 23 15:55:37 2007
@@ -6,6 +6,28 @@
 use base qw/Jifty::DBI::Filter/;
 use Encode ();
 
+=head1 NAME
+
+Jifty::DBI::Filter::Truncate - Truncates column values
+
+=head1 DESCRIPTION
+
+This filter truncates column values to the correct length for their
+type or to a defined max_length (for non-numeric columns).
+
+=head2 encode
+
+If the column is a non-numeric type and has a max_length defined,
+encode will truncate to that length.  If the column is of a
+type limited by definition (e.g. C<char(13)>), encode will truncate
+the value to fit.
+
+=head1 SEE ALSO
+
+L<Jifty::DBI::Filter>
+
+=cut
+
 sub encode {
     my $self = shift;
 

Modified: Jifty-DBI/trunk/lib/Jifty/DBI/Handle.pm
==============================================================================
--- Jifty-DBI/trunk/lib/Jifty/DBI/Handle.pm	(original)
+++ Jifty-DBI/trunk/lib/Jifty/DBI/Handle.pm	Fri Mar 23 15:55:37 2007
@@ -1033,7 +1033,7 @@
 
 }
 
-=head2 Log MESSAGE
+=head2 log MESSAGE
 
 Takes a single argument, a message to log.
 

Modified: Jifty-DBI/trunk/lib/Jifty/DBI/Record.pm
==============================================================================
--- Jifty-DBI/trunk/lib/Jifty/DBI/Record.pm	(original)
+++ Jifty-DBI/trunk/lib/Jifty/DBI/Record.pm	Fri Mar 23 15:55:37 2007
@@ -1345,7 +1345,9 @@
 }
 
 
-=head2 run_canonicalization_for_column
+=head2 run_canonicalization_for_column column => 'COLUMN', value => 'VALUE'
+
+Runs all canonicalizers for the specified column.
 
 =cut
 
@@ -1360,6 +1362,12 @@
     return ( exists $value_ref->[-1]->[0] ? $value_ref->[-1]->[0] : $args{'value'});
 }
 
+=head2 has_canonicalizer_for_column COLUMN
+
+Returns true if COLUMN has a canonicalizer, otherwise returns undef.
+
+=cut
+
 sub has_canonicalizer_for_column {
     my $self = shift;
     my $key = shift;
@@ -1372,7 +1380,9 @@
 }
 
 
-=head2 run_canonicalization_for_column
+=head2 run_validation_for_column column => 'COLUMN', value => 'VALUE'
+
+Runs all validators for the specified column.
 
 =cut
 
@@ -1398,6 +1408,12 @@
     
 }
 
+=head2 has_validator_for_column COLUMN
+
+Returns true if COLUMN has a validator, otherwise returns undef.
+
+=cut
+
 sub has_validator_for_column {
     my $self = shift;
     my $key  = shift;

Modified: Jifty-DBI/trunk/lib/Jifty/DBI/Schema.pm
==============================================================================
--- Jifty-DBI/trunk/lib/Jifty/DBI/Schema.pm	(original)
+++ Jifty-DBI/trunk/lib/Jifty/DBI/Schema.pm	Fri Mar 23 15:55:37 2007
@@ -112,6 +112,10 @@
     goto &Exporter::Lite::import;
 }
 
+=head2 filter_die
+
+=cut
+
 sub filter_die {
     # Calling it by hand means we restore the old sighandler.
     $SIG{__DIE__} = $old_sig_die;
@@ -189,6 +193,13 @@
 
 =cut
 
+=head2 column
+
+DEPRECATED.  This method of defining columns will not work anymore.  Please
+use the C<schema {}> method documented above.
+
+=cut
+
 sub schema (&) {
     my $code = shift;
     my $from = caller;
@@ -356,6 +367,10 @@
     # (We may not *have* a caller(1) if the user is executing a .pm file.)
 }
 
+=head2 register_types
+
+=cut
+
 sub register_types {
     my $class = shift;
     while (my ($type, $sub) = splice(@_, 0, 2)) {
@@ -394,6 +409,11 @@
 
 =cut
 
+=head2 by
+
+Helper for C<references>.  Used to specify what column name should be
+used in the referenced model.  See the documentation for C<references>e
+
 =head2 type
 
 type passed to our database abstraction layer, which should resolve it


More information about the Jifty-commit mailing list