grepper 0.9.1 → 0.9.2

data/History.txt

@@ -13,3 +13,12 @@
 * Fixed a line-counting bug that was making
   Match#lineno work wrongly. 
 
+=== 0.9.2 / 2008-12-24
+
+* Added bin/grep.rb, simple grep commandline tool
+
+* Fixed some separator problems in formatter output
+
+* Added some logic to the Match and Result classes
+
+* Refactoring

data/Manifest.txt

@@ -2,8 +2,9 @@ History.txt
 Manifest.txt
 README.txt
 Rakefile
-lib/formatter.rb
+bin/grep.rb
 lib/grepper.rb
+lib/grepper/formatter.rb
 test/input.1
 test/input.2
 test/input.3

data/README.txt

@@ -84,7 +84,7 @@ and
 
 == Version
 
-0.9.1, December 23, 2008
+0.9.2, December 24, 2008
 
 == Author
 

data/bin/grep.rb

@@ -0,0 +1,48 @@
+$: << '../lib'
+require 'rubygems'
+require 'grepper'
+require 'grepper/formatter'
+
+require 'getoptlong'
+
+
+opts = GetoptLong.new(
+  ['--help',            '-h',   GetoptLong::NO_ARGUMENT],
+  ['--line-number',     '-n',   GetoptLong::NO_ARGUMENT],
+  ['--before-context',  '-B',   GetoptLong::REQUIRED_ARGUMENT],
+  ['--after-context',    '-A',  GetoptLong::REQUIRED_ARGUMENT],
+  ['--invert-match',     '-v',  GetoptLong::NO_ARGUMENT]
+)
+
+grepper = Grepper.new
+formatter = Grepper::Formatter.new(grepper)
+
+opts.each do |opt,arg|
+  case opt
+  when '--line-number'
+    formatter.options << "n"
+  when '--before-context'
+    grepper.options << "B#{arg}"
+  when '--after-context'
+    grepper.options << "A#{arg}"
+  when '--invert-match'
+    grepper.options << "v"
+  when '--help'
+    puts "Help"
+    exit 0
+  else
+    puts "Unknown option #{opt}"
+  end
+end
+
+if ARGV.size < 2
+  puts "Sorry"
+  exit 0
+end
+
+grepper.pattern = Regexp.new(ARGV.shift)
+grepper.files = ARGV.dup
+
+grepper.run
+formatter.format
+puts formatter.output

data/lib/{formatter.rb → grepper/formatter.rb}

@@ -12,6 +12,7 @@ class Grepper
 #
 #   f = Grepper::Formatter.initialize(grepper)
 #   f.format
+#   f.options = ['...'] # see below
 #   puts f.output
 #
 # Output will show filenames if there are multiple files,
@@ -20,6 +21,25 @@ class Grepper
 # that the Grepper and its result set already have. 
 #
 # For version and license information, see <tt>grepper.rb</tt>.
+#
+# == Options
+#
+# Formatters have an options array which you can set and
+# add to. It's empty by default.
+#
+# Available options:
+#
+# * <tt>l</tt> -- show matching filenames only
+# * <tt>c</tt> -- show match count only
+# * <tt>n</tt> -- show the line number of the match
+# 
+# Note that Grepper objects also have options ('v', 'A1', etc.).
+# Both the Formatter options and the Grepper options are pulled
+# from the canon of grep(1) options. Some make more sense for the
+# grep operation itself (like inverting the sense of the match with
+# 'v'), while some are purely a formatting thing (like including the
+# filename). 
+
   class Formatter
     
     attr_reader :output
@@ -28,6 +48,7 @@ class Grepper
     def initialize(grepper)
       @output = ""
       @grepper = grepper
+      @options = []
     end
 
     def matches_are_contiguous?(first,second)
@@ -42,6 +63,8 @@ class Grepper
       @output = process_grepper(@grepper)
     end
 
+    private
+    
     def format_line(n,b,l,a)
       case
       when options.include?('n')
@@ -55,10 +78,28 @@ class Grepper
       multi? ? many_string + string : string
     end
     
-    def context_lines(lines,file)
-      lines.map {|line| one_or_many(line,"#{file}-") }.join
+    def context_lines(lines,file,n,position)
+      str = ""
+      i = case position
+          when :before then n - lines.size
+          when :after then n + 1
+      end
+      lines.each do |line|
+        count = options.include?('n') ? "#{i}-" : ""
+        str << one_or_many("#{count}#{line}","#{file}-")
+        i += 1
+      end
+      str
     end
 
+    def before_lines(*args)
+      context_lines(*args << :before)
+    end
+    
+    def after_lines(*args)
+      context_lines(*args << :after)
+    end
+    
     def boundary_string_for(m1, m2, conditions_hash)
       conditions = conditions_hash[:conditions]
       return "" unless conditions
@@ -66,36 +107,43 @@ class Grepper
       return "--\n"
     end
     
-    def file_boundary_string_for(f1, f2)
-      f1 &&! (f1 == f2) ? "--\n" : ""
-    end
+    public
     
     def process_grepper(grepper)
       str = ""
       last_file = nil
