[Jifty-commit] jifty-dbi branch, master, updated. 0.60-31-g28fbafd
Jifty commits
jifty-commit at lists.jifty.org
Wed Dec 8 15:09:13 EST 2010
The branch, master has been updated
via 28fbafd25bdc9656e4eee500cb24db702e5bdb0d (commit)
via 437c1025f0b2ba6f914a0cfc4b7a54e78f8e781d (commit)
via 1dfe9318d67cc5451615c8ad2e1b60221b13393a (commit)
via af2cc481bc8dcf569e4cf7405938ff642a47428f (commit)
via 20f69f021cdf7a8a41556e5fcbc2e97dbe42950a (commit)
via 98bd6965a990b0299aa0bdb44d4e914ec0e7a127 (commit)
from 37feeb8ca6ab925c8a4abbf459be15fd0190e238 (commit)
Summary of changes:
.gitignore | 2 +
lib/Jifty/DBI.pm | 14 ++--
lib/Jifty/DBI/Collection.pm | 32 +++++-----
lib/Jifty/DBI/Collection/Union.pm | 2 +-
lib/Jifty/DBI/Column.pm | 4 +-
lib/Jifty/DBI/Filter.pm | 2 +-
lib/Jifty/DBI/Filter/Boolean.pm | 6 +-
lib/Jifty/DBI/Filter/Truncate.pm | 2 +-
lib/Jifty/DBI/Filter/utf8.pm | 4 +-
lib/Jifty/DBI/Handle.pm | 6 +-
lib/Jifty/DBI/Handle/Informix.pm | 2 +-
lib/Jifty/DBI/HasFilters.pm | 2 +-
lib/Jifty/DBI/Record.pm | 10 ++--
lib/Jifty/DBI/Schema.pm | 4 +-
lib/Jifty/DBI/SchemaGenerator.pm | 4 +-
t/01records.t | 4 +-
t/{pod-coverage.t => 99-pod-coverage.t} | 1 +
t/99-pod-spelling.t | 109 +++++++++++++++++++++++++++++++
t/99-pod.t | 5 ++
t/pod.t | 4 -
20 files changed, 166 insertions(+), 53 deletions(-)
rename t/{pod-coverage.t => 99-pod-coverage.t} (86%)
create mode 100644 t/99-pod-spelling.t
create mode 100644 t/99-pod.t
delete mode 100644 t/pod.t
- Log -----------------------------------------------------------------
commit 98bd6965a990b0299aa0bdb44d4e914ec0e7a127
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Wed Dec 8 14:21:53 2010 -0500
Move pod.t and pod-coverage.t to t/99-...
diff --git a/t/pod-coverage.t b/t/99-pod-coverage.t
similarity index 100%
rename from t/pod-coverage.t
rename to t/99-pod-coverage.t
diff --git a/t/pod.t b/t/99-pod.t
similarity index 100%
rename from t/pod.t
rename to t/99-pod.t
commit 20f69f021cdf7a8a41556e5fcbc2e97dbe42950a
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Wed Dec 8 14:24:06 2010 -0500
Run pod tests only for authors
diff --git a/t/99-pod-coverage.t b/t/99-pod-coverage.t
index 298ff24..1491de9 100644
--- a/t/99-pod-coverage.t
+++ b/t/99-pod-coverage.t
@@ -1,6 +1,7 @@
use Test::More;
eval "use Test::Pod::Coverage 1.00";
plan skip_all => "Test::Pod::Coverage 1.00 required for testing POD coverage" if $@;
+plan skip_all => "Coverage tests only run for authors" unless (-d 'inc/.author');
all_pod_coverage_ok( );
# Workaround for dumb bug (fixed in 5.8.7) where Test::Builder thinks that
diff --git a/t/99-pod.t b/t/99-pod.t
index 437887a..67dc72a 100644
--- a/t/99-pod.t
+++ b/t/99-pod.t
@@ -1,4 +1,5 @@
use Test::More;
eval "use Test::Pod 1.00";
plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
+plan skip_all => "Coverage tests only run for authors" unless (-d 'inc/.author');
all_pod_files_ok();
commit af2cc481bc8dcf569e4cf7405938ff642a47428f
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Wed Dec 8 15:00:00 2010 -0500
Correct lots of typos and misspellings
diff --git a/lib/Jifty/DBI.pm b/lib/Jifty/DBI.pm
index 2ce0dda..7099152 100644
--- a/lib/Jifty/DBI.pm
+++ b/lib/Jifty/DBI.pm
@@ -15,13 +15,13 @@ Jifty::DBI deals with databases, so that you don't have to.
This module provides an object-oriented mechanism for retrieving and
updating data in a DBI-accessible database.
-This module is the direct descendent of L<DBIx::SearchBuilder>. If you're familiar
+This module is the direct descendant of L<DBIx::SearchBuilder>. If you're familiar
with SearchBuilder, Jifty::DBI should be quite familiar to you.
=head2 Purpose
Jifty::DBI::Record abstracts the agony of writing the common and generally
-simple SQL statements needed to serialize and de-serialize an object to the
+simple SQL statements needed to serialize and deserialize an object to the
database. In a traditional system, you would define various methods on
your object 'create', 'read', 'update', and 'delete' being the most common.
In each method you would have a SQL statement like:
@@ -156,12 +156,12 @@ the last example.
print "Foo : ", $s->foo(), "\n";
print "Bar : ", $s->bar(), "\n";
-Thats all you have to to get the data, now to change the data!
+That's all you have to to get the data, now to change the data!
$s->set_bar('NewBar');
-Pretty simple! Thats really all there is to it. Set<Field>($) returns
+Pretty simple! That's really all there is to it. Set<Field>($) returns
a boolean and a string describing the problem. Lets look at an example of
what will happen if we try to set a 'Id' which we previously defined as
read only.
@@ -199,8 +199,8 @@ object!
And it's gone.
-For simple use, thats more or less all there is to it. In the future, I hope to exapand
-this HowTo to discuss using container classes, overloading, and what
+For simple use, that's more or less all there is to it. In the future, I hope to expand
+this how-to to discuss using container classes, overloading, and what
ever else I think of.
=head1 LICENSE
diff --git a/lib/Jifty/DBI/Collection.pm b/lib/Jifty/DBI/Collection.pm
index f4d309d..a2f9298 100755
--- a/lib/Jifty/DBI/Collection.pm
+++ b/lib/Jifty/DBI/Collection.pm
@@ -1011,7 +1011,7 @@ Should return a new object of the correct type for the current collection.
L</record_class> method is used to determine class of the object.
Each record class at least once is loaded using require. This method is
-called each time a record fetched so load atemts are cached to avoid
+called each time a record fetched so load attempts are cached to avoid
penalties. If you're sure that all record classes are loaded before
first use then you can override this method.
@@ -1068,7 +1068,7 @@ sub record_class {
=head2 redo_search
Takes no arguments. Tells Jifty::DBI::Collection that the next time
-it's asked for a record, it should requery the database
+it is asked for a record, it should re-execute the query.
=cut
@@ -1121,9 +1121,9 @@ wanted (that means we can't do recursive joins as for now).
=item alias
-Unless alias is set, the join criterias will be taken from EXT_LINKcolumn
-and INT_LINKcolumn and added to the criterias. If alias is set, new
-criterias about the foreign table will be added.
+Unless alias is set, the join criteria will be taken from EXT_LINKcolumn
+and INT_LINKcolumn and added to the criteria. If alias is set, new
+criteria about the foreign table will be added.
=item column
@@ -1145,7 +1145,7 @@ operator is the SQL operator to use for this phrase. Possible choices include:
=item "!="
-Any other standard SQL comparision operators that your underlying
+Any other standard SQL comparison operators that your underlying
database supports are also valid.
=item "LIKE"
@@ -1162,7 +1162,7 @@ starts_with is like LIKE, except it only appends a % at the end of the string
=item "ends_with"
-ENDSWITH is like LIKE, except it prepends a % to the beginning of the string
+ends_with is like LIKE, except it prepends a % to the beginning of the string
=item "IN"
@@ -1396,8 +1396,8 @@ sub limit {
=head2 open_paren CLAUSE
-Places an open paren at the current location in the given C<CLAUSE>.
-Note that this can be used for Deep Magic, and has a high likelyhood
+Places an open parenthesis at the current location in the given C<CLAUSE>.
+Note that this can be used for Deep Magic, and has a high likelihood
of allowing you to construct malformed SQL queries. Its interface
will probably change in the near future, but its presence allows for
arbitrarily complex queries.
@@ -1440,8 +1440,8 @@ sub open_paren {
=head2 close_paren CLAUSE
-Places a close paren at the current location in the given C<CLAUSE>.
-Note that this can be used for Deep Magic, and has a high likelyhood
+Places a close parenthesis at the current location in the given C<CLAUSE>.
+Note that this can be used for Deep Magic, and has a high likelihood
of allowing you to construct malformed SQL queries. Its interface
will probably change in the near future, but its presence allows for
arbitrarily complex queries.
@@ -1793,7 +1793,7 @@ sub _get_alias {
Join instructs Jifty::DBI::Collection to join two tables.
-The standard form takes a param hash with keys C<alias1>, C<column1>, C<alias2>
+The standard form takes a paramhash with keys C<alias1>, C<column1>, C<alias2>
and C<column2>. C<alias1> and C<alias2> are column aliases obtained from
$self->new_alias or a $self->limit. C<column1> and C<column2> are the columns
in C<alias1> and C<alias2> that should be linked, respectively. For this
@@ -1890,7 +1890,7 @@ the number of rows the database should display.
=head2 first_row
Get or set the first row of the result set the database should return.
-Takes an optional single integer argrument. Returns the currently set
+Takes an optional single integer argument. Returns the currently set
integer first row that the database should return.
@@ -2130,9 +2130,9 @@ sub columns {
=head2 columns_in_db table
-Return a list of columns in table, lowercased.
+Return a list of columns in table, in lowercase.
-TODO: Why are they lowercased?
+TODO: Why are they in lowercase?
=cut
@@ -2212,7 +2212,7 @@ sub clone {
Returns list of the object's fields that should be copied.
If your subclass store references in the object that should be copied while
-clonning then you probably want override this method and add own values to
+cloning then you probably want override this method and add own values to
the list.
=cut
diff --git a/lib/Jifty/DBI/Collection/Union.pm b/lib/Jifty/DBI/Collection/Union.pm
index 7c49f04..1d4c194 100644
--- a/lib/Jifty/DBI/Collection/Union.pm
+++ b/lib/Jifty/DBI/Collection/Union.pm
@@ -145,7 +145,7 @@ sub last {
=head2 count
-Returns the total number of elements in the Union'ed Collection
+Returns the total number of elements in the union collection
=cut
diff --git a/lib/Jifty/DBI/Column.pm b/lib/Jifty/DBI/Column.pm
index d7c7d2d..c4c9875 100644
--- a/lib/Jifty/DBI/Column.pm
+++ b/lib/Jifty/DBI/Column.pm
@@ -63,12 +63,12 @@ for my $attr (@handy_attrs) {
=head1 NAME
-Jifty::DBI::Column - Encapsulate's a single column in a Jifty::DBI::Record table
+Jifty::DBI::Column - Encapsulates a single column in a Jifty::DBI::Record table
=head1 DESCRIPTION
-This class encapsulate's a single column in a Jifty::DBI::Record table
+This class encapsulates a single column in a Jifty::DBI::Record table
description. It replaces the _accessible method in
L<Jifty::DBI::Record>.
diff --git a/lib/Jifty/DBI/Filter.pm b/lib/Jifty/DBI/Filter.pm
index 8ff6a0e..48a965c 100644
--- a/lib/Jifty/DBI/Filter.pm
+++ b/lib/Jifty/DBI/Filter.pm
@@ -69,7 +69,7 @@ with here.
=item handle
-A L<Jifty::DBI::Handle> object, because some filters (ie
+A L<Jifty::DBI::Handle> object, because some filters (i.e.
L<Jifty::DBI::Filter::Boolean>) depend on what database system is being used.
=back
diff --git a/lib/Jifty/DBI/Filter/Boolean.pm b/lib/Jifty/DBI/Filter/Boolean.pm
index c82ef1d..d7549f3 100644
--- a/lib/Jifty/DBI/Filter/Boolean.pm
+++ b/lib/Jifty/DBI/Filter/Boolean.pm
@@ -42,9 +42,9 @@ Jifty::DBI::Filter::Boolean - Encodes booleans
=head2 decode
-Transform the value into 1 or 0 so Perl's concept of the boolean's value agrees
-with the database's concept of the boolean's value. (For example, 't' and 'f'
-might be used -- 'f' is true in Perl)
+Transform the value into 1 or 0 so Perl's concept of the value agrees
+with the database's concept of the value. (For example, 't' and 'f'
+might be used in the database, but 'f' is true in Perl)
=cut
diff --git a/lib/Jifty/DBI/Filter/Truncate.pm b/lib/Jifty/DBI/Filter/Truncate.pm
index 08dfcfd..7906ba6 100644
--- a/lib/Jifty/DBI/Filter/Truncate.pm
+++ b/lib/Jifty/DBI/Filter/Truncate.pm
@@ -12,7 +12,7 @@ Jifty::DBI::Filter::Truncate - Filter used to enforce max_length column trait
=head1 DESCRIPTION
-You do not need to use this filter explicitly. This filter is used internally to enforce the L<Jifty::DBI::Schema/max_length> retrictions on columns:
+You do not need to use this filter explicitly. This filter is used internally to enforce the L<Jifty::DBI::Schema/max_length> restrictions on columns:
column name =>
type is 'text',
diff --git a/lib/Jifty/DBI/Filter/utf8.pm b/lib/Jifty/DBI/Filter/utf8.pm
index c60e60e..d9aaf16 100644
--- a/lib/Jifty/DBI/Filter/utf8.pm
+++ b/lib/Jifty/DBI/Filter/utf8.pm
@@ -15,7 +15,7 @@ Jifty::DBI::Filter::utf8 - Jifty::DBI UTF-8 data filter
This filter allow you to check that you operate with
valid UTF-8 data.
-Usage as type specific filter is recommneded.
+Usage as type specific filter is recommended.
=head1 METHODS
@@ -51,7 +51,7 @@ sub encode {
=head2 decode
Checks whether value is correct UTF-8 data or not and
-substitute all malformed data with 0xFFFD code point.
+substitute all malformed data with the C<0xFFFD> code point.
Always set UTF-8 flag on the value.
diff --git a/lib/Jifty/DBI/Handle.pm b/lib/Jifty/DBI/Handle.pm
index d013d1f..a5c7cc6 100755
--- a/lib/Jifty/DBI/Handle.pm
+++ b/lib/Jifty/DBI/Handle.pm
@@ -279,8 +279,8 @@ sub log_sql_statements {
Used in instrumenting the SQL logging. You can use this to, for example, get a
stack trace for each query (so you can find out where the query is being made).
-The name is required so that multiple hooks can be installed without stepping
-on eachother's toes.
+The name is required so that multiple hooks can be installed, and inspected, by
+name.
The coderef is run in scalar context and (currently) receives no arguments.
@@ -650,7 +650,7 @@ Returns the database's version.
If argument C<short> is true returns short variant, in other
case returns whatever database handle/driver returns. By default
-returns short version, e.g. '4.1.23' or '8.0-rc4'.
+returns short version, e.g. C<4.1.23> or C<8.0-rc4>.
Returns empty string on error or if database couldn't return version.
diff --git a/lib/Jifty/DBI/Handle/Informix.pm b/lib/Jifty/DBI/Handle/Informix.pm
index 44223ca..10e1ccf 100644
--- a/lib/Jifty/DBI/Handle/Informix.pm
+++ b/lib/Jifty/DBI/Handle/Informix.pm
@@ -76,7 +76,7 @@ sub apply_limits {
=head2 disconnect
-Disconnects and completely unreferences the handle for Informix.
+Disconnects and removes the reference to the handle for Informix.
=cut
diff --git a/lib/Jifty/DBI/HasFilters.pm b/lib/Jifty/DBI/HasFilters.pm
index 7f6b6e9..34613fb 100644
--- a/lib/Jifty/DBI/HasFilters.pm
+++ b/lib/Jifty/DBI/HasFilters.pm
@@ -14,7 +14,7 @@ __PACKAGE__->mk_accessors qw/
Jifty::DBI::HasFilters - abstract class for objects that has filters
-=head1 SYNOPSYS
+=head1 SYNOPSIS
my $record = Jifty::DBI::Record->new(...);
$record->input_filters( 'Jifty::DBI::Filter::Truncate',
diff --git a/lib/Jifty/DBI/Record.pm b/lib/Jifty/DBI/Record.pm
index 57178c3..50dce33 100755
--- a/lib/Jifty/DBI/Record.pm
+++ b/lib/Jifty/DBI/Record.pm
@@ -410,7 +410,7 @@ sub _init_methods_for_column {
=head2 null_reference
-By default, Jifty::DBI::Record will return C<undef> for non-existant
+By default, Jifty::DBI::Record will return C<undef> for non-existent
foreign references which don't exist. That is, if each Employee
C<refers_to> a Department, but isn't required to,
C<<$model->department>> will return C<undef> for employees not in a
@@ -683,9 +683,9 @@ sub writable_attributes {
=head2 record values
-As you've probably already noticed, C<Jifty::DBI::Record> autocreates
-methods for your standard get/set accessors. It also provides you with
-some hooks to massage the values being loaded or stored.
+As you've probably already noticed, C<Jifty::DBI::Record> automatically
+creates methods for your standard get/set accessors. It also provides you
+with some hooks to massage the values being loaded or stored.
When you fetch a record value by calling
C<$my_record-E<gt>some_field>, C<Jifty::DBI::Record> provides the
@@ -1346,7 +1346,7 @@ return value is ignored regardless.
This method is called after attempting to insert the record into the
database. It gets handed a reference to the return value of the
-insert. That'll either be a true value or a L<Class::ReturnValue>.
+insert. That will either be a true value or a L<Class::ReturnValue>.
Aborting the trigger merely causes C<create> to return a false
(undefined) value even thought he create may have succeeded. This
diff --git a/lib/Jifty/DBI/Schema.pm b/lib/Jifty/DBI/Schema.pm
index f7a4906..6e7973a 100644
--- a/lib/Jifty/DBI/Schema.pm
+++ b/lib/Jifty/DBI/Schema.pm
@@ -609,7 +609,7 @@ interfaces. Correct usage is C<is mandatory>.
=head2 not_null
-Same as L</mandatory>. This is deprecated. Currect usage would be
+Same as L</mandatory>. This is deprecated. Correct usage would be
C<is not_null>.
=head2 autocompleted
@@ -690,7 +690,7 @@ sub till {
=head2 valid_values
A list of valid values for this column. Jifty will use this to
-autoconstruct a validator for you. This list may also be used to
+automatically construct a validator for you. This list may also be used to
generate the user interface. Correct usage is C<valid_values are
qw/foo bar baz/>.
diff --git a/lib/Jifty/DBI/SchemaGenerator.pm b/lib/Jifty/DBI/SchemaGenerator.pm
index 3b56b4f..016b97a 100644
--- a/lib/Jifty/DBI/SchemaGenerator.pm
+++ b/lib/Jifty/DBI/SchemaGenerator.pm
@@ -20,7 +20,7 @@ __PACKAGE__->mk_accessors(qw(_db_schema));
=head1 NAME
-Jifty::DBI::SchemaGenerator - Generate table schemas from Jifty::DBI records
+Jifty::DBI::SchemaGenerator - Generate a table schema from Jifty::DBI records
=head1 DESCRIPTION
@@ -196,7 +196,7 @@ sub add_model {
=head2 column_definition_sql TABLENAME COLUMNNAME
-Given a tablename and a column name, returns the SQL fragment
+Given a table name and a column name, returns the SQL fragment
describing that column for the current database.
=cut
diff --git a/t/01records.t b/t/01records.t
index ac47d40..3d23c80 100644
--- a/t/01records.t
+++ b/t/01records.t
@@ -83,7 +83,7 @@ SKIP: {
is($msg, 'Immutable column', 'id is immutable column');
is($rec->id, $id, "The record still has its id");
-# Check some non existant column
+# Check some non existent column
ok( !eval{ $rec->some_unexpected_column }, "The record has no 'some_unexpected_column'");
{
# test produce DBI warning
@@ -134,7 +134,7 @@ SKIP: {
is($val, 0, "didn't find object");
is($msg, "Missing a primary key?", "reason is missing PK");
-# _load_from_sql and not existant row
+# _load_from_sql and not existent row
$newrec = TestApp::Address->new( handle => $handle );
($val, $msg) = $newrec->_load_from_sql('SELECT id FROM addresses WHERE id = ?', 0);
is($val, 0, "didn't find object");
commit 1dfe9318d67cc5451615c8ad2e1b60221b13393a
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Wed Dec 8 15:00:33 2010 -0500
Add t/99-pod-spelling.t
diff --git a/t/99-pod-spelling.t b/t/99-pod-spelling.t
new file mode 100644
index 0000000..fe1393f
--- /dev/null
+++ b/t/99-pod-spelling.t
@@ -0,0 +1,109 @@
+#!/usr/bin/env perl -w
+
+use strict;
+use Test::More;
+eval "use Test::Spelling";
+plan skip_all => "Test::Spelling required for testing POD spelling" if $@;
+plan skip_all => "Coverage tests only run for authors" unless (-d 'inc/.author');
+
+add_stopwords(<DATA>);
+
+local $ENV{LC_ALL} = 'C';
+set_spell_cmd('aspell list -l en');
+
+all_pod_files_spelling_ok();
+
+__DATA__
+Autocommit
+autocompleted
+backend
+BYTEA
+canonicalizer
+canonicalizers
+Checkbox
+classdata
+COLUMNNAME
+Combobox
+cpan
+database's
+datasource
+DateTime
+DBD
+dbh
+DBI
+deserialize
+dsn
+formatter
+Glasser
+Hanenkamp
+hashrefs
+HookResults
+Informix
+Informix's
+InlineButton
+Jifty
+Knopp
+LLC
+login
+lookups
+lossy
+marshalling
+memcached
+metadata
+mhat
+mixin
+mixins
+MyModel
+myscript
+mysql's
+NULLs
+ODBC
+OtherClass
+OtherCollection
+paramhash
+Postgres
+postgres
+PostgreSQL
+prefetch
+prefetched
+prefetches
+preload
+prepends
+PrintError
+QUERYSTRING
+RaiseError
+recordset
+RequireSSL
+requiressl
+resultsets
+Ruslan
+SchemaGenerator
+SearchBuilder
+sid
+Spier
+SQL
+SQLite
+SQLite's
+STATEMENTREF
+STDERR
+Storable
+Sybase
+Sybase's
+Syck
+TABLENAME
+Tappe
+TODO
+unimported
+unlimit
+unmarshalling
+Unrendered
+username
+UTC
+UTF
+utf
+validator
+validators
+Vandiver
+wildcard
+YAML
+Zakirov
commit 437c1025f0b2ba6f914a0cfc4b7a54e78f8e781d
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Wed Dec 8 15:03:10 2010 -0500
Copyright year bump
diff --git a/lib/Jifty/DBI.pm b/lib/Jifty/DBI.pm
index 7099152..87f72f6 100644
--- a/lib/Jifty/DBI.pm
+++ b/lib/Jifty/DBI.pm
@@ -205,7 +205,7 @@ ever else I think of.
=head1 LICENSE
-Jifty::DBI is Copyright 2005-2009 Best Practical Solutions, LLC.
+Jifty::DBI is Copyright 2005-2010 Best Practical Solutions, LLC.
Jifty::DBI is distributed under the same terms as Perl itself.
=cut
commit 28fbafd25bdc9656e4eee500cb24db702e5bdb0d
Author: Shawn M Moore <sartak at bestpractical.com>
Date: Wed Dec 8 15:06:59 2010 -0500
A few more .gitignore entries
diff --git a/.gitignore b/.gitignore
index 77589d2..54babd9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,3 +8,5 @@ blib/
inc/
pm_to_blib
.prove
+*.sw[po]
+cover_db/
-----------------------------------------------------------------------
More information about the Jifty-commit
mailing list