ptools 1.2.7 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19b48052d410d086d24c61ef25da0b3e87b32c00
-  data.tar.gz: 49b572916684c747255775890a6e7188f286eced
+  metadata.gz: 57f08c106fbf7ec7ec69af176de55bed6738c146
+  data.tar.gz: bba434e438133b637255424a4d0192f550ac8f10
 SHA512:
-  metadata.gz: 70977a568a82dd6885804f7b47391f096da6b66b965944838c85cb47b6eba501bec70e0bbe69ea65a02621707532a3bf24846dbd4011a9ef66b8dc5a03b63f58
-  data.tar.gz: f81220180763b1fd1157712b16942c0fc5e588d3795b6be1fbaf7945201677333593f45dce298156e947434f18e1cfe7c990bbccd5edc3eac83a30fce56fe491
+  metadata.gz: 90c01dc5d9bba802ee72da662bcc8f68924899effe6cca6139521bd78664dc2e28a222d66198705076cf534cb21481413d01323821d8c5f02729e45c047a5c80
+  data.tar.gz: 8fbb9f1eb7794aa24a27dec7cc3ef0cd47d5d07338ea54996f1ec350950e0b9fcccf1059dc156318812d261db807223ddf54cde868ecfb533bcb6674032949ee

data/CHANGES

@@ -1,3 +1,8 @@
+== 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.
+* Removed the File.middle method. I don't think it's useful.
+
 == 1.2.7 - 6-Dec-2014
 * File.which now expands ~ for paths. Thanks go to dg-vrnetze for the patch.
 * Use /dev/null for cygwin instead of NUL.

data/MANIFEST

@@ -7,7 +7,6 @@
 * test/test_constants.rb
 * test/test_head.rb
 * test/test_image.rb
-* test/test_middle.rb
 * test/test_nlconvert.rb
 * test/test_null.rb
 * test/test_tail.rb

data/README

@@ -15,7 +15,6 @@
   File.whereis("ruby")       # ['/usr/local/bin/ruby','/opt/bin/ruby']
 
   File.head("myfile")        # Returns first 10 lines of 'myfile'
-  File.middle("myfile",8,12) # Returns lines 8-12 of 'myfile'
   File.tail("myfile",3)      # Returns last 3 lines of 'myfile'
   File.wc("myfile",'words')  # Returns the number of words in 'myfile'
 
@@ -40,8 +39,6 @@
   The File.nl_convert method is based on the nlcvt program found at
   http://www.perl.com/language/ppt/src/nlcvt/nlcvt, written by Tom Christiansen.
     
-  The middle() method was provided by Shashank Date.
-
   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).
 

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.2.7'
+  PTOOLS_VERSION = '1.3.0'
 
   # :stopdoc:
 
@@ -237,35 +237,45 @@ class File
     return a.empty? ? nil : a # Return nil in block form
   end
 
-  # In block form, yields line +from+ up to line +to+.  In non-block form
-  # returns an Array of lines from +from+ to +to+.
-  #
-  def self.middle(filename, from=10, to=20)
-    if block_given?
-      IO.readlines(filename)[from-1..to-1].each{ |line| yield line }
-    else
-      IO.readlines(filename)[from-1..to-1]
-    end
-  end
-
   # In block form, yields the last +num_lines+ of file +filename+.
   # In non-block form, it returns the lines as an array.
   #
-  # Note that this method slurps the entire file, so I don't recommend it
-  # for very large files. Also note that 'tail -f' functionality is not
-  # present. See the 'file-tail' library for that.
-  #
   # Example:
   #
   #   File.tail('somefile.txt') # => ['This is line7', 'This is line8', ...]
   #
+  # If you're looking for tail -f functionality, please use the file-tail
+  # gem instead.
+  #
   def self.tail(filename, num_lines=10)
+    tail_size = 2**16 # 64k chunks
+
+    # 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"
+
+    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
+      end
+    }
+
     if block_given?
-      IO.readlines(filename).reverse[0..num_lines-1].reverse.each{ |line|
-        yield line
-      }
+      buf.split(line_sep)[-num_lines..-1].each{ |line| yield line  }
     else
