insano_image_resizer 0.5.7 → 0.7.1

data/README.md

@@ -7,7 +7,7 @@ in the frame when possible. The resizer is built on top of the VIPS command-line
 and is designed to be as fast as possible. In our tests, VIPS is faster than ImageMagick for any
 image larger than ~300x300px, and is exponentially faster for very large images.
 
-![A brief overview of the Insano processing function](insano_image_resizer/raw/master/samples/explanation.png)
+![A brief overview of the Insano processing function](samples/explanation.png)
 
 Output formats: The Insano image resizer will keep PNGs as PNG, but any other format is converted to JPEG
 
@@ -36,7 +36,7 @@ Example:
 
 Input parameters:
 
-The `process` method is the main function of the Insano gem. Using different parameters,
+The #process method is the main function of the Insano gem. Using different parameters,
 you can produce a wide range of resized images. Each of the parameters is explained below.
 
 The first argument is an input file path. Because the Insano image resizer uses the VIPS
@@ -50,6 +50,13 @@ the current width and height of the image. Note that the image resizer will
 never distort an image: the output image will always fill the viewport you provide,
 scaling up only if absolutely necessary.
 
+Note that the output image may show more of the source image than you specify using the
+viewport. The region is only meant to indicate what region you'd like to ensure makes
+it into the output. For example, if you have a 200 x 200px image and request an output image of
+100 x 100px, showing the 50px region around 150px x 150px, the output will contain more than
+just that region, since filling a 100px square with a 50px region would require enlarging the
+source image.
+
 The third parameter is the point of interest that you'd like to keep centered if possible.
 Imagine that an 4:3 image contains a person's face on the left side. When you create a
 square thumbnail of the image, the persons face is half chopped off, because the processor
@@ -61,12 +68,18 @@ should be cropped off. However, specifying the optional :region parameter with a
 less than 1, you can make the image resizer zoom in around the POI, cropping the image
 so that an area of size (region * image size) around the POI is visible.
 
-Note that the output image may show more of the source image than you specify using the
-interest region. The region is only meant to indicate what region you'd like to ensure makes
-it into the output. For example, if you have a 200 x 200px image and request an output image of
-100 x 100px, showing the 50px region around 150px x 150px, the output will contain more than
-just that region, since filling a 100px square with a 50px region would require enlarging the
-source image.
+The last optional parameter determines quality. The #process method accepts either a hash or an
+integer. If an integer is provided, then that number will be used when generating all JPEG files.
+A hash of the following form may be used instead:
+
+    { :min_area => { :area => 4000, :quality => 90 },
+                     :max_area => { :area => 1000000, :quality => 60 }}
+
+When a hash is used, images up to the minimum area use the min_area quality. Images at or above the
+maximum area use the max_area quality. Images in between get a quality based on a sliding scale
+between the min and max. This is the default behavior.
+
+Insano accounts for EXIF rotation flags, producing properly oriented images across all devices.
 
 Credits
 =======

data/lib/insano_image_resizer/processor.rb

@@ -9,28 +9,54 @@ module InsanoImageResizer
     include Loggable
     include Cocaine
 
+    DEFAULT_QUALITY_LIMITS = { :min_area => { :area => 4000, :quality => 90 },
+                               :max_area => { :area => 1000000, :quality => 60 }}
+
     def initialize(options = {})
       @vips_path = options[:vips_path] || 'vips'
       @identify_path = options[:identify_path] || 'identify'
     end
 
-    def process(input_path, viewport_size = {}, interest_point = {}, quality = 60)
+    def process(input_path, viewport_size = {}, interest_point = {}, quality_limits=DEFAULT_QUALITY_LIMITS)
       width, height, original_format, target_extension = fetch_image_properties(input_path)
 
+      exif_result = handle_exif_rotation(input_path, original_format)
+      width, height = [height, width] if exif_result == :swap_dimensions
+
       output_tmp = Tempfile.new(['img', ".#{target_extension}"])
 
       transform = calculate_transform(input_path, width, height, viewport_size, interest_point)
+      quality = target_jpg_quality(transform[:w], transform[:h], quality_limits) if target_extension == 'jpg'
       run_transform(input_path, output_tmp.path, transform, original_format, target_extension, quality)
 
       output_tmp.path
     end
 
+    # limits is of the form:
+    # { :min_area => { :area => 4000, :quality => 90 },
+    #   :max_area => { :area => 1000000, :quality => 60 }}
+    def target_jpg_quality(width, height, limits)
+      return limits.to_i unless limits.is_a?(Hash)
+      min_area = limits[:min_area][:area]
+      min_area_quality = limits[:min_area][:quality]
+      max_area = limits[:max_area][:area]
+      max_area_quality = limits[:max_area][:quality]
+      normalized_target_area = [width * height - min_area, 0].max
+      normalized_max_area =  max_area - min_area
+      target_area_fraction = [normalized_target_area.to_f / normalized_max_area, 1].min
+      quality_span = min_area_quality - max_area_quality
+      quality_fraction = quality_span * target_area_fraction
+      min_area_quality - quality_fraction
+    end
+
     private
 
     def fetch_image_properties(input_path)
       line = Cocaine::CommandLine.new(@identify_path, '-format "%w %h %m" :input')
-      parts = line.run(:input => input_path).split(' ')
-      [parts[0].to_i, parts[1].to_i, parts[2], parts[2] == 'PNG' ? 'png' : 'jpg']
+      width, height, original_format = line.run(:input => input_path).split(' ')
+
+      target_extension = (original_format == 'PNG' ? 'png' : 'jpg')
+      [width.to_i, height.to_i, original_format, target_extension]
     end
 
     def calculate_transform(input_path, width, height, viewport_size, interest_point)
