package SQL::Translator::Utils;
# ----------------------------------------------------------------------
-# $Id: Utils.pm,v 1.2 2003-04-17 13:41:36 dlc Exp $
+# $Id: Utils.pm 1440 2009-01-17 16:31:57Z jawnsy $
# ----------------------------------------------------------------------
-# Copyright (C) 2003 darren chamberlain <darren@cpan.org>
+# Copyright (C) 2002-2009 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 strict;
use base qw(Exporter);
-use vars qw($VERSION @EXPORT_OK);
+use vars qw($VERSION $DEFAULT_COMMENT @EXPORT_OK);
+
+use Digest::SHA1 qw( sha1_hex );
use Exporter;
-$VERSION = 1.00;
-@EXPORT_OK = ('debug', 'normalize_name');
+$VERSION = '1.99';
+$DEFAULT_COMMENT = '-- ';
+@EXPORT_OK = qw(
+ debug normalize_name header_comment parse_list_arg truncate_id_uniquely $DEFAULT_COMMENT parse_mysql_version
+);
# ----------------------------------------------------------------------
# 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;
+ 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;
+ 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;
+}
+
+# ----------------------------------------------------------------------
+# 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
+ ];
+ }
+}
+
+# ----------------------------------------------------------------------
+# truncate_id_uniquely( $desired_name, $max_symbol_length )
+#
+# Truncates the name $desired_name to the $max_symbol_length by
+# including part of the hash of the full name at the end of the
+# truncated name, giving a high probability that the symbol will be
+# unique.
+# ----------------------------------------------------------------------
+my $COLLISION_TAG_LENGTH = 8;
+sub truncate_id_uniquely {
+ my ( $desired_name, $max_symbol_length ) = @_;
+
+ return $desired_name unless defined $desired_name && length $desired_name > $max_symbol_length;
+
+ my $truncated_name = substr $desired_name, 0, $max_symbol_length - $COLLISION_TAG_LENGTH - 1;
+
+ # Hex isn't the most space-efficient, but it skirts around allowed
+ # charset issues
+ my $digest = sha1_hex($desired_name);
+ my $collision_tag = substr $digest, 0, $COLLISION_TAG_LENGTH;
+
+ return $truncated_name
+ . '_'
+ . $collision_tag;
+}
+
+
+#---------------------------------------------------------------------
+# parse_mysql_version ( $version_string, $result_target)
+#
+# Attempts to parse an arbitrary string as a mysql version number.
+# Returns either a floating point perl style string, or a mysql style
+# 5 digit string, depending on the supplied $result_target
+#---------------------------------------------------------------------
+sub parse_mysql_version {
+ my ($v, $target) = @_;
+
+ return undef unless $v;
+
+ $target ||= 'perl';
+
+ my @vers;
+
+ # X.Y.Z style
+ if ( $v =~ / ^ (\d+) \. (\d{1,3}) (?: \. (\d{1,3}) )? $ /x ) {
+ push @vers, $1, $2, $3;
+ }
+
+ # XYYZZ (mysql) style
+ elsif ( $v =~ / ^ (\d) (\d{2}) (\d{2}) $ /x ) {
+ push @vers, $1, $2, $3;
+ }
+
+ # XX.YYYZZZ (perl) style or simply X
+ elsif ( $v =~ / ^ (\d+) (?: \. (\d{3}) (\d{3}) )? $ /x ) {
+ push @vers, $1, $2, $3;
+ }
+ else {
+ #how do I croak sanely here?
+ die "Unparseable MySQL version '$v'";
+ }
+
+ if ($target eq 'perl') {
+ return sprintf ('%d.%03d%03d', map { $_ || 0 } (@vers) );
+ }
+ elsif ($target eq 'mysql') {
+ return sprintf ('%d%02d%02d', map { $_ || 0 } (@vers) );
+ }
+ else {
+ #how do I croak sanely here?
+ die "Unknown version target '$target'";
+ }
+}
+
+
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:
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 truncate_id_uniquely
+
+Takes a string ($desired_name) and int ($max_symbol_length). Truncates
+$desired_name to $max_symbol_length by including part of the hash of
+the full name at the end of the truncated name, giving a high
+probability that the symbol will be unique. For example,
+
+ truncate_id_uniquely( 'a' x 100, 64 )
+ truncate_id_uniquely( 'a' x 99 . 'b', 64 );
+ truncate_id_uniquely( 'a' x 99, 64 )
+
+Will give three different results; specifically:
+
+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa_7f900025
+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa_6191e39a
+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa_8cd96af2
+
+=head2 $DEFAULT_COMMENT
+
+This is the default comment string, '-- ' by default. Useful for
+C<header_comment>.
+
+=head2 parse_mysql_version
+
+Used by both L<Parser::MySQL|SQL::Translator::Parser::MySQL> and
+L<Producer::MySQL|SQL::Translator::Producer::MySQL> in order to provide a
+consistent format for both C<< parser_args->{mysql_parser_version} >> and
+C<< producer_args->{mysql_version} >> respectively. Takes any of the following
+version specifications:
+
+ 5.0.3
+ 4.1
+ 3.23.2
+ 5
+ 5.001005 (perl style)
+ 30201 (mysql style)
+
+=head1 AUTHORS
+
+Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
+
+=cut
projects / dbsrgits/SQL-Translator.git / blobdiff