ptools 1.3.5 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d84987b222f9b080bd61559d152790acfc5c17c9
-  data.tar.gz: 05f9fbe563ca0e70cdbe4983a43e0ae1132c8ee9
+SHA256:
+  metadata.gz: 36406684b5e92604183390f36512e57d842143d4f7cdc29f9f728cb8085c99f6
+  data.tar.gz: 736ef4ab5f6ff12ec22e4158eeb09f1a5d3db94f969ae4991ac7732fa2d4b0e5
 SHA512:
-  metadata.gz: dd49ca3dee0986e8f9d287de7fbfcad81492858b556a678692ff3510fd5400928b44b84b8fb701d13c40b3f34953ca213c849709f0c8666aacad6a8b2001314e
-  data.tar.gz: b0d5eb2e3b457c4d9ff23866b385e209c46e8f8b394ba0c29d45520b906b09173fb14dbdc436f344f8e65b7236b842277a9ba61d1f28dc746c36b5f6f8c891ad
+  metadata.gz: 872ba6353a2e52e845bb2b2e6b1fced1e334873b5da3edcd9764d481f4db1434b07d8b85e5e60e222e467b9ca67e36b019aac639a172c414f64398a1a29cf463
+  data.tar.gz: b38ac907b048d378c89807fae43e3a6d5c38e2f34b3afbfbacd333cb0860393e2be4faab59bcb0f800cb2f02f49e5110b05fc21b6a870ce2f2829560fdf1759e

data/{CHANGES → CHANGES.md}

@@ -1,34 +1,62 @@
-== 1.3.5 - 3-Sep-2017
+## 1.4.2 - 6-Jan-2021
+* Fixed a private access modifier that wasn't actually working as intended.
+* Two Windows constants that were never meant for public consumption have been marked private.
+* Minor tweak to one of the touch specs.
+* The Gemfile now just uses the gemspec.
+* The image? singleton method was effectively ignoring filename extensions. This
+  has been fixed, though with the option to disable that check if desired.
+
+## 1.4.1 - 29-Dec-2020
+* Switch from rdoc to markdown since github is not rendering rdoc properly.
+* Added metadata to gemspec.
+
+## 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
+## 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
+## 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.
+## 1.3.2 - 11-Dec-2014
+* 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
+## 1.3.1 - 9-Dec-2014
 * Fixed some potential issues with File.tail. Thanks go to Matt Hoyle for
   the patch.
 
-== 1.3.0 - 8-Dec-2014
+## 1.3.0 - 8-Dec-2014
 * Made the File.tail method efficient. It's no longer slurpy, and it also no
   longer includes line endings in the result.
 * Removed the File.middle method. I don't think it's useful.
 
-== 1.2.7 - 6-Dec-2014
+## 1.2.7 - 6-Dec-2014
 * File.which now expands ~ for paths. Thanks go to dg-vrnetze for the patch.
 * Use /dev/null for cygwin instead of NUL.
 * Use mv instead of cp in the nl_convert method.
@@ -36,12 +64,12 @@
 * Modified the binary? method to check 4096 bytes at most.
 * Thanks to Matt Hoyle for many of the changes implemented in this release.
 
-== 1.2.6 - 14-Jul-2014
+## 1.2.6 - 14-Jul-2014
 * Updated the png? and jpg? methods so they explicitly specify the
   offset argument so that it works with 1.9.2 and earlier. Thanks go to
   Anurag Priyam for the spot.
 
-== 1.2.5 - 11-Jul-2014
+## 1.2.5 - 11-Jul-2014
 * Added a Gemfile, mostly for Travis CI.
 * Added rake as a development dependency.
 * Revert back to hash syntax supported by 1.8.x.
@@ -49,19 +77,19 @@
 * Updated the tests for File.sparse? so that it doesn't rely on
   an external file.
 
-== 1.2.4 - 25-Feb-2014
+## 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
+## 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.
 * Updated the win32-file and test-unit dependencies.
 * Replace all instances of File.exists? with File.exist? because the former
   is deprecated in Ruby 2.1 and later.
 
-== 1.2.2 - 6-Apr-2012
+## 1.2.2 - 6-Apr-2012
 * Yet another sparse file test fix for OSX, which does not support
   sparse file generation on HFS+.
 * Fixed a bug in the File.whereis method on Windows when dealing with
@@ -69,15 +97,15 @@
 * Some Config vs RbConfig fixes to silence 1.9.3 warnings.
 * Refactored and cleaned up some tests.
 
-== 1.2.1 - 20-May-2011
+## 1.2.1 - 20-May-2011
 * Added an (empty) .gemtest file so that it can be used with test.rubygems.org.
 * Fixed a sparse file test.
 
