ptools 1.1.4 → 1.1.5

data/CHANGES

@@ -1,3 +1,6 @@
+== 1.1.5 - 19-Jul-2007
+* Added the File.image? method. Inspired by ruby-talk: 260487. 
+
 == 1.1.4 - 21-May-2007
 * Removed the install.rb file. Installation is now handled exclusively by the
   rake install task.

data/MANIFEST

@@ -7,6 +7,7 @@
 * test/ts_all.rb
 * test/tc_constants.rb
 * test/tc_head.rb
+* test/tc_image.rb
 * test/tc_middle.rb
 * test/tc_nlconvert.rb
 * test/tc_null.rb

data/lib/ptools.rb

@@ -1,7 +1,7 @@
 require 'win32/file' if RUBY_PLATFORM.match('mswin')
 
 class File
-   PTOOLS_VERSION = '1.1.3'
+   PTOOLS_VERSION = '1.1.5'
 
    # :stopdoc:
 
@@ -16,8 +16,27 @@ class File
       IS_WINDOWS = false
    end
 
+   IMAGE_EXT = %w/.bmp .gif .jpg .jpeg .png/
+
    # :startdoc:
 
+   # Returns whether or not the file is an image. Only JPEG, PNG, BMP and
+   # GIF are checked against.
+   #
+   # This method does some simple read and extension checks. For a version
+   # that is more robust, but which depends on a 3rd party C library (and is
+   # difficult to build on MS Windows), see the 'filemagic' library, available
+   # on the RAA.
+   #--
+   # Approach used here is based on information found at
+   # http://en.wikipedia.org/wiki/Magic_number_(programming) 
+   #
+   def self.image?(file)
+      bool = IMAGE_EXT.include?(File.extname(file).downcase)      # Match ext
+      bool = bmp?(file) || jpg?(file) || png?(file) || gif?(file) # Check data
+      bool
+   end
+
    # Returns the null device (aka bitbucket) on your platform.  On most
    # Unix-like systems this is '/dev/null', on Windows it's 'NUL', etc.
    #--
@@ -281,4 +300,22 @@ class File
          return [bytes,chars,words,lines]
       end
    end
+
+   private
+
+   def self.bmp?(file)
+      IO.read(file, 3) == "BM6"
+   end
+
+   def self.jpg?(file)
+      IO.read(file, 10) == "\377\330\377\340\000\020JFIF"
+   end
+
+   def self.png?(file)
+      IO.read(file, 4) == "\211PNG"
+   end
+
+   def self.gif?(file)
+      ['GIF89a', 'GIF97a'].include?(IO.read(file, 6))
+   end
 end

data/test/tc_constants.rb

@@ -9,7 +9,11 @@ require 'ptools'
 
 class TC_Constants < Test::Unit::TestCase
    def test_version
-      assert_equal('1.1.4', File::PTOOLS_VERSION)
+      assert_equal('1.1.5', File::PTOOLS_VERSION)
+   end
+
+   def test_image_ext
+      assert_equal(%w/.bmp .gif .jpeg .jpg .png/, File::IMAGE_EXT.sort)
    end
 
    if RUBY_PLATFORM.match('mswin')

data/test/tc_image.rb

@@ -0,0 +1,32 @@
+#####################################################################
+# tc_image.rb
+# 
+# Test case for the File.image? method. You should run this test
+# via the 'rake test_image' task.
+#####################################################################
+require 'test/unit'
+require 'ptools'
+
+class TC_Ptools_Image < Test::Unit::TestCase
+   def setup
+      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
+      @text_file = 'test_file1.txt'
+   end
+
+   def test_image_basic
+      assert_respond_to(File, :image?)
+      assert_nothing_raised{ File.image?(@text_file) }
+   end
+
+   def test_image_expected_results
+      assert_equal(false, File.image?(@text_file))
+   end
+
+   def test_image_expected_errors
+      assert_raises(Errno::ENOENT, ArgumentError){ File.image?('bogus') }
+   end
+
+   def teardown
+      @text_file = nil
+   end
+end

data/test/ts_all.rb

@@ -9,6 +9,7 @@ $LOAD_PATH.unshift(Dir.pwd + "/test")
 require 'tc_binary'
 require 'tc_constants'
 require 'tc_head'
+require 'tc_image'
 require 'tc_middle'
 require 'tc_nlconvert'
 require 'tc_null'

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4
 specification_version: 1
 name: ptools
 version: !ruby/object:Gem::Version 
-  version: 1.1.4
-date: 2007-05-21 00:00:00 -06:00
+  version: 1.1.5
+date: 2007-07-19 00:00:00 -06:00
 summary: Extra methods for the File class
 require_paths: 
 - lib
@@ -37,6 +37,7 @@ files:
 - test/tc_binary.rb
 - test/tc_constants.rb
 - test/tc_head.rb
+- test/tc_image.rb
 - test/tc_middle.rb
 - test/tc_nlconvert.rb
 - test/tc_null.rb