ocfl 0.8.1 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c21578c64e68d5bdab7fcea3b08bf8210a967a52d0d6b0f2ecdc203a4f2eaca4
-  data.tar.gz: 48503dd0f9011c88bbf20bc6adf073d2b1ff422ac1ed06063c332f7c3bbf619e
+  metadata.gz: 73309493b42b637ca8a3526c52d50531996f77495ae114a9fa6963b0a3a3b67f
+  data.tar.gz: f7bd61220ac24196b86ae50a6cf44e301002c6cf265b0debbe643abc1b088e50
 SHA512:
-  metadata.gz: 74169c05ca7d91082db0198d252234956c7a47139d57419f5be14e8e23168af39e75b9d9e78d397bd1b65fbc688834ee84cd1456d452795163c777c6c7da15c7
-  data.tar.gz: acd185ad8a09d1b016d9c6867d5b4b68005fbe1227abe8848912f917c3d71f4d535cd1847cc4422606fec0d5fc01b9dbf59b6b613c4e5701dfca1703ebae79dc
+  metadata.gz: c94aa2013e50467adb00b2e4e2ea5a53b29947490ed069d13a117ec0bdddb8480cb81a369e9f1f4d4639434fa63b1cf89ce77ed309527b0dc2f49685f6e4ceda
+  data.tar.gz: 9922c3d6521295df8384b2927daeb573f2e762ee0f69b111ab23cca5931fe32ee05b346ebd31bf3779f41e89d31a4119fadc18308f48ca4f762376b4afe3ad2c

data/.rubocop.yml

@@ -31,6 +31,10 @@ RSpec/MultipleExpectations:
 RSpec/ExampleLength:
   Max: 10
 
+RSpec/InstanceVariable:
+  Exclude:
+    - spec/support/temp_directory.rb
+
 RSpec/MultipleMemoizedHelpers:
   Max: 8
 

data/README.md

@@ -16,36 +16,50 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Usage
 
 ```ruby
-directory = OCFL::Object::Directory.new(object_root: '/files/[object_root]')
-directory.exists?
+storage_root = OCFL::StorageRoot.new(base_directory: '/files')
+storage_root.exists?
+# => false
+storage_root.valid?
 # => false
-builder = OCFL::Object::DirectoryBuilder.new(object_root: 'spec/abc123', id: 'http://example.com/abc123')
-builder.copy_file('sig/ocfl.rbs', destination_path: 'ocfl/types/generated.rbs')
 
-directory = builder.save
-directory.exists?
+storage_root.save
+storage_root.exists?
 # => true
-directory.valid?
+storage_root.valid?
 # => true
+
+object = storage_root.object('bc123df4567') # returns an instance of `OCFL::Object`
+object.exists?
+# => false
+object.valid?
+# => false
+object.head
+# => 'v0'
 ```
 
 ### Versions
 
-There are three ways to get a version with an existing object directory.
+To build out an object, you'll need to create one or more versions.
+
+There are three ways to get a version within an existing object directory.
 
 #### Start a new version
 ```
-new_version = directory.begin_new_version
-new_version.copy_file('sig/ocfl.rbs')
+new_version = object.begin_new_version
+new_version.copy_file('sig/ocfl.rbs', destination_path: 'ocfl/types/generated.rbs')
 new_version.save
 
-directory.head
-# => 'v2'
+object.exists?
+# => true
+object.valid?
+# => true
+object.head
+# => 'v1'
 ```
 
 #### Modify the existing head version
 ```
-new_version = directory.head_version
+new_version = object.head_version
 new_version.delete_file('sample.txt')
 new_version.copy_file('sig/ocfl.rbs')
 new_version.save
@@ -53,7 +67,7 @@ new_version.save
 
 #### Overwrite the existing head version
 ```
