interactive_grep 0.0.2 → 0.0.4

data/README.txt

@@ -1,14 +1,11 @@
 Interactively Grep for patterns.
 
-This works particularly well for files with muli-line patterns (like
-weblogs) and it handles zipped files.
+This works particularly well for exploring multi-line pattern even in gzip'd files (i.e. weblogs)
 
-The code: pretty-yucky. This is based on my very first Ruby program (and
-the code was a total hack)!
+Why? This is based on my very first Ruby program (the code was a total hack)!
 
-But I've kept it because it's actually useful.
-And hopefully by the time you see this the code will serve as an example
-of the power of refactoring ;)
+I kept it because it's actually useful.
+Hopefully by the time you get this the code (v1.0), it will serve as an example of the power of refactoring ;)
 
 Basic use-case(s):
   gem install interactive_grep
@@ -17,41 +14,47 @@ Basic use-case(s):
 
   # OR in your code:
   irb
-    # normal ('grep') mode - support(s) regular or gzipped files
-    ig = InteractiveGrep::Grepper.new("files" => "/path/to/weblog.gz",
-                                      "pattern" => search_string
+    # normal ('grep') mode
+    ig = InteractiveGrep::Grepper.new(
+           "files" => "/path/to/weblog.gz",
+           "pattern" => search_string
     )
     puts ig.run
-    # => [matching_line1, matching_line2, matching_line3, etc...]
+    # => [matching_line1, ..., matching_lineN]
 
-    # count ('grep -c') mode - support(s) regular or gzipped files
-    ig = InteractiveGrep::Grepper.new("files" => "/path/to/weblog.gz",
-                                      "pattern" => search_string,
-                                      "mode" => "count"
+    # count ('grep -c') mode
+    ig = InteractiveGrep::Grepper.new(
+           "files" => "/path/to/weblog.gz",
+           "pattern" => search_string,
+           "mode" => "count"
     )
     ig.run
     # => 20
 
     # interactive mode - oh yeah!!!
-    ig = InteractiveGrep::Grepper.new(files => "/path/to/weblog.gz",
-                                      "pattern" => search_string
+    ig = InteractiveGrep::Grepper.new(
+           files => "/path/to/weblog.gz",
+           "pattern" => search_string
+           "mode" => "interactive"
     )
-    ig.interactive = true
     ig.run
-      # every time your *current* pattern is matched,
-      # the match is displayed
-      # and you are prompted to:
-      #   repeat the same search pattern (press enter)
-      #   'S'ee what's on the next line of the file (enter S)
-      #   adjust the search pattern (whatever you enter)
-      #   turn 'O'ff interactive-mode (enter O)
-      #    ...at which point the rest of the results will be 
-      #    automatically matched using the current pattern
+      # every line matching the current pattern is displayed
+      # and you're prompted to:
+      #   repeat the current search (press enter)
+      #
+      #   turn off interactive-mode (enter '-'*)
+      #    -- grep remainder of file(s) for current pattern
+      #
+      #   modify the current pattern (whatever you enter)
+      #    e.g. to explore one-line at a time enter "." (dot)
+      #    *note: to search for a dash, escape it (i.e. "\-")
 
 (See specs for more detailed use-cases ...and short-comings)
 rake rspec
 
 # TODO:
-# add specs for the behavior I described above
+# specs the behavior I've already described
 # test-drive an API I can be proud of ;-)
-# ability to record & replay grep-sessions
+# refactor (DRY-up and modularize)
+# add ability to record & replay grep-sessions
+# add support for zip, bzip, etc..

data/bin/igrep

@@ -1,46 +1,47 @@
 #!/usr/bin/env ruby
-
 # the "i" is for interactive
+
 begin
   require 'rubygems'
   gem 'interactive_grep'
+  require 'interactive_grep'
 rescue LoadError
+  require File.expand_path( '../../lib/interactive_grep/grepper.rb', __FILE__ )
 end
-file_or_gem = File.expand_path( '../../lib/interactive_grep/grepper.rb', __FILE__ )
-file_or_gem = 'interactive_grep' unless File.exists?( file_or_gem )
-require file_or_gem
+require 'optparse'
 
-# TODO: replace this w/ a real cmd-line options parser!
-if 0 == ARGV.size || InteractiveGrep::Grepper.contains_option?(ARGV,'h')
-  puts InteractiveGrep::Grepper.usage
-end
+options = {}
+options["verbose"] = true
 
-pattern = nil; interactive = true
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [OPTIONS] A_FILEGLOB or FILE(S)"
 
-in_file = ARGV[0]
+  options["pattern"] = nil
+  opts.on( "--pattern [PATTERN]", "Regex to grep with") do |p|
+    options["pattern"] = p
+  end
 
-if 2 <= ARGV.size
-  pattern = ARGV[1]
-end
+  options["mode"] = 'interactive'
+  opts.on( "--mode [MODE]", ['interactive', 'count', 'normal'], "'interactive', 'count' or 'normal'") do |m|
+    options["mode"] = m
+  end
 
-if 3 <= ARGV.size
-  mode = case ARGV[2]
-         when /^i/i
-           interactive = true
-           "interactive"
-         when /^c/i
-           interactive = false
-           "count"
-         else
-           interactive = false
-           "normal"
-         end
+  opts.on_tail( '-h', '--help', 'This help screen' ) do
+    puts opts
+    exit
+  end
 end
 
-mode ||= interactive ? "interactive" : "normal"
-igrep = InteractiveGrep::Grepper.new( { "files" => in_file, "pattern" => pattern, "mode" => mode, "verbose" => "true" } )
+opt_parser.parse!
+
+options["files"] = ARGV
+if options["files"].empty?
+  puts opt_parser
+  exit
+end
 
-puts "Welcome..." if interactive
+igrep = InteractiveGrep::Grepper.new( options )
+puts "Welcome..." if :interactive == options["mode"]
 igrep.run()
 
 exit

data/interactive_grep.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec", "~> 2.11.0"
+  s.add_development_dependency "ruby-debug19"
 end

data/lib/interactive_grep/grepper.rb

@@ -3,56 +3,34 @@ require 'zlib'
 module InteractiveGrep
   class Grepper
     DEFAULT_PATTERN = %r{.}.freeze
-    DEFAULT_NUMBER_OF_LINES_TO_INDICATE = 100.freeze
+    DEFAULT_PROGRESS_INDICATOR_COUNT = 100.freeze # in verbose mode, show signs of life after processing every N lines
     DEBUG = false.freeze
 
-    attr_accessor :file_names, :current_pattern, :initial_pattern, :gz, :file_index, :enough_lines_to_indicate
+    attr_reader :file_names, :current_pattern, :file_index
+    attr_accessor :progress_indicator_count, :initial_pattern
 
     def initialize( options = nil )
       options ||= {}
-      @enough_lines_to_indicate = options[:line_indicator_count] || DEFAULT_NUMBER_OF_LINES_TO_INDICATE
-      @verbose = DEBUG || !!options[ "verbose" ]
-      reset_file_index
-      @file_names = options[ "files" ]
-      if ( !@file_names.is_a?( Array ) ) && @file_names[/\*/]
-        @file_names = Dir.glob( @file_names ).map{|fname| fname}
-      end
-      @file_names = [ @file_names ] unless @file_names.is_a? Array
-      unless current_file && File.exists?( current_file )
-        raise "must specify at least one valid file (and/or file_glob)"
-      end
-
-      @initial_pattern = !!options[ "pattern" ] ? %r{#{options[ "pattern" ]}} : DEFAULT_PATTERN
-      @current_pattern = @initial_pattern
 
+      @progress_indicator_count = options[:progress_indicator_count] || DEFAULT_PROGRESS_INDICATOR_COUNT
+      @verbose = DEBUG || !!options[ "verbose" ]
       @mode = options[ "mode" ] || "normal"
-
       @gz = options[ "gz" ]
+      @initial_pattern = !!options[ "pattern" ] ? %r{#{options[ "pattern" ]}} : DEFAULT_PATTERN
+      @current_pattern = @initial_pattern
+      reset_file_index
+      @file_names = self.class.globs_to_files( options[ "files" ] )
 
-      if verbose?
-        puts "using:\n\tfiles: #{file_names}\n\tending in: #{ending}\n\tinitial_pattern: #{current_pattern_string}\n"
+      if !current_file || !File.exists?( current_file )
+        raise "must specify at least one valid file (and/or file_glob)"
       end
-    end
 
-    def self.contains_option?(input_options, option_string)
-      input_options.any?{|o| o[/^\s*\-+#{option_string}/] }
+      puts "using:\n\tfiles: #{file_names}\n\tending in: #{ending}\n\tinitial_pattern: #{current_pattern_string}\n" if verbose?
     end
 
-    def self.usage
-      puts	"usage $0 [-h]"
-      puts	"\tproduces this help-message"
-      puts	""
-
-      puts	"usage $0 <input_file> [<pattern>] [<mode>]"
-      puts	""
-      puts 	"modes: 'interactive' (default), 'count', or 'normal'"
-      puts 	"e.g."
-      puts 	"./igrep.rb big_test.txt.gz"
-      puts 	'./igrep.rb "/reporting/access*.gz" cvsfa=63 interactive'
-      puts 	'./igrep.rb "/reporting/access*.gz" cvsfa=63 count'
-      puts 	'./igrep.rb "/reporting/access*.gz" cvsfa=63 # normal-grep mode'
-      puts	""
-      exit
+    def self.globs_to_files( files_or_globs )
+      files_or_globs = files_or_globs.is_a?( Array ) ? files_or_globs : [ files_or_globs ]
+      files_or_globs.map {|file_or_glob| Dir.glob( file_or_glob ) }.flatten
     end
 
     def default_pattern?
@@ -96,17 +74,12 @@ module InteractiveGrep
           end
           @current_pattern = prompt( line )
         end
-        if verbose?
-          puts "." if 0 == (counter % enough_lines_to_indicate)
-        end
+        puts "." if verbose? && 0 == (counter % progress_indicator_count)
       end
       reset_file_index
       puts "no more files.\n" if verbose?
       if just_count?
-        if verbose?
-          puts "matched #{counter} line(s)"
-          puts "done.\n"
-        end
+        puts "matched #{counter} line(s)\ndone.\n" if verbose?
         counter
       else
         puts "done.\n" if verbose?
@@ -116,6 +89,8 @@ module InteractiveGrep
 
     private
 
+    attr_reader :current_pattern, :file_index
+
     def verbose?
       !!@verbose
     end
@@ -129,39 +104,24 @@ module InteractiveGrep
     end
 
     def prompt( msg )
-      if verbose? && msg && !just_count?
-        puts "\n>>\n#{msg}\n<<"
-      end
+      puts "\n>>\n#{msg}\n<<" if verbose? && msg && !just_count?
 
       if interactive?
-        puts "S | O | <pattern: [#{current_pattern_string}]> ? "
-        user_input = STDIN.gets.strip
+        puts ". | O | <pattern: [#{current_pattern_string}]> ? "
+        user_input = STDIN.gets.chomp
         puts ""
-        if DEBUG
-          puts "user_input: >>#{user_input.inspect}<<"
-        end
+        puts "user_input: >>#{user_input.inspect}<<" if DEBUG
 
         case
         when /^\s*$/.match( user_input ) #corresponds w/ <enter> (or <return>)
-          if verbose?
-            puts " => continuing w/ the previous pattern"
-          end
+          puts " => continuing w/ the previous pattern" if verbose?
           @current_pattern
-        when [ "O", "o" ].include?( user_input ) #interactive mode Off
+        when "-" == user_input #interactive mode Off
           @mode = "normal"
-          if verbose?
-            puts " => interactive switched mode off"
-          end
+          puts " => interactive switched mode off" if verbose?
           @current_pattern
-        when [ "S", "s" ].include?( user_input ) #Show every line
-          if verbose?
-            puts " => showing the next line"
-          end
-          /./
         else #use whatever was entered
-          if verbose?
-            puts " => using your input as the new search pattern"
-          end
+          puts " => using your input as the new search pattern" if verbose?
           %r{#{user_input}}
         end
       else

data/lib/interactive_grep/version.rb

@@ -1,3 +1,3 @@
 module InteractiveGrep
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/spec/lib/interactive_grep/grepper_spec.rb

@@ -26,7 +26,7 @@ describe InteractiveGrep::Grepper do
         end
 
         it "should have gz set to false" do
-          grepper.gz.should be_false
+          grepper.should_not be_gz
         end
       end
 
@@ -38,7 +38,7 @@ describe InteractiveGrep::Grepper do
         end
 
         it "should have gz set to true" do
-          grepper.gz.should be_true
+          grepper.should be_gz
         end
       end
 
@@ -50,7 +50,7 @@ describe InteractiveGrep::Grepper do
         end
 
         it "should have gz set to true" do
-          grepper.gz.should be_true
+          grepper.should be_gz
         end
       end
 
@@ -62,7 +62,7 @@ describe InteractiveGrep::Grepper do
         end
 
         it "should have gz set to false" do
-          grepper.gz.should be_false
+          grepper.should_not be_gz
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interactive_grep
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-07-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70175694399860 !ruby/object:Gem::Requirement
+  requirement: &70136989126620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,18 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70175694399860
+  version_requirements: *70136989126620
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70136989126200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70136989126200
 description: grep for stuff in (optionally gzipped) files ...even before you fully
   know what that 'stuff' looks like
 email: