moab-versioning 4.2.1 → 4.4.2

data/lib/moab/file_inventory_difference.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # Compares two {FileInventory} instances based primarily on file signatures and secondarily on file pathnames.
@@ -24,17 +24,17 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @group_differences = Array.new
+      @group_differences = []
       super(opts)
     end
 
     # @attribute
     # @return [String] The digital object ID (druid)
-    attribute :digital_object_id, String, :tag => 'objectId'
+    attribute :digital_object_id, String, tag: 'objectId'
 
     # @attribute
     # @return [Integer] the number of differences found between the two inventories that were compared (dynamically calculated)
-    attribute :difference_count, Integer, :tag => 'differenceCount', :on_save => Proc.new { |i| i.to_s }
+    attribute :difference_count, Integer, tag: 'differenceCount', on_save: proc { |i| i.to_s }
 
     def difference_count
       @group_differences.inject(0) { |sum, group| sum + group.difference_count }
@@ -50,7 +50,7 @@ module Moab
 
     # @attribute
     # @return [String] The datetime at which the report was run
-    attribute :report_datetime, String, :tag => 'reportDatetime'
+    attribute :report_datetime, String, tag: 'reportDatetime'
 
     def report_datetime=(datetime)
       @report_datetime = Moab::UtcTime.input(datetime)
@@ -62,11 +62,11 @@ module Moab
 
     # @attribute
     # @return [Array<FileGroupDifference>] The set of data groups comprising the version
-    has_many :group_differences, FileGroupDifference, :tag => 'fileGroupDifference'
+    has_many :group_differences, FileGroupDifference, tag: 'fileGroupDifference'
 
     # @return [Array<String>] The data fields to include in summary reports
     def summary_fields
-      %w{digital_object_id difference_count basis other report_datetime group_differences}
+      %w[digital_object_id difference_count basis other report_datetime group_differences]
     end
 
     # @param [String] group_id The identifer of the group to be selected
@@ -89,8 +89,8 @@ module Moab
       group_ids = basis_inventory.group_ids | other_inventory.group_ids
       group_ids.each do |group_id|
         # get a pair of groups to compare, creating a empty group if not present in the inventory
-        basis_group = basis_inventory.group(group_id) || FileGroup.new(:group_id => group_id)
-        other_group = other_inventory.group(group_id) || FileGroup.new(:group_id => group_id)
+        basis_group = basis_inventory.group(group_id) || FileGroup.new(group_id: group_id)
+        other_group = other_inventory.group(group_id) || FileGroup.new(group_id: group_id)
         @group_differences << FileGroupDifference.new.compare_file_groups(basis_group, other_group)
       end
       self
@@ -110,11 +110,11 @@ module Moab
     # @return [Hash] Serializes the data and then filters it to report only the changes
     def differences_detail
       #return self.summary if difference_count == 0
-      inv_diff = self.to_hash
+      inv_diff = to_hash
       inv_diff["group_differences"].each_value do |group_diff|
         delete_subsets = []
         group_diff["subsets"].each do |change_type, subset|
-          delete_subsets << change_type if change_type == "identical" or subset["count"] == 0
+          delete_subsets << change_type if (change_type == "identical") || (subset["count"] == 0)
         end
         delete_subsets.each do |change_type|
           group_diff["subsets"].delete(change_type)

data/lib/moab/file_manifestation.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # A container for a file signature and all the physical file instances that have that signature
@@ -24,13 +24,13 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @instances = Array.new
+      @instances = []
       super(opts)
     end
 
     # @attribute
     # @return [FileSignature] The fixity data of the file instance
-    element :signature, FileSignature, :tag => 'fileSignature'
+    element :signature, FileSignature, tag: 'fileSignature'
 
     def signature
       @signature.is_a?(Array) ? @signature[0] : @signature
@@ -42,12 +42,12 @@ module Moab
 
     # @attribute
     # @return [Array<FileInstance>] The location(s) of the file manifestation's file instances
-    has_many :instances, FileInstance, :tag => 'fileInstance'
+    has_many :instances, FileInstance, tag: 'fileInstance'
 
     # @api internal
     # @return [Array<String>] Create an array from all the file paths of the child {FileInstance} objects
     def paths
-      instances.collect { |i| i.path }
+      instances.collect(&:path)
     end
 
     # @api internal
@@ -76,8 +76,9 @@ module Moab
     # @param other [FileManifestation] The {FileManifestation} object to compare with self
     # @return [Boolean] True if {FileManifestation} objects have same content
     def ==(other)
-      return false unless (other.respond_to?(:signature) && other.respond_to?(:instances)) # Cannot equal an incomparable type!
-      (self.signature == other.signature) && (self.instances == other.instances)
+      return false unless other.respond_to?(:signature) && other.respond_to?(:instances) # Cannot equal an incomparable type!
+
+      (signature == other.signature) && (instances == other.instances)
     end
   end
 end

data/lib/moab/file_signature.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # The fixity properties of a file, used to determine file content equivalence regardless of filename.
@@ -46,19 +46,19 @@ module Moab
 
     # @attribute
     # @return [Integer] The size of the file in bytes
-    attribute :size, Integer, :on_save => Proc.new { |n| n.to_s }
+    attribute :size, Integer, on_save: proc { |n| n.to_s }
 
     # @attribute
     # @return [String] The MD5 checksum value of the file
-    attribute :md5, String, :on_save => Proc.new { |n| n.nil? ? "" : n.to_s }
+    attribute :md5, String, on_save: proc { |n| n.nil? ? "" : n.to_s }
 
     # @attribute
     # @return [String] The SHA1 checksum value of the file
-    attribute :sha1, String, :on_save => Proc.new { |n| n.nil? ? "" : n.to_s }
+    attribute :sha1, String, on_save: proc { |n| n.nil? ? "" : n.to_s }
 
     # @attribute
     # @return [String] The SHA256 checksum value of the file
-    attribute :sha256, String, :on_save => Proc.new { |n| n.nil? ? "" : n.to_s }
+    attribute :sha256, String, on_save: proc { |n| n.nil? ? "" : n.to_s }
 
     KNOWN_ALGOS = {
       md5: proc { Digest::MD5.new },
@@ -75,7 +75,7 @@ module Moab
     # @param [Array<Symbol>] one or more keys of KNOWN_ALGOS to be computed
     # @return [Moab::FileSignature] object populated with (requested) checksums
     def self.from_file(pathname, algos_to_use = active_algos)
-      raise 'Unrecognized algorithm requested' unless algos_to_use.all? { |a| KNOWN_ALGOS.include?(a) }
+      raise(MoabRuntimeError, 'Unrecognized algorithm requested') unless algos_to_use.all? { |a| KNOWN_ALGOS.include?(a) }
 
       signatures = algos_to_use.map { |k| [k, KNOWN_ALGOS[k].call] }.to_h
 
@@ -85,7 +85,7 @@ module Moab
         end
       end
 
-      new(signatures.map { |k, digest| [k, digest.hexdigest] }.to_h.merge(size: pathname.size))
+      new(signatures.transform_values(&:hexdigest).merge(size: pathname.size))
     end
 
     # @param type [Symbol,String] The type of checksum
@@ -106,12 +106,11 @@ module Moab
 
    # @return [Hash<Symbol,String>] A hash of the checksum data
     def checksums
-      checksum_hash = Hash.new
-      checksum_hash[:md5] = @md5
-      checksum_hash[:sha1] = @sha1
-      checksum_hash[:sha256] = @sha256
-      checksum_hash.delete_if { |_key, value| value.nil? or value.empty? }
-      checksum_hash
+      {
+        md5: md5,
+        sha1: sha1,
+        sha256: sha256
+      }.reject { |_key, value| value.nil? || value.empty? }
     end
 
     # @return [Boolean] The signature contains all of the 3 desired checksums
@@ -120,24 +119,23 @@ module Moab
     end
 
     # @api internal
-    # @return [Hash<Symbol,String>] A hash of fixity data from this signataure object
+    # @return [Hash<Symbol => String>] A hash of fixity data from this signataure object
     def fixity
-      fixity_hash = Hash.new
-      fixity_hash[:size] = @size.to_s
-      fixity_hash.merge!(checksums)
-      fixity_hash
+      { size: size.to_s }.merge(checksums)
     end
 
     # @api internal
     # @param other [FileSignature] The other file signature being compared to this signature
     # @return [Boolean] Returns true if self and other have comparable fixity data.
     def eql?(other)
-      return false unless (other.respond_to?(:size) && other.respond_to?(:checksums))
-      return false if self.size.to_i != other.size.to_i
-      self_checksums = self.checksums
+      return false unless other.respond_to?(:size) && other.respond_to?(:checksums)
+      return false if size.to_i != other.size.to_i
+
+      self_checksums = checksums
       other_checksums = other.checksums
       matching_keys = self_checksums.keys & other_checksums.keys
-      return false if matching_keys.size == 0
+      return false if matching_keys.empty?
+
       matching_keys.each do |key|
         return false if self_checksums[key] != other_checksums[key]
       end
@@ -181,31 +179,27 @@ module Moab
     # @return [FileSignature] The full signature derived from the file, unless the fixity is inconsistent with current values
     def normalized_signature(pathname)
       sig_from_file = FileSignature.new.signature_from_file(pathname)
-      if self.eql?(sig_from_file)
-        # The full signature from file is consistent with current values
-        return sig_from_file
-      else
-        # One or more of the fixity values is inconsistent, so raise an exception
-        raise "Signature inconsistent between inventory and file for #{pathname}: #{self.diff(sig_from_file).inspect}"
-      end
+      return sig_from_file if eql?(sig_from_file)
+
+      # The full signature from file is consistent with current values, or...
+      # One or more of the fixity values is inconsistent, so raise an exception
+      raise(MoabRuntimeError, "Signature inconsistent between inventory and file for #{pathname}: #{diff(sig_from_file).inspect}")
     end
 
     # @return [Hash<Symbol,String>] Key is type (e.g. :sha1), value is checksum names (e.g. ['SHA-1', 'SHA1'])
-    def FileSignature.checksum_names_for_type
-      names_for_type = Hash.new
-      names_for_type[:md5] = ['MD5']
-      names_for_type[:sha1] = ['SHA-1', 'SHA1']
-      names_for_type[:sha256] = ['SHA-256', 'SHA256']
-      names_for_type
+    def self.checksum_names_for_type
+      {
+        md5: ['MD5'],
+        sha1: %w[SHA-1 SHA1],
+        sha256: %w[SHA-256 SHA256]
+      }
     end
 
    # @return [Hash<String, Symbol>] Key is checksum name (e.g. MD5), value is checksum type (e.g. :md5)
-    def FileSignature.checksum_type_for_name
-      type_for_name = Hash.new
-      self.checksum_names_for_type.each do |type, names|
-        names.each do |name|
-          type_for_name[name] = type
-        end
+    def self.checksum_type_for_name
+      type_for_name = {}
+      checksum_names_for_type.each do |type, names|
+        names.each { |name| type_for_name[name] = type }
       end
       type_for_name
     end

data/lib/moab/signature_catalog.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # A digital object's Signature Catalog is derived from an filtered aggregation of the file inventories
@@ -32,27 +32,27 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @entries = Array.new
-      @signature_hash = Hash.new
+      @entries = []
+      @signature_hash = {}
       super(opts)
     end
 
     # @attribute
     # @return [String] The object ID (druid)
-    attribute :digital_object_id, String, :tag => 'objectId'
+    attribute :digital_object_id, String, tag: 'objectId'
 
     # @attribute
     # @return [Integer] The ordinal version number
-    attribute :version_id, Integer, :tag => 'versionId', :key => true, :on_save => Proc.new { |n| n.to_s }
+    attribute :version_id, Integer, tag: 'versionId', key: true, on_save: proc { |n| n.to_s }
 
     # @return [String] The unique identifier concatenating digital object id with version id
     def composite_key
-      @digital_object_id + '-' + StorageObject.version_dirname(@version_id)
+      "#{@digital_object_id}-#{StorageObject.version_dirname(@version_id)}"
     end
 
     # @attribute
     # @return [String] The datetime at which the catalog was updated
-    attribute :catalog_datetime, Time, :tag => 'catalogDatetime'
+    attribute :catalog_datetime, Time, tag: 'catalogDatetime'
 
     def catalog_datetime=(datetime)
       @catalog_datetime = Moab::UtcTime.input(datetime)
@@ -64,7 +64,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The total number of data files (dynamically calculated)
-    attribute :file_count, Integer, :tag => 'fileCount', :on_save => Proc.new { |t| t.to_s }
+    attribute :file_count, Integer, tag: 'fileCount', on_save: proc { |t| t.to_s }
 
     def file_count
       entries.size
@@ -72,7 +72,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 { |t| t.to_s }
+    attribute :byte_count, Integer, tag: 'byteCount', on_save: proc { |t| t.to_s }
 
     def byte_count
       entries.inject(0) { |sum, entry| sum + entry.signature.size.to_i }
@@ -80,7 +80,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 { |t| t.to_s }
+    attribute :block_count, Integer, tag: 'blockCount', on_save: proc { |t| t.to_s }
 
     def block_count
       block_size = 1024
@@ -89,12 +89,12 @@ module Moab
 
     # @return [Array<String>] The data fields to include in summary reports
     def summary_fields
-      %w{digital_object_id version_id catalog_datetime file_count byte_count block_count}
+      %w[digital_object_id version_id catalog_datetime file_count byte_count block_count]
     end
 
     # @attribute
     # @return [Array<SignatureCatalogEntry>] The set of data groups comprising the version
-    has_many :entries, SignatureCatalogEntry, :tag => 'entry'
+    has_many :entries, SignatureCatalogEntry, tag: 'entry'
 
     def entries=(entry_array)
       entry_array.each do |entry|
@@ -130,11 +130,11 @@ module Moab
     def normalize_group_signatures(group, group_pathname = nil)
       unless group_pathname.nil?
         group_pathname = Pathname(group_pathname)
-        raise "Could not locate #{group_pathname}" unless group_pathname.exist?
+        raise(MoabRuntimeError, "Could not locate #{group_pathname}") unless group_pathname.exist?
       end
       group.files.each do |file|
         unless file.signature.complete?
-          if @signature_hash.has_key?(file.signature)
+          if @signature_hash.key?(file.signature)
             file.signature = @signature_hash.find { |k, _v| k == file.signature }[0]
           elsif group_pathname
             file_pathname = group_pathname.join(file.instances[0].path)
@@ -153,7 +153,7 @@ module Moab
     def update(version_inventory, data_pathname)
       version_inventory.groups.each do |group|
         group.files.each do |file|
-          unless @signature_hash.has_key?(file.signature)
+          unless @signature_hash.key?(file.signature)
             entry = SignatureCatalogEntry.new
             entry.version_id = version_inventory.version_id
             entry.group_id = group.group_id
@@ -178,16 +178,14 @@ module Moab
     #   containing only those files that were added in this version
     # @example {include:file:spec/features/catalog/version_additions_spec.rb}
     def version_additions(version_inventory)
-      version_additions = FileInventory.new(:type => 'additions')
+      version_additions = FileInventory.new(type: 'additions')
       version_additions.copy_ids(version_inventory)
       version_inventory.groups.each do |group|
-        group_addtions = FileGroup.new(:group_id => group.group_id)
+        group_addtions = FileGroup.new(group_id: group.group_id)
         group.files.each do |file|
-          unless @signature_hash.has_key?(file.signature)
-            group_addtions.add_file_instance(file.signature, file.instances[0])
-          end
+          group_addtions.add_file_instance(file.signature, file.instances[0]) unless @signature_hash.key?(file.signature)
         end
-        version_additions.groups << group_addtions if group_addtions.files.size > 0
+        version_additions.groups << group_addtions unless group_addtions.files.empty?
       end
       version_additions
     end

data/lib/moab/signature_catalog_entry.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # A file-level entry in a digital object's {SignatureCatalog}.
@@ -25,19 +25,19 @@ module Moab
 
     # @attribute
     # @return [Integer] The ordinal version number
-    attribute :version_id, Integer, :tag => 'originalVersion', :key => true, :on_save => Proc.new { |n| n.to_s }
+    attribute :version_id, Integer, tag: 'originalVersion', key: true, on_save: proc { |n| n.to_s }
 
     # @attribute
     # @return [String] The name of the file group
-    attribute :group_id, String, :tag => 'groupId', :key => true
+    attribute :group_id, String, tag: 'groupId', key: true
 
     # @attribute
     # @return [String] The id is the filename path, relative to the file group's base directory
-    attribute :path, String, :key => true, :tag => 'storagePath'
+    attribute :path, String, key: true, tag: 'storagePath'
 
     # @attribute
     # @return [FileSignature] The fixity data of the file instance
-    element :signature, FileSignature, :tag => 'fileSignature'
+    element :signature, FileSignature, tag: 'fileSignature'
 
     def signature
       # HappyMapper's parser tries to put an array of signatures in the signature field

data/lib/moab/stanford.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'moab'
 require 'stanford/content_inventory'
 require 'stanford/dor_metadata'

data/lib/moab/storage_object.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # A class to represent a digital object's repository storage location
@@ -84,10 +84,10 @@ module Moab
     # @return [FileInventory] The file inventory of the specified type for this version
     def versionize_bag(bag_dir, current_version, new_version)
       new_inventory = FileInventory.new(
-        :type => 'version',
-        :digital_object_id => @digital_object_id,
-        :version_id => new_version.version_id,
-        :inventory_datetime => Time.now
+        type: 'version',
+        digital_object_id: @digital_object_id,
+        version_id: new_version.version_id,
+        inventory_datetime: Time.now
       )
       new_inventory.inventory_from_bagit_bag(bag_dir)
       new_inventory.write_xml_file(bag_dir)
@@ -115,6 +115,7 @@ module Moab
       storage_filepath = @object_pathname.join(catalog_filepath)
       errmsg = "#{catalog_filepath} missing from storage location #{storage_filepath}"
       raise FileNotFoundException, errmsg unless storage_filepath.exist?
+
       storage_filepath
     end
 
@@ -122,27 +123,26 @@ module Moab
     # @param version_id [Integer] The version identifier of an object version
     # @return [String] The directory name of the version, relative to the digital object home directory (e.g v0002)
     def self.version_dirname(version_id)
-      ("v%04d" % version_id)
+      format("v%04d", version_id)
     end
 
     # @return [Array<Integer>] The list of all version ids for this object
     def version_id_list
-      list = Array.new
+      list = []
       return list unless @object_pathname.exist?
+
       @object_pathname.children.each do |dirname|
         vnum = dirname.basename.to_s
-        if vnum =~ /^v(\d+)$/
-          list << vnum[1..-1].to_i
-        end
+        list << vnum[1..].to_i if vnum =~ /^v(\d+)$/
       end
       list.sort
     end
 
     # @return [Array<StorageObjectVersion>] The list of all versions in this storage object
     def version_list
-      version_id_list.collect { |id| self.storage_object_version(id) }
+      version_id_list.collect { |id| storage_object_version(id) }
     end
-    alias :versions :version_list
+    alias versions version_list
 
     # @return [Boolean] true if there are no versions yet in this object
     def empty?
@@ -152,12 +152,12 @@ module Moab
     # @api external
     # @return [Integer] The identifier of the latest version of this object, or 0 if no versions exist
     def current_version_id
-      @current_version_id ||= self.version_id_list.last || 0
+      @current_version_id ||= version_id_list.last || 0
     end
 
     # @return [StorageObjectVersion] The most recent version in the storage object
     def current_version
-      self.storage_object_version(current_version_id)
+      storage_object_version(current_version_id)
     end
 
     # @api internal
@@ -165,8 +165,9 @@ module Moab
     # @return [Boolean] Tests whether the new version number is one higher than the current version number
     def validate_new_inventory(version_inventory)
       if version_inventory.version_id != (current_version_id + 1)
-        raise "version mismatch - current: #{current_version_id} new: #{version_inventory.version_id}"
+        raise(MoabRuntimeError, "version mismatch - current: #{current_version_id} new: #{version_inventory.version_id}")
       end
+
       true
     end
 
@@ -181,7 +182,7 @@ module Moab
       when 1..current
         StorageObjectVersion.new(self, version_id)
       else
-        raise "Version ID #{version_id} does not exist"
+        raise(MoabRuntimeError, "Version ID #{version_id} does not exist")
       end
     end
 
@@ -191,21 +192,19 @@ module Moab
     # * Version 0 is a special case used to generate empty manifests
     # * Current version + 1 is used for creation of a new version
     def storage_object_version(version_id)
-      if version_id
-        StorageObjectVersion.new(self, version_id)
-      else
-        raise "Version ID not specified"
-      end
+      raise(MoabRuntimeError, "Version ID not specified") unless version_id
+
+      StorageObjectVersion.new(self, version_id)
     end
 
     # @return [VerificationResult] Return result of storage verification
     def verify_object_storage
       result = VerificationResult.new(digital_object_id)
-      self.version_list.each do |version|
+      version_list.each do |version|
         result.subentities << version.verify_version_storage
       end
       result.subentities << current_version.verify_signature_catalog
-      result.verified = result.subentities.all? { |entity| entity.verified }
+      result.verified = result.subentities.all?(&:verified)
       result
     end
 
@@ -216,7 +215,7 @@ module Moab
       recovery_object = StorageObject.new(@digital_object_id, recovery_path, false)
       recovery_object.versions.each do |recovery_version|
         version_id = recovery_version.version_id
-        storage_version = self.storage_object_version(version_id)
+        storage_version = storage_object_version(version_id)
         # rename/save the original
         storage_version.deactivate(timestamp)
         # copy the recovered version into place