Need help with carrierwave-imageoptimizer?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

jtescher
204 Stars 26 Forks MIT License 54 Commits 0 Opened issues

Description

This gem allows you to simply optimize CarrierWave images via jpegoptim or optipng.

Services available

!
?

Need anything else?

Contributors list

CarrierWave ImageOptimizer

This gem allows you to simply optimize CarrierWave images via jpegoptim or optipng using the image_optimizer gem.

Tested against 2.2.x, 2.3.x, and ruby-head

Build Status Code Climate Coverage Status Gem Version

Installation

This gem uses the following utilities for optimizing images:
  1. jpegoptim, which can be installed from the official jpegoptim repository

  2. OptiPNG, which can be installed from sourceforge.net

Or install the utilities via homebrew:

$ brew install optipng jpegoptim

Then add this line to your application's Gemfile:

gem 'carrierwave-imageoptimizer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install carrierwave-imageoptimizer

Installation on Heroku

If you are using Heroku for your production you must use heroku buildpacks in order to install

optipng
and
jpegoptim
. jayzes has some plug and play buildpacks to get you going in no time.

On an existing Heroku app and using the Heroku CLI

  1. Add this gem to your gemfile.
  2. Modify your code following the instrunctions on the usage section.
  3. heroku buildpacks:add --index 1 https://github.com/jayzes/heroku-buildpack-optipng
  4. heroku buildpacks:add --index 1 https://github.com/jayzes/heroku-buildpack-jpegoptim
  5. git push heroku
    • It is important to do a push to heroku _after__ the buildpacks have been declared._

Usage

To add image optimization to your CarrierWave uploader, first include the module:

class MyUploader < CarrierWave::Uploader::Base
  include CarrierWave::ImageOptimizer
  ...
end

Then apply to all versions via:

class MyUploader < CarrierWave::Uploader::Base
  ...
  process :optimize
end

Or to a single image version via:

class MyUploader < CarrierWave::Uploader::Base
  ...
  version :thumbnail do
    process :optimize
  end
end
Lossy JPEG optimization

Pass an optional

quality
parameter to target a specific lossy JPG quality level (0-100), default is lossless optimization. PNGs will ignore the quality setting.
class MyUploader < CarrierWave::Uploader::Base
  ...
  version :thumbnail do
    process optimize: [{ quality: 50 }]
  end
end
Quiet Mode

Pass an optional

quiet
parameter to compress images without logging progress.
class MyUploader < CarrierWave::Uploader::Base
  ...
  version :thumbnail do
    process optimize: [{ quiet: true }]
  end
end

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.