-== 1.2.0 - 8-Jan-2011
+## 1.2.0 - 8-Jan-2011
 * Added the File.sparse? method for Unix platforms. This method already
   exists on Windows courtesy of the win32-file library.
 
-== 1.1.9 - 25-Mar-2010
+## 1.1.9 - 25-Mar-2010
 * Refactored File.which and File.whereis and added additional tests for each.
 * Removed the block form of File.whereis.
 * Reorganized the Rakefile a bit and put the test tasks under the 'test'
@@ -85,7 +113,7 @@
 * Updated the test-unit development dependency.
 * Updates the README.
 
-== 1.1.8 - 6-Oct-2009
+## 1.1.8 - 6-Oct-2009
 * Fixed some bad variable names that crept into the File.nl_convert method.
 * Added the File.null_device alias for File.null.
 * Added cygwin and mingw to Windows detection code.
@@ -97,7 +125,7 @@
 * Documentation updates.
 * Added the :gem rake task.
 
-== 1.1.7 - 28-Jul-2009
+## 1.1.7 - 28-Jul-2009
 * Now compatible with Ruby 1.9.x.
 * Replaced RUBY_PLATFORM with rbconfig check for the sake of other
   implementations, such as JRuby.
@@ -105,35 +133,35 @@
 * Added Test::Unit 2.x as a development dependency.
 * Renamed the test files.
 
-== 1.1.6 - 31-Aug-2007
+## 1.1.6 - 31-Aug-2007
 * Fixed the File.touch method so that it doesn't whack existing files. Thanks
   go to Thomas Preymesser for the spot.
 * Added corresponding tests to the tc_touch.rb file.
 
-== 1.1.5 - 19-Jul-2007
+## 1.1.5 - 19-Jul-2007
 * Added the File.image? method. Inspired by ruby-talk: 260487. 
 
-== 1.1.4 - 21-May-2007
+## 1.1.4 - 21-May-2007
 * Removed the install.rb file. Installation is now handled exclusively by the
   rake install task.
 * Updated the MANIFEST file, and made it rdoc friendly.
 * Manual installation corrections in the README file.
 
-== 1.1.3 - 29-Apr-2007
+## 1.1.3 - 29-Apr-2007
 * I changed the way that the constants IS_WINDOWS and WIN32EXTS are defined.
 * The IS_WINDOWS and WIN32EXTS are no long documented publically. They were
   never meant for public use.
 * The tc_constants.rb file was modified to only run certain tests on Windows.
 
-== 1.1.2 - 28-Apr-2007
+## 1.1.2 - 28-Apr-2007
 * Fixed a require line that could cause problems on MS Windows.
 * Added a Rakefile which includes tasks for installation and testing.
 * Some cleanup and improvement in the various test files.
 
-== 1.1.1 - 24-Aug-2006
+## 1.1.1 - 24-Aug-2006
 * Added the File.binary? method, based on code from Ryan Davis.
 
-== 1.1.0 - 23-Aug-2006
+## 1.1.0 - 23-Aug-2006
 * Added the File.null method which returns the bit bucket on your platform.
 * The suffixes on MS Windows are now based on the PATHEXT environment variable,
   and defaults to '.com', '.bat' and '.exe' only if it's not defined.
@@ -142,7 +170,7 @@
 * Modified the platform checking and path separator handling.
 * Added and tweaked some tests.
 
-== 1.0.0 - 2-Jun-2005
+## 1.0.0 - 2-Jun-2005
 * Modified the File.middle method to accept an optional block.
 * File.whereis is now limited to unique values so that redundant PATH entries
   do not cause redundant entries in the returned array (or block).
@@ -156,12 +184,12 @@
 * Removed the INSTALL file.  See the README instead.
 * Moved project to RubyForge.
 
-== 0.1.3 - 5-Dec-2003
+## 0.1.3 - 5-Dec-2003
 * Modified File#which and File#whereis for Win32 to handle extensions better,
   i.e. you can send "ruby" or "ruby.exe" and get back the same result.
 * Minor test changes to tc_which.rb and tc_whereis.rb.
 
-== 0.1.2 - 14-May-2003
+## 0.1.2 - 14-May-2003
 * Modified nl_convert() to allow the destination filename to be the same as the
   source file.  In that case, a tempfile is used and copied back over the
   original file.
@@ -171,7 +199,7 @@
 * Test suite additions/fixes.
 * Updates to MANIFEST.
 
-== 0.1.1 - 21-Mar-2003
+## 0.1.1 - 21-Mar-2003
 * Modified File.tail to return data in the same order that 'tail' does.
 * Modified File.which to return nil if the program is not found.
 * Modified File.whereis now uses '\' instead of '/' on MS Windows.
