ptools 1.3.3 → 1.4.0

data/spec/touch_spec.rb

@@ -0,0 +1,47 @@
+#####################################################################
+# test_touch.rb
+#
+# Test case for the File.touch method. This test should be run
+# via the 'rake test_touch task'.
+#####################################################################
+require 'rspec'
+require 'ptools'
+
+RSpec.describe File, :touch do
+  let(:dirname) { File.dirname(__FILE__) }
+  let(:filename) { 'test_file_touch.txt' }
+  let(:xfile) { File.join(dirname, filename) }
+
+  before do
+    File.open(xfile, 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
+    @test_file = File.join(dirname, 'delete.this')
+  end
+
+  example "touch basic functionality" do
+    expect(File).to respond_to(:touch)
+    expect{ File.touch(@test_file) }.not_to raise_error
+  end
+
+  example "touch a new file returns expected results" do
+    expect(File.touch(@test_file)).to eq(File)
+    expect(File.exist?(@test_file)).to be true
+    expect(File.size(@test_file)).to eq(0)
+  end
+
+  example "touch an existing file returns expected results" do
+    stat = File.stat(xfile)
+    sleep 0.5
+    expect{ File.touch(xfile) }.not_to raise_error
+    expect(File.size(xfile) == stat.size).to be true
+    expect(File.mtime(xfile) == stat.mtime).to be false
+  end
+
+  example "touch requires an argument" do
+    expect{ File.touch }.to raise_error(ArgumentError)
+  end
+
+  after do
+    File.delete(@test_file) if File.exist?(@test_file)
+    File.delete(xfile) if File.exist?(xfile)
+  end
+end

data/spec/wc_spec.rb

@@ -0,0 +1,65 @@
+#####################################################################
+# wc_spec.rb
+#
+# Specs for the File.wc method. These specs should be run via
+# the 'rake wc' task.
+#####################################################################
+require 'rspec'
+require 'ptools'
+
+RSpec.describe File, :wc do
+  let(:test_file) { 'test_file_wc.txt' }
+
+  before do
+    File.open(test_file, 'w'){ |fh| 25.times{ |n| fh.puts "line#{n+1}" } }
+  end
+
+  example "wc method basic functionality" do
+    expect(File).to respond_to(:wc)
+    expect{ File.wc(test_file) }.not_to raise_error
+  end
+
+  example "wc accepts specific optional arguments" do
+    expect{ File.wc(test_file, 'bytes') }.not_to raise_error
+    expect{ File.wc(test_file, 'chars') }.not_to raise_error
+    expect{ File.wc(test_file, 'words') }.not_to raise_error
+    expect{ File.wc(test_file, 'lines') }.not_to raise_error
+  end
+
+  example "argument to wc ignores the case of the option argument" do
+    expect{ File.wc(test_file, 'LINES') }.not_to raise_error
+  end
+
+  example "wc with no option returns expected results" do
+    expect(File.wc(test_file)).to be_kind_of(Array)
+    expect(File.wc(test_file)).to eq([166, 166, 25, 25])
+  end
+
+  example "wc with bytes option returns the expected result" do
+    expect(File.wc(test_file, 'bytes')).to eq(166)
+  end
+
+  example "wc with chars option returns the expected result" do
+    expect(File.wc(test_file, 'chars')).to eq(166)
+  end
+
+  example "wc with words option returns the expected result" do
+    expect(File.wc(test_file, 'words')).to eq(25)
+  end
+
+  example "wc with lines option returns the expected result" do
+    expect(File.wc(test_file, 'lines')).to eq(25)
+  end
+
+  example "wc requires at least on argument" do
+    expect{ File.wc }.to raise_error(ArgumentError)
+  end
+
+  example "an invalid option raises an error" do
+    expect{ File.wc(test_file, 'bogus') }.to raise_error(ArgumentError)
+  end
+
+  after do
+    File.delete(test_file) if File.exists?(test_file)
+  end
+end

data/spec/whereis_spec.rb

@@ -0,0 +1,87 @@
+######################################################################
+# test_whereis.rb
+#
+# Tests for the File.whereis method.
+######################################################################
+require 'rubygems'
+require 'rspec'
+require 'ptools'
+require 'rbconfig'
+
+RSpec.describe File, :whereis do
+  let(:windows) { File::ALT_SEPARATOR }
+  let(:ruby) { RUBY_ENGINE }
+  let(:bin_dir) { RbConfig::CONFIG['bindir'] }
+
+  before do
+    @expected_locs = [File.join(bin_dir, ruby)]
+
+    if windows
+      @expected_locs[0] << '.exe'
+      @expected_locs[0].tr!("/", "\\")
+    end
+
+    unless windows
+      @expected_locs << "/usr/local/bin/#{ruby}"
+      @expected_locs << "/opt/sfw/bin/#{ruby}"
+      @expected_locs << "/opt/bin/#{ruby}"
+      @expected_locs << "/usr/bin/#{ruby}"
+    end
+
+    @actual_locs = nil
+  end
+
+  example "whereis basic functionality" do
+    expect(File).to respond_to(:whereis)
+    expect{ File.whereis('ruby') }.not_to raise_error
+    expect(File.whereis('ruby')).to be_kind_of(Array).or be_nil
+  end
+
+  example "whereis accepts an optional second argument" do
+    expect{ File.whereis('ruby', '/usr/bin:/usr/local/bin') }.not_to raise_error
+  end
+
+  example "whereis returns expected values" do
+    expect{ @actual_locs = File.whereis(ruby) }.not_to raise_error
+    expect(@actual_locs).to be_kind_of(Array)
+    expect((@expected_locs & @actual_locs).size > 0).to be true
+  end
+
+  example "whereis returns nil if program not found" do
+    expect(File.whereis('xxxyyy')).to be_nil
+  end
+
+  example "whereis returns nil if program cannot be found in provided path" do
+    expect(File.whereis(ruby, '/foo/bar')).to be_nil
+  end
+
+  example "whereis returns single element array or nil if absolute path is provided" do
+    absolute = File.join(bin_dir, ruby)
+    absolute << '.exe' if windows
+
+    expect(File.whereis(absolute)).to eq([absolute])
+    expect(File.whereis("/foo/bar/baz/#{ruby}")).to be_nil
+  end
+
+  example "whereis works with an explicit extension on ms windows" do
+    skip "skipped unless MS Windows" unless windows
+    expect(File.whereis(ruby + '.exe')).not_to be_nil
+  end
+
+  example "whereis requires at least one argument" do
+    expect{ File.whereis }.to raise_error(ArgumentError)
+  end
+
+  example "whereis returns unique paths only" do
+    expect(File.whereis(ruby) == File.whereis(ruby).uniq).to be true
+  end
+
+  example "whereis accepts a maximum of two arguments" do
+    expect{ File.whereis(ruby, 'foo', 'bar') }.to raise_error(ArgumentError)
+  end
+
+  example "the second argument to whereis cannot be nil or empty" do
+    expect{ File.whereis(ruby, nil) }.to raise_error(ArgumentError)
+    expect{ File.whereis(ruby, '') }.to raise_error(ArgumentError)
+  end
+end

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,36 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: ptools
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----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-----
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -47,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: 2.5.0
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.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,
@@ -72,7 +77,6 @@ extra_rdoc_files:
 - CHANGES
 - MANIFEST
 files:
-- ".gemtest"
 - CHANGES
 - Gemfile
 - MANIFEST
@@ -81,28 +85,30 @@ files:
 - certs/djberg96_pub.pem
 - lib/ptools.rb
 - ptools.gemspec
-- test/img/test.gif
-- test/img/test.jpg
-- test/img/test.png
-- test/test_binary.rb
-- test/test_constants.rb
-- test/test_head.rb
-- test/test_image.rb
-- test/test_is_sparse.rb
-- test/test_nlconvert.rb
-- test/test_null.rb
-- test/test_tail.rb
-- test/test_touch.rb
-- test/test_wc.rb
-- test/test_whereis.rb
-- test/test_which.rb
-- test/txt/english.txt
-- test/txt/korean.txt
+- 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
+- Artistic-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -117,21 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Extra methods for the File class
-test_files:
-- test/test_binary.rb
-- test/test_constants.rb
-- test/test_head.rb
-- test/test_image.rb
-- test/test_is_sparse.rb
-- test/test_nlconvert.rb
-- test/test_null.rb
-- test/test_tail.rb
-- test/test_touch.rb
-- test/test_wc.rb
-- test/test_whereis.rb
-- test/test_which.rb
+test_files: []