retina_rails 1.0.4 → 2.0.0

data/lib/retina_rails/processors.rb

@@ -0,0 +1,14 @@
+module RetinaRails
+  module Processors
+
+    def self.include_processors
+      if defined?(::CarrierWave)
+        require 'retina_rails/processors/carrierwave'
+      end
+      if defined?(::Paperclip)
+        require 'retina_rails/processors/paperclip'
+      end
+    end
+
+  end # Processors
+end # RetinaRails

data/lib/retina_rails/processors/carrierwave.rb

@@ -0,0 +1,49 @@
+module RetinaRails
+  module Processors
+    module CarrierWave
+
+      extend ActiveSupport::Concern
+
+      ##
+      # Stores the original dimensions of the image as a serialized Hash in to the model
+      #
+      def store_retina_dimensions
+        if model
+          width, height = `identify -format "%wx%h" #{file.path}`.split(/x/) ## Read dimensions
+
+          ## Set original height and width attributes on model
+
+          model.retina_dimensions = (model.retina_dimensions || {}).deep_merge!(
+            mounted_as => {
+              version_name => {
+                :width  => width.to_i  / 2,
+                :height => height.to_i / 2
+              }
+            }
+          )
+        end
+      end
+
+      ##
+      # Process retina quality of the image.
+      # Works with ImageMagick and MiniMagick
+      #
+      # === Parameters
+      #
+      # [percentage (Int)] quality in percentage
+      #
+      def retina_quality(percentage)
+        manipulate! do |img|
+          if defined?(Magick)
+            img.write(current_path) { self.quality = percentage } unless img.quality == percentage
+          elsif defined?(MiniMagick)
+            img.quality(percentage.to_s)
+          end
+          img = yield(img) if block_given?
+          img
+        end
+      end
+
+    end # CarrierWave
+  end # Processors
+end # RetinaRails

data/lib/retina_rails/processors/paperclip.rb

@@ -0,0 +1,30 @@
+module Paperclip
+  class SaveDimensions < Paperclip::Processor
+
+    ##
+    # Stores the original dimensions of the image as a serialized Hash in to the model
+    #
+    def make
+      model     = attachment.instance
+      file_path = file.path rescue nil
+      style     = options[:style]
+
+      if file_path
+        width, height = `identify -format "%wx%h" #{file_path}`.split(/x/) ## Read dimensions
+
+        ## Set original height and width attributes on model
+        model.retina_dimensions = (model.retina_dimensions || {}).deep_merge!(
+          attachment.name => {
+            style => {
+              :width  => width.to_i  / 2,
+              :height => height.to_i / 2
+            }
+          }
+        )
+      end
+
+      file
+    end
+
+  end # SaveDimensions
+end # Paperclip

data/lib/retina_rails/strategies.rb

@@ -1,17 +1,16 @@
-require 'retina_rails/strategies/carrierwave'
-require 'retina_rails/strategies/paperclip'
-
 module RetinaRails
   module Strategies
 
     def self.include_strategies
       if defined?(::CarrierWave)
-        ::CarrierWave::Uploader::Base.send(:include, RetinaRails::Strategies::CarrierWave::Base)
+        require 'retina_rails/strategies/carrierwave'
+        ::CarrierWave::Uploader::Base.send(:include, CarrierWave::Base)
       end
       if defined?(::Paperclip)
-        ::ActiveRecord::Base.send(:include, RetinaRails::Strategies::Paperclip::Base)
+        require 'retina_rails/strategies/paperclip'
+        ::ActiveRecord::Base.send(:include, Paperclip::Base)
       end
     end
 
-  end
-end
+  end # Strategies
+end # RetinaRails

data/lib/retina_rails/strategies/carrierwave.rb

@@ -11,25 +11,57 @@ module RetinaRails
             include Uploader
           end
 
-        end
+        end # ClassMethods
 
-      end
+      end # Base
 
       module Uploader
 
         extend ActiveSupport::Concern
+        include Processors::CarrierWave
 
         module ClassMethods
 
+          ##
+          # Adds a new version to this uploader
+          #
+          # === Parameters
+          #
+          # [name (#to_sym)] name of the version
+          # [options (Hash)] optional options hash
+          # [&block (Proc)] a block to eval on this version of the uploader
+          #
+          # === Examples
+          #
+          #     class MyUploader < CarrierWave::Uploader::Base
+          #
+          #       retina!
+          #
+          #       version :thumb do
+          #         process :resize_to_fill => [30, 30]
+          #         process :retina_quality => 25
+          #       end
+          #
+          #       version :thumb, :retina => false do
+          #         process :resize_to_fill => [30, 30]
+          #       end
+          #
+          #     end
+          #
           def version(name, options={}, &block)
             super
 
-            retina_version(name, { :if => options[:if] }) unless options[:retina] == false
+            optimize_retina!(name, { :if => options[:if] }) unless options[:retina] == false
           end
 
-          # Define a retina version
-          # This method will simply copy all settings and add a larger (retina) version
-          def retina_version(name, options={})
+          ##
+          # Optimize version for retina displays
+          #
+          # === Parameters
+          #
+          # [name (Sym)] name of the version
+          #
+          def optimize_retina!(name, options={})
             config = versions[name]
             options[:retina] = false
 
@@ -43,65 +75,39 @@ module RetinaRails
 
             ## Define a retina version if processor is present
             if dimensions_processor
+              dimensions = dimensions_processor[1].dup
 
-              processor_options = dimensions_processor[1].dup
+              width  = dimensions[0] * 2
+              height = dimensions[1] * 2
 
-              width  = processor_options[0] * 2
-              height = processor_options[1] * 2
+              2.times { dimensions.delete_at(0) }
 
-              2.times { processor_options.delete_at(0) }
+              dimensions.insert(0, height)
+              dimensions.insert(0, width)
 
-              processor_options.insert(0, height)
-              processor_options.insert(0, width)
-
-              version "#{name}_retina", options do
-                process dimensions_processor[0] => processor_options
+              ## Override version with double height and width
+              version name, options do
+                process dimensions_processor[0] => dimensions
 
                 quality_processor = nil
 
                 ## Set other processors
                 processors.each do |processor|
-                  process processor[0] => processor[1]
-
                   quality_processor = true if processor[0] == :retina_quality
                 end
 
                 ## Set default quality if retina_quality is not defined
-                process :retina_quality => 40 if quality_processor.nil?
-              end
-            end
-          end
+                process :retina_quality => 60 if quality_processor.nil?
 
-        end
-
-        ## Set the correct filename for storage according to the convention (append @2x to filename)
-        def full_filename(for_file)
-          super.tap do |file_name|
-            if version_name.to_s.include?('retina')
-              has_extension = file_name.scan(/(jpg|jpeg|png|gif|bmp)/).any?
-
-              regex = has_extension ? /(.*)\./ : /.*/
-              file_name.sub!(regex, '\1@2x.').gsub!('retina_', '')
-            end
-          end
-        end
-
-        ## Set retina image quality
-        def retina_quality(percentage)
-          if version_name.to_s.include?('retina')
-            manipulate! do |img|
-              if defined?(Magick)
-                img.write(current_path) { self.quality = percentage } unless img.quality == percentage
-              elsif defined?(MiniMagick)
-                img.quality(percentage.to_s)
+                ## Store dimensions
+                process :store_retina_dimensions
               end
-              img = yield(img) if block_given?
-              img
             end
           end
-        end
 
-      end
-    end
-  end
-end
+        end # ClassMethods
+
+      end # Uploader
+    end # CarrierWave
+  end # Strategies
+end # RetinaRails

data/lib/retina_rails/strategies/paperclip.rb

@@ -9,33 +9,59 @@ module RetinaRails
         module ClassMethods
 
           def retina!
+            serialize :retina_dimensions
+
             include Uploader
           end
 
-        end
+        end # Class methods
 
-      end
+      end # Base
 
       module Uploader
 
         extend ActiveSupport::Concern
 
-        included do
-
-          ## Override paperclip default options
-          Extensions.override_default_options
-
-        end
-
         module ClassMethods
 
+          ##
+          # Define an attachment with its options
+          #
+          # === Parameters
+          #
+          # [name (#to_sym)] name of the version
+          # [options (Hash)] optional options hash
+          #
+          # === Examples
+          #
+          #     class Upload
+          #
+          #       retina!
+          #
+          #       has_attached_file :image,
+          #         :styles => {
+          #           :original => ["800x800", :jpg],
+          #           :big => ["125x125#", :jpg]
+          #         },
+          #         :retina => true # Or
+          #         :retina => { :quality => 25 } # Optional
+          #
+          #     end
+          #
           def has_attached_file(name, options={})
             super
 
-            has_attached_retina_file name if options[:retina]
+            optimize_retina! name unless options[:retina] == false
           end
 
-          def has_attached_retina_file(name)
+          ##
+          # Optimize attachment for retina displays
+          #
+          # === Parameters
+          #
+          # [name (Sym)] name of the attachment
+          #
+          def optimize_retina!(name)
             attachment = attachment_definitions[name]
 
             ## Check for style definitions
