plumnailer 0.1.3 → 0.1.4

data/README.textile

@@ -1,19 +1,46 @@
-Compare all of the images on an HTML page and select the one that best
-represents what the page is about (for use as a thumbnail for the entire page).
+Compare all of the images on an HTML page and sort them according to how well
+they represent what the page is about. The top image could be used as a
+thumbnail to represent the entire page.
+
+Basic usage:
+
+<pre>
+<code>
+require 'plumnailer'
+
+chooser = Plumnailer::Chooser.new
+choice = chooser.choose('http://urls.matthewm.boedicker.org/')
+puts choice.source_url
+
+choice.resize_to_fill(64, 64).write('thumb.jpg')
+</code>
+</pre>
+
+Alternate fetcher that caches images on local filesystem:
 
 <pre>
 <code>
 require 'plumnailer'
 
 chooser = Plumnailer::Chooser.new
-# caching fetcher is good for testing
 chooser.fetcher = chooser.img_parser.fetcher =
   Plumnailer::CachingFetcher.new('/tmp/plumnailer-test')
 
 choice = chooser.choose('http://urls.matthewm.boedicker.org/')
 puts choice.source_url
+</code>
+</pre>
 
-choice.resize_to_fill(64, 64).write('thumb.jpg')
+Top five images:
+
+<pre>
+<code>
+require 'plumnailer'
+
+chooser = Plumnailer::Chooser.new
+chooser.choose('http://urls.matthewm.boedicker.org/', :top => 5).each do |i|
+  puts i.source_url
+end
 </code>
 </pre>
 

data/lib/plumnailer/chooser.rb

@@ -12,7 +12,12 @@ module Plumnailer
     end
 
     # Find the most representative image on a page.
-    def choose(url)
+    # 
+    # Return the best image or nil if no suitable images are found.
+    #
+    # If options[:top] is passed in return up to the top n images. If this
+    # option is used the the method will always return of list of size 0 to n.
+    def choose(url, options={})
       doc_string = fetcher.fetch(url)
 
       doc = doc_parser.parse(doc_string, url)
@@ -24,14 +29,15 @@ module Plumnailer
 
       imgs = img_parser.parse(img_abs_urls)
 
-      unless imgs.empty?
-        imgs.each do |img|
-          # set source document on image so it can be used in comparator
-          img.doc = doc
-          img.extend @img_comparator
-        end
-        imgs.sort.first
+      imgs.each do |img|
+        # set source document on image so it can be used in comparator
+        img.doc = doc
+        img.extend @img_comparator
       end
+
+      imgs.sort!
+
+      options[:top] ? imgs.first(options[:top]) : imgs.first
     end
 
     attr_accessor :fetcher

data/plumnailer.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name = 'plumnailer'
-  s.version = '0.1.3'
-  s.summary = 'Choose the most representative image on an HTML page for use as a thumbnail'
+  s.version = '0.1.4'
+  s.summary = 'Rank images on an HTML page for use as a thumbnail'
   s.description = s.summary
   s.homepage = 'https://github.com/mmb/plumnailer'
   s.authors = ['Matthew M. Boedicker']

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: plumnailer
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Matthew M. Boedicker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-16 00:00:00 -05:00
+date: 2011-08-04 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,7 +74,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
-description: Choose the most representative image on an HTML page for use as a thumbnail
+description: Rank images on an HTML page for use as a thumbnail
 email: 
 - matthewm@boedicker.org
 executables: []
@@ -132,6 +132,6 @@ rubyforge_project:
 rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: Choose the most representative image on an HTML page for use as a thumbnail
+summary: Rank images on an HTML page for use as a thumbnail
 test_files: []