moab-versioning 6.0.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 749994fdd6abe9265d77a9c86595fd45790731eab77d953d2e497aa8bf294a51
-  data.tar.gz: 46da4dba3b799cd9e03c7218863590fef18f98a15f326ab80f178424a8aaa828
+  metadata.gz: 0fb403abc29dd5b88bd2a34f29717876e846ebf9cf90bc2129534794c499e472
+  data.tar.gz: ef320be8188580b0502e343b86bd0f39213e29aa53f8eeb25b0aa722b3273ace
 SHA512:
-  metadata.gz: e9c6898512516358683eb76556607942281e5a2b3f9ecb0dfe6e1e25506ae21a46f46c95b8611b3a37f6d6dd4b8b6045e54cdd0531a7e12f47a281f9218c43ab
-  data.tar.gz: 055efae4024095b3f2dba87369fc1a2843c7f2a8d84f66277315232791f1a4ae4e1b5ffbcd6e2474665cf09c9498059f4746fa3bfcef0609381347d8368d914e
+  metadata.gz: 381b7705b914b10714249571e0eca3ac4ac67496b3ee15995dc7c58dbbbfe92085c6b4bd17b386424c6d75889e4f3313b90a55fa20ea5293f733106d4ae1f510
+  data.tar.gz: f845dab613e3addc79f5b9e34270a40174b95fbe6435dc0013cedfeb1ad6bebcf3390c9f5077d1063a58e3281b0a2330f68ba9d8a63a9624f8c0b55e4b86a379

data/lib/moab/bagger.rb

@@ -67,14 +67,7 @@ module Moab
     # @return [NilClass] Delete the bagit files
     def delete_bag
       # make sure this looks like a bag before deleting
-      if bag_pathname.join('bagit.txt').exist?
-        if bag_pathname.join('data').exist?
-          bag_pathname.rmtree
-        else
-          bag_pathname.children.each(&:delete)
-          bag_pathname.rmdir
-        end
-      end
+      bag_pathname.rmtree if bag_pathname.join('bagit.txt').exist?
       nil
     end
 

data/lib/moab/config.rb

@@ -8,8 +8,8 @@ module Moab
       @checksum_algos = [:md5, :sha1, :sha256]
     end
 
-    def configure(&block)
-      instance_eval(&block)
+    def configure(...)
+      instance_eval(...)
     end
 
     def storage_roots(new_value = nil)

data/lib/moab/file_group.rb

@@ -38,7 +38,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The total number of data files (dynamically calculated)
-    attribute :file_count, Integer, tag: 'fileCount', on_save: proc { |i| i.to_s }
+    attribute :file_count, Integer, tag: 'fileCount', on_save: proc(&:to_s)
 
     def file_count
       files.inject(0) { |sum, manifestation| sum + manifestation.file_count }
@@ -46,7 +46,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The total size (in bytes) of all data files (dynamically calculated)
-    attribute :byte_count, Integer, tag: 'byteCount', on_save: proc { |i| i.to_s }
+    attribute :byte_count, Integer, tag: 'byteCount', on_save: proc(&:to_s)
 
     def byte_count
       files.inject(0) { |sum, manifestation| sum + manifestation.byte_count }
@@ -54,7 +54,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The total disk usage (in 1 kB blocks) of all data files (estimating du -k result) (dynamically calculated)
-    attribute :block_count, Integer, tag: 'blockCount', on_save: proc { |i| i.to_s }
+    attribute :block_count, Integer, tag: 'blockCount', on_save: proc(&:to_s)
 
     def block_count
       files.inject(0) { |sum, manifestation| sum + manifestation.block_count }
@@ -97,16 +97,23 @@ module Moab
 
     # @api internal
     # @param signature_subset [Array<FileSignature>] The signatures used to select the entries to return
-    # @return [Hash<String,FileSignature>] A pathname,signature hash containing a subset of the filenames in this file group
+    # @return [Hash<String,FileSignature>] A pathname,signature hash containing a subset of the filenames in this file
+    #                                      group, e.g., {"intro-1.jpg"=>#<Moab::FileSignature>, ...}
     def path_hash_subset(signature_subset)
-      path_hash = {}
-      signature_subset.each do |signature|
-        manifestation = signature_hash[signature]
-        manifestation.instances.each do |instance|
-          path_hash[instance.path] = signature
-        end
+      # the structure of the `signature_hash` attr is documented above
+      signature_hash
+        .filter_map do |signature, manifestation|
+        # filters out signatures not in the provided subset
+        next unless signature_subset.include?(signature)
+
+        # for each instance in the manifestation, return an array of its path and the signature from the above block
+        manifestation.instances.map { |instance| [instance.path, signature] }
       end
