ptools 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c180275bc8e38301a9c1d13771831614cf4febb5
-  data.tar.gz: 0de46ac283166ffc26a20955f2b4d4809116a6fc
+SHA256:
+  metadata.gz: be2c833dd51c09611f84da85481ae3b8039d427955fa951c5aab0745bef680d7
+  data.tar.gz: 612f6f1ab4cb5e605d9b1c18d26a9b35b95e798a9e9e11d54f539bb5ee1f1082
 SHA512:
-  metadata.gz: 8bf975d8d26c1f464f48cdb831347eba7a4094ccba45e9f974766ca14f343db58d87a41dad2a7647ad1f3b3a1923622549177c6936638b60a796ba33088984ee
-  data.tar.gz: 849697b55d1a7ee705f5eec78f3a2e19dcfe086e5b1cbf753bcf185509554dac11ee153709fd356ff8dc601d7806ebe9cc5d288abfb70cd6df5c6cd631449fdb
+  metadata.gz: 8ec40d7c6e2d9edb2cc0e5a41a74469d7a17d208cd67d0461963488c20f97ab06b125c17903c976c6f741f93a36612ccdd63fde6c9ac0a64671340b2dbe7d78c
+  data.tar.gz: 7cd78b2d229c8f98a7df154275d74cb0055336bac5b40368112dd83a3cf5b8ed96c3b708b5fe5cda543a263041ab2ab44fe1a656e8be70f5d4c0c36259646bb0

data/CHANGES

@@ -1,10 +1,38 @@
+== 1.4.0 - 20-Aug-2020
+* Switched from test-unit to rspec, and reworked the tests bit in general.
+* Removed the File.null method since Ruby has IO::NULL.
+
+== 1.3.7 - 24-Jun-2020
+* Fixed a bug where the File.binary? method would bomb on a zero byte file.
+  Thanks go to Alexandru Emil Lupu for the spot and patch.
+* Remove Gemfile.lock from repo. You can generate that yourself locally if
+  you want.
+
+== 1.3.6 - 7-Jun-2020
+* Updated gemspec, added more versions to .travis.yml file, fixed typo.
+  Thanks go to Al Snow for the updates.
+* Fixed a bug where the File.binary? method would return true for utf16
+  or utf32 encoded files. Thanks go to Andrew McAndre for the spot.
+* Updated cert.
+
+== 1.3.5 - 3-Sep-2017
+* The File.image? method now checks against .ico files.
+* Eliminated Fixnum warning that showed up in Ruby 2.4.x.
+* Updated cert.
+
+== 1.3.4 - 4-Jul-2017
+* The File.binary? method now lets you set your own percentage for the
+  internal heuristic as an optional second argument.
+* The VERSION constant is now frozen.
+* Minor updates to the Rakefile and gemspec.
+* Updated cert file.
+
 == 1.3.3 - 25-Sep-2015
 * This gem is now signed.
 * The Rakefile tasks now assume Rubygems 2.x.
 
 == 1.3.2 - 11-Dec-2014
-* Update to the File.tail method that deals prevents potential line ending
-  issues in JRuby.
+* Update to the File.tail method that prevents potential line ending issues in JRuby.
 * Added known issues with JRuby to the README.
 
 == 1.3.1 - 9-Dec-2014

data/Gemfile

@@ -8,5 +8,5 @@ end
 
 group :test do
   gem 'rake'
-  gem 'test-unit'
+  gem 'rspec'
 end

data/MANIFEST

@@ -1,20 +1,27 @@
 * CHANGES
 * README
 * MANIFEST
+* Gemfile
 * Rakefile
 * ptools.gemspec
 * certs/djberg96_pub.pem
 * lib/ptools.rb
-* test/test_constants.rb
-* test/test_head.rb
-* test/test_image.rb
-* test/test_nlconvert.rb
-* test/test_null.rb
-* test/test_tail.rb
-* test/test_touch.rb
-* test/test_wc.rb
-* test/test_which.rb
-* test/test_whereis.rb
-* test/img/test.gif
-* test/img/test.jpg
-* test/img/test.png
+* spec/binary_spec.rb
+* spec/constants_spec.rb
+* spec/head_spec.rb
+* spec/image_spec.rb
+* spec/nlconvert_spec.rb
+* spec/sparse_spec.rb
+* spec/tail_spec.rb
+* spec/touch_spec.rb
+* spec/wc_spec.rb
+* spec/whereis_spec.rb
+* spec/which_spec.rb
+* spec/img/test.gif
+* spec/img/test.ico
+* spec/img/test.jpg
+* spec/img/test.png
+* spec/txt/empty.txt
+* spec/txt/english.txt
+* spec/txt/english.utf16
+* spec/txt/korean.txt

