moab-versioning 4.3.0 → 5.0.0.beta1

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
@@ -44,19 +46,19 @@ module Moab
 
     # @attribute
     # @return [Integer] The size of the file in bytes
-    attribute :size, Integer, :on_save => proc { |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 { |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 { |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 { |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 },
@@ -83,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
@@ -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})
@@ -37,20 +39,20 @@ module Moab
 
     # @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 { |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)
@@ -62,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 { |t| t.to_s }
+    attribute :file_count, Integer, tag: 'fileCount', on_save: proc { |t| t.to_s }
 
     def file_count
       entries.size
@@ -70,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 { |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 }
@@ -78,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 { |t| t.to_s }
+    attribute :block_count, Integer, tag: 'blockCount', on_save: proc { |t| t.to_s }
 
     def block_count
       block_size = 1024
@@ -92,7 +94,7 @@ module Moab
 
     # @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|
@@ -176,14 +178,12 @@ 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.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)
@@ -23,19 +25,19 @@ module Moab
 
     # @attribute
     # @return [Integer] The ordinal version number
-    attribute :version_id, Integer, :tag => 'originalVersion', :key => true, :on_save => proc { |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,19 +1,11 @@
+# frozen_string_literal: true
+
 require 'moab'
 require 'stanford/content_inventory'
-require 'stanford/dor_metadata'
 require 'stanford/storage_repository'
 require 'stanford/storage_services'
-require 'stanford/active_fedora_object'
-require 'stanford/moab_storage_directory'
 require 'stanford/storage_object_validator'
 
 # Stanford is a module that isolates classes specific to the Stanford Digital Repository
-#
-# ====Data Model
-# * <b>{DorMetadata} = utility methods for interfacing with Stanford metadata files (esp contentMetadata)</b>
-#   * {ActiveFedoraObject} [1..*] = utility for extracting content or other information from a Fedora Instance
-#
-# @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 Stanford
 end

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
@@ -82,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)
@@ -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,9 +130,10 @@ 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+)$/
+        list << vnum[1..].to_i if vnum =~ /^v(\d+)$/
       end
       list.sort
     end
@@ -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
@@ -83,13 +85,14 @@ module Moab
     end
 
     def version_dir_format?(dirname)
-      dirname =~ /^[v]\d{4}$/
+      dirname =~ /^v\d{4}$/
     end
 
     # call only if the version directories are "correctly named" vdddd
     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
+        next if dir_name[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
@@ -43,7 +45,7 @@ module Moab
 
     # @return [String] The unique identifier concatenating digital object id with version id
     def composite_key
-      @storage_object.digital_object_id + '-' + StorageObject.version_dirname(@version_id)
+      "#{@storage_object.digital_object_id}-#{StorageObject.version_dirname(@version_id)}"
     end
 
     # @return [Boolean] true if the object version directory exists
@@ -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,14 +112,15 @@ 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) }
+        groups = %w[content metadata].collect { |id| FileGroup.new(group_id: id) }
         FileInventory.new(
-          :type => 'version',
-          :digital_object_id => @storage_object.digital_object_id,
-          :version_id => @version_id,
-          :groups => groups
+          type: 'version',
+          digital_object_id: @storage_object.digital_object_id,
+          version_id: @version_id,
+          groups: groups
         )
       end
     end
@@ -127,7 +131,7 @@ module Moab
       if version_id > 0
         SignatureCatalog.read_xml_file(@version_pathname.join('manifests'))
       else
-        SignatureCatalog.new(:digital_object_id => @storage_object.digital_object_id)
+        SignatureCatalog.new(digital_object_id: @storage_object.digital_object_id)
       end
     end
 
@@ -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?
@@ -196,12 +202,12 @@ module Moab
     # @return [void] examine the version's directory and create/serialize a {FileInventory} containing the manifest files
     def generate_manifest_inventory
       manifest_inventory = FileInventory.new(
-        :type => 'manifests',
-        :digital_object_id => @storage_object.digital_object_id,
-        :version_id => @version_id
+        type: 'manifests',
+        digital_object_id: @storage_object.digital_object_id,
+        version_id: @version_id
       )
       pathname = @version_pathname.join('manifests')
-      manifest_inventory.groups << FileGroup.new(:group_id => 'manifests').group_from_directory(pathname, false)
+      manifest_inventory.groups << FileGroup.new(group_id: 'manifests').group_from_directory(pathname, false)
       manifest_inventory.write_xml_file(pathname)
     end
 
@@ -306,7 +312,7 @@ module Moab
       version_additions = file_inventory('additions')
       result.subentities << VerificationResult.verify_value('composite_key', composite_key, version_additions.composite_key)
       data_directory = @version_pathname.join('data')
-      directory_inventory = FileInventory.new(:type => 'directory').inventory_from_directory(data_directory)
+      directory_inventory = FileInventory.new(type: 'directory').inventory_from_directory(data_directory)
       diff = FileInventoryDifference.new
       diff.compare(version_additions, directory_inventory)
       compare_result = VerificationResult.new('file_differences')
@@ -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
@@ -127,7 +160,16 @@ module Moab
     # @param druid [String] The object identifier
     # @return [void] transfer the object to the preservation repository
     def store_new_object_version(druid, bag_pathname)
-      storage_object(druid, create = true).ingest_bag(bag_pathname)
+      storage_object(druid, 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).
@@ -74,12 +83,6 @@ module Moab
       @@repository.storage_object(object_id).current_version_id
     end
 
-    # @param [String] object_id The digital object identifier of the object
-    # @return [Pathname] Pathname object containing the full path for the specified file
-    def self.version_metadata(object_id)
-      retrieve_file('metadata', 'versionMetadata.xml', object_id)
-    end
-
     # @param [String] object_id The digital object identifier of the object
     # @param [Integer] version_id The ID of the version, if nil use latest version
     # @return [FileInventory] the file inventory for the specified object version
@@ -101,7 +104,7 @@ module Moab
     # @return [Pathname] Pathname object containing the full path for the specified file
     def self.retrieve_file(file_category, file_id, object_id, version_id = nil)
       storage_object_version = @@repository.storage_object(object_id).find_object_version(version_id)
-      file_pathname = storage_object_version.find_filepath(file_category, file_id)
+      storage_object_version.find_filepath(file_category, file_id)
     end
 
     # @param [String] file_category The category of file ('content', 'metdata', or 'manifest')
@@ -111,7 +114,7 @@ module Moab
     # @return [Pathname] Pathname object containing the full path for the specified file
     def self.retrieve_file_using_signature(file_category, file_signature, object_id, version_id = nil)
       storage_object_version = @@repository.storage_object(object_id).find_object_version(version_id)
-      file_pathname = storage_object_version.find_filepath_using_signature(file_category, file_signature)
+      storage_object_version.find_filepath_using_signature(file_category, file_signature)
     end
 
     # @param [String] file_category The category of file ('content', 'metdata', or 'manifest')
@@ -121,7 +124,7 @@ module Moab
     # @return [FileSignature] The signature of the file
     def self.retrieve_file_signature(file_category, file_id, object_id, version_id = nil)
       storage_object_version = @@repository.storage_object(object_id).find_object_version(version_id)
-      file_pathname = storage_object_version.find_signature(file_category, file_id)
+      storage_object_version.find_signature(file_category, file_id)
     end
 
     # @param [String] object_id The digital object identifier of the object

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