grepper 0.9.0 → 0.9.1

data/History.txt

@@ -4,3 +4,12 @@
 
   * First release
 
+=== 0.9.1 / 2008-12-23
+
+* Added Formatter class to provide reasonably standard-ish output
+
+* Added some logic to the Match class
+
+* Fixed a line-counting bug that was making
+  Match#lineno work wrongly. 
+

data/Manifest.txt

@@ -2,10 +2,13 @@ History.txt
 Manifest.txt
 README.txt
 Rakefile
+lib/formatter.rb
 lib/grepper.rb
 test/input.1
 test/input.2
 test/input.3
 test/input.4
 test/input.6
+test/test_formatter.rb
 test/test_grepper.rb
+test/test_match.rb

data/README.txt

@@ -1,20 +1,5 @@
 Grepper -- simple way to grep through files and save results
 
-== Version
-
-0.9.0, December 21, 2008
-
-== Author
-
-David A. Black (dblack@rubypal.com)
-
-== Copyright and license
-
-Copyright (c) 2008, Ruby Power and Light, LLC
-
-Released under the Ruby license. No warranty of any kind. Use
-entirely at your own risk. 
-
 == Description
 
 The Grepper class greps through files, and returns a result
@@ -25,7 +10,10 @@ line that matched) and before- and after-context arrays. If no before
 or after lines were requested, those context values will be nil. 
 
 To use, you prepare a Grepper object; call <tt>run</tt> on it; and
-walk through the result set. 
+walk through the result set. This distribution comes with the
+Grepper::Formatter class, which is built on top of Grepper and provides
+fairly canonical-looking output by walking through Grepper objects. 
+(See <tt>lib/formatter.rb</tt>.) Meanwhile, here are the details. 
 
 == Preparing a Grepper object
 
@@ -94,4 +82,19 @@ and
 
   matches.each_match do |match|
 
+== Version
+
+0.9.1, December 23, 2008
+
+== Author
+
+David A. Black (dblack@rubypal.com)
+
+== Copyright and license
+
+Copyright (c) 2008, Ruby Power and Light, LLC
+
+Released under the Ruby license. No warranty of any kind. Use
+entirely at your own risk. 
+
 

data/lib/formatter.rb

@@ -0,0 +1,108 @@
+require "rubygems"
+require "grepper"
+
+class Grepper
+
+# == Description
+#
+# Grepper::Formatter provides output similar to GNU grep (and
+# probably other greps. 
+#
+# == Usage
+#
+#   f = Grepper::Formatter.initialize(grepper)
+#   f.format
+#   puts f.output
+#
+# Output will show filenames if there are multiple files,
+# and will show before- and after-context. The Formatter
+# doesn't really do anything except format the information
+# that the Grepper and its result set already have. 
+#
+# For version and license information, see <tt>grepper.rb</tt>.
+  class Formatter
+    
+    attr_reader :output
+    attr_accessor :options
+    
+    def initialize(grepper)
+      @output = ""
+      @grepper = grepper
+    end
+
+    def matches_are_contiguous?(first,second)
+      first.absolute_end == second.absolute_start - 1
+    end
+
+    def multi?
+      @grepper.results.size > 1 &&! @options.include?('h')
+    end
+    
+    def format
+      @output = process_grepper(@grepper)
+    end
+
+    def format_line(n,b,l,a)
+      case
+      when options.include?('n')
+        "#{n}:#{l}"
+      else
+        l.dup
+      end
+    end
+
+    def one_or_many(string, many_string)
+      multi? ? many_string + string : string
+    end
+    
+    def context_lines(lines,file)
+      lines.map {|line| one_or_many(line,"#{file}-") }.join
+    end
+
+    def boundary_string_for(m1, m2, conditions_hash)
+      conditions = conditions_hash[:conditions]
+      return "" unless conditions
+      return "" if matches_are_contiguous?(m1, m2)
+      return "--\n"
+    end
+    
+    def file_boundary_string_for(f1, f2)
+      f1 &&! (f1 == f2) ? "--\n" : ""
+    end
+    
+    def process_grepper(grepper)
+      str = ""
+      last_file = nil
+      grepper.results.each do |file,matches|
+        if options.include?('l')
+          str << "#{file}\n"
+        elsif options.include?('c')
+          str << one_or_many("#{matches.size}\n", "#{file}:")
+        else
+          matches.each_with_index do |(n,before,line,after),m|
+            if (after || before)
+              str << file_boundary_string_for(last_file, file)
+            end
+
+            last_file = file
+
+            if before
+              prev = matches[m-1]
+              str << boundary_string_for(prev, matches[m], :conditions => prev &&! m.zero?)
+              str << context_lines(before,file)
+            end
+
+            str << one_or_many(format_line(n,before,line,after), "#{file}:")
+
+            if after
+              str << context_lines(after,file)
+              succ = matches[m+1]
+              str << boundary_string_for(matches[m], succ, :conditions => succ)
+            end  
+          end
+        end
+      end
+      return str
+    end
+  end
+end

data/lib/grepper.rb

@@ -1,20 +1,5 @@
 # Grepper -- simple way to grep through files and save results
 #
-# == Version
-#
-# 0.9.0, December 21, 2008
-#
-# == Author
-#
-# David A. Black (dblack@rubypal.com)
-#
-# == Copyright and license
-#
-# Copyright (c) 2008, Ruby Power and Light, LLC
-#
-# Released under the Ruby license. No warranty of any kind. Use
-# entirely at your own risk. 
-#
 # == Description
 #
 # The Grepper class greps through files, and returns a result
@@ -25,7 +10,10 @@
 # or after lines were requested, those context values will be nil. 
 #
 # To use, you prepare a Grepper object; call <tt>run</tt> on it; and
-# walk through the result set. 
+# walk through the result set. This distribution comes with the
+# Grepper::Formatter class, which is built on top of Grepper and provides
+# fairly canonical-looking output by walking through Grepper objects. 
+# (See <tt>lib/formatter.rb</tt>.) Meanwhile, here are the details. 
 #
 # == Preparing a Grepper object
 #
@@ -94,9 +82,24 @@
 #
 #   matches.each_match do |match|
 #
+# == Version
+#
+# 0.9.1, December 23, 2008
+#
+# == Author
+#
+# David A. Black (dblack@rubypal.com)
+#
+# == Copyright and license
+#
+# Copyright (c) 2008, Ruby Power and Light, LLC
+#
+# Released under the Ruby license. No warranty of any kind. Use
+# entirely at your own risk. 
+#
 
 class Grepper
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 
   attr_accessor :files, :pattern, :options
   attr_reader :results
@@ -111,10 +114,12 @@ class Grepper
   private 
 
   def get_after_context(fh, after_count)
+
     res = []
     after_count.times do |i|
       line = fh.gets
       break unless line
+
       if match?(line)
         fh.pos -= line.size
         break
@@ -144,12 +149,17 @@ class Grepper
       results << result
       buffer = []
       File.open(file) do |fh|
-        fh.each_with_index do |line,i|
+        i = 0
+        while line = fh.gets
+          i += 1
+          
           if match?(line)
             match = Match.new(line)
-            match.lineno = i + 1
+            match.lineno = i
+
             if after_count
               match.after = get_after_context(fh, after_count)
+              i += match.after.to_s.scan(/\n/).size
             end
 
             if before_count
@@ -175,13 +185,27 @@ class Grepper
 #
 # Match instances are created automatically by the Grepper
 # object when you run it. 
-class Match
-  attr_accessor :before, :line, :after, :lineno
-  def initialize(line)
-    @before = @after = nil
-    @line = line
+  class Match
+    attr_accessor :before, :line, :after, :lineno
+    def initialize(line)
+      @before = @after = nil
+      @line = line
+    end
+  
+    def total_line_count
+      before.to_s.scan(/\n/).size +
+      after.to_s.scan(/\n/).size +
+      1
+    end
+
+    def absolute_start
+      lineno - before.to_s.scan(/\n/).size
+    end
+  
+    def absolute_end
+      lineno + after.to_s.scan(/\n/).size
+    end
   end
-end
 
 # Grepper::Result represents the matches from a single file. It
 # connects the filename (the <tt>file</tt> attribute) with a
@@ -199,12 +223,13 @@ end
 
   # Provides the iteration intelligence for result sets.  
   module ResultsExtension
-    def each(&block)
+    def each
       (0...size).each do |i|
         yield(self[i].file, self[i].matches)
       end
     end
-    def each_result(&block)
+    
+    def each_result
       (0...size).each do |i|
         yield self[i]
       end

