ptools 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0041b6df231b056f194bffcee580248797c341c5
-  data.tar.gz: 196e358a536fa6b2d7bc6243c3fe4d320c65860a
+  metadata.gz: 567b8c9e88bdaed3107c8248a607801686db5ef0
+  data.tar.gz: d6ea99f75c65ec236c1606d856a729f9b26b1659
 SHA512:
-  metadata.gz: a611871af4c407b0ca637d1aa1a9e76854813a9ba52219a4abc97ac806d1af1e78e26fabc877abb97d099d7fa3a5d4fcfa6e083ec3e54a8eeb012410fb75fe17
-  data.tar.gz: 11d52f61ad1fc09fabb0c0c5a2006db4c917df704dc9c7252d3d41567762697fcb48bae93842c0f9c90a855286eed80f7224cdafd39e658923a7d1828b8f1859
+  metadata.gz: 210ee8e720a6cf80f8136ff7fb951d24ec7c58880d666a12118e4bc7f85b9daeeba7892a71dbb56f46c81ebf36cb61da2d6d09604399073a1afb45b8f13d6441
+  data.tar.gz: 3e1f8324bd844ade8ca6dffe4d3b5df19382db1243c27f3278594276365cf25373102f26e909eadb264b306cfcda070bf1e899ed9773eebfaa90f1b9f793aefc

data/CHANGES

@@ -1,3 +1,8 @@
+== 1.3.2 - 11-Dec-2014
+* Update to the File.tail method that deals prevents potential line ending
+  issues in JRuby.
+* Added known issues with JRuby to the README.
+
 == 1.3.1 - 9-Dec-2014
 * Fixed some potential issues with File.tail. Thanks go to Matt Hoyle for
   the patch.

data/README

@@ -3,7 +3,7 @@
   File class based on Unix command line tools.
    
 == Prerequisites
-  On MS Windows you will need win32-file 0.5.4 or later.
+  On MS Windows you will need the win32-file gem.
 
 == Installation
   gem install ptools
@@ -27,7 +27,10 @@
   File.nl_convert("myfile", "newfile", "dos")
    
 == Known Bugs
-  None known. Please report any bugs on the github project page.
+  The File.which and File.whereis methods may fail when using JRuby on Windows.
+  See https://github.com/jruby/jruby/issues/2291 for details.
+
+  Please report any other issues on the github project page.
 
   http://www.github.com/djberg96/ptools
 
@@ -42,6 +45,8 @@
   The binary?() method was based almost entirely on a blog post by Ryan
   Davis (who, in turn, based his code on Perl's -B switch).
 
+  Thanks go to Matt Hoyle for help with the File.tail method.
+
 == Future Plans
   Add whatever other tools people think might be useful.
    

data/Rakefile

@@ -29,7 +29,11 @@ namespace 'gem' do
   desc 'Install the ptools gem'
   task :install => [:create] do
     file = Dir["*.gem"].first
-    sh "gem install -l #{file}"
+    if RUBY_PLATFORM == 'java'
+      sh "jruby -S gem install -l #{file}"
+    else
+      sh "gem install -l #{file}"
+    end
   end
 end
 
@@ -75,13 +79,6 @@ namespace 'test' do
     t.test_files = FileList['test/test_image.rb']
   end
 
-  Rake::TestTask.new('middle') do |t|
-    t.libs << 'test'
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_middle.rb']
-  end
-
   Rake::TestTask.new('nlconvert') do |t|
     t.libs << 'test'
     t.verbose = true

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.1'
+  PTOOLS_VERSION = '1.3.2'
 
   # :stopdoc:
 
@@ -247,6 +247,10 @@ class File
   # If you're looking for tail -f functionality, please use the file-tail
   # gem instead.
   #
+  #--
+  # Internally I'm using a 64 chunk of memory at a time. I may allow the size
+  # to be configured in the future as an optional 3rd argument.
+  #
   def self.tail(filename, num_lines=10)
     tail_size = 2**16 # 64k chunks
 
@@ -255,24 +259,26 @@ class File
     file_size  = File.size(filename)
     read_bytes = file_size % tail_size
     read_bytes = tail_size if read_bytes == 0
-    line_sep   = File::ALT_SEPARATOR ? "\r\n" : "\n"
+
+    line_sep = File::ALT_SEPARATOR ? "\r\n" : "\n"
 
     buf = ''
 
-    File.open(filename){ |fh|
-      # Set the starting read position
-      position   = file_size - read_bytes
-      
+    # Open in binary mode to ensure line endings aren't converted.
+    File.open(filename, 'rb'){ |fh|
+      position = file_size - read_bytes # Set the starting read position
+
       # Loop until we have the lines or run out of file
       while buf.scan(line_sep).size <= num_lines and position >= 0
         fh.seek(position, IO::SEEK_SET)
         buf = fh.read(read_bytes) + buf
         read_bytes = tail_size
-        position  -= read_bytes
+        position -= read_bytes
       end
     }
 
     lines = buf.split(line_sep).pop(num_lines)
+
     if block_given?
       lines.each{ |line| yield line  }
     else

data/ptools.gemspec

@@ -3,7 +3,7 @@ require 'rbconfig'
 
 Gem::Specification.new do |gem|
   gem.name       = 'ptools'
-  gem.version    = '1.3.1'
+  gem.version    = '1.3.2'
   gem.license    = 'Artistic 2.0'
   gem.author     = 'Daniel J. Berger'
   gem.email      = 'djberg96@gmail.com'

data/test/test_binary.rb

@@ -16,15 +16,15 @@ class TC_Ptools_Binary < Test::Unit::TestCase
       @@bin_file = '/bin/ls'
     end
 
-    Dir.chdir('test') if File.exist?('test')
+    @@dirname = File.dirname(__FILE__)
   end
 
   def setup
-    @txt_file = File.join('txt', 'english.txt')
-    @uni_file = File.join('txt', 'korean.txt')
-    @png_file = File.join('img', 'test.png')
-    @jpg_file = File.join('img', 'test.jpg')
-    @gif_file = File.join('img', 'test.gif')
+    @txt_file = File.join(@@dirname, 'txt', 'english.txt')
+    @uni_file = File.join(@@dirname, 'txt', 'korean.txt')
+    @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

data/test/test_constants.rb

@@ -15,7 +15,7 @@ class TC_Ptools_Constants < Test::Unit::TestCase
   end
 
   test "PTOOLS_VERSION constant is set to expected value" do
-    assert_equal('1.3.1', File::PTOOLS_VERSION)
+    assert_equal('1.3.2', File::PTOOLS_VERSION)
   end
 
   test "IMAGE_EXT constant is set to array of values" do

data/test/test_nlconvert.rb

@@ -10,18 +10,18 @@ require 'ptools'
 
 class TC_Ptools_NLConvert < Test::Unit::TestCase
   def self.startup
-    Dir.chdir('test') if File.exist?('test')
-    @@test_file1 = 'test_nl_convert1.txt'
-    @@test_file2 = 'test_nl_convert2.txt'
+    @@dirname = File.dirname(__FILE__)
+    @@test_file1 = File.join(@@dirname, 'test_nl_convert1.txt')
+    @@test_file2 = File.join(@@dirname, 'test_nl_convert2.txt')
     File.open(@@test_file1, 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
     File.open(@@test_file2, 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
   end
 
   def setup
-    @test_file1 = 'test_nl_convert1.txt'
-    @test_file2 = 'test_nl_convert2.txt'
-    @dos_file   = 'dos_test_file.txt'
-    @mac_file   = 'mac_test_file.txt'
+    @test_file1 = File.join(@@dirname, 'test_nl_convert1.txt')
+    @test_file2 = File.join(@@dirname, 'test_nl_convert2.txt')
+    @dos_file   = File.join(@@dirname, 'dos_test_file.txt')
+    @mac_file   = File.join(@@dirname, 'mac_test_file.txt')
     @unix_file  = 'nix_test_file.txt'
   end
 
@@ -35,7 +35,7 @@ class TC_Ptools_NLConvert < Test::Unit::TestCase
     assert_equal( "\cM",    File.nl_for_platform('mac') )
     assert_nothing_raised{ File.nl_for_platform('local') }
   end
-  
+
   test "nl_convert basic functionality" do
     assert_respond_to(File, :nl_convert)
   end

data/test/test_tail.rb

@@ -9,48 +9,53 @@ require 'ptools'
 
 class TC_FileTail < Test::Unit::TestCase
   def self.startup
+    @@dirname = File.dirname(__FILE__)
 
-    Dir.chdir('test') if File.exist?('test')
+    @@test_file1   = File.join(@@dirname, 'test_file1.txt')
+    @@test_file64  = File.join(@@dirname, 'test_file64.txt')
+    @@test_file128 = File.join(@@dirname, 'test_file128.txt')
 
-    File.open('test_file1.txt', 'w'){ |fh| 
+    @@test_file_trail = File.join(@@dirname, 'test_file_trail.txt')
+    @@test_file_trail_nl = File.join(@@dirname, 'test_file_trail_nl.txt')
+
+    File.open(@@test_file1, 'w'){ |fh|
       25.times{ |n| fh.puts "line#{n+1}" }
     }
 
     # Trailing newline test
-    File.open('test_file_trail.txt', 'w'){ |fh| 
+    File.open(@@test_file_trail, 'w'){ |fh|
       2.times{ |n| fh.puts "trail#{n+1}" }
       fh.write "trail3"
     }
-    File.open('test_file_trail_nl.txt', 'w'){ |fh| 
+    File.open(@@test_file_trail_nl, 'w'){ |fh|
       3.times{ |n| fh.puts "trail#{n+1}" }
     }
 
     # Larger files
     test_tail_fmt_str = "line data data data data data data data %5s"
 
-    File.open('test_file64.txt', 'w'){ |fh|
-      2000.times{ |n| 
-        fh.puts test_tail_fmt_str % (n+1).to_s 
+    File.open(@@test_file64, 'w'){ |fh|
+      2000.times{ |n|
+        fh.puts test_tail_fmt_str % (n+1).to_s
       }
     }
 
-    File.open('test_file128.txt', 'w'){ |fh| 
-      4500.times{ |n| 
+    File.open(@@test_file128, 'w'){ |fh|
+      4500.times{ |n|
         fh.puts test_tail_fmt_str % (n+1).to_s
       }
-
     }
   end
 
   def setup
-    @test_file     = 'test_file1.txt'
-    @test_trail    = 'test_file_trail.txt'
-    @test_trail_nl = 'test_file_trail_nl.txt'
-    @test_file_64  = 'test_file64.txt'
-    @test_file_128 = 'test_file128.txt'
+    @test_file     = @@test_file1
+    @test_trail    = @@test_file_trail
+    @test_trail_nl = @@test_file_trail_nl
+    @test_file_64  = @@test_file64
+    @test_file_128 = @@test_file128
 
     @expected_tail1 = %w{
-      line16 line17 line18 line19 line20 
+      line16 line17 line18 line19 line20
       line21 line22 line23 line24 line25
     }
 
@@ -62,8 +67,6 @@ class TC_FileTail < Test::Unit::TestCase
     @expected_tail_trail = %w{ trail2 trail3 }
 
     @test_tail_fmt_str = "line data data data data data data data %5s"
-
-
   end
 
   def test_tail_basic
@@ -105,8 +108,6 @@ class TC_FileTail < Test::Unit::TestCase
     assert_equal( expected_tail_128k, File.tail(@test_file_128, 4500) )
   end
 
-  
-
   def teardown
     @test_file = nil
     @expected_tail1 = nil
@@ -114,10 +115,10 @@ class TC_FileTail < Test::Unit::TestCase
   end
 
   def self.shutdown
-    File.delete('test_file1.txt') if File.exist?('test_file1.txt')
-    File.delete('test_file64.txt') if File.exist?('test_file64.txt')
-    File.delete('test_file128.txt') if File.exist?('test_file128.txt')
-    File.delete('test_file_trail_nl.txt') if File.exist?('test_file_trail_nl.txt')
-    File.delete('test_file_trail.txt') if File.exist?('test_file_trail.txt')
+    File.delete(@@test_file1) if File.exist?(@@test_file1)
+    File.delete(@@test_file64) if File.exist?(@@test_file64)
+    File.delete(@@test_file128) if File.exist?(@@test_file128)
+    File.delete(@@test_file_trail_nl) if File.exist?(@@test_file_trail_nl)
+    File.delete(@@test_file_trail) if File.exist?(@@test_file_trail)
   end
 end

data/test/test_touch.rb

@@ -9,13 +9,14 @@ require 'ptools'
 
 class TC_FileTouch < Test::Unit::TestCase
   def self.startup
-    Dir.chdir('test') if File.exist?('test')
-    File.open('test_file1.txt', 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
+    @@dirname = File.dirname(__FILE__)
+    @@xfile = File.join(@@dirname, 'test_file1.txt')
+    File.open(@@xfile, 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
   end
 
   def setup
-    @test_file = 'delete.this'
-    @xfile = 'test_file1.txt'
+    @test_file = File.join(@@dirname, 'delete.this')
+    @xfile = File.join(@@dirname, 'test_file1.txt')
   end
 
   def test_touch_basic
@@ -47,6 +48,6 @@ class TC_FileTouch < Test::Unit::TestCase
   end
 
   def self.shutdown
-    File.delete('test_file1.txt') if File.exist?('test_file1.txt')
+    File.delete(@@xfile) if File.exist?(@@xfile)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ptools
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2014-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -95,20 +95,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 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_head.rb
+- test/test_null.rb
+- test/test_is_sparse.rb
 - test/test_whereis.rb
+- test/test_binary.rb
+- test/test_touch.rb
+- test/test_tail.rb
+- test/test_constants.rb
+- test/test_image.rb
 - test/test_which.rb