moab-versioning 4.3.0 → 5.0.0.beta1

data/lib/moab/version_metadata_entry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moab
   # The descriptive attributes of a digital object version.
   #
@@ -22,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,
@@ -44,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Moab is a module that provides a distintive namespace for the collection of classes it contains.
 #
 # ====Data Model
@@ -18,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
@@ -33,7 +31,6 @@ module Moab
 end
 
 require 'serializer'
-require 'confstruct/configuration'
 require 'moab/config'
 require 'moab/utc_time'
 require 'moab/file_signature'
@@ -47,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'
@@ -58,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

@@ -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.
@@ -20,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
 
@@ -57,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

@@ -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.
@@ -21,6 +23,7 @@ module Serializer
       opts.each do |key, value|
         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
@@ -68,6 +71,7 @@ module Serializer
     # @return [String] For the current object instance, return the string to use as a hash key
     def key
       return send(key_name) if key_name
+
       nil
     end
 
@@ -109,7 +113,7 @@ module Serializer
 
     # @return [Hash] Calls to_hash(summary=true)
     def summary
-      to_hash(summary = true)
+      to_hash(true)
     end
 
     # @api internal
@@ -117,6 +121,7 @@ module Serializer
     # @return [Hash] Generate a hash containing the differences between two objects of the same type
     def diff(other)
       raise(Moab::MoabRuntimeError, "Cannot compare different classes") if self.class != other.class
+
       left = other.to_hash
       right = to_hash
       if key.nil? || other.key.nil?

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/stanford/content_inventory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stanford
   # Stanford-specific utility methods for transforming contentMetadata to versionInventory and doing comparisons
   #
@@ -21,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,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)
@@ -83,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
 
@@ -96,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
@@ -126,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] + " ..." unless result.empty?
+      raise Moab::InvalidMetadataException, "#{result[0]} ..." unless result.empty?
+
       true
     end
 
@@ -176,6 +179,7 @@ module Stanford
     def remediate_content_metadata(content_metadata, content_group)
       return nil if content_metadata.nil?
       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
@@ -187,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_object_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stanford
   # druids are Stanford specific entities
   class StorageObjectValidator < Moab::StorageObjectValidator

data/lib/stanford/storage_repository.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'druid-tools'
 
 module Stanford
@@ -29,12 +31,14 @@ 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?
       raise(Moab::InvalidSuriSyntaxError, syntax_msg) unless DruidTools::Druid.valid?(identifier, true)
+
       DruidTools::Druid.new(identifier, true).tree.join(File::SEPARATOR)
     end
   end

data/lib/stanford/storage_services.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stanford
   # An interface class to support access to SDR storage via a RESTful server
   class StorageServices < Moab::StorageServices

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moab-versioning
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 5.0.0.beta1
 platform: ruby
 authors:
 - Darren Weber
@@ -11,24 +11,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: confstruct
+  name: druid-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -42,7 +42,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri-happymapper
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -56,7 +56,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: nokogiri-happymapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,21 +70,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: druid-tools
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: equivalent-xml
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -98,7 +84,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -112,7 +98,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -126,7 +112,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -140,7 +126,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -159,28 +145,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: '2.1'
 description: Contains classes to process digital object version content and metadata
 email:
 - darren.weber@stanford.edu
@@ -191,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
@@ -212,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
@@ -235,16 +215,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 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