Reduce $Id to its normal form

[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer.pm

diff --git a/lib/SQL/Translator/Producer.pm b/lib/SQL/Translator/Producer.pm
index 6aedc5c..450eb64 100644 (file)
--- a/lib/SQL/Translator/Producer.pm
+++ b/lib/SQL/Translator/Producer.pm
@@ -1,64 +1,114 @@
 package SQL::Translator::Producer;
 
-#-----------------------------------------------------
-# $Id: Producer.pm,v 1.1.1.1 2002-03-01 02:26:25 kycl4rk Exp $
+# -------------------------------------------------------------------
+# $Id$
+# -------------------------------------------------------------------
+# Copyright (C) 2002-4 SQLFairy Authors
 #
-# File       : SQL/Translator/Producer.pm
-# Programmer : Ken Y. Clark, kclark@logsoft.com
-# Created    : 2002/02/27
-# Purpose    : base object for Producers
-#-----------------------------------------------------
-
-use strict;
-use vars qw( $VERSION );
-$VERSION = (qw$Revision: 1.1.1.1 $)[-1];
-
-use SQL::Translator;
-use base qw[ SQL::Translator ];
-
-sub from { return shift()->{'from'} }
-
-sub header {
-    my $self = shift;
-    my $from = $self->from || '';
-    my $to   = $self->to   || '';
-    return <<"HEADER";
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; version 2.
 #
-# $from-to-$to translator
-# Version: $SQL::Translator::VERSION
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
 #
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+# 02111-1307  USA
+# -------------------------------------------------------------------
+
+use strict;
+use vars qw($VERSION);
+$VERSION = '1.99';
+
+sub produce { "" }
+
+# Do not rely on this if you are not bundled with SQL::Translator.
+# -- rjbs, 2008-09-30
+## $exceptions contains an arrayref of paired values
+## Each pair contains a pattern match or string, and a value to be used as
+## the default if matched.
+## They are special per Producer, and provide support for the old 'now()'
+## default value exceptions
+sub _apply_default_value {
+  my (undef, $field_ref, $default, $exceptions) = @_;
+
+  if ($exceptions and ! ref $default) {
+    for (my $i = 0; $i < @$exceptions; $i += 2) {
+      my ($pat, $val) = @$exceptions[ $i, $i + 1 ];
+      if (ref $pat and $default =~ $pat) {
+          $default = $val;
+          last;
+      } elsif (lc $default eq lc $pat) {
+          $default = $val;
+          last
+      }
+    }
+  }
+
+  if (ref $default) {
+      $$field_ref .= " DEFAULT $$default";
+  } else {
+      $$field_ref .= " DEFAULT '$default'";
+  }
 
-HEADER
 }
 
 1;
 
-#-----------------------------------------------------
+# -------------------------------------------------------------------
 # A burnt child loves the fire.
 # Oscar Wilde
-#-----------------------------------------------------
+# -------------------------------------------------------------------
+
+=pod
 
 =head1 NAME
 
-SQL::Translator::Producer - base object for Producers
+SQL::Translator::Producer - describes how to write a producer
 
-=head1 SYNOPSIS
+=head1 DESCRIPTION
 
-  package SQL::Translator::Producer::Foo;
-  use SQL::Translator::Producer;
-  use base( 'SQL::Translator::Producer' );
-  1;
+Producer modules designed to be used with SQL::Translator need to
+implement a single function, called B<produce>.  B<produce> will be
+called with the SQL::Translator object from which it is expected to 
+retrieve the SQL::Translator::Schema object which has been populated 
+by the parser.  It is expected to return a string.
 
-=head1 DESCRIPTION
+=head1 METHODS
+
+=over 4
+
+=item produce
+
+=item create_table($table)
+
+=item create_field($field)
+
+=item create_view($view)
+
+=item create_index($index)
+
+=item create_constraint($constraint)
+
+=item create_trigger($trigger)
+
+=item alter_field($from_field, $to_field)
+
+=item add_field($table, $new_field)
 
-Intended to serve as a base class for all SQL Translator producers.
+=item drop_field($table, $old_field)
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-Ken Y. Clark, kclark@logsoft.com
+Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
 
 =head1 SEE ALSO
 
-perl(1).
+perl(1), SQL::Translator, SQL::Translator::Schema.
 
 =cut