mini_paperclip 0.1.0

data/gemfiles/rails_60.gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+gemspec path: '../'
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rack-test"
+gem "webmock"
+gem "tapp"
+gem 'activerecord', '~> 6.0.0'
+gem "sqlite3"

data/gemfiles/rails_60.gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: ..
+  specs:
+    mini_paperclip (0.1.0)
+      activemodel
+      activesupport
+      aws-sdk-s3
+      mimemagic
+      mini_magick
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    aws-eventstream (1.1.0)
+    aws-partitions (1.399.0)
+    aws-sdk-core (3.109.3)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-kms (1.39.0)
+      aws-sdk-core (~> 3, >= 3.109.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.85.0)
+      aws-sdk-core (~> 3, >= 3.109.0)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.2.2)
+      aws-eventstream (~> 1, >= 1.0.2)
+    concurrent-ruby (1.1.7)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.4.0)
+    mimemagic (0.3.5)
+    mini_magick (4.11.0)
+    minitest (5.14.2)
+    public_suffix (4.0.6)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    sqlite3 (1.4.2)
+    tapp (1.5.1)
+      thor
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    webmock (3.10.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 6.0.0)
+  mini_paperclip!
+  rack-test
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  sqlite3
+  tapp
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/lib/mini_paperclip.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "openssl"
+require "net/http"
+require "active_model/validator"
+require "active_support"
+require "active_support/number_helper"
+require "mini_magick"
+require "mimemagic"
+require "aws-sdk-s3"
+
+require "mini_paperclip/attachment"
+require "mini_paperclip/class_methods"
+require "mini_paperclip/config"
+require "mini_paperclip/interpolator"
+require "mini_paperclip/storage"
+require "mini_paperclip/validators"
+require "mini_paperclip/version"
+
+module MiniPaperclip
+  class << self
+    def config
+      @config ||= Config.new(
+        # defaults
+        interpolates: {
+          /:class/ => ->(*) { class_result },
+          /:attachment/ => ->(*) { attachment_result },
+          /:hash/ => ->(_, style) { hash_key(style) },
+          /:extension/ => ->(*) { File.extname(@record.read_attribute("#{@attachment_name}_file_name"))[1..-1] },
+          /:id/ => ->(*) { @record.id },
+          /:updated_at/ => ->(*) { @record.read_attribute("#{@attachment_name}_updated_at").to_i },
+          /:style/ => ->(_, style) { style }
+        },
+        hash_data: ":class/:attribute/:id/:style/:updated_at",
+        url_missing_path: ":attachment/:style/missing.png",
+        read_timeout: 60,
+        logger: Logger.new($stdout),
+      )
+    end
+  end
+end

