kt-paperclip 6.2.0

data/lib/paperclip/missing_attachment_styles.rb

@@ -0,0 +1,84 @@
+require "paperclip/attachment_registry"
+require "set"
+
+module Paperclip
+  class << self
+    attr_writer :registered_attachments_styles_path
+    def registered_attachments_styles_path
+      @registered_attachments_styles_path ||= Rails.root.join("public/system/paperclip_attachments.yml").to_s
+    end
+  end
+
+  # Get list of styles saved on previous deploy (running rake paperclip:refresh:missing_styles)
+  def self.get_registered_attachments_styles
+    YAML.load_file(Paperclip.registered_attachments_styles_path)
+  rescue Errno::ENOENT
+    nil
+  end
+  private_class_method :get_registered_attachments_styles
+
+  def self.save_current_attachments_styles!
+    File.open(Paperclip.registered_attachments_styles_path, "w") do |f|
+      YAML.dump(current_attachments_styles, f)
+    end
+  end
+
+  # Returns hash with styles for all classes using Paperclip.
+  # Unfortunately current version does not work with lambda styles:(
+  #   {
+  #     :User => {:avatar => [:small, :big]},
+  #     :Book => {
+  #       :cover => [:thumb, :croppable]},
+  #       :sample => [:thumb, :big]},
+  #     }
+  #   }
+  def self.current_attachments_styles
+    Hash.new.tap do |current_styles|
+      Paperclip::AttachmentRegistry.each_definition do |klass, attachment_name, attachment_attributes|
+        # TODO: is it even possible to take into account Procs?
+        next if attachment_attributes[:styles].is_a?(Proc)
+
+        attachment_attributes[:styles].try(:keys).try(:each) do |style_name|
+          klass_sym = klass.to_s.to_sym
+          current_styles[klass_sym] ||= Hash.new
+          current_styles[klass_sym][attachment_name.to_sym] ||= Array.new
+          current_styles[klass_sym][attachment_name.to_sym] << style_name.to_sym
+          current_styles[klass_sym][attachment_name.to_sym].map!(&:to_s).sort!.map!(&:to_sym).uniq!
+        end
+      end
+    end
+  end
+  private_class_method :current_attachments_styles
+
+  # Returns hash with styles missing from recent run of rake paperclip:refresh:missing_styles
+  #   {
+  #     :User => {:avatar => [:big]},
+  #     :Book => {
+  #       :cover => [:croppable]},
+  #     }
+  #   }
+  def self.missing_attachments_styles
+    current_styles = current_attachments_styles
+    registered_styles = get_registered_attachments_styles
+
+    Hash.new.tap do |missing_styles|
+      current_styles.each do |klass, attachment_definitions|
+        attachment_definitions.each do |attachment_name, styles|
+          registered = begin
+                         registered_styles[klass][attachment_name] || []
+                       rescue StandardError
+                         []
+                       end
+          missed = styles - registered
+          if missed.present?
+            klass_sym = klass.to_s.to_sym
+            missing_styles[klass_sym] ||= Hash.new
+            missing_styles[klass_sym][attachment_name.to_sym] ||= Array.new
+            missing_styles[klass_sym][attachment_name.to_sym].concat(missed.to_a)
+            missing_styles[klass_sym][attachment_name.to_sym].map!(&:to_s).sort!.map!(&:to_sym).uniq!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/paperclip/processor.rb

@@ -0,0 +1,56 @@
+module Paperclip
+  # Paperclip processors allow you to modify attached files when they are
+  # attached in any way you are able. Paperclip itself uses command-line
+  # programs for its included Thumbnail processor, but custom processors
+  # are not required to follow suit.
+  #
+  # Processors are required to be defined inside the Paperclip module and
+  # are also required to be a subclass of Paperclip::Processor. There is
+  # only one method you *must* implement to properly be a subclass:
+  # #make, but #initialize may also be of use. #initialize accepts 3
+  # arguments: the file that will be operated on (which is an instance of
+  # File), a hash of options that were defined in has_attached_file's
+  # style hash, and the Paperclip::Attachment itself. These are set as
+  # instance variables that can be used within `#make`.
+  #
+  # #make must return an instance of File (Tempfile is acceptable) which
+  # contains the results of the processing.
+  #
+  # See Paperclip.run for more information about using command-line
+  # utilities from within Processors.
+  class Processor
+    attr_accessor :file, :options, :attachment
+
+    def initialize(file, options = {}, attachment = nil)
+      @file = file
+      @options = options
+      @attachment = attachment
+    end
+
+    def make; end
+
+    def self.make(file, options = {}, attachment = nil)
+      new(file, options, attachment).make
+    end
+
+    # The convert method runs the convert binary with the provided arguments.
+    # See Paperclip.run for the available options.
+    def convert(arguments = "", local_options = {})
+      Paperclip.run(
+        Paperclip.options[:is_windows] ? "magick convert" : "convert",
+        arguments,
+        local_options
+      )
+    end
+
+    # The identify method runs the identify binary with the provided arguments.
+    # See Paperclip.run for the available options.
+    def identify(arguments = "", local_options = {})
+      Paperclip.run(
+        Paperclip.options[:is_windows] ? "magick identify" : "identify",
+        arguments,
+        local_options
+      )
+    end
+  end
+end

data/lib/paperclip/processor_helpers.rb

@@ -0,0 +1,52 @@
+module Paperclip
+  module ProcessorHelpers
+    class NoSuchProcessor < StandardError; end
+
+    def processor(name) #:nodoc:
+      @known_processors ||= {}
+      if @known_processors[name.to_s]
+        @known_processors[name.to_s]
+      else
+        name = name.to_s.camelize
+        load_processor(name) unless Paperclip.const_defined?(name)
+        processor = Paperclip.const_get(name)
+        @known_processors[name.to_s] = processor
+      end
+    end
+
+    def load_processor(name)
+      if defined?(Rails.root) && Rails.root
+        filename = "#{name.to_s.underscore}.rb"
+        directories = %w(lib/paperclip lib/paperclip_processors)
+
+        required = directories.map do |directory|
+          pathname = File.expand_path(Rails.root.join(directory, filename))
+          file_exists = File.exist?(pathname)
+          require pathname if file_exists
+          file_exists
+        end
+
+        unless required.any?
+          raise LoadError, "Could not find the '#{name}' processor in any of these paths: #{directories.join(', ')}"
+        end
+      end
+    end
+
+    def clear_processors!
+      @known_processors.try(:clear)
+    end
+
+    # You can add your own processor via the Paperclip configuration. Normally
+    # Paperclip will load all processors from the
+    # Rails.root/lib/paperclip_processors directory, but here you can add any
+    # existing class using this mechanism.
+    #
+    #   Paperclip.configure do |c|
+    #     c.register_processor :watermarker, WatermarkingProcessor.new
+    #   end
+    def register_processor(name, processor)
+      @known_processors ||= {}
+      @known_processors[name.to_s] = processor
+    end
+  end
+end

data/lib/paperclip/rails_environment.rb

@@ -0,0 +1,21 @@
+module Paperclip
+  class RailsEnvironment
+    def self.get
+      new.get
+    end
+
+    def get
+      Rails.env if rails_exists? && rails_environment_exists?
+    end
+
+    private
+
+    def rails_exists?
+      Object.const_defined?(:Rails)
+    end
+
+    def rails_environment_exists?
+      Rails.respond_to?(:env)
+    end
+  end
+end

data/lib/paperclip/railtie.rb

