ptools 1.3.7 → 1.4.0

data/spec/which_spec.rb

@@ -0,0 +1,112 @@
+#####################################################################
+# which_spec.rb
+#
+# Test case for the File.which method. You should run this test
+# via 'rake spec' or 'rake spec --tag which'.
+#####################################################################
+require 'rspec'
+require 'rbconfig'
+require 'fileutils'
+require 'ptools'
+require 'tempfile'
+
+describe File, :which do
+  before(:context) do
+    @windows = File::ALT_SEPARATOR
+    @dir = File.join(Dir.pwd, 'tempdir')
+    @non_exe = File.join(Dir.pwd, 'tempfile')
+    @ruby = RUBY_PLATFORM.match('java') ? 'jruby' : 'ruby'
+    @ruby = 'rbx' if defined?(Rubinius)
+
+    Dir.mkdir(@dir) unless File.exist?(@dir)
+    FileUtils.touch(@non_exe)
+    File.chmod(775, @dir)
+    File.chmod(644, @non_exe)
+
+    @exe = File.join(
+      RbConfig::CONFIG['bindir'],
+      RbConfig::CONFIG['ruby_install_name']
+    )
+
+    if @windows
+      @exe.tr!('/','\\')
+      @exe << ".exe"
+    end
+  end
+
+  example "which method basic functionality" do
+    expect(File).to respond_to(:which)
+    expect{ File.which(@ruby) }.not_to raise_error
+    expect(File.which(@ruby)).to be_kind_of(String)
+  end
+
+  example "which accepts an optional path to search" do
+    expect{ File.which(@ruby, "/usr/bin:/usr/local/bin") }.not_to raise_error
+  end
+
+  example "which returns nil if not found" do
+    expect(File.which(@ruby, '/bogus/path')).to be_nil
+    expect(File.which('blahblahblah')).to be_nil
+  end
+
+  example "which handles executables without extensions on windows" do
+    skip "skipped unless MS Windows" unless @windows
+    expect(File.which('ruby')).not_to be_nil
+    expect(File.which('notepad')).not_to be_nil
+  end
+
+  example "which handles executables that already contain extensions on windows" do
+    skip "skipped unless MS Windows" unless @windows
+    expect(File.which('ruby.exe')).not_to be_nil
+    expect(File.which('notepad.exe')).not_to be_nil
+  end
+
+  example "which returns argument if an existent absolute path is provided" do
+    expect(File.which(@ruby)).to eq(@exe), "May fail on a symlink"
+  end
+
+  example "which returns nil if a non-existent absolute path is provided" do
+    expect(File.which('/foo/bar/baz/ruby')).to be_nil
+  end
+
+  example "which does not pickup files that are not executable" do
+    expect(File.which(@non_exe)).to be_nil
+  end
+
+  example "which does not pickup executable directories" do
+    expect(File.which(@dir)).to be_nil
+  end
+
+  example "which accepts a minimum of one argument" do
+    expect{ File.which }.to raise_error(ArgumentError)
+  end
+
+  example "which accepts a maximum of two arguments" do
+    expect{ File.which(@ruby, "foo", "bar") }.to raise_error(ArgumentError)
+  end
+
+  example "the second argument cannot be nil or empty" do
+    expect{ File.which(@ruby, nil) }.to raise_error(ArgumentError)
+    expect{ File.which(@ruby, '') }.to raise_error(ArgumentError)
+  end
+
+  example "resolves with with ~" do
+    skip "skipped on MS Windows" if @windows
+    begin
+      old_home = ENV['HOME']
+
+      ENV['HOME'] = Dir::Tmpname.tmpdir
+      program = Tempfile.new(['program', '.sh'])
+      File.chmod(755, program.path)
+
+      expect(File.which(File.basename(program.path), '~/')).not_to be_nil
+    ensure
+      ENV['HOME'] = old_home
+    end
+  end
+
+  after(:context) do
+    FileUtils.rm(@non_exe)
+    FileUtils.rm_rf(@dir)
+  end
+end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: ptools
 version: !ruby/object:Gem::Version
-  version: 1.3.7
+  version: 1.4.0
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,19 +52,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 description: |2
       The ptools (power tools) library provides several handy methods to
       Ruby's core File class, such as File.which for finding executables,
@@ -77,44 +77,38 @@ extra_rdoc_files:
 - CHANGES
 - MANIFEST
 files:
-- test
-- test/test_constants.rb
-- test/txt
-- test/txt/empty.txt
-- test/txt/english.utf16
-- test/txt/english.txt
-- test/txt/korean.txt
-- test/test_head.rb
-- test/test_binary.rb
-- test/img
-- test/img/test.gif
-- test/img/test.ico
-- test/img/test.jpg
-- test/img/test.png
-- test/test_image.rb
-- test/test_null.rb
-- test/test_which.rb
-- test/test_tail.rb
-- test/test_is_sparse.rb
-- test/test_nlconvert.rb
-- test/test_whereis.rb
-- test/test_touch.rb
-- test/test_wc.rb
 - CHANGES
+- Gemfile
 - MANIFEST
 - README
-- ptools.gemspec
 - Rakefile
-- certs
 - certs/djberg96_pub.pem
-- lib
 - lib/ptools.rb
-- Gemfile
+- ptools.gemspec
+- spec/binary_spec.rb
+- spec/constants_spec.rb
+- spec/head_spec.rb
+- spec/image_spec.rb
+- spec/img/test.gif
+- spec/img/test.ico
+- spec/img/test.jpg
+- spec/img/test.png
+- spec/nlconvert_spec.rb
+- spec/sparse_spec.rb
+- spec/tail_spec.rb
+- spec/touch_spec.rb
+- spec/txt/empty.txt
+- spec/txt/english.txt
+- spec/txt/english.utf16
+- spec/txt/korean.txt
+- spec/wc_spec.rb
+- spec/whereis_spec.rb
+- spec/which_spec.rb
 homepage: https://github.com/djberg96/ptools
 licenses:
 - Artistic-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,20 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Extra methods for the File class
-test_files:
-- test/test_constants.rb
-- test/test_head.rb
-- test/test_binary.rb
-- test/test_image.rb
-- test/test_null.rb
-- test/test_which.rb
-- test/test_tail.rb
-- test/test_is_sparse.rb
-- test/test_nlconvert.rb
-- test/test_whereis.rb
-- test/test_touch.rb
-- test/test_wc.rb
+test_files: []

data/test/test_binary.rb

@@ -1,74 +0,0 @@
-#####################################################################
-# test_binary.rb
-#
-# Test case for the File.binary? method. You should run this test
-# via the 'rake test_binary' task.
-#####################################################################
-require 'rubygems'
-require 'test-unit'
-require 'ptools'
-
-class TC_Ptools_Binary < Test::Unit::TestCase
-  def self.startup
-    if File::ALT_SEPARATOR
-      @@bin_file = File.join(ENV['windir'], 'notepad.exe')
-    else
-      @@bin_file = '/bin/ls'
-    end
-
-    @@dirname = File.dirname(__FILE__)
-  end
-
-  def setup
-    @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
-
-  test "File.binary? basic functionality" do
-    assert_respond_to(File, :binary?)
-    assert_nothing_raised{ File.binary?(@txt_file) }
-  end
-
-  test "File.binary? returns true for binary files" do
-    assert_true(File.binary?(@@bin_file))
-  end
-
-  test "File.binary? returns false for text files" do
-    assert_false(File.binary?(@emp_file))
-    assert_false(File.binary?(@txt_file))
-    assert_false(File.binary?(@uni_file))
-    assert_false(File.binary?(@utf_file))
-  end
-
-  test "File.binary? returns false for image files" do
-    assert_false(File.binary?(@png_file))
-    assert_false(File.binary?(@jpg_file))
-    assert_false(File.binary?(@gif_file))
-  end
-
-  test "File.binary? accepts an optional percentage argument" do
-    assert_false(File.binary?(@txt_file, 0.50))
-    assert_true(File.binary?(@txt_file, 0.05))
-  end
-
-  test "File.binary? raises an error if the file cannot be found" do
-    assert_raise_kind_of(SystemCallError){ File.binary?('bogus') }
-  end
-
-  test "File.binary? only accepts one argument" do
-    assert_raise_kind_of(ArgumentError){ File.binary?(@txt_file, @@bin_file) }
-  end
-
-  def teardown
-    @txt_file = nil
-    @uni_file = nil
-    @png_file = nil
-    @jpg_file = nil
-    @gif_file = nil
-  end
-end

data/test/test_constants.rb

@@ -1,39 +0,0 @@
-#####################################################################
-# test_constants.rb
-#
-# Tests the constants that have been defined for our package. This
-# test case should be run via the 'rake test_constants' task.
-#####################################################################
-require 'rubygems'
-require 'test-unit'
-require 'rbconfig'
-require 'ptools'
-
-class TC_Ptools_Constants < Test::Unit::TestCase
-  def self.startup
-    @@windows = File::ALT_SEPARATOR
-  end
-
-  test "PTOOLS_VERSION constant is set to expected value" do
-    assert_equal('1.3.7', File::PTOOLS_VERSION)
-    assert_true(File::PTOOLS_VERSION.frozen?)
-  end
-
-  test "IMAGE_EXT constant is set to array of values" do
-    assert_equal(%w[.bmp .gif .jpeg .jpg .png], File::IMAGE_EXT.sort)
-  end
-
-  test "WINDOWS constant is defined on MS Windows" do
-    omit_unless(@@windows, "Skipping on Unix systems")
-    assert_not_nil(File::MSWINDOWS)
-  end
-
-  test "WIN32EXTS constant is defined on MS Windows" do
-    omit_unless(@@windows, "Skipping on Unix systems")
-    assert_not_nil(File::WIN32EXTS)
-  end
-
-  def self.shutdown
-    @@windows = nil
-  end
-end

data/test/test_head.rb

@@ -1,48 +0,0 @@
-######################################################################
-# test_head.rb
-#
-# Test case for the File.head method. This test should be run via
-# the 'rake test_head' task.
-######################################################################
-require 'test-unit'
-require 'ptools'
-
-class TC_FileHead < Test::Unit::TestCase
-  def self.startup
-    Dir.chdir('test') if File.exist?('test')
-    File.open('test_file1.txt', 'w'){ |fh| 25.times{ |n| fh.puts "line#{n+1}" } }
-  end
-
-  def setup
-    @test_file = 'test_file1.txt'
-    @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
-
-  def test_head_basic
-    assert_respond_to(File, :head)
-    assert_nothing_raised{ File.head(@test_file) }
-    assert_nothing_raised{ File.head(@test_file, 5) }
-    assert_nothing_raised{ File.head(@test_file){} }
-  end
-
-  def test_head_expected_results
-    assert_kind_of(Array, File.head(@test_file))
-    assert_equal(@expected_head1, File.head(@test_file))
-    assert_equal(@expected_head2, File.head(@test_file, 5))
-  end
-
-  def test_head_expected_errors
-    assert_raises(ArgumentError){ File.head(@test_file, 5, "foo") }
-    assert_raises(Errno::ENOENT){ File.head("bogus") }
-  end
-
-  def teardown
-    @test_file = nil
-  end
-
-  def self.shutdown
-    File.delete('test_file1.txt') if File.exist?('test_file1.txt')
-  end
-end

data/test/test_image.rb

@@ -1,62 +0,0 @@
-#####################################################################
-# test_image.rb
-#
-# Test case for the File.image? method. You should run this test
-# via the 'rake test:image' task.
-#####################################################################
-require 'test-unit'
-require 'ptools'
-
-class TC_Ptools_Image < Test::Unit::TestCase
-  def self.startup
-    Dir.chdir('test') if File.exist?('test')
-  end
-
-  def setup
-    @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
-
-  test "image? method basic functionality" do
-    assert_respond_to(File, :image?)
-    assert_nothing_raised{ File.image?(@txt_file) }
-    assert_boolean(File.image?(@txt_file))
-  end
-
-  test "image? method returns false for a text file" do
-    assert_false(File.image?(@txt_file))
-    assert_false(File.image?(@uni_file))
-  end
-
-  test "image? method returns true for a gif" do
-    assert_true(File.image?(@gif_file))
-  end
-
-  test "image? method returns true for a jpeg" do
-    assert_true(File.image?(@jpg_file))
-  end
-
-  test "image? method returns true for a png" do
-    assert_true(File.image?(@png_file))
-  end
-
-  test "image? method returns true for an ico" do
-    assert_true(File.image?(@ico_file))
-  end
-
-  test "image? method raises an error if the file does not exist" do
-    assert_raises(Errno::ENOENT, ArgumentError){ File.image?('bogus') }
-  end
-
-  def teardown
-    @txt_file = nil
-    @uni_file = nil
-    @jpg_file = nil
-    @png_file = nil
-    @gif_file = nil
-  end
-end