data/lib/mini_paperclip/attachment.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+module MiniPaperclip
+  class Attachment
+    UnsupporedError = Class.new(StandardError)
+
+    attr_reader :record, :attachment_name, :config, :storage,
+                :waiting_write_file, :meta_content_type
+
+    def initialize(record, attachment_name, overwrite_config = {})
+      @record = record
+      @attachment_name = attachment_name
+      @config = MiniPaperclip.config.merge(overwrite_config)
+      @waiting_write_file = nil
+      @meta_content_type = nil
+      @dirty = false
+      @storage = Storage.const_get(@config.storage.to_s.camelcase)
+                        .new(record, attachment_name, @config)
+    end
+
+    def original_filename
+      @record.read_attribute("#{@attachment_name}_file_name")
+    end
+
+    def content_type
+      @record.read_attribute("#{@attachment_name}_content_type")
+    end
+
+    def size
+      @record.read_attribute("#{@attachment_name}_file_size")
+    end
+
+    def updated_at
+      @record.read_attribute("#{@attachment_name}_updated_at").to_i
+    end
+
+    def file?
+      original_filename.present?
+    end
+    alias_method :present?, :file?
+
+    def blank?
+      !file?
+    end
+
+    def exists?(style = :original)
+      file? && @storage.exists?(style)
+    end
+
+    def url(style = :original)
+      @storage.url_for_read(style)
+    end
+
+    def dirty?
+      @dirty
+    end
+
+    def assign(file)
+      @dirty = true
+      @waiting_copy_attachment = nil
+      @waiting_write_file = nil
+      @meta_content_type = nil
+
+      if file.nil?
+        # clear
+        @record.write_attribute("#{@attachment_name}_file_name", nil)
+        @record.write_attribute("#{@attachment_name}_content_type", nil)
+        @record.write_attribute("#{@attachment_name}_file_size", nil)
+        @record.write_attribute("#{@attachment_name}_updated_at", nil)
+      elsif file.instance_of?(Attachment)
+        # copy
+        @record.write_attribute("#{@attachment_name}_file_name", file.record.read_attribute("#{@attachment_name}_file_name"))
+        @record.write_attribute("#{@attachment_name}_content_type", file.record.read_attribute("#{@attachment_name}_content_type"))
+        @record.write_attribute("#{@attachment_name}_file_size", file.record.read_attribute("#{@attachment_name}_file_size"))
+        @record.write_attribute("#{@attachment_name}_updated_at", Time.current)
+        @waiting_copy_attachment = file
+      elsif file.respond_to?(:original_filename)
+        # e.g. ActionDispatch::Http::UploadedFile
+        @record.write_attribute("#{@attachment_name}_file_name", file.original_filename)
+        @record.write_attribute("#{@attachment_name}_content_type", strict_content_type(file.to_io))
+        @record.write_attribute("#{@attachment_name}_file_size", file.size)
+        @record.write_attribute("#{@attachment_name}_updated_at", Time.current)
+        @waiting_write_file = build_tempfile(file.tap(&:rewind))
+        @meta_content_type = file.content_type
+      elsif file.respond_to?(:path)
+        # e.g. File
+        @record.write_attribute("#{@attachment_name}_file_name", File.basename(file.path))
+        @record.write_attribute("#{@attachment_name}_content_type", strict_content_type(file))
+        @record.write_attribute("#{@attachment_name}_file_size", file.size)
+        @record.write_attribute("#{@attachment_name}_updated_at", Time.current)
+        @waiting_write_file = build_tempfile(file.tap(&:rewind))
+      elsif file.instance_of?(String)
+        if file.empty?
+          # do nothing
+        elsif file.start_with?('http')
+          # download from url
+          open_uri_option = {
+            read_timeout: MiniPaperclip.config.read_timeout || 60
+          }
+          uri = URI.parse(file)
+          uri.open(open_uri_option) do |io|
+            @record.write_attribute("#{@attachment_name}_file_name", File.basename(uri.path))
+            @record.write_attribute("#{@attachment_name}_content_type", strict_content_type(io))
+            @record.write_attribute("#{@attachment_name}_file_size", io.size)
+            @record.write_attribute("#{@attachment_name}_updated_at", Time.current)
+            @waiting_write_file = build_tempfile(io.tap(&:rewind))
+            @meta_content_type = io.meta["content-type"]
+          end
+        elsif file.start_with?('data:')
+          # data-uri
+          match_data = file.match(/\Adata:([-\w]+\/[-\w\+\.]+)?;base64,(.*)/m)
+          if match_data.nil?
+            raise UnsupporedError, "attachment for \"#{file[0..100]}\" is not supported"
+          end
+          raw = Base64.decode64(match_data[2])
+          @record.write_attribute("#{@attachment_name}_file_name", nil)
+          @record.write_attribute("#{@attachment_name}_content_type", strict_content_type(StringIO.new(raw)))
+          @record.write_attribute("#{@attachment_name}_file_size", raw.bytesize)
+          @record.write_attribute("#{@attachment_name}_updated_at", Time.current)
+          @waiting_write_file = build_tempfile(StringIO.new(raw))
+          @meta_content_type = match_data[1]
+        else
+          raise UnsupporedError, "attachment for \"#{file[0..100]}\" is not supported"
+        end
+      else
+        raise UnsupporedError, "attachment for #{file.class} is not supported"
+      end
+    end
+
+    def process_and_store
+      return unless file?
+
+      if @waiting_copy_attachment
+        debug("start attachment copy")
+        @storage.copy(:original, @waiting_copy_attachment)
+        @config.styles&.each do |style, size_arg|
+          @storage.copy(style, @waiting_copy_attachment)
+        end
+        @waiting_copy_attachment = nil
+        return
+      end
+
+      return if @waiting_write_file.nil?
+
+      begin
+        debug("start attachment styles process")
+        @storage.write(:original, @waiting_write_file)
+        @config.styles&.each do |style, size_arg|
+          Tempfile.create([style.to_s, File.extname(@waiting_write_file.path)]) do |temp|
+            MiniMagick::Tool::Convert.new do |convert|
+              convert << @waiting_write_file.path
+              if size_arg.end_with?('#')
+                # crop option
+                convert.resize("#{size_arg[0..-2]}^")
+                convert.gravity("center")
+                convert.extent(size_arg[0..-2])
+              else
+                convert.resize(size_arg)
+              end
+              convert << temp.path
+            end
+            @storage.write(style, temp)
+          end
+        end
+      ensure
+        @waiting_write_file.close!
+      end
+      @waiting_write_file = nil
+    end
+
+    private
+
+    def strict_content_type(io)
+      MimeMagic.by_magic(io)&.type
+    end
+
+    def build_tempfile(io)
+      temp = Tempfile.new(['MiniPaperclip'])
+      temp.binmode
+      debug("copying by tempfile from:#{io.class} to:#{temp.path}")
+      IO.copy_stream(io, temp)
+      temp.rewind
+      temp
+    end
+
+    def debug(str)
+      MiniPaperclip.config.logger.debug(str)
+    end
+  end
+end

data/lib/mini_paperclip/class_methods.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module MiniPaperclip
+  module ClassMethods
+    def has_attached_file(attachment_name, option_config = {})
+      define_method(attachment_name) do
+        instance_variable_get("@#{attachment_name}") or
+          instance_variable_set("@#{attachment_name}", Attachment.new(self, attachment_name, option_config))
+      end
+      define_method("#{attachment_name}=") do |file|
+        a = Attachment.new(self, attachment_name, option_config)
+        a.assign(file)
+        instance_variable_set("@#{attachment_name}", a)
+      end
+      after_save do
+        if valid?
+          instance_variable_get("@#{attachment_name}")&.tap do |a|
+            a.dirty? && a.process_and_store
+          end
+        end
+      end
+      validates_with Validators::MediaTypeSpoofValidator, {
+        attributes: attachment_name,
+        if: -> { instance_variable_get("@#{attachment_name}")&.dirty? }
+      }
+    end
+
+    def validates_attachment(attachment_name, content_type: nil, size: nil, presence: nil, geometry: nil, **opts)
+      if content_type
+        validates_with Validators::ContentTypeValidator, {
+          attributes: attachment_name.to_sym,
+          **content_type,
+          **opts,
+        }
+      end
+
+      if size
+        validates_with Validators::FileSizeValidator, {
+          attributes: attachment_name.to_sym,
+          **size,
+          **opts,
+        }
+      end
+
+      if !presence.nil?
+        validates_with Validators::PresenceValidator, {
+          attributes: attachment_name.to_sym,
+          presence: presence,
+          **opts,
+        }
+      end
+
+      if geometry
+        validates_with Validators::GeometryValidator, {
+          attributes: attachment_name.to_sym,
+          **geometry,
+          **opts,
+        }
+      end
+    end
+  end
+end

data/lib/mini_paperclip/config.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MiniPaperclip
+  class Config < Struct.new(
+    :storage,
+    :filesystem_path,
+    :hash_secret,
+    :hash_data,
+    :styles,
+    :url_scheme,
+    :url_host,
+    :url_path,
+    :url_missing_path,
+    :s3_host_alias,
+    :s3_bucket_name,
+    :s3_acl,
+    :s3_cache_control,
+    :interpolates,
+    :read_timeout,
+    :logger,
+    keyword_init: true,
+  )
+    def merge(hash)
+      dup.merge!(hash)
+    end
+
+    def merge!(hash)
+      to_h.deep_merge(hash).each { |k, v| self[k] = v }
+      self
+    end
+  end
+end

data/lib/mini_paperclip/interpolator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module MiniPaperclip
+  class Interpolator
+    def initialize(record, attachment_name, config)
+      @record = record
+      @attachment_name = attachment_name
+      @config = config
+    end
+
+    def interpolate(template, style)
+      template.dup.tap do |t|
+        @config.interpolates&.each do |matcher, block|
+          t.gsub!(matcher) { instance_exec(attachment, style, &block) }
+        end
+      end
+    end
+
+    private
+
+    def class_result
+      @record.class.name.underscore.pluralize
+    end
+
+    def attachment_result
+      @attachment_name.to_s.downcase.pluralize
+    end
+
+    def attachment
+      @record.public_send(@attachment_name)
+    end
+
+    def hash_key(style)
+      OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest::SHA1.new,
+        @config.hash_secret,
+        interpolate(@config.hash_data, style),
+      )
+    end
+  end
+end