ptools 1.3.7 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60d8a2d183abbb54bd0140d4681625c0c6d1aec1a4f03c0de4a63ef7e6b8625e
-  data.tar.gz: 8e850bf76e10e887dd089b15a580e63dae8b32f159a7120f4bd2a4700870101c
+  metadata.gz: be2c833dd51c09611f84da85481ae3b8039d427955fa951c5aab0745bef680d7
+  data.tar.gz: 612f6f1ab4cb5e605d9b1c18d26a9b35b95e798a9e9e11d54f539bb5ee1f1082
 SHA512:
-  metadata.gz: 22ed87d408f7f324838f3cd6a88428e28fcc5fcba6356c9c40117ec08be5fbc1dd6f36a1da75cfea6bd4d1ebc8d51bb219a8cff0435c326e89b704552c8464e5
-  data.tar.gz: a7a276fc8b777a95edd4ac38cc4637fcde6567f9e321f02bc2b3b094c56556034d465bc60c9f834fd696c3b0928b9c65130ce853275b6b977b4571ec95e20b38
+  metadata.gz: 8ec40d7c6e2d9edb2cc0e5a41a74469d7a17d208cd67d0461963488c20f97ab06b125c17903c976c6f741f93a36612ccdd63fde6c9ac0a64671340b2dbe7d78c
+  data.tar.gz: 7cd78b2d229c8f98a7df154275d74cb0055336bac5b40368112dd83a3cf5b8ed96c3b708b5fe5cda543a263041ab2ab44fe1a656e8be70f5d4c0c36259646bb0

data/CHANGES

@@ -1,3 +1,7 @@
+== 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.
@@ -28,8 +32,7 @@
 * 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

@@ -6,17 +6,22 @@
 * 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
-* test/img/test.ico
+* 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

@@ -53,7 +53,7 @@
   Add whatever other tools people think might be useful.
    
 == License
-  Artistic 2.0
+  Artistic-2.0
     
 == Copyright
   (C) 2003-2020 Daniel J. Berger

data/Rakefile

@@ -2,6 +2,7 @@ require 'rake'
 require 'rake/clean'
 require 'rake/testtask'
 require 'rbconfig'
+require 'rspec/core/rake_task'
 include RbConfig
 
 CLEAN.include("**/*.gem", "**/*.rbc", "**/*coverage*")
@@ -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'

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.7'.freeze
+  PTOOLS_VERSION = '1.4.0'.freeze
 
   # :stopdoc:
 
@@ -44,36 +44,6 @@ class 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

data/ptools.gemspec

@@ -2,13 +2,13 @@ require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name       = 'ptools'
-  spec.version    = '1.3.7'
+  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.test_files = Dir['spec/_spec*']
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = ['certs/djberg96_pub.pem']
 
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   EOF
 
   spec.add_development_dependency('rake')
-  spec.add_development_dependency('test-unit')
+  spec.add_development_dependency('rspec', '~> 3.9')
 
   if File::ALT_SEPARATOR
     spec.platform = Gem::Platform.new(['universal', 'mingw32'])

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.0')
+    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