ocfl 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b32346d0bd14e71b28385a1e34ad4f4af73335ab64345fa374c890ccf07e4f83
-  data.tar.gz: 4f9f6bc929cdee4f24e3b8b4bca167d69219d34fb74de00ff75414a68ee66ad2
+  metadata.gz: 04033b37955d5ee76f304558abce0d860317fbd019e4a84ac033e2e4b4a89b49
+  data.tar.gz: 24aa1a8705a985d88900f30fd59c2e19be305edb3b710293330cfb6607fb6e46
 SHA512:
-  metadata.gz: e9a520d6bf056649a3b4c261ea27fb6d5a994d8f0bd274f5a8aca19751e24fa4c1ca08de57ee7971b927081f4dcb941a514570deba8088580579613123a1d1f1
-  data.tar.gz: a3df7b8ae6913eee74a0bea12474ee4c7ebe937bd1b92c28c8918e2a00c46d82191e99a360dacd780b1be65f1bdab25dbca7edfa47f3d03b8d4cf8e3ef534ebe
+  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"]
@@ -47,9 +72,6 @@ directory.path(filepath: "ocfl.rbs", version: "v2")
 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
 ```
 
 ## Development

data/lib/ocfl/object/directory.rb

@@ -64,10 +64,17 @@ module OCFL
         true
       end
 
+      # Start a completely new version
       def begin_new_version
         DraftVersion.new(object_directory: self, state: head_inventory.state)
       end
 
+      # 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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocfl
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-24 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)