data/README

@@ -47,14 +47,16 @@
 
   Thanks go to Matt Hoyle for help with the File.tail method.
 
+  And thanks to any and all contributors!
+
 == Future Plans
   Add whatever other tools people think might be useful.
    
 == License
-  Artistic 2.0
+  Artistic-2.0
     
 == Copyright
-  (C) 2003-2014 Daniel J. Berger
+  (C) 2003-2020 Daniel J. Berger
   All Rights Reserved.
     
 == Warranty

data/Rakefile

@@ -2,15 +2,16 @@ require 'rake'
 require 'rake/clean'
 require 'rake/testtask'
 require 'rbconfig'
+require 'rspec/core/rake_task'
 include RbConfig
 
 CLEAN.include("**/*.gem", "**/*.rbc", "**/*coverage*")
 
 desc 'Install the ptools package (non-gem)'
 task :install do
-   sitelibdir = CONFIG["sitelibdir"]
-   file = "lib/ptools.rb"
-   FileUtils.cp(file, sitelibdir, :verbose => true)
+  sitelibdir = CONFIG["sitelibdir"]
+  file = "lib/ptools.rb"
+  FileUtils.cp(file, sitelibdir, :verbose => true)
 end
 
 namespace 'gem' do
@@ -33,103 +34,54 @@ namespace 'gem' do
   end
 end
 
-Rake::TestTask.new do |t|
-  task :test => :clean
-  t.verbose = true
-  t.warning = true
-end
-
-namespace 'test' do
-  desc "Check test coverage using rcov"
-  task :coverage => [:clean] do
-    require 'rcov'
-    rm_rf 'coverage'
-    sh "rcov -Ilib test/test*.rb" 
+namespace 'spec' do
+  RSpec::Core::RakeTask.new(:binary) do |t|
+    t.pattern = 'spec/binary_spec.rb'
   end
 
-  Rake::TestTask.new('binary') do |t|
-    t.libs << 'test'
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_binary.rb']
+  RSpec::Core::RakeTask.new(:constants) do |t|
+    t.pattern = 'spec/constants_spec.rb'
   end
 
-  Rake::TestTask.new('constants') do |t|
-    t.libs << 'test'
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_constants.rb']
+  RSpec::Core::RakeTask.new(:head) do |t|
+    t.pattern = 'spec/head_spec.rb'
   end
 
-  Rake::TestTask.new('head') do |t|
-    t.libs << 'test'
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_head.rb']
+  RSpec::Core::RakeTask.new(:image) do |t|
+    t.pattern = 'spec/image_spec.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']
+  RSpec::Core::RakeTask.new(:nlconvert) do |t|
+    t.pattern = 'spec/nlconvert_spec.rb'
   end
 
-  Rake::TestTask.new('nlconvert') do |t|
-    t.libs << 'test'
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_nlconvert.rb']
+  RSpec::Core::RakeTask.new(:sparse) do |t|
+    t.pattern = 'spec/sparse_spec.rb'
   end
 
-  Rake::TestTask.new('null') do |t|
-    t.libs << 'test'
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_null.rb']
+  RSpec::Core::RakeTask.new(:tail) do |t|
+    t.pattern = 'spec/tail_spec.rb'
   end
 
-  Rake::TestTask.new('sparse') do |t|
-    t.libs << 'test'
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_is_sparse.rb']
+  RSpec::Core::RakeTask.new(:touch) do |t|
+    t.pattern = 'spec/touch_spec.rb'
   end
 
-  Rake::TestTask.new('tail') do |t|
-    t.libs << 'test'
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_tail.rb']
+  RSpec::Core::RakeTask.new(:wc) do |t|
+    t.pattern = 'spec/wc_spec.rb'
   end
-
-  Rake::TestTask.new('touch') do |t|
-    t.libs << 'test'
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_touch.rb']
-  end
-
-  Rake::TestTask.new('wc') do |t|
-    t.libs << 'test'
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_wc.rb']
+ 
+  RSpec::Core::RakeTask.new(:whereis) do |t|
+    t.pattern = 'spec/whereis_spec.rb'
   end
 