data/test/test_formatter.rb

@@ -0,0 +1,149 @@
+require 'lib/formatter'
+require 'test/unit'
+
+class FormatterTest < Test::Unit::TestCase
+  def setup
+    @g = Grepper.new
+    @g.files = %w{ test/input.1 test/input.2 test/input.3 }
+    @g.pattern = /abc/
+  end
+  
+  def run_with_files(grepper,*files)
+    grepper.files = *files
+    grepper.run
+  end
+  
+  def formatter_for(grepper, options=grepper.options)
+    f = Grepper::Formatter.new(grepper)
+    f.options = options
+    f.format
+    f
+  end
+  
+  def test_one_file
+    run_with_files(@g,%w{ test/input.1 })
+    f = formatter_for(@g)
+    assert_equal("This matches abc.\n", f.output)
+  end
+  
+  def test_one_file_with_line_numbers
+    run_with_files(@g,%w{ test/input.1 })
+    f = formatter_for(@g, %w{n})
+    assert_equal("2:This matches abc.\n", f.output)
+  end
+
+  def test_one_file_with_count
+    run_with_files(@g,%w{ test/input.6 })
+    f = formatter_for(@g, %w{c})
+    assert_equal("3\n", f.output)
+  end
+  
+  def test_one_file_name_only
+    run_with_files(@g,%w{ test/input.1 })
+    f = formatter_for(@g, %w{l})
+    assert_equal("test/input.1\n", f.output)
+  end
+
+  def test_multiple_files_name_only
+    run_with_files(@g, %w{ test/input.1 test/input.2 test/input.4 })
+    f = formatter_for(@g, %w{l})
+    assert_equal("test/input.1\ntest/input.2\ntest/input.4\n", f.output)
+  end
+
+  def test_multiple_files_with_count
+    run_with_files(@g, %w{ test/input.1 test/input.6 })
+    f = formatter_for(@g, %w{c})
+    assert_equal("test/input.1:1\ntest/input.6:3\n", f.output)
+  end
+  
+  def test_multiple_files_with_line_numbers
+    run_with_files(@g,%w{ test/input.1 test/input.2 })
+    f = formatter_for(@g, %w{n})
+    assert_equal("test/input.1:2:This matches abc.\ntest/input.2:3:So does this abc.\n", f.output)
+  end
+  
+  def test_after_context_single_file
+    @g.options = ["A2"]
+    run_with_files(@g,%w{ test/input.6 })
+    f = formatter_for(@g)
+    assert_equal(<<EOM, f.output)
+abc
+three
+four
+abc
+five
+six
+abc
+EOM
+  end
+  def test_after_context_single_file_with_separator
+    @g.options = ["A1"]
+    run_with_files(@g,%w{ test/input.6 })
+    f = formatter_for(@g)
+    assert_equal(<<EOM, f.output)
+abc
+three
+--
+abc
+five
+--
+abc
+EOM
+  end
+
+  
+  def test_before_context_single_file
+    @g.options = ["B1"]
+    run_with_files(@g, %w{ test/input.6 })
+    f = formatter_for(@g)
+    assert_equal(<<EOM, f.output)
+two
+abc
+--
+four
+abc
+--
+six
+abc
+EOM
+  end
+  
+  def test_before_context_multiple_files
+    @g.options = ["B1"]
+    run_with_files(@g, %w{ test/input.1 test/input.6 })
+    f = formatter_for(@g)
+    assert_equal(<<EOM, f.output)
+test/input.1-This is a file
+test/input.1:This matches abc.
+--
+test/input.6-two
+test/input.6:abc
+--
+test/input.6-four
+test/input.6:abc
+--
+test/input.6-six
+test/input.6:abc
+EOM
+  end
+  
+  def test_after_context_multiple_files
+    @g.options = ["A1"]
+    run_with_files(@g, %w{ test/input.1 test/input.6 })
+    f = formatter_for(@g)
+    assert_equal(<<EOM, f.output)
+test/input.1:This matches abc.
+test/input.1-This doesn't.
+--
+test/input.6:abc
+test/input.6-three
+--
+test/input.6:abc
+test/input.6-five
+--
+test/input.6:abc
+EOM
+  end
+  
+end
+    

data/test/test_grepper.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require 'English'
+require "test/unit"
 require "lib/grepper.rb"
 
 class GrepTest < Test::Unit::TestCase
@@ -132,6 +131,14 @@ EOM
     assert_equal(2, @g.results[0].matches[0].lineno)
   end
   
+  def test_multiple_line_numbers_one_file
+    @g.files = ["test/input.6"]
+    @g.options = ["A1"]
+    @g.run
+    assert_equal(3, @g.results[0].matches[0].lineno)
+    assert_equal(6, @g.results[0].matches[1].lineno)
+  end
+  
   def test_line_numbering_in_multiple_files
     test_basic_lines_from_multiple_files
     assert_equal(3, @g.results[1].matches[0].lineno)

data/test/test_match.rb

@@ -0,0 +1,54 @@
+# Tests for the match statistic logic. 
+
+require "test/unit"
+require "lib/grepper.rb"
+
+class Grepper::MatchTest < Test::Unit::TestCase
+  def setup
+    @g = Grepper.new
+    @g.pattern = /abc/
+    @g.files = %w{ test/input.6 }
+  end
+
+  def assert_match_stats(match, lineno, abs_start, abs_end)
+    assert_equal(lineno, match.lineno)
+    assert_equal(abs_start, match.absolute_start)
+    assert_equal(abs_end, match.absolute_end)
+  end
+  
+  def test_basic_match_location_data
+    @g.run
+    m = @g.results[0].matches[0]
+    assert_match_stats(m,3,3,3)
+  end
+  
+  def test_before_context
+    @g.options = "B2"
+    @g.run
+    matches = @g.results[0].matches
+    assert_match_stats(matches[0], 3,1,3)
+    assert_match_stats(matches[1], 6,4,6)
+    assert_match_stats(matches[2], 9,7,9)
+  end
+
+  def test_after_context
+    @g.options = "A2"
+    @g.run
+    matches = @g.results[0].matches
+    assert_match_stats(matches[0], 3,3,5)
+    assert_match_stats(matches[1], 6,6,8)
+    assert_match_stats(matches[2], 9,9,9)
+  end
+  
+  def test_both_contexts
+    @g.options = "A1B1"
+    @g.run
+    matches = @g.results[0].matches
+    assert_match_stats(matches[0], 3,2,4)
+    assert_match_stats(matches[1], 6,5,7)
+    assert_match_stats(matches[2], 9,8,9)
+  end    
+    
+end
+  
+  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grepper
 version: !ruby/object:Gem::Version 
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors: 
 - David A. Black
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-22 00:00:00 -05:00
+date: 2008-12-23 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.2
     version: 
-description: The Grepper class greps through files, and returns a result set of Grepper::Result objects. Each Result object represents the matches found in a single file. The Result contains a set of Grepper::Match objects. Each Match object represents a line (the line that matched) and before- and after-context arrays. If no before or after lines were requested, those context values will be nil.   To use, you prepare a Grepper object; call <tt>run</tt> on it; and walk through the result set.
+description: The Grepper class greps through files, and returns a result set of Grepper::Result objects. Each Result object represents the matches found in a single file. The Result contains a set of Grepper::Match objects. Each Match object represents a line (the line that matched) and before- and after-context arrays. If no before or after lines were requested, those context values will be nil.   To use, you prepare a Grepper object; call <tt>run</tt> on it; and walk through the result set. This distribution comes with the Grepper::Formatter class, which is built on top of Grepper and provides fairly canonical-looking output by walking through Grepper objects.  (See <tt>lib/formatter.rb</tt>.) Meanwhile, here are the details.
 email: 
 - dblack@rubypal.com
 executables: []
@@ -38,15 +38,18 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
+- lib/formatter.rb
 - lib/grepper.rb
 - test/input.1
 - test/input.2
 - test/input.3
 - test/input.4
 - test/input.6
+- test/test_formatter.rb
 - test/test_grepper.rb
+- test/test_match.rb
 has_rdoc: true
-homepage: 0.9.0, December 21, 2008
+homepage: The Grepper class greps through files, and returns a result
 post_install_message: 
 rdoc_options: 
 - --main
@@ -68,9 +71,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: grepper
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: The Grepper class greps through files, and returns a result set of Grepper::Result objects
 test_files: 
+- test/test_formatter.rb
 - test/test_grepper.rb
+- test/test_match.rb