croptoelie 0.4.0 → 0.4.1

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/croptoelie.gemspec

@@ -1,11 +1,11 @@
-# Generated by jeweler
+# Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{croptoelie}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bèr Kessels"]

data/lib/croptoelie.rb

@@ -1,33 +1,33 @@
 require 'RMagick'
 class CropToelie
   include Magick
-  
+
   attr_accessor :orig
   attr_accessor :steps
-  
-  # Create a new CropToelie object from a ImageList single image object. 
-  #  If you want to provide a file by its path use CropToelie.from_file('/path/to/image.png'). 
+
+  # Create a new CropToelie object from a ImageList single image object.
+  #  If you want to provide a file by its path use CropToelie.from_file('/path/to/image.png').
   def initialize(image)
     @image = image
-    
+
     # Hardcoded (but overridable) defaults.
     @steps  = 10
 
     # Preprocess image.
     @image = @image.quantize
-    
+
     # Prepare some often-used internal variables.
     @rows = @image.rows
     @columns = @image.columns
   end
-  
+
   # Open create a croptoelie from a file on disk.
   def self.from_file(image_path)
     image = ImageList.new(image_path).last
     return CropToelie.new(image)
   end
 
-  # Crops an image to width x height 
+  # Crops an image to width x height
   def smart_crop(width, height)
     sq = square(width, height)
     return @image.crop!(sq[:left], sq[:top], width, height, true)
@@ -35,11 +35,11 @@ class CropToelie
 
   # Squares an image (with smart_square) and then scales that to width, heigh
   def smart_crop_and_scale(width, height)
-    smart_square    
+    smart_square
     return @image.scale!(width, height)
   end
-  
-  # Squares an image by slicing off the least interesting parts. 
+
+  # Squares an image by slicing off the least interesting parts.
   # Usefull for squaring images such as thumbnails. Usefull before scaling.
   def smart_square
     if @rows != @columns #None-square images must be shaved off.
@@ -52,21 +52,21 @@ class CropToelie
       sq = square(crop_width, crop_height)
       @image.crop!(sq[:left], sq[:top], crop_width, crop_height, true)
     end
-    
-    @image    
+
+    @image
   end
-  
+
   # Finds the most interesting square with size width x height.
-  # 
+  #
   # Returns a hash {:left => left, :top => top, :right => right, :bottom => bottom}
   def square(width, height)
     return smart_crop_by_trim(width, height)
   end
-  
+
   private
-    # Determines if the image should be cropped. 
-    # Image should be cropped if original is larger then requested size. 
-    # In all other cases, it should not. 
+    # Determines if the image should be cropped.
+    # Image should be cropped if original is larger then requested size.
+    # In all other cases, it should not.
     def should_crop?
       return (@columns > @width) && (@rows < @height)
     end
@@ -77,38 +77,41 @@ class CropToelie
       width, height = right, bottom
       step_size = step_size(requested_x, requested_y)
 
-      # Slice from left and right edges until the correct width is reached.
-      while (width > requested_x)
-        slice_width = [(width - requested_x), step_size].min
+      # Avoid attempts to slice less then one pixel.
+      if step_size > 0
+        # Slice from left and right edges until the correct width is reached.
+        while (width > requested_x)
+          slice_width = [(width - requested_x), step_size].min
 
-        left_entropy  = entropy_slice(@image, left, 0, slice_width, bottom)
-        right_entropy = entropy_slice(@image, (right - slice_width), 0, slice_width, bottom)
+          left_entropy  = entropy_slice(@image, left, 0, slice_width, bottom)
+          right_entropy = entropy_slice(@image, (right - slice_width), 0, slice_width, bottom)
 
-        #remove the slice with the least entropy
-        if left_entropy < right_entropy
-          left += slice_width
-        else
-          right -= slice_width
+          #remove the slice with the least entropy
+          if left_entropy < right_entropy
+            left += slice_width
+          else
+            right -= slice_width
+          end
+
+          width = (right - left)
         end
-        
-        width = (right - left)
-      end
 
-      # Slice from top and bottom edges until the correct height is reached.
-      while (height > requested_y)
-        slice_height = [(height - step_size), step_size].min
-        
-        top_entropy    = entropy_slice(@image, 0, top, @columns, slice_height)
-        bottom_entropy = entropy_slice(@image, 0, (bottom - slice_height), @columns, slice_height)
-
-        #remove the slice with the least entropy
-        if top_entropy < bottom_entropy
-          top += slice_height
-        else
-          bottom -= slice_height
+        # Slice from top and bottom edges until the correct height is reached.
+        while (height > requested_y)
+          slice_height = [(height - step_size), step_size].min
+
+          top_entropy    = entropy_slice(@image, 0, top, @columns, slice_height)
+          bottom_entropy = entropy_slice(@image, 0, (bottom - slice_height), @columns, slice_height)
+
+          #remove the slice with the least entropy
+          if top_entropy < bottom_entropy
+            top += slice_height
+          else
+            bottom -= slice_height
+          end
+
+          height = (bottom - top)
         end
-        
-        height = (bottom - top)
       end
 
       square = {:left => left, :top => top, :right => right, :bottom => bottom}
@@ -119,22 +122,22 @@ class CropToelie
       slice = image_data.crop(x, y, width, height)
       entropy = entropy(slice)
     end
-    
+
     # Compute the entropy of an image, defined as -sum(p.*log2(p)).
     #  Note: instead of log2, only available in ruby > 1.9, we use
     #  log(p)/log(2). which has the same effect.
     def entropy(image_slice)
       hist = image_slice.color_histogram
       hist_size = hist.values.inject{|sum,x| sum ? sum + x : x }.to_f
-      
+
       entropy = 0
-      hist.values.each do |h| 
+      hist.values.each do |h|
         p = h.to_f / hist_size
         entropy += (p * (Math.log(p)/Math.log(2))) if p != 0
       end
       return entropy * -1
     end
-    
+
     def step_size(requested_x, requested_y)
       ((([@rows - requested_x, @columns - requested_y].max)/2)/@steps).to_i
     end

data/test/fixtures/entropyish.txt

@@ -0,0 +1 @@
+This is not an image.

data/test/test_croptoelie.rb

@@ -2,9 +2,14 @@ require 'helper'
 
 class TestCroptoelie < Test::Unit::TestCase
   def setup
-    @filename = File.join(File.expand_path(File.dirname(__FILE__)), "entropyish.png")
+    @filename = File.join(File.expand_path(File.dirname(__FILE__)), "fixtures", "entropyish.png")
     @image    = Magick::ImageList.new(@filename).last
+
+    @twenty_twenty = Magick::ImageList.new(
+      File.join(File.expand_path(File.dirname(__FILE__)), "fixtures", "20x20.png")
+    ).last
   end
+
   should "initialize a croptoelie image from an ImageList item" do
     img = CropToelie.new(@image)
     assert_equal(img.class, CropToelie)
@@ -16,27 +21,59 @@ class TestCroptoelie < Test::Unit::TestCase
 
   should "fail on creating a croptoelie image from a textfile" do
     assert_raise Magick::ImageMagickError, NoMethodError do
-       CropToelie.new(File.join(File.expand_path(File.dirname(__FILE__)), "entropyish.txt"))
+       CropToelie.new(File.join(File.expand_path(File.dirname(__FILE__)), "fixtures","entropyish.txt"))
     end
   end
-  
+
   should "crop to 100x100 without scaling with smart_crop" do
     img = CropToelie.new(@image)
     img = img.smart_crop(100, 100)
     size = [img.rows, img.columns]
     assert_equal(size, [100, 100])
   end
-  
+
   should "crop to 100x100 with scaling with smart_crop_and_scale" do
     img = CropToelie.new(@image)
     img = img.smart_crop_and_scale(100, 100)
     size = [img.rows, img.columns]
     assert_equal(size, [100, 100])
   end
-  
+
   should "square image without scaling" do
     img = CropToelie.new(@image)
     img = img.smart_square
     assert_equal(img.rows, img.columns)
   end
+
+  should "not crop small images" do
+    img = CropToelie.new(@twenty_twenty)
+    img = img.smart_crop(100, 100)
+    size = [img.rows, img.columns]
+    assert_equal([20, 20], size)
+  end
+
+  should "still crop a slice of one pixel" do
+    img = CropToelie.new(@twenty_twenty)
+    img = img.smart_crop(19, 19)
+    size = [img.rows, img.columns]
+    assert_equal([19, 19], size)
+  end
+
+  ###########################################################################
+  #                   Images reported to fail by issue #5                   #
+  ###########################################################################
+  [:smart_crop, :smart_crop_and_scale, :smart_square].each do |method|
+    full_path = File.join File.dirname(__FILE__), "fixtures", "errors"
+    Dir.open(full_path).select{|f| !File.directory?(f)}.each do |file|
+
+      should "'not fail on reported-as-broken image '#{file}' with '#{method}'" do
+          realpath = File.realpath(File.join full_path, file)
+
+          img = CropToelie.new(Magick::ImageList.new(realpath).last)
+          img = img.smart_crop(200, 200)
+          size = [img.rows, img.columns]
+          assert_equal(size, [200, 200])
+      end
+    end
+  end
 end

metadata

@@ -1,96 +1,126 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: croptoelie
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.4.1
   prerelease: 
-  version: 0.4.0
 platform: ruby
-authors: 
-- "B\xC3\xA8r Kessels"
+authors:
+- Bèr Kessels
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-19 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rmagick
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rmagick
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
         version: 2.11.0
   type: :runtime
   prerelease: false
-  version_requirements: *id006
-description: "Crops images based on entropy: leaving the most interesting part intact. Don't expect this to be a replacement for human cropping, it is an algorythm and not an extremely smart one at that :). Best results achieved in combination with scaling: the cropping is then only used to square the image, cutting off the least interesting part. The trimming simply chops off te edge that is least interesting, and continues doing so, untill it reached the requested size."
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+description: ! 'Crops images based on entropy: leaving the most interesting part intact.
+  Don''t expect this to be a replacement for human cropping, it is an algorythm and
+  not an extremely smart one at that :). Best results achieved in combination with
+  scaling: the cropping is then only used to square the image, cutting off the least
+  interesting part. The trimming simply chops off te edge that is least interesting,
+  and continues doing so, untill it reached the requested size.'
 email: ber@webschuur.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.md
-files: 
+files:
 - .document
-- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -102,43 +132,45 @@ files:
 - doc/croptoelie_test.rb
 - doc/histogram.rb
 - lib/croptoelie.rb
-- test/entropyish.png
-- test/entropyish.txt
+- test/fixtures/20x20.png
+- test/fixtures/entropyish.png
+- test/fixtures/entropyish.txt
+- test/fixtures/errors/flo-rida.png
+- test/fixtures/errors/hollywood-undead.jpg
+- test/fixtures/errors/maroon-5.jpg
+- test/fixtures/errors/yo-gotti.jpg
 - test/helper.rb
 - test/profiler.rb
 - test/test_croptoelie.rb
-has_rdoc: true
 homepage: http://github.com/berkes/croptoelie
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -831961247
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 259147617
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Content aware cropper.
-test_files: 
+test_files:
 - test/helper.rb
 - test/profiler.rb
 - test/test_croptoelie.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm ruby-1.9.2-p0@croptoelie