moab-versioning 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd9a6b4c49a9ab93e011a23004c0c21b74878ff7dc46c29b022c56b83627c3bb
-  data.tar.gz: 065bb99748c0e06d5f3fafebc9b75552e1585709e170d27b27a5f14cb7b1db85
+  metadata.gz: dcb99d73bd625e8cbba0201f1dea7f6ae4925806df623e2a1e52198827f5b1c7
+  data.tar.gz: cb53aea7e39eabf83f8f80e0d05b70fe4a73e4376e0a6e054fb912b1225460f1
 SHA512:
-  metadata.gz: 2efdbe79de69d26b41de7de0052ade6e3c8cf1a8651e6e05d093b889cb0de0ac47061663951bef33082012719b3f5774ff37ced11ef210a8f7a67cfbc7bbb7b2
-  data.tar.gz: cd9518df71844ea61f4b036d08d51e2c86456c28492404265b8bd68d8510db1556ac359abd3ae95736011431ebab6bbe4a804530875e060b278dd54a9e57aff5
+  metadata.gz: af674dbff0e829b11da52850800fd2b3365e4ebc27d6629cefe7a71de0961bab884e7fb406be515a93a6387e48c5eb90a170144177fef9655331b9517732c298
+  data.tar.gz: d858888aad9e8557b33471f02c600e94217eba5ac213f27469fd7cc745f79752c9699e53c58d007f9c6fd39202d17f5e14da1a5761994309b2e5047ca76e0731

data/lib/moab.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Moab is a module that provides a distintive namespace for the collection of classes it contains.
 #
 # ====Data Model
@@ -33,7 +35,6 @@ module Moab
 end
 
 require 'serializer'
-require 'confstruct/configuration'
 require 'moab/config'
 require 'moab/utc_time'
 require 'moab/file_signature'

data/lib/moab/bagger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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
@@ -141,6 +143,7 @@ module Moab
     def deposit_group(group_id, source_dir)
       group = bag_inventory.group(group_id)
       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)
@@ -158,6 +161,7 @@ module Moab
     def reconstuct_group(group_id, storage_object_dir)
       group = bag_inventory.group(group_id)
       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]
@@ -260,6 +264,7 @@ module Moab
         shell_execute(tar_cmd.sub('--force-local', ''))
       end
       raise(MoabRuntimeError, "Unable to create tarfile #{tar_pathname}") unless tar_pathname.exist?
+
       true
     end
 
@@ -273,7 +278,7 @@ module Moab
         stdout
       else
         msg = "Shell command failed: [#{command}] caused by <STDERR = #{stderr}>"
-        msg << " STDOUT = #{stdout}" if stdout && stdout.length.positive?
+        msg << " STDOUT = #{stdout}" if stdout&.length&.positive?
         raise(MoabStandardError, msg)
       end
     rescue SystemCallError => e

data/lib/moab/config.rb

@@ -1,10 +1,43 @@
+# frozen_string_literal: true
+
 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
-    checksum_algos [:md5, :sha1, :sha256]
+  # A place to store configuration for the gem
+  class Configuration
+    def initialize
+      @path_method = :druid_tree
+      @checksum_algos = [:md5, :sha1, :sha256]
+    end
+
+    def configure(&block)
+      instance_eval(&block)
+    end
+
+    def storage_roots(new_value = nil)
+      @storage_roots = new_value if new_value
+      @storage_roots
+    end
+
+    def storage_trunk(new_value = nil)
+      @storage_trunk = new_value if new_value
+      @storage_trunk
+    end
+
+    def deposit_trunk(new_value = nil)
+      @deposit_trunk = new_value if new_value
+      @deposit_trunk
+    end
+
+    def path_method(new_value = nil)
+      @path_method = new_value if new_value
+      @path_method
+    end
+
+    def checksum_algos(new_value = nil)
+      @checksum_algos = new_value if new_value
+      @checksum_algos
+    end
   end
+
+  # @return [Moab::Configuration] the configuration data
+  Config = Configuration.new
 end

data/lib/moab/deposit_bag_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # Given a deposit bag, ensures the contents valid for becoming a StorageObjectVersion
   # this is a Shameless Green implementation, combining code from:
