ptools 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16f06f25547577f77bf9f56f263bd4bd29bd2c2c
-  data.tar.gz: 6d86459c2c74ea62fe50b674ba1a866aef4059b6
+  metadata.gz: 8b1ad5b7756616fecd9369472860f83dd3294f5e
+  data.tar.gz: 44943151f729df7c9c2f5a00fbfd9491ac3ea694
 SHA512:
-  metadata.gz: c2ed19fd3d1e598a5599b2f3893f922c2fd132702dc5af72153a1e87bcdd4dfb9e5dc8c8f5ffdd34d19eaf8c55429186e87527633ab2bb2027f3fb329864a6f9
-  data.tar.gz: 2ce7328135836e1b821664167099de0d434c451e4269ab838141638be4c9f67e21096904ff69244fb973370629a3289a95056779801abaea9fba7d67b6d6a834
+  metadata.gz: 3f05fdc52605e22f394c85b575aa9dccb475b707665da115615ba2fafd807b9649a860446ca2088f27ee7973f83b3f3bb1a129b464e1a094c5845ef990949e74
+  data.tar.gz: 6447938245ae44d917b9013a3d0a128e80b26218db680f4b81a01e5d9734b91b591ab8f673afab7d36eb4fe23638cde85fe7c98e6c564a90aa34e51529e730b3

data/CHANGES

@@ -1,3 +1,8 @@
+== 1.2.4 - 25-Feb-2014
+* The File.binary method now always returns false for images. It is meant to
+  detect executables, shared objects, etc. Use File.image? to detect images.
+* Encoding fixes for the File.image? method.
+
 == 1.2.3 - 19-Feb-2014
 * Fixed a bug where File.binary? would return true for unicode text. Thanks go
   to Ben Hollis for the spot.

data/Rakefile

@@ -68,6 +68,13 @@ namespace 'test' do
     t.test_files = FileList['test/test_head.rb']
   end
 
+  Rake::TestTask.new('image') do |t|
+    t.libs << 'test'
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_image.rb']
+  end
+
   Rake::TestTask.new('middle') do |t|
     t.libs << 'test'
     t.verbose = true

data/lib/ptools.rb

@@ -3,7 +3,7 @@ require 'win32/file' if File::ALT_SEPARATOR
 
 class File
   # The version of the ptools library.
-  PTOOLS_VERSION = '1.2.3'
+  PTOOLS_VERSION = '1.2.4'
 
   # :stopdoc:
 
@@ -28,13 +28,12 @@ class File
   #
   # 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.
+  # difficult to build on MS Windows), see the 'filemagic' library.
   #
   # Examples:
   #
   #    File.image?('somefile.jpg') # => true
-  #    File.image?('somefile.txt') # => true
+  #    File.image?('somefile.txt') # => false
   #--
   # The approach I used here is based on information found at
   # http://en.wikipedia.org/wiki/Magic_number_(programming)
@@ -75,9 +74,10 @@ class File
     alias null_device null
   end
 
-  # Returns whether or not +file+ is a binary file.  Note that this is
-  # not guaranteed to be 100% accurate.  It performs a "best guess" based
-  # on a simple test of the first +File.blksize+ characters.
+  # Returns whether or not +file+ is a binary non-image file, i.e. executable,
+  # shared object, ect. Note that this is NOT guaranteed to be 100% accurate.
+  # It performs a "best guess" based on a simple test of the first
+  # +File.blksize+ characters.
   #
   # Example:
   #
@@ -88,7 +88,9 @@ class File
   # based on Perl's -B switch).
   #
   def self.binary?(file)
-    s = (File.read(file, File.stat(file).blksize) || "").encode('US-ASCII', :undef => :replace).split(//)
+    return false if image?(file)
+    s = (File.read(file, File.stat(file).blksize) || "")
+    s = s.encode('US-ASCII', :undef => :replace).split(//)
     ((s.size - s.grep(" ".."~").size) / s.size.to_f) > 0.30
   end
 
@@ -416,11 +418,11 @@ class File
   end
 
   def self.jpg?(file)
-    IO.read(file, 10) == "\377\330\377\340\000\020JFIF"
+    IO.read(file, 10, encoding: 'binary') == "\377\330\377\340\000\020JFIF".force_encoding(Encoding::BINARY)
   end
 
   def self.png?(file)
-    IO.read(file, 4) == "\211PNG"
+    IO.read(file, 4, encoding: 'binary') == "\211PNG".force_encoding(Encoding::BINARY)
   end
 
   def self.gif?(file)

data/ptools.gemspec

@@ -3,7 +3,7 @@ require 'rbconfig'
 
 Gem::Specification.new do |gem|
   gem.name       = 'ptools'
-  gem.version    = '1.2.3'
+  gem.version    = '1.2.4'
   gem.license    = 'Artistic 2.0'
   gem.author     = 'Daniel J. Berger'
   gem.email      = 'djberg96@gmail.com'

data/test/test_binary.rb

@@ -10,8 +10,6 @@ require 'ptools'
 
 class TC_Ptools_Binary < Test::Unit::TestCase
   def self.startup
-    @@txt_file = 'test_binary.txt'
-
     if File::ALT_SEPARATOR
       @@bin_file = File.join(ENV['windir'], 'notepad.exe')
     else
@@ -19,29 +17,49 @@ class TC_Ptools_Binary < Test::Unit::TestCase
     end
 
     Dir.chdir('test') if File.exist?('test')
+  end
 
-    File.open(@@txt_file, 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
+  def setup
+    @txt_file = File.join('txt', 'english.txt')
+    @uni_file = File.join('txt', 'korean.txt')
+    @png_file = File.join('img', 'test.png')
+    @jpg_file = File.join('img', 'test.jpg')
+    @gif_file = File.join('img', 'test.gif')
   end
 
   test "File.binary? basic functionality" do
     assert_respond_to(File, :binary?)
-    assert_nothing_raised{ File.binary?(@@txt_file) }
+    assert_nothing_raised{ File.binary?(@txt_file) }
   end
 
-  test "File.binary? returns expected results" do
-    assert_false(File.binary?(@@txt_file))
+  test "File.binary? returns true for binary files" do
     assert_true(File.binary?(@@bin_file))
   end
 
+  test "File.binary? returns false for text files" do
+    assert_false(File.binary?(@txt_file))
+    assert_false(File.binary?(@uni_file))
+  end
+
+  test "File.binary? returns false for image files" do
+    assert_false(File.binary?(@png_file))
+    assert_false(File.binary?(@jpg_file))
+    assert_false(File.binary?(@gif_file))
+  end
+
   test "File.binary? raises an error if the file cannot be found" do
     assert_raise_kind_of(SystemCallError){ File.binary?('bogus') }
   end
 
   test "File.binary? only accepts one argument" do
-    assert_raise_kind_of(ArgumentError){ File.binary?(@@txt_file, @@bin_file) }
+    assert_raise_kind_of(ArgumentError){ File.binary?(@txt_file, @@bin_file) }
   end
 
-  def self.shutdown
-    File.delete(@@txt_file) if File.exist?(@@txt_file)
+  def teardown
+    @txt_file = nil
+    @uni_file = nil
+    @png_file = nil
+    @jpg_file = nil
+    @gif_file = nil
   end
 end

data/test/test_constants.rb

@@ -15,7 +15,7 @@ class TC_Ptools_Constants < Test::Unit::TestCase
   end
 
   test "PTOOLS_VERSION constant is set to expected value" do
-    assert_equal('1.2.3', File::PTOOLS_VERSION)
+    assert_equal('1.2.4', File::PTOOLS_VERSION)
   end
 
   test "IMAGE_EXT constant is set to array of values" do

data/test/test_image.rb

@@ -2,7 +2,7 @@
 # test_image.rb
 #
 # Test case for the File.image? method. You should run this test
-# via the 'rake test_image' task.
+# via the 'rake test:image' task.
 #####################################################################
 require 'test-unit'
 require 'ptools'
@@ -10,31 +10,48 @@ require 'ptools'
 class TC_Ptools_Image < Test::Unit::TestCase
   def self.startup
     Dir.chdir('test') if File.exist?('test')
-    File.open('test_file1.txt', 'w'){ |fh| 25.times{ |n| fh.puts "line#{n+1}" } }
   end
 
   def setup
-    @text_file = 'test_file1.txt'
+    @txt_file  = File.join(Dir.pwd, 'txt', 'english.txt')
+    @uni_file  = File.join(Dir.pwd, 'txt', 'korean.txt')
+    @jpg_file  = File.join(Dir.pwd, 'img', 'test.jpg')
+    @png_file  = File.join(Dir.pwd, 'img', 'test.png')
+    @gif_file  = File.join(Dir.pwd, 'img', 'test.gif')
   end
 
-  def test_image_basic
+  test "image? method basic functionality" do
     assert_respond_to(File, :image?)
-    assert_nothing_raised{ File.image?(@text_file) }
+    assert_nothing_raised{ File.image?(@txt_file) }
+    assert_boolean(File.image?(@txt_file))
   end
 
-  def test_image_expected_results
-    assert_equal(false, File.image?(@text_file))
+  test "image? method returns false for a text file" do
+    assert_false(File.image?(@txt_file))
+    assert_false(File.image?(@uni_file))
   end
 
-  def test_image_expected_errors
-    assert_raises(Errno::ENOENT, ArgumentError){ File.image?('bogus') }
+  test "image? method returns true for a gif" do
+    assert_true(File.image?(@gif_file))
   end
 
-  def teardown
-    @text_file = nil
+  test "image? method returns true for a jpeg" do
+    assert_true(File.image?(@jpg_file))
+  end
+
+  test "image? method returns true for a png" do
+    assert_true(File.image?(@png_file))
   end
 
-  def self.shutdown
-    File.delete('test_file1.txt') if File.exist?('test_file1.txt')
+  test "image? method raises an error if the file does not exist" do
+    assert_raises(Errno::ENOENT, ArgumentError){ File.image?('bogus') }
+  end
+
+  def teardown
+    @txt_file = nil
+    @uni_file = nil
+    @jpg_file = nil
+    @png_file = nil
+    @gif_file = nil
   end
 end

data/test/txt/english.txt

@@ -0,0 +1 @@
+Hello World

data/test/txt/korean.txt

@@ -0,0 +1 @@
+한국어의 내용분석을 위한

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ptools
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -43,6 +43,9 @@ files:
 - Rakefile
 - lib/ptools.rb
 - ptools.gemspec
+- test/img/test.gif
+- test/img/test.jpg
+- test/img/test.png
 - test/test_binary.rb
 - test/test_constants.rb
 - test/test_head.rb
@@ -56,6 +59,8 @@ files:
 - test/test_wc.rb
 - test/test_whereis.rb
 - test/test_which.rb
+- test/txt/english.txt
+- test/txt/korean.txt
 homepage: https://github.com/djberg96/ptools
 licenses:
 - Artistic 2.0