moab-versioning 4.2.1 → 4.4.2

data/lib/moab/file_group_difference.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # Performs analysis and reports the differences between two matching {FileGroup} objects.
@@ -53,18 +53,18 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @subset_hash = Hash.new { |hash, key| hash[key] = FileGroupDifferenceSubset.new(:change => key.to_s) }
+      @subset_hash = Hash.new { |hash, key| hash[key] = FileGroupDifferenceSubset.new(change: key.to_s) }
       super(opts)
     end
 
     # @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 [Integer] the total 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
       count = 0
@@ -76,49 +76,49 @@ module Moab
 
     # @attribute
     # @return [Integer] How many files were unchanged
-    attribute :identical, Integer, :on_save => Proc.new { |n| n.to_s }
+    attribute :identical, Integer, on_save: proc { |n| n.to_s }
     def identical
       subset_hash[:identical].count
     end
 
     # @attribute
     # @return [Integer] How many duplicate copies of files were added
-    attribute :copyadded, Integer, :on_save => Proc.new { |n| n.to_s }
+    attribute :copyadded, Integer, on_save: proc { |n| n.to_s }
     def copyadded
       subset_hash[:copyadded].count
     end
 
     # @attribute
     # @return [Integer] How many duplicate copies of files were deleted
-    attribute :copydeleted, Integer, :on_save => Proc.new { |n| n.to_s }
+    attribute :copydeleted, Integer, on_save: proc { |n| n.to_s }
     def copydeleted
       subset_hash[:copydeleted].count
     end
 
     # @attribute
     # @return [Integer] How many files were renamed
-    attribute :renamed, Integer, :on_save => Proc.new { |n| n.to_s }
+    attribute :renamed, Integer, on_save: proc { |n| n.to_s }
     def renamed
       subset_hash[:renamed].count
     end
 
     # @attribute
     # @return [Integer] How many files were modified
-    attribute :modified, Integer, :on_save => Proc.new { |n| n.to_s }
+    attribute :modified, Integer, on_save: proc { |n| n.to_s }
     def modified
       subset_hash[:modified].count
     end
 
     # @attribute
     # @return [Integer] How many files were added
-    attribute :added, Integer, :on_save => Proc.new { |n| n.to_s }
+    attribute :added, Integer, on_save: proc { |n| n.to_s }
     def added
       subset_hash[:added].count
     end
 
     # @attribute
     # @return [Integer] How many files were deleted
-    attribute :deleted, Integer, :on_save => Proc.new { |n| n.to_s }
+    attribute :deleted, Integer, on_save: proc { |n| n.to_s }
     def deleted
       subset_hash[:deleted].count
     end
@@ -126,35 +126,35 @@ module Moab
     # @attribute
     # @return [Array<FileGroupDifferenceSubset>] A set of Arrays (one for each change type),
     #    each of which contains an collection of file-level differences having that change type.
-    has_many :subsets, FileGroupDifferenceSubset, :tag => 'subset'
+    has_many :subsets, FileGroupDifferenceSubset, tag: 'subset'
 
     def subsets
       subset_hash.values
     end
 
     def subsets=(array)
-      if array
-        array.each { |subset| subset_hash[subset.change.to_sym] = subset }
-      end
+      return unless array
+
+      array.each { |subset| subset_hash[subset.change.to_sym] = subset }
     end
 
     # @return [Array<String>] The data fields to include in summary reports
     def summary_fields
-      %w{group_id difference_count identical copyadded copydeleted renamed modified deleted added}
+      %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()
+    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
 
@@ -231,7 +231,7 @@ module Moab
         other_paths = other_signature_hash[signature].paths
         matching_paths = basis_paths & other_paths
         matching_paths.each do |path|
-          fid = FileInstanceDifference.new(:change => 'identical')
+          fid = FileInstanceDifference.new(change: 'identical')
           fid.basis_path = path
           fid.other_path = "same"
           fid.signatures << signature
@@ -257,7 +257,7 @@ module Moab
         other_only_paths = other_paths - basis_paths
         maxsize = [basis_only_paths.size, other_only_paths.size].max
         (0..maxsize - 1).each do |n|
-          fid = FileInstanceDifference.new()
+          fid = FileInstanceDifference.new
           fid.basis_path = basis_only_paths[n]
           fid.other_path = other_only_paths[n]
           fid.signatures << signature
@@ -284,7 +284,7 @@ module Moab
     #   Container for reporting the set of file-level differences of type 'modified'
     def tabulate_modified_files(basis_path_hash, other_path_hash)
       matching_keys(basis_path_hash, other_path_hash).each do |path|
-        fid = FileInstanceDifference.new(:change => 'modified')
+        fid = FileInstanceDifference.new(change: 'modified')
         fid.basis_path = path
         fid.other_path = "same"
         fid.signatures << basis_path_hash[path]
@@ -303,7 +303,7 @@ module Moab
     #   Container for reporting the set of file-level differences of type 'added'
     def tabulate_added_files(basis_path_hash, other_path_hash)
       other_only_keys(basis_path_hash, other_path_hash).each do |path|
-        fid = FileInstanceDifference.new(:change => 'added')
+        fid = FileInstanceDifference.new(change: 'added')
         fid.basis_path = ""
         fid.other_path = path
         fid.signatures << other_path_hash[path]
@@ -321,7 +321,7 @@ module Moab
     #   Container for reporting the set of file-level differences of type 'deleted'
     def tabulate_deleted_files(basis_path_hash, other_path_hash)
       basis_only_keys(basis_path_hash, other_path_hash).each do |path|
-        fid = FileInstanceDifference.new(:change => 'deleted')
+        fid = FileInstanceDifference.new(change: 'deleted')
         fid.basis_path = path
         fid.other_path = ""
         fid.signatures << basis_path_hash[path]
@@ -331,20 +331,20 @@ module Moab
     end
 
     # @return [Hash<Symbol,Array>] Sets of filenames grouped by change type for use in performing file or metadata operations
-    def file_deltas()
+    def file_deltas
       # The hash to be returned
       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 })
+      %i[identical modified deleted copydeleted].each do |change|
+        deltas[change].concat(subset_hash[change].files.collect(&:basis_path))
       end
       # case where basis_path and other_path are both present.  (create array of arrays)
-      [:copyadded, :renamed].each do |change|
+      %i[copyadded renamed].each do |change|
         deltas[change].concat(subset_hash[change].files.collect { |file| [file.basis_path, file.other_path] })
       end
       # case where basis_path is empty.  (create array of strings)
       [:added].each do |change|
-        deltas[change].concat(subset_hash[change].files.collect { |file| file.other_path })
+        deltas[change].concat(subset_hash[change].files.collect(&:other_path))
       end
       deltas
     end

data/lib/moab/file_group_difference_subset.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # A container for reporting a set of file-level differences of the type specified by the change attribute
@@ -20,17 +20,17 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @files = Array.new
+      @files = []
       super(opts)
     end
 
     # @attribute
     # @return [String] The type of change (identical|renamed|modified|deleted|added)
-    attribute :change, String, :key => true
+    attribute :change, String, key: true
 
     # @attribute
     # @return [Integer] How many files were changed
-    attribute :count, Integer, :on_save => Proc.new { |n| n.to_s }
+    attribute :count, Integer, on_save: proc { |n| n.to_s }
 
     def count
       files.size
@@ -38,6 +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,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # The file path and last modification date properties of a file
@@ -25,7 +25,7 @@ module Moab
 
     # @attribute
     # @return [String] The id is the filename path, relative to the file group's base directory
-    attribute :path, String, :key => true
+    attribute :path, String, key: true
 
     # @attribute
     # @return [String] gsub(/\n/,' ')
@@ -54,7 +54,8 @@ module Moab
     # @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!
-      self.path == other.path
+
+      path == other.path
     end
 
     # @api internal

data/lib/moab/file_instance_difference.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # A container for recording difference information at the file level
@@ -28,7 +28,7 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @signatures = Array.new
+      @signatures = []
       super(opts)
     end
 
@@ -38,14 +38,14 @@ module Moab
 
     # @attribute
     # @return [String] The file's path in the basis inventory (usually for an old version)
-    attribute :basis_path, String, :tag => 'basisPath', :on_save => Proc.new { |s| s.to_s }
+    attribute :basis_path, String, tag: 'basisPath', on_save: proc { |s| s.to_s }
 
     # @attribute
     # @return [String] The file's path in the other inventory (usually for an new version) compared against the basis
-    attribute :other_path, String, :tag => 'otherPath', :on_save => Proc.new { |s| s.to_s }
+    attribute :other_path, String, tag: 'otherPath', on_save: proc { |s| s.to_s }
 
     # @attribute
     # @return [Array<FileSignature>] The fixity data of the file manifestation(s) (plural if change was a content modification)
-    has_many :signatures, FileSignature, :tag => 'fileSignature'
+    has_many :signatures, FileSignature, tag: 'fileSignature'
   end
 end

data/lib/moab/file_inventory.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # A structured container for recording information about a collection of related files.
@@ -35,7 +35,7 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @groups = Array.new
+      @groups = []
       @inventory_datetime = Time.now
       super(opts)
     end
@@ -46,20 +46,20 @@ module Moab
 
     # @attribute
     # @return [String] The digital object identifier (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 inventory was created
-    attribute :inventory_datetime, String, :tag => 'inventoryDatetime'
+    attribute :inventory_datetime, String, tag: 'inventoryDatetime'
 
     def inventory_datetime=(datetime)
       @inventory_datetime = Moab::UtcTime.input(datetime)
@@ -71,7 +71,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The total number of data files in the inventory (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
       groups.inject(0) { |sum, group| sum + group.file_count }
@@ -79,7 +79,7 @@ module Moab
 
      # @attribute
     # @return [Integer] The total size (in bytes) in all files of all files in the inventory (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
       groups.inject(0) { |sum, group| sum + group.byte_count }
@@ -87,7 +87,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
       groups.inject(0) { |sum, group| sum + group.block_count }
@@ -95,18 +95,18 @@ module Moab
 
     # @attribute
     # @return [Array<FileGroup>] The set of data groups comprising the version
-    has_many :groups, FileGroup, :tag => 'fileGroup'
+    has_many :groups, FileGroup, tag: 'fileGroup'
 
     # @return [Array<FileGroup] The set of data groups that contain files
     def non_empty_groups
-      groups.select { |group| !group.files.empty? }
+      groups.reject { |group| group.files.empty? }
     end
 
     # @param non_empty [Boolean] if true, return group_id's only for groups having files
     # @return [Array<String>] group identifiers contained in this file inventory
     def group_ids(non_empty = nil)
-      my_groups = non_empty ? self.non_empty_groups : groups
-      my_groups.map { |g| g.group_id }
+      my_groups = non_empty ? non_empty_groups : groups
+      my_groups.map(&:group_id)
     end
 
     # @param [String] group_id The identifer of the group to be selected
@@ -119,12 +119,12 @@ module Moab
     # @return [Boolean] true if the group is missing or empty
     def group_empty?(group_id)
       group = self.group(group_id)
-      group.nil? or group.files.empty?
+      group.nil? || group.files.empty?
     end
 
     # @return [Array<String>] The data fields to include in summary reports
     def summary_fields
-      %w{type digital_object_id version_id inventory_datetime file_count byte_count block_count groups}
+      %w[type digital_object_id version_id inventory_datetime file_count byte_count block_count groups]
     end
 
     # @param [String] group_id The identifer of the group to be selected
@@ -134,9 +134,11 @@ module Moab
       file_group = group(group_id)
       errmsg = "group #{group_id} not found for #{digital_object_id} - #{version_id}"
       raise FileNotFoundException, errmsg if file_group.nil?
+
       file_signature = file_group.path_hash[file_id]
       errmsg = "#{group_id} file #{file_id} not found for #{digital_object_id} - #{version_id}"
       raise FileNotFoundException, errmsg if file_signature.nil?
+
       file_signature
     end
 
@@ -161,17 +163,9 @@ module Moab
     def data_source
       data_source = (groups.collect { |g| g.data_source.to_s }).join('|')
       if data_source.start_with?('contentMetadata')
-        if version_id
-          "v#{version_id}-#{data_source}"
-        else
-          "new-#{data_source}"
-        end
+        version_id ? "v#{version_id}-#{data_source}" : "new-#{data_source}"
       else
-        if version_id
-          "v#{version_id}"
-        else
-          data_source
-        end
+        version_id ? "v#{version_id}" : data_source
       end
     end
 
@@ -185,7 +179,7 @@ module Moab
       if group_id
         groups << FileGroup.new(group_id: group_id).group_from_directory(data_dir)
       else
-        ['content', 'metadata'].each do |gid|
+        %w[content metadata].each do |gid|
           groups << FileGroup.new(group_id: gid).group_from_directory(Pathname(data_dir).join(gid))
         end
       end
@@ -200,7 +194,7 @@ module Moab
       signatures_from_bag = signatures_from_bagit_manifests(bag_pathname)
       bag_data_subdirs = bag_pathname.join('data').children
       bag_data_subdirs.each do |subdir|
-        groups << FileGroup.new(:group_id => subdir.basename.to_s).group_from_bagit_subdir(subdir, signatures_from_bag)
+        groups << FileGroup.new(group_id: subdir.basename.to_s).group_from_bagit_subdir(subdir, signatures_from_bag)
       end
       self
     end
@@ -208,7 +202,7 @@ module Moab
     # @param  bag_pathname [Pathname] The location of the BagIt bag to be inventoried
     # @return [Hash<Pathname,FileSignature>] The fixity data present in the bag's manifest files
     def signatures_from_bagit_manifests(bag_pathname)
-      manifest_pathname = Hash.new
+      manifest_pathname = {}
       DEFAULT_CHECKSUM_TYPES.each do |type|
         manifest_pathname[type] = bag_pathname.join("manifest-#{type}.txt")
       end
@@ -235,14 +229,14 @@ module Moab
     def human_size
       count = 0
       size = byte_count
-      while size >= 1024 and count < 4
+      while (size >= 1024) && (count < 4)
         size /= 1024.0
         count += 1
       end
       if count == 0
-        sprintf("%d B", size)
+        format("%d B", size)
       else
-        sprintf("%.2f %s", size, %w[B KB MB GB TB][count])
+        format("%.2f %s", size, %w[B KB MB GB TB][count])
       end
     end