ocfl 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 256cd51a71d4728f32b12904cd02153e92a3a054e0b7b9ee7f18f7aca7a34320
-  data.tar.gz: d8bfb5f8571e998710fb6e7e5f245e7723886d3db26c0c54537f2b172d456d46
+  metadata.gz: 734c2a614db8c30eb86ddd0c7a32b6c10d813adb9ae5244d50614f35244c64cd
+  data.tar.gz: 4b5daffdbd581fe38974975a7f9e6dfcef734d078833b0eb030d750aacc7b18e
 SHA512:
-  metadata.gz: e3aad0f2020ef90a36b3fdf71129e9bd84fce068e665eecb08e00d37cd897d7d5c91298ed8dfaadc0b6d8a27060cb5306eb85bbbe630267fb8889989279a795f
-  data.tar.gz: '07609a37af93df25a2d836f46d42591972514265272f6a4fe3e1bf333198f7c98eae07e8ce5f21499967340627a2013f2f6e450433af3824f0146d855f0c03c8'
+  metadata.gz: 8c67987902f4adc67c8c250af66568872b9f3e9ca9cd9a3df60f26702e4ac16bfb6aea9e44628f427fe910af548ebc534436005e857f15cc3d47e4a31cc667a3
+  data.tar.gz: 857a0a20ee5a57c6b7087ef43264dbe2d3fd9b258175cc9449885a4b0eb1d56823cfe87eccad9bb86c5efc26ce5c2433e0465d6c5b0e425523668a18a7131e6a

data/.rubocop.yml

@@ -1,3 +1,8 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 3.1
 
@@ -17,8 +22,14 @@ Metrics/BlockLength:
     - describe
     - context
 
-Style/StringConcatenation:
-  Enabled: false # Too many false positives with Pathname#+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/NestedGroups:
+  Max: 4
 
 Gemspec/DeprecatedAttributeAssignment: # new in 1.30
   Enabled: true
@@ -219,4 +230,148 @@ Style/SuperWithArgsParentheses: # new in 1.58
 Style/SwapValues: # new in 1.1
   Enabled: true
 Style/YAMLFileRead: # new in 1.53
-  Enabled: true
+  Enabled: true
+Style/MapIntoArray: # new in 1.63
+  Enabled: true
+Performance/AncestorsInclude: # new in 1.7
+  Enabled: true
+Performance/BigDecimalWithNumericArgument: # new in 1.7
+  Enabled: true
+Performance/BlockGivenWithExplicitBlock: # new in 1.9
+  Enabled: true
+Performance/CollectionLiteralInLoop: # new in 1.8
+  Enabled: true
+Performance/ConcurrentMonotonicTime: # new in 1.12
+  Enabled: true
+Performance/ConstantRegexp: # new in 1.9
+  Enabled: true
+Performance/MapCompact: # new in 1.11
+  Enabled: true
+Performance/MapMethodChain: # new in 1.19
+  Enabled: true
+Performance/MethodObjectAsBlock: # new in 1.9
+  Enabled: true
+Performance/RedundantEqualityComparisonBlock: # new in 1.10
+  Enabled: true
+Performance/RedundantSortBlock: # new in 1.7
+  Enabled: true
+Performance/RedundantSplitRegexpArgument: # new in 1.10
+  Enabled: true
+Performance/RedundantStringChars: # new in 1.7
+  Enabled: true
+Performance/ReverseFirst: # new in 1.7
+  Enabled: true
+Performance/SortReverse: # new in 1.7
+  Enabled: true
+Performance/Squeeze: # new in 1.7
+  Enabled: true
+Performance/StringIdentifierArgument: # new in 1.13
+  Enabled: true
+Performance/StringInclude: # new in 1.7
+  Enabled: true
+Performance/Sum: # new in 1.8
+  Enabled: true
+Capybara/ClickLinkOrButtonStyle: # new in 2.19
+  Enabled: true
+Capybara/MatchStyle: # new in 2.17
+  Enabled: true
+Capybara/NegationMatcher: # new in 2.14
+  Enabled: true
+Capybara/RedundantWithinFind: # new in 2.20
+  Enabled: true
+Capybara/SpecificActions: # new in 2.14
+  Enabled: true
+Capybara/SpecificFinders: # new in 2.13
+  Enabled: true
+Capybara/SpecificMatcher: # new in 2.12
+  Enabled: true
+Capybara/RSpec/HaveSelector: # new in 2.19
+  Enabled: true
+Capybara/RSpec/PredicateMatcher: # new in 2.19
+  Enabled: true
+FactoryBot/AssociationStyle: # new in 2.23
+  Enabled: true
+FactoryBot/ConsistentParenthesesStyle: # new in 2.14
+  Enabled: true
+FactoryBot/ExcessiveCreateList: # new in 2.25
+  Enabled: true
+FactoryBot/FactoryAssociationWithStrategy: # new in 2.23
+  Enabled: true
+FactoryBot/FactoryNameStyle: # new in 2.16
+  Enabled: true
+FactoryBot/IdSequence: # new in 2.24
+  Enabled: true
+FactoryBot/RedundantFactoryOption: # new in 2.23
+  Enabled: true
+FactoryBot/SyntaxMethods: # new in 2.7
+  Enabled: true
+RSpecRails/AvoidSetupHook: # new in 2.4
+  Enabled: true
+RSpecRails/HaveHttpStatus: # new in 2.12
+  Enabled: true
+RSpecRails/InferredSpecType: # new in 2.14
+  Enabled: true
+RSpecRails/MinitestAssertions: # new in 2.17
+  Enabled: true
+RSpecRails/NegationBeValid: # new in 2.23
+  Enabled: true
+RSpecRails/TravelAround: # new in 2.19
+  Enabled: true
+RSpec/BeEmpty: # new in 2.20
+  Enabled: true
+RSpec/BeEq: # new in 2.9.0
+  Enabled: true
+RSpec/BeNil: # new in 2.9.0
+  Enabled: true
+RSpec/ChangeByZero: # new in 2.11
+  Enabled: true
+RSpec/ContainExactly: # new in 2.19
+  Enabled: true
+RSpec/DuplicatedMetadata: # new in 2.16
+  Enabled: true
+RSpec/EmptyMetadata: # new in 2.24
+  Enabled: true
+RSpec/EmptyOutput: # new in 2.29
+  Enabled: true
+RSpec/Eq: # new in 2.24
+  Enabled: true
+RSpec/ExcessiveDocstringSpacing: # new in 2.5
+  Enabled: true
+RSpec/IdenticalEqualityAssertion: # new in 2.4
+  Enabled: true
+RSpec/IndexedLet: # new in 2.20
+  Enabled: true
+RSpec/IsExpectedSpecify: # new in 2.27
+  Enabled: true
+RSpec/MatchArray: # new in 2.19
+  Enabled: true
+RSpec/MetadataStyle: # new in 2.24
+  Enabled: true
+RSpec/NoExpectationExample: # new in 2.13
+  Enabled: true
+RSpec/PendingWithoutReason: # new in 2.16
+  Enabled: true
+RSpec/ReceiveMessages: # new in 2.23
+  Enabled: true
+RSpec/RedundantAround: # new in 2.19
+  Enabled: true
+RSpec/RedundantPredicateMatcher: # new in 2.26
+  Enabled: true
+RSpec/RemoveConst: # new in 2.26
+  Enabled: true
+RSpec/RepeatedSubjectCall: # new in 2.27
+  Enabled: true
+RSpec/SkipBlockInsideExample: # new in 2.19
+  Enabled: true
+RSpec/SortMetadata: # new in 2.14
+  Enabled: true
+RSpec/SpecFilePathFormat: # new in 2.24
+  Enabled: true
+RSpec/SpecFilePathSuffix: # new in 2.24
+  Enabled: true
+RSpec/SubjectDeclaration: # new in 2.5
+  Enabled: true
+RSpec/UndescriptiveLiteralsDescription: # new in 2.29
+  Enabled: true
+RSpec/VerifiedDoubleReference: # new in 2.10.0
+  Enabled: true

data/README.md

@@ -35,15 +35,29 @@ new_version.save
 directory.head
 # => 'v2'
 
-directory.path("v2", "ocfl.rbs")
+# List file names that were part of a given version
+directory.versions['v2'].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>
+
+# 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>
 
-directory.path(:head, "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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "digest"
-
 module OCFL
   module Object
     # An OCFL Directory layout for a particular object.
@@ -19,15 +17,22 @@ module OCFL
 
       delegate :head, :versions, :manifest, to: :inventory
 
-      def path(version, filename)
+      def path(filepath:, version: nil)
         version = head if version == :head
-        relative_path = version_inventory(version).path(filename)
-        object_root + relative_path
+        relative_path = if version
+                          version_inventory(version).path(filepath)
+                        else
+                          inventory.path(filepath)
+                        end
+
+        raise FileNotFound, "Path '#{filepath}' not found in #{version || "object"} inventory" if relative_path.nil?
+
+        object_root / relative_path
       end
 
       def inventory
         @inventory ||= begin
-          data = InventoryLoader.load(object_root + "inventory.json")
+          data = InventoryLoader.load(object_root / "inventory.json")
           if data.success?
             Inventory.new(data: data.value!)
           else
@@ -44,7 +49,7 @@ module OCFL
 
       def version_inventory(version)
         @version_inventory[version] ||= begin
-          data = InventoryLoader.load(object_root + version + "inventory.json")
+          data = InventoryLoader.load(object_root / version / "inventory.json")
           if data.success?
             Inventory.new(data: data.value!)
           else
@@ -60,12 +65,17 @@ module OCFL
         @inventory = nil
         @errors = nil
         @version_inventory_errors = {}
+        true
       end
 
       def begin_new_version
         DraftVersion.new(object_directory: self)
       end
 
+      def clone_current_version
+        DraftVersion.new(object_directory: self, state: head_inventory.state)
+      end
+
       def overwrite_current_version
         DraftVersion.new(object_directory: self, overwrite_head: true)
       end
@@ -82,7 +92,7 @@ module OCFL
       end
 
       def head_directory_valid?
-        InventoryValidator.new(directory: object_root + inventory.head).valid? &&
+        InventoryValidator.new(directory: object_root / inventory.head).valid? &&
           !head_inventory.nil? # Ensures it could be loaded
       end
 
@@ -91,9 +101,8 @@ module OCFL
       end
 
       def namaste_file
-        object_root + "0=ocfl_object_1.1"
+        object_root / "0=ocfl_object_1.1"
       end
     end
-    # rubocop:enable Style/StringConcatenation
   end
 end

data/lib/ocfl/object/directory_builder.rb

@@ -1,21 +1,25 @@
 # frozen_string_literal: true
 
-require "digest"
-
 module OCFL
   module Object
     # Creates a OCFL Directory layout for a particular object.
     class DirectoryBuilder
       class ObjectExists < Error; end
 
-      def initialize(object_root:, id:)
+      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, :object_root, :object_directory
+      attr_reader :id, :inventory, :object_root, :object_directory
 
       def copy_file(...)
         create_object_directory
@@ -33,28 +37,33 @@ module OCFL
 
       # @return [Directory]
       def save
-        version_path = object_root + "v1"
-        FileUtils.mkdir_p(version_path) unless version_path.exist? # in case no files were added
-
-        FileUtils.touch(object_root + "0=ocfl_object_1.1")
+        FileUtils.mkdir_p(object_root)
+        FileUtils.touch(object_directory.namaste_file)
         write_inventory
         object_directory
       end
 
       def version
-        @version ||= begin
-          data = Inventory::InventoryStruct.new(id:, version: "v0", type: Inventory::URI_1_1, digestAlgorithm: "sha512",
-                                                head: "v0", versions: {}, manifest: {})
-          inventory = Inventory.new(data:)
-          @object_directory = Directory.new(object_root: @object_root, inventory:)
-          DraftVersion.new(object_directory:)
-        end
+        @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
-    # rubocop:enable Style/StringConcatenation
   end
 end

data/lib/ocfl/object/draft_version.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
-require "digest"
-
 module OCFL
   module Object
     # A new OCFL version
     class DraftVersion
       # @params [Directory] object_directory
-      def initialize(object_directory:, overwrite_head: false)
+      def initialize(object_directory:, overwrite_head: false, state: {})
         @object_directory = object_directory
         @manifest = object_directory.inventory.manifest.dup
-        @state = {}
+        @state = state
 
         number = object_directory.head.delete_prefix("v").to_i
         @version_number = "v#{overwrite_head ? number : number + 1}"
@@ -25,13 +23,13 @@ module OCFL
         FileUtils.mv(incoming_path, content_path)
       end
 
-      def copy_file(incoming_path, destination_path: '')
+      def copy_file(incoming_path, destination_path: "")
         prepare_content_directory
         copy_one(File.basename(incoming_path), incoming_path, destination_path)
       end
 
       # Copies files into the object and preserves their relative paths as logical directories in the object
-      def copy_recursive(incoming_path, destination_path: '')
+      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|
@@ -40,27 +38,31 @@ module OCFL
       end
 
       def save
-        inventory = build_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)
+        prepare_directory # only necessary if the version has no new content (deletes only)
+        write_inventory(build_inventory)
         object_directory.reload
       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