@@ -44,7 +70,7 @@ module RetinaRails
             retina_options = if attachment[:retina].is_a?(Hash)
               attachment[:retina]
             else
-              { :quality => 40 }
+              { :quality => 60 }
             end
 
             ## Get retina quality
@@ -67,64 +93,36 @@ module RetinaRails
                 processor = dimensions.scan(/#|</).first
 
                 new_dimensions = "#{width}x#{height}#{processor}"
-                retina_styles["#{key}_retina".to_sym] = value.kind_of?(Array) ? [new_dimensions, value[1]] : new_dimensions
+                retina_styles[key.to_sym] = value.kind_of?(Array) ? [new_dimensions, value[1]] : new_dimensions
 
                 ## Set quality convert option
                 convert_option = convert_options[key] if convert_options
                 convert_option = convert_option ? "#{convert_option} -quality #{retina_quality}" : "-quality #{retina_quality}"
-                retina_convert_options["#{key}_retina".to_sym] = convert_option
+                retina_convert_options[key.to_sym] = convert_option
 
               end
 
-              ## Append new retina optimzed styles
+              ## Override styles with new retina dimensions
               attachment[:styles].merge!(retina_styles)
 
               ## Set quality convert options
               attachment[:convert_options] = {} if attachment[:convert_options].nil?
               attachment[:convert_options].merge!(retina_convert_options)
 
-              ## Make path work with retina optimization
-              original_path = attachment[:path]
-              attachment[:path] = Extensions.optimize_path(original_path) if original_path
-
-              ## Make url work with retina optimization
-              original_url = attachment[:url]
-              attachment[:url] = Extensions.optimize_path(original_url) if original_url
-
-            end
-          end
-
-        end
-
-        module Extensions
-
-          ## Insert :retina interpolation in url or path
-          def self.optimize_path(path)
-            path.scan(':retina').empty? ? path.gsub(':filename', ':basename.:extension').split('.').insert(-2, ':retina.').join : path
-          end
-
-          def self.override_default_options
-
-            ## Remove _retina from style so it doesn't end up in filename
-            ::Paperclip.interpolates :style do |attachment, style|
-              style.to_s.end_with?('_retina') ? style.to_s[0..-8] : style
-            end
+              ## Set save dimensions processor
+              if attachment[:processors]
+                attachment[:processors] << :save_dimensions
+                attachment[:processors] << :thumbnail
+              else
+                attachment[:processors] = [:thumbnail, :save_dimensions]
+              end
 
-            ## Replace :retina with @2x if style ends with _retina
-            ::Paperclip.interpolates :retina do |attachment, style|
-              style.to_s.end_with?('_retina') ? '@2x' : ''
             end
-
-            ## Make default url compatible with retina optimzer
-            url = ::Paperclip::Attachment.default_options[:url]
-            ::Paperclip::Attachment.default_options[:url] = optimize_path(url)
-
           end
 
-        end
-
-      end
+        end # ClassMethods
+      end # Uploader
 
-    end
-  end
-end
+    end # Paperclip
+  end # Strategies
+end # RetinaRails

data/lib/retina_rails/version.rb

@@ -1,3 +1,3 @@
 module RetinaRails
-  VERSION = "1.0.4"
+  VERSION = "2.0.0"
 end

data/retina_rails.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |gem|
   gem.authors       = ['Johan van Zonneveld', 'Arjen Oosterkamp']
   gem.email         = ['johan@vzonneveld.nl', 'mail@arjen.me']
   gem.homepage      = 'https://github.com/jhnvz/retina_rails.git'
-  gem.summary       = %q{Makes your life easier optimizing for retina displays}
-  gem.description   = %q{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}
+  gem.summary       = %q{Makes your life easier optimizing your application for retina displays}
+  gem.description   = %q{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.}
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
@@ -23,11 +23,18 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec', '>= 2.3'
   gem.add_development_dependency 'rspec-rails', '~> 2.0'
   gem.add_development_dependency 'carrierwave'
-  gem.add_development_dependency 'paperclip', '< 4.0'
+  gem.add_development_dependency 'paperclip'
   gem.add_development_dependency 'rmagick'
   gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'coveralls'
 
+  if RUBY_VERSION > '1.9.2'
+    gem.add_dependency 'rails', '>= 3.2.0'
+  else
+    gem.add_dependency 'rails', '>= 3.2.0', '< 4.0.0'
+  end
 
-  gem.add_dependency 'rails', '>= 3.2.0', '< 4.0.0'
+  if File.exists?('UPGRADING')
+    gem.post_install_message = File.read("UPGRADING")
+  end
 end