image_validator 0.1.0

data/README.markdown

@@ -0,0 +1,17 @@
+# ImageValidator
+
+A simple image file validator using the identify command line app.
+
+Checks to see if an image is valid.
+
+## Uage
+
+      ImageValidator.valid?(file)
+
+`file` can be an IO, a filename or image data in a string. Returns true if the image exists.
+ 
+ 
+      ImageValidator.valid?("missing_image.png") # => false
+      ImageValidator.valid?("") # => false
+      ImageValidator.valid?(File.open("an_image_file.png")) # => true
+      # etc…

data/lib/image_validator.rb

@@ -0,0 +1,31 @@
+module ImageValidator
+  def valid?(file)
+    file = thing_to_io(file)
+    check_image_magick_is_available
+    IO.popen("identify - &> /dev/null", "w") do |identify|
+      some_content_has_been_read = false
+      while blk = file.read(1024**2)
+        identify << blk
+        some_content_has_been_read = true if blk != ""
+      end
+      return false unless some_content_has_been_read
+    end
+    $?.success?
+  end
+
+protected
+  def check_image_magick_is_available
+    raise "identify command not found, please install imagemagick" if `which identify` == ''
+  end
+
+  def thing_to_io(thing)
+    return thing unless thing.is_a?(String)
+
+    if (File.exists?(thing) rescue false)
+      File.open(thing)
+    else
+      StringIO.new(thing, "rb")
+    end
+  end
+  extend self
+end

data/test/fixtures/dolphin.txt

@@ -0,0 +1,34 @@
+                              I'm a dolphin!
+
+
+                         ..                                              
+                       :`   ``´:..                                       
+                        ´:`:.    ``´:.                                   
+                          : `-:.     `´:.                                
+                           : ::´    .::::::::...                         
+                           : :´`               ``´::.                    
+                          :´                        `´::                 
+                        :´                              `:.              
+                      .´                                  `´:            
+                     :                                       ´:          
+                   :´                                          ´:        
+                 .:                                              :.      
+                :´                                                `:     
+               :´                                                   :    
+              :                                                      :   
+             :                 .::::::::         .:                   :  
+            :              .:::::::´´´´;        :`                    ;  
+           :            ::::´`        :        :``::. .        :.      : 
+          .´         .::´`           :       .´     `´:::.      `      : 
+          :        .:´`             ;      .:           `´:   .   :    : 
+         :        .´              :`  ..::´                `: `-.  `:..: 
+         ;      .:                 ````                      `:. ´:. ´:  
+        :      :´                                              `´;.`:  : 
+        :     :                                                   `:.:. :
+      :´´´   :                                                      `´::;
+    :´       :                                                           
+   :        ':                                                           
+  ´      .   ´.                                                          
+ ;   :::`:.   `.                                                         
+:  :´      `´. :                                                         
+

data/test/image_validator_test.rb

@@ -0,0 +1,62 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+require 'fileutils'
+
+class ImageValidatorTest < Test::Unit::TestCase
+  def test_an_invalid_image
+    name = "dolphin.txt"
+    assert_invalid(fixture(name))
+    assert_invalid(fixture_filename(name))
+    assert_invalid(fixture_as_string(name))
+  end
+
+  def test_a_missing_image
+    name = "your_face"
+    assert_invalid(StringIO.new("", "rb"))
+    assert_invalid(name)
+    assert_invalid("")
+  end
+
+  def test_a_png
+    name = "space-lincoln.png"
+    assert_valid(fixture(name))
+    assert_valid(fixture_filename(name))
+    assert_valid(fixture_as_string(name))
+  end
+
+  def test_a_gif
+    name = "space-lincoln.gif"
+    assert_valid(fixture(name))
+    assert_valid(fixture_filename(name))
+    assert_valid(fixture_as_string(name))
+  end
+
+  def test_a_jpeg
+    name = "space-lincoln.jpg"
+    assert_valid(fixture(name))
+    assert_valid(fixture_filename(name))
+    assert_valid(fixture_as_string(name))
+  end
+end
+
+class ImageValidatorWithNoImageMagickTest < Test::Unit::TestCase
+  def setup
+    @fake_bin = File.expand_path(File.join(ENV["TMPDIR"], "ImageValidatorWithNoImageMagickTest_bin"))
+    Dir.mkdir(@fake_bin)
+    File.symlink(`which which`.chomp, File.join(@fake_bin, "which"))
+
+    @orig_path = ENV["PATH"]
+    ENV["PATH"] = @fake_bin
+  end
+
+  def test_should_explode_if_image_magick_is_missing
+    e = assert_raise(RuntimeError){
+      assert_valid(fixture("space-lincoln.png"))
+    }
+    assert_equal "identify command not found, please install imagemagick", e.message
+  end
+
+  def teardown
+    FileUtils.rm_rf(@fake_bin)
+    ENV["PATH"] = @orig_path
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require "image_validator"
+require "test/unit"
+
+class Test::Unit::TestCase
+  def fixture(name)
+    File.open(fixture_filename(name), "rb")
+  end
+
+  def fixture_filename(name)
+    File.join(File.dirname(__FILE__), "fixtures", name)
+  end
+
+  def fixture_as_string(name)
+    fixture(name).read
+  end
+
+  def assert_valid(image)
+    assert ImageValidator.valid?(image), "Expected image to be valid"
+  end
+
+  def assert_invalid(image)
+    assert !ImageValidator.valid?(image), "Expected image to be invalid"
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: image_validator
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tom Lea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-02 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: 
+email: contrib@tomlea.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- test/fixtures/dolphin.txt
+- test/fixtures/space-lincoln.gif
+- test/fixtures/space-lincoln.jpg
+- test/fixtures/space-lincoln.png
+- test/image_validator_test.rb
+- test/test_helper.rb
+- lib/image_validator.rb
+has_rdoc: true
+homepage: http://tomlea.co.uk
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: image_validator
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple wrapper around the ImageMagick command line to check if an image is valid.
+test_files: []
+