moab-versioning 4.4.0 → 5.0.0

data/lib/moab/storage_object_version.rb

@@ -45,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
@@ -115,12 +115,12 @@ module Moab
 
         @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
@@ -131,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
 
@@ -202,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
 
@@ -312,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')

data/lib/moab/storage_repository.rb

@@ -160,7 +160,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(druid, create = true).ingest_bag(bag_pathname)
+      storage_object(druid, true).ingest_bag(bag_pathname)
     end
 
     private

data/lib/moab/storage_services.rb

@@ -83,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
@@ -110,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')
@@ -120,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')
@@ -130,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/version_metadata_entry.rb

@@ -24,7 +24,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The object version number (A sequential integer)
-    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 }
 
     # @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.rb

@@ -20,10 +20,6 @@
 #       * {FileInstanceDifference} [1..*] = contains difference information at the file level
 #         * {FileSignature} [1..2] = contains the file signature(s) of two file instances being compared
 #
-# * <b>{VersionMetadata} = descriptive information about a digital object's versions</b>
-#   * {VersionMetadataEntry} [1..*] = attributes of a digital object version
-#     * {VersionMetadataEvent} [1..*] = object version lifecycle events with timestamps
-#
 # * <b>{StorageObject} = represents a digital object's repository storage location and ingest/dissemination methods</b>
 #   * {StorageObjectVersion} [1..*] = represents a version subdirectory within an object's home directory
 #     * {Bagger} [1] = utility for creating bagit packages for ingest or dissemination
@@ -48,9 +44,6 @@ require 'moab/file_instance_difference'
 require 'moab/file_group_difference_subset'
 require 'moab/file_group_difference'
 require 'moab/file_inventory_difference'
-require 'moab/version_metadata_event'
-require 'moab/version_metadata_entry'
-require 'moab/version_metadata'
 require 'moab/bagger'
 require 'moab/storage_object'
 require 'moab/storage_object_version'
@@ -59,4 +52,3 @@ require 'moab/storage_services'
 require 'moab/exceptions'
 require 'moab/verification_result'
 require 'moab/storage_object_validator'
-require 'moab/deposit_bag_validator'

data/lib/serializer/manifest.rb

@@ -22,7 +22,7 @@ module Serializer
         filename
       else
         cname = name.split(/::/).last
-        cname[0, 1].downcase + cname[1..-1] + '.xml'
+        "#{cname[0, 1].downcase}#{cname[1..]}.xml"
       end
     end
 
@@ -59,7 +59,7 @@ module Serializer
     def self.write_xml_file(xml_object, parent_dir, filename = nil)
       parent_dir.mkpath
       xml_pathname(parent_dir, filename).open('w') do |f|
-        xmlBuilder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8')
+        xmlBuilder = Nokogiri::XML::Builder.new(encoding: 'UTF-8')
         xmlBuilder = xml_object.to_xml(xmlBuilder)
         f << xmlBuilder.to_xml
       end

data/lib/serializer/serializable.rb

@@ -113,7 +113,7 @@ module Serializer
 
     # @return [Hash] Calls to_hash(summary=true)
     def summary
-      to_hash(summary = true)
+      to_hash(true)
     end
 
     # @api internal

data/lib/stanford/content_inventory.rb

@@ -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
@@ -49,7 +49,7 @@ module Stanford
                 else
                   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)
@@ -85,10 +85,10 @@ module Stanford
       instance = Moab::FileInstance.new
       instance.path = node.attributes['id'].content
       instance.datetime = begin
-                            node.attributes['datetime'].content
-                          rescue
-                            nil
-                          end
+        node.attributes['datetime'].content
+      rescue
+        nil
+      end
       instance
     end
 
@@ -98,23 +98,23 @@ 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) do
-          xml.resource(:type => "version", :sequence => "1", :id => "version-#{version_id}") do
+        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
@@ -128,7 +128,7 @@ 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] + " ..." unless result.empty?
+      raise Moab::InvalidMetadataException, "#{result[0]} ..." unless result.empty?
 
       true
     end
@@ -191,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

data/lib/stanford/storage_repository.rb

@@ -31,9 +31,9 @@ module Stanford
     # @param object_id [String] The identifier of the digital object whose path is requested
     # @return [String] the druid tree directory path based on the given object identifier.
     def druid_tree(object_id)
-      # Note: this seems an odd place to do druid validation, but leaving it here for now
+      # NOTE: this seems an odd place to do druid validation, but leaving it here for now
       syntax_msg = "Identifier has invalid suri syntax: #{object_id}"
-      raise(Moab::InvalidSuriSyntaxError, syntax_msg + " nil or empty") if object_id.to_s.empty?
+      raise(Moab::InvalidSuriSyntaxError, "#{syntax_msg} nil or empty") if object_id.to_s.empty?
 
       identifier = object_id.split(':')[-1]
       raise(Moab::InvalidSuriSyntaxError, syntax_msg) if identifier.to_s.empty?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moab-versioning
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Darren Weber
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: druid-tools
@@ -145,28 +145,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.37.1
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.37.1
+        version: '2.1'
 description: Contains classes to process digital object version content and metadata
 email:
 - darren.weber@stanford.edu
@@ -177,7 +177,6 @@ files:
 - lib/moab.rb
 - lib/moab/bagger.rb
 - lib/moab/config.rb
-- lib/moab/deposit_bag_validator.rb
 - lib/moab/exceptions.rb
 - lib/moab/file_group.rb
 - lib/moab/file_group_difference.rb
@@ -198,16 +197,11 @@ files:
 - lib/moab/storage_services.rb
 - lib/moab/utc_time.rb
 - lib/moab/verification_result.rb
-- lib/moab/version_metadata.rb
 - lib/moab/version_metadata_entry.rb
-- lib/moab/version_metadata_event.rb
 - lib/serializer.rb
 - lib/serializer/manifest.rb
 - lib/serializer/serializable.rb
-- lib/stanford/active_fedora_object.rb
 - lib/stanford/content_inventory.rb
-- lib/stanford/dor_metadata.rb
-- lib/stanford/moab_storage_directory.rb
 - lib/stanford/storage_object_validator.rb
 - lib/stanford/storage_repository.rb
 - lib/stanford/storage_services.rb
@@ -221,16 +215,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby implementation of digital object versioning toolkit used by the SULAIR