moab-versioning 4.2.0 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c13dd09bef589a3c4a3314737c2d3b6dfb4589f
-  data.tar.gz: 629913d22d1ba0b40f62671aabc7cca01767c276
+  metadata.gz: 8226ecfe5e815a81aa72bc564fc1abc341b4f570
+  data.tar.gz: 9d085cad25bc601caec626edb5cf4f778a979fc3
 SHA512:
-  metadata.gz: fe0076d5a2e868613c4e5f081abdee5fd93e76effccfdf4219d7849d8f9944cc11ff728b407ffac22a0d02b9a71c30a75e2077c3f11698bb815e336b951f33b4
-  data.tar.gz: 6c3e42f3cf596cd16e2d62858da725e93fcf37ab835bfcc4f9a3951eb4bbd569845210f9dfa40f39048bab235162fe2d169494a5469a31229924ad29dbea01db
+  metadata.gz: 6c0072f1cd34f7bd192a4231b6c496e81d4ce380edaf08cd5fb997b240ad64b09c8ce94ed4083a65f812c11971b1e11eadf2d8099edb898226d904a8e58c3d17
+  data.tar.gz: 71aa7a0ff75185089d2a7705a13635b67b0fbaa600b438a35fde7f75a4bd83061f050b1c4eeef98162e38b64a66e6c23e3f45748bde93b5de42acaee32fadf9e

data/lib/moab/bagger.rb

@@ -1,5 +1,4 @@
 module Moab
-
   # A class used to create a BagIt package from a version inventory and a set of source files.
   # The {#fill_bag} method is called with a package_mode parameter that specifies
   # whether the bag is being created for deposit into the repository or is to contain the output of a version reconstruction.
@@ -18,7 +17,6 @@ module Moab
   # @note Copyright (c) 2012 by The Board of Trustees of the Leland Stanford Junior University.
   #   All rights reserved.  See {file:LICENSE.rdoc} for details.
   class Bagger
-
     # @param version_inventory [FileInventory] The complete inventory of the files comprising a digital object version
     # @param signature_catalog [SignatureCatalog] The signature catalog, used to specify source paths (in :reconstructor mode),
     #   or to filter the version inventory (in :depositor mode)
@@ -71,7 +69,7 @@ module Moab
         if bag_pathname.join('data').exist?
           bag_pathname.rmtree
         else
-          bag_pathname.children.each {|file| file.delete}
+          bag_pathname.children.each { |file| file.delete }
           bag_pathname.rmdir
         end
       end
@@ -108,13 +106,13 @@ module Moab
       @package_mode = package_mode
       bag_pathname.mkpath
       case package_mode
-        when :depositor
-          version_inventory.write_xml_file(bag_pathname, 'version')
-          @bag_inventory = signature_catalog.version_additions(version_inventory)
-          bag_inventory.write_xml_file(bag_pathname, 'additions')
-        when :reconstructor
-          @bag_inventory = version_inventory
-          bag_inventory.write_xml_file(bag_pathname, 'version')
+      when :depositor
+        version_inventory.write_xml_file(bag_pathname, 'version')
+        @bag_inventory = signature_catalog.version_additions(version_inventory)
+        bag_inventory.write_xml_file(bag_pathname, 'additions')
+      when :reconstructor
+        @bag_inventory = version_inventory
+        bag_inventory.write_xml_file(bag_pathname, 'version')
       end
       bag_inventory
     end
@@ -128,10 +126,10 @@ module Moab
       bag_inventory.groups.each do |group|
         group_id = group.group_id
         case package_mode
-          when :depositor
-            deposit_group(group_id, source_base_pathname.join(group_id))
-          when :reconstructor
-            reconstuct_group(group_id, source_base_pathname)
+        when :depositor
+          deposit_group(group_id, source_base_pathname.join(group_id))
+        when :reconstructor
+          reconstuct_group(group_id, source_base_pathname)
         end
       end
     end
@@ -143,7 +141,7 @@ module Moab
     def deposit_group(group_id, source_dir)
       group = bag_inventory.group(group_id)
       return nil? if group.nil? or group.files.empty?