-      IO.readlines(filename).reverse[0..num_lines-1].reverse
+      buf.split(line_sep)[-num_lines..-1]
     end
   end
 

data/ptools.gemspec

@@ -3,7 +3,7 @@ require 'rbconfig'
 
 Gem::Specification.new do |gem|
   gem.name       = 'ptools'
-  gem.version    = '1.2.7'
+  gem.version    = '1.3.0'
   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.2.7', File::PTOOLS_VERSION)
+    assert_equal('1.3.0', File::PTOOLS_VERSION)
   end
 
   test "IMAGE_EXT constant is set to array of values" do

data/test/test_tail.rb

@@ -16,11 +16,11 @@ class TC_FileTail < Test::Unit::TestCase
   def setup
     @test_file = 'test_file1.txt'
 
-    @expected_tail1 = ["line16\n","line17\n","line18\n","line19\n"]
-    @expected_tail1.push("line20\n","line21\n","line22\n", "line23\n")
-    @expected_tail1.push("line24\n","line25\n")
+    @expected_tail1 = ["line16","line17","line18","line19"]
+    @expected_tail1.push("line20","line21","line22", "line23")
+    @expected_tail1.push("line24","line25")
 
-    @expected_tail2 = ["line21\n","line22\n","line23\n","line24\n","line25\n"]
+    @expected_tail2 = ["line21","line22","line23","line24","line25"]
   end
 
   def test_tail_basic

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ptools
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.3.0
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-06 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,7 +66,6 @@ files:
 - test/test_head.rb
 - test/test_image.rb
 - test/test_is_sparse.rb
-- test/test_middle.rb
 - test/test_nlconvert.rb
 - test/test_null.rb
 - test/test_tail.rb
@@ -106,7 +105,6 @@ test_files:
 - test/test_head.rb
 - test/test_image.rb
 - test/test_is_sparse.rb
-- test/test_middle.rb
 - test/test_nlconvert.rb
 - test/test_null.rb
 - test/test_tail.rb

data/test/test_middle.rb

@@ -1,58 +0,0 @@
-#####################################################################
-# test_middle.rb
-#
-# Test case for the File.middle method. You should run this test
-# via the 'rake test_middle' task.
-#####################################################################
-require 'test-unit'
-require 'ptools'
-
-class TC_FileMiddle < 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_middle1 = ["line10\n", "line11\n", "line12\n", "line13\n", "line14\n"]
-    @expected_middle1.push("line15\n","line16\n", "line17\n", "line18\n")
-    @expected_middle1.push("line19\n","line20\n")
-
-    @expected_middle2 = ["line14\n","line15\n","line16\n","line17\n"]
-    @expected_middle2.push("line18\n","line19\n","line20\n")
-
-    @expected_middle3 = ["line5\n","line6\n","line7\n"]
-    @expected_middle3.push("line8\n","line9\n","line10\n")
-  end
-
-  def test_method_basic
-    assert_respond_to(File, :middle)
-    assert_nothing_raised{ File.middle(@test_file) }
-    assert_nothing_raised{ File.middle(@test_file, 14) }
-    assert_nothing_raised{ File.middle(@test_file, 5, 10) }
-    assert_nothing_raised{ File.middle(@test_file){} }
-  end
-
-  def test_middle_expected_results
-    assert_kind_of(Array, File.middle(@test_file))
-    assert_equal(@expected_middle1, File.middle(@test_file))
-    assert_equal(@expected_middle2, File.middle(@test_file, 14))
-    assert_equal(@expected_middle3, File.middle(@test_file, 5, 10))
-  end
-
-  def test_middle_expected_errors
-    assert_raises(ArgumentError){ File.middle }
-    assert_raises(ArgumentError){ File.middle(@test_file, 5, 10, 15) }
-    assert_raises(NoMethodError){ File.middle(@test_file, "foo") }
-    assert_raises(Errno::ENOENT){ File.middle("bogus") }
-  end
-
-  def teardown
-    @test_file = nil
-    @expected_middle1 = nil
-    @expected_middle2 = nil
-    @expected_middle3 = nil
-  end
-end