Author: hmbrand
Date: Fri Dec 21 04:40:43 2012
New Revision: 15537
Modified:
dbi/branches/sqlengine/.aspell.local.pws
dbi/branches/sqlengine/lib/DBD/DBM.pm
dbi/branches/sqlengine/lib/DBD/File/Developers.pod
dbi/branches/sqlengine/lib/DBD/File/Roadmap.pod
Log:
Spell and style issues in Jens'; request
Modified: dbi/branches/sqlengine/.aspell.local.pws
==============================================================================
--- dbi/branches/sqlengine/.aspell.local.pws (original)
+++ dbi/branches/sqlengine/.aspell.local.pws Fri Dec 21 04:40:43 2012
@@ -1,4 +1,4 @@
-personal_ws-1.1 en_EN 123
+personal_ws-1.1 en_EN 133
# checked files:
# - lib/DBD/DBM.pm
# - lib/DBD/File.pm
@@ -54,6 +54,7 @@
Dunlop
EINTR
eval
+extensibility
filename
getinfo
GetInfo
@@ -66,8 +67,11 @@
hasn
Haworth
implementor
+indices
Informix
INI
+instantiation
+instantiations
IRC
isn
iso
@@ -76,6 +80,7 @@
Jochen
JOINs
jrehsack
+JSON
jzucker
lang
latin
@@ -98,11 +103,14 @@
multi
MyFancyLogger
namespace
+namespaces
Nano
nl
NULLABLE
ODBC
+optimizations
pag
+parametrized
pre
precompiled
readonly
@@ -114,12 +122,14 @@
Solaris
speeded
st
+Steffen
sth
Storable
subclasses
subdirectories
txt
TypeInfo
+unlinked
unrecognised
usenet
UTF
Modified: dbi/branches/sqlengine/lib/DBD/DBM.pm
==============================================================================
--- dbi/branches/sqlengine/lib/DBD/DBM.pm (original)
+++ dbi/branches/sqlengine/lib/DBD/DBM.pm Fri Dec 21 04:40:43 2012
@@ -3,7 +3,7 @@
# DBD::DBM - a DBI driver for DBM files
#
# Copyright (c) 2004 by Jeff Zucker < jzucker AT cpan.org >
-# Copyright (c) 2010 by Jens Rehsack & H.Merijn Brand
+# Copyright (c) 2010-2013 by Jens Rehsack & H.Merijn Brand
#
# All rights reserved.
#
@@ -723,7 +723,7 @@
=head1 USAGE
-This section will explain some useage cases in more detail. To get an
+This section will explain some usage cases in more detail. To get an
overview about the available attributes, see L</Metadata>.
=head2 Specifying Files and Directories
@@ -1325,11 +1325,11 @@
=item C<YAML::MLDBM>
-Additional serializer for MLDBM. YAML is very portable between languanges.
+Additional serializer for MLDBM. YAML is very portable between languages.
=item C<MLDBM::Serializer::JSON>
-Additional serializer for MLDBM. JSON is very portable between languanges,
+Additional serializer for MLDBM. JSON is very portable between languages,
probably more than YAML.
=back
@@ -1438,7 +1438,7 @@
took over maintenance.
Copyright (c) 2004 by Jeff Zucker, all rights reserved.
- Copyright (c) 2010 by Jens Rehsack & H.Merijn Brand, all rights reserved.
+ Copyright (c) 2010-2013 by Jens Rehsack & H.Merijn Brand, all rights reserved.
You may freely distribute and/or modify this module under the terms of
either the GNU General Public License (GPL) or the Artistic License, as
Modified: dbi/branches/sqlengine/lib/DBD/File/Developers.pod
==============================================================================
--- dbi/branches/sqlengine/lib/DBD/File/Developers.pod (original)
+++ dbi/branches/sqlengine/lib/DBD/File/Developers.pod Fri Dec 21 04:40:43 2012
@@ -6,12 +6,12 @@
package DBD::myDriver;
- use base qw(DBD::File);
+ use base qw( DBD::File );
sub driver
{
...
- my $drh = $proto->SUPER::driver($attr);
+ my $drh = $proto->SUPER::driver ($attr);
...
return $drh->{class};
}
@@ -20,14 +20,14 @@
package DBD::myDriver::dr;
- @ISA = qw(DBD::File::dr);
+ @ISA = qw( DBD::File::dr );
sub data_sources { ... }
...
package DBD::myDriver::db;
- @ISA = qw(DBD::File::db);
+ @ISA = qw( DBD::File::db );
sub init_valid_attributes { ... }
sub init_default_attributes { ... }
@@ -38,29 +38,29 @@
package DBD::myDriver::st;
- @ISA = qw(DBD::File::st);
+ @ISA = qw( DBD::File::st );
sub FETCH { ... }
sub STORE { ... }
package DBD::myDriver::Statement;
- @ISA = qw(DBD::File::Statement);
+ @ISA = qw( DBD::File::Statement );
package DBD::myDriver::Table;
- @ISA = qw(DBD::File::Table);
+ @ISA = qw( DBD::File::Table );
my %reset_on_modify = (
- myd_abc => "myd_foo",
- myd_mno => "myd_bar",
- );
- __PACKAGE__->register_reset_on_modify( \%reset_on_modify );
+ myd_abc => "myd_foo",
+ myd_mno => "myd_bar",
+ );
+ __PACKAGE__->register_reset_on_modify (\%reset_on_modify);
my %compat_map = (
- abc => 'foo_abc',
- xyz => 'foo_xyz',
- );
- __PACKAGE__->register_compat_map( \%compat_map );
+ abc => 'foo_abc',
+ xyz => 'foo_xyz',
+ );
+ __PACKAGE__->register_compat_map (\%compat_map);
sub bootstrap_table_meta { ... }
sub init_table_meta { ... }
@@ -106,14 +106,14 @@
# invokes
package DBD::DBM::dr;
- @DBD::DBM::dr::ISA = qw(DBD::File::dr);
+ @DBD::DBM::dr::ISA = qw( DBD::File::dr );
sub connect ($$;$$$)
{
...
- }
+ }
-Similar for C<< data_sources () >> and C<< disconnect_all() >>.
+Similar for C<< data_sources >> and C<< disconnect_all >>.
Pure Perl DBI drivers derived from DBD::File do not usually need to
override any of the methods provided through the DBD::XXX::dr package
@@ -154,12 +154,12 @@
sub driver
{
- my ( $class, $attr ) = @_;
+ my ($class, $attr) = @_;
...
- my $drh = $class->SUPER::driver( $attr );
+ my $drh = $class->SUPER::driver ($attr);
...
return $drh;
- }
+ }
It is not necessary to implement your own driver method as long as
additional initialization (e.g. installing more private driver
@@ -209,7 +209,7 @@
(written as C<$drv_prefix>) is added.
The driver prefix is extracted from the attribute name and verified against
-C<< $dbh->{ $drv_prefix . "valid_attrs" } >> (when it exists). If the
+C<< $dbh->{$drv_prefix . "valid_attrs"} >> (when it exists). If the
requested attribute value is not listed as a valid attribute, this method
croaks. If the attribute is valid and readonly (listed in C<< $dbh->{
$drv_prefix . "readonly_attrs" } >> when it exists), a real copy of the
@@ -269,11 +269,11 @@
When the derived implementor class provides the attribute to validate
attributes (e.g. C<< $dbh->{dbm_valid_attrs} = {...}; >>) or the attribute
-containing the immutable attributes (e.g. C<< $dbh->{dbm_readonly_attrs}
-= {...}; >>), the attributes C<drv_valid_attrs>, C<drv_readonly_attrs>,
-C<drv_version> and C<drv_meta> are added (when available) to the list of
-valid and immutable attributes (where C<drv_> is interpreted as the driver
-prefix).
+containing the immutable attributes (e.g.
+C<< $dbh->{dbm_readonly_attrs} = {...}; >>), the attributes
+C<drv_valid_attrs>, C<drv_readonly_attrs>, C<drv_version> and C<drv_meta>
+are added (when available) to the list of valid and immutable attributes
+(where C<drv_> is interpreted as the driver prefix).
If C<drv_meta> is set, an attribute with the name in C<drv_meta> is
initialized providing restricted read/write access to the meta data of the
@@ -291,8 +291,7 @@
Retrieve an attribute from a table's meta information. The method
signature is C<< get_file_meta ($dbh, $table, $attr) >>. This method
-is called by the injected db handle method C<< ${drv_prefix}get_meta
->>.
+is called by the injected db handle method C<< ${drv_prefix}get_meta >>.
While get_file_meta allows C<$table> or C<$attr> to be a list of tables or
attributes to retrieve, get_single_table_meta allows only one table name
@@ -366,36 +365,36 @@
sub data_sources ($;$)
{
- my ( $class, $drh, $attrs ) = @_;
- ...
- }
+ my ($class, $drh, $attrs) = @_;
+ ...
+ }
sub avail_tables
{
- my ( $class, $drh ) = @_;
- ...
- }
+ my ($class, $drh) = @_;
+ ...
+ }
The C<data_sources> method is called when the user invokes any of the
following:
- @ary = DBI->data_sources($driver);
- @ary = DBI->data_sources($driver, \%attr);
+ @ary = DBI->data_sources ($driver);
+ @ary = DBI->data_sources ($driver, \%attr);
- @ary = $dbh->data_sources();
- @ary = $dbh->data_sources(\%attr);
+ @ary = $dbh->data_sources ();
+ @ary = $dbh->data_sources (\%attr);
The C<avail_tables> method is called when the user invokes any of the
following:
- @names = $dbh->tables( $catalog, $schema, $table, $type );
+ @names = $dbh->tables ($catalog, $schema, $table, $type);
- $sth = $dbh->table_info( $catalog, $schema, $table, $type );
- $sth = $dbh->table_info( $catalog, $schema, $table, $type, \%attr );
+ $sth = $dbh->table_info ($catalog, $schema, $table, $type);
+ $sth = $dbh->table_info ($catalog, $schema, $table, $type, \%attr);
- $dbh->func( "list_tables" );
+ $dbh->func ("list_tables");
-Everytime where an C<\%attr> argument can be specified, this C<\%attr>
+Every time where an C<\%attr> argument can be specified, this C<\%attr>
object's C<sql_table_source> attribute is preferred over the C<$dbh>
attribute or the driver default.
@@ -405,49 +404,53 @@
@DBD::File::DataSource::Stream::ISA = 'DBI::DBD::SqlEngine::DataSource';
- sub complete_table_name {
- my ($self, $meta, $file, $respect_case) = @_;
- ...
- }
+ sub complete_table_name
+ {
+ my ($self, $meta, $file, $respect_case) = @_;
+ ...
+ }
-Unsets all meta attributes identifying a file: C<f_fqfn>, C<f_fqbn> and
+Clears all meta attributes identifying a file: C<f_fqfn>, C<f_fqbn> and
C<f_fqln>. The table name is set according to C<$respect_case> and
C<< $meta->{sql_identifier_case} >> (SQL_IC_LOWER, SQL_IC_UPPER).
package DBD::File::DataSource::Stream;
- sub apply_encoding {
- my ($self, $meta, $fn) = @_;
- ...
- }
+ sub apply_encoding
+ {
+ my ($self, $meta, $fn) = @_;
+ ...
+ }
Applies the encoding from I<meta information> (C<< $meta->{f_encoding} >>)
to the file handled opened in C<open_data>.
package DBD::File::DataSource::Stream;
- sub open_data {
- my ($self, $meta, $attrs, $flags) = @_;
- ...
- }
+ sub open_data
+ {
+ my ($self, $meta, $attrs, $flags) = @_;
+ ...
+ }
-Opens (C<dup(2)>) the file handle provided in C<< $meta->{f_file} >>.
+Opens (C<dup (2)>) the file handle provided in C<< $meta->{f_file} >>.
package DBD::File::DataSource::Stream;
sub can_flock { ... }
-Returns whether C<flock(2)> is available or not (avoids retesting in
+Returns whether C<flock (2)> is available or not (avoids retesting in
subclasses).
=head2 DBD::File::DataSource::File
package DBD::File::DataSource::File;
- sub complete_table_name ($$;$) {
- my ( $self, $meta, $table, $respect_case ) = @_;
- ...
- }
+ sub complete_table_name ($$;$)
+ {
+ my ($self, $meta, $table, $respect_case) = @_;
+ ...
+ }
The method C<complete_table_name> tries to map a filename to the associated
table name. It is called with a partially filled meta structure for the
@@ -461,10 +464,11 @@
package DBD::File::DataSource::File;
- sub open_data ($) {
- my ( $self, $meta, $attrs, $flags ) = @_;
- ...
- }
+ sub open_data ($)
+ {
+ my ($self, $meta, $attrs, $flags) = @_;
+ ...
+ }
Depending on the attributes set in the table's meta data, the
following steps are performed. Unless C<< f_dontopen >> is set to a
@@ -485,7 +489,7 @@
Implements the open_table method required by L<SQL::Statement> and
L<DBI::SQL::Nano>. All the work for opening the file(s) belonging to the
-table is handled and parameterized in DBD::File::Table. Unless you intend
+table is handled and parametrized in DBD::File::Table. Unless you intend
to add anything to the following implementation, an empty DBD::XXX::Statement
package satisfies DBD::File.
@@ -497,8 +501,8 @@
$class =~ s/::Statement/::Table/;
my $flags = {
- createMode => $createMode,
- lockMode => $lockMode,
+ createMode => $createMode,
+ lockMode => $lockMode,
};
$self->{command} eq "DROP" and $flags->{dropMode} = 1;
@@ -572,17 +576,17 @@
If your DBD has calculated values in the meta data area, then call
C<register_reset_on_modify>:
- my %reset_on_modify = ( "xxx_foo" => "xxx_bar" );
- __PACKAGE__->register_reset_on_modify( \%reset_on_modify );
+ my %reset_on_modify = (xxx_foo => "xxx_bar");
+ __PACKAGE__->register_reset_on_modify (\%reset_on_modify);
=item register_compat_map
Allows C<get_table_meta_attr> and C<set_table_meta_attr> to update the
attribute name to the current favored one:
- # from DBD::DBM
- my %compat_map = ( "dbm_ext" => "f_ext" );
- __PACKAGE__->register_compat_map( \%compat_map );
+ # from DBD::DBM
+ my %compat_map = (dbm_ext => "f_ext");
+ __PACKAGE__->register_compat_map (\%compat_map);
=item open_file
@@ -650,7 +654,7 @@
=head1 COPYRIGHT AND LICENSE
-Copyright (C) 2010 by H.Merijn Brand & Jens Rehsack
+Copyright (C) 2010-2013 by H.Merijn Brand & Jens Rehsack
All rights reserved.
Modified: dbi/branches/sqlengine/lib/DBD/File/Roadmap.pod
==============================================================================
--- dbi/branches/sqlengine/lib/DBD/File/Roadmap.pod (original)
+++ dbi/branches/sqlengine/lib/DBD/File/Roadmap.pod Fri Dec 21 04:40:43 2012
@@ -71,7 +71,7 @@
DBD::RAM or DBD::PO etc.
To improve the performance of the underlying SQL engines, a clean
-reimplementation seems to be required. Currently both engines are
+re-implementation seems to be required. Currently both engines are
prematurely optimized and therefore it is not trivial to provide
further optimization without the risk of breaking existing features.
@@ -142,7 +142,7 @@
=head1 PRIORITIES
-Our priorities are focussed on current issues. Initially many new test
+Our priorities are focused on current issues. Initially many new test
cases for DBD::File and DBD::DBM should be added to the DBI test
suite. After that some additional documentation on how to use the
DBD::File API will be provided.
