ocfl 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b32346d0bd14e71b28385a1e34ad4f4af73335ab64345fa374c890ccf07e4f83
-  data.tar.gz: 4f9f6bc929cdee4f24e3b8b4bca167d69219d34fb74de00ff75414a68ee66ad2
+  metadata.gz: 9b1b7553fa1d862a3aa1f6a7f63b148f424f1448c321f7b534776c857ce932f2
+  data.tar.gz: 8408cf71f4a08fc2c44485ea69e6f77eb5e49366a80d460d20e7ab7961ef9442
 SHA512:
-  metadata.gz: e9a520d6bf056649a3b4c261ea27fb6d5a994d8f0bd274f5a8aca19751e24fa4c1ca08de57ee7971b927081f4dcb941a514570deba8088580579613123a1d1f1
-  data.tar.gz: a3df7b8ae6913eee74a0bea12474ee4c7ebe937bd1b92c28c8918e2a00c46d82191e99a360dacd780b1be65f1bdab25dbca7edfa47f3d03b8d4cf8e3ef534ebe
+  metadata.gz: 5420543eb4d07840970600fbc1f4a475e2ae3f09dea57de76087e626ed87a99ec9b02cf4dd38598398fb75aaa1e8eb61fb20d2af4d4b2b9939a269cf811d7b13
+  data.tar.gz: f3f6b84156e307897c3be76ed247043ce5d5f161536267b2ee5cfb8a91b50c6080da57ba6fc5c063349603784a13689ef4bbc74c624cbf302ec3f50810b53307

data/.rubocop.yml

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

data/README.md

@@ -20,25 +20,54 @@ directory = OCFL::Object::Directory.new(object_root: '/files/[object_root]')
 directory.exists?
 # => false
 builder = OCFL::Object::DirectoryBuilder.new(object_root: 'spec/abc123', id: 'http://example.com/abc123')
-builder.copy_file('sig/ocfl.rbs')
+builder.copy_file('sig/ocfl.rbs', destination_path: 'ocfl/types/generated.rbs')
 
 directory = builder.save
 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'
+```
+
+#### Modify the existing head version
+```
+new_version = directory.head_version
+new_version.delete_file('sample.txt')
+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"]
 
+# Or on the head version
+directory.head_version.file_names
+# => ["ocfl.rbs"]
+
 # Get the path of a file in a given version
 directory.path(filepath: "ocfl.rbs", version: "v2")
 # => <Pathname:/files/[object_root]/v2/content/ocfl.rbs>
@@ -47,9 +76,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 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/directory_builder.rb

@@ -33,12 +33,12 @@ module OCFL
 
       def create_object_directory
         FileUtils.mkdir_p(object_root)
+        FileUtils.touch(object_directory.namaste_file) unless File.exist?(object_directory.namaste_file)
       end
 
       # @return [Directory]
       def save
-        FileUtils.mkdir_p(object_root)
-        FileUtils.touch(object_directory.namaste_file)
+        create_object_directory
         write_inventory
         object_directory
       end

data/lib/ocfl/object/draft_version.rb

@@ -17,6 +17,8 @@ module OCFL
 
       attr_reader :object_directory, :manifest, :state, :version_number
 
+      delegate :file_names, to: :to_version_struct
+
       def move_file(incoming_path)
         prepare_content_directory
         add(incoming_path)
@@ -25,7 +27,24 @@ module OCFL
 
       def copy_file(incoming_path, destination_path: "")
         prepare_content_directory
-        copy_one(File.basename(incoming_path), incoming_path, destination_path)
+        copy_one(destination_path.presence || File.basename(incoming_path), incoming_path)
+      end
+
+      def digest_for_filename(filename)
+        state.find { |_, filenames| filenames.include?(filename) }&.first
+      end
+
+      # Note, this only removes the file from this version. Previous versions may still use it.
+      def delete_file(filename)
+        sha512_digest = digest_for_filename(filename)
+        raise "Unknown file: #{filename}" unless 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
@@ -33,7 +52,10 @@ module OCFL
         prepare_content_directory
         incoming_path = incoming_path.delete_suffix("/")
         Dir.glob("#{incoming_path}/**/*").reject { |fn| File.directory?(fn) }.each do |file|
-          copy_one(file.delete_prefix(incoming_path).delete_prefix("/"), file, destination_path)
+          logical_file_path = file.delete_prefix(incoming_path).delete_prefix("/")
+          logical_file_path = File.join(destination_path, logical_file_path) unless destination_path.empty?
+
+          copy_one(logical_file_path, file)
         end
       end
 
@@ -43,6 +65,10 @@ module OCFL
         object_directory.reload
       end
 
+      def to_version_struct
+        Version.new(state:, created: Time.now.utc.iso8601)
+      end
+
       private
 
       def write_inventory(inventory)
@@ -51,8 +77,9 @@ module OCFL
         FileUtils.cp(path / "inventory.json.sha512", object_directory.object_root)
       end
 
-      def copy_one(logical_file_path, incoming_path, destination_path)
-        logical_file_path = File.join(destination_path, logical_file_path) unless destination_path.empty?
+      # @param [String] logical_file_path where we're going to store the file (e.g. 'object/directory_builder_spec.rb')
+      # @param [String] incoming_path where's this file from (e.g. 'spec/ocfl/object/directory_builder_spec.rb')
+      def copy_one(logical_file_path, incoming_path)
         add(incoming_path, logical_file_path:)
         parent_dir = (content_path / logical_file_path).parent
         FileUtils.mkdir_p(parent_dir) unless parent_dir == content_path
@@ -93,8 +120,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
@@ -102,13 +129,14 @@ module OCFL
       # This gives the update list of versions. The old list plus this new one.
       # @param [Hash] old_versions the versions prior to this one.
       def versions(old_versions)
-        old_versions.merge(version_number => Version.new(created: Time.now.utc.iso8601, state: @state))
+        old_versions.merge(version_number => to_version_struct)
       end
 
       # 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.8.0"
 end

data/lib/ocfl.rb

@@ -3,6 +3,7 @@
 require "zeitwerk"
 require "active_support"
 require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/object/blank"
 require "digest"
 require "dry/monads"
 require "dry-schema"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocfl
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.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)