moab-versioning 4.2.1 → 4.4.2

data/lib/moab/storage_services.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # An interface class to support access to SDR storage via a RESTful server
@@ -43,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).
@@ -79,7 +86,7 @@ module Moab
     # @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)
-      self.retrieve_file('metadata', 'versionMetadata.xml', object_id)
+      retrieve_file('metadata', 'versionMetadata.xml', object_id)
     end
 
     # @param [String] object_id The digital object identifier of the object
@@ -87,11 +94,11 @@ module Moab
     # @return [FileInventory] the file inventory for the specified object version
     def self.retrieve_file_group(file_category, object_id, version_id = nil)
       storage_object_version = @@repository.storage_object(object_id).find_object_version(version_id)
-      if file_category =~ /manifest/
-        inventory_type = file_category = 'manifests'
-      else
-        inventory_type = 'version'
-      end
+      inventory_type = if file_category =~ /manifest/
+                         file_category = 'manifests'
+                       else
+                         'version'
+                       end
       inventory = storage_object_version.file_inventory(inventory_type)
       inventory.group(file_category)
     end
@@ -103,7 +110,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')
@@ -113,7 +120,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')
@@ -123,7 +130,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,4 +1,4 @@
-require 'time'
+# frozen_string_literal: true
 
 module Moab
   # Timestamp conversion methods.
@@ -16,7 +16,7 @@ module Moab
       when Time
         datetime
       else
-        raise "unknown time format #{datetime.inspect}"
+        raise(MoabRuntimeError, "unknown time format #{datetime.inspect}")
       end
     end
 
@@ -31,7 +31,7 @@ module Moab
       when Time
         datetime.utc.iso8601
       else
-        raise "unknown time format #{datetime.inspect}"
+        raise(MoabRuntimeError, "unknown time format #{datetime.inspect}")
       end
     end
   end

data/lib/moab/verification_result.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # A recursive "Tree" type object for verifications
@@ -54,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,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # The descriptive information about a digital object's collection of versions
@@ -19,16 +19,16 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @versions = Array.new
+      @versions = []
       super(opts)
     end
 
     # @attribute
     # @return [String] The digital object identifier
-    attribute :digital_object_id, String, :tag => 'objectId'
+    attribute :digital_object_id, String, tag: 'objectId'
 
     # @attribute
     # @return [Array<VersionMetadataEntry>] An array of version metadata entries, one per version
-    has_many :versions, VersionMetadataEntry, :tag => 'version'
+    has_many :versions, VersionMetadataEntry, tag: 'version'
   end
 end

data/lib/moab/version_metadata_entry.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# frozen_string_literal: true
 
 module Moab
   # The descriptive attributes of a digital object version.
@@ -18,13 +18,13 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @events = Array.new
+      @events = []
       super(opts)
     end
 
     # @attribute
     # @return [Integer] The object version number (A sequential integer)
-    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 }
 
     # @attribute
     # @return [String] "an external version label that increments the most significant digit for major revisions,
@@ -46,14 +46,14 @@ module Moab
 
     # @attribute
     # @return [FileGroupDifference] Summary of content file differences since previous version
-    element :content_changes, FileGroupDifference, :tag => 'fileGroupDifference'
+    element :content_changes, FileGroupDifference, tag: 'fileGroupDifference'
 
     # @attribute
     # @return [FileGroupDifference]   Summary of metadata file differences since previous version
-    element :metadata_changes, FileGroupDifference, :tag => 'fileGroupDifference'
+    element :metadata_changes, FileGroupDifference, tag: 'fileGroupDifference'
 
     # @attribute
     # @return [Array<VersionMetadataEvent>] Array of events with timestamps that track lifecycle stages
-    has_many :events, VersionMetadataEvent, :tag => 'event'
+    has_many :events, VersionMetadataEvent, tag: 'event'
   end
 end

data/lib/moab/version_metadata_event.rb

@@ -1,4 +1,4 @@
-require 'moab'
+# 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.
@@ -19,8 +21,8 @@ module Serializer
       if filename
         filename
       else
-        cname = self.name.split(/::/).last
-        cname[0, 1].downcase + cname[1..-1] + '.xml'
+        cname = name.split(/::/).last
+        "#{cname[0, 1].downcase}#{cname[1..]}.xml"
       end
     end
 
@@ -29,7 +31,7 @@ module Serializer
     # @param filename [String] Optional filename if one wishes to override the default filename
     # @return [Pathname] The location of the xml file
     def self.xml_pathname(parent_dir, filename = nil)
-      Pathname.new(parent_dir).join(self.xml_filename(filename))
+      Pathname.new(parent_dir).join(xml_filename(filename))
     end
 
     # @api external
@@ -37,7 +39,7 @@ module Serializer
     # @param filename [String] Optional filename if one wishes to override the default filename
     # @return [Boolean] Returns true if the xml file exists
     def self.xml_pathname_exist?(parent_dir, filename = nil)
-      self.xml_pathname(parent_dir, filename).exist?
+      xml_pathname(parent_dir, filename).exist?
     end
 
     # @api external
@@ -46,7 +48,7 @@ module Serializer
     # @return [Serializable] Read the xml file and return the parsed XML
     # @example {include:file:spec/features/serializer/read_xml_spec.rb}
     def self.read_xml_file(parent_dir, filename = nil)
-      self.parse(self.xml_pathname(parent_dir, filename).read)
+      parse(xml_pathname(parent_dir, filename).read)
     end
 
     # @api external
@@ -56,8 +58,8 @@ module Serializer
     # @return [void] Serializize the in-memory object to a xml file instance
     def self.write_xml_file(xml_object, parent_dir, filename = nil)
       parent_dir.mkpath
-      self.xml_pathname(parent_dir, filename).open('w') do |f|
-        xmlBuilder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8')
+      xml_pathname(parent_dir, filename).open('w') do |f|
+        xmlBuilder = Nokogiri::XML::Builder.new(encoding: 'UTF-8')
         xmlBuilder = xml_object.to_xml(xmlBuilder)
         f << xmlBuilder.to_xml
       end

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.
@@ -19,11 +21,10 @@ module Serializer
     #   The symbols should correspond to attributes declared using HappyMapper syntax
     def initialize(opts = {})
       opts.each do |key, value|
-        if variable_names.include?(key.to_s) || key == :test
-          instance_variable_set("@#{key}", value)
-        else
-          raise "#{key} is not a variable name in #{self.class.name}"
-        end
+        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
 
@@ -45,7 +46,7 @@ module Serializer
     # @api internal
     # @return [Array] Extract the names of the variables
     def variable_names
-      variables.collect { |variable| variable.name }
+      variables.collect(&:name)
     end
 
     # @api internal
@@ -54,7 +55,7 @@ module Serializer
     #   This follows the same convention as used by DataMapper
     # @see http://datamapper.org/docs/properties.html
     def key_name
-      if not defined?(@key_name)
+      unless defined?(@key_name)
         @key_name = nil
         self.class.attributes.each do |attribute|
           if attribute.options[:key]
@@ -69,7 +70,8 @@ module Serializer
     # @api internal
     # @return [String] For the current object instance, return the string to use as a hash key
     def key
-      return self.send(key_name) if key_name
+      return send(key_name) if key_name
+
       nil
     end
 
@@ -79,10 +81,10 @@ module Serializer
     #   If the array member has a field tagged as a key, that field will be used as the hash.key.
     #   Otherwise the index position of the array member will be used as the key
     def array_to_hash(array, summary = false)
-      item_hash = Hash.new
+      item_hash = {}
       array.each_index do |index|
         item = array[index]
-        ikey = (item.respond_to?(:key) && item.key) ? item.key : index
+        ikey = item.respond_to?(:key) && item.key ? item.key : index
         item_hash[ikey] = item.respond_to?(:to_hash) ? item.to_hash(summary) : item
       end
       item_hash
@@ -92,41 +94,42 @@ module Serializer
     # @return [Hash] Recursively generate an Hash containing the object's properties
     # @param summary [Boolean] Controls the depth and detail of recursion
     def to_hash(summary = false)
