sdsykes-fastimage 1.0.1 → 1.0.2

data/README.textile

@@ -4,11 +4,13 @@ h4. FastImage finds the size or type of an image given its uri by fetching as li
 
 h2. The problem
 
-Your app needs to find the size or type of an image.  But the image is not locally stored - it's on another server, or in the cloud - at Amazon S3 for example.
+Your app needs to find the size or type of an image.  This could be for adding width and height attributes to an image tag, for adjusting layouts or overlays to fit an image or any other of dozens of reasons.
 
-You don't want to download the entire image, which could be many tens of kilobytes, or even megabytes just to get this information.  For most image types, the size of the image is simply stored at the start of the file.  For JPEG files it's a little bit more complex, but even so you do not need to fetch most of the image to find the size.
+But the image is not locally stored - it's on another asset server, or in the cloud - at Amazon S3 for example.
 
-FastImage does this minimal fetch for image types GIF, JPEG, PNG and BMP.
+You don't want to download the entire image to your app server - it could be many tens of kilobytes, or even megabytes just to get this information.  For most image types, the size of the image is simply stored at the start of the file.  For JPEG files it's a little bit more complex, but even so you do not need to fetch most of the image to find the size.
+
+FastImage does this minimal fetch for image types GIF, JPEG, PNG and BMP.  And it doesn't rely on installing external libraries such as RMagick (which relies on ImageMagick or GraphicsMagick) or ImageScience (which relies on FreeImage).
 
 You only need supply the uri, and FastImage will do the rest.
 
@@ -31,8 +33,48 @@ h4. Gem
 
   sudo gem install sdsykes-fastimage -s http://gems.github.com
 
+h4. Rails
+
+Install the gem as above, and configure it in your environment.rb file as below:
+<pre>
+<code>
+...
+Rails::Initializer.run do |config|
+  ...
+  config.gem "fastimage"
+  ...
+end
+...
+</code>
+</pre>
+Then you're off - just use FastImage.size() and FastImage.type() in your code as in the examples.
+
 h2. Documentation
 
 "http://rdoc.info/projects/sdsykes/fastimage":http://rdoc.info/projects/sdsykes/fastimage
 
-(c) 2009 Stephen Sykes (sdsykes)
+h2. Tests
+
+You'll need to 'sudo gem install fakeweb' to be able to run the tests.
+
+<pre>
+<code>
+ruby test/test.rb
+Loaded suite test/test
+Started
+.........
+Finished in 0.055059 seconds.
+
+9 tests, 15 assertions, 0 failures, 0 errors
+</code>
+</pre>
+
+
+h2. References
+* "http://pennysmalls.com/2008/08/19/find-jpeg-dimensions-fast-in-ruby/":http://pennysmalls.com/2008/08/19/find-jpeg-dimensions-fast-in-ruby/
+* "http://snippets.dzone.com/posts/show/805":http://snippets.dzone.com/posts/show/805
+* "http://www.anttikupila.com/flash/getting-jpg-dimensions-with-as3-without-loading-the-entire-file/":http://www.anttikupila.com/flash/getting-jpg-dimensions-with-as3-without-loading-the-entire-file/
+* "http://imagesize.rubyforge.org/":http://imagesize.rubyforge.org/
+
+
+(c) 2009 Stephen Sykes

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 1
+:patch: 2
 :major: 1
 :minor: 0

data/lib/fastimage.rb

@@ -20,6 +20,7 @@
 # * http://snippets.dzone.com/posts/show/805
 # * http://www.anttikupila.com/flash/getting-jpg-dimensions-with-as3-without-loading-the-entire-file/
 # * http://pennysmalls.com/2008/08/19/find-jpeg-dimensions-fast-in-ruby/
+# * http://imagesize.rubyforge.org/
 #
 require 'net/https'
 

data/test/test.rb

@@ -0,0 +1,78 @@
+require 'rubygems'
+
+require 'test/unit'
+
+require 'fastimage'
+
+require 'fakeweb'
+
+FixturePath = File.join(File.dirname(__FILE__), "fixtures")
+
+GoodFixtures = {
+  "test.bmp"=>[:bmp, [40, 27]],
+  "test.gif"=>[:gif, [17, 32]],
+  "test.jpg"=>[:jpg, [882, 470]],
+  "test.png"=>[:png, [30, 20]]
+  }
+
+BadFixtures = [
+  "faulty.jpg",
+  "test.ico"
+]
+
+TestUrl = "http://example.nowhere/"
+
+GoodFixtures.each do |fn, info|
+  FakeWeb.register_uri(:get, "#{TestUrl}#{fn}", :file => File.join(FixturePath, fn))
+end
+BadFixtures.each do |fn|
+  FakeWeb.register_uri(:get, "#{TestUrl}#{fn}", :file => File.join(FixturePath, fn))
+end
+
+class FasImageTest < Test::Unit::TestCase
+  def test_should_report_type_correctly
+    GoodFixtures.each do |fn, info|
+      assert_equal info[0], FastImage.type(TestUrl + fn)
+    end
+  end
+
+  def test_should_report_size_correctly
+    GoodFixtures.each do |fn, info|
+      assert_equal info[1], FastImage.size(TestUrl + fn)
+    end    
+  end
+  
+  def test_should_return_nil_on_fetch_failure
+    assert_nil FastImage.size(TestUrl + "does_not_exist")
+  end
+  
+  def test_should_return_nil_for_faulty_jpeg_where_size_cannot_be_found
+    assert_nil FastImage.size(TestUrl + "faulty.jpg")
+  end
+
+  def test_should_return_nil_when_image_type_not_known
+    assert_nil FastImage.size(TestUrl + "test.ico")
+  end
+  
+  def test_should_return_nil_if_timeout_occurs
+    assert_nil FastImage.size("http://example.com/does_not_exist", :timeout=>0.001)
+  end
+  
+  def test_should_raise_when_asked_to_when_size_cannot_be_found
+    assert_raises(FastImage::SizeNotFound) do
+      FastImage.size(TestUrl + "faulty.jpg", :raise_on_failure=>true)
+    end
+  end
+
+  def test_should_raise_when_asked_to_when_timeout_occurs
+    assert_raises(FastImage::ImageFetchFailure) do
+      FastImage.size("http://example.com/does_not_exist", :timeout=>0.001, :raise_on_failure=>true)
+    end
+  end
+
+  def test_should_raise_when_asked_when_image_type_not_known
+    assert_raises(FastImage::UnknownImageType) do
+      FastImage.size(TestUrl + "test.ico", :raise_on_failure=>true)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sdsykes-fastimage
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Stephen Sykes
@@ -28,6 +28,14 @@ files:
 - README.textile
 - VERSION.yml
 - lib/fastimage.rb
+- test/fixtures
+- test/fixtures/faulty.jpg
+- test/fixtures/test.bmp
+- test/fixtures/test.gif
+- test/fixtures/test.ico
+- test/fixtures/test.jpg
+- test/fixtures/test.png
+- test/test.rb
 has_rdoc: true
 homepage: http://github.com/sdsykes/fastimage
 post_install_message: