moab-versioning 4.2.1 → 4.2.2

data/lib/moab/storage_object_version.rb

@@ -1,5 +1,3 @@
-require 'moab'
-
 module Moab
   # A class to represent a version subdirectory within an object's home directory in preservation storage
   # ====Data Model
@@ -32,7 +30,7 @@ module Moab
     def initialize(storage_object, version_id)
       if version_id.is_a?(Integer)
         @version_id = version_id
-      elsif version_id.is_a?(String) and version_id =~ /^v(\d+)$/
+      elsif version_id.is_a?(String) && version_id =~ /^v(\d+)$/
         @version_id = version_id.sub(/^v/, '').to_i
       else
         raise "version_id (#{version_id}) is not in a recognized format"
@@ -40,7 +38,7 @@ module Moab
       @version_name = StorageObject.version_dirname(@version_id)
       @version_pathname = storage_object.object_pathname.join(@version_name)
       @storage_object = storage_object
-      @inventory_cache = Hash.new
+      @inventory_cache = {}
     end
 
     # @return [String] The unique identifier concatenating digital object id with version id
@@ -110,10 +108,10 @@ module Moab
     # @see FileInventory#read_xml_file
     def file_inventory(type)
       if version_id > 0
-        return @inventory_cache[type] if @inventory_cache.has_key?(type)
+        return @inventory_cache[type] if @inventory_cache.key?(type)
         @inventory_cache[type] = FileInventory.read_xml_file(@version_pathname.join('manifests'), type)
       else
-        groups = ['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,
@@ -208,12 +206,12 @@ module Moab
     end
 
     # @return [VerificationResult] return result of testing correctness of version manifests
-    def verify_version_storage()
-      result = VerificationResult.new(self.composite_key)
-      result.subentities << self.verify_manifest_inventory
-      result.subentities << self.verify_version_inventory
-      result.subentities << self.verify_version_additions
-      result.verified = result.subentities.all? { |entity| entity.verified }
+    def verify_version_storage
+      result = VerificationResult.new(composite_key)
+      result.subentities << verify_manifest_inventory
+      result.subentities << verify_version_inventory
+      result.subentities << verify_version_additions
+      result.verified = result.subentities.all?(&:verified)
       result
     end
 
@@ -221,8 +219,8 @@ module Moab
     def verify_manifest_inventory
       # read/parse manifestInventory.xml
       result = VerificationResult.new("manifest_inventory")
-      manifest_inventory = self.file_inventory('manifests')
-      result.subentities << VerificationResult.verify_value('composite_key', self.composite_key, manifest_inventory.composite_key)
+      manifest_inventory = file_inventory('manifests')
+      result.subentities << VerificationResult.verify_value('composite_key', composite_key, manifest_inventory.composite_key)
       result.subentities << VerificationResult.verify_truth('manifests_group', !manifest_inventory.group_empty?('manifests'))
       # measure the manifest signatures of the files in the directory (excluding manifestInventory.xml)
       directory_inventory = FileInventory.new.inventory_from_directory(@version_pathname.join('manifests'), 'manifests')
@@ -236,7 +234,7 @@ module Moab
       compare_result.verified = (diff.difference_count == 0)
       compare_result.details = diff.differences_detail
       result.subentities << compare_result
-      result.verified = result.subentities.all? { |entity| entity.verified }
+      result.verified = result.subentities.all?(&:verified)
       result
     end
 
@@ -244,10 +242,10 @@ module Moab
     def verify_signature_catalog
       result = VerificationResult.new("signature_catalog")
       signature_catalog = self.signature_catalog
-      result.subentities << VerificationResult.verify_value('signature_key', self.composite_key, signature_catalog.composite_key)
+      result.subentities << VerificationResult.verify_value('signature_key', composite_key, signature_catalog.composite_key)
       found = 0
-      missing = Array.new
-      object_pathname = self.storage_object.object_pathname
+      missing = []
+      object_pathname = storage_object.object_pathname
       signature_catalog.entries.each do |catalog_entry|
         storage_location = object_pathname.join(catalog_entry.storage_path)
         if storage_location.exist?
@@ -264,19 +262,19 @@ module Moab
       }
       file_result.details['missing'] = missing unless missing.empty?
       result.subentities << file_result
-      result.verified = result.subentities.all? { |entity| entity.verified }
+      result.verified = result.subentities.all?(&:verified)
       result
     end
 
     # @return [Boolean] true if files & signatures listed in version inventory can all be found
     def verify_version_inventory
       result = VerificationResult.new("version_inventory")
-      version_inventory = self.file_inventory('version')
-      result.subentities << VerificationResult.verify_value('inventory_key', self.composite_key, version_inventory.composite_key)
+      version_inventory = file_inventory('version')
+      result.subentities << VerificationResult.verify_value('inventory_key', composite_key, version_inventory.composite_key)
       signature_catalog = self.signature_catalog
-      result.subentities << VerificationResult.verify_value('signature_key', self.composite_key, signature_catalog.composite_key)
+      result.subentities << VerificationResult.verify_value('signature_key', composite_key, signature_catalog.composite_key)
       found = 0
-      missing = Array.new
+      missing = []
       version_inventory.groups.each do |group|
         group.files.each do |file|
           file.instances.each do |instance|
@@ -298,15 +296,15 @@ module Moab
       }
       file_result.details['missing'] = missing unless missing.empty?
       result.subentities << file_result
-      result.verified = result.subentities.all? { |entity| entity.verified }
+      result.verified = result.subentities.all?(&:verified)
       result
     end
 
     # @return [Boolean] returns true if files in data folder match files listed in version addtions inventory
     def verify_version_additions
       result = VerificationResult.new("version_additions")
-      version_additions = self.file_inventory('additions')
-      result.subentities << VerificationResult.verify_value('composite_key', self.composite_key, version_additions.composite_key)
+      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)
       diff = FileInventoryDifference.new
@@ -315,7 +313,7 @@ module Moab
       compare_result.verified = (diff.difference_count == 0)
       compare_result.details = diff.differences_detail
       result.subentities << compare_result
-      result.verified = result.subentities.all? { |entity| entity.verified }
+      result.verified = result.subentities.all?(&:verified)
       result
     end
 

data/lib/moab/storage_repository.rb

@@ -1,5 +1,3 @@
-require 'moab'
-
 module Moab
   # A class to represent the SDR repository store
   #
@@ -58,9 +56,9 @@ module Moab
     end
 
     # @param object_id [String] The identifier of the digital object
-    # @return [Pathname] The branch segment of the object deposit path
+    # @return [String] The branch segment of the object deposit path
+    # @note Override this method in a subclass
     def deposit_branch(object_id)
-       #todo This method should be customized, or overridden in a subclass
       object_id
     end
 
@@ -77,7 +75,7 @@ module Moab
         return root if root_trunk_branch.exist?
       end
       # Search for the object's directory in the deposit areas
-      if include_deposit and deposit_trunk
+      if include_deposit && deposit_trunk
         branch = deposit_branch(object_id)
         storage_roots.each do |root|
           root_trunk = root.join(deposit_trunk)
@@ -119,11 +117,8 @@ module Moab
     def storage_object(object_id, create = false)
       storage_object = find_storage_object(object_id)
       unless storage_object.object_pathname.exist?
-        if create
-          storage_object.object_pathname.mkpath
-        else
-          raise Moab::ObjectNotFoundException, "No storage object found for #{object_id}"
-        end
+        raise Moab::ObjectNotFoundException, "No storage object found for #{object_id}" unless create
+        storage_object.object_pathname.mkpath
       end
       storage_object
     end
@@ -132,9 +127,7 @@ 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 = self.storage_object(druid, create = true)
-      new_version = storage_object.ingest_bag(bag_pathname)
-      new_version
+      storage_object(druid, create = true).ingest_bag(bag_pathname)
     end
   end
 end

data/lib/moab/storage_services.rb

@@ -1,5 +1,3 @@
-require 'moab'
-
 module Moab
   # An interface class to support access to SDR storage via a RESTful server
   #
@@ -79,7 +77,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 +85,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

data/lib/moab/utc_time.rb

@@ -1,5 +1,3 @@
-require 'time'
-
 module Moab
   # Timestamp conversion methods.
   class UtcTime

data/lib/moab/verification_result.rb

@@ -1,5 +1,3 @@
-require 'moab'
-
 module Moab
   # A recursive "Tree" type object for verifications
   class VerificationResult

data/lib/moab/version_metadata.rb

@@ -1,5 +1,3 @@
-require 'moab'
-
 module Moab
   # The descriptive information about a digital object's collection of versions
   #
@@ -19,7 +17,7 @@ module Moab
 
     # (see Serializable#initialize)
     def initialize(opts = {})
-      @versions = Array.new
+      @versions = []
       super(opts)
     end
 

data/lib/moab/version_metadata_entry.rb

@@ -1,5 +1,3 @@
-require 'moab'
-
 module Moab
   # The descriptive attributes of a digital object version.
   #
@@ -18,13 +16,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,

data/lib/moab/version_metadata_event.rb

@@ -1,5 +1,3 @@
-require 'moab'
-
 module Moab
   # A container element to record object version lifecycle events with timestamps
   #

data/lib/serializer/manifest.rb

@@ -19,7 +19,7 @@ module Serializer
       if filename
         filename
       else
-        cname = self.name.split(/::/).last
+        cname = name.split(/::/).last
         cname[0, 1].downcase + cname[1..-1] + '.xml'
       end
     end
@@ -29,7 +29,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 +37,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 +46,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,7 +56,7 @@ 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|
+      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

data/lib/serializer/serializable.rb

@@ -19,11 +19,8 @@ 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
+        raise "#{key} is not a variable name in #{self.class.name}" unless variable_names.include?(key.to_s) || key == :test
+        instance_variable_set("@#{key}", value)
       end
     end
 
@@ -45,7 +42,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 +51,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 +66,7 @@ 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 +76,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,26 +89,26 @@ 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(summary = true)
     end
 
     # @api internal
@@ -120,13 +117,13 @@ module Serializer
     def diff(other)
       raise "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 +133,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 +161,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