-      path_hash
+        # the nested map operations above return e.g.: [[["intro-1.jpg",
+        # #<Moab::FileSignature>],...]] which needs to be flattened one time to
+        # convert back into a hash
+        .flatten(1)
+        .to_h
     end
 
     # @param manifestiation_array [Array<FileManifestation>] The collection of {FileManifestation} objects
@@ -133,12 +140,11 @@ module Moab
     # @return [void] Add a single {FileSignature},{FileInstance} key/value pair to this group.
     #   Data is actually stored in the {#signature_hash}
     def add_file_instance(signature, instance)
-      if signature_hash.key?(signature)
-        manifestation = signature_hash[signature]
-      else
-        manifestation = FileManifestation.new
-        manifestation.signature = signature
-        signature_hash[signature] = manifestation
+      manifestation = signature_hash[signature] || begin
+        FileManifestation.new.tap do |file_manifestation|
+          file_manifestation.signature = signature
+          signature_hash[signature] = file_manifestation
+        end
       end
       manifestation.instances << instance
     end

data/lib/moab/file_group_difference.rb

@@ -64,7 +64,7 @@ module Moab
     # @attribute
     # @return [Integer] the total number of differences found between the two inventories that were
     #   compared  (dynamically calculated)
-    attribute :difference_count, Integer, tag: 'differenceCount', on_save: proc { |i| i.to_s }
+    attribute :difference_count, Integer, tag: 'differenceCount', on_save: proc(&:to_s)
 
     def difference_count
       count = 0
@@ -76,49 +76,49 @@ module Moab
 
     # @attribute
     # @return [Integer] How many files were unchanged
-    attribute :identical, Integer, on_save: proc { |n| n.to_s }
+    attribute :identical, Integer, on_save: proc(&:to_s)
     def identical
       subset_hash[:identical].count
     end
 
     # @attribute
     # @return [Integer] How many duplicate copies of files were added
-    attribute :copyadded, Integer, on_save: proc { |n| n.to_s }
+    attribute :copyadded, Integer, on_save: proc(&:to_s)
     def copyadded
       subset_hash[:copyadded].count
     end
 
     # @attribute
     # @return [Integer] How many duplicate copies of files were deleted
-    attribute :copydeleted, Integer, on_save: proc { |n| n.to_s }
+    attribute :copydeleted, Integer, on_save: proc(&:to_s)
     def copydeleted
       subset_hash[:copydeleted].count
     end
 
     # @attribute
     # @return [Integer] How many files were renamed
-    attribute :renamed, Integer, on_save: proc { |n| n.to_s }
+    attribute :renamed, Integer, on_save: proc(&:to_s)
     def renamed
       subset_hash[:renamed].count
     end
 
     # @attribute
     # @return [Integer] How many files were modified
-    attribute :modified, Integer, on_save: proc { |n| n.to_s }
+    attribute :modified, Integer, on_save: proc(&:to_s)
     def modified
       subset_hash[:modified].count
     end
 
     # @attribute
     # @return [Integer] How many files were added
-    attribute :added, Integer, on_save: proc { |n| n.to_s }
+    attribute :added, Integer, on_save: proc(&:to_s)
     def added
       subset_hash[:added].count
     end
 
     # @attribute
     # @return [Integer] How many files were deleted
-    attribute :deleted, Integer, on_save: proc { |n| n.to_s }
+    attribute :deleted, Integer, on_save: proc(&:to_s)
     def deleted
       subset_hash[:deleted].count
     end
@@ -256,7 +256,7 @@ module Moab
         basis_only_paths = basis_paths - other_paths
         other_only_paths = other_paths - basis_paths
         maxsize = [basis_only_paths.size, other_only_paths.size].max
-        (0..maxsize - 1).each do |n|
+        (0..maxsize - 1).each do |n| # rubocop:disable Lint/AmbiguousRange
           fid = FileInstanceDifference.new
           fid.basis_path = basis_only_paths[n]
           fid.other_path = other_only_paths[n]

data/lib/moab/file_group_difference_subset.rb

@@ -30,7 +30,7 @@ module Moab
 
     # @attribute
     # @return [Integer] How many files were changed
-    attribute :count, Integer, on_save: proc { |n| n.to_s }
+    attribute :count, Integer, on_save: proc(&:to_s)
 
     def count
       files.size

data/lib/moab/file_instance_difference.rb

@@ -38,11 +38,11 @@ module Moab
 
     # @attribute
     # @return [String] The file's path in the basis inventory (usually for an old version)
-    attribute :basis_path, String, tag: 'basisPath', on_save: proc { |s| s.to_s }
+    attribute :basis_path, String, tag: 'basisPath', on_save: proc(&:to_s)
 
     # @attribute
     # @return [String] The file's path in the other inventory (usually for an new version) compared against the basis