@@ -30,23 +32,23 @@ module Moab
       VERSION_MISSING_FROM_FILE => "Version xml file %{version_file} missing data at %{xpath} containing version id"
     }.freeze
 
-    REQUIRED_MANIFEST_CHECKSUM_TYPE = 'sha256'.freeze
+    REQUIRED_MANIFEST_CHECKSUM_TYPE = 'sha256'
     RECOGNIZED_CHECKSUM_ALGORITHMS = %i[md5 sha1 sha256 sha384 sha512].freeze
 
-    TAGMANIFEST = 'tagmanifest'.freeze
-    MANIFEST = 'manifest'.freeze
-    DATA_DIR_BASENAME = 'data'.freeze
-    BAG_INFO_TXT_BASENAME = 'bag-info.txt'.freeze
-    VERSION_ADDITIONS_BASENAME = 'versionAdditions.xml'.freeze
-    VERSION_INVENTORY_BASENAME = 'versionInventory.xml'.freeze
-    VERSION_METADATA_PATH = "#{DATA_DIR_BASENAME}/metadata/versionMetadata.xml".freeze
+    TAGMANIFEST = 'tagmanifest'
+    MANIFEST = 'manifest'
+    DATA_DIR_BASENAME = 'data'
+    BAG_INFO_TXT_BASENAME = 'bag-info.txt'
+    VERSION_ADDITIONS_BASENAME = 'versionAdditions.xml'
+    VERSION_INVENTORY_BASENAME = 'versionInventory.xml'
+    VERSION_METADATA_PATH = "#{DATA_DIR_BASENAME}/metadata/versionMetadata.xml"
 
     REQUIRED_BAG_FILES = [
       DATA_DIR_BASENAME,
-      'bagit.txt'.freeze,
+      'bagit.txt',
       BAG_INFO_TXT_BASENAME,
-      "#{MANIFEST}-#{REQUIRED_MANIFEST_CHECKSUM_TYPE}.txt".freeze,
-      "#{TAGMANIFEST}-#{REQUIRED_MANIFEST_CHECKSUM_TYPE}.txt".freeze,
+      "#{MANIFEST}-#{REQUIRED_MANIFEST_CHECKSUM_TYPE}.txt",
+      "#{TAGMANIFEST}-#{REQUIRED_MANIFEST_CHECKSUM_TYPE}.txt",
       VERSION_ADDITIONS_BASENAME,
       VERSION_INVENTORY_BASENAME,
       VERSION_METADATA_PATH
@@ -64,6 +66,7 @@ module Moab
     def validation_errors
       return [single_error_hash(BAG_DIR_NOT_FOUND, bag_dir: deposit_bag_pathname)] unless deposit_bag_pathname.exist?
       return result_array unless required_bag_files_exist?
+
       verify_version
       verify_tagmanifests
       verify_payload_size
@@ -112,6 +115,7 @@ module Moab
       doc = Nokogiri::XML(File.open(pathname.to_s), &:strict)
       version_id = doc.xpath(xpath).last.text unless doc.xpath(xpath).empty?
       return version_id.to_i if version_id
+
       err_data = {
         version_file: pathname,
         xpath: xpath
@@ -129,6 +133,7 @@ module Moab
 
     def verify_version_from_xml_file(file_pathname, found)
       return if found == expected_new_version
+
       err_data = {
         file_pathname: file_pathname,
         new_version: expected_new_version,
@@ -251,6 +256,7 @@ module Moab
         end
       end
       return if diff_hash.empty?
+
       err_data = {
         manifest_type: manifest_type,
         diffs: diff_hash
@@ -266,9 +272,7 @@ module Moab
       checksum_types_to_compare.each do |type|
         left_checksum = left_checksums[type]
         right_checksum = right_checksums[type]
-        if left_checksum != right_checksum
-          diff_hash[type] = { left_label => left_checksum, right_label => right_checksum }
-        end
+        diff_hash[type] = { left_label => left_checksum, right_label => right_checksum } if left_checksum != right_checksum
       end
       diff_hash.empty? ? nil : diff_hash
     end
@@ -277,6 +281,7 @@ module Moab
       sizes_from_bag_info_file = bag_info_payload_size
       generated_sizes = generated_payload_size
       return if sizes_from_bag_info_file == generated_sizes
+
       err_data = {
         bag_info_sizes: sizes_from_bag_info_file,
         generated_sizes: generated_sizes

data/lib/moab/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   class MoabRuntimeError < RuntimeError; end
   class MoabStandardError < StandardError; end

data/lib/moab/file_group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # A container for a standard subset of a digital objects {FileManifestation} objects
   # Used to segregate depositor content from repository metadata files
@@ -161,9 +163,11 @@ module Moab
     # @return [Boolean] Test whether the given path is contained within the {#base_directory}
     def is_descendent_of_base?(pathname)
       raise(MoabRuntimeError, "base_directory has not been set") if @base_directory.nil?
+
       is_descendent = false
       pathname.expand_path.ascend { |ancestor| is_descendent ||= (ancestor == @base_directory) }
       raise(MoabRuntimeError, "#{pathname} is not a descendent of #{@base_directory}") unless is_descendent
+
       is_descendent
     end
 
@@ -203,6 +207,7 @@ module Moab
       validated ||= is_descendent_of_base?(pathname)
       pathname.children.sort.each do |child|
         next if child.basename.to_s == '.DS_Store'
+
         if child.directory?
           harvest_directory(child, recursive, validated) if recursive
         else
@@ -222,9 +227,7 @@ module Moab
       instance = FileInstance.new.instance_from_file(pathname, @base_directory)
       if @signatures_from_bag && @signatures_from_bag[pathname]
         signature = @signatures_from_bag[pathname]
-        unless signature.complete?
-          signature = signature.normalized_signature(pathname)
-        end
+        signature = signature.normalized_signature(pathname) unless signature.complete?
       else
         signature = FileSignature.new.signature_from_file(pathname)
       end

data/lib/moab/file_group_difference.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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.
@@ -132,6 +134,7 @@ module Moab
 
     def subsets=(array)
       return unless array
+
       array.each { |subset| subset_hash[subset.change.to_sym] = subset }
     end
 

data/lib/moab/file_group_difference_subset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # A container for reporting a set of file-level differences of the type specified by the change attribute
   #

data/lib/moab/file_instance.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # The file path and last modification date properties of a file
   #
@@ -52,6 +54,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!
+
       path == other.path
     end
 

data/lib/moab/file_instance_difference.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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>

data/lib/moab/file_inventory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # A structured container for recording information about a collection of related files.
   #
@@ -132,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
 

data/lib/moab/file_inventory_difference.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # Compares two {FileInventory} instances based primarily on file signatures and secondarily on file pathnames.
   # Although the usual use will be to compare the content of 2 different temporal versions of the same object,

data/lib/moab/file_manifestation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # A container for a file signature and all the physical file instances that have that signature
   # This element has one child {FileSignature} element, and one or more {FileInstance} elements
@@ -75,6 +77,7 @@ module Moab
     # @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!
+
       (signature == other.signature) && (instances == other.instances)
     end
   end

data/lib/moab/file_signature.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # The fixity properties of a file, used to determine file content equivalence regardless of filename.
   # Placing this data in a class by itself facilitates using file size together with the MD5 and SHA1 checksums
@@ -128,10 +130,12 @@ module Moab
     def eql?(other)
       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.empty?
+
       matching_keys.each do |key|
         return false if self_checksums[key] != other_checksums[key]
       end
@@ -176,6 +180,7 @@ module Moab
     def normalized_signature(pathname)
       sig_from_file = FileSignature.new.signature_from_file(pathname)
       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}")
@@ -185,8 +190,8 @@ module Moab
     def self.checksum_names_for_type
       {
         md5: ['MD5'],
-        sha1: ['SHA-1', 'SHA1'],
-        sha256: ['SHA-256', 'SHA256']
+        sha1: %w[SHA-1 SHA1],
+        sha256: %w[SHA-256 SHA256]
       }
     end
 

data/lib/moab/signature_catalog.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # A digital object's Signature Catalog is derived from an filtered aggregation of the file inventories
   # of a digital object's set of versions.  (see {#update})
@@ -181,9 +183,7 @@ module Moab
       version_inventory.groups.each do |group|
         group_addtions = FileGroup.new(:group_id => group.group_id)
         group.files.each do |file|
-          unless @signature_hash.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 unless group_addtions.files.empty?
       end

data/lib/moab/signature_catalog_entry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # A file-level entry in a digital object's {SignatureCatalog}.
   # It has a child {FileSignature} element that identifies the file's contents (the bytestream)

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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # A class to represent a digital object's repository storage location
   # and methods for
@@ -113,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
 
@@ -127,6 +130,7 @@ module Moab
     def version_id_list
       list = []
       return list unless @object_pathname.exist?
+
       @object_pathname.children.each do |dirname|
         vnum = dirname.basename.to_s
         list << vnum[1..-1].to_i if vnum =~ /^v(\d+)$/
@@ -163,6 +167,7 @@ module Moab
       if version_inventory.version_id != (current_version_id + 1)
         raise(MoabRuntimeError, "version mismatch - current: #{current_version_id} new: #{version_inventory.version_id}")
       end
+
       true
     end
 
@@ -188,6 +193,7 @@ module Moab
     # * Current version + 1 is used for creation of a new version
     def storage_object_version(version_id)
       raise(MoabRuntimeError, "Version ID not specified") unless version_id
+
       StorageObjectVersion.new(self, version_id)
     end
 

data/lib/moab/storage_object_validator.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Moab
   # Given a druid path, are the contents actually a well-formed Moab?
   # Shameless green: repetitious code included.
   class StorageObjectValidator
-    METADATA_DIR = "metadata".freeze
-    CONTENT_DIR = "content".freeze
+    METADATA_DIR = "metadata"
+    CONTENT_DIR = "content"
     EXPECTED_DATA_SUB_DIRS = [CONTENT_DIR, METADATA_DIR].freeze
     IMPLICIT_DIRS = ['.', '..'].freeze # unlike Find.find, Dir.entries returns the current/parent dirs
-    DATA_DIR = "data".freeze
-    MANIFESTS_DIR = 'manifests'.freeze
+    DATA_DIR = "data"
+    MANIFESTS_DIR = 'manifests'
     EXPECTED_VERSION_SUB_DIRS = [DATA_DIR, MANIFESTS_DIR].freeze
     MANIFEST_INVENTORY_PATH = File.join(MANIFESTS_DIR, "manifestInventory.xml").freeze
     SIGNATURE_CATALOG_PATH = File.join(MANIFESTS_DIR, "signatureCatalog.xml").freeze
@@ -90,6 +92,7 @@ module Moab
     def check_sequential_version_dirs
       version_directories.each_with_index do |dir_name, index|
         next if dir_name[1..-1].to_i == index + 1 # version numbering starts at 1, array indexing at 0
+
         return [result_hash(VERSIONS_NOT_IN_ORDER, version_directories)]
       end
       []
@@ -113,6 +116,7 @@ module Moab
       return expected_version_sub_dirs(version_path, version) if count == EXPECTED_VERSION_SUB_DIRS.size
       return found_unexpected(version_sub_dirs, version, EXPECTED_VERSION_SUB_DIRS) if count > EXPECTED_VERSION_SUB_DIRS.size
       return missing_dir(version_sub_dirs, version, EXPECTED_VERSION_SUB_DIRS) if count < EXPECTED_VERSION_SUB_DIRS.size
+
       []
     end
 
@@ -122,15 +126,20 @@ module Moab
       data_sub_dirs = directory_entries(data_dir_path)
       errors.concat check_data_sub_dirs(version, data_sub_dirs)
       errors.concat check_metadata_dir_files_only(version_path) if errors.empty?
-      errors.concat check_optional_content_dir(version_path, allow_content_subdirs) if data_sub_dirs.include?('content') && errors.empty?
+      if data_sub_dirs.include?('content') && errors.empty?
+        errors.concat check_optional_content_dir(version_path, allow_content_subdirs)
+      end
       errors
     end
 
     def check_data_sub_dirs(version, data_sub_dirs)
       return found_unexpected(data_sub_dirs, version, EXPECTED_DATA_SUB_DIRS) if data_sub_dirs.size > EXPECTED_DATA_SUB_DIRS.size
+
       errors = []
       errors.concat missing_dir(data_sub_dirs, version, [METADATA_DIR]) unless data_sub_dirs.include?(METADATA_DIR)
-      errors.concat found_unexpected(data_sub_dirs, version, EXPECTED_DATA_SUB_DIRS) unless data_sub_dirs.to_set.subset?(EXPECTED_DATA_SUB_DIRS.to_set)
+      unless data_sub_dirs.to_set.subset?(EXPECTED_DATA_SUB_DIRS.to_set)
+        errors.concat found_unexpected(data_sub_dirs, version, EXPECTED_DATA_SUB_DIRS)
+      end
       errors
     end
 
@@ -139,7 +148,9 @@ module Moab
       content_dir_path = File.join(version_path, DATA_DIR, CONTENT_DIR)
       errors << result_hash(NO_FILES_IN_CONTENT_DIR, basename(version_path)) if directory_entries(content_dir_path).empty?
       content_sub_dir = contains_sub_dir?(content_dir_path)
-      errors << result_hash(CONTENT_SUB_DIRS_DETECTED, version: basename(version_path), dir: content_sub_dir) if content_sub_dir && !allow_content_subdirs
+      if content_sub_dir && !allow_content_subdirs
+        errors << result_hash(CONTENT_SUB_DIRS_DETECTED, version: basename(version_path), dir: content_sub_dir)
+      end
       if allow_content_subdirs && contains_sub_dir?(content_dir_path) && contains_forbidden_content_sub_dir?(content_dir_path)
         errors << result_hash(BAD_SUB_DIR_IN_CONTENT_DIR, basename(version_path))
       end
@@ -159,7 +170,9 @@ module Moab
       metadata_dir_path = File.join(version_path, DATA_DIR, METADATA_DIR)
       errors << result_hash(NO_FILES_IN_METADATA_DIR, basename(version_path)) if directory_entries(metadata_dir_path).empty?
       metadata_sub_dir = contains_sub_dir?(metadata_dir_path)
-      errors << result_hash(METADATA_SUB_DIRS_DETECTED, version: basename(version_path), dir: metadata_sub_dir) if metadata_sub_dir
+      if metadata_sub_dir
+        errors << result_hash(METADATA_SUB_DIRS_DETECTED, version: basename(version_path), dir: metadata_sub_dir)
+      end
       errors
     end
 
@@ -228,6 +241,7 @@ module Moab
 
     def check_required_manifest_files(dir, version)
       return [result_hash(NO_FILES_IN_MANIFEST_DIR, version)] unless contains_file?(File.join(dir, MANIFESTS_DIR))
+
       errors = []
       errors << result_hash(NO_MANIFEST_INVENTORY, version) unless File.exist?(File.join(dir, MANIFEST_INVENTORY_PATH))
       errors << result_hash(NO_SIGNATURE_CATALOG, version) unless File.exist?(File.join(dir, SIGNATURE_CATALOG_PATH))

data/lib/moab/storage_object_version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # A class to represent a version subdirectory within an object's home directory in preservation storage
   # ====Data Model
@@ -68,6 +70,7 @@ module Moab
     def find_filepath(file_category, file_id)
       this_version_filepath = file_pathname(file_category, file_id)
       return this_version_filepath if this_version_filepath.exist?
+
       if file_category == 'manifest'
         msg = "manifest file #{file_id} not found for #{@storage_object.digital_object_id} - #{@version_id}"
         raise FileNotFoundException, msg
@@ -109,6 +112,7 @@ module Moab
     def file_inventory(type)
       if version_id > 0
         return @inventory_cache[type] if @inventory_cache.key?(type)
+
         @inventory_cache[type] = FileInventory.read_xml_file(@version_pathname.join('manifests'), type)
       else
         groups = %w[content metadata].collect { |id| FileGroup.new(:group_id => id) }
@@ -136,6 +140,7 @@ module Moab
     # @return [void] Create the version subdirectory and move files into it
     def ingest_bag_data(bag_dir)
       raise(MoabRuntimeError, "Version already exists: #{@version_pathname}") if @version_pathname.exist?
+
       @version_pathname.join('manifests').mkpath
       bag_dir = Pathname(bag_dir)
       ingest_dir(bag_dir.join('data'), @version_pathname.join('data'))
@@ -150,6 +155,7 @@ module Moab
     # @return [void] recursively link or copy the source directory contents to the target directory
     def ingest_dir(source_dir, target_dir, use_links = true)
       raise(MoabRuntimeError, "cannot copy - target already exists: #{target_dir.expand_path}") if target_dir.exist?
+
       target_dir.mkpath
       source_dir.children.each do |child|
         if child.directory?
@@ -321,6 +327,7 @@ module Moab
     # @return [null] Deactivate this object version by moving it to another directory.  (Used by restore operation)
     def deactivate(timestamp)
       return unless @version_pathname.exist?
+
       timestamp_pathname = @version_pathname.parent.join(timestamp.utc.iso8601.gsub(/[-:]/, ''))
       timestamp_pathname.mkpath
       demote_pathame = timestamp_pathname.join(@version_pathname.basename)

data/lib/moab/storage_repository.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # A class to represent the SDR repository store
   #
@@ -19,8 +21,10 @@ module Moab
     def storage_roots
       unless defined?(@storage_roots)
         raise(MoabRuntimeError, "Moab::Config.storage_roots not found in config file") if Moab::Config.storage_roots.nil?
+
         @storage_roots = [Moab::Config.storage_roots].flatten.collect { |filesystem| Pathname(filesystem) }
         raise(MoabRuntimeError, "Moab::Config.storage_roots empty") if @storage_roots.empty?
+
         @storage_roots.each { |root| raise(MoabRuntimeError, "Storage root #{root} not found on system") unless root.exist? }
       end
       @storage_roots
@@ -30,7 +34,8 @@ module Moab
     def storage_trunk
       unless defined?(@storage_trunk)
         raise(MoabRuntimeError, "Moab::Config.storage_trunk not found in config file") if Moab::Config.storage_trunk.nil?
-        @storage_trunk  = Moab::Config.storage_trunk
+
+        @storage_trunk = Moab::Config.storage_trunk
       end
       @storage_trunk
     end
@@ -50,7 +55,7 @@ module Moab
       unless defined?(@deposit_trunk)
         # do not raise error.  this parameter will be ignored if missing
         # raise "Moab::Config.deposit_trunk not found in config file" if Moab::Config.deposit_trunk.nil?
-        @deposit_trunk  = Moab::Config.deposit_trunk
+        @deposit_trunk = Moab::Config.deposit_trunk
       end
       @deposit_trunk
     end
@@ -71,6 +76,7 @@ module Moab
       storage_roots.each do |root|
         root_trunk = root.join(storage_trunk)
         raise(MoabRuntimeError, "Storage area not found at #{root_trunk}") unless root_trunk.exist?
+
         root_trunk_branch = root_trunk.join(branch)
         return root if root_trunk_branch.exist?
       end
@@ -80,6 +86,7 @@ module Moab
         storage_roots.each do |root|
           root_trunk = root.join(deposit_trunk)
           raise(MoabRuntimeError, "Deposit area not found at #{root_trunk}") unless root_trunk.exist?
+
           root_trunk_branch = root_trunk.join(branch)
           return root if root_trunk_branch.exist?
         end
@@ -93,10 +100,35 @@ module Moab
     # @return [StorageObject] The representation of a digitial object's  storage directory, which might not exist yet.
     def find_storage_object(object_id, include_deposit = false)
       root = find_storage_root(object_id, include_deposit)
-      storage_pathname = root.join(storage_trunk, storage_branch(object_id))
-      storage_object = StorageObject.new(object_id, storage_pathname)
-      storage_object.storage_root = root
-      storage_object
+      create_storage_object(object_id, root)
+    end
+
+    # @param object_id [String] The identifier of the digital object
+    # @param include_deposit [Boolean] specifies whether to look in deposit areas for objects in process of initial ingest
+    # @return [Array<StorageObject>] Representations of a digitial object's storage directories, or an empty array if none found.
+    def search_storage_objects(object_id, include_deposit = false)
+      storage_objects = []
+      # Search for the object's home directory in the storage areas
+      branch = storage_branch(object_id)
+      storage_roots.each do |root|
+        root_trunk = root.join(storage_trunk)
+        raise(MoabRuntimeError, "Storage area not found at #{root_trunk}") unless root_trunk.exist?
+
+        root_trunk_branch = root_trunk.join(branch)
+        storage_objects << create_storage_object(object_id, root) if root_trunk_branch.exist?
+      end
+      # Search for the object's directory in the deposit areas
+      if include_deposit && deposit_trunk
+        branch = deposit_branch(object_id)
+        storage_roots.each do |root|
+          root_trunk = root.join(deposit_trunk)
+          raise(MoabRuntimeError, "Deposit area not found at #{root_trunk}") unless root_trunk.exist?
+
+          root_trunk_branch = root_trunk.join(branch)
+          storage_objects << create_storage_object(object_id, root) if root_trunk_branch.exist?
+        end
+      end
+      storage_objects
     end
 
     # @param object_id [String] The identifier of the digital object whose size is desired
@@ -118,6 +150,7 @@ module Moab
       storage_object = find_storage_object(object_id)
       unless storage_object.object_pathname.exist?
         raise ObjectNotFoundException, "No storage object found for #{object_id}" unless create
+
         storage_object.object_pathname.mkpath
       end
       storage_object
@@ -129,5 +162,14 @@ module Moab
     def store_new_object_version(druid, bag_pathname)
       storage_object(druid, create = true).ingest_bag(bag_pathname)
     end
+
+    private
+
+    def create_storage_object(object_id, root)
+      storage_pathname = root.join(storage_trunk, storage_branch(object_id))
+      storage_object = StorageObject.new(object_id, storage_pathname)
+      storage_object.storage_root = root
+      storage_object
+    end
   end
 end

data/lib/moab/storage_services.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # An interface class to support access to SDR storage via a RESTful server
   #
@@ -41,6 +43,13 @@ module Moab
       @@repository.find_storage_object(object_id, include_deposit)
     end
 
+    # @param object_id [String] The identifier of the digital object
+    # @param [Object] include_deposit
+    # @return [Array<StorageObject>] Representations of a digitial object's storage directories, or an empty array if none found.
+    def self.search_storage_objects(object_id, include_deposit = false)
+      @@repository.search_storage_objects(object_id, include_deposit)
+    end
+
     # @param object_id [String] The identifier of the digital object whose size is desired
     # @param include_deposit [Boolean] specifies whether to look in deposit areas for objects in process of initial ingest
     # @return [Integer] the size occupied on disk by the storage object, in bytes.  this is the entire moab (all versions).

data/lib/moab/utc_time.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # Timestamp conversion methods.
   class UtcTime

data/lib/moab/verification_result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # A recursive "Tree" type object for verifications
   class VerificationResult
@@ -52,10 +54,9 @@ module Moab
     # @return [Hash] The verification result serialized to a hash
     def to_hash(verbose = false, level = 0)
       hash = { 'verified' => verified }
-      if verbose || !verified
-        hash['details'] = details || subentities_to_hash(verbose, level)
-      end
+      hash['details'] = details || subentities_to_hash(verbose, level) if verbose || !verified
       return hash if level > 0
+
       { entity => hash }
     end
 

data/lib/moab/version_metadata.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # The descriptive information about a digital object's collection of versions
   #

data/lib/moab/version_metadata_entry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # The descriptive attributes of a digital object version.
   #

data/lib/moab/version_metadata_event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # A container element to record object version lifecycle events with timestamps
   #

data/lib/serializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Serializer is a module containing classes whose methods faciliate serialization
 # of data fields to various formats.  To obtain those benefits, a dependent class
 # should inherit from {Serializable} or {Manifest}

data/lib/serializer/manifest.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Serializer
   # Subclass of {Serializable} that adds methods for marshalling/unmarshalling data
   # to a persistent XML file format.

data/lib/serializer/serializable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Serializer
   # Some utility methods to faciliate serialization of data fields to Hash, JSON, or YAML shared by all subclasses.
   # This class assumes that HappyMapper is used for declaration of fields to be serialized.
@@ -21,6 +23,7 @@ module Serializer
       opts.each do |key, value|
         errmsg = "#{key} is not a variable name in #{self.class.name}"
         raise(Moab::MoabRuntimeError, errmsg) unless variable_names.include?(key.to_s) || key == :test
+
         instance_variable_set("@#{key}", value)
       end
     end
@@ -68,6 +71,7 @@ module Serializer
     # @return [String] For the current object instance, return the string to use as a hash key
     def key
       return send(key_name) if key_name
+
       nil
     end
 
@@ -117,6 +121,7 @@ module Serializer
     # @return [Hash] Generate a hash containing the differences between two objects of the same type
     def diff(other)
       raise(Moab::MoabRuntimeError, "Cannot compare different classes") if self.class != other.class
+
       left = other.to_hash
       right = to_hash
       if key.nil? || other.key.nil?

data/lib/stanford/active_fedora_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stanford
   # Utility Class for extracting content or other information from a Fedora Instance
   #

data/lib/stanford/content_inventory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stanford
   # Stanford-specific utility methods for transforming contentMetadata to versionInventory and doing comparisons
   #
@@ -127,6 +129,7 @@ module Stanford
     def validate_content_metadata(content_metadata)
       result = validate_content_metadata_details(content_metadata)
       raise Moab::InvalidMetadataException, result[0] + " ..." unless result.empty?
+
       true
     end
 
@@ -176,6 +179,7 @@ module Stanford
     def remediate_content_metadata(content_metadata, content_group)
       return nil if content_metadata.nil?
       return content_metadata if content_group.nil? || content_group.files.empty?
+
       signature_for_path = content_group.path_hash
       @type_for_name = Moab::FileSignature.checksum_type_for_name
       @names_for_type = Moab::FileSignature.checksum_names_for_type

data/lib/stanford/dor_metadata.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stanford
   # Stanford-specific utility methods for interfacing with DOR metadata files
   #

data/lib/stanford/moab_storage_directory.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'find'
 
 module Stanford
   ##
   # methods for dealing with a directory which stores Moab objects
   class MoabStorageDirectory
-    DRUID_TREE_REGEXP = '[[:lower:]]{2}/\\d{3}/[[:lower:]]{2}/\\d{4}'.freeze
-    DRUID_REGEXP = '[[:lower:]]{2}\\d{3}[[:lower:]]{2}\\d{4}'.freeze
+    DRUID_TREE_REGEXP = '[[:lower:]]{2}/\\d{3}/[[:lower:]]{2}/\\d{4}'
+    DRUID_REGEXP = '[[:lower:]]{2}\\d{3}[[:lower:]]{2}\\d{4}'
 
     def self.find_moab_paths(storage_dir)
       Find.find(storage_dir) do |path|

data/lib/stanford/storage_object_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stanford
   # druids are Stanford specific entities
   class StorageObjectValidator < Moab::StorageObjectValidator

data/lib/stanford/storage_repository.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'druid-tools'
 
 module Stanford
@@ -32,9 +34,11 @@ module Stanford
       # Note: this seems an odd place to do druid validation, but leaving it here for now
       syntax_msg = "Identifier has invalid suri syntax: #{object_id}"
       raise(Moab::InvalidSuriSyntaxError, syntax_msg + " nil or empty") if object_id.to_s.empty?
+
       identifier = object_id.split(':')[-1]
       raise(Moab::InvalidSuriSyntaxError, syntax_msg) if identifier.to_s.empty?
       raise(Moab::InvalidSuriSyntaxError, syntax_msg) unless DruidTools::Druid.valid?(identifier, true)
+
       DruidTools::Druid.new(identifier, true).tree.join(File::SEPARATOR)
     end
   end

data/lib/stanford/storage_services.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stanford
   # An interface class to support access to SDR storage via a RESTful server
   class StorageServices < Moab::StorageServices

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moab-versioning
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Darren Weber
@@ -11,24 +11,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2020-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: confstruct
+  name: druid-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -42,7 +42,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri-happymapper
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -56,7 +56,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: nokogiri-happymapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,21 +70,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: druid-tools
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: equivalent-xml
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -98,7 +84,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -112,7 +98,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -126,7 +112,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -140,7 +126,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -159,28 +145,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.79.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.79.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.37.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.37.1
 description: Contains classes to process digital object version content and metadata
 email:
 - darren.weber@stanford.edu
@@ -237,7 +223,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="