package SQL::Translator::Utils;
# ----------------------------------------------------------------------
-# $Id: Utils.pm,v 1.3 2003-04-25 11:44:20 dlc Exp $
+# $Id: Utils.pm,v 1.12 2004-02-09 23:04:26 kycl4rk Exp $
# ----------------------------------------------------------------------
-# Copyright (C) 2003 darren chamberlain <darren@cpan.org>
+# Copyright (C) 2002-4 SQLFairy Authors
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
use Exporter;
-$VERSION = 1.00;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.12 $ =~ /(\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)
}
}
-
+# ----------------------------------------------------------------------
sub normalize_name {
- my $name = shift;
+ my $name = shift or return '';
# The name can only begin with a-zA-Z_; if there's anything
# else, prefix with _
return $name;
}
+# ----------------------------------------------------------------------
sub header_comment {
my $producer = shift || caller;
my $comment_char = shift;
return $header_comment;
}
+# ----------------------------------------------------------------------
+# parse_list_arg
+#
+# Meant to accept a list, an array reference, or a string of
+# comma-separated values. Retuns an array reference of the
+# arguments. Modified to also handle a list of references.
+# ----------------------------------------------------------------------
+sub parse_list_arg {
+ my $list = UNIVERSAL::isa( $_[0], 'ARRAY' ) ? shift : [ @_ ];
+
+ #
+ # This protects stringification of references.
+ #
+ if ( @$list && ref $list->[0] ) {
+ return $list;
+ }
+ #
+ # This processes string-like arguments.
+ #
+ else {
+ return [
+ map { s/^\s+|\s+$//g; $_ }
+ map { split /,/ }
+ grep { defined && length } @$list
+ ];
+ }
+}
+
1;
-__END__
+# ----------------------------------------------------------------------
+
+=pod
=head1 NAME
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:
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