-    attribute :other_path, String, tag: 'otherPath', on_save: proc { |s| s.to_s }
+    attribute :other_path, String, tag: 'otherPath', on_save: proc(&:to_s)
 
     # @attribute
     # @return [Array<FileSignature>] The fixity data of the file manifestation(s) (plural if change was a content modification)

data/lib/moab/file_inventory.rb

@@ -50,7 +50,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The ordinal version number
-    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(&:to_s)
 
     # @return [String] The unique identifier concatenating digital object id with version id
     def composite_key
@@ -71,7 +71,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The total number of data files in the inventory (dynamically calculated)
-    attribute :file_count, Integer, tag: 'fileCount', on_save: proc { |t| t.to_s }
+    attribute :file_count, Integer, tag: 'fileCount', on_save: proc(&:to_s)
 
     def file_count
       groups.inject(0) { |sum, group| sum + group.file_count }
@@ -79,7 +79,7 @@ module Moab
 
      # @attribute
     # @return [Integer] The total size (in bytes) in all files of all files in the inventory (dynamically calculated)
-    attribute :byte_count, Integer, tag: 'byteCount', on_save: proc { |t| t.to_s }
+    attribute :byte_count, Integer, tag: 'byteCount', on_save: proc(&:to_s)
 
     def byte_count
       groups.inject(0) { |sum, group| sum + group.byte_count }
@@ -87,7 +87,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The total disk usage (in 1 kB blocks) of all data files (estimating du -k result) (dynamically calculated)
-    attribute :block_count, Integer, tag: 'blockCount', on_save: proc { |t| t.to_s }
+    attribute :block_count, Integer, tag: 'blockCount', on_save: proc(&:to_s)
 
     def block_count
       groups.inject(0) { |sum, group| sum + group.block_count }

data/lib/moab/file_inventory_difference.rb

@@ -34,7 +34,7 @@ module Moab
 
     # @attribute
     # @return [Integer] the number of differences found between the two inventories that were compared (dynamically calculated)
-    attribute :difference_count, Integer, tag: 'differenceCount', on_save: proc { |i| i.to_s }
+    attribute :difference_count, Integer, tag: 'differenceCount', on_save: proc(&:to_s)
 
     def difference_count
       @group_differences.inject(0) { |sum, group| sum + group.difference_count }
@@ -87,11 +87,11 @@ module Moab
       @report_datetime = Time.now
       # get a union list of all group_ids present in either inventory
       group_ids = basis_inventory.group_ids | other_inventory.group_ids
-      group_ids.each do |group_id|
+      @group_differences = group_ids.map do |group_id|
         # get a pair of groups to compare, creating a empty group if not present in the inventory
         basis_group = basis_inventory.group(group_id) || FileGroup.new(group_id: group_id)
         other_group = other_inventory.group(group_id) || FileGroup.new(group_id: group_id)
-        @group_differences << FileGroupDifference.new.compare_file_groups(basis_group, other_group)
+        FileGroupDifference.new.compare_file_groups(basis_group, other_group)
       end
       self
     end

data/lib/moab/file_signature.rb

@@ -45,20 +45,20 @@ module Moab
     tag 'fileSignature'
 
     # @attribute
-    # @return [Integer] The size of the file in bytes
-    attribute :size, Integer, on_save: proc { |n| n.to_s }
+    # @return [String] The size of the file in bytes (can be empty)
+    attribute :size, Integer, on_save: proc(&:to_s)
 
     # @attribute
-    # @return [String] The MD5 checksum value of the file
-    attribute :md5, String, on_save: proc { |n| n.nil? ? '' : n.to_s }
+    # @return [String] The MD5 checksum value of the file (can be empty)
+    attribute :md5, String, on_save: proc(&:to_s)
 
     # @attribute
-    # @return [String] The SHA1 checksum value of the file
-    attribute :sha1, String, on_save: proc { |n| n.nil? ? '' : n.to_s }
+    # @return [String] The SHA1 checksum value of the file (can be empty)
+    attribute :sha1, String, on_save: proc(&:to_s)
 
     # @attribute
-    # @return [String] The SHA256 checksum value of the file
-    attribute :sha256, String, on_save: proc { |n| n.nil? ? '' : n.to_s }
+    # @return [String] The SHA256 checksum value of the file (can be empty)
+    attribute :sha256, String, on_save: proc(&:to_s)
 
     KNOWN_ALGOS = {
       md5: proc { Digest::MD5.new },
@@ -106,11 +106,11 @@ module Moab
 
    # @return [Hash<Symbol,String>] A hash of the checksum data
     def checksums
-      {
-        md5: md5,
-        sha1: sha1,
-        sha256: sha256
-      }.reject { |_key, value| value.nil? || value.empty? }
+      @checksums ||= {}.tap do |checksum_hash|
+        checksum_hash[:md5] = md5 unless md5.to_s.empty?
+        checksum_hash[:sha1] = sha1 unless sha1.to_s.empty?
+        checksum_hash[:sha256] = sha256 unless sha256.to_s.empty?
+      end
     end
 
     # @return [Boolean] The signature contains all of the 3 desired checksums
@@ -128,7 +128,6 @@ module Moab
     # @param other [FileSignature] The other file signature being compared to this signature
     # @return [Boolean] Returns true if self and other have comparable fixity data.
     def eql?(other)
-      return false unless other.respond_to?(:size) && other.respond_to?(:checksums)
       return false if size.to_i != other.size.to_i
 
       self_checksums = checksums
@@ -140,6 +139,8 @@ module Moab
         return false if self_checksums[key] != other_checksums[key]
       end
       true
+    rescue NoMethodError
+      false
     end
 
     # @api internal

data/lib/moab/signature_catalog.rb

@@ -43,7 +43,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The ordinal version number
-    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(&:to_s)
 
     # @return [String] The unique identifier concatenating digital object id with version id
     def composite_key
@@ -64,7 +64,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The total number of data files (dynamically calculated)
-    attribute :file_count, Integer, tag: 'fileCount', on_save: proc { |t| t.to_s }
+    attribute :file_count, Integer, tag: 'fileCount', on_save: proc(&:to_s)
 
     def file_count
       entries.size
@@ -72,7 +72,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The total size (in bytes) of all data files (dynamically calculated)
-    attribute :byte_count, Integer, tag: 'byteCount', on_save: proc { |t| t.to_s }
+    attribute :byte_count, Integer, tag: 'byteCount', on_save: proc(&:to_s)
 
     def byte_count
       entries.inject(0) { |sum, entry| sum + entry.signature.size.to_i }
@@ -80,7 +80,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The total disk usage (in 1 kB blocks) of all data files (estimating du -k result) (dynamically calculated)
-    attribute :block_count, Integer, tag: 'blockCount', on_save: proc { |t| t.to_s }
+    attribute :block_count, Integer, tag: 'blockCount', on_save: proc(&:to_s)
 
     def block_count
       block_size = 1024

data/lib/moab/signature_catalog_entry.rb

@@ -25,7 +25,7 @@ module Moab
 
     # @attribute
     # @return [Integer] The ordinal version number
-    attribute :version_id, Integer, tag: 'originalVersion', key: true, on_save: proc { |n| n.to_s }
+    attribute :version_id, Integer, tag: 'originalVersion', key: true, on_save: proc(&:to_s)
 
     # @attribute
     # @return [String] The name of the file group

data/lib/moab/verification_result.rb

@@ -31,7 +31,7 @@ module Moab
     # @return [VerificationResult] The result of comparing the expected and found values
     def self.verify_value(entity, expected, found)
       details = { 'expected' => expected, 'found' => found }
-      new(entity, (expected == found), details)
+      new(entity, (expected == found), details) # rubocop:disable Style/RedundantParentheses
     end
 
     # @deprecated Just use the constructor

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(&:to_s)
 
     # @attribute
     # @return [String] "an external version label that increments the most significant digit for major revisions,

data/lib/stanford/content_inventory.rb

@@ -124,7 +124,7 @@ module Stanford
       cm.to_xml
     end
 
-    # @param content_metadata [String,Nokogiri::XML::Document] The contentMetadata as a string or XML doc
+    # @param content_metadata [String, Nokogiri::XML::Document] The contentMetadata as a string or XML doc
     # @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)

data/lib/stanford/storage_services.rb

@@ -19,6 +19,10 @@ module Stanford
       @@repository
     end
 
+    # NOTE: `ShelvingService.content_diff` in dor-services-app implements similar logic, but in a way that
+    # uses XML retrieved via preservation-client instead of reading the XML from disk.  This allows DSA to
+    # perform the potentially time expensive diff without requiring access to preservation disk mounts.
+    # See https://github.com/sul-dlss/dor-services-app/pull/4492 and https://github.com/sul-dlss/dor-services-app/issues/4359
     # @param new_content_metadata [String] The content metadata to be compared to the base
     # @param object_id [String] The digital object identifier of the object whose version inventory is the basis of the
     #  comparison

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moab-versioning
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.1
 platform: ruby
 authors:
 - Naomi Dushay
@@ -9,10 +9,9 @@ authors:
 - Tony Zanella
 - Mike Giarlo
 - John Martin
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-26 00:00:00.000000000 Z
+date: 2025-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: druid-tools
@@ -144,16 +143,16 @@ dependencies:
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -215,7 +214,6 @@ licenses:
 - Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -230,8 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby implementation of digital object versioning toolkit used by Stanford
   University Libraries