Changeset 379 for trunk/project-meta

Timestamp:

Nov 28, 2018, 12:05:51 AM (6 years ago)

Author:

g7moreau

Message:

• Update project-meta to Dublin Core. Add an upgrade command

File:

• trunk/project-meta/project-meta (modified) (18 diffs)

trunk/project-meta/project-meta

@@ -8 +8 @@
 use strict;
 use warnings;
-use version; our $VERSION = version->declare('0.0.12');
+use version; our $VERSION = version->declare('0.1.1');
 
 use File::Copy qw(copy);    
@@ -17 +17 @@
 use Archive::Zip qw(:ERROR_CODES :CONSTANTS);
 
+our $CFG_VERSION = 2;
 
 my ($verbose);
@@ -36 +37 @@
    'make-file-license'     => \&cmd_make_file_license,
    'list-license'          => \&cmd_list_license,
+   'upgrade'               => \&cmd_upgrade,
    );
 
@@ -75 +77 @@
    $folderdb->{$folder}++;
    return addfolder2list($folderdb, $folder);
+   }
+
+################################################################
+
+sub upgrade_version_1_to_2 {
+   my $meta = shift;
+
+   $meta->{'project'}{'identifier'} ||= {};
+   $meta->{'project'}{'identifier'}{'acronym'} = $meta->{'project'}{'acronym'};
+   delete $meta->{'project'}{'acronym'};
+
+   $meta->{'project'}{'creator'} = $meta->{'project'}{'authors'};
+   delete $meta->{'project'}{'authors'};
+
+   $meta->{'project'}{'description'} = $meta->{'project'}{'short-description'};
+   delete $meta->{'project'}{'short-description'};
+
+   $meta->{'project'}{'rights'} = $meta->{'public-dap'}{'data-license'};
+   delete $meta->{'public-dap'}{'data-license'};
+
+   $meta->{'project'}{'relation'} ||= [];
+   for my $doi (@{$meta->{'publication'}{'doi'}}) {
+      push @{$meta->{'project'}{'relation'}}, {doi => $doi};
+      }
+   delete $meta->{'publication'}{'doi'};
+
+   $meta->{'version'} = 2;
+   return $meta;
+   }
+
+################################################################
+
+sub load_metadata {
+   my $meta = YAML::Syck::LoadFile("PROJECT-META.yml");
+
+   my $initial_version = $meta->{'version'};
+   if ($initial_version < $CFG_VERSION) {
+      print "Warning: upgrade config file from version $initial_version to last version $CFG_VERSION\n";
+      my $upgrade = 'upgrade_version_' . ($CFG_VERSION - 1) . '_to_' . $CFG_VERSION;
+      &{$upgrade}($meta);
+      }
+   elsif ($initial_version < $CFG_VERSION) {
+      die "Error: config file at future version $meta->{'version'}, program only at $CFG_VERSION\n"
+      }
+
+   return wantarray ? ($meta, $version) : $meta;
    }
 
@@ -96 +144 @@
  project-meta make-file-author
  project-meta make-file-copyright
+ project-meta upgrade
 END
    }
@@ -107 +156 @@
 ################################################################
 
+sub cmd_upgrade {
+   my ($meta, $initial_version) = load_metadata();
+
+   if ($initial_version < $meta->{'version'}) {
+      my $next_config = "PROJECT-META-v$meta->{'version'}.yml";
+      if (-e $next_config) {
+         die "Error: upgrade propose config file $next_config already exists\n";
+         }
+      
+      print "Warning: create new config file $next_config, please verify before using it\n";
+      YAML::Syck::SaveFile($next_config, $meta);
+      }
+   else ($initial_version == $CFG_VERSION) {
+      print "Warning: nothing to do, config file already at version $CFG_VERSION\n"
+      };
+   }
+
+################################################################
+
 sub cmd_check {
-   my $meta = YAML::Syck::LoadFile("PROJECT-META.yml");
-
-   my $acronym     = $meta->{'project'}{'acronym'};
+   my $meta = load_metadata();
+
+   my $acronym     = $meta->{'project'}{'identifier'}{'acronym'};
    my $current_dir = Cwd::getcwd();
    my $dap_folder  = $meta->{'public-dap'}{'dap-folder'};
 
-   print_ok 'project/acronym',                  $acronym =~ m{\d\d\w[\w\d_/]+};
+   print_ok 'project/identifier/acronym',       $acronym =~ m{\d\d\w[\w\d_/]+};
    print_ok 'public-dap/dap-folder',            $dap_folder ne '' and $dap_folder =~ m{^/};
    print_ok 'dap-folder not match current_dir', $dap_folder !~ m{$current_dir};
@@ -124 +192 @@
 
 sub cmd_dap_publish {
-   my $meta = YAML::Syck::LoadFile("PROJECT-META.yml");
+   my $meta = load_metadata();
    my $current_dir = Cwd::getcwd();
-   my $acronym     = $meta->{'project'}{'acronym'};
+   my $acronym     = $meta->{'project'}{'identifier'}{'acronym'};
    my $dap_folder  = $meta->{'public-dap'}{'dap-folder'};
    my $data_set    = $meta->{'public-dap'}{'data-set'};
@@ -169 +237 @@
 
 sub cmd_dap_unpublish {
-   my $meta = YAML::Syck::LoadFile("PROJECT-META.yml");
+   my $meta = load_metadata();
    my $current_dir = Cwd::getcwd();
-   my $acronym     = $meta->{'project'}{'acronym'};
+   my $acronym     = $meta->{'project'}{'identifier'}{'acronym'};
    my $dap_folder  = $meta->{'public-dap'}{'dap-folder'};
 
@@ -184 +252 @@
 
 sub cmd_make_zip {
-   my $meta = YAML::Syck::LoadFile("PROJECT-META.yml");
+   my $meta = load_metadata();
    my $current_dir = Cwd::getcwd();
    my $data_set    = $meta->{'public-dap'}{'data-set'};
-   my $acronym     = $meta->{'project'}{'acronym'};
+   my $acronym     = $meta->{'project'}{'identifier'}{'acronym'};
 
    push @{$data_set}, 'AUTHORS.txt', 'COPYRIGHT.txt', 'LICENSE.txt';
@@ -236 +304 @@
 
 sub cmd_make_file_author {
-   my $meta = YAML::Syck::LoadFile("PROJECT-META.yml");
+   my $meta = load_metadata();
 
    my $current_dir = Cwd::getcwd();
 
-   my $acronym    = $meta->{'project'}{'acronym'};
-   my $authors_list = $meta->{'project'}{'authors'};
+   my $acronym    = $meta->{'project'}{'identifier'}{'acronym'};
+   my $authors_list = $meta->{'project'}{'creator'};
 
    if (-f "$current_dir/AUTHORS.txt") {
@@ -277 +345 @@
 
 sub cmd_make_file_license {
-   my $meta = YAML::Syck::LoadFile("PROJECT-META.yml");
+   my $meta = load_metadata();
 
    my $current_dir = Cwd::getcwd();
@@ -286 +354 @@
       }
 
-   my $license = $meta->{'public-dap'}{'data-license'};
+   my $license = $meta->{'project'}{'rights'};
 
    if (not -f "/usr/share/project-meta/license.d/$license.txt") {
@@ -303 +371 @@
 
 sub cmd_make_file_copyright {
-   my $meta = YAML::Syck::LoadFile("PROJECT-META.yml");
+   my $meta = load_metadata();
 
    my $current_dir = Cwd::getcwd();
@@ -330 +398 @@
       );
    my $msg_format = '';
+   my $doi_first;
+   for my $doi (@{$meta->{'project'}{'relation'}) {
+      next if not exists $doi->{'doi'};
+      $doi_first = $doi->{'doi'};
+      last;
+      }
    $tt->process('COPYRIGHT.tt',
       {
          title       => $meta->{'project'}{'title'},
-         acronym     => $meta->{'project'}{'acronym'},
-         authorlist  => $meta->{'project'}{'authors'},
-         description => $meta->{'project'}{'short-description'},
-         license     => $meta->{'public-dap'}{'data-license'},
-         doi         => $meta->{'publication'}{'doi'},
+         acronym     => $meta->{'project'}{'identifier'}{'acronym'},
+         authorlist  => $meta->{'project'}{'creator'},
+         description => $meta->{'project'}{'description'},
+         license     => $meta->{'project'}{'rights'},
+         doi         => $  doi_first,
       }, \$msg_format) || die $tt->error;
 
@@ -385 +459 @@
  project-meta make-file-author
  project-meta make-file-copyright
+ project-meta upgrade
 
 
@@ -426 +501 @@
 =over
 
-=item * C<project/acronym>: the project short acronym, add to the OpeNDAP root folder
+=item * C<project/identifier/acronym>: the project short acronym, add to the OpeNDAP root folder
 
 =item * C<public-dap/dap-folder>: the OpeNDAP root folder
@@ -462 +537 @@
 =over
 
-=item * C<project/acronym>: the project short acronym, use as root folder
+=item * C<project/identifier/acronym>: the project short acronym, use as root folder
 
 =item * C<public-dap/data-set>: a list of files or folder to push
@@ -542 +617 @@
 Create or update the F<COPYRIGHT.txt> file at the current folder.
 Authors, license and copyright data are extracted from the C<PROJECT-META.yml> file.
+
+=head2 upgrade
+
+ project-meta upgrade
+
+Upgrade config file to last version.
+Create a file F<PROJECT-META-vVERSION.yml> in the current directory if it's not exists, error otherwise.
+Please maually verify this autogenerated config file before rename and using it.