moab-versioning 4.2.0 → 4.2.1

data/lib/moab/storage_repository.rb

@@ -1,7 +1,6 @@
 require 'moab'
 
 module Moab
-
   # A class to represent the SDR repository store
   #
   # ====Data Model
@@ -14,7 +13,6 @@ module Moab
   # @note Copyright (c) 2012 by The Board of Trustees of the Leland Stanford Junior University.
   #   All rights reserved.  See {file:LICENSE.rdoc} for details.
   class StorageRepository
-
     # Note that Moab::Config is not initialized from environment config file until after
     #  this object is initialized by StorageServices
     #  (see sequence of requires in spec_helper.rb and in applications that use)
@@ -23,9 +21,9 @@ module Moab
     def storage_roots
       unless defined?(@storage_roots)
         raise "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 "Moab::Config.storage_roots empty" if  @storage_roots.empty?
-        @storage_roots.each{|root| raise "Storage root #{root} not found on system" unless root.exist?}
+        @storage_roots = [Moab::Config.storage_roots].flatten.collect { |filesystem| Pathname(filesystem) }
+        raise "Moab::Config.storage_roots empty" if @storage_roots.empty?
+        @storage_roots.each { |root| raise "Storage root #{root} not found on system" unless root.exist? }
       end
       @storage_roots
     end
@@ -33,7 +31,7 @@ module Moab
     # @return [String] The trunk segment of the object storage path
     def storage_trunk
       unless defined?(@storage_trunk)
-        raise "oab::Config.storage_trunk not found in config file" if Moab::Config.storage_trunk.nil?
+        raise "Moab::Config.storage_trunk not found in config file" if Moab::Config.storage_trunk.nil?
         @storage_trunk  = Moab::Config.storage_trunk
       end
       @storage_trunk
@@ -69,7 +67,7 @@ module Moab
     # @param object_id [String] The identifier of the digital object whose version is desired
     # @param include_deposit [Boolean] specifies whether to look in deposit areas for objects in process of initial ingest
     # @return [Pathname] The location of the desired object's home directory (default=pairtree)
-    def find_storage_root(object_id, include_deposit=false)
+    def find_storage_root(object_id, include_deposit = false)
       # Search for the object's home directory in the storage areas
       branch = storage_branch(object_id)
       storage_roots.each do |root|
@@ -95,7 +93,7 @@ module Moab
     # @param object_id [String] The identifier of the digital object whose version is desired
     # @param include_deposit [Boolean] specifies whether to look in deposit areas for objects in process of initial ingest
     # @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)
+    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)
@@ -106,7 +104,7 @@ module Moab
     # @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).
-    def object_size(object_id, include_deposit=false)
+    def object_size(object_id, include_deposit = false)
       storage_pathname = find_storage_object(object_id, include_deposit).object_pathname
       size = 0
       Find.find(storage_pathname) do |path|
@@ -118,27 +116,25 @@ module Moab
     # @param object_id [String] The identifier of the digital object whose version is desired
     # @param create [Boolean] If true, the object home directory should be created if it does not exist
     # @return [StorageObject] The representation of a digitial object's storage directory, which must exist.
-    def storage_object(object_id, create=false)
-    storage_object = find_storage_object(object_id)
-    unless storage_object.object_pathname.exist?
-      if create
+    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}"
+        else
+          raise Moab::ObjectNotFoundException, "No storage object found for #{object_id}"
+        end
       end
-    end
-    storage_object
+      storage_object
     end
 
     # @depricated Please use StorageObject#ingest_bag
     # @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)
+    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
     end
-
   end
-
 end

data/lib/moab/storage_services.rb

@@ -1,7 +1,6 @@
 require 'moab'
 
 module Moab
-
   # An interface class to support access to SDR storage via a RESTful server
   #
   # ====Data Model
