valkyrie 3.1.4 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45ad037f0dbbaf39f2350701c25ec4820173455e80e094e6e18744cfb89effe5
-  data.tar.gz: e8d6d55cc8f2694f1e8502e988a3ecb6609eca94307bef69707105594ea21b88
+  metadata.gz: 7439f8be7099e4b54998826abda9222d07226ff7a54fdb868f2ab7d99596fd56
+  data.tar.gz: 866c57941b2e2604a8d7bd8b013e0b31c07dd909404733cfb7043c61412389ad
 SHA512:
-  metadata.gz: bce82f987a2916943fa4554985a049f1719cd67b89b206402f1e0dd4e8c622cda31f2c66d695e51e5209293a7d0b571d909795246bb3572f9c913b28010a14f8
-  data.tar.gz: 8699c74af257248e5be5dbe03bbc47566beba045fa3450a2524e6b7f5a065f60012e27f96eb64f86351fec3336737b457a74f16079266aa135a535c9026ab86e
+  metadata.gz: 89d1857a2f40c0d8c32c6a31a9ff1247e9b8c32aa84e917c77c3d89e6a0cb52c7548802852914ddcf11d9805f3cf0b6784331f937cf9004b18e63ecb27449971
+  data.tar.gz: 5b143107a9ca53b86c83c5ba884635fb869919a7641c1373324193f9ac918684557177cf2c2519f5d8eeb0420bd48404037da5fb46c84d5a17bda0e4381b72f7

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# v3.2.0 2024-04-10
+
+## Changes since last release
+
+* Add cleanup functionality to StreamFile#disk_path. ([tpendragon](https://github.com/tpendragon))
+
+Additional thanks to the following for code review and issue reports leading to this release:
+
+* [dchandekstark](https://github.com/dchandekstark)
+* [cgalarza](https://github.com/cgalarza)
+
+# v3.1.5 2024-04-10
+
+## Changes since last release
+
+* Add Valkyrie.root_path to access Valkyrie's gem location. ([tpendragon](https://github.com/tpendragon))
+
 # v3.1.4 2024-02-20
 
 ## Changes since last release

data/lib/valkyrie/specs/shared_specs/file.rb

@@ -14,5 +14,13 @@ RSpec.shared_examples 'a Valkyrie::StorageAdapter::File' do
     it "returns an existing disk path" do
       expect(File.exist?(file.disk_path)).to eq true
     end
+    it "can accept a block" do
+      disk_path = nil
+      file.disk_path do |f_path|
+        expect(File.exist?(f_path)).to eq true
+        disk_path = f_path
+      end
+      expect(disk_path).not_to be_nil
+    end
   end
 end

data/lib/valkyrie/specs/shared_specs/storage_adapter.rb

@@ -39,7 +39,7 @@ RSpec.shared_examples 'a Valkyrie::StorageAdapter' do
     # WebMock prevents the request from using send_request_with_body_stream as it can do IRL
     WebMock.disable!
     allow(storage_adapter).to receive(:file_mover).and_return(FileUtils.method(:cp))
-    File.open(Valkyrie::Engine.root.join("spec", "fixtures", "files", "tn_example.jpg")) do |io_file|
+    File.open(Valkyrie.root_path.join("spec", "fixtures", "files", "tn_example.jpg")) do |io_file|
       sha1 = Digest::SHA1.file(io_file).to_s
 
       resource = Valkyrie::Specs::CustomResource.new(id: SecureRandom.uuid)

data/lib/valkyrie/storage_adapter.rb

@@ -25,12 +25,13 @@ module Valkyrie
 
       # Find the adapter associated with the provided short name
       # @param short_name [Symbol]
-      # @return [Valkyrie::StorageAdapter]
+      # @return [Object] the storage adapter
       # @raise Valkyrie::StorageAdapter::AdapterNotFoundError when we are unable to find the named adapter
       def find(short_name)
         storage_adapters.fetch(short_name)
       rescue KeyError
-        raise "Unable to find #{self} with short_name of #{short_name.inspect}. Registered adapters are #{storage_adapters.keys.inspect}"
+        raise AdapterNotFoundError, "Unable to find #{self} with short_name of #{short_name.inspect}. " \
+                                    "Registered adapters are #{storage_adapters.keys.inspect}"
       end
 
       # Search through all registered storage adapters until it finds one that
@@ -53,7 +54,8 @@ module Valkyrie
 
       # Return the registered storage adapter which handles the given ID.
       # @param id [Valkyrie::ID]
-      # @return [Valkyrie::StorageAdapter]
+      # @return [Object] the storage adapter
+      # @raise [Valkyrie::StorageAdapter::AdapterNotFoundError]
       def adapter_for(id:)
         handler = storage_adapters.values.find do |storage_adapter|
           storage_adapter.handles?(id: id)
@@ -74,7 +76,12 @@ module Valkyrie
       end
 
       def disk_path
-        Pathname.new(io.path)
+        path = Pathname.new(io.path)
+        if block_given?
+          yield path
+        else
+          path
+        end
       end
 
       # @param digests [Array<Digest>]
@@ -89,7 +96,7 @@ module Valkyrie
       end
 
       # @param size [Integer]
-      # @param digests [Array<Digest>]
+      # @param digests [Hash<String, String>] map of digest algorithm names to digest values.
       # @return [Boolean]
       def valid?(size: nil, digests:)
         return false if size && io.size.to_i != size.to_i
@@ -102,17 +109,34 @@ module Valkyrie
 
     class StreamFile < File
       def disk_path
-        Pathname.new(tmp_file.path)
+        path = Pathname.new(tmp_file.path)
+        if block_given?
+          yield path
+          clean_tmp_file
+        else
+          path
+        end
+      end
+
+      def close
+        super
+        clean_tmp_file
       end
 
       private
 
+      def clean_tmp_file
+        return unless @tmp_file
+        ::File.delete(tmp_file.path)
+        @tmp_file = nil
+      end
+
       def tmp_file_name
         id.to_s.tr(':/', '__')
       end
 
       def tmp_file_path
-        ::File.join(Dir.tmpdir, tmp_file_name)
+        ::File.join(Dir.tmpdir, "#{SecureRandom.uuid}-#{tmp_file_name}")
       end
 
       def tmp_file

data/lib/valkyrie/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Valkyrie
-  VERSION = "3.1.4"
+  VERSION = "3.2.0"
 end

data/lib/valkyrie.rb

@@ -60,6 +60,14 @@ module Valkyrie
     end
   end
 
+  def root_path
+    if Valkyrie.const_defined?(:Engine)
+      Valkyrie::Engine.root
+    else
+      Pathname.new(__dir__).dirname
+    end
+  end
+
   # @return [Valkyrie::Logging]
   def logger
     @logger ||= Valkyrie::Logging.new(logger: Logger.new(STDOUT))
@@ -123,5 +131,5 @@ module Valkyrie
     end
   end
 
-  module_function :config, :logger, :logger=, :config_root_path, :environment, :config_file, :config_hash
+  module_function :config, :logger, :logger=, :config_root_path, :environment, :config_file, :config_hash, :root_path
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valkyrie
 version: !ruby/object:Gem::Version
-  version: 3.1.4
+  version: 3.2.0
 platform: ruby
 authors:
 - Trey Pendragon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-21 00:00:00.000000000 Z
+date: 2024-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -582,7 +582,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: An ORM using the Data Mapper pattern, specifically built to solve Digital