-      oh = Hash.new
+      oh = {}
       vars = summary ? variables.select { |v| summary_fields.include?(v.name) } : variables
       vars.each do |variable|
         key = variable.name.to_s
-        value = self.send(variable.name)
-        case value
-        when Array
-          oh[key] = array_to_hash(value, summary)
-        when Serializable
-          oh[key] = value.to_hash
-        else
-          oh[key] = value
-        end
+        value = send(variable.name)
+        oh[key] = case value
+                  when Array
+                    array_to_hash(value, summary)
+                  when Serializable
+                    value.to_hash
+                  else
+                    value
+                  end
       end
       oh
     end
 
     # @return [Hash] Calls to_hash(summary=true)
     def summary
-      self.to_hash(summary = true)
+      to_hash(true)
     end
 
     # @api internal
     # @param other [Serializable] The other object being compared
     # @return [Hash] Generate a hash containing the differences between two objects of the same type
     def diff(other)
-      raise "Cannot compare different classes" if self.class != other.class
+      raise(Moab::MoabRuntimeError, "Cannot compare different classes") if self.class != other.class
+
       left = other.to_hash
-      right = self.to_hash
-      if self.key.nil? or other.key.nil?
+      right = to_hash
+      if key.nil? || other.key.nil?
         ltag = :old
         rtag = :new
       else
         ltag = other.key
-        rtag = self.key
+        rtag = key
       end
       Serializable.deep_diff(ltag, left, rtag, right)
     end
@@ -136,23 +139,26 @@ module Serializer
     # @return [Hash] Generate a hash containing the differences between two hashes
     #   (recursively descend parallel trees of hashes)
     # @see https://gist.github.com/146844
-    def Serializable.deep_diff(*hashes)
-      diff = Hash.new
+    def self.deep_diff(*hashes)
+      diff = {}
       case hashes.length
       when 4
         ltag, left, rtag, right = hashes
       when 2
-        ltag, left, rtag, right = :left, hashes[0], :right, hashes[1]
+        ltag = :left
+        left = hashes[0]
+        rtag = :right
+        right = hashes[1]
       else
         raise ArgumentError, "wrong number of arguments (#{hashes.length} for 2 or 4)"
       end
       (left.keys | right.keys).each do |k|
         if left[k] != right[k]
-          if left[k].is_a?(Hash) && right[k].is_a?(Hash)
-            diff[k] = deep_diff(ltag, left[k], rtag, right[k])
-          else
-            diff[k] = Hash.[](ltag, left[k], rtag, right[k])
-          end
+          diff[k] = if left[k].is_a?(Hash) && right[k].is_a?(Hash)
+                      deep_diff(ltag, left[k], rtag, right[k])
+                    else
+                      Hash.[](ltag, left[k], rtag, right[k])
+                    end
         end
       end
       diff
@@ -161,14 +167,14 @@ module Serializer
     # @api internal
     # @return [String] Generate JSON output from a hash of the object's variables
     def to_json(summary = false)
-      hash = self.to_hash(summary)
+      hash = to_hash(summary)
       JSON.pretty_generate(hash)
     end
 
     # @api internal
     # @return [String] Generate YAML output from a hash of the object's variables
     def to_yaml(summary = false)
-      self.to_hash(summary).to_yaml
+      to_hash(summary).to_yaml
     end
   end
 end

data/lib/stanford/active_fedora_object.rb

@@ -1,4 +1,4 @@
-require 'moab/stanford'
+# 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,4 +1,4 @@
-require 'moab/stanford'
+# frozen_string_literal: true
 
 module Stanford
   # Stanford-specific utility methods for transforming contentMetadata to versionInventory and doing comparisons
@@ -23,7 +23,7 @@ module Stanford
       # Many of these objects have contentMetadata with no child elements, such as this:
       #    <contentMetadata objectId="bd608mj3166" type="file"/>
       # but there are also objects that have no datasteam of this name at all
-      cm_inventory = Moab::FileInventory.new(:type => "version", :digital_object_id => object_id, :version_id => version_id)
+      cm_inventory = Moab::FileInventory.new(type: "version", digital_object_id: object_id, version_id: version_id)
       content_group = group_from_cm(content_metadata, subset)
       cm_inventory.groups << content_group
       cm_inventory
@@ -47,9 +47,9 @@ module Stanford
                 when 'all'
                   ng_doc.xpath("//file")
                 else
-                  raise "Unknown disposition subset (#{subset})"
+                  raise(Moab::MoabRuntimeError, "Unknown disposition subset (#{subset})")
                 end
-      content_group = Moab::FileGroup.new(:group_id => 'content', :data_source => "contentMetadata-#{subset}")
+      content_group = Moab::FileGroup.new(group_id: 'content', data_source: "contentMetadata-#{subset}")
       nodeset.each do |file_node|
         signature = generate_signature(file_node)
         instance = generate_instance(file_node)
@@ -62,7 +62,7 @@ module Stanford
     # @param node [Nokogiri::XML::Node] The XML node containing file information
     # @return [FileSignature] The {FileSignature} object generated from the XML data
     def generate_signature(node)
-      signature = Moab::FileSignature.new()
+      signature = Moab::FileSignature.new
       signature.size = node.attributes['size'].content
       checksum_nodes = node.xpath('checksum')
       checksum_nodes.each do |checksum_node|
@@ -82,9 +82,13 @@ module Stanford
     # @param node (see #generate_signature)
     # @return [FileInstance] The {FileInstance} object generated from the XML data
     def generate_instance(node)
-      instance = Moab::FileInstance.new()
+      instance = Moab::FileInstance.new
       instance.path = node.attributes['id'].content
-      instance.datetime = node.attributes['datetime'].content rescue nil
+      instance.datetime = begin
+        node.attributes['datetime'].content
+      rescue
+        nil
+      end
       instance
     end
 
@@ -94,28 +98,28 @@ module Stanford
     # @example {include:file:spec/features/stanford/content_metadata_write_spec.rb}
     def generate_content_metadata(file_group, object_id, version_id)
       cm = Nokogiri::XML::Builder.new do |xml|
-        xml.contentMetadata(:type => "sample", :objectId => object_id) {
-          xml.resource(:type => "version", :sequence => "1", :id => "version-#{version_id}") {
+        xml.contentMetadata(type: "sample", objectId: object_id) do
+          xml.resource(type: "version", sequence: "1", id: "version-#{version_id}") do
             file_group.files.each do |file_manifestation|
               signature = file_manifestation.signature
               file_manifestation.instances.each do |instance|
                 xml.file(
-                  :id => instance.path,
-                  :size => signature.size,
-                  :datetime => instance.datetime,
-                  :shelve => 'yes',
-                  :publish => 'yes',
-                  :preserve => 'yes'
-                ) {
+                  id: instance.path,
+                  size: signature.size,
+                  datetime: instance.datetime,
+                  shelve: 'yes',
+                  publish: 'yes',
+                  preserve: 'yes'
+                ) do
                   fixity = signature.fixity
-                  xml.checksum(:type => "MD5") { xml.text signature.md5 } if fixity[:md5]
-                  xml.checksum(:type => "SHA-1") { xml.text signature.sha1 } if fixity[:sha1]
-                  xml.checksum(:type => "SHA-256") { xml.text signature.sha256 } if fixity[:sha256]
-                }
+                  xml.checksum(type: "MD5") { xml.text signature.md5 } if fixity[:md5]
+                  xml.checksum(type: "SHA-1") { xml.text signature.sha1 } if fixity[:sha1]
+                  xml.checksum(type: "SHA-256") { xml.text signature.sha256 } if fixity[:sha256]
+                end
               end
             end
-          }
-        }
+          end
+        end
       end
       cm.to_xml
     end
@@ -124,7 +128,8 @@ module Stanford
     # @return [Boolean] True if contentMetadata has essential file attributes, else raise exception
     def validate_content_metadata(content_metadata)
       result = validate_content_metadata_details(content_metadata)
-      raise Moab::InvalidMetadataException, result[0] + " ..." if result.size > 0
+      raise Moab::InvalidMetadataException, "#{result[0]} ..." unless result.empty?
+
       true
     end
 
@@ -145,7 +150,7 @@ module Stanford
         end
       nodeset = content_metadata_doc.xpath("//file")
       nodeset.each do |file_node|
-        missing = ['id', 'size', 'md5', 'sha1']
+        missing = %w[id size md5 sha1]
         missing.delete('id') if file_node.has_attribute?('id')
         missing.delete('size') if file_node.has_attribute?('size')
         checksum_nodes = file_node.xpath('checksum')
@@ -159,7 +164,7 @@ module Stanford
         end
         if missing.include?('id')
           result << "File node #{nodeset.index(file_node)} is missing #{missing.join(',')}"
-        elsif missing.size > 0
+        elsif !missing.empty?
           id = file_node['id']
           result << "File node having id='#{id}' is missing #{missing.join(',')}"
         end
@@ -173,11 +178,12 @@ module Stanford
     # @see http://blog.slashpoundbang.com/post/1454850669/how-to-pretty-print-xml-with-nokogiri
     def remediate_content_metadata(content_metadata, content_group)
       return nil if content_metadata.nil?
-      return content_metadata if content_group.nil? or content_group.files.size < 1
+      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
-      ng_doc = Nokogiri::XML(content_metadata) { |x| x.noblanks }
+      ng_doc = Nokogiri::XML(content_metadata, &:noblanks)
       nodeset = ng_doc.xpath("//file")
       nodeset.each do |file_node|
         filepath = file_node['id']
@@ -185,7 +191,7 @@ module Stanford
         remediate_file_size(file_node, signature)
         remediate_checksum_nodes(file_node, signature)
       end
-      ng_doc.to_xml(:indent => 2)
+      ng_doc.to_xml(indent: 2)
     end
 
     # @param [Nokogiri::XML::Element] file_node the File stanza being remediated
@@ -193,10 +199,10 @@ module Stanford
     # @return [void] update the file size attribute if missing, raise exception if inconsistent
     def remediate_file_size(file_node, signature)
       file_size = file_node['size']
-      if file_size.nil? or file_size.empty?
+      if file_size.nil? || file_size.empty?
         file_node['size'] = signature.size.to_s
       elsif file_size != signature.size.to_s
-        raise "Inconsistent size for #{file_node['id']}: #{file_size} != #{signature.size}"
+        raise(Moab::MoabRuntimeError, "Inconsistent size for #{file_node['id']}: #{file_size} != #{signature.size}")
       end
     end
 
@@ -205,14 +211,14 @@ module Stanford
     # @return [void] update the file's checksum elements if data missing, raise exception if inconsistent
     def remediate_checksum_nodes(file_node, signature)
       # collect <checksum> elements for checksum types that are already present
-      checksum_nodes = Hash.new
+      checksum_nodes = {}
       file_node.xpath('checksum').each do |checksum_node|
         type = @type_for_name[checksum_node['type']]
         checksum_nodes[type] = checksum_node
       end
       # add new <checksum> elements for the other checksum types that were missing
       @names_for_type.each do |type, names|
-        unless checksum_nodes.has_key?(type)
+        unless checksum_nodes.key?(type)
           checksum_node = Nokogiri::XML::Element.new('checksum', file_node.document)
           checksum_node['type'] = names[0]
           file_node << checksum_node
@@ -223,10 +229,10 @@ module Stanford
       checksum_nodes.each do |type, checksum_node|
         cm_checksum = checksum_node.content
         sig_checksum = signature.checksums[type]
-        if cm_checksum.nil? or cm_checksum.empty?
+        if cm_checksum.nil? || cm_checksum.empty?
           checksum_node.content = sig_checksum
         elsif cm_checksum != sig_checksum
-          raise "Inconsistent #{type} for #{file_node['id']}: #{cm_checksum} != #{sig_checksum}"
+          raise(Moab::MoabRuntimeError, "Inconsistent #{type} for #{file_node['id']}: #{cm_checksum} != #{sig_checksum}")
         end
       end
     end