+      context = grepper.results.context?
+
       grepper.results.each do |file,matches|
+
+# Put in a -- boundary if this is a new file and
+# there's a before- or after-context
+        if context && last_file &&! (file == last_file)
+          str << "--\n"
+        end
+
+        last_file = file
+
+# 'l' -- filenames only
         if options.include?('l')
           str << "#{file}\n"
+
+# 'c' -- match count only
         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)
+              str << before_lines(before,file,n)
             end
 
             str << one_or_many(format_line(n,before,line,after), "#{file}:")
 
             if after
-              str << context_lines(after,file)
+              str << after_lines(after,file,n)
               succ = matches[m+1]
               str << boundary_string_for(matches[m], succ, :conditions => succ)
             end  
@@ -105,4 +153,4 @@ class Grepper
       return str
     end
   end
-end
+end

data/lib/grepper.rb

@@ -84,7 +84,7 @@
 #
 # == Version
 #
-# 0.9.1, December 23, 2008
+# 0.9.2, December 24, 2008
 #
 # == Author
 #
@@ -99,7 +99,7 @@
 #
 
 class Grepper
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 
   attr_accessor :files, :pattern, :options
   attr_reader :results
@@ -141,8 +141,8 @@ class Grepper
   def run
     @negate = true if options.include?('v')
     
-    after_count = $1.to_i if options.find {|o| /A(\d)/.match(o) }
-    before_count = $1.to_i if options.find {|o| /B(\d)/.match(o) }
+    after_count = $1.to_i if options.find {|o| /A(\d+)/.match(o) }
+    before_count = $1.to_i if options.find {|o| /B(\d+)/.match(o) }
 
     files.each do |file|
       result = Result.new(file)
@@ -234,6 +234,10 @@ class Grepper
         yield self[i]
       end
     end
+    
+    def context?
+      any? {|f,matches| matches.any? {|n,b,l,a| b || a } }
+    end
   end
 
   # Provides the iteration intelligence for match sets. 

data/test/test_formatter.rb

@@ -1,4 +1,6 @@
-require 'lib/formatter'
+# Tests of the output of the formatter. 
+
+require 'grepper/formatter'
 require 'test/unit'
 
 class FormatterTest < Test::Unit::TestCase
@@ -13,7 +15,7 @@ class FormatterTest < Test::Unit::TestCase
     grepper.run
   end
   
-  def formatter_for(grepper, options=grepper.options)
+  def formatter_for(grepper,options = [])
     f = Grepper::Formatter.new(grepper)
     f.options = options
     f.format
@@ -145,5 +147,64 @@ test/input.6:abc
 EOM
   end
   
+  def test_before_context_with_line_numbers
+    @g.options = ["B2"]
+    run_with_files(@g, %w{ test/input.6 })
+    f = formatter_for(@g,["n"])
+    assert_equal(<<EOM, f.output)
+1-one
+2-two
+3:abc
+4-three
+5-four
+6:abc
+7-five
+8-six
+9:abc
+EOM
+  end
+
+    def test_after_context_with_line_numbers
+      @g.options = ["A2"]
+      run_with_files(@g, %w{ test/input.6 })
+      f = formatter_for(@g,["n"])
+      assert_equal(<<EOM, f.output)
+3:abc
+4-three
+5-four
+6:abc
+7-five
+8-six
+9:abc
+EOM
+  end
+  
+  def test_before_context_line_numbers_multiple_files
+    @g.options = ["B2"]
+    run_with_files(@g, %w{ test/input.1 test/input.2 })
+    f = formatter_for(@g,["n"])
+    assert_equal(<<EOM, f.output)
+test/input.1-1-This is a file
+test/input.1:2:This matches abc.
+--
+test/input.2-1-This doesn't match.
+test/input.2-2-However, this:
+test/input.2:3:So does this abc.
+EOM
+  end
+
+    def test_after_context_line_numbers_multiple_files
+      @g.options = ["A2"]
+      run_with_files(@g, %w{ test/input.1 test/input.2 })
+      f = formatter_for(@g,["n"])
+      assert_equal(<<EOM, f.output)
+test/input.1:2:This matches abc.
+test/input.1-3-This doesn't.
+--
+test/input.2:3:So does this abc.
+test/input.2-4-does.
+EOM
+    end
 end
-    
+
+

data/test/test_grepper.rb

@@ -1,3 +1,5 @@
+# Tests of the basic functioning of the grepper. 
+
 require "test/unit"
 require "lib/grepper.rb"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grepper
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors: 
 - David A. Black
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-23 00:00:00 -05:00
+date: 2008-12-24 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,8 +25,8 @@ dependencies:
 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: []
-
+executables: 
+- grep.rb
 extensions: []
 
 extra_rdoc_files: 
@@ -38,8 +38,9 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
-- lib/formatter.rb
+- bin/grep.rb
 - lib/grepper.rb
+- lib/grepper/formatter.rb
 - test/input.1
 - test/input.2
 - test/input.3