-      target_dir = bag_pathname.join('data',group_id)
+      target_dir = bag_pathname.join('data', group_id)
       group.path_list.each do |relative_path|
         source = source_dir.join(relative_path)
         target = target_dir.join(relative_path)
@@ -160,7 +158,7 @@ module Moab
     def reconstuct_group(group_id, storage_object_dir)
       group = bag_inventory.group(group_id)
       return nil? if group.nil? or group.files.empty?
-      target_dir = bag_pathname.join('data',group_id)
+      target_dir = bag_pathname.join('data', group_id)
       group.files.each do |file|
         catalog_entry = signature_catalog.signature_hash[file.signature]
         source = storage_object_dir.join(catalog_entry.storage_path)
@@ -251,15 +249,15 @@ module Moab
     end
 
     # @return [Boolean] Create a tar file containing the bag
-    def create_tarfile(tar_pathname=nil)
+    def create_tarfile(tar_pathname = nil)
       bag_name = bag_pathname.basename
       bag_parent = bag_pathname.parent
       tar_pathname ||= bag_parent.join("#{bag_name}.tar")
-      tar_cmd="cd '#{bag_parent}'; tar --dereference --force-local -cf  '#{tar_pathname}' '#{bag_name}'"
+      tar_cmd = "cd '#{bag_parent}'; tar --dereference --force-local -cf  '#{tar_pathname}' '#{bag_name}'"
       begin
         shell_execute(tar_cmd)
       rescue
-        shell_execute(tar_cmd.sub('--force-local',''))
+        shell_execute(tar_cmd.sub('--force-local', ''))
       end
       raise "Unable to create tarfile #{tar_pathname}" unless tar_pathname.exist?
       return true

data/lib/moab/config.rb

@@ -1,13 +1,12 @@
 require 'moab'
 
 module Moab
-
   # @return [Confstruct::Configuration] the configuration data
   Config = Confstruct::Configuration.new do
-      storage_roots nil
-      storage_trunk nil
-      deposit_trunk nil
-      path_method :druid_tree
+    storage_roots nil
+    storage_trunk nil
+    deposit_trunk nil
+    path_method :druid_tree
+    checksum_algos [:md5, :sha1, :sha256]
   end
-
 end

data/lib/moab/deposit_bag_validator.rb

@@ -1,5 +1,4 @@
 module Moab
-
   # Given a deposit bag, ensures the contents valid for becoming a StorageObjectVersion
   # this is a Shameless Green implementation, combining code from:
   #  - sdr-preservation-core/lib/sdr_ingest/validate_bag  <-- old preservation robots
@@ -11,7 +10,6 @@ module Moab
   #  - deposit_bag_validator
   #  - file_signature
   class DepositBagValidator
-
     BAG_DIR_NOT_FOUND = :bag_dir_not_found
     CHECKSUM_MISMATCH = :checksum_mismatch
     CHECKSUM_TYPE_UNRECOGNIZED = :checksum_type_unrecognized
@@ -85,7 +83,7 @@ module Moab
         pathname = deposit_bag_pathname.join(filename)
         result_array << single_error_hash(REQUIRED_FILE_NOT_FOUND, file_pathname: pathname) unless pathname.exist?
       end
-      result_array.empty? ? true : false
+      result_array.empty?
     end
 
     def verify_version
@@ -221,7 +219,7 @@ module Moab
       file_checksums
     end
 
-    def digester_hash(types_to_generate=DEFAULT_CHECKSUM_TYPES)
+    def digester_hash(types_to_generate = DEFAULT_CHECKSUM_TYPES)
       types_to_generate.each_with_object({}) do |checksum_type, digester_hash|
         case checksum_type
         when :md5

data/lib/moab/exceptions.rb

@@ -1,18 +1,13 @@
 module Moab
   class ObjectNotFoundException < RuntimeError
-
   end
 
   class FileNotFoundException < RuntimeError
-
   end
 
   class InvalidMetadataException < RuntimeError
-
   end
 
   class ValidationException < RuntimeError
-
   end
-
 end

data/lib/moab/file_group.rb

@@ -1,7 +1,6 @@
 require 'moab'
 
 module Moab