-new_version = directory.overwrite_current_version
+new_version = object.overwrite_current_version
 new_version.copy_file('sig/ocfl.rbs')
 new_version.save
 ```
@@ -61,7 +75,7 @@ new_version.save
 ### File paths
 ```
 # List file names that were part of a given version
-directory.versions['v2'].file_names
+object.versions['v1'].file_names
 # => ["ocfl.rbs"]
 
 # Or on the head version
@@ -69,13 +83,12 @@ 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>
+object.path(filepath: "ocfl.rbs", version: "v1")
+# => <Pathname:/files/[object_root]/v1/content/ocfl.rbs>
 
 # Get the path of a file in the head version
-directory.path(filepath: "ocfl.rbs")
-# => <Pathname:/files/[object_root]/v2/content/ocfl.rbs>
-
+object.path(filepath: "ocfl.rbs")
+# => <Pathname:/files/[object_root]/v1/content/ocfl.rbs>
 ```
 
 ## Development

data/lib/ocfl/inventory.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module OCFL
+  # Represents the JSON file that stores the object inventory
+  # https://ocfl.io/1.1/spec/#inventory
+  class Inventory
+    URI_1_1 = "https://ocfl.io/1.1/spec/#inventory"
+
+    # A data structure for the inventory
+    class InventoryStruct < Dry::Struct
+      transform_keys(&:to_sym)
+      attribute :id, Types::String
+      attribute :type, Types::String
+      attribute :digestAlgorithm, Types::String
+      attribute :head, Types::String
+      attribute? :contentDirectory, Types::String
+      attribute :versions, Types::Hash.map(Types::String, ObjectVersion)
+      attribute :manifest, Types::Hash
+    end
+
+    # @param [InventoryStruct] data
+    def initialize(data:)
+      @data = data
+    end
+
+    attr_reader :errors, :data
+
+    delegate :id, :head, :versions, :manifest, to: :data
+    delegate :state, to: :head_version
+
+    def content_directory
+      data.contentDirectory || "content"
+    end
+
+    # @return [String,nil] the path to the file relative to the object root. (e.g. v2/content/image.tiff)
+    def path(logical_path)
+      return unless head_version # object does not exist on disk
+
+      digest, = state.find { |_, logical_paths| logical_paths.include?(logical_path) }
+
+      return unless digest
+
+      manifest[digest].find { |content_path| content_path.match(%r{\Av\d+/#{content_directory}/#{logical_path}\z}) }
+    end
+
+    def head_version
+      versions[head]
+    end
+  end
+end

data/lib/ocfl/inventory_loader.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module OCFL
+  # Loads and Inventory object from JSON
+  class InventoryLoader
+    include Dry::Monads[:result]
+
+    VersionEnum = Types::String.enum(Inventory::URI_1_1)
+    DigestAlgorithm = Types::String.enum("md5", "sha1", "sha256", "sha512", "blake2b-512")
+
+    # https://ocfl.io/1.1/spec/#inventory-structure
+    # Validation of the incoming data
+    Schema = Dry::Schema.Params do
+      # config.validate_keys = true
+      required(:id).filled(:string)
+      required(:type).filled(VersionEnum)
+      required(:digestAlgorithm).filled(DigestAlgorithm)
+      required(:head).filled(:string)
+      optional(:contentDirectory).filled(:string)
+      required(:versions).hash
+      required(:manifest).hash
+    end
+
+    def self.load(file_name)
+      new(file_name).load
+    end
+
+    def initialize(file_name)
+      @file_name = file_name
+    end
+
+    def load
+      bytestream = File.read(@file_name)
+      data = JSON.parse(bytestream)
+      errors = Schema.call(data).errors
+      if errors.empty?
+        Success(Inventory::InventoryStruct.new(data))
+      else
+        Failure(errors)
+      end
+    end
+  end
+end

data/lib/ocfl/inventory_validator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OCFL
+  # Checks to see that the inventory.json and it's checksum in a direcotory are valid
+  class InventoryValidator
+    def initialize(directory:)
+      @directory = Pathname.new(directory)
+    end
+
+    attr_reader :directory
+
+    def valid?
+      inventory_file_exists? && inventory_file_matches_checksum?
+    end
+
+    def inventory_file_exists?
+      File.exist?(inventory_file)
+    end
+
+    def inventory_file_matches_checksum?
+      return false unless File.exist?(inventory_checksum_file)
+
+      actual = inventory_file_checksum
+      expected = File.read(inventory_checksum_file)
+      expected.match?(/\A#{actual}\s+inventory\.json\z/)
+    end
+
+    def inventory_checksum_file
+      directory / "inventory.json.sha512"
+    end
+
+    def inventory_file_checksum
+      Digest::SHA512.file inventory_file
+    end
+
+    def inventory_file
+      directory / "inventory.json"
+    end
+  end
+end

data/lib/ocfl/inventory_writer.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OCFL
+  # Writes a OCFL Inventory to json on disk
+  class InventoryWriter
+    def initialize(inventory:, path:)
+      @path = path
+      @inventory = inventory
+    end
+
+    attr_reader :inventory, :path
+
+    def write
+      write_inventory
+      update_inventory_checksum
+    end
+
+    def write_inventory
+      File.write(inventory_file, JSON.pretty_generate(inventory.to_h))
+    end
+
+    def inventory_file
+      path / "inventory.json"
+    end
+
+    def checksum_file
+      path / "inventory.json.sha512"
+    end
+
+    def update_inventory_checksum
+      digest = Digest::SHA512.file inventory_file
+      File.write(checksum_file, "#{digest} inventory.json")
+    end
+  end
+end

data/lib/ocfl/layouts/druid_tree.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OCFL
+  module Layouts
+    # An OCFL Storage Root layout for the druid-tree structure
+    # @see https://ocfl.io/1.1/spec/#root-structure
+    class DruidTree
+      DRUID_PARTS_PATTERN = /\A([b-df-hjkmnp-tv-z]{2})([0-9]{3})([b-df-hjkmnp-tv-z]{2})([0-9]{4})\z/i
+
+      def self.path_to(identifier)
+        segments = Array(identifier&.match(DRUID_PARTS_PATTERN)&.captures)
+
+        raise "druid '#{identifier}' is invalid" unless segments.count == 4
+
+        Pathname.new(
+          File.join(segments)
+        )
+      end
+    end
+  end
+end

data/lib/ocfl/object.rb

@@ -3,7 +3,143 @@
 module OCFL
   # An OCFL Object is a group of one or more content files and administrative information
   # https://ocfl.io/1.1/spec/#object-spec
-  module Object
+  class Object
     class FileNotFound < RuntimeError; end
+
+    # @param [String] identifier an object identifier
+    # @param [Pathname, String] root the path to the object root within the OCFL structure
+    # @param [Inventory, nil] inventory this is only passed in when creating a new version
+    # @param [String, nil] content_directory the directory to store versions in
+    def initialize(root:, identifier:, inventory: nil, content_directory: nil)
+      @identifier = identifier
+      @root = Pathname.new(root)
+      @content_directory = content_directory
+      @version_inventory = {}
+      @version_inventory_errors = {}
+      @inventory = inventory
+    end
+
+    attr_reader :root, :errors, :identifier
+
+    delegate :head, :versions, :manifest, to: :inventory
+
+    def exists?
+      namaste_file.exist?
+    end
+
+    def path(filepath:, version: nil)
+      version ||= head
+      relative_path = version_inventory(version).path(filepath)
+
+      raise FileNotFound, "Path '#{filepath}' not found in #{version} inventory" if relative_path.nil?
+
+      root / relative_path
+    end
+
+    def inventory
+      @inventory ||= begin
+        maybe_inventory, inventory_loading_errors = load_or_initialize_inventory
+        if maybe_inventory
+          maybe_inventory
+        else
+          @errors = inventory_loading_errors
+          puts @errors.messages.inspect
+          nil
+        end
+      end
+    end
+
+    def head_inventory
+      version_inventory(inventory.head)
+    end
+
+    def version_inventory(version)
+      @version_inventory[version] ||= begin
+        maybe_inventory, inventory_loading_errors = load_or_initialize_inventory(version:)
+        if maybe_inventory
+          maybe_inventory
+        else
+          @version_inventory_errors[version] = inventory_loading_errors
+          puts @version_inventory_errors[version].messages.inspect
+          nil
+        end
+      end
+    end
+
+    def valid?
+      InventoryValidator.new(directory: root).valid? &&
+        exists? &&
+        !inventory.nil? && # Ensures it could be loaded
+        head_directory_valid?
+    end
+
+    def head_directory_valid?
+      InventoryValidator.new(directory: root / inventory.head).valid? &&
+        !head_inventory.nil? # Ensures it could be loaded
+    end
+
+    # Start a completely new version
+    def begin_new_version
+      VersionBuilder.new(object: self, state:)
+    end
+
+    # Get a handle for the head version
+    def head_version
+      VersionBuilder.new(object: self, overwrite_head: true, state: head_inventory.state)
+    end
+
+    # Get a handle that will replace the existing head version
+    def overwrite_current_version
+      VersionBuilder.new(object: self, overwrite_head: true)
+    end
+
+    def reload
+      @version_inventory = {}
+      @inventory = nil
+      @errors = nil
+      @version_inventory_errors = {}
+      true
+    end
+
+    def namaste_file
+      root / "0=ocfl_object_1.1"
+    end
+
+    private
+
+    def load_or_initialize_inventory(version: "")
+      inventory_path = root / version / "inventory.json"
+
+      return [new_inventory, nil] unless inventory_path.exist?
+
+      data = InventoryLoader.load(inventory_path)
+      if data.success?
+        [Inventory.new(data: data.value!), nil]
+      else
+        [nil, data.failure]
+      end
+    end
+
+    def state
+      return {} if inventory.head == "v0"
+
+      head_inventory.state
+    end
+
+    def new_inventory # rubocop:disable Metrics/MethodLength
+      Inventory.new(
+        data: Inventory::InventoryStruct.new(
+          {
+            id: identifier,
+            version: "v0",
+            type: Inventory::URI_1_1,
+            digestAlgorithm: "sha512",
+            head: "v0",
+            versions: {},
+            manifest: {}
+          }.tap { |attrs| attrs[:contentDirectory] = @content_directory if @content_directory }
+        )
+      )
+    end
   end
 end

data/lib/ocfl/object_version.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OCFL
+  # Represents the OCFL version
+  # https://ocfl.io/1.1/spec/#version
+  class ObjectVersion < Dry.Struct
+    # Represents the OCFL user
+    class User < Dry.Struct
+      transform_keys(&:to_sym)
+      attribute :name, Types::String
+      attribute? :address, Types::String
+    end
+
+    transform_keys(&:to_sym)
+    attribute :created, Types::String
+    attribute :state, Types::Hash.map(Types::String, Types::Array.of(Types::String))
+    attribute? :message, Types::String
+    attribute? :user, User
+
+    def file_names
+      state.values.flatten
+    end
+  end
+end

data/lib/ocfl/storage_root.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module OCFL
+  # An OCFL Storage Root is the base directory of an OCFL storage layout.
+  # https://ocfl.io/1.1/spec/#storage-root
+  class StorageRoot
+    attr_reader :base_directory, :layout
+
+    delegate :path_to, to: :layout
+
+    def initialize(base_directory:)
+      @base_directory = Pathname.new(base_directory)
+      @layout = Layouts::DruidTree
+    end
+
+    def exists?
+      base_directory.directory?
+    end
+
+    def valid?
+      namaste_file.exist?
+    end
+
+    def save
+      # TODO: optionally write the OCFL 1.1 spec
+      # TODO: optionally write any given extensions (like the TBD druid-tree layout)
+      return if exists? && valid?
+
+      FileUtils.mkdir_p(base_directory)
+      FileUtils.touch(namaste_file)
+      true
+    end
+
+    def object(identifier, content_directory = nil)
+      root = base_directory / path_to(identifier)
+
+      Object.new(identifier:, root:, content_directory:)
+    end
+
+    private
+
+    def namaste_file
+      base_directory / "0=ocfl_1.1"
+    end
+  end
+end

data/lib/ocfl/version.rb

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

data/lib/ocfl/version_builder.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module OCFL
+  # Build a new version
+  class VersionBuilder
+    # @params [Object] object
+    def initialize(object:, overwrite_head: false, state: {})
+      @object = object
+      @manifest = object.inventory.manifest.dup
+      @state = state
+
+      number = object.head.delete_prefix("v").to_i
+      @version_number = "v#{overwrite_head ? number : number + 1}"
+      @prepared_content = @prepared = overwrite_head
+    end
+
+    attr_reader :object, :manifest, :state, :version_number
+
+    delegate :file_names, to: :to_version_struct
+
+    def move_file(incoming_path)
+      prepare_content_directory
+      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(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.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
+      incoming_path = incoming_path.delete_suffix("/")
+      Dir.glob("#{incoming_path}/**/*").reject { |fn| File.directory?(fn) }.each do |file|
+        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
+
+    def save
+      prepare_directory # only necessary if the version has no new content (deletes only)
+      write_inventory(build_inventory)
+      object.reload
+    end
+
+    private
+
+    def to_version_struct
+      ObjectVersion.new(state:, created: Time.now.utc.iso8601)
+    end
+
+    def write_inventory(inventory)
+      InventoryWriter.new(inventory:, path:).write
+      FileUtils.cp(path / "inventory.json", object.root)
+      FileUtils.cp(path / "inventory.json.sha512", object.root)
+    end
+
+    # @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.root)
+      file_path_relative_to_root = (version_content_path / logical_file_path).to_s
+      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
+      prepare_directory
+      return if @prepared_content
+
+      FileUtils.mkdir(content_path)
+      @prepared_content = true
+    end
+
+    def prepare_directory
+      return if @prepared
+
+      FileUtils.mkdir_p(path)
+      FileUtils.touch(object.namaste_file) if version_number == "v1"
+      @prepared = true
+    end
+
+    def content_path
+      path / object.inventory.content_directory
+    end
+
+    def path
+      object.root / version_number
+    end
+
+    def build_inventory
+      old_data = object.inventory.data
+      versions = versions(old_data.versions)
+
+      # 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
+
+    # 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 => 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
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocfl
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.1
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-31 00:00:00.000000000 Z
+date: 2024-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -92,16 +92,16 @@ files:
 - README.md
 - Rakefile
 - lib/ocfl.rb
+- lib/ocfl/inventory.rb
+- lib/ocfl/inventory_loader.rb
+- lib/ocfl/inventory_validator.rb
+- lib/ocfl/inventory_writer.rb
+- lib/ocfl/layouts/druid_tree.rb
 - lib/ocfl/object.rb
-- lib/ocfl/object/directory.rb
-- lib/ocfl/object/directory_builder.rb
-- lib/ocfl/object/draft_version.rb
-- lib/ocfl/object/inventory.rb
-- lib/ocfl/object/inventory_loader.rb
-- lib/ocfl/object/inventory_validator.rb
-- lib/ocfl/object/inventory_writer.rb
-- lib/ocfl/object/version.rb
+- lib/ocfl/object_version.rb
+- lib/ocfl/storage_root.rb
 - lib/ocfl/version.rb
+- lib/ocfl/version_builder.rb
 - sig/ocfl.rbs
 - tmp/.keep
 homepage: https://github.com/sul-dlss/ocfl-rb
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: A ruby library for interacting with the Oxford Common File Layout (OCFL)

data/lib/ocfl/object/directory.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-module OCFL
-  module Object
-    # An OCFL Directory layout for a particular object.
-    class Directory
-      # @param [String] object_root
-      # @param [Inventory] inventory this is only passed in when creating a new object. (see DirectoryBuilder)
-      def initialize(object_root:, inventory: nil)
-        @object_root = Pathname.new(object_root)
-        @version_inventory = {}
-        @version_inventory_errors = {}
-        @inventory = inventory
-      end
-
-      attr_reader :object_root, :errors
-
-      delegate :head, :versions, :manifest, to: :inventory
-
-      def path(filepath:, version: nil)
-        version ||= head
-        relative_path = version_inventory(version).path(filepath)
-
-        raise FileNotFound, "Path '#{filepath}' not found in #{version} inventory" if relative_path.nil?
-
-        object_root / relative_path
-      end
-
-      def inventory
-        @inventory ||= begin
-          data = InventoryLoader.load(object_root / "inventory.json")
-          if data.success?
-            Inventory.new(data: data.value!)
-          else
-            @errors = data.failure
-            puts @errors.messages.inspect
-            nil
-          end
-        end
-      end
-
-      def head_inventory
-        version_inventory(inventory.head)
-      end
-
-      def version_inventory(version)
-        @version_inventory[version] ||= begin
-          data = InventoryLoader.load(object_root / version / "inventory.json")
-          if data.success?
-            Inventory.new(data: data.value!)
-          else
-            @version_inventory_errors[version] = data.failure
-            puts @version_inventory_errors[version].messages.inspect
-            nil
-          end
-        end
-      end
-
-      def reload
-        @version_inventory = {}
-        @inventory = nil
-        @errors = nil
-        @version_inventory_errors = {}
-        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
-
-      def exists?
-        namaste_exists?
-      end
-
-      def valid?
-        InventoryValidator.new(directory: object_root).valid? &&
-          namaste_exists? &&
-          !inventory.nil? && # Ensures it could be loaded
-          head_directory_valid?
-      end
-
-      def head_directory_valid?
-        InventoryValidator.new(directory: object_root / inventory.head).valid? &&
-          !head_inventory.nil? # Ensures it could be loaded
-      end
-
-      def namaste_exists?
-        File.exist?(namaste_file)
-      end
-
-      def namaste_file
-        object_root / "0=ocfl_object_1.1"
-      end
-    end
-  end
-end

data/lib/ocfl/object/directory_builder.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module OCFL
-  module Object
-    # Creates a OCFL Directory layout for a particular object.
-    class DirectoryBuilder
-      class ObjectExists < Error; end
-
-      def initialize(object_root:, id:, content_directory: nil)
-        @object_root = Pathname.new(object_root)
-        raise ObjectExists, "The directory `#{object_root}' already exists" if @object_root.exist?
-
-        @id = id
-        inventory = Inventory.new(
-          data: Inventory::InventoryStruct.new(
-            new_inventory_attrs.tap { |attrs| attrs[:contentDirectory] = content_directory if content_directory }
-          )
-        )
-        @object_directory = Directory.new(object_root:, inventory:)
-      end
-
-      attr_reader :id, :inventory, :object_root, :object_directory
-
-      def copy_file(...)
-        create_object_directory
-        version.copy_file(...)
-      end
-
-      def copy_recursive(...)
-        create_object_directory
-        version.copy_recursive(...)
-      end
-
-      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
-        create_object_directory
-        write_inventory
-        object_directory
-      end
-
-      def version
-        @version ||= DraftVersion.new(object_directory:)
-      end
-
-      def write_inventory
-        version.save
-      end
-
-      private
-
-      def new_inventory_attrs
-        {
-          id:,
-          version: "v0",
-          type: Inventory::URI_1_1,
-          digestAlgorithm: "sha512",
-          head: "v0",
-          versions: {},
-          manifest: {}
-        }
-      end
-    end
-  end
-end

data/lib/ocfl/object/draft_version.rb

@@ -1,153 +0,0 @@
-# frozen_string_literal: true
-
-module OCFL
-  module Object
-    # A new OCFL version
-    class DraftVersion
-      # @params [Directory] object_directory
-      def initialize(object_directory:, overwrite_head: false, state: {})
-        @object_directory = object_directory
-        @manifest = object_directory.inventory.manifest.dup
-        @state = state
-
-        number = object_directory.head.delete_prefix("v").to_i
-        @version_number = "v#{overwrite_head ? number : number + 1}"
-        @prepared_content = @prepared = overwrite_head
-      end
-
-      attr_reader :object_directory, :manifest, :state, :version_number
-
-      delegate :file_names, to: :to_version_struct
-
-      def move_file(incoming_path)
-        prepare_content_directory
-        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(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
-      def copy_recursive(incoming_path, destination_path: "")
-        prepare_content_directory
-        incoming_path = incoming_path.delete_suffix("/")
-        Dir.glob("#{incoming_path}/**/*").reject { |fn| File.directory?(fn) }.each do |file|
-          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
-
-      def save
-        prepare_directory # only necessary if the version has no new content (deletes only)
-        write_inventory(build_inventory)
-        object_directory.reload
-      end
-
-      def to_version_struct
-        Version.new(state:, created: Time.now.utc.iso8601)
-      end
-
-      private
-
-      def write_inventory(inventory)
-        InventoryWriter.new(inventory:, path:).write
-        FileUtils.cp(path / "inventory.json", object_directory.object_root)
-        FileUtils.cp(path / "inventory.json.sha512", object_directory.object_root)
-      end
-
-      # @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
-        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
-        prepare_directory
-        return if @prepared_content
-
-        FileUtils.mkdir(content_path)
-        @prepared_content = true
-      end
-
-      def prepare_directory
-        return if @prepared
-
-        FileUtils.mkdir(path)
-        @prepared = true
-      end
-
-      def content_path
-        path / object_directory.inventory.content_directory
-      end
-
-      def path
-        object_directory.object_root / version_number
-      end
-
-      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
-        Inventory::InventoryStruct.new(old_data.to_h.merge(manifest: filtered_manifest(versions),
-                                                           head: version_number, versions:))
-      end
-
-      # 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 => 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
-      end
-    end
-  end
-end

data/lib/ocfl/object/inventory.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module OCFL
-  module Object
-    # Represents the JSON file that stores the object inventory
-    # https://ocfl.io/1.1/spec/#inventory
-    class Inventory
-      URI_1_1 = "https://ocfl.io/1.1/spec/#inventory"
-
-      # A data structure for the inventory
-      class InventoryStruct < Dry::Struct
-        transform_keys(&:to_sym)
-        attribute :id, Types::String
-        attribute :type, Types::String
-        attribute :digestAlgorithm, Types::String
-        attribute :head, Types::String
-        attribute? :contentDirectory, Types::String
-        attribute :versions, Types::Hash.map(Types::String, Version)
-        attribute :manifest, Types::Hash
-      end
-
-      def initialize(data:)
-        @data = data
-      end
-
-      attr_reader :errors, :data
-
-      delegate :id, :head, :versions, :manifest, to: :data
-      delegate :state, to: :head_version
-
-      def content_directory
-        data.contentDirectory || "content"
-      end
-
-      # @return [String,nil] the path to the file relative to the object root. (e.g. v2/content/image.tiff)
-      def path(logical_path)
-        digest, = state.find { |_, logical_paths| logical_paths.include?(logical_path) }
-
-        return unless digest
-
-        manifest[digest].find { |content_path| content_path.match(%r{\Av\d+/#{content_directory}/#{logical_path}\z}) }
-      end
-
-      def head_version
-        versions[head]
-      end
-    end
-  end
-end

data/lib/ocfl/object/inventory_loader.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module OCFL
-  module Object
-    # Loads and Inventory object from JSON
-    class InventoryLoader
-      include Dry::Monads[:result]
-
-      VersionEnum = Types::String.enum(Inventory::URI_1_1)
-      DigestAlgorithm = Types::String.enum("md5", "sha1", "sha256", "sha512", "blake2b-512")
-
-      # https://ocfl.io/1.1/spec/#inventory-structure
-      # Validation of the incoming data
-      Schema = Dry::Schema.Params do
-        # config.validate_keys = true
-        required(:id).filled(:string)
-        required(:type).filled(VersionEnum)
-        required(:digestAlgorithm).filled(DigestAlgorithm)
-        required(:head).filled(:string)
-        optional(:contentDirectory).filled(:string)
-        required(:versions).hash
-        required(:manifest).hash
-      end
-
-      def self.load(file_name)
-        new(file_name).load
-      end
-
-      def initialize(file_name)
-        @file_name = file_name
-      end
-
-      def load
-        bytestream = File.read(@file_name)
-        data = JSON.parse(bytestream)
-        errors = Schema.call(data).errors
-        if errors.empty?
-          Success(Inventory::InventoryStruct.new(data))
-        else
-          Failure(errors)
-        end
-      end
-    end
-  end
-end

data/lib/ocfl/object/inventory_validator.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module OCFL
-  module Object
-    # Checks to see that the inventory.json and it's checksum in a direcotory are valid
-    class InventoryValidator
-      def initialize(directory:)
-        @directory = Pathname.new(directory)
-      end
-
-      attr_reader :directory
-
-      def valid?
-        inventory_file_exists? && inventory_file_matches_checksum?
-      end
-
-      def inventory_file_exists?
-        File.exist?(inventory_file)
-      end
-
-      def inventory_file_matches_checksum?
-        return false unless File.exist?(inventory_checksum_file)
-
-        actual = inventory_file_checksum
-        expected = File.read(inventory_checksum_file)
-        expected.match?(/\A#{actual}\s+inventory\.json\z/)
-      end
-
-      def inventory_checksum_file
-        directory / "inventory.json.sha512"
-      end
-
-      def inventory_file_checksum
-        Digest::SHA512.file inventory_file
-      end
-
-      def inventory_file
-        directory / "inventory.json"
-      end
-    end
-  end
-end

data/lib/ocfl/object/inventory_writer.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module OCFL
-  module Object
-    # Writes a OCFL Inventory to json on disk
-    class InventoryWriter
-      def initialize(inventory:, path:)
-        @path = path
-        @inventory = inventory
-      end
-
-      attr_reader :inventory, :path
-
-      def write
-        write_inventory
-        update_inventory_checksum
-      end
-
-      def write_inventory
-        File.write(inventory_file, JSON.pretty_generate(inventory.to_h))
-      end
-
-      def inventory_file
-        path / "inventory.json"
-      end
-
-      def checksum_file
-        path / "inventory.json.sha512"
-      end
-
-      def update_inventory_checksum
-        digest = Digest::SHA512.file inventory_file
-        File.write(checksum_file, "#{digest} inventory.json")
-      end
-    end
-  end
-end

data/lib/ocfl/object/version.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module OCFL
-  module Object
-    # Represents the OCFL version
-    # https://ocfl.io/1.1/spec/#version
-    class Version < Dry.Struct
-      # Represents the OCFL user
-      class User < Dry.Struct
-        transform_keys(&:to_sym)
-        attribute :name, Types::String
-        attribute? :address, Types::String
-      end
-
-      transform_keys(&:to_sym)
-      attribute :created, Types::String
-      attribute :state, Types::Hash.map(Types::String, Types::Array.of(Types::String))
-      attribute? :message, Types::String
-      attribute? :user, User
-
-      def file_names
-        state.values.flatten
-      end
-    end
-  end
-end