shrine 2.18.1 → 2.19.0

data/lib/shrine/storage/file_system.rb

@@ -50,22 +50,28 @@ class Shrine
       end
 
       # Copies the file into the given location.
-      def upload(io, id, shrine_metadata: {}, **upload_options)
-        bytes_copied = IO.copy_stream(io, path!(id))
-        path(id).chmod(permissions) if permissions
+      def upload(io, id, move: false, shrine_metadata: {}, **options)
+        Shrine.deprecation("Unrecognized options for FileSystem#upload: #{options.inspect}. Passing unrecognized options to FileSystem#upload will not be supported in Shrine 3.") if options.any?
+
+        if move && movable?(io, id)
+          move(io, id)
+        else
+          IO.copy_stream(io, path!(id))
 
-        shrine_metadata["size"] ||= bytes_copied
+          path(id).chmod(permissions) if permissions
+        end
       end
 
       # Moves the file to the given location. This gets called by the `moving`
       # plugin.
-      def move(io, id, shrine_metadata: {}, **upload_options)
+      def move(io, id, **)
         if io.respond_to?(:path)
           FileUtils.mv io.path, path!(id)
         else
           FileUtils.mv io.storage.path(io.id), path!(id)
           io.storage.clean(io.storage.path(io.id)) if io.storage.clean?
         end
+
         path(id).chmod(permissions) if permissions
       end
 
@@ -106,17 +112,22 @@ class Shrine
         host ? host + path : path
       end
 
-      # Deletes all files from the #directory. If `:older_than` is passed in (a
-      # `Time` object), deletes all files which were last modified before that
-      # time.
-      def clear!(older_than: nil)
-        if older_than
-          # add trailing slash to make it work with symlinks
-          Pathname("#{directory}/").find do |path|
-            if path.file? && path.mtime < older_than
-              path.delete
-              clean(path) if clean?
+      # Deletes all files from the #directory. If a block is passed in, deletes
+      # only the files for which the block evaluates to true.
+      #
+      #     file_system.clear! # deletes all files and subdirectories in the storage directory
+      #     file_system.clear! { |path| path.mtime < Time.now - 7*24*60*60 } # deletes only files older than 1 week
+      def clear!(older_than: nil, &condition)
+        if older_than || condition
+          list_files(directory) do |path|
+            if older_than
+              Shrine.deprecation("The :older_than option to FileSystem#clear! is deprecated and will be removed in Shrine 3. You should use a block instead, e.g. `storage.clear! { |path| path.mtime < Time.now - 7*24*60*60 }`.")
+              next unless path.mtime < older_than
+            else
+              next unless condition.call(path)
             end
+            path.delete
+            clean(path) if clean?
           end
         else
           directory.children.each(&:rmtree)
@@ -171,6 +182,12 @@ class Shrine
         path.sub(%r{^/}, "")
       end
 
+      def list_files(directory)
+        Pathname("#{directory}/") # add trailing slash to make it work with symlinks
+          .find
+          .each { |path| yield path if path.file? }
+      end
+
       def deprecated_download(id, **options)
         Shrine.deprecation("Shrine::Storage::FileSystem#download is deprecated and will be removed in Shrine 3.")
         tempfile = Tempfile.new(["shrine-filesystem", File.extname(id)], binmode: true)

data/lib/shrine/storage/linter.rb

@@ -43,11 +43,6 @@ class Shrine
         lint_url(id)
         lint_delete(id)
 
-        if storage.respond_to?(:move)
-          uploaded_file = uploader.upload(io_factory.call, location: "bar".dup)
-          lint_move(uploaded_file, "quux")
-        end
-
         if storage.respond_to?(:clear!)
           storage.upload(io_factory.call, id = "quux".dup)
           lint_clear(id)
@@ -85,14 +80,6 @@ class Shrine
         end
       end
 
-      def lint_move(uploaded_file, id)
-        if storage.movable?(uploaded_file, id)
-          storage.move(uploaded_file, id, {})
-          error :exists?, "returns false for destination after #move" if !storage.exists?(id)
-          error :exists?, "returns true for source after #move" if storage.exists?(uploaded_file.id)
-        end
-      end
-
       def lint_clear(id)
         storage.clear!
         error :clear!, "file still #exists? after clearing" if storage.exists?(id)

data/lib/shrine/storage/s3.rb

@@ -252,11 +252,8 @@ class Shrine
       #     # or
       #     s3.clear! { |object| object.last_modified < Time.now - 7*24*60*60 }
       def clear!(&block)
-        objects_to_delete = Enumerator.new do |yielder|
-          bucket.objects(prefix: prefix).each do |object|
-            yielder << object if block.nil? || block.call(object)
-          end
-        end
+        objects_to_delete = bucket.objects(prefix: prefix)
+        objects_to_delete = objects_to_delete.lazy.select(&block) if block
 
         delete_objects(objects_to_delete)
       end

data/lib/shrine/uploaded_file.rb

@@ -74,6 +74,11 @@ class Shrine
       end
       alias content_type mime_type
 
+      # Shorthand for accessing metadata values.
+      def [](key)
+        metadata[key]
+      end
+
       # Calls `#open` on the storage to open the uploaded file for reading.
       # Most storages will return a lazy IO object which dynamically
       # retrieves file content from the storage as the object is being read.
@@ -262,5 +267,8 @@ class Shrine
         end
       end
     end
+
+    extend ClassMethods
+    include InstanceMethods
   end
 end

data/lib/shrine/version.rb

@@ -7,8 +7,8 @@ class Shrine
 
   module VERSION
     MAJOR = 2
-    MINOR = 18
-    TINY  = 1
+    MINOR = 19
+    TINY  = 0
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/shrine.gemspec

@@ -36,26 +36,41 @@ direct uploads for fully asynchronous user experience.
   gem.add_dependency "down", "~> 4.1"
   gem.add_dependency "content_disposition", "~> 1.0"
 
+  # general testing helpers
   gem.add_development_dependency "rake", ">= 11.1"
   gem.add_development_dependency "minitest", "~> 5.8"
   gem.add_development_dependency "minitest-hooks", "~> 1.3"
   gem.add_development_dependency "mocha", "~> 1.4"
-  gem.add_development_dependency "rack-test_app"
   gem.add_development_dependency "shrine-memory", ">= 0.2.2"
 
+  # for endpoint plugins
   gem.add_development_dependency "rack", "~> 2.0"
+  gem.add_development_dependency "http-form_data", "~> 2.0"
+  gem.add_development_dependency "rack-test_app"
+
+  # for determine_mime_type plugin
   gem.add_development_dependency "mimemagic", ">= 0.3.2"
   gem.add_development_dependency "marcel"
+  gem.add_development_dependency "ruby-filemagic", "~> 0.7" unless RUBY_ENGINE == "jruby" || ENV["CI"]
+
+  # for determine_mime_type and infer_extension plugins
   gem.add_development_dependency "mime-types"
   gem.add_development_dependency "mini_mime", "~> 1.0"
-  gem.add_development_dependency "ruby-filemagic", "~> 0.7" unless RUBY_ENGINE == "jruby" || ENV["CI"]
+
+  # for store_dimensions plugin
   gem.add_development_dependency "fastimage"
   gem.add_development_dependency "mini_magick", "~> 4.0" unless ENV["CI"]
   gem.add_development_dependency "ruby-vips", "~> 2.0" unless ENV["CI"]
+
+  # for S3 storage
   gem.add_development_dependency "aws-sdk-s3", "~> 1.16"
   gem.add_development_dependency "aws-sdk-core", "~> 3.23"
-  gem.add_development_dependency "http-form_data", "~> 2.0"
 
+  # for instrumentation plugin
+  gem.add_development_dependency "dry-monitor"
+  gem.add_development_dependency "activesupport", "~> 5.2.0"
+
+  # for ORM plugins
   gem.add_development_dependency "sequel"
   gem.add_development_dependency "activerecord", "~> 5.2.0"
   gem.add_development_dependency "sqlite3", "~> 1.3.6" unless RUBY_ENGINE == "jruby"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 2.18.1
+  version: 2.19.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-05 00:00:00.000000000 Z
+date: 2019-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -95,35 +95,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: rack-test_app
+  name: shrine-memory
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
-  name: shrine-memory
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: http-form_data
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -137,35 +137,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: mimemagic
+  name: rack-test_app
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: marcel
+  name: mimemagic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: marcel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,33 +179,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mini_mime
+  name: ruby-filemagic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: ruby-filemagic
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mini_mime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: fastimage
   requirement: !ruby/object:Gem::Requirement
@@ -277,19 +291,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.23'
 - !ruby/object:Gem::Dependency
-  name: http-form_data
+  name: dry-monitor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -382,6 +410,7 @@ files:
 - doc/plugins/hooks.md
 - doc/plugins/included.md
 - doc/plugins/infer_extension.md
+- doc/plugins/instrumentation.md
 - doc/plugins/keep_files.md
 - doc/plugins/logging.md
 - doc/plugins/metadata_attributes.md
@@ -434,6 +463,7 @@ files:
 - doc/release_notes/2.16.0.md
 - doc/release_notes/2.17.0.md
 - doc/release_notes/2.18.0.md
+- doc/release_notes/2.19.0.md
 - doc/release_notes/2.2.0.md
 - doc/release_notes/2.3.0.md
 - doc/release_notes/2.3.1.md
@@ -477,6 +507,7 @@ files:
 - lib/shrine/plugins/hooks.rb
 - lib/shrine/plugins/included.rb
 - lib/shrine/plugins/infer_extension.rb
+- lib/shrine/plugins/instrumentation.rb
 - lib/shrine/plugins/keep_files.rb
 - lib/shrine/plugins/logging.rb
 - lib/shrine/plugins/metadata_attributes.rb