kt-paperclip-compression 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 388c0d55aefababf29de64ca183f7150ed864c3bd8c32bea1be5bdd96a0c2ac0
+  data.tar.gz: ac1c7bd982f52d1242ceeec563403a9b2646c6974d36686d11fa2f36b7860d19
+SHA512:
+  metadata.gz: 94d1c13bfc17cab2647ffe1a81a85ab1923842b8d8792f1e85d1ea1721d2c0bce73505e1efb57bd65235c2a23b9fa834eec58fe9d63307a5db9d442cf755d9e6
+  data.tar.gz: a6a9bc7bffb5c9ad747ee73f4f73278231135e5b69ab2947b9fa13eaaa26da88b878e272c85230dd0372f28c7410d5b918259bf6695b26bbd6dc9d888e8e3f70

data/lib/kt-paperclip-compression.rb

@@ -0,0 +1 @@
+require 'paperclip-compression'

data/lib/paperclip-compression.rb

@@ -0,0 +1,13 @@
+require 'kt-paperclip'
+require 'os'
+require 'paperclip-compression/paperclip/compression'
+require 'paperclip-compression/base'
+require 'paperclip-compression/config'
+require 'paperclip-compression/jpeg'
+require 'paperclip-compression/png'
+
+module PaperclipCompression
+  def self.root
+    Gem::Specification.find_by_name('kt-paperclip-compression').gem_dir
+  end
+end

data/lib/paperclip-compression/base.rb

@@ -0,0 +1,85 @@
+module PaperclipCompression
+
+  ExitStatusError = defined?(Cocaine) ? Cocaine::ExitStatusError : Terrapin::ExitStatusError
+  CommandNotFoundError = defined?(Cocaine) ? Cocaine::CommandNotFoundError : Terrapin::CommandNotFoundError
+
+  class Base
+
+    def initialize(file, first_processor)
+      @file             = file
+      current_extension = File.extname(file.path)
+      @basename         = File.basename(file.path, current_extension)
+      @dst              = Paperclip::TempfileFactory.new.generate(@basename)
+      @dst_path         = File.expand_path(@dst.path)
+      @src_path         = File.expand_path(@file.path)
+      @first_processor  = first_processor
+    end
+
+    def self.make(file, first_processor, options = {})
+      new(file, first_processor, options).make
+    end
+
+    def process_file
+      # Close output file so compressors which require exclusive file rights
+      # work.
+      @dst.close
+
+      # Execute the child-compressor classes implementation of how to compress
+      # the output
+      compress
+
+      # Re-open the output file so downstream paperclip-middleware may
+      # read/write/etc. without having to re-open the file.
+      @dst.open
+
+      # Return the destination file for downstream paperclip processors.
+      @dst
+    end
+
+    protected
+
+    def process_file?
+      @cli_opts
+    end
+
+    def unprocessed_tempfile
+      copy_to_tempfile
+      first_processor? ? @dst : @file
+    end
+
+    def command_path(command)
+     folder = if OS.osx?
+        File.join('osx', catalina? ? '64bit' : '32bit')
+      elsif OS.linux?
+        File.join('linux', OS.bits.eql?(64) ? 'x64' : 'x86')
+      elsif OS.windows?
+        OS.bits.eql?(64) ? 'win64' : 'win32'
+      end
+
+      File.join(PaperclipCompression.root, 'bin', folder, command)
+    end
+
+    private
+
+    def compress
+      fail MustImplementInSubClassesException,
+           'compress is overridden on a per compressor basis.'
+    end
+
+    def first_processor?
+      @first_processor
+    end
+
+    def copy_to_tempfile
+      FileUtils.cp(@src_path, @dst_path)
+    end
+
+    def catalina?
+      major = OS.host_os.match(/darwin(\d+)\./)[1].to_i
+      major >= 19
+    end
+  end
+
+  # Informs developers when a method is intended to be defined in # sub-classes.
+  class MustImplementInSubClassesException < Exception; end
+end

data/lib/paperclip-compression/config.rb

@@ -0,0 +1,85 @@
+module PaperclipCompression
+  class Config
+
+    PROCESSOR_OPTIONS_KEY = :processor_options
+    KEY = :compression
+
+    def self.create_with_fallbacks(style_options, type_key, gem_defaults)
+      gem_config = new({ KEY => { type_key => gem_defaults } }, type_key, nil, nil)
+      defaults_config = new(Paperclip::Attachment.default_options, type_key, gem_config, Paperclip::Attachment.default_options[:whiny])
+      new(style_options[PROCESSOR_OPTIONS_KEY], type_key, defaults_config, style_options[:whiny])
+    end
+
+    def initialize(options, type_key, fallback, whiny)
+      @whiny = whiny
+      @fallback = fallback
+      parse_options(options, type_key)
+    end
+
+    def process_file?
+      if defined?(@process_file)
+        @process_file
+      elsif @fallback
+        @fallback.process_file?
+      else
+        raise('options or fallback should have attributes')
+      end
+    end
+
+    def command
+      if defined?(@command)
+        @command
+      elsif @fallback
+        @fallback.command
+      else
+        raise("options or fallback should have 'command'")
+      end
+    end
+
+    def options
+      if defined?(@options)
+        @options
+      elsif @fallback
+        @fallback.options
+      else
+        raise("options or fallback should have 'options'")
+      end
+    end
+
+    def whiny
+      @whiny
+    end
+
+    private
+
+    def parse_options(options, type_key)
+      if options && options.has_key?(KEY)
+        compression_opts = options[KEY]
+
+        if compression_opts.eql?(true)
+          @process_file = true
+        elsif compression_opts.eql?(false) || compression_opts.eql?(nil)
+          @process_file = false
+        elsif compression_opts.is_a?(Hash) && compression_opts.has_key?(type_key)
+          parse_type_options(compression_opts[type_key])
+        end
+      end
+    end
+
+    def parse_type_options(type_opts)
+      if type_opts
+        @process_file = true
+
+        if type_opts.is_a?(String)
+          @options = type_opts
+        elsif type_opts.is_a?(Hash)
+          @command = type_opts[:command] if type_opts.has_key?(:command)
+          @options = type_opts[:options] if type_opts.has_key?(:options)
+        end
+      else
+        @process_file = false
+      end
+    end
+
+  end
+end