@@ -180,5 +208,5 @@
 * Thanks go to Shanko for both the spot and patch for tail, which, whereis
   and middle.
 
-== 0.1.0 - 18-Mar-2003
+## 0.1.0 - 18-Mar-2003
 * Initial release

data/Gemfile

@@ -1,12 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'structured_warnings'
-
-group :production do
-  gem 'win32-file' if File::ALT_SEPARATOR
-end
-
-group :test do
-  gem 'rake'
-  gem 'test-unit'
-end
+gemspec

data/MANIFEST.md

@@ -0,0 +1,27 @@
+* CHANGES.md
+* README.md
+* MANIFEST.md
+* Gemfile
+* Rakefile
+* ptools.gemspec
+* certs/djberg96_pub.pem
+* lib/ptools.rb
+* 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 → README.md}

@@ -1,32 +1,34 @@
-== Description
+## Description
   The ptools (power tools) library is an additional set of commands for the
   File class based on Unix command line tools.
    
-== Prerequisites
+## Prerequisites
   On MS Windows you will need the win32-file gem.
 
-== Installation
-  gem install ptools
+## Installation
+`gem install ptools`
 
-== Synopsis
-  require "ptools"
+## Synopsis
+```ruby
+require "ptools"
 
-  File.which("ruby")         # '/usr/local/bin/ruby'
-  File.whereis("ruby")       # ['/usr/local/bin/ruby','/opt/bin/ruby']
+File.which("ruby")         # '/usr/local/bin/ruby'
+File.whereis("ruby")       # ['/usr/local/bin/ruby','/opt/bin/ruby']
 
-  File.head("myfile")        # Returns first 10 lines of 'myfile'
-  File.tail("myfile",3)      # Returns last 3 lines of 'myfile'
-  File.wc("myfile",'words')  # Returns the number of words in 'myfile'
+File.head("myfile")        # Returns first 10 lines of 'myfile'
+File.tail("myfile",3)      # Returns last 3 lines of 'myfile'
+File.wc("myfile",'words')  # Returns the number of words in 'myfile'
 
-  File.touch("newfile")      # "newfile" now exists
-  File.null                  # '/dev/null' on Unix, 'NUL' on Windows
-  File.binary?('some_file')  # true or false
-  File.sparse?('some_file')  # true or false
+File.touch("newfile")      # "newfile" now exists
+File.null                  # '/dev/null' on Unix, 'NUL' on Windows
+File.binary?('some_file')  # true or false
+File.sparse?('some_file')  # true or false
 
-  # Creates a copy of 'myfile' called 'newfile', in DOS format
-  File.nl_convert("myfile", "newfile", "dos")
+# Creates a copy of 'myfile' called 'newfile', in DOS format
+File.nl_convert("myfile", "newfile", "dos")
+```
    
-== Known Bugs
+## Known Bugs
   The File.which and File.whereis methods may fail when using JRuby on Windows.
   See https://github.com/jruby/jruby/issues/2291 for details.
 
@@ -34,7 +36,7 @@
 
   http://www.github.com/djberg96/ptools
 
-== Acknowledgements
+## Acknowledgements
   The File.which method was originally adopted from the FileWhich code posted
   by Michael Granger on the now defunct rubygarden.org website. That code was
   later replaced by a version based on the ruby-which library.
@@ -47,20 +49,22 @@
 
   Thanks go to Matt Hoyle for help with the File.tail method.
 
-== Future Plans
+  And thanks to any and all contributors!
+
+## Future Plans
   Add whatever other tools people think might be useful.
    
-== License
-  Artistic 2.0
+## License
+  Artistic-2.0
     
-== Copyright
-  (C) 2003-2014 Daniel J. Berger
+## Copyright
+  (C) 2003-2020 Daniel J. Berger
   All Rights Reserved.
     
-== Warranty
+## Warranty
   This package is provided "as is" and without any express or
   implied warranties, including, without limitation, the implied
   warranties of merchantability and fitness for a particular purpose.
 
-== Author
+## Author
   Daniel J. Berger

data/Rakefile

@@ -2,9 +2,10 @@ require 'rake'
 require 'rake/clean'
 require 'rake/testtask'
 require 'rbconfig'
+require 'rspec/core/rake_task'
 include RbConfig
 
-CLEAN.include("**/*.gem", "**/*.rbc", "**/*coverage*")
+CLEAN.include("**/*.gem", "**/*.rbc", "**/*coverage*", "**/*.lock")
 
 desc 'Install the ptools package (non-gem)'
 task :install do
@@ -19,7 +20,7 @@ namespace 'gem' do
     require 'rubygems/package'
     spec = eval(IO.read('ptools.gemspec'))
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
+    Gem::Package.build(spec)
   end
 
   desc 'Install the ptools gem'
@@ -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'