interactive_grep 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+.ignore
+.rvmrc
+*.gem
+*.tmp
+.bundle
+Gemfile.lock
+coverage/*
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in interactive_grep.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Jonathan Thomas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.txt

@@ -0,0 +1,41 @@
+Interactively Grep for patterns.
+
+This works particularly well for files with muli-line patterns (like
+weblogs) and it handles zipped files.
+
+The code: horrible. This is my very first ruby program!
+I keep it simply because it's useful.
+One day I'll actually fix the code ;-)
+
+Basic use-case(s):
+  gem install interactive_grep
+  # from the commandline:
+  igrep -h
+
+  # in your code:
+  irb
+    # standard 'grep' (for optionally gzipped files)
+    ig = InteractiveGrep::Grepper.new("/path/to/my/weblog.gz", search_pattern_string)
+    results = ig.run
+    puts results
+    # => [matching_line1, matching_line2, matching_line3, etc...]
+
+    # standard 'grep -c' (for optionally gzipped files)
+    ig = InteractiveGrep::Grepper.new("/path/to/my/weblog.gz", search_pattern_string, true)
+    ig.run
+    # => 20  <-- yes, that third 'magic' initialization param caused
+                 the grepper to merely "count" the number of matches
+
+    # *** interactive grep (for optionally gzipped files) ***
+    ig = InteractiveGrep::Grepper.new("/path/to/my/weblog.gz", search_pattern_string)
+    ig.interactive = true
+    ig.run
+      # every time your *current* pattern is matched, the output is
+      # displayed ane you are prompted to:
+      # repeat the pattern search (just hit return)
+      # update the pattern (i.e. to find the next level of detail)
+
+(See specs for more detailed use-cases.)
+rake rspec
+
+# TODO: re-write this TDD-style

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+gemspec = eval(File.read("interactive_grep.gemspec"))
+
+task :build => "#{gemspec.full_name}.gem"
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["interactive_grep.gemspec"] do
+  system "gem build interactive_grep.gemspec"
+  system "gem install interactive_grep-#{InteractiveGrep::VERSION}.gem"
+end

data/bin/igrep

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+# the "i" is for interactive
+require 'interactive_grep'
+
+if __FILE__ == $0
+	if '-h' == ARGV[0] || 0 == ARGV.size
+		puts	"usage $0 -h"
+		puts	"\tproduces this help-message"
+		puts	""
+		
+		puts	"usage $0 <input_file> [<pattern>] [<display count-only>] [<interactive-mode=on>]"
+		puts	""
+		puts 	"e.g."
+		puts 	"./igrep.rb big_test.txt.gz"
+		puts 	'./igrep.rb "/reporting/access*.gz" cvsfa=63'
+		puts	""
+		exit
+	end
+
+	in_file = ARGV[0]
+	pattern = nil
+	interactive = nil
+	just_count = false
+	prompt = nil
+	if 2 <= ARGV.size
+		pattern = ARGV[1]
+	end
+	if 3 <= ARGV.size
+		# ARGV[2]
+		just_count = true
+		puts "true count: #{ARGV[2]}"
+	end
+	if 4 <= ARGV.size
+		interactive = ARGV[3]
+		puts "interactive mode: #{interactive}"
+	end
+
+	prompt = 'ready to continue' if interactive
+	igrep = InteractiveGrep::Grepper.new(in_file,pattern,just_count,interactive)
+	puts "#{prompt}\n\n" if interactive
+	igrep.run()
+	exit
+end

data/interactive_grep.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "interactive_grep/version"
+
+Gem::Specification.new do |s|
+  s.name        = "interactive_grep"
+  s.version     = InteractiveGrep::VERSION
+  s.authors     = ["JayTeeSr"]
+  s.email       = ["jaytee_sr_at_his-service_dot_net"]
+  s.homepage    = "https://github.com/JayTeeSF/interactive_grep"
+  s.summary     = %q{My very first Ruby program, which helped me interactively grep for multi-line patterns in gzipped weblogs}
+  s.description = %q{Interactively grep for stuff in (optionally gzipped) files}
+  s.rubyforge_project = "interactive_grep"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.bindir        = 'bin'
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec", "~> 2.11.0"
+end

data/lib/interactive_grep.rb

@@ -0,0 +1,3 @@
+require 'interactive_grep/version'
+require 'interactive_grep/grepper'
+module InteractiveGrep; end

data/lib/interactive_grep/grepper.rb

@@ -0,0 +1,133 @@
+module InteractiveGrep
+  class Grepper
+    require 'zlib'
+
+    @@DEBUG = false
+    attr_accessor :in_file, :ending, :def_pattern, :interactive, :counter, :just_count, :gz
+
+    def initialize(in_file,def_pattern=".",just_count=false,interactive=nil)
+      @counter = 0
+      @file_index = 0
+      @in_file = [ in_file.chomp ]
+      m = /(\.[^\.]+)$/.match(@in_file[0])
+
+      @ending = m[1] || ''
+
+      # handle glob...
+      if /\*/.match(@in_file[0])
+        @in_file = Dir.glob(@in_file[0]).map{|fname| fname}
+      end
+
+      @def_pattern = /#{def_pattern}/; #%r{ #{def_pattern} }
+      if interactive && just_count
+        just_count = false
+      end
+
+      @just_count = just_count
+      @interactive = interactive
+      @gz = false
+      if '.gz' == @ending
+        @gz = true
+      end
+
+      if @@DEBUG
+        print "using:\n\tin_file: #{@in_file}\n\tw/ ending:"
+        print "#{@ending}\n\tdef_pattern: #{@def_pattern}\n"
+      end
+    end
+
+    def prompt(pattern, msg, display=true)
+      if display && msg
+        @counter += 1
+        if !@just_count
+          if @@DEBUG
+            puts "" 
+            puts ">>"
+          end
+          print msg
+          if @@DEBUG
+            puts "<<"
+          end
+          puts ""
+        end
+      end
+
+      if @interactive.nil?
+        if @@DEBUG
+          puts "interactive mode is off"
+        end
+        pattern
+      else
+        puts "S | O | <pattern: [#{pattern}]> ? "
+        user_input = STDIN.gets.chomp
+        puts ""
+        if @@DEBUG
+          puts "user_input: >>#{user_input}<<"
+        end
+
+        case
+        when /^\s*$/.match(user_input) #corresponds w/ <enter> (or <return>)
+          if @@DEBUG
+            puts "user hit <return> (cont w/ same pattern)"
+          end
+          pattern
+        when ( (user_input == "o") || (user_input == "O") ) #interactive mode Off
+          @interactive = nil
+          if @@DEBUG
+            puts "turned interactive mode off"
+          end
+          pattern
+        when ( (user_input == "s") || (user_input == "S") ) #Show every line
+          if @@DEBUG
+            puts "show next line"
+          end
+          /./
+        else #use whatever was entered
+          if @@DEBUG
+            puts "use whatever was entered"
+          end
+          %r{#{user_input}}
+        end
+      end
+    end
+
+    def run(display_results=true)
+      results = []
+      while (1 + @file_index) < @in_file.count
+        myfh = get_file_handle()
+        pattern = @def_pattern
+        while line = myfh.gets
+          if pattern.match(line)
+            if @@DEBUG
+              puts ""
+            end
+            if line
+              line.strip!
+              results << line
+            end
+            pattern = prompt( pattern, line, display_results )
+            if @@DEBUG
+              puts ""
+            end
+          end
+          if @@DEBUG
+            puts "."
+          end
+        end
+      end
+      puts "count: #{@counter}" if @just_count
+      results
+    end
+
+    def get_file_handle
+      handle = nil
+      if @gz
+        handle = Zlib::GzipReader.open(@in_file[@file_index]);
+      else
+        handle = File.open(@in_file[@file_index], 'r')
+      end
+      @file_index += 1
+      handle
+    end
+  end
+end

data/lib/interactive_grep/version.rb

@@ -0,0 +1,3 @@
+module InteractiveGrep
+  VERSION = "0.0.1"
+end

data/spec/lib/interactive_grep/grepper_spec.rb

@@ -0,0 +1,17 @@
+require  "spec_helper"
+describe InteractiveGrep::Grepper do
+  context "initialization" do
+    context "with invalid params" do
+      it "should raise an error" do
+        expect { InteractiveGrep::Grepper.new }.to raise_error(ArgumentError)
+        expect { InteractiveGrep::Grepper.new(:one) }.to raise_error
+      end
+    end
+    context "with valid params" do
+      it "should not raise an error" do
+        expect { InteractiveGrep::Grepper.new( "./*.gz" ) }.not_to raise_error
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "bundler"
+Bundler.setup
+
+require "rspec"
+require "interactive_grep"

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: interactive_grep
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- JayTeeSr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70239385100440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: *70239385100440
+description: Interactively grep for stuff in (optionally gzipped) files
+email:
+- jaytee_sr_at_his-service_dot_net
+executables:
+- igrep
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.txt
+- Rakefile
+- bin/igrep
+- interactive_grep.gemspec
+- lib/.DS_Store
+- lib/interactive_grep.rb
+- lib/interactive_grep/.DS_Store
+- lib/interactive_grep/grepper.rb
+- lib/interactive_grep/version.rb
+- spec/lib/interactive_grep/grepper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/JayTeeSF/interactive_grep
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: interactive_grep
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: My very first Ruby program, which helped me interactively grep for multi-line
+  patterns in gzipped weblogs
+test_files:
+- spec/lib/interactive_grep/grepper_spec.rb
+- spec/spec_helper.rb