@@ -14,7 +13,6 @@ module Moab
   # @note Copyright (c) 2012 by The Board of Trustees of the Leland Stanford Junior University.
   #   All rights reserved.  See {file:LICENSE.rdoc} for details.
   class StorageServices
-
     # @return [StorageRepository] an instance of the interface to SDR storage
     @@repository = Moab::StorageRepository.new
 
@@ -41,21 +39,21 @@ module Moab
     # @param object_id [String] The identifier of the digital object
     # @param [Object] include_deposit
     # @return [StorageObject] The representation of a digitial object's  storage directory, which might not exist yet.
-    def self.find_storage_object(object_id, include_deposit=false)
+    def self.find_storage_object(object_id, include_deposit = false)
       @@repository.find_storage_object(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).
-    def self.object_size(object_id, include_deposit=false)
+    def self.object_size(object_id, include_deposit = false)
       @@repository.object_size(object_id, include_deposit)
     end
 
     # @param object_id [String] The identifier of the digital object whose version is desired
     # @param create [Boolean] If true, the object home directory should be created if it does not exist
     # @return [StorageObject] The representation of a digitial object's storage directory, which must exist.
-    def self.storage_object(object_id, create=false)
+    def self.storage_object(object_id, create = false)
       @@repository.storage_object(object_id, create)
     end
 
@@ -68,7 +66,7 @@ module Moab
     # @param object_id [String] The digital object identifier of the object
     # @param [Integer] version_id The ID of the version, if nil use latest version
     # @return [String] the location of the storage object version
-    def self.object_version_path(object_id,version_id=nil)
+    def self.object_version_path(object_id, version_id = nil)
       @@repository.storage_object(object_id).find_object_version(version_id).version_pathname.to_s
     end
 
@@ -87,7 +85,7 @@ module Moab
     # @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
-    def self.retrieve_file_group(file_category, object_id, version_id=nil)
+    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'
@@ -103,7 +101,7 @@ module Moab
     # @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 [Pathname] Pathname object containing the full path for the specified file
-    def self.retrieve_file(file_category, file_id, object_id, version_id=nil)
+    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)
     end
@@ -113,7 +111,7 @@ module Moab
     # @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 [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)
+    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)
     end
@@ -123,7 +121,7 @@ module Moab
     # @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 [FileSignature] The signature of the file
-    def self.retrieve_file_signature(file_category, file_id, object_id, version_id=nil)
+    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)
     end
@@ -132,12 +130,12 @@ module Moab
     # @param [Object] base_version_id The identifier of the base version to be compared
     # @param [Object] compare_version_id The identifier of the version to be compared to the base version
     # @return [FileInventoryDifference] The report of the version differences
-    def self.version_differences(object_id, base_version_id,compare_version_id)
+    def self.version_differences(object_id, base_version_id, compare_version_id)
       base_version = @@repository.storage_object(object_id).storage_object_version(base_version_id)
       compare_version = @@repository.storage_object(object_id).storage_object_version(compare_version_id)
-      base_inventory=base_version.file_inventory('version')
-      compare_inventory=compare_version.file_inventory('version')
-      FileInventoryDifference.new.compare(base_inventory,compare_inventory)
+      base_inventory = base_version.file_inventory('version')
+      compare_inventory = compare_version.file_inventory('version')
+      FileInventoryDifference.new.compare(base_inventory, compare_inventory)
     end
   end
 end

data/lib/moab/utc_time.rb

@@ -3,21 +3,20 @@ require 'time'
 module Moab
   # Timestamp conversion methods.
   class UtcTime
-
     # @param datetime [Time,String,Nil] The input datetime
     # @return [void] Convert input datetime to a Time object, or nil if input is empty.
     def self.input(datetime)
       case datetime
-        when nil
-          nil
-        when ""
-          nil
-        when String
-          Time.parse(datetime)
-        when Time
-          datetime
-        else
-          raise "unknown time format #{datetime.inspect}"
+      when nil
+        nil
+      when ""
+        nil
+      when String
+        Time.parse(datetime)
+      when Time
+        datetime
+      else
+        raise "unknown time format #{datetime.inspect}"
       end
     end
 