@@ -0,0 +1,31 @@
+require "paperclip"
+require "paperclip/schema"
+
+module Paperclip
+  require "rails"
+
+  class Railtie < Rails::Railtie
+    initializer "paperclip.insert_into_active_record" do |app|
+      ActiveSupport.on_load :active_record do
+        Paperclip::Railtie.insert
+      end
+
+      if app.config.respond_to?(:paperclip_defaults)
+        Paperclip::Attachment.default_options.merge!(app.config.paperclip_defaults)
+      end
+    end
+
+    rake_tasks { load "tasks/paperclip.rake" }
+  end
+
+  class Railtie
+    def self.insert
+      Paperclip.options[:logger] = Rails.logger
+
+      if defined?(ActiveRecord)
+        Paperclip.options[:logger] = ActiveRecord::Base.logger
+        ActiveRecord::Base.include Paperclip::Glue
+      end
+    end
+  end
+end

data/lib/paperclip/schema.rb

@@ -0,0 +1,81 @@
+require "active_support/deprecation"
+
+module Paperclip
+  # Provides helper methods that can be used in migrations.
+  module Schema
+    COLUMNS = { file_name: :string,
+                content_type: :string,
+                file_size: :bigint,
+                updated_at: :datetime }.freeze
+
+    def self.included(_base)
+      ActiveRecord::ConnectionAdapters::Table.include TableDefinition
+      ActiveRecord::ConnectionAdapters::TableDefinition.include TableDefinition
+      ActiveRecord::ConnectionAdapters::AbstractAdapter.include Statements
+      ActiveRecord::Migration::CommandRecorder.include CommandRecorder
+    end
+
+    module Statements
+      def add_attachment(table_name, *attachment_names)
+        if attachment_names.empty?
+          raise ArgumentError, "Please specify attachment name in your add_attachment call in your migration."
+        end
+
+        options = attachment_names.extract_options!
+
+        attachment_names.each do |attachment_name|
+          COLUMNS.each_pair do |column_name, column_type|
+            column_options = options.merge(options[column_name.to_sym] || {})
+            add_column(table_name, "#{attachment_name}_#{column_name}", column_type, column_options)
+          end
+        end
+      end
+
+      def remove_attachment(table_name, *attachment_names)
+        if attachment_names.empty?
+          raise ArgumentError, "Please specify attachment name in your remove_attachment call in your migration."
+        end
+
+        attachment_names.each do |attachment_name|
+          COLUMNS.keys.each do |column_name|
+            remove_column(table_name, "#{attachment_name}_#{column_name}")
+          end
+        end
+      end
+
+      def drop_attached_file(*args)
+        ActiveSupport::Deprecation.warn "Method `drop_attached_file` in the migration has been deprecated and will be replaced by `remove_attachment`."
+        remove_attachment(*args)
+      end
+    end
+
+    module TableDefinition
+      def attachment(*attachment_names)
+        options = attachment_names.extract_options!
+        attachment_names.each do |attachment_name|
+          COLUMNS.each_pair do |column_name, column_type|
+            column_options = options.merge(options[column_name.to_sym] || {})
+            column("#{attachment_name}_#{column_name}", column_type, column_options)
+          end
+        end
+      end
+
+      def has_attached_file(*attachment_names)
+        ActiveSupport::Deprecation.warn "Method `t.has_attached_file` in the migration has been deprecated and will be replaced by `t.attachment`."
+        attachment(*attachment_names)
+      end
+    end
+
+    module CommandRecorder
+      def add_attachment(*args)
+        record(:add_attachment, args)
+      end
+
+      private
+
+      def invert_add_attachment(args)
+        [:remove_attachment, args]
+      end
+    end
+  end
+end

data/lib/paperclip/storage.rb

@@ -0,0 +1,3 @@
+require "paperclip/storage/filesystem"
+require "paperclip/storage/fog"
+require "paperclip/storage/s3"

data/lib/paperclip/storage/filesystem.rb

