Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
FastImage finds the size or type of an image given its uri by fetching as little as needed
Branch: master

This branch is 123 commits behind sdsykes:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
MIT_LICENCE
README
README.textile
Rakefile
VERSION.yml
fastimage.gemspec

README.textile

FastImage

FastImage finds the size or type of an image given its uri by fetching as little as needed

The problem

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.

But the image is not locally stored – it’s on another asset server, or in the cloud – at Amazon S3 for example.

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 much 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.

Fastimage can also read local (and other) files, and uses the open-uri library to do so.

And new in v1.2.9, FastImage will automatically read from any object that responds to :read – for
instance an IO object if that is passed instead of a URI.

New in v1.2.10 FastImage will follow up to 4 HTTP redirects to get the image.

Examples


require 'fastimage'

FastImage.size("http://stephensykes.com/images/ss.com_x.gif")
=> [266, 56]  # width, height
FastImage.type("http://stephensykes.com/images/pngimage")
=> :png
FastImage.type("/some/local/file.gif")
=> :gif

Installation

Gem


  gem install fastimage

Rails

Install the gem as above, and add it to your Gemfile if you are using bundler, or configure it in your environment.rb file as below:


... Rails::Initializer.run do |config| ... config.gem "fastimage" ... end ...

Then you’re off – just use FastImage.size() and FastImage.type() in your code as in the examples.

Documentation

http://rdoc.info/projects/sdsykes/fastimage

Tests

You’ll need to ‘sudo gem install fakeweb’ to be able to run the tests.


ruby test/test.rb
Loaded suite test/test
Started
...............
Finished in 0.059392 seconds.

15 tests, 27 assertions, 0 failures, 0 errors

References

Licence

MIT, see file MIT_LICENCE

Something went wrong with that request. Please try again.