Doc update

[mfinanz.git] / scripts / rose_auto_create_model.pl

diff --git a/scripts/rose_auto_create_model.pl b/scripts/rose_auto_create_model.pl
index 6b6db0a8c31a6cce714c4f8b1f8042899c6a2361..7793d6096427534e4ce52e01538a9c27bf4035e7 100755 (executable)
--- a/scripts/rose_auto_create_model.pl
+++ b/scripts/rose_auto_create_model.pl
@@ -129,13 +129,16 @@ CODE
   my $file_exists = -f $meta_file;
   if ($file_exists) {
     my $old_size    = -s $meta_file;
-    my $old_md5     = md5_hex(do { local(@ARGV, $/) = ($meta_file); <> });
+    my $orig_file   = do { local(@ARGV, $/) = ($meta_file); <> };
+    my $old_md5     = md5_hex($orig_file);
     my $new_size    = length $full_definition;
     my $new_md5     = md5_hex($full_definition);
     if ($old_size == $new_size && $old_md5 == $new_md5) {
       notice("No changes in $meta_file, skipping.") if $config{verbose};
       return;
     }
+
+    show_diff(\$orig_file, \$full_definition) if $config{show_diff};
   }
 
   if (!$config{nocommit}) {
@@ -162,8 +165,10 @@ sub parse_args {
     all             => \ my $all,
     sugar           => \ my $sugar,
     'no-commit'     => \ my $nocommit,
+    'dry-run'       => \ my $nocommit,
     help            => sub { pod2usage(verbose => 99, sections => 'NAME|SYNOPSIS|OPTIONS') },
     verbose         => \ my $verbose,
+    diff            => \ my $diff,
   );
 
   $options->{login}    = $login if $login;
@@ -171,6 +176,29 @@ sub parse_args {
   $options->{all}      = $all;
   $options->{nocommit} = $nocommit;
   $options->{verbose}  = $verbose;
+
+  if ($diff) {
+    if (eval { require Text::Diff; 1 }) {
+      $options->{show_diff} = 1;
+    } else {
+      error('Could not load Text::Diff. Sorry, no diffs for you.');
+    }
+  }
+}
+
+sub show_diff {
+   my ($text_a, $text_b) = @_;
+
+   my %colors = (
+     '+' => 'green',
+     '-' => 'red',
+   );
+
+   Text::Diff::diff($text_a, $text_b, { OUTPUT => sub {
+     for (split /\n/, $_[0]) {
+       print colored($_, $colors{substr($_, 0, 1)}), $/;
+     }
+   }});
 }
 
 sub usage {
@@ -268,12 +296,19 @@ database connection, and the piece of mind that comes from knowing that your
 class is stable, and won't change behind your back in response to an "action at
 a distance" (i.e., a database schema update).>
 
-Unfortunately this ready easier than it is, since classes need to get in the
-right package and directory, certain stuff need to be adjusted and table names
+Unfortunately this reads easier than it is, since classes need to go into the
+right package and directory, certain stuff needs to be adjusted and table names
 need to be translated into their class names. This script will wrap all that
 behind a few simple options.
 
-In the most basic version, just give it a login and
+In the most basic version, just give it a login and a table name, and it will
+load the schema information for this table and create the appropriate class
+files, or update them if already present.
+
+Each table has two associated files. A C<SL::DB::MetaSetup::*> class, which is
+a perl version of the schema definition, and a C<SL::DB::*> class file. The
+first one will be updated if the schema changes, the second one will only be
+created if it does not exist.
 
 =head1 OPTIONS
 
@@ -297,9 +332,15 @@ Process tables in sugar schema instead of standard schema. Rarely useful unless
 you debug schema awareness of the RDBO layer.
 
 =item C<--no-commit, -n>
+=item C<--dry-run>
 
 Do not write back generated files. This will do everything as usual but not
-actually modify any files.
+actually modify any file.
+
+=item C<--diff>
+
+Displays diff for selected file, if file is present and newer file is
+different. Beware, does not imply C<--no-commit>.
 
 =item C<--help, -h>