Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jtescher/carrierwave-imageoptimizer
This gem allows you to simply optimize CarrierWave images via jpegoptim or optipng.
https://github.com/jtescher/carrierwave-imageoptimizer
Last synced: 4 days ago
JSON representation
This gem allows you to simply optimize CarrierWave images via jpegoptim or optipng.
- Host: GitHub
- URL: https://github.com/jtescher/carrierwave-imageoptimizer
- Owner: jtescher
- License: mit
- Created: 2013-01-22T18:47:09.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2022-03-08T15:27:09.000Z (almost 3 years ago)
- Last Synced: 2024-10-09T07:08:54.534Z (2 months ago)
- Language: Ruby
- Homepage: https://rubygems.org/gems/carrierwave-imageoptimizer
- Size: 39.1 KB
- Stars: 212
- Watchers: 6
- Forks: 33
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-rails-gem - CarrierWave ImageOptimizer - This gem allows you to simply optimize CarrierWave images via jpegoptim or optipng using the image_optimizer gem. (File Uploading / Omniauth)
README
# CarrierWave ImageOptimizer
This gem allows you to simply optimize CarrierWave images via jpegoptim or optipng using the [image_optimizer](https://github.com/jtescher/image_optimizer) gem.
Tested against 2.2.x, 2.3.x, and ruby-head
[](http://travis-ci.org/jtescher/carrierwave-imageoptimizer)
[](https://codeclimate.com/github/jtescher/carrierwave-imageoptimizer)
[](https://coveralls.io/r/jtescher/carrierwave-imageoptimizer)
[](http://badge.fury.io/rb/carrierwave-imageoptimizer)
## Installation
##### This gem uses the following utilities for optimizing images:
1. jpegoptim, which can be installed from the official [jpegoptim](https://github.com/tjko/jpegoptim) repository
2. OptiPNG, which can be installed from [sourceforge.net](http://optipng.sourceforge.net/)
Or install the utilities via homebrew:
```bash
$ 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](https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app) in order to install `optipng` and `jpegoptim`. [jayzes](https://github.com/jayzes?tab=repositories) 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](#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:
```ruby
class MyUploader < CarrierWave::Uploader::Base
include CarrierWave::ImageOptimizer
...
end
```
Then apply to all versions via:
```ruby
class MyUploader < CarrierWave::Uploader::Base
...
process :optimize
end
```
Or to a single image version via:
```ruby
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.
```ruby
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.
```ruby
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