ocfl 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b78d16d5b12ad0e134c313c3c68b62c5d008534615d9e91f8d4acc0e4e46fbd
-  data.tar.gz: 513c7bce75abd89c7516208b2320fb7fd302a32e2c1052ea636d069f02eef721
+  metadata.gz: 5b7d95d43fc87d3ce3d87f27aa4c89bf5692df05b2a144e31ba364beafa9d829
+  data.tar.gz: c04004d43c6147808882b8c126e218c655787469c5c0565f41714adb93cceb63
 SHA512:
-  metadata.gz: 575c5cc29088328fb7622bbf66c82779751952b11c6a6950e8e7d2e73eb43800cd187a5b681b3f2762dc0e4fa1aad88a6c63211bae1b94bcdf5f8986189d5e86
-  data.tar.gz: 05c1f6b0fd8819625b7fbc2209db416b2a84b6ae2383d18a1fefb5c963f3aa3e50322f1692dc009b45ec65c25e90d35c04b2911ea08b80ede22d41918158012c
+  metadata.gz: 408709f7faedf25af358673629d874844b915f6023ab842732f5625f17ae6903b3f39f9f7e4fa37a7ebfdae4824eab1f6b780af5ed2c5ecfcf7476555d484a13
+  data.tar.gz: bd5a83be543d91953d85f9ab712ebdd3f4f4c714c626afb4c92ee355351deec6e5a398fc29a087b1876fcaeebe4ae4328b2dc4a502201b491bf2b443307d678a

data/README.md

@@ -5,15 +5,13 @@ This is an implementation of the Oxford Common File Layout (OCFL) for Ruby.  See
 
 ## 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
+    $ bundle add ocfl
 
 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
+    $ gem install ocfl
 
 ## Usage
 
@@ -42,6 +40,10 @@ directory.path("v2", "ocfl.rbs")
 
 directory.path(:head, "ocfl.rbs")
 # => <Pathname:/files/[object_root]/v2/content/ocfl.rbs>
+
+new_version = directory.overwrite_current_version
+new_version.copy_file('sig/ocfl.rbs')
+new_version.save
 ```
 
 ## Development

data/lib/ocfl/object/directory.rb

@@ -17,7 +17,7 @@ module OCFL
 
       attr_reader :object_root, :errors
 
-      delegate :head, to: :inventory
+      delegate :head, :versions, :manifest, to: :inventory
 
       def path(version, filename)
         version = head if version == :head
@@ -66,6 +66,10 @@ module OCFL
         DraftVersion.new(object_directory: self)
       end
 
+      def overwrite_current_version
+        DraftVersion.new(object_directory: self, overwrite_head: true)
+      end
+
       def exists?
         namaste_exists?
       end

data/lib/ocfl/object/draft_version.rb

@@ -7,13 +7,17 @@ module OCFL
     # A new OCFL version
     class DraftVersion
       # @params [Directory] object_directory
-      def initialize(object_directory:)
+      def initialize(object_directory:, overwrite_head: false)
         @object_directory = object_directory
         @manifest = object_directory.inventory.manifest.dup
         @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
+      attr_reader :object_directory, :manifest, :state, :version_number
 
       def move_file(incoming_path)
         prepare_content_directory
@@ -27,19 +31,22 @@ module OCFL
         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
+      # Copies files into the object and preserves their relative paths as logical directories in the object
+      def copy_recursive(incoming_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("/")
+          add(file, logical_file_path:)
+          parent_dir = (content_path + logical_file_path).parent
+          FileUtils.mkdir_p(parent_dir)
+          FileUtils.cp(file, content_path + logical_file_path)
+        end
+      end
 
-      def add(incoming_path)
+      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)
-        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]
@@ -68,14 +75,25 @@ module OCFL
         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:))
+        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 => Version.new(created: Time.now.utc.iso8601, state: @state))
+      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)
       end
 
       def save

data/lib/ocfl/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocfl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-12 00:00:00.000000000 Z
+date: 2024-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport