package SQL::Translator::Utils;
# ----------------------------------------------------------------------
-# $Id: Utils.pm,v 1.1 2003-03-12 14:17:11 dlc Exp $
+# $Id: Utils.pm,v 1.8 2003-06-27 16:30:35 kycl4rk Exp $
# ----------------------------------------------------------------------
# Copyright (C) 2003 darren chamberlain <darren@cpan.org>
#
use strict;
use base qw(Exporter);
-use vars qw($VERSION @EXPORT_OK);
+use vars qw($VERSION $DEFAULT_COMMENT @EXPORT_OK);
use Exporter;
-$VERSION = 1.00;
-@EXPORT_OK = ('debug');
+$VERSION = sprintf "%d.%02d", q$Revision: 1.8 $ =~ /(\d+)\.(\d+)/;
+$DEFAULT_COMMENT = '-- ';
+@EXPORT_OK = qw(
+ debug normalize_name header_comment parse_list_arg $DEFAULT_COMMENT
+);
# ----------------------------------------------------------------------
# debug(@msg)
# If called from Translator.pm, on line 643.
# ----------------------------------------------------------------------
sub debug {
- my ($pkg, $file, $line, $sub) = caller(1);
+ my ($pkg, $file, $line, $sub) = caller(0);
{
no strict qw(refs);
return unless ${"$pkg\::DEBUG"};
}
}
+# ----------------------------------------------------------------------
+sub normalize_name {
+ my $name = shift;
+
+ # The name can only begin with a-zA-Z_; if there's anything
+ # else, prefix with _
+ $name =~ s/^([^a-zA-Z_])/_$1/;
+
+ # anything other than a-zA-Z0-9_ in the non-first position
+ # needs to be turned into _
+ $name =~ tr/[a-zA-Z0-9_]/_/c;
+
+ # All duplicated _ need to be squashed into one.
+ $name =~ tr/_/_/s;
+
+ # Trim a trailing _
+ $name =~ s/_$//;
+
+ return $name;
+}
+
+# ----------------------------------------------------------------------
+sub header_comment {
+ my $producer = shift || caller;
+ my $comment_char = shift;
+ my $now = scalar localtime;
+
+ $comment_char = $DEFAULT_COMMENT
+ unless defined $comment_char;
+
+ my $header_comment =<<"HEADER_COMMENT";
+${comment_char}
+${comment_char}Created by $producer
+${comment_char}Created on $now
+${comment_char}
+HEADER_COMMENT
+
+ # Any additional stuff passed in
+ for my $additional_comment (@_) {
+ $header_comment .= "${comment_char}${additional_comment}\n";
+ }
+
+ 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
C<SQL::Translator::Utils> contains utility functions designed to be
used from the other modules within the C<SQL::Translator> modules.
-No functions are exported by default.
+Nothing is exported by default.
-=head1 EXPORTED FUNCTIONS
+=head1 EXPORTED FUNCTIONS AND CONSTANTS
=head2 debug
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:
The entire message is enclosed within C<[> and C<]> for visual clarity
when STDERR is intermixed with STDOUT.
+
+=head2 normalize_name
+
+C<normalize_name> takes a string and ensures that it is suitable for
+use as an identifier. This means: ensure that it starts with a letter
+or underscore, and that the rest of the string consists of only
+letters, numbers, and underscores. A string that begins with
+something other than [a-zA-Z] will be prefixer with an underscore, and
+all other characters in the string will be replaced with underscores.
+Finally, a trailing underscore will be removed, because that's ugly.
+
+ normalize_name("Hello, world");
+
+Produces:
+
+ Hello_world
+
+A more useful example, from the C<SQL::Translator::Parser::Excel> test
+suite:
+
+ normalize_name("silly field (with random characters)");
+
+returns:
+
+ silly_field_with_random_characters
+
+=head2 header_comment
+
+Create the header comment. Takes 1 mandatory argument (the producer
+classname), an optional comment character (defaults to $DEFAULT_COMMENT),
+and 0 or more additional comments, which will be appended to the header,
+prefixed with the comment character. If additional comments are provided,
+then a comment string must be provided ($DEFAULT_COMMENT is exported for
+this use). For example, this:
+
+ package My::Producer;
+
+ use SQL::Translator::Utils qw(header_comment $DEFAULT_COMMENT);
+
+ print header_comment(__PACKAGE__,
+ $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
projects / dbsrgits/SQL-Translator.git / blobdiff