-
   # A container for a standard subset of a digital objects {FileManifestation} objects
   # Used to segregate depositor content from repository metadata files
   # This is a child element of {FileInventory}, which contains a full example
@@ -16,14 +15,13 @@ module Moab
   # @note Copyright (c) 2012 by The Board of Trustees of the Leland Stanford Junior University.
   #   All rights reserved.  See {file:LICENSE.rdoc} for details.
   class FileGroup < Serializer::Serializable
-
     include HappyMapper
 
     # The name of the XML element used to serialize this objects data
     tag 'fileGroup'
 
     # (see Serializable#initialize)
-    def initialize(opts={})
+    def initialize(opts = {})
       @signature_hash = Hash.new
       @data_source = ""
       super(opts)
@@ -39,7 +37,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The total number of data files (dynamically calculated)
-    attribute :file_count, Integer, :tag => 'fileCount', :on_save => Proc.new {|i| i.to_s}
+    attribute :file_count, Integer, :tag => 'fileCount', :on_save => Proc.new { |i| i.to_s }
 
     def file_count
       files.inject(0) { |sum, manifestation| sum + manifestation.file_count }
@@ -47,7 +45,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The total size (in bytes) of all data files (dynamically calculated)
-    attribute :byte_count, Integer, :tag => 'byteCount', :on_save => Proc.new {|i| i.to_s}
+    attribute :byte_count, Integer, :tag => 'byteCount', :on_save => Proc.new { |i| i.to_s }
 
     def byte_count
       files.inject(0) { |sum, manifestation| sum + manifestation.byte_count }
@@ -55,7 +53,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The total disk usage (in 1 kB blocks) of all data files (estimating du -k result) (dynamically calculated)
-    attribute :block_count, Integer, :tag => 'blockCount', :on_save => Proc.new {|i| i.to_s}
+    attribute :block_count, Integer, :tag => 'blockCount', :on_save => Proc.new { |i| i.to_s }
 
     def block_count
       files.inject(0) { |sum, manifestation| sum + manifestation.block_count }
@@ -83,7 +81,7 @@ module Moab
     #   used to test for existence of a filename in this file group
     def path_hash
       path_hash = Hash.new
-      signature_hash.each do |signature,manifestation|
+      signature_hash.each do |signature, manifestation|
         manifestation.instances.each do |instance|
           path_hash[instance.path] = signature
         end
@@ -93,7 +91,7 @@ module Moab
 
     # @return [Array<String>] The list of file paths in this group
     def path_list
-      files.collect{|file| file.instances.collect{|instance| instance.path}}.flatten
+      files.collect { |file| file.instances.collect { |instance| instance.path } }.flatten
     end
 
     # @api internal
@@ -116,7 +114,7 @@ module Moab
     def files=(manifestiation_array)
       manifestiation_array.each do |manifestiation|
         add_file(manifestiation)
-     end
+      end
     end
 
     # @api internal
@@ -133,7 +131,7 @@ module Moab
     # @param instance [FileInstance] The pathname and datetime of the file instance to be added
     # @return [void] Add a single {FileSignature},{FileInstance} key/value pair to this group.
     #   Data is actually stored in the {#signature_hash}
-    def add_file_instance(signature,instance)
+    def add_file_instance(signature, instance)
       if signature_hash.has_key?(signature)
         manifestation = signature_hash[signature]
       else
@@ -165,7 +163,7 @@ module Moab
     def is_descendent_of_base?(pathname)
       raise("base_directory has not been set") if @base_directory.nil?
       is_descendent = false
-      pathname.expand_path.ascend {|ancestor| is_descendent ||= (ancestor == @base_directory)}
+      pathname.expand_path.ascend { |ancestor| is_descendent ||= (ancestor == @base_directory) }
       raise("#{pathname} is not a descendent of #{@base_directory}") unless is_descendent
       is_descendent
     end
@@ -174,7 +172,7 @@ module Moab
     # @param signatures_from_bag [Hash<Pathname,Signature>] The fixity data already calculated for the files
     # @param recursive [Boolean] if true, descend into child directories
     # @return [FileGroup] Harvest a directory (using digest hash for fixity data) and add all files to the file group
