paperclip-optimizer 0.2.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+paperclip-optimizer.sublime-project
+paperclip-optimizer.sublime-workspace

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+paperclip-optimizer

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p392

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+before_install:
+ - sudo apt-get install -qq libjpeg-progs optipng
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jan-Christian Foeh
+
+MIT License
+
+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,85 @@
+# PaperclipOptimizer
+
+[![Build Status](https://travis-ci.org/janfoeh/paperclip-optimizer.png)](https://travis-ci.org/janfoeh/paperclip-optimizer)
+[![Dependency Status](https://gemnasium.com/janfoeh/paperclip-optimizer.png)](https://gemnasium.com/janfoeh/paperclip-optimizer)
+
+PaperClipOptimizer is a processor for [Paperclip](https://github.com/thoughtbot/paperclip) that allows 
+you to optimize and minify uploaded JPG, PNG or GIF images.
+
+It is just a thin wrapper around [ImageOptim](https://github.com/toy/image_optim), 
+which supports many external optimization libraries like
+
+* [advpng](http://advancemame.sourceforge.net/doc-advpng.html) from 
+  [AdvanceCOMP](http://advancemame.sourceforge.net/comp-readme.html)
+* [gifsicle](http://www.lcdf.org/gifsicle/)
+* [jpegoptim](http://www.kokkonen.net/tjko/projects.html)
+* jpegtran from [Independent JPEG Group's JPEG library](http://www.ijg.org/)
+* [optipng](http://optipng.sourceforge.net/)
+* [pngcrush](http://pmt.sourceforge.net/pngcrush/)
+* [pngout](http://www.advsys.net/ken/util/pngout.htm)
+
+## Installation
+
+Add this line to your application's Gemfile after the Paperclip gem:
+
+    gem 'paperclip-optimizer'
+
+And then execute:
+
+    $ bundle
+
+See [ImageOptims README](https://github.com/toy/image_optim#binaries-location) 
+on how to install the various optimization libraries.
+
+## Usage
+
+Just add ```:paperclip_optimizer``` to Paperclips ```:processors``` - setting:
+
+```ruby
+class User < ActiveRecord::Base
+  attr_accessible :avatar
+  has_attached_file :avatar, 
+                    :styles => { :thumb => "100x100>" },
+                    :default_url => "/images/:style/missing.png",
+                    :processors => [:thumbnail, :paperclip_optimizer]
+end
+```
+
+Remember to include the ```:thumbnail``` processor as well if you want to retain 
+Paperclips geometry functionality.
+
+### Settings
+
+By default, PaperclipOptimizer only enables _jpegtran_ and _optipng_. You can 
+pass configuration options to ImageOptim through the ```:styles``` hash:
+
+```ruby
+class User < ActiveRecord::Base
+  attr_accessible :avatar
+  has_attached_file :avatar, 
+                    :styles => {
+                      :thumb => {
+                        :geometry => "100x100>",
+                        :paperclip_optimizer => {
+                          :pngout => {
+                            :strategy => 1
+                          }
+                        }
+                      }
+                    },
+                    :default_url => "/images/:style/missing.png",
+                    :processors => [:thumbnail, :paperclip_optimizer]
+end
+```
+
+See [ImageOptims options](https://github.com/toy/image_optim#options) for 
+all available options.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fixtures/invalid.jpg

@@ -0,0 +1,29 @@
+# Paperclip::Optimizer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'paperclip-optimizer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paperclip-optimizer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/fixtures/invalid.png

@@ -0,0 +1,29 @@
+# Paperclip::Optimizer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'paperclip-optimizer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paperclip-optimizer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/paperclip-optimizer.rb

@@ -0,0 +1,31 @@
+require "paperclip-optimizer/version"
+require "paperclip-optimizer/processor"
+
+module PaperclipOptimizer
+  DEFAULT_SETTINGS = {
+    verbose: true,
+    pngcrush: false, 
+    pngout: false, 
+    advpng: false, 
+    jpegoptim: false, 
+    gifsicle: false
+  }.freeze
+
+  # Helper class for capturing ImageOptims error output and redirecting it
+  # to Paperclips logger instance
+  class StdErrCapture
+    def initialize(logger, log_level = :error)
+      @logger     = logger
+      @log_level  = log_level
+    end
+
+    def write(string)
+      @logger.send(@log_level, string)
+    end
+
+    alias_method "<<", :write
+
+    def flush; end
+  end
+
+end

data/lib/paperclip-optimizer/processor.rb

@@ -0,0 +1,32 @@
+require "paperclip"
+require "image_optim"
+
+module Paperclip
+  class PaperclipOptimizer < Processor
+    def make
+      settings = (@options[:paperclip_optimizer] || {}).reverse_merge(::PaperclipOptimizer::DEFAULT_SETTINGS)
+
+      src_path = File.expand_path(@file.path)
+
+      if settings[:verbose]
+        Paperclip.logger.info "optimizing #{src_path} with settings: #{settings.inspect}"
+
+        old_stderr  = $stderr
+        $stderr     = ::PaperclipOptimizer::StdErrCapture.new(Paperclip.logger)
+      end
+
+      begin
+        image_optim           = ImageOptim.new(settings)
+        compressed_file_path  = image_optim.optimize_image(src_path)
+      ensure
+        $stderr = old_stderr if settings[:verbose]
+      end
+
+      if compressed_file_path && File.exists?(compressed_file_path)
+        return File.open(compressed_file_path)
+      else
+        return @file
+      end
+    end
+  end
+end

data/lib/paperclip-optimizer/version.rb

@@ -0,0 +1,3 @@
+module PaperclipOptimizer
+  VERSION = "0.2.0"
+end

data/paperclip-optimizer.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paperclip-optimizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "paperclip-optimizer"
+  spec.version       = PaperclipOptimizer::VERSION
+  spec.authors       = ["Jan-Christian Föh"]
+  spec.email         = ["jan@programmanstalt.de"]
+  spec.description   = %q{paperclip-optimizer is a processor for Paperclip that allows you to optimize and minify uploaded JPEG and PNG files.}
+  spec.summary       = %q{Minify Paperclip JPEG and PNG attachments}
+  spec.homepage      = "https://github.com/janfoeh/paperclip-optimizer"
+  spec.license       = "MIT"
+
+  spec.add_dependency "paperclip", "~> 3.4.1"
+  spec.add_dependency "image_optim", "~> 0.8"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'sqlite3'
+
+  spec.add_runtime_dependency "paperclip"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

data/spec/paperclip-optimizer_spec.rb

@@ -0,0 +1,99 @@
+require "spec_helper"
+require "fileutils"
+
+describe Paperclip::PaperclipOptimizer do
+
+  def stubbed_upload_model(*args)
+    stubbed_model = Upload.dup
+
+    # prevent ActiveModel::Validations from blowing up when error messages are 
+    # accessed on an anonymous class
+    stubbed_model.stub(:model_name => ActiveModel::Name.new(self, nil, "temp"))
+    stubbed_model.any_instance.stub(*args)
+
+    stubbed_model
+  end
+
+  before(:each) do
+    tmp_dir = File.join(File.dirname(__FILE__), 'tmp')
+
+    Dir.mkdir(tmp_dir) unless File.directory?(tmp_dir)
+    
+    Dir.entries(tmp_dir).each do |f|
+      next unless f.end_with?(".jpg", ".png")
+
+      FileUtils.remove_entry_secure( File.join(tmp_dir, f) )
+    end
+  end
+
+  it "creates smaller JPEGs" do
+    jpg = get_fixture(:jpg)
+    unoptimized_upload = Upload.new(:image => jpg)
+    jpg.close
+    unoptimized_upload.save
+
+    jpg = get_fixture(:jpg)
+    optimized_upload  = stubbed_upload_model(
+                          processor_settings: [:thumbnail, :paperclip_optimizer]
+                        ).new(:image => jpg)
+    jpg.close
+    optimized_upload.save
+
+    unoptimized_file_size  = File.size(unoptimized_upload.image.path(:medium))
+    optimized_file_size    = File.size(optimized_upload.image.path(:medium))
+
+    expect(optimized_file_size).to be < unoptimized_file_size
+  end
+
+  it "creates smaller PNGs" do
+    png = get_fixture(:png)
+    unoptimized_upload = Upload.new(:image => png)
+    unoptimized_upload.save
+    png.close
+
+    png = get_fixture(:png)
+    optimized_upload  = stubbed_upload_model(
+                          processor_settings: [:thumbnail, :paperclip_optimizer]
+                        ).new(:image => png)
+    png.close
+    optimized_upload.save
+
+    unoptimized_file_size  = File.size(unoptimized_upload.image.path(:medium))
+    optimized_file_size    = File.size(optimized_upload.image.path(:medium))
+
+    expect(optimized_file_size).to be < unoptimized_file_size
+  end
+
+  it "does not prevent invalid attachments from being saved" do
+    jpg = get_fixture(:jpg, "invalid")
+    upload  = stubbed_upload_model(
+                processor_settings: [:paperclip_optimizer]
+              ).new(:image => jpg)
+    jpg.close
+    upload.save
+
+    expect(upload.errors).to be_empty
+    expect(upload.persisted?).to be_true
+  end
+
+  it "should allow disabled optimization options to be reenabled" do
+    settings  = {
+                  :gifsicle => {:interlace => true}
+                }.reverse_merge(::PaperclipOptimizer::DEFAULT_SETTINGS)
+
+    ImageOptim.should_receive(:new).with(settings).and_call_original
+
+    jpg = get_fixture(:jpg)
+
+    stubbed_upload_model(
+      processor_settings: [:paperclip_optimizer],
+      style_settings: { 
+        medium: {
+          paperclip_optimizer: {
+            gifsicle: {:interlace => true}
+          }
+        }
+      }
+    ).new(:image => jpg)
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table "uploads", :force => true do |t|
+    t.string :image_file_name
+    t.string :image_content_type
+    t.integer :image_updated_at
+    t.integer :image_file_size
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'paperclip'
+require 'paperclip/railtie'
+# require 'filemagic'
+require 'paperclip-optimizer'
+
+require 'rspec'
+require 'rspec/autorun'
+
+require "active_record"
+
+# taken from https://github.com/tienle/docsplit-paperclip-processor/blob/master/spec/spec_helper.rb
+
+ActiveRecord::Base.establish_connection(
+  "adapter" => "sqlite3",
+  "database" => ":memory:"
+)
+
+ActiveRecord::Base.logger = Logger.new(nil)
+load(File.join(File.dirname(__FILE__), 'schema.rb'))
+
+Paperclip::Railtie.insert
+
+class Upload < ActiveRecord::Base
+  self.table_name = "uploads"
+
+  has_attached_file :image,
+      :storage    => :filesystem,
+      :path       => "./spec/tmp/:id.:extension",
+      :url        => "/spec/tmp/:id.:extension",
+      :styles     => lambda { |attachment| attachment.instance.style_settings },
+      :processors => lambda { |instance| instance.processor_settings }
+
+  def style_settings
+    { 
+      medium: { geometry: "500x500>" }
+    }
+  end
+
+  def processor_settings
+    [:thumbnail]
+  end
+end
+
+def get_fixture(file_type = :jpg, valid = "valid")
+  file_name     = "#{valid}.#{file_type.to_s}"
+  fixtures_dir  = File.join(File.dirname(__FILE__), "../fixtures")
+  fixture_path  = File.join(fixtures_dir, file_name)
+
+  File.open(fixture_path)
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-optimizer
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Jan-Christian Föh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+- !ruby/object:Gem::Dependency
+  name: image_optim
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: paperclip-optimizer is a processor for Paperclip that allows you to optimize
+  and minify uploaded JPEG and PNG files.
+email:
+- jan@programmanstalt.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fixtures/invalid.jpg
+- fixtures/invalid.png
+- fixtures/valid.jpg
+- fixtures/valid.png
+- lib/paperclip-optimizer.rb
+- lib/paperclip-optimizer/processor.rb
+- lib/paperclip-optimizer/version.rb
+- paperclip-optimizer.gemspec
+- spec/paperclip-optimizer_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+homepage: https://github.com/janfoeh/paperclip-optimizer
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Minify Paperclip JPEG and PNG attachments
+test_files:
+- spec/paperclip-optimizer_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb