ocfl 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04033b37955d5ee76f304558abce0d860317fbd019e4a84ac033e2e4b4a89b49
-  data.tar.gz: 24aa1a8705a985d88900f30fd59c2e19be305edb3b710293330cfb6607fb6e46
+  metadata.gz: c21578c64e68d5bdab7fcea3b08bf8210a967a52d0d6b0f2ecdc203a4f2eaca4
+  data.tar.gz: 48503dd0f9011c88bbf20bc6adf073d2b1ff422ac1ed06063c332f7c3bbf619e
 SHA512:
-  metadata.gz: ae4c04c535047ff07f7123787cc08efa6cf2f56c5bf53f2a21366bf81f0474dfcbc35c48802c52c920c1a36d8f1bd77bc7558c4f0ac75e17afba0c131fd9dd45
-  data.tar.gz: cf9d0d5037ecb46946c9f8eab7407097cc0330f26d45566077ce83e61371cf1ebf8d906e13ee8ee003b40f9e2fb6b11b31d70e6de194a3f895503ccfc3947466
+  metadata.gz: 74169c05ca7d91082db0198d252234956c7a47139d57419f5be14e8e23168af39e75b9d9e78d397bd1b65fbc688834ee84cd1456d452795163c777c6c7da15c7
+  data.tar.gz: acd185ad8a09d1b016d9c6867d5b4b68005fbe1227abe8848912f917c3d71f4d535cd1847cc4422606fec0d5fc01b9dbf59b6b613c4e5701dfca1703ebae79dc

data/.rubocop.yml

@@ -22,6 +22,9 @@ Metrics/BlockLength:
     - describe
     - context
 
+Metrics/ClassLength:
+  Max: 110
+
 RSpec/MultipleExpectations:
   Enabled: false
 

data/README.md

@@ -20,7 +20,7 @@ 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?
@@ -43,10 +43,10 @@ directory.head
 # => 'v2'
 ```
 
-#### Re-open the existing head version
+#### Modify the existing head version
 ```
-new_version = directory.reopen_head_version
-new_version.delete_file('cb6c8557fc724c636929775212c5194984d68cb1508a1')
+new_version = directory.head_version
+new_version.delete_file('sample.txt')
 new_version.copy_file('sig/ocfl.rbs')
 new_version.save
 ```
@@ -64,6 +64,10 @@ new_version.save
 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>

data/lib/ocfl/object/directory.rb

@@ -70,7 +70,7 @@ module OCFL
       end
 
       # Get a handle for the head version
-      def reopen_head_version
+      def head_version
         DraftVersion.new(object_directory: self, overwrite_head: true, state: head_inventory.state)
       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,19 +17,30 @@ 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)
+        already_stored = add(incoming_path)
+        return if already_stored
+
         FileUtils.mv(incoming_path, content_path)
       end
 
       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(sha512_digest)
+      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]
@@ -43,7 +54,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
 
@@ -53,6 +67,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)
@@ -61,20 +79,29 @@ 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?
-        add(incoming_path, logical_file_path:)
+      # @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)
+        already_stored = add(incoming_path, logical_file_path:)
+        return if already_stored
+
         parent_dir = (content_path / logical_file_path).parent
         FileUtils.mkdir_p(parent_dir) unless parent_dir == content_path
         FileUtils.cp(incoming_path, content_path / logical_file_path)
       end
 
+      # @return [Boolean] true if the file already existed in this object. If false, the object must be
+      #                   moved to the content directory.
       def add(incoming_path, logical_file_path: File.basename(incoming_path))
         digest = Digest::SHA512.file(incoming_path).to_s
         version_content_path = content_path.relative_path_from(object_directory.object_root)
         file_path_relative_to_root = (version_content_path / logical_file_path).to_s
-        @manifest[digest] = [file_path_relative_to_root]
-        @state[digest] = [logical_file_path]
+        result = @manifest.key?(digest)
+        @manifest[digest] ||= []
+        @state[digest] ||= []
+        @manifest[digest].push(file_path_relative_to_root)
+        @state[digest].push(logical_file_path)
+        result
       end
 
       def prepare_content_directory
@@ -112,7 +139,7 @@ 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.

data/lib/ocfl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OCFL
-  VERSION = "0.7.0"
+  VERSION = "0.8.1"
 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocfl
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Justin Coyne
@@ -103,6 +103,7 @@ files:
 - lib/ocfl/object/version.rb
 - lib/ocfl/version.rb
 - sig/ocfl.rbs
+- tmp/.keep
 homepage: https://github.com/sul-dlss/ocfl-rb
 licenses: []
 metadata: