croptoelie 0.2.0 → 0.3.0

data/README.md

@@ -1,4 +1,4 @@
-= croptoelie
+# croptoelie
 
 Content aware cropping.
 
@@ -10,18 +10,44 @@ Best results achieved in combination with scaling: the cropping is then only use
 
 The trimming simply chops off te edge that is least interesting, and continues doing so, untill it reached the requested size.
 
-== Contributing to croptoelie
+## Usage
+
+Use it in [carrierwave][1], in a custom `manipulate!` block. For example, carrierwave in a Rails project:
+
+File *uploaders/attachement_uploader.rb*: 
+
+    def smart_crop_and_scale(width, height)
+      manipulate! do |img|
+        img = CropToelie.new(img)
+        img = img.smart_crop_and_scale(width, height)
+        img = yield(img) if block_given?
+        img
+      end
+    end
+
+    # Create different versions of your uploaded files:
+    version :thumb do
+      process :smart_crop_and_scale => [80, 80]
+    end
+
+## Contributing to croptoelie
+
+* This is one of my first more complex Ruby gems. So any help in general improvement is welcome. If you read the code and thing "OMG, what was he thinking, the answer is probably 'I wasn't'". Feel free to tell me so.
+* RMagick is not the cleanest and leanest of all image-manipulation libraries in Ruby, but it was the only one where I found enough documentation and that had the features I needed (such as histograms). If you have better ideas, feel free to tell me them.
+* I only use this gem with [carrierwave][1], so other implementations are probably not well done. If you want to use it in any other project, please tell me what I should change to make your life easier. 
+* The integration in carrierwave should be simpler. I would love to be able to say `process :smart_crop_and_scale` instead of having to use the smartcropper as class in a custom carrierwave `manipulate!` block. My knowledge of Ruby, Carrierwave and how to get this integration done properly is limited, if you have a patch, or a suggestion, that would be great!
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
 * Start a feature/bugfix branch
 * Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+## Copyright
 
 Copyright (c) 2011 Bèr Kessels. See LICENSE.txt for
 further details.
 
+[1]: https://github.com/jnicklas/carrierwave
+

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.3.0

data/croptoelie.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{croptoelie}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bèr Kessels"]
-  s.date = %q{2011-02-28}
+  s.date = %q{2011-04-07}
   s.description = %q{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. It offers two methods, scanning and trimming: with scanning the whole image is placed in an array then evaluated: very slow and memory-gobbling. The trimming simply chops off te edge that is least interesting, and continues doing so, untill it reached the requested size.}
   s.email = %q{ber@webschuur.com}
   s.extra_rdoc_files = [

data/lib/croptoelie.rb

@@ -5,9 +5,11 @@ class CropToelie
   attr_accessor :orig
   attr_accessor :step_size
   
-  def initialize(image_path)
-    @image  = ImageList.new(image_path).last
-    @orig   = ImageList.new(image_path).last
+  # 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
+    @orig = image
     
     # Hardcoded (but overridable) defaults.
     @step_size  = 10
@@ -19,6 +21,12 @@ class CropToelie
     @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
   # 

metadata

@@ -2,7 +2,7 @@
 name: croptoelie
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - "B\xC3\xA8r Kessels"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-28 00:00:00 +01:00
+date: 2011-04-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -118,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -223000205
+      hash: -945638801
       segments: 
       - 0
       version: "0"