moab-versioning 4.2.1 → 4.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8226ecfe5e815a81aa72bc564fc1abc341b4f570
-  data.tar.gz: 9d085cad25bc601caec626edb5cf4f778a979fc3
+  metadata.gz: 26d64bba0aa593e619713fb761078c032df8e1cc
+  data.tar.gz: 91b9bbd3842691aabbc4a9f003347fceeea949f4
 SHA512:
-  metadata.gz: 6c0072f1cd34f7bd192a4231b6c496e81d4ce380edaf08cd5fb997b240ad64b09c8ce94ed4083a65f812c11971b1e11eadf2d8099edb898226d904a8e58c3d17
-  data.tar.gz: 71aa7a0ff75185089d2a7705a13635b67b0fbaa600b438a35fde7f75a4bd83061f050b1c4eeef98162e38b64a66e6c23e3f45748bde93b5de42acaee32fadf9e
+  metadata.gz: 94c2ec711d1135684611e517f994658c1358ea01b0687e46c454772476c72b9090250045a79adfb0bc5a8fe0e02988951fbce939eb9891d77956a46c67562cfc
+  data.tar.gz: e69e5ee8da7091da76bf6dba56856411da26b683ec5ae897f7c6a6811f5af9e8700a9306e4cd5f75bf20de5e92f0b35b7f87a47753d03fdedaad947f85619e70

data/lib/moab.rb

@@ -29,7 +29,7 @@
 # @note Copyright (c) 2012 by The Board of Trustees of the Leland Stanford Junior University.
 #   All rights reserved.  See {file:LICENSE.rdoc} for details.
 module Moab
-  DEFAULT_CHECKSUM_TYPES = [:md5, :sha1, :sha256].freeze
+  DEFAULT_CHECKSUM_TYPES = %i[md5 sha1 sha256].freeze
 end
 
 require 'serializer'

data/lib/moab/bagger.rb

@@ -25,7 +25,7 @@ module Moab
       @version_inventory = version_inventory
       @signature_catalog = signature_catalog
       @bag_pathname = Pathname.new(bag_pathname)
-      create_bagit_txt()
+      create_bagit_txt
     end
 
     # @return [FileInventory] The complete inventory of the files comprising a digital object version
@@ -54,7 +54,7 @@ module Moab
 
     # @api internal
     # @return [void] Generate the bagit.txt tag file
-    def create_bagit_txt()
+    def create_bagit_txt
       bag_pathname.mkpath
       bag_pathname.join("bagit.txt").open('w') do |f|
         f.puts "Tag-File-Character-Encoding: UTF-8"
@@ -63,13 +63,13 @@ module Moab
     end
 
     # @return [NilClass] Delete the bagit files
-    def delete_bag()
+    def delete_bag
       # make sure this looks like a bag before deleting
       if bag_pathname.join('bagit.txt').exist?
         if bag_pathname.join('data').exist?
           bag_pathname.rmtree
         else
-          bag_pathname.children.each { |file| file.delete }
+          bag_pathname.children.each(&:delete)
           bag_pathname.rmdir
         end
       end
@@ -77,7 +77,7 @@ module Moab
     end
 
     # @param tar_pathname [Pathname] The location of the tar file (default is based on bag location)
-    def delete_tarfile()
+    def delete_tarfile
       bag_name = bag_pathname.basename
       bag_parent = bag_pathname.parent
       tar_pathname = bag_parent.join("#{bag_name}.tar")
@@ -140,7 +140,7 @@ module Moab
     #    Return true if successful or nil if the group was not found in the inventory
     def deposit_group(group_id, source_dir)
       group = bag_inventory.group(group_id)
-      return nil? if group.nil? or group.files.empty?
+      return nil? if group.nil? || group.files.empty?
       target_dir = bag_pathname.join('data', group_id)
       group.path_list.each do |relative_path|
         source = source_dir.join(relative_path)
@@ -157,7 +157,7 @@ module Moab
     #    Return true if successful or nil if the group was not found in the inventory
     def reconstuct_group(group_id, storage_object_dir)
       group = bag_inventory.group(group_id)
-      return nil? if group.nil? or group.files.empty?
+      return nil? if group.nil? || group.files.empty?
       target_dir = bag_pathname.join('data', group_id)
       group.files.each do |file|
         catalog_entry = signature_catalog.signature_hash[file.signature]
@@ -183,8 +183,8 @@ module Moab
     # @api internal
     # @return [void] Using the checksum information from the inventory, create BagIt manifest files for the payload
     def create_payload_manifests
-      manifest_pathname = Hash.new
-      manifest_file = Hash.new
+      manifest_pathname = {}
+      manifest_file = {}
       DEFAULT_CHECKSUM_TYPES.each do |type|
         manifest_pathname[type] = bag_pathname.join("manifest-#{type}.txt")
         manifest_file[type] = manifest_pathname[type].open('w')
@@ -205,7 +205,7 @@ module Moab
         if manifest_file[type]
           manifest_file[type].close
           manifest_pathname[type].delete if
-              manifest_pathname[type].exist? and manifest_pathname[type].size == 0
+              manifest_pathname[type].exist? && manifest_pathname[type].size == 0
         end
       end
     end
@@ -222,9 +222,9 @@ module Moab
 
     # @api internal
     # @return [void] create BagIt tag manifest files containing checksums for all files in the bag's root directory
-    def create_tagfile_manifests()
-      manifest_pathname = Hash.new
-      manifest_file = Hash.new
+    def create_tagfile_manifests
+      manifest_pathname = {}
+      manifest_file = {}
       DEFAULT_CHECKSUM_TYPES.each do |type|
         manifest_pathname[type] = bag_pathname.join("tagmanifest-#{type}.txt")
         manifest_file[type] = manifest_pathname[type].open('w')
@@ -243,7 +243,7 @@ module Moab
         if manifest_file[type]
           manifest_file[type].close
           manifest_pathname[type].delete if
-              manifest_pathname[type].exist? and manifest_pathname[type].size == 0
+              manifest_pathname[type].exist? && manifest_pathname[type].size == 0
         end
       end
     end
@@ -260,7 +260,7 @@ module Moab
         shell_execute(tar_cmd.sub('--force-local', ''))
       end
       raise "Unable to create tarfile #{tar_pathname}" unless tar_pathname.exist?
-      return true
+      true
     end
 
     # Executes a system command in a subprocess

data/lib/moab/config.rb

@@ -1,5 +1,3 @@
-require 'moab'
-
 module Moab
   # @return [Confstruct::Configuration] the configuration data
   Config = Confstruct::Configuration.new do

data/lib/moab/deposit_bag_validator.rb

@@ -31,7 +31,7 @@ module Moab
     }.freeze
 
     REQUIRED_MANIFEST_CHECKSUM_TYPE = 'sha256'.freeze
-    RECOGNIZED_CHECKSUM_ALGORITHMS = [:md5, :sha1, :sha256, :sha384, :sha512].freeze
+    RECOGNIZED_CHECKSUM_ALGORITHMS = %i[md5 sha1 sha256 sha384 sha512].freeze
 
     TAGMANIFEST = 'tagmanifest'.freeze
     MANIFEST = 'manifest'.freeze

data/lib/moab/file_group.rb

@@ -1,5 +1,3 @@
-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
@@ -22,8 +20,9 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @signature_hash = Hash.new
+      @signature_hash = {}
       @data_source = ""
+      @signatures_from_bag = nil # prevents later warning: instance variable @signatures_from_bag not initialized
       super(opts)
     end
 
@@ -37,7 +36,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 { |i| i.to_s }
 
     def file_count
       files.inject(0) { |sum, manifestation| sum + manifestation.file_count }
@@ -45,7 +44,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 { |i| i.to_s }
 
     def byte_count
       files.inject(0) { |sum, manifestation| sum + manifestation.byte_count }
@@ -53,7 +52,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 { |i| i.to_s }
 
     def block_count
       files.inject(0) { |sum, manifestation| sum + manifestation.block_count }
@@ -61,7 +60,7 @@ module Moab
 
     # @return [Array<String>] The data fields to include in summary reports
     def summary_fields
-      %w{group_id file_count byte_count block_count}
+      %w[group_id file_count byte_count block_count]
     end
 
     # @attribute
@@ -80,7 +79,7 @@ module Moab
     # @return [Hash<String,FileSignature>] An index of file paths,
     #   used to test for existence of a filename in this file group
     def path_hash
-      path_hash = Hash.new
+      path_hash = {}
       signature_hash.each do |signature, manifestation|
         manifestation.instances.each do |instance|
           path_hash[instance.path] = signature
@@ -91,14 +90,14 @@ 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(&:path) }.flatten
     end
 
     # @api internal
     # @param signature_subset [Array<FileSignature>] The signatures used to select the entries to return
     # @return [Hash<String,FileSignature>] A pathname,signature hash containing a subset of the filenames in this file group
     def path_hash_subset(signature_subset)
-      path_hash = Hash.new
+      path_hash = {}
       signature_subset.each do |signature|
         manifestation = signature_hash[signature]
         manifestation.instances.each do |instance|
@@ -132,7 +131,7 @@ module Moab
     # @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)
-      if signature_hash.has_key?(signature)
+      if signature_hash.key?(signature)
         manifestation = signature_hash[signature]
       else
         manifestation = FileManifestation.new
@@ -146,7 +145,7 @@ module Moab
     # @return [void] Remove a file from the inventory
     # for example, the manifest inventory does not contain a file entry for itself
     def remove_file_having_path(path)
-      signature = self.path_hash[path]
+      signature = path_hash[path]
       signature_hash.delete(signature)
     end
 
@@ -203,9 +202,8 @@ module Moab
       pathname = Pathname.new(path).expand_path
       validated ||= is_descendent_of_base?(pathname)
       pathname.children.sort.each do |child|
-        if child.basename.to_s == ".DS_Store"
-          next
-        elsif child.directory?
+        next if child.basename.to_s == '.DS_Store'
+        if child.directory?
           harvest_directory(child, recursive, validated) if recursive
         else
           add_physical_file(child, validated)

data/lib/moab/file_group_difference.rb

@@ -1,5 +1,3 @@
-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.
@@ -64,7 +62,7 @@ module Moab
     # @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 +74,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
@@ -133,19 +131,18 @@ module Moab
     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,
@@ -257,7 +254,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
@@ -331,20 +328,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,5 +1,3 @@
-require 'moab'
-
 module Moab
   # A container for reporting a set of file-level differences of the type specified by the change attribute
   #
@@ -20,7 +18,7 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @files = Array.new
+      @files = []
       super(opts)
     end
 
@@ -30,7 +28,7 @@ module Moab
 
     # @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

data/lib/moab/file_instance.rb

@@ -1,5 +1,3 @@
-require 'moab'
-
 module Moab
   # The file path and last modification date properties of a file
   #
@@ -54,7 +52,7 @@ 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,5 +1,3 @@
-require 'moab'
-
 module Moab
   # A container for recording difference information at the file level
   # * If there was no change, the change type is set to <i>identical</i>
@@ -28,7 +26,7 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @signatures = Array.new
+      @signatures = []
       super(opts)
     end
 
@@ -38,11 +36,11 @@ 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)

data/lib/moab/file_inventory.rb

@@ -1,5 +1,3 @@
-require 'moab'
-
 module Moab
   # A structured container for recording information about a collection of related files.
   #
@@ -35,7 +33,7 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @groups = Array.new
+      @groups = []
       @inventory_datetime = Time.now
       super(opts)
     end
@@ -50,7 +48,7 @@ module Moab
 
     # @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
@@ -71,7 +69,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 +77,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 +85,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 }
@@ -99,14 +97,14 @@ module Moab
 
     # @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 +117,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
@@ -161,17 +159,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 +175,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
@@ -208,7 +198,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 +225,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