-  Rake::TestTask.new('whereis') do |t|
-    t.libs << 'test'
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_whereis.rb']
+  RSpec::Core::RakeTask.new(:which) do |t|
+    t.pattern = 'spec/which_spec.rb'
   end
 
-  Rake::TestTask.new('which') do |t|
-    t.libs << 'test'
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_which.rb']
+  RSpec::Core::RakeTask.new(:all) do |t|
+    t.pattern = 'spec/*_spec.rb'
   end
 end
 
-task :default => :test
+task :default => 'spec:all'

data/certs/djberg96_pub.pem

@@ -1,21 +1,26 @@
 -----BEGIN CERTIFICATE-----
-MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAhkamJl
+MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
 cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
-MB4XDTE1MDkwMjIwNDkxOFoXDTE2MDkwMTIwNDkxOFowPzERMA8GA1UEAwwIZGpi
+MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
 ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
-bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMyTkvXqRp6hLs9eoJOS
-Hmi8kRYbq9Vkf15/hMxJpotYMgJVHHWrmDcC5Dye2PbnXjTkKf266Zw0PtT9h+lI
-S3ts9HO+vaCFSMwFFZmnWJSpQ3CNw2RcHxjWkk9yF7imEM8Kz9ojhiDXzBetdV6M
-gr0lV/alUr7TNVBDngbXEfTWscyXh1qd7xZ4EcOdsDktCe5G45N/o3662tPQvJsi
-FOF0CM/KuBsa/HL1/eoEmF4B3EKIRfTHrQ3hu20Kv3RJ88QM4ec2+0dd97uX693O
-zv6981fyEg+aXLkxrkViM/tz2qR2ZE0jPhHTREPYeMEgptRkTmWSKAuLVWrJEfgl
-DtkCAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFEwe
-nn6bfJADmuIDiMSOzedOrL+xMB0GA1UdEQQWMBSBEmRqYmVyZzk2QGdtYWlsLmNv
-bTAdBgNVHRIEFjAUgRJkamJlcmc5NkBnbWFpbC5jb20wDQYJKoZIhvcNAQEFBQAD
-ggEBAHmNOCWoDVD75zHFueY0viwGDVP1BNGFC+yXcb7u2GlK+nEMCORqzURbYPf7
-tL+/hzmePIRz7i30UM//64GI1NLv9jl7nIwjhPpXpf7/lu2I9hOTsvwSumb5UiKC
-/sqBxI3sfj9pr79Wpv4MuikX1XPik7Ncb7NPsJPw06Lvyc3Hkg5X2XpPtLtS+Gr2
-wKJnmzb5rIPS1cmsqv0M9LPWflzfwoZ/SpnmhagP+g05p8bRNKjZSA2iImM/GyYZ
-EJYzxdPOrx2n6NYR3Hk+vHP0U7UBSveI6+qx+ndQYaeyCn+GRX2PKS9h66YF/Q1V
-tGSHgAmcLlkdGgan182qsE/4kKM=
+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.3'
+  PTOOLS_VERSION = '1.4.0'.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,46 +39,20 @@ 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
   # +File.blksize+ characters, or 4096, whichever is smaller.
   #
+  # By default it will check to see if more than 30 percent of the characters
+  # are non-text characters. If so, the method returns true. You can configure
+  # this percentage by passing your own as a second argument.
+  #
   # Example:
   #
   #   File.binary?('somefile.exe') # => true
@@ -87,13 +61,15 @@ class File
   # Based on code originally provided by Ryan Davis (which, in turn, is
   # based on Perl's -B switch).
   #
-  def self.binary?(file)
+  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) || "")
     s = s.encode('US-ASCII', :undef => :replace).split(//)
-    ((s.size - s.grep(" ".."~").size) / s.size.to_f) > 0.30
+    ((s.size - s.grep(" ".."~").size) / s.size.to_f) > percentage
   end
 
   # Looks for the first occurrence of +program+ within +path+.
@@ -428,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'
 
@@ -479,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,16 +1,15 @@
-require 'rubygems'
 require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name       = 'ptools'
-  spec.version    = '1.3.3'
-  spec.license    = 'Artistic 2.0'
+  spec.version    = '1.4.0'
+  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.files      = Dir['**/*'] << '.gemtest'
+  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']
@@ -22,10 +21,10 @@ Gem::Specification.new do |spec|
   EOF
 
   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