shrine 2.19.4 → 3.0.0.alpha

data/lib/shrine/plugins/hooks.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-class Shrine
-  module Plugins
-    # Documentation lives in [doc/plugins/hooks.md] on GitHub.
-    #
-    # [doc/plugins/hooks.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/hooks.md
-    module Hooks
-      module InstanceMethods
-        def upload(io, context = {})
-          result = nil
-          before_upload(io, context)
-          around_upload(io, context) { result = super }
-          after_upload(io, context)
-          result
-        end
-
-        def around_upload(*args)
-          yield
-        end
-
-        def before_upload(*)
-        end
-
-        def after_upload(*)
-        end
-
-
-        def processed(io, context)
-          result = nil
-          before_process(io, context)
-          around_process(io, context) { result = super }
-          after_process(io, context)
-          result
-        end
-        private :processed
-
-        def around_process(*args)
-          yield
-        end
-
-        def before_process(*)
-        end
-
-        def after_process(*)
-        end
-
-
-        def store(io, context = {})
-          result = nil
-          before_store(io, context)
-          around_store(io, context) { result = super }
-          after_store(io, context)
-          result
-        end
-
-        def around_store(*args)
-          yield
-        end
-
-        def before_store(*)
-        end
-
-        def after_store(*)
-        end
-
-
-        def delete(io, context = {})
-          result = nil
-          before_delete(io, context)
-          around_delete(io, context) { result = super }
-          after_delete(io, context)
-          result
-        end
-
-        def around_delete(*args)
-          yield
-        end
-
-        def before_delete(*)
-        end
-
-        def after_delete(*)
-        end
-      end
-    end
-
-    register_plugin(:hooks, Hooks)
-  end
-end

data/lib/shrine/plugins/logging.rb

@@ -1,142 +0,0 @@
-# frozen_string_literal: true
-
-Shrine.deprecation("The logging plugin has been deprecated in favor of instrumentation plugin. The logging plugin will be removed in Shrine 3.")
-
-require "logger"
-require "json"
-require "time"
-
-class Shrine
-  module Plugins
-    # Documentation lives in [doc/plugins/logging.md] on GitHub.
-    #
-    # [doc/plugins/logging.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/logging.md
-    module Logging
-      def self.load_dependencies(uploader, *)
-        uploader.plugin :hooks
-      end
-
-      def self.configure(uploader, opts = {})
-        uploader.opts[:logging_stream] = opts.fetch(:stream, uploader.opts.fetch(:logging_stream, $stdout))
-        uploader.opts[:logging_logger] = opts.fetch(:logger, uploader.opts.fetch(:logging_logger, uploader.create_logger))
-        uploader.opts[:logging_format] = opts.fetch(:format, uploader.opts.fetch(:logging_format, :human))
-
-        Shrine.deprecation("The :heroku logging format has been renamed to :logfmt. Using :heroku name will stop being supported in Shrine 3.") if uploader.opts[:logging_format] == :heroku
-      end
-
-      module ClassMethods
-        def logger=(logger)
-          @logger = logger
-        end
-
-        def logger
-          @logger ||= opts[:logging_logger]
-        end
-
-        def create_logger
-          logger = Logger.new(opts[:logging_stream])
-          logger.level = Logger::INFO
-          logger.level = Logger::WARN if ENV["RACK_ENV"] == "test"
-          logger.formatter = pretty_formatter
-          logger
-        end
-
-        # It makes logging preamble simpler than the default logger. Also, it
-        # doesn't output timestamps if on Heroku.
-        def pretty_formatter
-          proc do |severity, time, program_name, message|
-            output = "#{Process.pid}: #{message}\n".dup
-            output.prepend "#{time.utc.iso8601(3)} " unless ENV["DYNO"]
-            output
-          end
-        end
-      end
-
-      module InstanceMethods
-        def store(io, context = {})
-          log("store", io, context) { super }
-        end
-
-        def delete(io, context = {})
-          log("delete", io, context) { super }
-        end
-
-        private
-
-        def processed(io, context = {})
-          log("process", io, context) { super }
-        end
-
-        # Collects the data and sends it for logging.
-        def log(action, input, context)
-          result, duration = benchmark { yield }
-
-          _log(
-            action:       action,
-            phase:        context[:action],
-            uploader:     self.class.to_s,
-            attachment:   context[:name],
-            record_class: (context[:record].class.to_s if context[:record]),
-            record_id:    (context[:record].id if context[:record].respond_to?(:id)),
-            files:        (action == "process" ? [count(input), count(result)] : count(result)),
-            duration:     ("%.2f" % duration).to_f,
-          ) unless result.nil?
-
-          result
-        end
-
-        # Determines format of logging and calls appropriate method.
-        def _log(data)
-          message = send("_log_message_#{opts[:logging_format]}", data)
-          self.class.logger.info(message)
-        end
-
-        def _log_message_human(data)
-          components = []
-          components << "#{data[:action].upcase}"
-          components[-1] += "[#{data[:phase]}]" if data[:phase]
-          components << "#{data[:uploader]}"
-          components[-1] += "[:#{data[:attachment]}]" if data[:attachment]
-          components << "#{data[:record_class]}" if data[:record_class]
-          components[-1] += "[#{data[:record_id]}]" if data[:record_id]
-          components << "#{Array(data[:files]).join("-")} #{"file#{"s" if Array(data[:files]).any?{|n| n > 1}}"}"
-          components << "(#{data[:duration]}s)"
-          components.join(" ")
-        end
-
-        def _log_message_json(data)
-          data[:files] = Array(data[:files]).join("-")
-          JSON.generate(data)
-        end
-
-        def _log_message_logfmt(data)
-          data[:files] = Array(data[:files]).join("-")
-          data.map { |key, value| "#{key}=#{value}" }.join(" ")
-        end
-        alias _log_message_heroku _log_message_logfmt # deprecated alias
-
-        # We may have one file, a hash of versions, or an array of files or
-        # hashes.
-        def count(object)
-          case object
-          when Hash
-            object.count
-          when Array
-            object.inject(0) { |sum, o| sum += count(o) }
-          else
-            1
-          end
-        end
-
-        def benchmark
-          start = Time.now
-          result = yield
-          finish = Time.now
-          [result, finish - start]
-        end
-      end
-    end
-
-    register_plugin(:logging, Logging)
-  end
-end

data/lib/shrine/plugins/migration_helpers.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-Shrine.deprecation("The migration_helpers plugin is deprecated and will be removed in Shrine 3. Attacher#cached? and Attacher#stored? have been moved to base.")
-
-class Shrine
-  module Plugins
-    # Documentation lives in [doc/plugins/migration_helpers.md] on GitHub.
-    #
-    # [doc/plugins/migration_helpers.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/migration_helpers.md
-    module MigrationHelpers
-      def self.configure(uploader, delegate: false)
-        uploader.opts[:migration_helpers_delegate] = delegate
-      end
-
-      module AttachmentMethods
-        def initialize(name)
-          super
-
-          return if shrine_class.opts[:migration_helpers_delegate] == false
-
-          name = attachment_name
-
-          define_method :"update_#{name}" do |&block|
-            send(:"#{name}_attacher").update_stored(&block)
-          end
-
-          define_method :"#{name}_cache" do
-            send(:"#{name}_attacher").cache
-          end
-
-          define_method :"#{name}_store" do
-            send(:"#{name}_attacher").store
-          end
-
-          define_method :"#{name}_cached?" do
-            send(:"#{name}_attacher").cached?
-          end
-
-          define_method :"#{name}_stored?" do
-            send(:"#{name}_attacher").stored?
-          end
-        end
-      end
-
-      module AttacherMethods
-        # Updates the attachment with the result of the block. It will get
-        # called only if the attachment exists and is stored.
-        def update_stored(&block)
-          return if get.nil? || cache.uploaded?(get)
-          new_attachment = block.call(get)
-          swap(new_attachment)
-        end
-
-        # Returns true if the attachment is present and is uploaded by the
-        # temporary storage.
-        def cached?
-          get && cache.uploaded?(get)
-        end
-
-        # Returns true if the attachment is present and is uploaded by the
-        # permanent storage.
-        def stored?
-          get && store.uploaded?(get)
-        end
-      end
-    end
-
-    register_plugin(:migration_helpers, MigrationHelpers)
-  end
-end

data/lib/shrine/plugins/moving.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-Shrine.deprecation("The moving plugin has been deprecated in favor of the :move upload option for FileSystem storage. It will no longer be available in Shrine 3.")
-
-class Shrine
-  module Plugins
-    # Documentation lives in [doc/plugins/moving.md] on GitHub.
-    #
-    # [doc/plugins/moving.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/moving.md
-    module Moving
-      def self.configure(uploader, opts = {})
-        uploader.opts[:moving_storages] = opts.fetch(:storages, uploader.opts[:moving_storages])
-      end
-
-      module InstanceMethods
-        private
-
-        # Moves the file if storage supports it, otherwise defaults to copying.
-        def copy(io, context)
-          if move?(io, context)
-            move(io, context)
-          else
-            super
-          end
-        end
-
-        # Generates upload options and calls `#move` on the storage.
-        def move(io, context)
-          location = context[:location]
-          metadata = context[:metadata]
-          upload_options = context[:upload_options] || {}
-
-          storage.move(io, location, shrine_metadata: metadata, **upload_options)
-        end
-
-        # Returns true if file should be moved and is movable.
-        def move?(io, context)
-          return false if context[:move] == false
-          moving_storage? && movable?(io, context)
-        end
-
-        # Returns true if storage can move this file.
-        def movable?(io, context)
-          storage.respond_to?(:move) && storage.movable?(io, context[:location])
-        end
-
-        # Returns true if file should be moved.
-        def moving_storage?
-          opts[:moving_storages].nil? ||
-          opts[:moving_storages].include?(storage_key)
-        end
-      end
-    end
-
-    register_plugin(:moving, Moving)
-  end
-end

data/lib/shrine/plugins/multi_delete.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-Shrine.deprecation("The multi_delete plugin is deprecated and will be removed in Shrine 3.")
-
-class Shrine
-  module Plugins
-    # Documentation lives in [doc/plugins/multi_delete.md] on GitHub.
-    #
-    # [doc/plugins/multi_delete.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/multi_delete.md
-    module MultiDelete
-      module InstanceMethods
-        private
-
-        # Adds the ability to upload multiple files, leveraging the underlying
-        # storage's potential multi delete capability.
-        def _delete(uploaded_file, context)
-          if uploaded_file.is_a?(Array)
-            if storage.respond_to?(:multi_delete)
-              storage.multi_delete(uploaded_file.map(&:id))
-            else
-              uploaded_file.each { |file| _delete(file, context) }
-            end
-          else
-            super
-          end
-        end
-      end
-    end
-
-    register_plugin(:multi_delete, MultiDelete)
-  end
-end

data/lib/shrine/plugins/parallelize.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-require "thread"
-
-class Shrine
-  module Plugins
-    # Documentation lives in [doc/plugins/parallelize.md] on GitHub.
-    #
-    # [doc/plugins/parallelize.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/parallelize.md
-    module Parallelize
-      def self.configure(uploader, opts = {})
-        uploader.opts[:parallelize_threads] = opts.fetch(:threads, uploader.opts.fetch(:parallelize_threads, 3))
-      end
-
-      def self.load_dependencies(uploader, opts = {})
-        uploader.plugin :hooks
-      end
-
-      module InstanceMethods
-        def around_store(io, context)
-          with_pool { |pool| super(io, context.update(thread_pool: pool)) }
-        end
-
-        def around_delete(uploaded_file, context)
-          with_pool { |pool| super(uploaded_file, context.update(thread_pool: pool)) }
-        end
-
-        private
-
-        def put(io, context)
-          context[:thread_pool].enqueue { super }
-        end
-
-        def remove(uploaded_file, context)
-          context[:thread_pool].enqueue { super }
-        end
-
-        # We initialize a thread pool with configured number of threads.
-        def with_pool(&block)
-          pool = ThreadPool.new(opts[:parallelize_threads])
-          result = yield pool
-          pool.perform
-          result
-        end
-      end
-
-      class ThreadPool
-        def initialize(size)
-          @size = size
-          @tasks = Queue.new
-        end
-
-        def enqueue(&task)
-          @tasks.enq(task)
-        end
-
-        def perform
-          @tasks.close
-          threads = @size.times.map { spawn_thread }
-          threads.each(&:join)
-        end
-
-        private
-
-        def spawn_thread
-          Thread.new do
-            loop do
-              task = @tasks.deq or break
-              task.call
-            end
-          end
-        end
-      end
-    end
-
-    register_plugin(:parallelize, Parallelize)
-  end
-end