+
       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:)
-        parent_dir = (content_path + logical_file_path).parent
+        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)
+        FileUtils.cp(incoming_path, content_path / logical_file_path)
       end
 
       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
+        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]
       end
@@ -81,11 +83,11 @@ module OCFL
       end
 
       def content_path
-        path + "content"
+        path / object_directory.inventory.content_directory
       end
 
       def path
-        object_directory.object_root + version_number
+        object_directory.object_root / version_number
       end
 
       def build_inventory

data/lib/ocfl/object/inventory.rb

@@ -26,18 +26,25 @@ module OCFL
       attr_reader :errors, :data
 
       delegate :id, :head, :versions, :manifest, to: :data
+      delegate :state, to: :head_version
 
       def content_directory
         data.contentDirectory || "content"
       end
 
-      # @returns [String] the path to the file relative to the object root. (e.g. v2/content/image.tiff)
+      # @return [String,nil] the path to the file relative to the object root. (e.g. v2/content/image.tiff)
       def path(logical_path)
-        sha = versions[head].state.find { |_sha, file_names| file_names.include?(logical_path) }&.first
+        matching_paths = manifest.values.flatten.select do |path|
+          path.match(%r{\Av\d+/#{content_directory}/#{logical_path}\z})
+        end
 
-        return unless sha
+        return if matching_paths.empty?
 
-        manifest.fetch(sha).first
+        matching_paths.max_by { |path| path[/\d+/].to_i }
+      end
+
+      def head_version
+        versions[head]
       end
     end
   end

data/lib/ocfl/object/inventory_validator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "digest"
-
 module OCFL
   module Object
     # Checks to see that the inventory.json and it's checksum in a direcotory are valid
@@ -29,7 +27,7 @@ module OCFL
       end
 
       def inventory_checksum_file
-        directory + "inventory.json.sha512"
+        directory / "inventory.json.sha512"
       end
 
       def inventory_file_checksum
@@ -37,9 +35,8 @@ module OCFL
       end
 
       def inventory_file
-        directory + "inventory.json"
+        directory / "inventory.json"
       end
     end
-    # rubocop:enable Style/StringConcatenation
   end
 end

data/lib/ocfl/object/inventory_writer.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "digest"
-
 module OCFL
   module Object
     # Writes a OCFL Inventory to json on disk
@@ -23,11 +21,11 @@ module OCFL
       end
 
       def inventory_file
-        path + "inventory.json"
+        path / "inventory.json"
       end
 
       def checksum_file
-        path + "inventory.json.sha512"
+        path / "inventory.json.sha512"
       end
 
       def update_inventory_checksum
@@ -35,6 +33,5 @@ module OCFL
         File.write(checksum_file, "#{digest} inventory.json")
       end
     end
-    # rubocop:enable Style/StringConcatenation
   end
 end

data/lib/ocfl/object/version.rb

@@ -17,6 +17,10 @@ module OCFL
       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

data/lib/ocfl/object.rb

@@ -3,5 +3,7 @@
 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; end
+  module Object
+    class FileNotFound < RuntimeError; end
+  end
 end

data/lib/ocfl/version.rb

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

data/lib/ocfl.rb

@@ -1,25 +1,16 @@
 # frozen_string_literal: true
 
-require_relative "ocfl/version"
 require "zeitwerk"
-require "json"
+require "active_support"
+require "active_support/core_ext/module/delegation"
+require "digest"
 require "dry/monads"
 require "dry-schema"
 require "dry-struct"
-require "active_support"
-require "active_support/core_ext/module/delegation"
-
-# Custom zeitwerk inflector for OCFL
-class OCFLInflector < Zeitwerk::Inflector
-  def camelize(basename, _abspath)
-    return "OCFL" if basename == "ocfl"
-
-    super
-  end
-end
+require "json"
 
 loader = Zeitwerk::Loader.for_gem
-loader.inflector = OCFLInflector.new
+loader.inflector.inflect("ocfl" => "OCFL")
 loader.setup
 
 module OCFL

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocfl
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2024-05-23 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.4
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: A ruby library for interacting with the Oxford Common File Layout (OCFL)