@@ -25,14 +24,14 @@ module Moab
     # @return [String] Convert the datetime into a ISO 8601 formatted string
     def self.output(datetime)
       case datetime
-        when nil, ""
-          ""
-        when String
-          Time.parse(datetime).utc.iso8601
-        when Time
-          datetime.utc.iso8601
-        else
-          raise "unknown time format #{datetime.inspect}"
+      when nil, ""
+        ""
+      when String
+        Time.parse(datetime).utc.iso8601
+      when Time
+        datetime.utc.iso8601
+      else
+        raise "unknown time format #{datetime.inspect}"
       end
     end
   end

data/lib/moab/verification_result.rb

@@ -1,9 +1,8 @@
 require 'moab'
 
 module Moab
-
+  # A recursive "Tree" type object for verifications
   class VerificationResult
-
     # @return [String] The name of the entity that was verified
     attr_accessor :entity
 
@@ -16,69 +15,59 @@ module Moab
     # @return [Array<VerificationResult>] The subentities, if any, on which this verification is based
     attr_accessor :subentities
 
-    # @param entity [Object] The name of the entity being verified
-    def initialize(entity)
-      @entity = entity
-      @verified = false
-      @details = nil
+    # @param entity [#to_s] The name of the entity being verified
+    # @param verified [Boolean]
+    # @param details [Hash]
+    def initialize(entity, verified = false, details = nil)
+      @entity = entity.to_s  # force to string
+      @verified = !!verified # rubocop:disable Style/DoubleNegation
+      @details = details
       @subentities = Array.new
     end
 
-    # @param entity [Symbol] The name of the entity being verified
+    # @param entity [#to_s] The name of the entity being verified
     # @param expected [Object] The expected value
     # @param found [Object] The found value
     # @return [VerificationResult] The result of comparing the expected and found values
     def self.verify_value(entity, expected, found)
-      result = VerificationResult.new(entity.to_s)
-      result.verified = (expected == found)
-      result.details = {'expected' => expected, 'found' => found}
-      result
+      details = { 'expected' => expected, 'found' => found }
+      new(entity, (expected == found), details)
     end
 
-    # @param entity [Symbol] The name of the entity being verified
+    # @deprecated Just use the constructor
+    # @param entity [#to_s] The name of the entity being verified
     # @param expression [Object] The expression that will be evaluated as true or false
     # @param details [Object] optional details that could be reported
     # @return [VerificationResult] The result of evaluating the expression
-    def self.verify_truth(entity,expression,details=nil)
-      result = VerificationResult.new(entity.to_s)
-      # TODO: add expression.empty?
-      result.verified = !(expression.nil? or (expression == false))
-      result.details = details
-      result
+    def self.verify_truth(entity, expression, details = nil)
+      new(entity, expression, details)
     end
 
     # @param verbose [Boolean] If true, always provide all details of the verification
     # @return [String] The verification result serialized to JSON
-    def to_json(verbose=false)
+    def to_json(verbose = false)
       JSON.pretty_generate(to_hash(verbose))
     end
 
     # @param verbose [Boolean] If true, always provide all details of the verification
     # @param level [Integer] Used to test the depth of recursion
     # @return [Hash] The verification result serialized to a hash
-    def to_hash(verbose=false,level=0)
-      hash = Hash.new
-      hash['verified'] = @verified
-      if (verbose or @verified == false)
-        hash['details'] = @details ? @details : subentities_to_hash(verbose,level)
-      end
-      if level > 0
-        hash
-      else
-        {@entity => hash}
+    def to_hash(verbose = false, level = 0)
+      hash = { 'verified' => verified }
+      if verbose || !verified
+        hash['details'] = details || subentities_to_hash(verbose, level)
       end
+      return hash if level > 0
+      { entity => hash }
     end
 
+    private
+
     # @param verbose [Boolean] If true, always provide all details of the verification
     # @param level [Integer] Used to increment the depth of recursion
     # @return [Hash] The verification result of subentities serialized to a hash
-    def subentities_to_hash(verbose,level)
-      hash = Hash.new
-      @subentities.each do |s|
-       hash[s.entity] = s.to_hash(verbose, level+1)
-      end
-      hash
+    def subentities_to_hash(verbose, level)
+      subentities.map { |s| [s.entity, s.to_hash(verbose, level + 1)] }.to_h
     end
-
   end
 end

data/lib/moab/version_metadata.rb

@@ -1,7 +1,6 @@
 require 'moab'
 
 module Moab
-
   # The descriptive information about a digital object's collection of versions
   #
   # ====Data Model
@@ -13,14 +12,13 @@ module Moab
   # @note Copyright (c) 2012 by The Board of Trustees of the Leland Stanford Junior University.
   #   All rights reserved.  See {file:LICENSE.rdoc} for details.
   class VersionMetadata < Serializer::Manifest
-
     include HappyMapper
 
     # The name of the XML element used to serialize this objects data
     tag 'versionMetadata'
 
     # (see Serializable#initialize)
-    def initialize(opts={})
+    def initialize(opts = {})
       @versions = Array.new
       super(opts)
     end
@@ -32,7 +30,5 @@ module Moab
     # @attribute
     # @return [Array<VersionMetadataEntry>] An array of version metadata entries, one per version
     has_many :versions, VersionMetadataEntry, :tag => 'version'
-
   end
-
 end

data/lib/moab/version_metadata_entry.rb

@@ -1,7 +1,6 @@
 require 'moab'
 
 module Moab
-
   # The descriptive attributes of a digital object version.
   #
   # ====Data Model
@@ -12,21 +11,20 @@ module Moab
   # @note Copyright (c) 2012 by The Board of Trustees of the Leland Stanford Junior University.
   #   All rights reserved.  See {file:LICENSE.rdoc} for details.
   class VersionMetadataEntry < Serializer::Serializable
-
     include HappyMapper
 
     # The name of the XML element used to serialize this objects data
     tag 'version'
 
     # (see Serializable#initialize)
-    def initialize(opts={})
+    def initialize(opts = {})
       @events = Array.new
       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.new { |n| n.to_s }
 
     # @attribute
     # @return [String] "an external version label that increments the most significant digit for major revisions,
@@ -57,7 +55,5 @@ module Moab
     # @attribute
     # @return [Array<VersionMetadataEvent>] Array of events with timestamps that track lifecycle stages
     has_many :events, VersionMetadataEvent, :tag => 'event'
-
   end
-
 end

data/lib/moab/version_metadata_event.rb

@@ -1,7 +1,6 @@
 require 'moab'
 
 module Moab
-
   # A container element to record object version lifecycle events with timestamps
   #
   # ====Data Model
@@ -14,14 +13,13 @@ module Moab
   # @note Copyright (c) 2012 by The Board of Trustees of the Leland Stanford Junior University.
   #   All rights reserved.  See {file:LICENSE.rdoc} for details.
   class VersionMetadataEvent < Serializer::Serializable
-
     include HappyMapper
 
     # The name of the XML element used to serialize this objects data
     tag 'event'
 
     # (see Serializable#initialize)
-    def initialize(opts={})
+    def initialize(opts = {})
       super(opts)
     end
 
@@ -29,19 +27,16 @@ module Moab
     # @return [String] The type of event
     attribute :type, String
 
-
     # @attribute
     # @return [String] The date and time of an event
     attribute :datetime, String
 
     def datetime=(event_datetime)
-      @datetime=Moab::UtcTime.input(event_datetime)
+      @datetime = Moab::UtcTime.input(event_datetime)
     end
 
     def datetime
       Moab::UtcTime.output(@datetime)
     end
-
   end
-
 end