ocfl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b78d16d5b12ad0e134c313c3c68b62c5d008534615d9e91f8d4acc0e4e46fbd
+  data.tar.gz: 513c7bce75abd89c7516208b2320fb7fd302a32e2c1052ea636d069f02eef721
+SHA512:
+  metadata.gz: 575c5cc29088328fb7622bbf66c82779751952b11c6a6950e8e7d2e73eb43800cd187a5b681b3f2762dc0e4fa1aad88a6c63211bae1b94bcdf5f8986189d5e86
+  data.tar.gz: 05c1f6b0fd8819625b7fbc2209db416b2a84b6ae2383d18a1fefb5c963f3aa3e50322f1692dc009b45ec65c25e90d35c04b2911ea08b80ede22d41918158012c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,222 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  AllowedMethods:
+    - describe
+    - context
+
+Style/StringConcatenation:
+  Enabled: false # Too many false positives with Pathname#+
+
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Gemspec/DevelopmentDependencies: # new in 1.44
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: true
+Lint/DuplicateMatchPattern: # new in 1.50
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/ItWithoutArgumentsInBlock: # new in 1.59
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/LiteralAssignmentInCondition: # new in 1.58
+  Enabled: true
+Lint/MixedCaseRange: # new in 1.53
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RedundantRegexpQuantifiers: # new in 1.53
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRescue: # new in 1.43
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Metrics/CollectionLiteralLength: # new in 1.47
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/ArrayIntersect: # new in 1.40
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/ComparableClamp: # new in 1.44
+  Enabled: true
+Style/ConcatArrayLiterals: # new in 1.41
+  Enabled: true
+Style/DataInheritance: # new in 1.49
+  Enabled: true
+Style/DirEmpty: # new in 1.48
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/ExactRegexpMatch: # new in 1.51
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileEmpty: # new in 1.48
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MapToSet: # new in 1.42
+  Enabled: true
+Style/MinMaxComparison: # new in 1.42
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/OperatorMethodCall: # new in 1.37
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantArrayConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantConstantBase: # new in 1.40
+  Enabled: true
+Style/RedundantCurrentDirectoryInPath: # new in 1.53
+  Enabled: true
+Style/RedundantDoubleSplatHashBraces: # new in 1.41
+  Enabled: true
+Style/RedundantEach: # new in 1.38
+  Enabled: true
+Style/RedundantFilterChain: # new in 1.52
+  Enabled: true
+Style/RedundantHeredocDelimiterQuotes: # new in 1.45
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+Style/RedundantLineContinuation: # new in 1.49
+  Enabled: true
+Style/RedundantRegexpArgument: # new in 1.53
+  Enabled: true
+Style/RedundantRegexpConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: true
+Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/SingleLineDoEndBlock: # new in 1.57
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SuperWithArgsParentheses: # new in 1.58
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+Style/YAMLFileRead: # new in 1.53
+  Enabled: true

data/README.md

@@ -0,0 +1,55 @@
+# OCFL for Ruby
+
+This is an implementation of the Oxford Common File Layout (OCFL) for Ruby.  See https://ocfl.io for more information about OCFL.
+
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+```ruby
+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')
+
+directory = builder.save
+directory.exists?
+# => true
+directory.valid?
+# => true
+
+new_version = directory.begin_new_version
+new_version.copy_file('sig/ocfl.rbs')
+new_version.save
+
+directory.head
+# => 'v2'
+
+directory.path("v2", "ocfl.rbs")
+# => <Pathname:/files/[object_root]/v2/content/ocfl.rbs>
+
+directory.path(:head, "ocfl.rbs")
+# => <Pathname:/files/[object_root]/v2/content/ocfl.rbs>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sul-dlss/ocfl.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/ocfl/object/directory.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "digest"
+
+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, to: :inventory
+
+      def path(version, filename)
+        version = head if version == :head
+        relative_path = version_inventory(version).path(filename)
+        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 = {}
+      end
+
+      def begin_new_version
+        DraftVersion.new(object_directory: self)
+      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
+    # rubocop:enable Style/StringConcatenation
+  end
+end

data/lib/ocfl/object/directory_builder.rb

@@ -0,0 +1,55 @@
+# 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:)
+        @object_root = Pathname.new(object_root)
+        raise ObjectExists, "The directory `#{object_root}' already exists" if @object_root.exist?
+
+        @id = id
+      end
+
+      attr_reader :id, :object_root, :object_directory
+
+      def copy_file(...)
+        create_directory
+        version.copy_file(...)
+      end
+
+      def create_directory
+        FileUtils.mkdir_p(object_root)
+      end
+
+      # @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")
+        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
+      end
+
+      def write_inventory
+        version.save
+      end
+    end
+    # rubocop:enable Style/StringConcatenation
+  end
+end

data/lib/ocfl/object/draft_version.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module OCFL
+  module Object
+    # A new OCFL version
+    class DraftVersion
+      # @params [Directory] object_directory
+      def initialize(object_directory:)
+        @object_directory = object_directory
+        @manifest = object_directory.inventory.manifest.dup
+        @state = {}
+      end
+
+      attr_reader :object_directory, :manifest, :state
+
+      def move_file(incoming_path)
+        prepare_content_directory
+        add(incoming_path)
+        FileUtils.mv(incoming_path, content_path)
+      end
+
+      def copy_file(incoming_path)
+        prepare_content_directory
+        add(incoming_path)
+        FileUtils.cp(incoming_path, content_path)
+      end
+
+      # def copy_directory(incoming_path)
+      #   prepare_content_directory
+      #   Dir.foreach(incoming_path) do |file_name|
+      #     next if ['.', '..'].include?(file_name)
+      #     add(incoming_path)
+      #     FileUtils.cp(incoming_path, content_path)
+      #   end
+      # end
+
+      def add(incoming_path)
+        digest = Digest::SHA512.file(incoming_path).to_s
+        version_content_path = content_path.relative_path_from(object_directory.object_root)
+        logical_file_path = File.basename(incoming_path)
+        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
+
+      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 + "content"
+      end
+
+      def path
+        object_directory.object_root + version_number
+      end
+
+      def version_number
+        @version_number ||= "v#{object_directory.head.delete_prefix("v").to_i + 1}"
+      end
+
+      def build_inventory
+        old_data = object_directory.inventory.data
+        versions = old_data.versions.merge(version_number => Version.new(created: Time.now.utc.iso8601, state: @state))
+        Inventory::InventoryStruct.new(old_data.to_h.merge(manifest:, head: version_number, versions:))
+      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)
+        object_directory.reload
+      end
+    end
+  end
+end

data/lib/ocfl/object/inventory.rb

@@ -0,0 +1,44 @@
+# 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
+
+      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)
+      def path(logical_path)
+        sha = versions[head].state.find { |_sha, file_names| file_names.include?(logical_path) }&.first
+
+        return unless sha
+
+        manifest.fetch(sha).first
+      end
+    end
+  end
+end

data/lib/ocfl/object/inventory_loader.rb

@@ -0,0 +1,45 @@
+# 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

@@ -0,0 +1,45 @@
+# 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
+    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
+    # rubocop:enable Style/StringConcatenation
+  end
+end

data/lib/ocfl/object/inventory_writer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "digest"
+
+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
+    # rubocop:enable Style/StringConcatenation
+  end
+end

data/lib/ocfl/object/version.rb

@@ -0,0 +1,22 @@
+# 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
+    end
+  end
+end

data/lib/ocfl/object.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+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
+end

data/lib/ocfl/version.rb

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

data/lib/ocfl.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "ocfl/version"
+require "zeitwerk"
+require "json"
+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
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector = OCFLInflector.new
+loader.setup
+
+module OCFL
+  class Error < StandardError; end
+
+  # Schema types
+  module Types
+    include Dry.Types()
+  end
+end

data/sig/ocfl.rbs

@@ -0,0 +1,4 @@
+module Ocfl
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: ocfl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Coyne
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: See https://ocfl.io/
+email:
+- jcoyne@justincoyne.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- lib/ocfl.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/version.rb
+- sig/ocfl.rbs
+homepage: https://github.com/sul-dlss/ocfl-rb
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sul-dlss/ocfl-rb
+  source_code_uri: https://github.com/sul-dlss/ocfl-rb
+  changelog_uri: https://github.com/sul-dlss/ocfl-rb/releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.4
+signing_key:
+specification_version: 4
+summary: A ruby library for interacting with the Oxford Common File Layout (OCFL)
+test_files: []