image_resizer 0.2.3 → 0.3.0

data/README.md

@@ -51,6 +51,9 @@ Example:
     tempfile = processor.generate_icon(temp_object)
     File.open(path_to_output_file, 'wb') { |f| f.write(File.read(tempfile)) }
 
+Any of the resizing and cropping methods accept an optional :format option that determines the output format of the file (:png, :jpg, etc.). If omitted, the original file format is maintained.
+
+
 Credits
 =======
 

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.3.0

data/image_resizer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "image_resizer"
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Nelson"]
-  s.date = "2012-04-29"
+  s.date = "2012-04-30"
   s.description = "Image resizing gem (requires ImageMagick)"
   s.email = "daniel@populr.me"
   s.extra_rdoc_files = [

data/lib/image_resizer/processor.rb

@@ -30,9 +30,9 @@ module ImageResizer
       if height == 0 && width == 0
         temp_object.file
       elsif height == 0
-        _resize(temp_object, "#{width}x")
+        _resize(temp_object, "#{width}x", options[:format])
       elsif width == 0
-        _resize(temp_object, "x#{height}")
+        _resize(temp_object, "x#{height}", options[:format])
       else
         if options[:crop_from_top_if_portrait]
           analyzer = ImageResizer::Analyzer.new
@@ -41,12 +41,12 @@ module ImageResizer
           center_of_gravity = 'c'
         end
 
-        resize_and_crop(temp_object, :width => width.to_i, :height => height.to_i, :gravity => center_of_gravity)
+        resize_and_crop(temp_object, :width => width.to_i, :height => height.to_i, :gravity => center_of_gravity, :format => options[:format])
       end
     end
 
-    def _resize(temp_object, geometry)
-      convert(temp_object, "-resize #{geometry}")
+    def _resize(temp_object, geometry, format=nil)
+      convert(temp_object, "-resize #{geometry}", format)
     end
 
     def auto_orient(temp_object)
@@ -66,7 +66,7 @@ module ImageResizer
       resize = opts[:resize] ? "-resize #{opts[:resize]} " : ''
       gravity = gravity ? "-gravity #{gravity} " : ''
 
-      convert(temp_object, "#{resize}#{gravity}-crop #{width}x#{height}#{x}#{y} #{repage}")
+      convert(temp_object, "#{resize}#{gravity}-crop #{width}x#{height}#{x}#{y} #{repage}", opts[:format])
     end
 
     def resize_and_crop_around_point(temp_object, options)
@@ -119,7 +119,8 @@ module ImageResizer
                               :upper_left => [upper_left_x_percent, upper_left_y_percent],
                               :lower_right => [lower_right_x_percent, lower_right_y_percent],
                               :width => desired_width,
-                              :height => desired_height
+                              :height => desired_height,
+                              :format => options[:format]
                               )
     end
 
@@ -155,7 +156,7 @@ module ImageResizer
       end
 
 
-      convert(temp_object, "-crop #{frame_width}x#{frame_height}+#{upper_left_x}+#{upper_left_y} -resize #{desired_width}x#{desired_height} +repage")
+      convert(temp_object, "-crop #{frame_width}x#{frame_height}+#{upper_left_x}+#{upper_left_y} -resize #{desired_width}x#{desired_height} +repage", options[:format])
     end
 
     def flip(temp_object)
@@ -173,7 +174,11 @@ module ImageResizer
 
     def resize_and_crop(temp_object, opts={})
       if !opts[:width] && !opts[:height]
-        return temp_object
+        if opts[:format]
+          return convert(temp_object, '', opts[:format])
+        else
+          return temp_object
+        end
       elsif !opts[:width] || !opts[:height]
         attrs          = identify(temp_object)
         opts[:width]   ||= attrs[:width]
@@ -213,12 +218,12 @@ module ImageResizer
     end
 
     def convert(temp_object, args='', format=nil)
-      format ? [super, {:format => format.to_sym}] : super
+      super
     end
 
     def generate_icon(temp_object, options={})
       max_resolution = [options[:max_resolution] || 256, 256].min
-      largest_png = convert(temp_object, "-resize #{max_resolution}x#{max_resolution}! -transparent white", :png).first
+      largest_png = convert(temp_object, "-resize #{max_resolution}x#{max_resolution}! -transparent white", :png)
       formats = []
       current = 16
       while current < max_resolution
@@ -226,7 +231,7 @@ module ImageResizer
         current *= 2
       end
       formats << largest_png
-      convert(formats, '', :ico).first
+      convert(formats, '', :ico)
     end
   end
 end

data/spec/image_resizer/processor_spec.rb

@@ -75,6 +75,11 @@ describe ImageResizer::Processor do
 
   describe "crop" do # Difficult to test here other than dimensions
 
+    it "should accept a format option" do
+      @processor.should_receive(:convert).with(@image, anything(), :png)
+      @processor.crop(@image, :width => '100', :height => '100', :format => :png)
+    end
+
     it "should not crop if no args given" do
       image = @processor.crop(@image)
       image.should have_width(280)
@@ -132,17 +137,23 @@ describe ImageResizer::Processor do
   end
 
 
-  describe "#resize(temp_object, width, height)" do
+  describe "#resize(temp_object, options)" do
+
     context "when both the width and the height are non-zero" do
       it "should crop and scale to the specified dimensions" do
-        @processor.should_receive(:resize_and_crop).with(@image, :width => 77, :height => 33, :gravity => 'c')
+        @processor.should_receive(:resize_and_crop).with(@image, hash_including(:width => 77, :height => 33, :gravity => 'c'))
         @processor.resize(@image, :width => 77, :height => 33)
       end
 
+      it "should accept a format option" do
+        @processor.should_receive(:resize_and_crop).with(@image, hash_including(:format => :png))
+        @processor.resize(@image, :width => 77, :height => 33, :format => :png)
+      end
+
       context "with the crop_from_top_if_portrait option" do
         context "with a portrait oriented image" do
           it "should resize and crop with a gravity of 'n'" do
-            @processor.should_receive(:resize_and_crop).with(@image, :width => 77, :height => 33, :gravity => 'n')
+            @processor.should_receive(:resize_and_crop).with(@image, hash_including(:width => 77, :height => 33, :gravity => 'n'))
             @processor.resize(@image, :width => 77, :height => 33, :crop_from_top_if_portrait => true)
           end
         end
@@ -150,7 +161,7 @@ describe ImageResizer::Processor do
         context "with a landscape oriented image" do
           it "should resize and crop with a gravity of 'c'" do
             @image = ImageResizer::TempObject.new(SAMPLES_DIR.join('landscape.png')) # 355x280
-            @processor.should_receive(:resize_and_crop).with(@image, :width => 77, :height => 33, :gravity => 'c')
+            @processor.should_receive(:resize_and_crop).with(@image, hash_including(:width => 77, :height => 33, :gravity => 'c'))
             @processor.resize(@image, :width => 77, :height => 33, :crop_from_top_if_portrait => true)
           end
         end
@@ -159,29 +170,44 @@ describe ImageResizer::Processor do
 
     context "when the height is 0, nil, or not present" do
       it "should restrict only in the horizontal dimension" do
-        @processor.should_receive(:_resize).with(@image, '77x').exactly(3).times
-        @processor.resize(@image, :width => 77, :height => 0)
+        @processor.should_receive(:_resize).with(@image, '77x', nil).exactly(3).times
+        @processor.resize(@image, :width => 77, :height => 0  )
         @processor.resize(@image, :width => 77, :height => nil)
         @processor.resize(@image, :width => 77)
       end
+
+      it "should accept a format option" do
+        @processor.should_receive(:_resize).with(@image, '77x', :png)
+        @processor.resize(@image, :width => 77, :height => 0, :format => :png)
+      end
     end
 
     context "when the width is 0, nil, or not present" do
       it "should restrict only in the vertical dimension" do
-        @processor.should_receive(:_resize).with(@image, 'x33').exactly(3).times
+        @processor.should_receive(:_resize).with(@image, 'x33', nil).exactly(3).times
         @processor.resize(@image, :width => 0, :height => 33)
         @processor.resize(@image, :width => nil, :height => 33)
         @processor.resize(@image, :height => 33)
       end
+
+      it "should accept a format option" do
+        @processor.should_receive(:_resize).with(@image, 'x33', :png)
+        @processor.resize(@image, :width => 0, :height => 33, :format => :png)
+      end
     end
 
     context "when both height and width are 0, nil, or not present" do
       it "should return the original image file" do
-        @image.should_receive(:file).exactly(3).times
+        @image.should_receive(:file).exactly(3).times.and_return('the_file')
         @processor.should_not_receive(:_resize)
-        @processor.resize(@image, :width => 0, :height => 0)
-        @processor.resize(@image, :width => nil, :height => nil)
-        @processor.resize(@image)
+        @processor.resize(@image, :width => 0, :height => 0).should == 'the_file'
+        @processor.resize(@image, :width => nil, :height => nil).should == 'the_file'
+        @processor.resize(@image).should == 'the_file'
+      end
+
+      it "should call convert with the target format" do
+        @processor.should_receive(:convert).with(@image, anything(), :png)
+        @processor.resize(@image, :width => 0, :height => 33, :format => :png)
       end
     end
   end
@@ -189,15 +215,15 @@ describe ImageResizer::Processor do
 
 
 
-  describe "#resize_and_crop_around_point(:point => [x%, y%], :width => w, :height => h" do
+  describe "#resize_and_crop_around_point(:point => [x%, y%], :width => w, :height => h)" do
     context "when the source image is portrait, but the requested ratio is landscape" do
       it "should call crop_to_frame_and_resize with a frame that is vertically centered on the focus point" do
         # original is 280px x 355px
         @processor.should_receive(:crop_to_frame_and_resize ).with(@image,
-                                                                  :width => 100,
-                                                                  :height => 60,
-                                                                  :upper_left => [0.0, 0.5 - 280 * 0.6 / 355 / 2.0],
-                                                                  :lower_right => [1.0, 0.5 + 280 * 0.6 / 355 / 2.0])
+                                                                  hash_including(:width => 100,
+                                                                                 :height => 60,
+                                                                                 :upper_left => [0.0, 0.5 - 280 * 0.6 / 355 / 2.0],
+                                                                                 :lower_right => [1.0, 0.5 + 280 * 0.6 / 355 / 2.0]))
         @processor.resize_and_crop_around_point(@image,
                                             :point => [0.5, 0.5],
                                             :width => 100,
@@ -205,14 +231,29 @@ describe ImageResizer::Processor do
                                           )
       end
 
+    it "should accept a format option" do
+      @processor.should_receive(:crop_to_frame_and_resize ).with(@image,
+                                                                :width => 100,
+                                                                :height => 60,
+                                                                :upper_left => [0.0, 0.5 - 280 * 0.6 / 355 / 2.0],
+                                                                :lower_right => [1.0, 0.5 + 280 * 0.6 / 355 / 2.0],
+                                                                :format => :png)
+      @processor.resize_and_crop_around_point(@image,
+                                          :point => [0.5, 0.5],
+                                          :width => 100,
+                                          :height => 60,
+                                          :format => :png
+                                        )
+    end
+
       context "when the focus point is too close to the top to be the vertical center" do
         it "should call crop_to_frame_and_resize with a frame that is pinned at the top of the image" do
           # original is 280px x 355px
           @processor.should_receive(:crop_to_frame_and_resize ).with(@image,
-                                                                    :width => 100,
-                                                                    :height => 60,
-                                                                    :upper_left => [0.0, 0.0],
-                                                                    :lower_right => [1.0, 280 * 0.6 / 355])
+                                                                    hash_including(:width => 100,
+                                                                                   :height => 60,
+                                                                                   :upper_left => [0.0, 0.0],
+                                                                                   :lower_right => [1.0, 280 * 0.6 / 355]))
           @processor.resize_and_crop_around_point(@image,
                                               :point => [0.5, 0.1],
                                               :width => 100,
@@ -225,10 +266,10 @@ describe ImageResizer::Processor do
         it "should call crop_to_frame_and_resize with a frame that is pinned at the bottom of the image" do
           # original is 280px x 355px
           @processor.should_receive(:crop_to_frame_and_resize ).with(@image,
-                                                                    :width => 100,
-                                                                    :height => 60,
-                                                                    :upper_left => [0.0, 1 - 280 * 0.6 / 355],
-                                                                    :lower_right => [1.0, 1.0])
+                                                                    hash_including(:width => 100,
+                                                                                   :height => 60,
+                                                                                   :upper_left => [0.0, 1 - 280 * 0.6 / 355],
+                                                                                   :lower_right => [1.0, 1.0]))
           @processor.resize_and_crop_around_point(@image,
                                               :point => [0.5, 0.9],
                                               :width => 100,
@@ -246,10 +287,10 @@ describe ImageResizer::Processor do
       it "should call crop_to_frame_and_resize with a frame that is vertically centered on the focus point" do
         # original is 355px x 280px
         @processor.should_receive(:crop_to_frame_and_resize ).with(@image,
-                                                                  :width => 60,
-                                                                  :height => 100,
-                                                                  :upper_left => [0.5 - 280 * 0.6 / 355 / 2.0, 0.0],
-                                                                  :lower_right => [0.5 + 280 * 0.6 / 355 / 2.0, 1.0])
+                                                                  hash_including(:width => 60,
+                                                                                 :height => 100,
+                                                                                 :upper_left => [0.5 - 280 * 0.6 / 355 / 2.0, 0.0],
+                                                                                 :lower_right => [0.5 + 280 * 0.6 / 355 / 2.0, 1.0]))
         @processor.resize_and_crop_around_point(@image,
                                             :point => [0.5, 0.5],
                                             :width => 60,
@@ -261,10 +302,10 @@ describe ImageResizer::Processor do
         it "should call crop_to_frame_and_resize with a frame that is pinned at the left of the image" do
           # original is 355px x 280px
           @processor.should_receive(:crop_to_frame_and_resize ).with(@image,
-                                                                    :width => 60,
-                                                                    :height => 100,
-                                                                    :upper_left => [0.0, 0.0],
-                                                                    :lower_right => [280 * 0.6 / 355, 1.0])
+                                                                    hash_including(:width => 60,
+                                                                                   :height => 100,
+                                                                                   :upper_left => [0.0, 0.0],
+                                                                                   :lower_right => [280 * 0.6 / 355, 1.0]))
           @processor.resize_and_crop_around_point(@image,
                                               :point => [0.1, 0.5],
                                               :width => 60,
@@ -277,10 +318,10 @@ describe ImageResizer::Processor do
         it "should call crop_to_frame_and_resize with a frame that is pinned at the right of the image" do
           # original is 355px x 280px
           @processor.should_receive(:crop_to_frame_and_resize ).with(@image,
-                                                                    :width => 60,
-                                                                    :height => 100,
-                                                                    :upper_left => [1.0 - 280 * 0.6 / 355, 0.0],
-                                                                    :lower_right => [1.0, 1.0])
+                                                                    hash_including(:width => 60,
+                                                                                   :height => 100,
+                                                                                   :upper_left => [1.0 - 280 * 0.6 / 355, 0.0],
+                                                                                   :lower_right => [1.0, 1.0]))
           @processor.resize_and_crop_around_point(@image,
                                               :point => [0.9, 0.5],
                                               :width => 60,
@@ -318,7 +359,7 @@ describe ImageResizer::Processor do
   describe "#crop_to_frame_and_resize(:upper_left => [x%, y%], :lower_right => [x%, y%], :width => w, :height => h" do
     it "should call #crop with the :x & :y and :width & :height expressed in pixels and :width and :height determined by the frame bounds (not the width and height we pass in), and :resize expressed as widthxheight" do
       # original is 280px x 355px
-      @processor.should_receive(:convert).with(@image, "-crop 140x178+56+107 -resize 70x89 +repage")
+      @processor.should_receive(:convert).with(@image, "-crop 140x178+56+107 -resize 70x89 +repage", nil)
       @processor.crop_to_frame_and_resize(@image,
                                           :upper_left => [0.20, 0.30],
                                           :lower_right => [0.70, 0.80],
@@ -327,10 +368,21 @@ describe ImageResizer::Processor do
                                         )
     end
 
+    it "should accept a format parameter" do
+      @processor.should_receive(:convert).with(@image, "-crop 140x178+56+107 -resize 70x89 +repage", :png)
+      @processor.crop_to_frame_and_resize(@image,
+                                          :upper_left => [0.20, 0.30],
+                                          :lower_right => [0.70, 0.80],
+                                          :width => 70,
+                                          :height => 89,
+                                          :format => :png
+                                        )
+    end
+
     context "when width is 0, nil, or not present as an option" do
       it "should use the ratio defined by the upper_left and lower_right points to determine the width from the height" do
         # original is 280px x 355px
-        @processor.should_receive(:convert).with(@image, "-crop 140x178+56+107 -resize 70x89 +repage").exactly(3).times
+        @processor.should_receive(:convert).with(@image, "-crop 140x178+56+107 -resize 70x89 +repage", nil).exactly(3).times
         @processor.crop_to_frame_and_resize(@image,
                                             :upper_left => [0.20, 0.30],
                                             :lower_right => [0.70, 0.80],
@@ -357,7 +409,7 @@ describe ImageResizer::Processor do
     context "when height is 0, nil, or not present as an option" do
       it "should use the ratio defined by the upper_left and lower_right points to determine the height from the width" do
         # original is 280px x 355px
-        @processor.should_receive(:convert).with(@image, "-crop 140x178+56+107 -resize 70x89 +repage").exactly(3).times
+        @processor.should_receive(:convert).with(@image, "-crop 140x178+56+107 -resize 70x89 +repage", nil).exactly(3).times
         @processor.crop_to_frame_and_resize(@image,
                                             :upper_left => [0.20, 0.30],
                                             :lower_right => [0.70, 0.80],
@@ -443,11 +495,18 @@ describe ImageResizer::Processor do
       image.should have_height(355)
     end
 
-    it "should do nothing if called without width and height" do
-      image = @processor.resize_and_crop(@image)
-      image.should have_width(280)
-      image.should have_height(355)
-      image.should eq @image
+    context "without a width and height option" do
+      it "should do nothing if called without width and height" do
+        image = @processor.resize_and_crop(@image)
+        image.should have_width(280)
+        image.should have_height(355)
+        image.should eq @image
+      end
+
+      it "should convert the image" do
+        @processor.should_receive(:convert).with(@image, '', :png)
+        @processor.resize_and_crop(@image, :format => :png)
+      end
     end
 
     it "should crop to the correct dimensions" do
@@ -456,6 +515,11 @@ describe ImageResizer::Processor do
       image.should have_height(100)
     end
 
+    it "should accept a format option" do
+      @processor.should_receive(:crop).with(@image, hash_including(:format => :png))
+      image = @processor.resize_and_crop(@image, :width => '100', :height => '100', :format => :png)
+    end
+
     it "should actually resize before cropping" do
       image1 = @processor.resize_and_crop(@image, :width => '100', :height => '100')
       image2 = @processor.crop(@image, :width => '100', :height => '100', :gravity => 'c')
@@ -569,11 +633,10 @@ describe ImageResizer::Processor do
     end
 
     it "should allow for general convert commands with added format" do
-      image, extra = @processor.convert(@image, '-scale 56x71', :gif)
+      image = @processor.convert(@image, '-scale 56x71', :gif)
       image.should have_width(56)
       image.should have_height(71)
       image.should have_format('gif')
-      extra[:format].should == :gif
     end
 
     it "should work for commands with parenthesis" do
@@ -604,7 +667,7 @@ describe ImageResizer::Processor do
   describe "#generate_icon" do
     it "it should create a multi-sized ico file from the source file" do
       two_fifty_six_png = double('256')
-      @processor.should_receive(:convert).with(@image, '-resize 256x256! -transparent white', :png).and_return([two_fifty_six_png, :format => :png])
+      @processor.should_receive(:convert).with(@image, '-resize 256x256! -transparent white', :png).and_return(two_fifty_six_png)
       sixteen_png = double('16')
       @processor.should_receive(:convert).with(two_fifty_six_png, '-resize 16x16! -transparent white').and_return(sixteen_png)
       thirty_two_png = double('32')
@@ -616,19 +679,19 @@ describe ImageResizer::Processor do
 
       ico = double('ico')
       @processor.should_receive(:convert).with([sixteen_png, thirty_two_png, sixty_four_png, one_twenty_eight_png, two_fifty_six_png],
-                                                '', :ico).and_return([ico, :format => :ico])
+                                                '', :ico).and_return(ico)
       @processor.generate_icon(@image)
     end
 
     it "it should accept a :max_resolution option to limit the number of formats" do
       thirty_two_png = double('32')
-      @processor.should_receive(:convert).with(@image, '-resize 32x32! -transparent white', :png).and_return([thirty_two_png, :format => :png])
+      @processor.should_receive(:convert).with(@image, '-resize 32x32! -transparent white', :png).and_return(thirty_two_png)
       sixteen_png = double('16')
       @processor.should_receive(:convert).with(thirty_two_png, '-resize 16x16! -transparent white').and_return(sixteen_png)
 
       ico = double('ico')
       @processor.should_receive(:convert).with([sixteen_png, thirty_two_png],
-                                                '', :ico).and_return([ico, :format => :ico])
+                                                '', :ico).and_return(ico)
       @processor.generate_icon(@image, :max_resolution => 32)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: image_resizer
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-29 00:00:00.000000000 Z
+date: 2012-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153615980 !ruby/object:Gem::Requirement
+  requirement: &2157276080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153615980
+  version_requirements: *2157276080
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2153614640 !ruby/object:Gem::Requirement
+  requirement: &2157274360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153614640
+  version_requirements: *2157274360
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2153640760 !ruby/object:Gem::Requirement
+  requirement: &2157300300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153640760
+  version_requirements: *2157300300
 - !ruby/object:Gem::Dependency
   name: pry-nav
-  requirement: &2153640120 !ruby/object:Gem::Requirement
+  requirement: &2157299680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153640120
+  version_requirements: *2157299680
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
-  requirement: &2153639380 !ruby/object:Gem::Requirement
+  requirement: &2157298920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153639380
+  version_requirements: *2157298920
 description: Image resizing gem (requires ImageMagick)
 email: daniel@populr.me
 executables: []
@@ -131,7 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2737060154479348159
+      hash: -3748383720531710291
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: