ptools 1.3.4 → 1.4.1

data/certs/djberg96_pub.pem

@@ -1,21 +1,26 @@
 -----BEGIN CERTIFICATE-----
-MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAhkamJl
+MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
 cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
-MB4XDTE2MTAzMTE4NTcyNVoXDTE3MTAzMTE4NTcyNVowPzERMA8GA1UEAwwIZGpi
+MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
 ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
-bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALwqllig3Tyc29Y3SZgK
-fFaApRB5R3l8KkOog3rwqr4Rr8bc8MfAMwHOzfqUMQRF7bPIyd5jLu24tPSC2X8D
-SKDS3069iTzTEDSPin90MVes+nd/ngys93lgmJ9DSwpGXQzZ7sWqdaJjzqLqDMhZ
-3LhTRZeMpDA8hyEiX7GmVp+VvhAXQ1pjfoFBmMNrzibUmYXcyllzqfEFcbI31/EK
-vlkEmcTKdNyd4aIOFLadZpzVvLxWsxFqi6qwteAwlNk3zxaik6O82iAXq2tcnk8p
-asWidshXCiRunncPhVogVYNCS4ISfYD6b/f85T9DsxJ6tsADNfeXnMTRxQcQv+1x
-0l0CAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFC3D
-p9cyKtYtWUAefeMpMh4kMUP4MB0GA1UdEQQWMBSBEmRqYmVyZzk2QGdtYWlsLmNv
-bTAdBgNVHRIEFjAUgRJkamJlcmc5NkBnbWFpbC5jb20wDQYJKoZIhvcNAQEFBQAD
-ggEBAEYzyGzoleAO3i6mOBi/Px1yWdVuU4ejvxrj8axHRK+wHQ+bYvx9eEosuRHB
-mXjRvpN9UnOiY7wYbK36MpAALBq3swpcBpYXyfBOdv0JQvjMEGmKqXJS7AbNHNPc
-ZbpPrVSdJJ+aTWEDvybl693eEUvEuiSkVIz8w4yNcJP1zOBRBKxG2viJdMKz5Ho7
-2M9INmGCv3GCv4bljYlIIg4YYAyOaBbSQeAb2/F5XAlOR2oEB8ipB+RKGZXR8rq5
-EkhPwYAx+jZ4KyPve9JKm34Du9veVFEzq3aW+opaveK167NEorK7xLpmdEcdo9bR
-9CkYV0lClarK7w1ykAePuEeXD7k=
+bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+/3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
 -----END CERTIFICATE-----

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.3.4'.freeze
+  PTOOLS_VERSION = '1.4.1'.freeze
 
   # :stopdoc:
 
@@ -23,8 +23,8 @@ class File
 
   # :startdoc:
 
-  # Returns whether or not the file is an image. Only JPEG, PNG, BMP and
-  # GIF are checked against.
+  # Returns whether or not the file is an image. Only JPEG, PNG, BMP,
+  # GIF, and ICO 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
@@ -39,41 +39,11 @@ class File
   # 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) || tiff?(file) # Check data
+    bool = IMAGE_EXT.include?(File.extname(file).downcase)
+    bool = bmp?(file) || jpg?(file) || png?(file) || gif?(file) || tiff?(file) || ico?(file)
     bool
   end
 
-  # Returns the name of the null device (aka bitbucket) on your platform.
-  #
-  # Examples:
-  #
-  #   # On Linux
-  #   File.null # => '/dev/null'
-  #
-  #   # On MS Windows
-  #   File.null # => 'NUL'
-  #--
-  # The values I used here are based on information from
-  # http://en.wikipedia.org/wiki//dev/null
-  #
-  def self.null
-    case RbConfig::CONFIG['host_os']
-      when /mswin|win32|msdos|mingw|windows/i
-        'NUL'
-      when /amiga/i
-        'NIL:'
-      when /openvms/i
-        'NL:'
-      else
-        '/dev/null'
-    end
-  end
-
-  class << self
-    alias null_device null
-  end
-
   # 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
@@ -92,7 +62,9 @@ class File
   # based on Perl's -B switch).
   #
   def self.binary?(file, percentage = 0.30)
+    return false if File.stat(file).zero?
     return false if image?(file)
+    return false if check_bom?(file)
     bytes = File.stat(file).blksize
     bytes = 4096 if bytes > 4096
     s = (File.read(file, bytes) || "")
@@ -432,6 +404,20 @@ class File
 
   private
 
+  # Returns whether or not the given +text+ contains a BOM marker.
+  # If present, we can generally assume it's a text file.
+  #
+  def self.check_bom?(file)
+    text = File.read(file, 4).force_encoding('utf-8')
+
+    bool = false
+    bool = true if text[0,3] == "\xEF\xBB\xBF"
+    bool = true if text[0,4] == "\x00\x00\xFE\xFF" || text[0,4] == "\xFF\xFE\x00\x00"
+    bool = true if text[0,2] == "\xFF\xFE" || text[0,2] == "\xFE\xFF"
+
+    bool
+  end
+
   def self.nl_for_platform(platform)
     platform = RbConfig::CONFIG["host_os"] if platform == 'local'
 
@@ -469,7 +455,7 @@ class File
     bytes = IO.read(file, 4)
 
     # II is Intel, MM is Motorola
-    if bytes[0..1] != 'II'&& bytes[0..1] != 'MM'
+    if bytes[0..1] != 'II' && bytes[0..1] != 'MM'
       return false
     end
 
@@ -483,4 +469,8 @@ class File
 
     true
   end
+
+  def self.ico?(file)
+    ["\000\000\001\000", "\000\000\002\000"].include?(IO.read(file, 4, nil, :encoding => 'binary'))
+  end
 end

data/ptools.gemspec

@@ -1,31 +1,37 @@
-require 'rubygems'
 require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name       = 'ptools'
-  spec.version    = '1.3.4'
+  spec.version    = '1.4.1'
   spec.license    = 'Artistic-2.0'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'https://github.com/djberg96/ptools'
   spec.summary    = 'Extra methods for the File class'
-  spec.test_files = Dir['test/test*']
+  spec.test_files = Dir['spec/_spec*']
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = ['certs/djberg96_pub.pem']
 
-  spec.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
-
   spec.description = <<-EOF
     The ptools (power tools) library provides several handy methods to
     Ruby's core File class, such as File.which for finding executables,
     File.null to return the null device on your platform, and so on.
   EOF
 
+  spec.metadata = {
+    'homepage_uri'      => 'https://github.com/djberg96/ptools',
+    'bug_tracker_uri'   => 'https://github.com/djberg96/ptools/issues',
+    'changelog_uri'     => 'https://github.com/djberg96/ptools/blob/master/CHANGES.md',
+    'documentation_uri' => 'https://github.com/djberg96/ptools/wiki',
+    'source_code_uri'   => 'https://github.com/djberg96/ptools',
+    'wiki_uri'          => 'https://github.com/djberg96/ptools/wiki'
+  }
+
   spec.add_development_dependency('rake')
-  spec.add_development_dependency('test-unit', '>= 2.5.0')
+  spec.add_development_dependency('rspec', '~> 3.9')
 
   if File::ALT_SEPARATOR
     spec.platform = Gem::Platform.new(['universal', 'mingw32'])
-    spec.add_dependency('win32-file', '>= 0.7.0')
+    spec.add_dependency('win32-file')
   end
 end

data/spec/binary_spec.rb

@@ -0,0 +1,59 @@
+#####################################################################
+# test_binary.rb
+#
+# Test case for the File.binary? method. You should run this test
+# via the 'rake test_binary' task.
+#####################################################################
+require 'rubygems'
+require 'rspec'
+require 'ptools'
+
+RSpec.describe File, :binary do
+  let(:dirname)  { File.dirname(__FILE__) }
+  let(:bin_file) { File::ALT_SEPARATOR ? File.join(ENV['windir'], 'notepad.exe') : '/bin/ls' }
+
+  before do
+    @txt_file = File.join(dirname, 'txt', 'english.txt')
+    @emp_file = File.join(dirname, 'txt', 'empty.txt')
+    @uni_file = File.join(dirname, 'txt', 'korean.txt')
+    @utf_file = File.join(dirname, 'txt', 'english.utf16')
+    @png_file = File.join(dirname, 'img', 'test.png')
+    @jpg_file = File.join(dirname, 'img', 'test.jpg')
+    @gif_file = File.join(dirname, 'img', 'test.gif')
+  end
+
+  example "File.binary? basic functionality" do
+    expect(File).to respond_to(:binary?)
+    expect{ File.binary?(@txt_file) }.not_to raise_error
+  end
+
+  example "File.binary? returns true for binary files" do
+    expect(File.binary?(bin_file)).to be true
+  end
+
+  example "File.binary? returns false for text files" do
+    expect(File.binary?(@emp_file)).to be false
+    expect(File.binary?(@txt_file)).to be false
+    expect(File.binary?(@uni_file)).to be false
+    expect(File.binary?(@utf_file)).to be false
+  end
+
+  example "File.binary? returns false for image files" do
+    expect(File.binary?(@png_file)).to be false
+    expect(File.binary?(@jpg_file)).to be false
+    expect(File.binary?(@gif_file)).to be false
+  end
+
+  example "File.binary? accepts an optional percentage argument" do
+    expect(File.binary?(@txt_file, 0.50)).to be false
+    expect(File.binary?(@txt_file, 0.05)).to be true
+  end
+
+  example "File.binary? raises an error if the file cannot be found" do
+    expect{ File.binary?('bogus') }.to raise_error(SystemCallError)
+  end
+
+  example "File.binary? only accepts one argument" do
+    expect{ File.binary?(@txt_file, bin_file) }.to raise_error(ArgumentError)
+  end
+end

data/spec/constants_spec.rb

@@ -0,0 +1,33 @@
+##############################################################################
+# constants_spec.rb
+#
+# Specs for the constants that have been defined in the ptools library.
+# This test case should be run via the 'rake spec:constants' task.
+##############################################################################
+require 'rubygems'
+require 'rspec'
+require 'rbconfig'
+require 'ptools'
+
+RSpec.describe File, :constants do
+  let(:windows) { File::ALT_SEPARATOR }
+
+  example "PTOOLS_VERSION constant is set to expected value" do
+    expect(File::PTOOLS_VERSION).to eq('1.4.1')
+    expect(File::PTOOLS_VERSION.frozen?).to be true
+  end
+
+  example "IMAGE_EXT constant is set to array of values" do
+    expect(File::IMAGE_EXT.sort).to eq(%w[.bmp .gif .jpeg .jpg .png])
+  end
+
+  example "WINDOWS constant is defined on MS Windows" do
+    skip "skipped unless MS Windows" unless windows
+    expect(File::MSWINDOWS).not_to be_nil
+  end
+
+  example "WIN32EXTS constant is defined on MS Windows" do
+    skip "skipped unless MS Windows" unless windows
+    expect(File::WIN32EXTS).not_to be_nil
+  end
+end

data/spec/head_spec.rb

@@ -0,0 +1,41 @@
+######################################################################
+# head_spec.rb
+#
+# Specs for the File.head method. These specs should be run via
+# the 'rake spec:head' task.
+######################################################################
+require 'rspec'
+require 'ptools'
+
+RSpec.describe File, :head do
+  let(:test_file) { 'test_file_head.txt' }
+
+  before do
+    File.open(test_file, 'w'){ |fh| 25.times{ |n| fh.puts "line#{n+1}" } }
+    @expected_head1 = ["line1\n","line2\n","line3\n","line4\n","line5\n"]
+    @expected_head1.push("line6\n","line7\n","line8\n","line9\n","line10\n")
+    @expected_head2 = ["line1\n","line2\n","line3\n","line4\n","line5\n"]
+  end
+
+  example "head method basic functionality" do
+    expect(File).to respond_to(:head)
+    expect{ File.head(test_file) }.not_to raise_error
+    expect{ File.head(test_file, 5) }.not_to raise_error
+    expect{ File.head(test_file){} }.not_to raise_error
+  end
+
+  example "head method returns the expected results" do
+    expect(File.head(test_file)).to be_kind_of(Array)
+    expect(File.head(test_file)).to eq(@expected_head1)
+    expect(File.head(test_file, 5)).to eq(@expected_head2)
+  end
+
+  example "head method requires two arguments" do
+    expect{ File.head(test_file, 5, "foo") }.to raise_error(ArgumentError)
+    expect{ File.head("bogus") }.to raise_error(Errno::ENOENT)
+  end
+
+  after do
+    File.delete(test_file) if File.exists?(test_file)
+  end
+end

data/spec/image_spec.rb

@@ -0,0 +1,51 @@
+#####################################################################
+# image_spec.rb
+#
+# Specs for the File.image? method. You should run these specs via
+# the 'rake spec:image' task.
+#####################################################################
+require 'rspec'
+require 'ptools'
+
+RSpec.describe File, :image do
+  before do
+    Dir.chdir('spec') if File.exist?('spec')
+    @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')
+    @ico_file  = File.join(Dir.pwd, 'img', 'test.ico')
+  end
+
+  example "image? method basic functionality" do
+    expect(File).to respond_to(:image?)
+    expect{ File.image?(@txt_file) }.not_to raise_error
+    expect(File.image?(@txt_file)).to be(true).or be(false)
+  end
+
+  example "image? method returns false for a text file" do
+    expect(File.image?(@txt_file)).to be false
+    expect(File.image?(@uni_file)).to be false
+  end
+
+  example "image? method returns true for a gif" do
+    expect(File.image?(@gif_file)).to be true
+  end
+
+  example "image? method returns true for a jpeg" do
+    expect(File.image?(@jpg_file)).to be true
+  end
+
+  example "image? method returns true for a png" do
+    expect(File.image?(@png_file)).to be true
+  end
+
+  example "image? method returns true for an ico" do
+    expect(File.image?(@ico_file)).to be true
+  end
+
+  example "image? method raises an error if the file does not exist" do
+    expect{ File.image?('bogus') }.to raise_error(Exception) # Errno::ENOENT or ArgumentError
+  end
+end

data/spec/nlconvert_spec.rb

@@ -0,0 +1,104 @@
+#####################################################################
+# test_nlconvert.rb
+#
+# Test case for the File.nl_convert method. You should run this
+# test via the 'rake test_nlconvert' task.
+#####################################################################
+require 'rubygems'
+require 'rspec'
+require 'ptools'
+
+RSpec.describe File, :nlconvert do
+  let(:windows)    { File::ALT_SEPARATOR }
+  let(:dirname)    { File.dirname(__FILE__) }
+  let(:test_file1) { File.join(dirname, 'test_nl_convert1.txt') }
+  let(:test_file2) { File.join(dirname, 'test_nl_convert2.txt') }
+
+  before do
+    File.open(test_file1, 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
+    File.open(test_file2, 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
+    @test_file1 = File.join(dirname, 'test_nl_convert1.txt')
+    @test_file2 = File.join(dirname, 'test_nl_convert2.txt')
+    @dos_file   = File.join(dirname, 'dos_test_file.txt')
+    @mac_file   = File.join(dirname, 'mac_test_file.txt')
+    @unix_file  = 'unix_test_file.txt'
+  end
+
+  example "nl_for_platform basic functionality" do
+    expect(File).to respond_to(:nl_for_platform)
+  end
+
+  example "nl_for_platform returns expected results" do
+    expect(File.nl_for_platform('dos') ).to eq( "\cM\cJ")
+    expect(File.nl_for_platform('unix') ).to eq( "\cJ")
+    expect(File.nl_for_platform('mac') ).to eq( "\cM")
+
+  end
+
+  example "nl_for_platform with 'local' platform does not raise an error" do
+    expect{ File.nl_for_platform('local') }.not_to raise_error
+  end
+
+  example "nl_for_platform with unsupported platform raises an error" do
+    expect{ File.nl_for_platform('bogus') }.to raise_error(ArgumentError)
+  end
+
+  example "nl_convert basic functionality" do
+    expect(File).to respond_to(:nl_convert)
+  end
+
+  example "nl_convert accepts one, two or three arguments" do
+    expect{ File.nl_convert(@test_file2) }.not_to raise_error
+    expect{ File.nl_convert(@test_file2, @test_file2) }.not_to raise_error
+    expect{ File.nl_convert(@test_file2, @test_file2, "unix") }.not_to raise_error
+  end
+
+  example "nl_convert with dos platform argument works as expected" do
+    expect{ File.nl_convert(@test_file1, @dos_file, "dos") }.not_to raise_error
+    expect{ File.nl_convert(@test_file1, @dos_file, "dos") }.not_to raise_error
+    expect(File.size(@dos_file)).to be > File.size(@test_file1)
+    expect(IO.readlines(@dos_file).first.split("")[-2..-1]).to eq(["\cM","\cJ"])
+  end
+
+  example "nl_convert with mac platform argument works as expected" do
+    expect{ File.nl_convert(@test_file1, @mac_file, 'mac') }.not_to raise_error
+    expect(IO.readlines(@mac_file).first.split("").last).to eq("\cM")
+
+    skip if windows
+    expect(File.size(@mac_file)).to eq(File.size(@test_file1))
+  end
+
+  example "nl_convert with unix platform argument works as expected" do
+    expect{ File.nl_convert(@test_file1, @unix_file, "unix") }.not_to raise_error
+    expect(IO.readlines(@unix_file).first.split("").last).to eq("\n")
+
+    if windows
+      expect(File.size(@unix_file) >= File.size(@test_file1)).to be true
+    else
+      expect(File.size(@unix_file) <= File.size(@test_file1)).to be true
+    end
+  end
+
+  example "nl_convert requires at least one argument" do
+    expect{ File.nl_convert }.to raise_error(ArgumentError)
+  end
+
+  example "nl_convert requires a valid platform string" do
+    expect{ File.nl_convert(@test_file1, "bogus.txt", "blah") }.to raise_error(ArgumentError)
+  end
+
+  example "nl_convert accepts a maximum of three arguments" do
+    expect{ File.nl_convert(@example_file1, @test_file2, 'dos', 1) }.to raise_error(ArgumentError)
+    expect{ File.nl_convert(@test_file1, @test_file2, 'dos', 1) }.to raise_error(ArgumentError)
+  end
+
+  example "nl_convert will fail on anything but plain files" do
+    expect{ File.nl_convert(IO::NULL, @test_file1) }.to raise_error(ArgumentError)
+  end
+
+  after do
+    [@dos_file, @mac_file, @unix_file].each{ |file| File.delete(file) if File.exist?(file) }
+    File.delete(test_file1) if File.exist?(test_file1)
+    File.delete(test_file2) if File.exist?(test_file2)
+  end
+end