@@ -157,8 +183,7 @@ module InsanoImageResizer
       # but don't seem to be used.
       # The last four params define a rect of the source image that is transformed.
 
-      quality_extension = ''
-      quality_extension = ":#{quality}" if output_extension == 'jpg'
+      quality_extension = quality ? ":#{quality}" : ''
 
       if (transform[:scale] < 0.5)
         # If we're shrinking the image by more than a factor of two, let's do a two-pass operation. The reason we do this
@@ -169,21 +194,18 @@ module InsanoImageResizer
 
         # To ensure that we actually do both passes, don't let the im_shrink go all the way. This will result in terrible
         # looking shrunken images, since im_shrink basically just cuts pixels out.
-        if (shrink_factor == 1.0 / transform[:scale])
-          shrink_factor -= 1
-        end
+        shrink_factor -= 1 if shrink_factor == 1.0 / transform[:scale]
 
         transform[:scale] *= shrink_factor
 
-        if (input_path[-4..-3] != ".")
-          FileUtils.mv(input_path, input_path+"."+output_extension)
-          input_path = input_path + "." + output_extension
-        end
-        intermediate_path = input_path[0..-4]+"_shrunk." + output_extension
+
+        intermediate_path = "#{input_path}_shrunk.#{output_extension}"
+        intermediate_quality_extension = quality ? ":90" : ''
+
 
         line = Cocaine::CommandLine.new(@vips_path, "im_shrink :input :intermediate_path :shrink_factor :shrink_factor")
         line.run(:input => input_path,
-                 :intermediate_path => "#{intermediate_path}#{quality_extension}",
+                 :intermediate_path => "#{intermediate_path}#{intermediate_quality_extension}",
                  :shrink_factor => shrink_factor.to_s)
 
 
@@ -209,40 +231,48 @@ module InsanoImageResizer
                  :h => transform[:h].to_s)
       end
 
-      # find the EXIF values
-      orientation = 0
-      orientation = EXIFR::JPEG.new(input_path).orientation.to_i if original_format == 'JPEG'
-
-      if orientation == 3 || orientation == 6 || orientation == 8
-        FileUtils.mv(output_path, intermediate_path)
-        o_transform = []
-        if orientation == 3
-          command = 'im_rot180'
-        elsif orientation == 6
-          command = 'im_rot90'
-        elsif orientation == 8
-          command = 'im_rot270'
-        else
-          command = nil
-        end
-
-        if command
-          line = Cocaine::CommandLine.new(@vips_path, ":command :intermediate_path :output")
-          line.run(:output => "#{output_path}#{quality_extension}",
-                   :intermediate_path => intermediate_path,
-                   :command => command)
-        end
+      FileUtils.rm(input_path)
 
-        FileUtils.rm(intermediate_path)
-        line = Cocaine::CommandLine.new(mogrify, "-strip :output")
-        line.run(:output => output_path,
-                 :intermediate_path => intermediate_path)
+
+      output_path
+    end
+
+    def handle_exif_rotation(input_path, original_format)
+      return unless original_format == 'JPEG'
+
+      # find the EXIF values
+      orientation = EXIFR::JPEG.new(input_path).orientation.to_i
+
+      if orientation == 3
+        command = 'im_rot180'
+      elsif orientation == 6
+        command = 'im_rot90'
+        return_value = :swap_dimensions
+      elsif orientation == 8
+        command = 'im_rot270'
+        return_value = :swap_dimensions
+      else
+        return
       end
 
-      FileUtils.rm(input_path)
+      intermediate_path = "#{input_path}_rotated.jpg"
+      intermediate_quality_extension = ':90'
 
-      output_path
+      line = Cocaine::CommandLine.new(@vips_path, ":command :input :intermediate_path")
+      line.run(:input => input_path,
+               :intermediate_path => "#{intermediate_path}#{intermediate_quality_extension}",
+               :command => command)
+
+      # mogrify strips the EXIF tags so that browsers that support EXIF don't rotate again after
+      # we have rotated
+      line = Cocaine::CommandLine.new('mogrify', "-strip :intermediate_path")
+      line.run(:intermediate_path => intermediate_path)
+
+      FileUtils.mv(intermediate_path, input_path)
+
+      return_value
     end
+
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: insano_image_resizer
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2013-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocaine
-  requirement: &2161837320 !ruby/object:Gem::Requirement
+  requirement: &2164743100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161837320
+  version_requirements: *2164743100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2161836240 !ruby/object:Gem::Requirement
+  requirement: &2164742380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161836240
+  version_requirements: *2164742380
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2161834680 !ruby/object:Gem::Requirement
+  requirement: &2164741660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161834680
+  version_requirements: *2164741660
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2161833680 !ruby/object:Gem::Requirement
+  requirement: &2164740980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161833680
+  version_requirements: *2164740980
 - !ruby/object:Gem::Dependency
   name: pry-nav
-  requirement: &2161832100 !ruby/object:Gem::Requirement
+  requirement: &2164740340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161832100
+  version_requirements: *2164740340
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
-  requirement: &2161830740 !ruby/object:Gem::Requirement
+  requirement: &2164739640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161830740
+  version_requirements: *2164739640
 - !ruby/object:Gem::Dependency
   name: exifr
-  requirement: &2161845740 !ruby/object:Gem::Requirement
+  requirement: &2164737920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161845740
+  version_requirements: *2164737920
 description: ! "An image resizing gem that generates smaller versions of requested
   \n                    images. Calls through to VIPS on the command line to perform
   processing,\n                    and automatically handles cropping and scaling
@@ -121,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2229782920587942478
+      hash: 1771295257992981064
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: