ocfl 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 734c2a614db8c30eb86ddd0c7a32b6c10d813adb9ae5244d50614f35244c64cd
-  data.tar.gz: 4b5daffdbd581fe38974975a7f9e6dfcef734d078833b0eb030d750aacc7b18e
+  metadata.gz: 04033b37955d5ee76f304558abce0d860317fbd019e4a84ac033e2e4b4a89b49
+  data.tar.gz: 24aa1a8705a985d88900f30fd59c2e19be305edb3b710293330cfb6607fb6e46
 SHA512:
-  metadata.gz: 8c67987902f4adc67c8c250af66568872b9f3e9ca9cd9a3df60f26702e4ac16bfb6aea9e44628f427fe910af548ebc534436005e857f15cc3d47e4a31cc667a3
-  data.tar.gz: 857a0a20ee5a57c6b7087ef43264dbe2d3fd9b258175cc9449885a4b0eb1d56823cfe87eccad9bb86c5efc26ce5c2433e0465d6c5b0e425523668a18a7131e6a
+  metadata.gz: ae4c04c535047ff07f7123787cc08efa6cf2f56c5bf53f2a21366bf81f0474dfcbc35c48802c52c920c1a36d8f1bd77bc7558c4f0ac75e17afba0c131fd9dd45
+  data.tar.gz: cf9d0d5037ecb46946c9f8eab7407097cc0330f26d45566077ce83e61371cf1ebf8d906e13ee8ee003b40f9e2fb6b11b31d70e6de194a3f895503ccfc3947466

data/.rubocop.yml

@@ -28,6 +28,9 @@ RSpec/MultipleExpectations:
 RSpec/ExampleLength:
   Max: 10
 
+RSpec/MultipleMemoizedHelpers:
+  Max: 8
+
 RSpec/NestedGroups:
   Max: 4
 

data/README.md

@@ -27,14 +27,39 @@ directory.exists?
 # => true
 directory.valid?
 # => true
+```
+
+### Versions
+
+There are three ways to get a version with an existing object directory.
 
+#### Start a new version
+```
 new_version = directory.begin_new_version
 new_version.copy_file('sig/ocfl.rbs')
 new_version.save
 
 directory.head
 # => 'v2'
+```
+
+#### Re-open the existing head version
+```
+new_version = directory.reopen_head_version
+new_version.delete_file('cb6c8557fc724c636929775212c5194984d68cb1508a1')
+new_version.copy_file('sig/ocfl.rbs')
+new_version.save
+```
+
+#### Overwrite the existing head version
+```
+new_version = directory.overwrite_current_version
+new_version.copy_file('sig/ocfl.rbs')
+new_version.save
+```
 
+### File paths
+```
 # List file names that were part of a given version
 directory.versions['v2'].file_names
 # => ["ocfl.rbs"]
@@ -44,20 +69,9 @@ directory.path(filepath: "ocfl.rbs", version: "v2")
 # => <Pathname:/files/[object_root]/v2/content/ocfl.rbs>
 
 # Get the path of a file in the head version
-directory.path(filepath: "ocfl.rbs", version: :head)
-# => <Pathname:/files/[object_root]/v2/content/ocfl.rbs>
-
-# Get the path of a file from the latest version in which it was changed
 directory.path(filepath: "ocfl.rbs")
 # => <Pathname:/files/[object_root]/v2/content/ocfl.rbs>
 
-new_version = directory.overwrite_current_version
-new_version.copy_file('sig/ocfl.rbs')
-new_version.save
-
-new_version = directory.clone_current_version
-new_version.copy_file('Gemfile')
-new_version.save
 ```
 
 ## Development

data/lib/ocfl/object/directory.rb

@@ -18,14 +18,10 @@ module OCFL
       delegate :head, :versions, :manifest, to: :inventory
 
       def path(filepath:, version: nil)
-        version = head if version == :head
-        relative_path = if version
-                          version_inventory(version).path(filepath)
-                        else
-                          inventory.path(filepath)
-                        end
+        version ||= head
+        relative_path = version_inventory(version).path(filepath)
 
-        raise FileNotFound, "Path '#{filepath}' not found in #{version || "object"} inventory" if relative_path.nil?
+        raise FileNotFound, "Path '#{filepath}' not found in #{version} inventory" if relative_path.nil?
 
         object_root / relative_path
       end
@@ -68,14 +64,17 @@ module OCFL
         true
       end
 
+      # Start a completely new version
       def begin_new_version
-        DraftVersion.new(object_directory: self)
+        DraftVersion.new(object_directory: self, state: head_inventory.state)
       end
 
-      def clone_current_version
-        DraftVersion.new(object_directory: self, state: head_inventory.state)
+      # Get a handle for the head version
+      def reopen_head_version
+        DraftVersion.new(object_directory: self, overwrite_head: true, state: head_inventory.state)
       end
 
+      # Get a handle that will replace the existing head version
       def overwrite_current_version
         DraftVersion.new(object_directory: self, overwrite_head: true)
       end

data/lib/ocfl/object/draft_version.rb

@@ -28,6 +28,16 @@ module OCFL
         copy_one(File.basename(incoming_path), incoming_path, destination_path)
       end
 
+      # Note, this only removes the file from this version. Previous versions may still use it.
+      def delete_file(sha512_digest)
+        state.delete(sha512_digest)
+        # If the manifest points at the current content directory, then we can delete it.
+        file_paths = manifest[sha512_digest]
+        return unless file_paths.all? { |path| path.start_with?("#{version_number}/") }
+
+        File.unlink (object_directory.object_root + file_paths.first).to_s
+      end
+
       # Copies files into the object and preserves their relative paths as logical directories in the object
       def copy_recursive(incoming_path, destination_path: "")
         prepare_content_directory
@@ -93,8 +103,8 @@ module OCFL
       def build_inventory
         old_data = object_directory.inventory.data
         versions = versions(old_data.versions)
-        # Prune items from manifest if they are not part of any version
 
+        # Prune items from manifest if they are not part of any version
         Inventory::InventoryStruct.new(old_data.to_h.merge(manifest: filtered_manifest(versions),
                                                            head: version_number, versions:))
       end
@@ -108,7 +118,8 @@ module OCFL
       # The manifest after unused SHAs have been filtered out.
       def filtered_manifest(versions)
         shas_in_versions = versions.values.flat_map { |v| v.state.keys }.uniq
-        manifest.slice(*shas_in_versions)
+        manifest.slice!(*shas_in_versions)
+        manifest
       end
     end
   end

data/lib/ocfl/object/inventory.rb

@@ -34,13 +34,11 @@ module OCFL
 
       # @return [String,nil] the path to the file relative to the object root. (e.g. v2/content/image.tiff)
       def path(logical_path)
-        matching_paths = manifest.values.flatten.select do |path|
-          path.match(%r{\Av\d+/#{content_directory}/#{logical_path}\z})
-        end
+        digest, = state.find { |_, logical_paths| logical_paths.include?(logical_path) }
 
-        return if matching_paths.empty?
+        return unless digest
 
-        matching_paths.max_by { |path| path[/\d+/].to_i }
+        manifest[digest].find { |content_path| content_path.match(%r{\Av\d+/#{content_directory}/#{logical_path}\z}) }
       end
 
       def head_version

data/lib/ocfl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OCFL
-  VERSION = "0.5.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocfl
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-23 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: A ruby library for interacting with the Oxford Common File Layout (OCFL)