carrierwave-optimize_image 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e3cc95b0412f0cbe6b6f47dbd7837ee625cd484
+  data.tar.gz: b81a6e963eec254af21acdeb732a88152065f1e2
+SHA512:
+  metadata.gz: 8fb59213ea4fd79a9b38d71d866af1cced81975a162e065c5a23677a6f193ac7fb8411d5331b02afea61414bf3fb3b00e33408f744468d1b0de5f45a08cb6465
+  data.tar.gz: 6303e1f19462f126475615a36614bd74fc36894e683b93082e4ab3117685e06de61f012ce2c954cef94cf1bb5dee59777f97ffdb5a049b0656562f2671e45ba1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/tmp/
+/pkg/
+/spec/reports/
+/coverage/
+/doc/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0
+gemfile:
+  - Gemfile
+  - gemfiles/activesupport5.gemfile
+before_install:
+  - sudo apt-get install jpegoptim pngquant
+  - gem update bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in carrierwave-optimize_image.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kazuki Yamaguchi 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# CarrierWave OptimizeImage
+
+This gem allows you to simply optimize [CarrierWave](https://github.com/carrierwaveuploader/carrierwave) images via jpegoptim or optipng using the image_optimizer gem.
+
+## Installation
+Add this line to your application's Gemfile:
+
+**This gem uses the following utilities for optimizing images:**
+
+  - Install for [pngquant](https://github.com/pornel/pngquant)
+  - Install for [jpegoptim](https://github.com/tjko/jpegoptim)
+
+Or install the utilities via homebrew:
+
+    $ brew install pngquant jpegoptim
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "carrierwave-optimize_image"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carrierwave-optimize_image
+
+
+## Usage
+
+To add image optimization to your CarrierWave uploader, first include the module:
+
+```ruby
+  class ImageUploader < CarrierWave::Uploader::Base
+    include CarrierWave::OptimizeImage
+    ...
+  end
+```
+
+Then apply to all versions via:
+
+```ruby
+  class ImageUploader < CarrierWave::Uploader::Base
+    include CarrierWave::OptimizeImage
+    ...
+    process :optimize
+  end
+```
+
+Or to a single image version via:
+
+```ruby
+  class ImageUploader < CarrierWave::Uploader::Base
+    ...
+    version :thumbnail do
+      process :optimize
+    end
+  end
+```
+
+Pass an optional quality parameter to target a specific lossy JPG and PNG quality level (0-100)
+
+```ruby
+  class ImageUploader < CarrierWave::Uploader::Base
+    version :thumbnail do
+      process optimize: [{ quality: 60 }]
+    end
+  end
+```
+
+**Quiet Mode**
+
+Pass an optional ```quiet``` parameter to compress images without logging progress.
+
+```ruby
+  class ImageUploader < CarrierWave::Uploader::Base
+    ...
+    version :thumbnail do
+      process optimize: [{ quiet: true }]
+    end
+  end
+```
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b new_feature_branch`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin new_feature_branch`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task default: :spec

data/carrierwave-optimize_image.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "carrierwave/optimize_image/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "carrierwave-optimize_image"
+  spec.version       = CarrierWave::OptimizeImage::VERSION
+  spec.authors       = ["kazuki YAMAGUCHI"]
+  spec.email         = ["y.kazuki0614n@gmail.com"]
+  spec.homepage      = "https://github.com/yamakichi/carrierwave-optimize_image"
+  spec.description   = %q{A simple image optimize for CarrierWave}
+  spec.summary       = %q{Simple optimize CarrierWave via jpegoptim and pngquant}
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split("\n")
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "mini_magick"
+  spec.add_development_dependency "carrierwave"
+end

data/gemfiles/activesupport5.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.0"
+
+gemspec path: "../"

data/lib/carrierwave/exceptions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CarrierWave::OptimizeImage
+  class OptimizeError < StandardError; end
+  class NotFoundPngquant < OptimizeError; end
+  class NotFoundJpegoptim < OptimizeError; end
+end

data/lib/carrierwave/optimize_image.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "carrierwave/optimize_image/image_optimizer"
+require "carrierwave/optimize_image/version"
+require "carrierwave/exceptions"
+
+module CarrierWave
+  module OptimizeImage
+    def optimize(opts = {})
+      ImageOptimizer.optimize(current_path, opts)
+    end
+  end
+end

data/lib/carrierwave/optimize_image/image_optimizer.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module CarrierWave
+  module OptimizeImage
+    module ImageOptimizer
+      class << self
+        def optimize(path, opts = {})
+          raise NotFoundPngquant unless which_pngquant?
+          raise NotFoundJpegoptim unless which_jpegoptim?
+          optimize_for(path, opts)
+        end
+
+        private
+
+          def which_pngquant?
+            system! "which pngquant"
+          end
+
+          def which_jpegoptim?
+            system! "which jpegoptim"
+          end
+
+          def optimize_for(path, opts)
+            case mimetype(path)
+              when "jpeg" then optimize_jpg(path, opts)
+              when "png"  then optimize_png(path, opts)
+            end
+          end
+
+          def mimetype(path)
+            IO.popen(["file", "--brief", "--mime-type", path], in: :close, err: :close) { |io| io.read.chomp.sub(/image\//, "") }
+          end
+
+          def system!(*args)
+            system(*args) || abort("\n== Command #{args} failed ==")
+          end
+
+          def optimize_png(path, opts = {})
+            options = { verbose: false, quality: 100 }.merge!(opts)
+            quality = (0..100).include?(options[:quality]) ? options[:quality] : 100
+            vo = options[:verbose] ? " --verbose" : "--quiet"
+            path.gsub!(/([\(\)\[\]\{\}\*\?\\])/, '\\\\\1')
+            system! "pngquant --quality #{quality} #{vo} #{path}"
+          end
+
+          def optimize_jpg(path, opts = {})
+            options = { verbose: false, quality: 100 }.merge!(opts)
+            quality = (0..100).include?(options[:quality]) ? options[:quality] : 100
+            vo = options[:verbose] ? "--verbose" : "--quiet"
+            path.gsub!(/([\(\)\[\]\{\}\*\?\\])/, '\\\\\1')
+            system! "jpegoptim --force --max=#{quality} #{vo} #{path}"
+          end
+      end
+    end
+  end
+end

data/lib/carrierwave/optimize_image/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CarrierWave
+  module OptimizeImage
+    VERSION = "0.2.0"
+  end
+end

data/spec/optimize_image/version_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe CarrierWave::OptimizeImage do
+  it "should have a VERSION constant" do
+    expect(subject.const_get("VERSION")).to_not be_empty
+  end
+end

data/spec/optimize_image_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+require "carrierwave/optimize_image/image_optimizer"
+require "carrierwave/optimize_image"
+
+class MiniMagickUploader < CarrierWave::Uploader::Base
+  include CarrierWave::MiniMagick
+  include CarrierWave::OptimizeImage
+end
+
+describe CarrierWave::OptimizeImage::ImageOptimizer do
+  describe "#optimize" do
+    let(:sample_jpg_path) { File.join('spec', 'assets', 'sample.jpg') }
+    let(:sample_jpg_image) { File.open(sample_jpg_path) }
+
+    let(:sample_png_path) { File.join('spec', 'assets', 'sample.png') }
+    let(:sample_png_image) { File.open(sample_png_path) }
+
+    def upload_file(uploader, image)
+      uploader.store!(image)
+      uploader.manipulate! do |img|
+        img
+      end
+    end
+
+    it "calls the uploader's `current_path` when MiniMagick is used" do
+      uploader = MiniMagickUploader.new
+      upload_file(uploader, sample_jpg_image)
+      expect(CarrierWave::OptimizeImage::ImageOptimizer).to receive(:optimize).with(uploader.current_path, {})
+      uploader.optimize
+    end
+
+    it "calls `optimize_png` if the .png files MIME type is that of a PNG" do
+      uploader = MiniMagickUploader.new
+      upload_file(uploader, sample_png_image)
+      expect(CarrierWave::OptimizeImage::ImageOptimizer).to receive(:optimize_png).with(uploader.current_path, {})
+      uploader.optimize
+    end
+
+    it "calls `optimize_jpg` if the .jpg files MIME type is that of a JPEG" do
+      uploader = MiniMagickUploader.new
+      upload_file(uploader, sample_jpg_image)
+      expect(CarrierWave::OptimizeImage::ImageOptimizer).to receive(:optimize_jpg).with(uploader.current_path, {})
+      uploader.optimize
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "carrierwave"
+require "carrierwave/optimize_image"
+require "carrierwave/optimize_image/image_optimizer"

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-optimize_image
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- kazuki YAMAGUCHI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: bundler
+  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: mini_magick
+  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: carrierwave
+  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'
+description: A simple image optimize for CarrierWave
+email:
+- y.kazuki0614n@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- carrierwave-optimize_image.gemspec
+- gemfiles/activesupport5.gemfile
+- lib/carrierwave/exceptions.rb
+- lib/carrierwave/optimize_image.rb
+- lib/carrierwave/optimize_image/image_optimizer.rb
+- lib/carrierwave/optimize_image/version.rb
+- spec/assets/sample.jpg
+- spec/assets/sample.png
+- spec/optimize_image/version_spec.rb
+- spec/optimize_image_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/yamakichi/carrierwave-optimize_image
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Simple optimize CarrierWave via jpegoptim and pngquant
+test_files: []