@@ -0,0 +1,99 @@
+module Paperclip
+  module Storage
+    # The default place to store attachments is in the filesystem. Files on the local
+    # filesystem can be very easily served by Apache without requiring a hit to your app.
+    # They also can be processed more easily after they've been saved, as they're just
+    # normal files. There are two Filesystem-specific options for has_attached_file:
+    # * +path+: The location of the repository of attachments on disk. This can (and, in
+    #   almost all cases, should) be coordinated with the value of the +url+ option to
+    #   allow files to be saved into a place where Apache can serve them without
+    #   hitting your app. Defaults to
+    #   ":rails_root/public/:attachment/:id/:style/:basename.:extension"
+    #   By default this places the files in the app's public directory which can be served
+    #   directly. If you are using capistrano for deployment, a good idea would be to
+    #   make a symlink to the capistrano-created system directory from inside your app's
+    #   public directory.
+    #   See Paperclip::Attachment#interpolate for more information on variable interpolaton.
+    #     :path => "/var/app/attachments/:class/:id/:style/:basename.:extension"
+    # * +override_file_permissions+: This allows you to override the file permissions for files
+    #   saved by paperclip. If you set this to an explicit octal value (0755, 0644, etc) then
+    #   that value will be used to set the permissions for an uploaded file. The default is 0666.
+    #   If you set :override_file_permissions to false, the chmod will be skipped. This allows
+    #   you to use paperclip on filesystems that don't understand unix file permissions, and has the
+    #   added benefit of using the storage directories default umask on those that do.
+    module Filesystem
+      def self.extended(base); end
+
+      def exists?(style_name = default_style)
+        if original_filename
+          File.exist?(path(style_name))
+        else
+          false
+        end
+      end
+
+      def flush_writes #:nodoc:
+        @queued_for_write.each do |style_name, file|
+          FileUtils.mkdir_p(File.dirname(path(style_name)))
+          begin
+            move_file(file.path, path(style_name))
+          rescue SystemCallError
+            File.open(path(style_name), "wb") do |new_file|
+              while chunk = file.read(16 * 1024)
+                new_file.write(chunk)
+              end
+            end
+          end
+          unless @options[:override_file_permissions] == false
+            resolved_chmod = (@options[:override_file_permissions] & ~0o111) || (0o666 & ~File.umask)
+            FileUtils.chmod(resolved_chmod, path(style_name))
+          end
+          file.rewind
+        end
+
+        after_flush_writes # allows attachment to clean up temp files
+
+        @queued_for_write = {}
+      end
+
+      def flush_deletes #:nodoc:
+        @queued_for_delete.each do |path|
+          begin
+            log("deleting #{path}")
+            FileUtils.rm(path) if File.exist?(path)
+          rescue Errno::ENOENT => e
+            # ignore file-not-found, let everything else pass
+          end
+          begin
+            loop do
+              path = File.dirname(path)
+              FileUtils.rmdir(path)
+              break if File.exist?(path) # Ruby 1.9.2 does not raise if the removal failed.
+            end
+          rescue Errno::EEXIST, Errno::ENOTEMPTY, Errno::ENOENT, Errno::EINVAL, Errno::ENOTDIR, Errno::EACCES
+            # Stop trying to remove parent directories
+          rescue SystemCallError => e
+            log("There was an unexpected error while deleting directories: #{e.class}")
+            # Ignore it
+          end
+        end
+        @queued_for_delete = []
+      end
+
+      def copy_to_local_file(style, local_dest_path)
+        FileUtils.cp(path(style), local_dest_path)
+      end
+
+      private
+
+      def move_file(src, dest)
+        # Support hardlinked files
+        if File.identical?(src, dest)
+          File.unlink(src)
+        else
+          FileUtils.mv(src, dest)
+        end
+      end
+    end
+  end
+end

data/lib/paperclip/storage/fog.rb

