ptools 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57f08c106fbf7ec7ec69af176de55bed6738c146
-  data.tar.gz: bba434e438133b637255424a4d0192f550ac8f10
+  metadata.gz: 0041b6df231b056f194bffcee580248797c341c5
+  data.tar.gz: 196e358a536fa6b2d7bc6243c3fe4d320c65860a
 SHA512:
-  metadata.gz: 90c01dc5d9bba802ee72da662bcc8f68924899effe6cca6139521bd78664dc2e28a222d66198705076cf534cb21481413d01323821d8c5f02729e45c047a5c80
-  data.tar.gz: 8fbb9f1eb7794aa24a27dec7cc3ef0cd47d5d07338ea54996f1ec350950e0b9fcccf1059dc156318812d261db807223ddf54cde868ecfb533bcb6674032949ee
+  metadata.gz: a611871af4c407b0ca637d1aa1a9e76854813a9ba52219a4abc97ac806d1af1e78e26fabc877abb97d099d7fa3a5d4fcfa6e083ec3e54a8eeb012410fb75fe17
+  data.tar.gz: 11d52f61ad1fc09fabb0c0c5a2006db4c917df704dc9c7252d3d41567762697fcb48bae93842c0f9c90a855286eed80f7224cdafd39e658923a7d1828b8f1859

data/CHANGES

@@ -1,3 +1,7 @@
+== 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
 * Made the File.tail method efficient. It's no longer slurpy, and it also no
   longer includes line endings in the result.

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.0'
+  PTOOLS_VERSION = '1.3.1'
 
   # :stopdoc:
 
@@ -252,30 +252,31 @@ class File
 
     # MS Windows gets unhappy if you try to seek backwards past the
     # end of the file, so we have some extra checks here and later.
-    file_size = File.size(filename)
-    tail_size = file_size if file_size <= tail_size
-    line_sep  = File::ALT_SEPARATOR ? "\r\n" : "\n"
+    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"
 
     buf = ''
 
     File.open(filename){ |fh|
-      fh.seek(-tail_size, File::SEEK_END)
-
-      while buf.count(line_sep) <= num_lines
-        buf = fh.read(tail_size) + buf
-        break if buf.count(line_sep) >= num_lines
-        if tail_size * 2 < file_size
-          fh.seek(-tail_size * 2, File::SEEK_CUR)
-        else
-          fh.seek(-file_size, File::SEEK_CUR)
-        end
+      # Set the starting read position
+      position   = file_size - read_bytes
+      
+      # 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
       end
     }
 
+    lines = buf.split(line_sep).pop(num_lines)
     if block_given?
-      buf.split(line_sep)[-num_lines..-1].each{ |line| yield line  }
+      lines.each{ |line| yield line  }
     else
-      buf.split(line_sep)[-num_lines..-1]
+      lines
     end
   end
 

data/ptools.gemspec

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

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.0', File::PTOOLS_VERSION)
+    assert_equal('1.3.1', File::PTOOLS_VERSION)
   end
 
   test "IMAGE_EXT constant is set to array of values" do

data/test/test_tail.rb

@@ -9,18 +9,61 @@ require 'ptools'
 
 class TC_FileTail < 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}" } }
+
+    File.open('test_file1.txt', 'w'){ |fh| 
+      25.times{ |n| fh.puts "line#{n+1}" }
+    }
+
+    # Trailing newline test
+    File.open('test_file_trail.txt', 'w'){ |fh| 
+      2.times{ |n| fh.puts "trail#{n+1}" }
+      fh.write "trail3"
+    }
+    File.open('test_file_trail_nl.txt', '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_file128.txt', 'w'){ |fh| 
+      4500.times{ |n| 
+        fh.puts test_tail_fmt_str % (n+1).to_s
+      }
+
+    }
   end
 
   def setup
-    @test_file = 'test_file1.txt'
+    @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'
 
-    @expected_tail1 = ["line16","line17","line18","line19"]
-    @expected_tail1.push("line20","line21","line22", "line23")
-    @expected_tail1.push("line24","line25")
+    @expected_tail1 = %w{
+      line16 line17 line18 line19 line20 
+      line21 line22 line23 line24 line25
+    }
 
     @expected_tail2 = ["line21","line22","line23","line24","line25"]
+
+    @expected_tail_more = []
+    25.times{ |n| @expected_tail_more.push "line#{n+1}" }
+
+    @expected_tail_trail = %w{ trail2 trail3 }
+
+    @test_tail_fmt_str = "line data data data data data data data %5s"
+
+
   end
 
   def test_tail_basic
@@ -36,11 +79,34 @@ class TC_FileTail < Test::Unit::TestCase
     assert_equal(@expected_tail2, File.tail(@test_file, 5))
   end
 
+  def test_more_lines_than_file
+    assert_equal( @expected_tail_more, File.tail(@test_file, 30) )
+  end
+
   def test_tail_expected_errors
     assert_raises(ArgumentError){ File.tail }
     assert_raises(ArgumentError){ File.tail(@test_file, 5, 5) }
   end
 
+  def test_no_trailing_newline
+    assert_equal( @expected_tail_trail, File.tail(@test_trail, 2) )
+    assert_equal( @expected_tail_trail, File.tail(@test_trail_nl, 2) )
+  end
+
+  def test_tail_larger_than_64k
+    expected_tail_64k=[]
+    2000.times{ |n| expected_tail_64k.push( @test_tail_fmt_str % (n+1).to_s ) }
+    assert_equal( expected_tail_64k, File.tail(@test_file_64, 2000) )
+  end
+
+  def test_tail_larger_than_128k
+    expected_tail_128k = []
+    4500.times{ |n| expected_tail_128k.push( @test_tail_fmt_str % (n+1).to_s ) }
+    assert_equal( expected_tail_128k, File.tail(@test_file_128, 4500) )
+  end
+
+  
+
   def teardown
     @test_file = nil
     @expected_tail1 = nil
@@ -49,5 +115,9 @@ class TC_FileTail < Test::Unit::TestCase
 
   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')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ptools
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake