retina_rails 1.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31ec07293af143bd14885c2afe55b7e2f4835827
-  data.tar.gz: a52f634b29d6f2779ad7efe0c8707c6123538a20
+  metadata.gz: ab138b302000f7fe80c74791698ab63eb3767f9f
+  data.tar.gz: fcc8039ef665d5e15e4cdcb561015d79df618efc
 SHA512:
-  metadata.gz: 3de52f4874673f6c29f14290fb0b716e2a2ad605790119b437428c9beb6267fa1ea5ce7dc7d57dae9b3ede7ae550eace649f624904a6b20be3abb0013d761ecb
-  data.tar.gz: a3774c7bb7158d80c1a3cefaa0c3ccf601c9932c618d98f6cb645c16a069d0d6e5cea48e088ce3d8567ce5b84573bafc7c55b60c43823742dff769b8453efee5
+  metadata.gz: a07feddf0d93c425dcd7dee264afff7d3eab6dbee8d7072439d3a48e6d122595e0c54200cb6442104232bdd9c1f5a93763b4474272b4ffba8c2bf9925967e937
+  data.tar.gz: 679e66d2d3b510e851b18f55d1a92fd1d6ef543ba7ec168fbee867e24e32ea27740dd6255b0a05e37ebddd605586a204f183a6d14b535b1501de4afec24a0e7f

data/.gitignore

@@ -13,11 +13,9 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
-spec/paperclip_uploads
-spec/strategies/paperclip_uploads
-spec/retina_rails/strategies/paperclip_uploads
 test/tmp
 test/version_tmp
 tmp
 log
 uploads
+public

data/.travis.yml

@@ -1,6 +1,18 @@
 language: ruby
 rvm:
- - 1.9.2
- - 1.9.3
- - 2.0.0
- - ruby-head
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - ruby-head
+
+env:
+  - "RAILS_VERSION=3.1.0"
+  - "RAILS_VERSION=3.2.0"
+  - "RAILS_VERSION=4.0.0"
+  - "RAILS_VERSION=master"
+
+matrix:
+  allow_failures:
+    - env: "RAILS_VERSION=master"
+    - rvm: ruby-head

data/README.md

@@ -4,19 +4,49 @@
 
 Makes your life easier optimizing an application for retina displays.
 
+### Still using version 1.0.x?
+
+---
+
+Check [upgrading](https://github.com/jhnvz/retina_rails/blob/master/UPGRADING.md) to upgrade or the version 1.0.x [readme](https://github.com/jhnvz/retina_rails/tree/1.0.4).
+
+---
+
 How it works
 ------------
 
-Retina Rails automatically generates retina versions of your uploaded images (CarrierWave or Paperclip). It detects if a visitor has a retina display and if so it displays the @2x version.
+Retina Rails makes your application use high-resolution images by default. It automatically optimizes uploaded images (CarrierWave or Paperclip) for retina displays by making them twice the size and reducing the quality.
+
+*Good source on setting up image quality: http://www.netvlies.nl/blog/design-interactie/retina-revolution*
+
+Resources
+------------
 
-Note: It also works for images that live in assets/images.
+- [Installation](#installation)
+- [Migrations](#migrations)
+- [Carrierwave](#carrierwave)
+- [Paperclip](#paperclip)
+- [Displaying a retina image](#displaying-a-retina-image)
+- [Upgrading](https://github.com/jhnvz/retina_rails/blob/master/UPGRADING.md) 
 
 Installation
 ------------
 
-1. Add `gem 'retina_rails'` to your Gemfile.
+1. Add `gem 'retina_rails', '~> 2.0.0'` to your Gemfile.
 1. Run `bundle install`.
-1. Add `//= require retina` to your Javascript manifest file (usually found at `app/assets/javascripts/application.js`).
+
+Migrations
+------------
+
+Add a text column named `retina_dimensions`. This column is used to store original dimensions of the images.
+
+```ruby
+class AddRetinaDimensionsToUsers < ActiveRecord::Migration
+  def self.change
+    add_column :users, :retina_dimensions, :text
+  end
+end
+```
 
 CarrierWave
 ------------
@@ -30,7 +60,7 @@ class ExampleUploader < CarrierWave::Uploader::Base
 
   version :small do
     process :resize_to_fill => [30, 30]
-    process :retina_quality => 25
+    process :retina_quality => 80
   end
 
   version :large, :retina => false do
@@ -39,11 +69,12 @@ class ExampleUploader < CarrierWave::Uploader::Base
 
 end
 ```
-By default it sets the retina image quality to 40 which can be overriden with `process :retina_quality => 25`. To disable the creation of a retina version simply call `version :small, :retina => false`.
 
-### Custom processors
+By default it sets the retina image quality to 60 which can be overriden with `process :retina_quality => 80`. To disable the creation of a retina version simply call `version :small, :retina => false`.
 
-You can also use your custom processors like so:
+### Custom resize processors
+
+You can also use your custom resize processors like so:
 
 ```ruby
 class ExampleUploader < CarrierWave::Uploader::Base
@@ -51,23 +82,20 @@ class ExampleUploader < CarrierWave::Uploader::Base
   retina!
 
   version :small, :retina => false do
-    process :resize_to_fill_with_gravity => [100, 100, 'North', :jpg, 75]
-  end
-
-  version :small_retina, :retina => false do
-    process :resize_to_fill_with_gravity => [200, 200, 'North', :jpg, 40]
+    process :resize_to_fill_with_gravity => [200, 200, 'North', :jpg, 75]
+    process :store_retina_dimensions
   end
 
 end
 ```
 
-This will generate `small.jpg` and `small@2x.jpg`.
+Make sure you double the image size yourself in your processor. In this example the image will be displayed with a size of 100x100.
 
 
 Paperclip
 ------------
 
-Simply add `retina!` to your model and set `:retina` to true.
+Simply add `retina!` to your model.
 
 ```ruby
 class ExampleUploader < ActiveRecord::Base
@@ -77,38 +105,38 @@ class ExampleUploader < ActiveRecord::Base
   has_attached_file :image,
     :styles => {
        :original => ["800x800", :jpg],
-       :big => ["125x125#", :jpg]
+       :small => ["125x125#", :jpg]
      },
-     :retina => true # Or
-     :retina => { :quality => 25 } # Optional
+     :retina => { :quality => 80 }
 
 end
 ```
-By default it sets the retina image quality to 40 which can be overriden by adding a `quality` option.
 
-For retina images use
+By default it sets the retina image quality to 60 which can be overriden by adding a `quality` option. To disable the creation of a retina version set the `retina` option to false `:retina => false`.
+
+Displaying a retina image
 ------------
 
 ```ruby
-image_tag('image.png', :retina => true)
+retina_image_tag(@user, :image, :small, :default => [50, 40)
+# or
+retina_image_tag(@user, :image, :small, :default => { :width => 50, :height => 40 })
 ```
 
-Voila! Now you're using Retina Rails.
+If no image is uploaded (yet) it will display the default image defined with CarrierWave or Paperclip and set the width and height attributes specified in the default option.
+
+**Voila! Now you're using Retina Rails.**
 
 Supported Ruby Versions
 ------------
 
-This library aims to support and is tested against[travis] the following Ruby
+This library is tested against Travis and aims to support the following Ruby
 implementations:
 
 * Ruby 1.9.2
 * Ruby 1.9.3
 * Ruby 2.0.0
-
-Credits
-------------
-
-Retina Rails uses retinajs (https://github.com/imulus/retinajs)
+* Ruby 2.1.1
 
 Contributing
 ------------
@@ -122,4 +150,4 @@ Contributing
 Copyright
 ------------
 
-Copyright (c) 2012 Johan van Zonneveld. See LICENSE for details.
+Copyright (c) 2012-2014 Johan van Zonneveld. See LICENSE for details.

data/UPGRADING

@@ -0,0 +1,7 @@
+##################################################
+#  NOTE FOR UPGRADING FROM PRE-2.0 VERSION       #
+##################################################
+
+Retina Rails 2.0 introduces non-backward compatible changes.
+Check https://github.com/jhnvz/retina_rails/blob/master/UPGRADING.md
+for more details.

data/UPGRADING.md

@@ -0,0 +1,60 @@
+# Upgrading
+
+In version 2.0.0 we got rid of double image uploads and and the javascript helper. Retina Rails now displays high-resolution images by default instead of swapping the low-res image with a high-res version. This will save up on requests and storage.
+
+Since the whole strategy for displaying images has changed there are some things you need to do for version 2.0.0 to work.
+
+## Javascript helper
+
+Remove `//= require retina` from your Javascript manifest file (usually found at app/assets/javascripts/application.js) since we don't need it anymore.
+
+## Migrations
+
+You'll need to add a `retina_dimensions` column to the table of every model using retina optimised image uploads.
+
+**For example:**
+```ruby
+class AddRetinaDimensionsToUsers < ActiveRecord::Migration
+  def self.change
+    add_column :users, :retina_dimensions, :text
+  end
+end
+```
+
+## Displaying images
+
+Instead of rendering images with the `image_tag` method we now render with `retina_image_tag`.
+
+**Old way:**
+```ruby
+image_tag(@user.image.url(:small), :retina => true)
+```
+
+**New way:**
+```ruby
+retina_image_tag(@user, :image, :small, :default => [50, 40)
+# or
+retina_image_tag(@user, :image, :small, :default => { :width => 50, :height => 40 })
+```
+
+## Reprocessing uploads
+
+Since we only store the retina optimised version we need to save the original dimensions of the uploaded image. Every uploaded image needs to be reprocessed.
+
+### Carrierwave
+
+Open up a console and run:
+```ruby
+Model.find_each do |model|
+  model.image.recreate_versions!
+end
+```
+Or create a rake task that will do the trick for you.
+
+### Paperclip
+
+Run: `rake paperclip:refresh`
+
+---
+
+Make sure to run a test on your local machine or your staging environment before deploying to a production environment.

data/lib/retina_rails.rb

@@ -1,19 +1,23 @@
 require 'retina_rails/version'
+require 'retina_rails/extensions'
+require 'retina_rails/processors'
 require 'retina_rails/strategies'
 require 'retina_rails/helpers'
-require 'retina_rails/exception'
-
-require 'retina_rails/deprecation/carrierwave'
-require 'retina_rails/deprecation/paperclip'
 
 module RetinaRails
 
   if defined?(Rails)
-    class Engine < Rails::Engine; end
-
     class Railtie < Rails::Railtie
+      initializer "retina_rails.include_extenions" do
+        RetinaRails::Extensions.include_extensions
+      end
+
+      initializer "retina_rails.include_processors" do
+        RetinaRails::Processors.include_processors
+      end
+
       initializer "retina_rails.include_strategies" do
-         RetinaRails::Strategies.include_strategies
+        RetinaRails::Strategies.include_strategies
       end
     end
   end

data/lib/retina_rails/extensions.rb

@@ -0,0 +1,16 @@
+module RetinaRails
+  module Extensions
+
+    def self.include_extensions
+      if defined?(::CarrierWave)
+        require 'retina_rails/extensions/carrierwave'
+        ::CarrierWave::Mount.send(:include, CarrierWave::Mount)
+      end
+      if defined?(::Paperclip)
+        require 'retina_rails/extensions/paperclip'
+        ::Paperclip::Style.send(:include, Paperclip::Style)
+      end
+    end
+
+  end # Extensions
+end # RetinaRails

data/lib/retina_rails/extensions/carrierwave.rb

@@ -0,0 +1,25 @@
+module RetinaRails
+  module Extensions
+    module CarrierWave
+      module Mount
+
+        def self.included base
+          base.module_eval do
+            alias_method :original_mount_uploader, :mount_uploader
+
+            ##
+            # Serialize retina_dimensions
+            # if mounted to class has a retina_dimensions column
+            #
+            def mount_uploader(*args)
+              original_mount_uploader(*args)
+
+              serialize :retina_dimensions if table_exists? && columns_hash.has_key?('retina_dimensions')
+            end
+          end
+        end
+
+      end # Mount
+    end # CarrierWave
+  end # Extensions
+end # RetinaRails

data/lib/retina_rails/extensions/paperclip.rb

@@ -0,0 +1,23 @@
+module RetinaRails
+  module Extensions
+    module Paperclip
+      module Style
+
+        def self.included base
+          base.class_eval do
+            alias_method :original_processor_options, :processor_options
+
+            ##
+            # Make sure to add the current style being processed to the args
+            # so we can identify which style is being processed
+            #
+            def processor_options
+              original_processor_options.merge!(:style => name)
+            end
+          end
+        end
+
+      end # Style
+    end # Paperclip
+  end # Extensions
+end # RetinaRails

data/lib/retina_rails/helpers.rb

@@ -2,23 +2,53 @@ module ActionView
   module Helpers
     module AssetTagHelper
 
-      def image_tag_with_retina(source, options={})
-        retina = options.delete(:retina)
+      ##
+      # Displays a version of an upload and sets stored width and height attributes
+      #
+      # === Parameters
+      #
+      # [model (Model)] model instance
+      # [mounted_to (Sym)] attribute to which uploader is mounted
+      # [version (Sym)] version of the upload
+      # [options (Hash)] optional options hash
+      #
+      # === Examples
+      #
+      # retina_image_tag(@user, :avatar, :small, :default => { :width => 300, :height => 200 })
+      # retina_image_tag(@user, :avatar, :small, :default => [300, 200])
+      #
+      def retina_image_tag(model, mounted_to, version, options={})
+        default = options.delete(:default)
+
+        # Check if we can find the dimensions of the uploaded image.
+        # If no image or dimensions available use default.
+        if model.retina_dimensions.kind_of?(Hash) && model.retina_dimensions[mounted_to.to_sym]
+          dimensions = model.retina_dimensions[mounted_to.to_sym][version.to_sym]
+        else
+          if default.kind_of?(Array)
+            default = { :width => default[0], :height => default[1] }
+          end
+          dimensions = default || {}
+        end
 
-        if retina
-          retina_source = source.to_s
-          retina_source = retina_source.split('.')
-          filename      = retina_source.slice!(-2)
-          retina_source = retina_source.insert(-2, "#{filename}@2x").join('.')
+        options = dimensions.merge(options)
 
-          options[:data] ||= {}
-          options[:data].merge!(:at2x => path_to_image(retina_source))
+        image_tag(model.send(mounted_to).url(version), options)
+      end
+
+      ##
+      # Show deprecation warning when old image_tag helper with retina option is used.
+      # TODO: Remove in new release
+      #
+      def image_tag_with_retina(source, options={})
+        if options.delete(:retina)
+          ActiveSupport::Deprecation.warn("`image_tag('image.png', :retina => true)` is deprecated use `retina_image_tag` instead")
         end
 
         image_tag_without_retina(source, options)
       end
       alias_method_chain :image_tag, :retina
 
-    end
-  end
-end
+    end # AssetTagHelper
+  end # Helpers
+end # ActionView