-    def group_from_bagit_subdir(directory, signatures_from_bag, recursive=true)
+    def group_from_bagit_subdir(directory, signatures_from_bag, recursive = true)
       @signatures_from_bag = signatures_from_bag
       group_from_directory(directory, recursive)
     end
@@ -183,7 +181,7 @@ module Moab
     # @param directory [Pathname,String] The location of the files to harvest
     # @param recursive [Boolean] if true, descend into child directories
     # @return [FileGroup] Harvest a directory and add all files to the file group
-    def group_from_directory(directory, recursive=true)
+    def group_from_directory(directory, recursive = true)
       self.base_directory = directory
       @data_source = @base_directory.to_s
       harvest_directory(directory, recursive)
@@ -201,7 +199,7 @@ module Moab
     #   Note that unlike Find.find and Dir.glob, Pathname passes through symbolic links
     # @see http://stackoverflow.com/questions/3974087/how-to-make-rubys-find-find-follow-symlinks
     # @see http://stackoverflow.com/questions/357754/can-i-traverse-symlinked-directories-in-ruby-with-a-glob
-    def harvest_directory(path, recursive, validated=nil)
+    def harvest_directory(path, recursive, validated = nil)
       pathname = Pathname.new(path).expand_path
       validated ||= is_descendent_of_base?(pathname)
       pathname.children.sort.each do |child|
@@ -221,7 +219,7 @@ module Moab
     # @param _validated (unused; kept here for backwards compatibility)
     # @return [void] Add a single physical file's data to the array of files in this group.
     #   If fixity data was supplied in bag manifests, then utilize that data.
-    def add_physical_file(pathname, _validated=nil)
+    def add_physical_file(pathname, _validated = nil)
       pathname = Pathname.new(pathname).expand_path
       instance = FileInstance.new.instance_from_file(pathname, @base_directory)
       if @signatures_from_bag && @signatures_from_bag[pathname]
@@ -234,7 +232,5 @@ module Moab
       end
       add_file_instance(signature, instance)
     end
-
   end
-
 end

data/lib/moab/file_group_difference.rb

@@ -1,7 +1,6 @@
 require 'moab'
 
 module Moab
-
   # Performs analysis and reports the differences between two matching {FileGroup} objects.
   # The descending elements of the report hold a detailed breakdown of file-level differences, organized by change type.
   # This stanza is a child element of {FileInventoryDifference}, the documentation of which contains a full example.
@@ -53,8 +52,8 @@ module Moab
     end
 
     # (see Serializable#initialize)
-    def initialize(opts={})
-      @subset_hash = Hash.new {|hash, key| hash[key] = FileGroupDifferenceSubset.new(:change => key.to_s)}
+    def initialize(opts = {})
+      @subset_hash = Hash.new { |hash, key| hash[key] = FileGroupDifferenceSubset.new(:change => key.to_s) }
       super(opts)
     end
 
@@ -135,7 +134,7 @@ module Moab
 
     def subsets=(array)
       if array
-        array.each{|subset| subset_hash[subset.change.to_sym] = subset}
+        array.each { |subset| subset_hash[subset.change.to_sym] = subset }
       end
     end
 
@@ -144,19 +143,18 @@ module Moab
       %w{group_id difference_count identical copyadded copydeleted renamed modified deleted added}
     end
 
-
     # @api internal
     # @return [FileGroupDifference] Clone just this element for inclusion in a versionMetadata structure
     def summary()
       FileGroupDifference.new(
-          :group_id => group_id,
-          :identical => identical,
-          :copyadded => copyadded,
-          :copydeleted => copydeleted,
-          :renamed => renamed,
-          :modified => modified,
-          :added => added,
-          :deleted => deleted
+        :group_id => group_id,
+        :identical => identical,
+        :copyadded => copyadded,
+        :copydeleted => copydeleted,
+        :renamed => renamed,
+        :modified => modified,
+        :added => added,
+        :deleted => deleted
       )
     end
 
@@ -258,7 +256,7 @@ module Moab
         basis_only_paths = basis_paths - other_paths
         other_only_paths = other_paths - basis_paths
         maxsize = [basis_only_paths.size, other_only_paths.size].max
-        (0..maxsize-1).each do |n|
+        (0..maxsize - 1).each do |n|
           fid = FileInstanceDifference.new()
           fid.basis_path = basis_only_paths[n]
           fid.other_path = other_only_paths[n]
@@ -335,10 +333,10 @@ module Moab
     # @return [Hash<Symbol,Array>] Sets of filenames grouped by change type for use in performing file or metadata operations
     def file_deltas()
       # The hash to be returned
-      deltas = Hash.new {|hash, key| hash[key] = []}
+      deltas = Hash.new { |hash, key| hash[key] = [] }
       # case where other_path is empty or 'same'.  (create array of strings)
       [:identical, :modified, :deleted, :copydeleted].each do |change|
-        deltas[change].concat(subset_hash[change].files.collect{ |file| file.basis_path })
+        deltas[change].concat(subset_hash[change].files.collect { |file| file.basis_path })
       end
       # case where basis_path and other_path are both present.  (create array of arrays)
       [:copyadded, :renamed].each do |change|
@@ -372,9 +370,7 @@ module Moab
     # @param [Array<Array<String>>] filepairs The set of oldname, newname pairs for all files being renamed
     # @return [Array<Array<String>>] a set of file triples containing oldname, tempname, newname
     def rename_tempfile_triplets(filepairs)
-      filepairs.collect{ |old, new| [old, new, "#{new}-#{Time.now.strftime('%Y%m%d%H%H%S')}-tmp"] }
+      filepairs.collect { |old, new| [old, new, "#{new}-#{Time.now.strftime('%Y%m%d%H%H%S')}-tmp"] }
     end
-
   end
-
 end

data/lib/moab/file_group_difference_subset.rb

@@ -1,7 +1,6 @@
 require 'moab'
 
 module Moab
-
   # A container for reporting a set of file-level differences of the type specified by the change attribute
   #
   # ====Data Model
@@ -20,7 +19,7 @@ module Moab
     tag 'subset'
 
     # (see Serializable#initialize)
-    def initialize(opts={})
+    def initialize(opts = {})
       @files = Array.new
       super(opts)
     end
@@ -39,7 +38,6 @@ module Moab
 
     # @attribute
     # @return [Array<FileInstanceDifference>] The set of file instances having this type of change
-    has_many :files, FileInstanceDifference, :tag=>'file'
-
+    has_many :files, FileInstanceDifference, :tag => 'file'
   end
 end

data/lib/moab/file_instance.rb

@@ -1,7 +1,6 @@
 require 'moab'
 
 module Moab
-
   # The file path and last modification date properties of a file
   #
   # ====Data Model
@@ -14,14 +13,13 @@ module Moab
   # @note Copyright (c) 2012 by The Board of Trustees of the Leland Stanford Junior University.
   #   All rights reserved.  See {file:LICENSE.rdoc} for details.
   class FileInstance < Serializer::Serializable
-
     include HappyMapper
 
     # The name of the XML element used to serialize this objects data
     tag 'fileInstance'
 
     # (see Serializable#initialize)
-    def initialize(opts={})
+    def initialize(opts = {})
       super(opts)
     end
 
@@ -34,14 +32,13 @@ module Moab
     attribute :datetime, String
 
     def datetime=(event_datetime)
-      @datetime=Moab::UtcTime.input(event_datetime)
+      @datetime = Moab::UtcTime.input(event_datetime)
     end
 
     def datetime
       Moab::UtcTime.output(@datetime)
     end
 
-
     # @api internal
     # @param pathname [Pathname] The location of the physical file
     # @param base_directory [Pathname] The full path used as the basis of the relative paths reported
@@ -56,7 +53,7 @@ module Moab
     # @param other [FileInstance] The other file instance being compared to this instance
     # @return [Boolean] Returns true if self and other have the same path.
     def eql?(other)
-      return false unless other.respond_to?(:path)  # Cannot equal an incomparable type!
+      return false unless other.respond_to?(:path) # Cannot equal an incomparable type!
       self.path == other.path
     end
 
@@ -77,7 +74,5 @@ module Moab
     def hash
       path.hash
     end
-
   end
-
 end