ptools 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be2c833dd51c09611f84da85481ae3b8039d427955fa951c5aab0745bef680d7
-  data.tar.gz: 612f6f1ab4cb5e605d9b1c18d26a9b35b95e798a9e9e11d54f539bb5ee1f1082
+  metadata.gz: 35f02ac0737f1acf24a7edccb33f60990b5690259fe715520eeb803badc514ae
+  data.tar.gz: 469380e8d9f7107868b0ec17e8ca7aa4c8e5e1db19a7263c88995e1346f9c634
 SHA512:
-  metadata.gz: 8ec40d7c6e2d9edb2cc0e5a41a74469d7a17d208cd67d0461963488c20f97ab06b125c17903c976c6f741f93a36612ccdd63fde6c9ac0a64671340b2dbe7d78c
-  data.tar.gz: 7cd78b2d229c8f98a7df154275d74cb0055336bac5b40368112dd83a3cf5b8ed96c3b708b5fe5cda543a263041ab2ab44fe1a656e8be70f5d4c0c36259646bb0
+  metadata.gz: 114dec925795c5ebfc3f84209602490d22d54031fede8cf9914d635c4bb4180cce1d77dcb3f87d970f491a43b307f7017a29a1239b7d23442aaa01f701d13071
+  data.tar.gz: 60b1f3ad73a5019ed89b24ae82b0032f014b8770d8feb6b447ad72f459a6029cf678fa0fe96c5e8ec23eb1dc2818a66dbbabc499d4bc8ac858c256ad786236b0

data/{CHANGES → CHANGES.md}

@@ -1,50 +1,54 @@
-== 1.4.0 - 20-Aug-2020
+## 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
+## 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
+## 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
+## 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
+## 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.
@@ -52,12 +56,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.
@@ -65,19 +69,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
@@ -85,15 +89,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'
@@ -101,7 +105,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.
@@ -113,7 +117,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.
@@ -121,35 +125,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.
@@ -158,7 +162,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).
@@ -172,12 +176,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.
@@ -187,7 +191,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.
@@ -196,5 +200,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/{MANIFEST → MANIFEST.md}

@@ -1,6 +1,6 @@
-* CHANGES
-* README
-* MANIFEST
+* CHANGES.md
+* README.md
+* MANIFEST.md
 * Gemfile
 * Rakefile
 * ptools.gemspec

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.
@@ -49,20 +51,20 @@
 
   And thanks to any and all contributors!
 
-== Future Plans
+## Future Plans
   Add whatever other tools people think might be useful.
    
-== License
+## License
   Artistic-2.0
     
-== Copyright
+## 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

@@ -5,7 +5,7 @@ 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

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.4.0'.freeze
+  PTOOLS_VERSION = '1.4.1'.freeze
 
   # :stopdoc:
 
@@ -455,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
 

data/ptools.gemspec

@@ -2,7 +2,7 @@ require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name       = 'ptools'
-  spec.version    = '1.4.0'
+  spec.version    = '1.4.1'
   spec.license    = 'Artistic-2.0'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
@@ -12,14 +12,21 @@ Gem::Specification.new do |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('rspec', '~> 3.9')
 

data/spec/constants_spec.rb

@@ -13,7 +13,7 @@ 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.0')
+    expect(File::PTOOLS_VERSION).to eq('1.4.1')
     expect(File::PTOOLS_VERSION.frozen?).to be true
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ptools
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2020-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -72,15 +72,12 @@ description: |2
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README
-- CHANGES
-- MANIFEST
+extra_rdoc_files: []
 files:
-- CHANGES
+- CHANGES.md
 - Gemfile
-- MANIFEST
-- README
+- MANIFEST.md
+- README.md
 - Rakefile
 - certs/djberg96_pub.pem
 - lib/ptools.rb
@@ -107,7 +104,13 @@ files:
 homepage: https://github.com/djberg96/ptools
 licenses:
 - Artistic-2.0
-metadata: {}
+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
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -123,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Extra methods for the File class