data/lib/paperclip-compression/jpeg.rb

@@ -0,0 +1,39 @@
+module PaperclipCompression
+  class Jpeg < Base
+
+    KEY = :jpeg
+    JPEGTRAN_DEFAULT_OPTS = '-copy none -optimize -perfect'
+
+    def initialize(file, first_processor, options = {})
+      super(file, first_processor)
+      @config = PaperclipCompression::Config.create_with_fallbacks(options, KEY, gem_defaults)
+    end
+
+    def make
+      begin
+        @config.process_file? ? process_file : unprocessed_tempfile
+      rescue ExitStatusError
+        raise Paperclip::Error, "JPEGTRAN : There was an error processing #{@basename}" if @config.whiny
+      rescue CommandNotFoundError
+        raise Paperclip::Errors::CommandNotFoundError.new("Could not run 'jpegtran'. Please install jpegtran.")
+      end
+    end
+
+    private
+
+    def gem_defaults
+      {
+        command: command_path('jpegtran'),
+        options: JPEGTRAN_DEFAULT_OPTS
+      }
+    end
+
+    def compress
+      Paperclip.run(
+        @config.command,
+        "#{@config.options} :src_path > :dst_path",
+        src_path: @src_path, dst_path: @dst_path
+      )
+    end
+  end
+end

data/lib/paperclip-compression/paperclip/compression.rb

@@ -0,0 +1,33 @@
+module Paperclip
+  # Compresses the JPEG and PNG files
+  class Compression < Processor
+
+    def make
+      case content_type
+      when 'image/jpeg' then make_jpeg
+      when 'image/png'  then make_png
+      else
+        @file
+      end
+    end
+
+    private
+
+    def content_type
+      first_processor? ? @file.content_type : Paperclip::ContentTypeDetector.new(@file.path).detect
+    end
+
+    def first_processor?
+      @first_processor ||= @file.is_a?(Paperclip::AbstractAdapter)
+    end
+
+    def make_jpeg
+      PaperclipCompression::Jpeg.make(@file, first_processor?, @options)
+    end
+
+    def make_png
+      PaperclipCompression::Png.make(@file, first_processor?, @options)
+    end
+
+  end
+end

data/lib/paperclip-compression/png.rb

@@ -0,0 +1,39 @@
+module PaperclipCompression
+  class Png < Base
+
+    KEY = :png
+    OPTIPNG_DEFAULT_OPTS = '-o 5 -quiet'
+
+    def initialize(file, first_processor, options = {})
+      super(file, first_processor)
+      @config = PaperclipCompression::Config.create_with_fallbacks(options, KEY, gem_defaults)
+    end
+
+    def make
+      begin
+        @config.process_file? ? process_file : unprocessed_tempfile
+      rescue ExitStatusError
+        raise Paperclip::Error, "OPTIPNG : There was an error processing #{@basename}" if @config.whiny
+      rescue CommandNotFoundError
+        raise Paperclip::Errors::CommandNotFoundError.new("Could not run 'optipng'. Please install optipng.")
+      end
+    end
+
+    private
+
+    def gem_defaults
+      {
+        command: command_path('optipng'),
+        options: OPTIPNG_DEFAULT_OPTS
+      }
+    end
+
+    def compress
+      Paperclip.run(
+        @config.command,
+        "#{@config.options} -clobber :src_path -out :dst_path",
+        src_path: @src_path, dst_path: @dst_path
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: kt-paperclip-compression
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- İ. Emre Kutlu, Adam Anderson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kt-paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.1
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+description: JPEG and PNG compression for Paperclip gem
+email: emrekutlu@gmail.com, adam@makeascene.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/linux/x64/jpegtran
+- bin/linux/x64/optipng
+- bin/linux/x86/jpegtran
+- bin/linux/x86/optipng
+- bin/osx/32bit/jpegtran
+- bin/osx/32bit/optipng
+- bin/osx/64bit/jpegtran
+- bin/osx/64bit/optipng
+- bin/win32/jpegtran.exe
+- bin/win32/libjpeg-62.dll
+- bin/win32/optipng.exe
+- bin/win64/jpegtran.exe
+- bin/win64/libjpeg-62.dll
+- lib/kt-paperclip-compression.rb
+- lib/paperclip-compression.rb
+- lib/paperclip-compression/base.rb
+- lib/paperclip-compression/config.rb
+- lib/paperclip-compression/jpeg.rb
+- lib/paperclip-compression/paperclip/compression.rb
+- lib/paperclip-compression/png.rb
+homepage: http://github.com/adamtao/kt-paperclip-compression
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Image compression for Paperclip
+test_files: []