Doc notes on version selection and added xmi.id to specs.

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

diff --git a/lib/SQL/Translator/Utils.pm b/lib/SQL/Translator/Utils.pm
index 87ec225..ea39bd9 100644 (file)
--- a/lib/SQL/Translator/Utils.pm
+++ b/lib/SQL/Translator/Utils.pm
@@ -1,7 +1,7 @@
 package SQL::Translator::Utils;
 
 # ----------------------------------------------------------------------
-# $Id: Utils.pm,v 1.3 2003-04-25 11:44:20 dlc Exp $
+# $Id: Utils.pm,v 1.8 2003-06-27 16:30:35 kycl4rk Exp $
 # ----------------------------------------------------------------------
 # Copyright (C) 2003 darren chamberlain <darren@cpan.org>
 #
@@ -26,9 +26,11 @@ use vars qw($VERSION $DEFAULT_COMMENT @EXPORT_OK);
 
 use Exporter;
 
-$VERSION = 1.00;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/;
 $DEFAULT_COMMENT = '-- ';
-@EXPORT_OK = qw(debug normalize_name header_comment $DEFAULT_COMMENT);
+@EXPORT_OK = qw(
+    debug normalize_name header_comment parse_list_arg $DEFAULT_COMMENT
+);
 
 # ----------------------------------------------------------------------
 # debug(@msg)
@@ -68,7 +70,7 @@ sub debug {
     }
 }
 
-
+# ----------------------------------------------------------------------
 sub normalize_name {
     my $name = shift;
 
@@ -89,6 +91,7 @@ sub normalize_name {
     return $name;
 }
 
+# ----------------------------------------------------------------------
 sub header_comment {
     my $producer = shift || caller;
     my $comment_char = shift;
@@ -112,9 +115,21 @@ HEADER_COMMENT
     return $header_comment;
 }
 
+# ----------------------------------------------------------------------
+sub parse_list_arg {
+    my $list = UNIVERSAL::isa( $_[0], 'ARRAY' ) ? shift : [ @_ ];
+
+    return [ map { s/^\s+|\s+$//g; $_ }
+             map { split /,/ }
+             grep { defined && length } @$list
+           ];
+}
+
 1;
 
-__END__
+# ----------------------------------------------------------------------
+
+=pod
 
 =head1 NAME
 
@@ -139,7 +154,7 @@ Nothing is exported by default.
 C<debug> takes 0 or more messages, which will be sent to STDERR using
 C<warn>.  Occurances of the strings I<PKG>, I<SUB>, and I<LINE>
 will be replaced by the calling package, subroutine, and line number,
-respectively, as reported by C<caller(1)>.  
+respectively, as reported by C<caller(1)>.
 
 For example, from within C<foo> in F<SQL/Translator.pm>, at line 666:
 
@@ -191,22 +206,42 @@ this use).  For example, this:
   use SQL::Translator::Utils qw(header_comment $DEFAULT_COMMENT);
 
   print header_comment(__PACKAGE__,
-                       $DEFAULT_COMMENT, 
+                       $DEFAULT_COMMENT,
                        "Hi mom!");
 
 produces:
 
-  -- 
+  --
   -- Created by My::Prodcuer
   -- Created on Fri Apr 25 06:56:02 2003
-  -- 
+  --
   -- Hi mom!
-  -- 
+  --
 
 Note the gratuitous spacing.
 
+=head2 parse_list_arg
+
+Takes a string, list or arrayref (all of which could contain
+comma-separated values) and returns an array reference of the values.
+All of the following will return equivalent values:
+
+  parse_list_arg('id');
+  parse_list_arg('id', 'name');
+  parse_list_arg( 'id, name' );
+  parse_list_arg( [ 'id', 'name' ] );
+  parse_list_arg( qw[ id name ] );
+
 =head2 $DEFAULT_COMMENT
 
 This is the default comment string, '-- ' by default.  Useful for
 C<header_comment>.
 
+=head1 AUTHORS
+
+Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
+
+=cut
+
+=cut