shrine 1.4.2 → 2.0.0

data/lib/shrine/storage/file_system.rb

@@ -91,10 +91,9 @@ class Shrine
       # :  By default empty folders inside the directory are automatically
       #    deleted, but if it happens that it causes too much load on the
       #    filesystem, you can set this option to `false`.
-      def initialize(directory, prefix: nil, host: nil, clean: true, permissions: nil, subdirectory: nil)
-        if prefix || subdirectory
-          warn "The :subdirectory option is deprecated and will be removed in Shrine 2. You should use :prefix instead." if subdirectory
-          @prefix = Pathname(relative(prefix || subdirectory))
+      def initialize(directory, prefix: nil, host: nil, clean: true, permissions: nil)
+        if prefix
+          @prefix = Pathname(relative(prefix))
           @directory = Pathname(directory).join(@prefix)
         else
           @directory = Pathname(directory)
@@ -109,7 +108,7 @@ class Shrine
       end
 
       # Copies the file into the given location.
-      def upload(io, id, metadata = {})
+      def upload(io, id, shrine_metadata: {}, **upload_options)
         IO.copy_stream(io, path!(id))
         path(id).chmod(permissions) if permissions
       end
@@ -121,7 +120,7 @@ class Shrine
 
       # Moves the file to the given location. This gets called by the "moving"
       # plugin.
-      def move(io, id, metadata = {})
+      def move(io, id, shrine_metadata: {}, **upload_options)
         if io.respond_to?(:path)
           FileUtils.mv io.path, path!(id)
         else
@@ -168,16 +167,15 @@ class Shrine
         host ? host + path : path
       end
 
-      # Without any options it deletes all files from the #directory (and this
-      # requires confirmation). If `:older_than` is passed in (a `Time`
-      # object), deletes all files which were last modified before that time.
-      def clear!(confirm = nil, older_than: nil)
+      # 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
           directory.find do |path|
             path.mtime < older_than ? path.rmtree : Find.prune
           end
         else
-          raise Shrine::Confirm unless confirm == :confirm
           directory.rmtree
           directory.mkpath
           directory.chmod(permissions) if permissions

data/lib/shrine/storage/linter.rb

@@ -118,14 +118,8 @@ class Shrine
       end
 
       def lint_clear(id)
-        storage.clear!(:confirm)
+        storage.clear!
         error :clear!, "file still #exists? after clearing" if storage.exists?(id)
-
-        begin
-          storage.clear!
-          error :clear!, "should raise Shrine::Confirm if :confirm is not passed in"
-        rescue Shrine::Confirm
-        end
       end
 
       private

data/lib/shrine/storage/s3.rb

@@ -116,10 +116,10 @@ class Shrine
       #
       # It assigns the correct "Content-Type" taken from the MIME type, because
       # by default S3 sets everything to "application/octet-stream".
-      def upload(io, id, metadata = {})
-        options = {content_type: metadata["mime_type"]}
+      def upload(io, id, shrine_metadata: {}, **upload_options)
+        options = {content_type: shrine_metadata["mime_type"]}
+        options.update(@upload_options)
         options.update(upload_options)
-        options.update(metadata.delete("s3") || {})
 
         if copyable?(io)
           copy(io, id, **options)
@@ -171,34 +171,40 @@ class Shrine
 
       # Returns the presigned URL to the file.
       #
+      # :public
+      # :  Creates an unsigned version of the URL (the permissions on the S3
+      #    bucket need to be modified to allow public URLs).
+      #
       # :download
       # :  If set to `true`, creates a "forced download" link, which means that
       #    the browser will never display the file and always ask the user to
       #    download it.
       #
-      # :public
-      # :  Creates an unsigned version of the URL (requires setting appropriate
-      #    permissions on the S3 bucket).
-      #
-      # All other options are forwarded to [`Aws::S3::Object#presigned_url`].
+      # All other options are forwarded to [`Aws::S3::Object#presigned_url`] or
+      # [`Aws::S3::Object#public_url`].
       #
       # [`Aws::S3::Object#presigned_url`]: http://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Object.html#presigned_url-instance_method
+      # [`Aws::S3::Object#public_url`]: http://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Object.html#public_url-instance_method
       def url(id, download: nil, public: nil, **options)
-        if host.nil?
-          options[:response_content_disposition] = "attachment" if download
-          if public.nil?
-            object(id).presigned_url(:get, **options)
-          else
-            object(id).public_url(**options)
-          end
+        options[:response_content_disposition] = "attachment" if download
+
+        if public
+          url = object(id).public_url(**options)
         else
-          URI.join(host, URI.encode(object(id).key)).to_s
+          url = object(id).presigned_url(:get, **options)
+        end
+
+        if host
+          uri = URI.parse(url)
+          uri.path = uri.path.match(/^\/#{bucket.name}/).post_match unless uri.host.include?(bucket.name)
+          url = URI.join(host, uri.request_uri).to_s
         end
+
+        url
       end
 
-      # Deletes all files from the storage (requires confirmation).
-      def clear!(confirm = nil)
-        raise Shrine::Confirm unless confirm == :confirm
+      # Deletes all files from the storage.
+      def clear!
         bucket.object_versions(prefix: prefix).delete
       end
 

data/lib/shrine/version.rb

@@ -4,9 +4,9 @@ class Shrine
   end
 
   module VERSION
-    MAJOR = 1
-    MINOR = 4
-    TINY  = 2
+    MAJOR = 2
+    MINOR = 0
+    TINY  = 0
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/shrine.gemspec

@@ -6,8 +6,17 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = ">= 2.1"
 
-  gem.summary      = "Toolkit for file uploads in Ruby"
-  gem.description  = "Toolkit for file uploads in Ruby"
+  gem.summary      = "Toolkit for handling file uploads in Ruby"
+  gem.description  = <<-END
+Shrine is a toolkit for handling file uploads in Ruby. It supports uploading,
+processing and deleting IO objects, backed by a storage adapter. It uses
+efficient streaming to minimize memory usage.
+
+Shrine comes with a high-level attachment interface for attaching uploaded
+files to database records, saving their location and metadata to a database
+column, and tying them to record's lifecycle.
+  END
+
   gem.homepage     = "https://github.com/janko-m/shrine"
   gem.authors      = ["Janko Marohnić"]
   gem.email        = ["janko.marohnic@gmail.com"]
@@ -16,7 +25,7 @@ Gem::Specification.new do |gem|
   gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "shrine.gemspec", "doc/*.md"]
   gem.require_path = "lib"
 
-  gem.add_dependency "down", ">= 2.0.1"
+  gem.add_dependency "down", ">= 2.2.0"
 
   gem.add_development_dependency "rake", "~> 11.1"
   gem.add_development_dependency "minitest", "~> 5.8"
@@ -25,6 +34,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "webmock"
   gem.add_development_dependency "rack-test_app"
   gem.add_development_dependency "dotenv"
+  gem.add_development_dependency "shrine-memory"
 
   gem.add_development_dependency "roda"
   gem.add_development_dependency "mimemagic"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-19 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: shrine-memory
+  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: roda
   requirement: !ruby/object:Gem::Requirement
@@ -248,7 +262,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Toolkit for file uploads in Ruby
+description: |
+  Shrine is a toolkit for handling file uploads in Ruby. It supports uploading,
+  processing and deleting IO objects, backed by a storage adapter. It uses
+  efficient streaming to minimize memory usage.
+
+  Shrine comes with a high-level attachment interface for attaching uploaded
+  files to database records, saving their location and metadata to a database
+  column, and tying them to record's lifecycle.
 email:
 - janko.marohnic@gmail.com
 executables: []
@@ -261,6 +282,7 @@ files:
 - doc/changing_location.md
 - doc/creating_plugins.md
 - doc/creating_storages.md
+- doc/design.md
 - doc/direct_s3.md
 - doc/migrating_storage.md
 - doc/paperclip.md
@@ -279,7 +301,6 @@ files:
 - lib/shrine/plugins/default_url_options.rb
 - lib/shrine/plugins/delete_promoted.rb
 - lib/shrine/plugins/delete_raw.rb
-- lib/shrine/plugins/delete_uploaded.rb
 - lib/shrine/plugins/determine_mime_type.rb
 - lib/shrine/plugins/direct_upload.rb
 - lib/shrine/plugins/download_endpoint.rb
@@ -287,7 +308,6 @@ files:
 - lib/shrine/plugins/hooks.rb
 - lib/shrine/plugins/included.rb
 - lib/shrine/plugins/keep_files.rb
-- lib/shrine/plugins/keep_location.rb
 - lib/shrine/plugins/logging.rb
 - lib/shrine/plugins/migration_helpers.rb
 - lib/shrine/plugins/module_include.rb
@@ -301,7 +321,6 @@ files:
 - lib/shrine/plugins/remote_url.rb
 - lib/shrine/plugins/remove_attachment.rb
 - lib/shrine/plugins/remove_invalid.rb
-- lib/shrine/plugins/restore_cached.rb
 - lib/shrine/plugins/restore_cached_data.rb
 - lib/shrine/plugins/sequel.rb
 - lib/shrine/plugins/store_dimensions.rb
@@ -336,6 +355,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Toolkit for file uploads in Ruby
+summary: Toolkit for handling file uploads in Ruby
 test_files: []
 has_rdoc: 

data/lib/shrine/plugins/delete_uploaded.rb

@@ -1,3 +0,0 @@
-warn "The delete_uploaded Shrine plugin has been renamed to \"delete_raw\". Loading the plugin through \"delete_uploaded\" will not work in Shrine 2."
-require "shrine/plugins/delete_raw"
-Shrine::Plugins.register_plugin(:delete_uploaded, Shrine::Plugins::DeleteRaw)

data/lib/shrine/plugins/keep_location.rb

@@ -1,46 +0,0 @@
-warn "The keep_location Shrine plugin is deprecated and will be removed in Shrine 2. " \
-     "You can easily implement the same behaviour in Shrine#generate_location."
-
-class Shrine
-  module Plugins
-    # The keep_location plugin allows you to preserve locations when
-    # transferring files from one storage to another. This can be useful for
-    # debugging purposes or for backups.
-    #
-    #     plugin :keep_location, :cache => :store
-    #
-    # The above will preserve location of cached files uploaded to store. More
-    # precisely, if a Shrine::UploadedFile from cache is begin uploaded to
-    # store, the stored file will have the same location as the cached file.
-    #
-    # The destination storage can also be specified as an array:
-    #
-    #     plugin :keep_location, :cache => [:storage1, :storage2]
-    module KeepLocation
-      def self.configure(uploader, mappings = {})
-        uploader.opts[:keep_location_mappings] = mappings
-      end
-
-      module InstanceMethods
-        private
-
-        def get_location(io, context)
-          if !context[:location] && io.is_a?(UploadedFile) && keep_location?(io)
-            io.id
-          else
-            super
-          end
-        end
-
-        def keep_location?(uploaded_file)
-          opts[:keep_location_mappings].any? do |source, destination|
-            source == uploaded_file.storage_key.to_sym &&
-              Array(destination).include?(self.storage_key)
-          end
-        end
-      end
-    end
-
-    register_plugin(:keep_location, KeepLocation)
-  end
-end

data/lib/shrine/plugins/restore_cached.rb

@@ -1,3 +0,0 @@
-warn "The restore_cached Shrine plugin has been renamed to \"restore_cached_data\". Loading the plugin through \"restore_cached\" will not work in Shrine 2."
-require "shrine/plugins/restore_cached_data"
-Shrine::Plugins.register_plugin(:restore_cached, Shrine::Plugins::RestoreCachedData)