lib/SQL/Translator/Utils.pm

   1 package SQL::Translator::Utils;
   2
   3 # ----------------------------------------------------------------------
   4 # Copyright (C) 2002-2009 SQLFairy Authors
   5 #
   6 # This program is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU General Public License as
   8 # published by the Free Software Foundation; version 2.
   9 #
  10 # This program is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 # General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18 # 02111-1307  USA
  19 # -------------------------------------------------------------------
  20
  21 use strict;
  22 use base qw(Exporter);
  23 use vars qw($VERSION $DEFAULT_COMMENT @EXPORT_OK);
  24 use Digest::SHA1 qw( sha1_hex );
  25 use Exporter;
  26 use Readonly;
  27
  28 $VERSION = '1.60';
  29 $DEFAULT_COMMENT = '-- ';
  30 @EXPORT_OK = qw(
  31     debug normalize_name header_comment parse_list_arg truncate_id_uniquely $DEFAULT_COMMENT parse_mysql_version
  32 );
  33 Readonly my $COLLISION_TAG_LENGTH => 8;
  34
  35 # ----------------------------------------------------------------------
  36 # debug(@msg)
  37 #
  38 # Will send debugging messages to STDERR, if the caller's $DEBUG global
  39 # is set.
  40 #
  41 # This debug() function has a neat feature: Occurances of the strings
  42 # PKG, LINE, and SUB in each message will be replaced with elements
  43 # from caller():
  44 #
  45 #   debug("PKG: Bad things happened on line LINE!");
  46 #
  47 # Will be warned as:
  48 #
  49 #   [SQL::Translator: Bad things happened on line 643]
  50 #
  51 # If called from Translator.pm, on line 643.
  52 # ----------------------------------------------------------------------
  53 sub debug {
  54     my ($pkg, $file, $line, $sub) = caller(0);
  55     {
  56         no strict qw(refs);
  57         return unless ${"$pkg\::DEBUG"};
  58     }
  59
  60     $sub =~ s/^$pkg\:://;
  61
  62     while (@_) {
  63         my $x = shift;
  64         chomp $x;
  65         $x =~ s/\bPKG\b/$pkg/g;
  66         $x =~ s/\bLINE\b/$line/g;
  67         $x =~ s/\bSUB\b/$sub/g;
  68         #warn '[' . $x . "]\n";
  69         print STDERR '[' . $x . "]\n";
  70     }
  71 }
  72
  73 # ----------------------------------------------------------------------
  74 sub normalize_name {
  75     my $name = shift or return '';
  76
  77     # The name can only begin with a-zA-Z_; if there's anything
  78     # else, prefix with _
  79     $name =~ s/^([^a-zA-Z_])/_$1/;
  80
  81     # anything other than a-zA-Z0-9_ in the non-first position
  82     # needs to be turned into _
  83     $name =~ tr/[a-zA-Z0-9_]/_/c;
  84
  85     # All duplicated _ need to be squashed into one.
  86     $name =~ tr/_/_/s;
  87
  88     # Trim a trailing _
  89     $name =~ s/_$//;
  90
  91     return $name;
  92 }
  93
  94 # ----------------------------------------------------------------------
  95 sub header_comment {
  96     my $producer = shift || caller;
  97     my $comment_char = shift;
  98     my $now = scalar localtime;
  99
 100     $comment_char = $DEFAULT_COMMENT
 101         unless defined $comment_char;
 102
 103     my $header_comment =<<"HEADER_COMMENT";
 104 ${comment_char}
 105 ${comment_char}Created by $producer
 106 ${comment_char}Created on $now
 107 ${comment_char}
 108 HEADER_COMMENT
 109
 110     # Any additional stuff passed in
 111     for my $additional_comment (@_) {
 112         $header_comment .= "${comment_char}${additional_comment}\n";
 113     }
 114
 115     return $header_comment;
 116 }
 117
 118 # ----------------------------------------------------------------------
 119 # parse_list_arg
 120 #
 121 # Meant to accept a list, an array reference, or a string of
 122 # comma-separated values.  Retuns an array reference of the
 123 # arguments.  Modified to also handle a list of references.
 124 # ----------------------------------------------------------------------
 125 sub parse_list_arg {
 126     my $list = UNIVERSAL::isa( $_[0], 'ARRAY' ) ? shift : [ @_ ];
 127
 128     #
 129     # This protects stringification of references.
 130     #
 131     if ( @$list && ref $list->[0] ) {
 132         return $list;
 133     }
 134     #
 135     # This processes string-like arguments.
 136     #
 137     else {
 138         return [
 139             map { s/^\s+|\s+$//g; $_ }
 140             map { split /,/ }
 141             grep { defined && length } @$list
 142         ];
 143     }
 144 }
 145
 146 # ----------------------------------------------------------------------
 147 # truncate_id_uniquely( $desired_name, $max_symbol_length )
 148 #
 149 # Truncates the name $desired_name to the $max_symbol_length by
 150 # including part of the hash of the full name at the end of the
 151 # truncated name, giving a high probability that the symbol will be
 152 # unique.
 153 # ----------------------------------------------------------------------
 154 sub truncate_id_uniquely {
 155     my ( $desired_name, $max_symbol_length ) = @_;
 156
 157     return $desired_name
 158       unless defined $desired_name && length $desired_name > $max_symbol_length;
 159
 160     my $truncated_name = substr $desired_name, 0,
 161       $max_symbol_length - $COLLISION_TAG_LENGTH - 1;
 162
 163     # Hex isn't the most space-efficient, but it skirts around allowed
 164     # charset issues
 165     my $digest = sha1_hex($desired_name);
 166     my $collision_tag = substr $digest, 0, $COLLISION_TAG_LENGTH;
 167
 168     return $truncated_name
 169          . '_'
 170          . $collision_tag;
 171 }
 172
 173
 174 #---------------------------------------------------------------------
 175 # parse_mysql_version ( $version_string, $result_target)
 176 #
 177 # Attempts to parse an arbitrary string as a mysql version number.
 178 # Returns either a floating point perl style string, or a mysql style
 179 # 5 digit string, depending on the supplied $result_target
 180 #---------------------------------------------------------------------
 181 sub parse_mysql_version {
 182     my ($v, $target) = @_;
 183
 184     return undef unless $v;
 185
 186     $target ||= 'perl';
 187
 188     my @vers;
 189
 190     # X.Y.Z style
 191     if ( $v =~ / ^ (\d+) \. (\d{1,3}) (?: \. (\d{1,3}) )? $ /x ) {
 192         push @vers, $1, $2, $3;
 193     }
 194
 195     # XYYZZ (mysql) style
 196     elsif ( $v =~ / ^ (\d) (\d{2}) (\d{2}) $ /x ) {
 197         push @vers, $1, $2, $3;
 198     }
 199
 200     # XX.YYYZZZ (perl) style or simply X
 201     elsif ( $v =~ / ^ (\d+) (?: \. (\d{3}) (\d{3}) )? $ /x ) {
 202         push @vers, $1, $2, $3;
 203     }
 204     else {
 205         #how do I croak sanely here?
 206         die "Unparseable MySQL version '$v'";
 207     }
 208
 209     if ($target eq 'perl') {
 210         return sprintf ('%d.%03d%03d', map { $_ || 0 } (@vers) );
 211     }
 212     elsif ($target eq 'mysql') {
 213         return sprintf ('%d%02d%02d', map { $_ || 0 } (@vers) );
 214     }
 215     else {
 216         #how do I croak sanely here?
 217         die "Unknown version target '$target'";
 218     }
 219 }
 220
 221
 222 1;
 223
 224 # ----------------------------------------------------------------------
 225
 226 =pod
 227
 228 =head1 NAME
 229
 230 SQL::Translator::Utils - SQL::Translator Utility functions
 231
 232 =head1 SYNOPSIS
 233
 234   use SQL::Translator::Utils qw(debug);
 235   debug("PKG: Bad things happened");
 236
 237 =head1 DESCSIPTION
 238
 239 C<SQL::Translator::Utils> contains utility functions designed to be
 240 used from the other modules within the C<SQL::Translator> modules.
 241
 242 Nothing is exported by default.
 243
 244 =head1 EXPORTED FUNCTIONS AND CONSTANTS
 245
 246 =head2 debug
 247
 248 C<debug> takes 0 or more messages, which will be sent to STDERR using
 249 C<warn>.  Occurances of the strings I<PKG>, I<SUB>, and I<LINE>
 250 will be replaced by the calling package, subroutine, and line number,
 251 respectively, as reported by C<caller(1)>.
 252
 253 For example, from within C<foo> in F<SQL/Translator.pm>, at line 666:
 254
 255   debug("PKG: Error reading file at SUB/LINE");
 256
 257 Will warn
 258
 259   [SQL::Translator: Error reading file at foo/666]
 260
 261 The entire message is enclosed within C<[> and C<]> for visual clarity
 262 when STDERR is intermixed with STDOUT.
 263
 264 =head2 normalize_name
 265
 266 C<normalize_name> takes a string and ensures that it is suitable for
 267 use as an identifier.  This means: ensure that it starts with a letter
 268 or underscore, and that the rest of the string consists of only
 269 letters, numbers, and underscores.  A string that begins with
 270 something other than [a-zA-Z] will be prefixer with an underscore, and
 271 all other characters in the string will be replaced with underscores.
 272 Finally, a trailing underscore will be removed, because that's ugly.
 273
 274   normalize_name("Hello, world");
 275
 276 Produces:
 277
 278   Hello_world
 279
 280 A more useful example, from the C<SQL::Translator::Parser::Excel> test
 281 suite:
 282
 283   normalize_name("silly field (with random characters)");
 284
 285 returns:
 286
 287   silly_field_with_random_characters
 288
 289 =head2 header_comment
 290
 291 Create the header comment.  Takes 1 mandatory argument (the producer
 292 classname), an optional comment character (defaults to $DEFAULT_COMMENT),
 293 and 0 or more additional comments, which will be appended to the header,
 294 prefixed with the comment character.  If additional comments are provided,
 295 then a comment string must be provided ($DEFAULT_COMMENT is exported for
 296 this use).  For example, this:
 297
 298   package My::Producer;
 299
 300   use SQL::Translator::Utils qw(header_comment $DEFAULT_COMMENT);
 301
 302   print header_comment(__PACKAGE__,
 303                        $DEFAULT_COMMENT,
 304                        "Hi mom!");
 305
 306 produces:
 307
 308   --
 309   -- Created by My::Prodcuer
 310   -- Created on Fri Apr 25 06:56:02 2003
 311   --
 312   -- Hi mom!
 313   --
 314
 315 Note the gratuitous spacing.
 316
 317 =head2 parse_list_arg
 318
 319 Takes a string, list or arrayref (all of which could contain
 320 comma-separated values) and returns an array reference of the values.
 321 All of the following will return equivalent values:
 322
 323   parse_list_arg('id');
 324   parse_list_arg('id', 'name');
 325   parse_list_arg( 'id, name' );
 326   parse_list_arg( [ 'id', 'name' ] );
 327   parse_list_arg( qw[ id name ] );
 328
 329 =head2 truncate_id_uniquely
 330
 331 Takes a string ($desired_name) and int ($max_symbol_length). Truncates
 332 $desired_name to $max_symbol_length by including part of the hash of
 333 the full name at the end of the truncated name, giving a high
 334 probability that the symbol will be unique. For example,
 335
 336   truncate_id_uniquely( 'a' x 100, 64 )
 337   truncate_id_uniquely( 'a' x 99 . 'b', 64 );
 338   truncate_id_uniquely( 'a' x 99,  64 )
 339
 340 Will give three different results; specifically:
 341
 342   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa_7f900025
 343   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa_6191e39a
 344   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa_8cd96af2
 345
 346 =head2 $DEFAULT_COMMENT
 347
 348 This is the default comment string, '-- ' by default.  Useful for
 349 C<header_comment>.
 350
 351 =head2 parse_mysql_version
 352
 353 Used by both L<Parser::MySQL|SQL::Translator::Parser::MySQL> and
 354 L<Producer::MySQL|SQL::Translator::Producer::MySQL> in order to provide a
 355 consistent format for both C<< parser_args->{mysql_parser_version} >> and
 356 C<< producer_args->{mysql_version} >> respectively. Takes any of the following
 357 version specifications:
 358
 359   5.0.3
 360   4.1
 361   3.23.2
 362   5
 363   5.001005  (perl style)
 364   30201     (mysql style)
 365
 366 =head1 AUTHORS
 367
 368 Darren Chamberlain E<lt>darren@cpan.orgE<gt>,
 369 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
 370
 371 =cut