@@ -0,0 +1,252 @@
+module Paperclip
+  module Storage
+    # fog is a modern and versatile cloud computing library for Ruby.
+    # Among others, it supports Amazon S3 to store your files. In
+    # contrast to the outdated AWS-S3 gem it is actively maintained and
+    # supports multiple locations.
+    # Amazon's S3 file hosting service is a scalable, easy place to
+    # store files for distribution. You can find out more about it at
+    # http://aws.amazon.com/s3 There are a few fog-specific options for
+    # has_attached_file, which will be explained using S3 as an example:
+    # * +fog_credentials+: Takes a Hash with your credentials. For S3,
+    #   you can use the following format:
+    #     aws_access_key_id: '<your aws_access_key_id>'
+    #     aws_secret_access_key: '<your aws_secret_access_key>'
+    #     provider: 'AWS'
+    #     region: 'eu-west-1'
+    #     scheme: 'https'
+    # * +fog_directory+: This is the name of the S3 bucket that will
+    #   store your files.  Remember that the bucket must be unique across
+    #   all of Amazon S3. If the bucket does not exist, Paperclip will
+    #   attempt to create it.
+    # * +fog_file+: This can be hash or lambda returning hash. The
+    #   value is used as base properties for new uploaded file.
+    # * +path+: This is the key under the bucket in which the file will
+    #   be stored. The URL will be constructed from the bucket and the
+    #   path. This is what you will want to interpolate. Keys should be
+    #   unique, like filenames, and despite the fact that S3 (strictly
+    #   speaking) does not support directories, you can still use a / to
+    #   separate parts of your file name.
+    # * +fog_public+: (optional, defaults to true) Should the uploaded
+    #   files be public or not? (true/false)
+    # * +fog_host+: (optional) The fully-qualified domain name (FQDN)
+    #   that is the alias to the S3 domain of your bucket, e.g.
+    #   'http://images.example.com'. This can also be used in
+    #   conjunction with Cloudfront (http://aws.amazon.com/cloudfront)
+    # * +fog_options+: (optional) A hash of options that are passed
+    #   to fog when the file is created. For example, you could set
+    #   the multipart-chunk size to 100MB with a hash:
+    #     { :multipart_chunk_size => 104857600 }
+
+    module Fog
+      def self.extended(base)
+        unless defined?(Fog)
+          begin
+            require "fog"
+          rescue LoadError => e
+            e.message << " (You may need to install the fog gem)"
+            raise e
+          end
+        end
+
+        base.instance_eval do
+          unless @options[:url].to_s.match(/\A:fog.*url\z/)
+            @options[:path]  = @options[:path].gsub(/:url/, @options[:url]).gsub(/\A:rails_root\/public\/system\//, "")
+            @options[:url]   = ":fog_public_url"
+          end
+          unless Paperclip::Interpolations.respond_to? :fog_public_url
+            Paperclip.interpolates(:fog_public_url) do |attachment, style|
+              attachment.public_url(style)
+            end
+          end
+        end
+      end
+
+      AWS_BUCKET_SUBDOMAIN_RESTRICTON_REGEX = /\A(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}\z))(?:[a-z0-9]|\.(?![\.\-])|\-(?![\.])){1,61}[a-z0-9]\z/.freeze
+
+      def exists?(style = default_style)
+        if original_filename
+          !!directory.files.head(path(style))
+        else
+          false
+        end
+      end
+
+      def fog_credentials
+        @fog_credentials ||= parse_credentials(@options[:fog_credentials])
+      end
+
+      def fog_file
+        @fog_file ||= begin
+          value = @options[:fog_file]
+          if !value
+            {}
+          elsif value.respond_to?(:call)
+            value.call(self)
+          else
+            value
+          end
+        end
+      end
+
+      def fog_public(style = default_style)
+        if @options.key?(:fog_public)
+          value = @options[:fog_public]
+          if value.respond_to?(:key?) && value.key?(style)
+            value[style]
+          elsif value.respond_to?(:call)
+            value.call(self)
+          else
+            value
+          end
+        else
+          true
+        end
+      end
+
+      def flush_writes
+        @queued_for_write.each do |style, file|
+          log("saving #{path(style)}")
+          retried = false
+          begin
+            attributes = fog_file.merge(
+              body: file,
+              key: path(style),
+              public: fog_public(style),
+              content_type: file.content_type
+            )
+            attributes.merge!(@options[:fog_options]) if @options[:fog_options]
+            directory.files.create(attributes)
+          rescue Excon::Errors::NotFound
+            raise if retried
+
+            retried = true
+            directory.save
+            file.rewind
+            retry
+          ensure
+            file.rewind
+          end
+        end
+
+        after_flush_writes # allows attachment to clean up temp files
+
+        @queued_for_write = {}
+      end
+
+      def flush_deletes
+        @queued_for_delete.each do |path|
+          log("deleting #{path}")
+          directory.files.new(key: path).destroy
+        end
+        @queued_for_delete = []
+      end
+
+      def public_url(style = default_style)
+        if @options[:fog_host]
+          "#{dynamic_fog_host_for_style(style)}/#{path(style)}"
+        else
+          if fog_credentials[:provider] == "AWS"
+            "#{scheme}://#{host_name_for_directory}/#{path(style)}"
+          else
+            directory.files.new(key: path(style)).public_url
+          end
+        end
+      end
+
+      def expiring_url(time = (Time.now + 3600), style_name = default_style)
+        time = convert_time(time)
+        http_url_method = "get_#{scheme}_url"
+        if path(style_name) && directory.files.respond_to?(http_url_method)
+          expiring_url = directory.files.public_send(http_url_method, path(style_name), time)
+
+          if @options[:fog_host]
+            expiring_url.gsub!(/#{host_name_for_directory}/, dynamic_fog_host_for_style(style_name))
+          end
+        else
+          expiring_url = url(style_name)
+        end
+
+        expiring_url
+      end
+
+      def parse_credentials(creds)
+        creds = find_credentials(creds).stringify_keys
+        (creds[RailsEnvironment.get] || creds).symbolize_keys
+      end
+
+      def copy_to_local_file(style, local_dest_path)
+        log("copying #{path(style)} to local file #{local_dest_path}")
+        ::File.open(local_dest_path, "wb") do |local_file|
+          file = directory.files.get(path(style))
+          return false unless file
+
+          local_file.write(file.body)
+        end
+      rescue ::Fog::Errors::Error => e
+        warn("#{e} - cannot copy #{path(style)} to local file #{local_dest_path}")
+        false
+      end
+
+      private
+
+      def convert_time(time)
+        time = Time.now + time if time.is_a?(Integer)
+        time
+      end
+
+      def dynamic_fog_host_for_style(style)
+        if @options[:fog_host].respond_to?(:call)
+          @options[:fog_host].call(self)
+        else
+          @options[:fog_host] =~ /%d/ ? @options[:fog_host] % (path(style).hash % 4) : @options[:fog_host]
+        end
+      end
+
+      def host_name_for_directory
+        if directory_name.to_s =~ Fog::AWS_BUCKET_SUBDOMAIN_RESTRICTON_REGEX
+          "#{directory_name}.s3.amazonaws.com"
+        else
+          "s3.amazonaws.com/#{directory_name}"
+        end
+      end
+
+      def find_credentials(creds)
+        case creds
+        when File
+          YAML::safe_load(ERB.new(File.read(creds.path)).result)
+        when String, Pathname
+          YAML::safe_load(ERB.new(File.read(creds)).result)
+        when Hash
+          creds
+        else
+          if creds.respond_to?(:call)
+            creds.call(self)
+          else
+            raise ArgumentError, "Credentials are not a path, file, hash or proc."
+          end
+        end
+      end
+
+      def connection
+        @connection ||= ::Fog::Storage.new(fog_credentials)
+      end
+
+      def directory
+        @directory ||= connection.directories.new(key: directory_name)
+      end
+
+      def directory_name
+        if @options[:fog_directory].respond_to?(:call)
+          @options[:fog_directory].call(self)
+        else
+          @options[:fog_directory]
+        end
+      end
+
+      def scheme
+        @scheme ||= fog_credentials[:scheme] || "https"
+      end
+    end
+  end
+end