grep-fu 0.4.0 → 0.5.0

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/README.md

@@ -132,6 +132,17 @@ to
 
 And migrations will no longer be searched.  Note that targeted searches and specified directories always override the PRUNE_PATHS option.
 
+Version Information
+-------------------
+
+Passing the '--version' flag to grep-fu will return the current version.
+
+    grep-fu --version
+
+returns
+
+    grep-fu 0.5.0
+
 Technical mumbo-jumbo
 ---------------------
 
@@ -147,7 +158,7 @@ Grep-Fu speeds up the searching process by only searching the files you care abo
 
 Note that all these directories are still searchable with targeted searches or a directory specification; they're simply not searched by default
 
-Grep-fu also ignores files larger than 100K, which tend to be unsearchable binaries.
+Grep-fu also ignores files larger than 100K, which tend to be unsearchable binaries or SQL dumps.
 
 The pruning options for find are some of the ugliest in the CLI world.  Using Ruby allows us to construct a giant, hideous command that does exactly what we need.
 

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'rake'
+require 'spec/rake/spectask'
 
 begin
   require 'jeweler'
@@ -36,7 +37,12 @@ rescue LoadError
   end
 end
 
-task :test => :check_dependencies
+desc "Run all specs"
+Spec::Rake::SpecTask.new('run_specs') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+end
+
+task :test => [:check_dependencies, :run_specs]
 
 task :default => :test
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/bin/grep-fu

@@ -1,61 +1,5 @@
 #!/usr/bin/env ruby
-
-PATH_REPLACEMENTS = {
-                      'a' => 'app', 
-                      'c' => 'app/controllers', 
-                      'h' => 'app/helpers', 
-                      'm' => 'app/models', 
-                      'v' => 'app/views', 
-                      'l' => 'lib',
-                      'p' => 'public', 
-                      'css' => 'public/stylesheets', 
-                      'js' => 'public/javascripts', 
-                      't' => 'test',
-                      's' => 'spec',
-                      'vp' => 'vendor/plugins',
-                      'mig' => 'db/migrate'
-                    }
-
-PRUNE_PATHS = ['/.svn', '/.git', '/vendor', '/log', '/public', '/tmp', '/coverage']
-COLOR_ON_BY_DEFAULT = false
-options = '-ril'
-
-unless ARGV.size > 0
-  puts "\nUsage: #{__FILE__} [findpath] search_string [--verbose|--single-line]\n
-    Where findpath is one of the following:
-      any literal subdirectory
-#{PATH_REPLACEMENTS.map { |abbr, txt| "      #{abbr} - #{txt}" }.join("\n")}\n\n"
-  exit
-end
-
-clargs = ARGV
-
-verbose = (clargs -= ['--verbose'] if clargs.include?('--verbose'))
-single_line = (clargs -= ['--single-line'] if clargs.include?('--single-line'))
-color = (clargs -= ['--color'] if (clargs.include?('--color')) || COLOR_ON_BY_DEFAULT)
-
-if clargs.include?('--no-color')
-  clargs -= ['--no-color']
-  color = false
-end
-
-options = '-rin' if verbose
-options << ' --color=always' if color
-
-search_criteria = clargs.last
-file_path = clargs.size == 2 ? PATH_REPLACEMENTS[clargs.first] || clargs.first : './'
-delicious_prunes = PRUNE_PATHS ? "-path '*#{PRUNE_PATHS.join("' -prune -o -path *'")}' -prune -o" : ''
-
-find_command = "find #{file_path} #{delicious_prunes} \\( -size -100000c -type f \\) -print0 | xargs -0 grep #{options} \"#{search_criteria}\""
-
-if verbose
-  `#{find_command}`.each_line do |found|
-    file_and_line = found.slice!(/^.*?:.*?:/)
-    puts "#{file_and_line}\n\t#{found.strip}"
-  end
-elsif single_line
-  puts `#{find_command}`.map { |found| found.chomp }.join(' ')
-else
-  puts `#{find_command}`
-end
-
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'grep-fu'
+ 
+GrepFu::run!(ARGV)

data/grep-fu.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{grep-fu}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eric Budd"]
-  s.date = %q{2010-05-27}
+  s.date = %q{2010-06-16}
   s.default_executable = %q{grep-fu}
   s.description = %q{Grep-Fu is a very fast, Rails-oriented command-line helper script for grep.}
   s.email = %q{calamitous@calamitylane.com}
@@ -19,18 +19,32 @@ Gem::Specification.new do |s|
      "README.md"
   ]
   s.files = [
-    "LICENSE",
+    ".gitignore",
+     "LICENSE",
      "README.md",
      "Rakefile",
      "VERSION",
      "bin/grep-fu",
-     "grep-fu.gemspec"
+     "grep-fu.gemspec",
+     "lib/grep-fu.rb",
+     "lib/grep-fu/find_builder.rb",
+     "lib/grep-fu/options.rb",
+     "spec/find_builder_spec.rb",
+     "spec/grep_fu_spec.rb",
+     "spec/options_spec.rb",
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/Calamitous/grep-fu}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Grep-Fu is a very fast, Rails-oriented command-line helper script for grep.}
+  s.test_files = [
+    "spec/find_builder_spec.rb",
+     "spec/options_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/grep_fu_spec.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/grep-fu/find_builder.rb

@@ -0,0 +1,20 @@
+module GrepFu
+  class FindBuilder
+    PRUNE_PATHS = ['/.svn', '/.git', '/vendor', '/log', '/public', '/tmp', '/coverage']
+
+    def self.delicious_prunes
+      "-path '*#{PRUNE_PATHS.join("' -prune -o -path '*")}' -prune -o"
+    end
+
+    def self.find_command(options)
+      [
+        'find',
+        options.file_path,
+        delicious_prunes,
+        "\\( -size -100000c -type f \\) -print0 | xargs -0 grep",
+        options.to_s,
+        "\"#{options.search_criteria}\""
+      ].join(' ')
+    end
+  end
+end

data/lib/grep-fu/options.rb

@@ -0,0 +1,61 @@
+module GrepFu
+  class Options
+    attr_reader :verbose, :single_line, :color, :search_criteria, :file_path 
+
+    PATH_REPLACEMENTS = {
+      'a' => 'app', 
+      'c' => 'app/controllers', 
+      'h' => 'app/helpers', 
+      'm' => 'app/models', 
+      'v' => 'app/views', 
+      'l' => 'lib',
+      'p' => 'public', 
+      'css' => 'public/stylesheets', 
+      'js' => 'public/javascripts', 
+      't' => 'test',
+      's' => 'spec',
+      'vp' => 'vendor/plugins',
+      'mig' => 'db/migrate'
+    }
+
+    COLOR_ON_BY_DEFAULT = false
+
+    def self.usage(file)
+      lines = ['',
+        "Usage: #{file} [findpath] search_string [--verbose|--single-line]\n",
+        "    Where findpath is one of the following:",
+        "      any literal subdirectory",
+        Options::PATH_REPLACEMENTS.map { |abbr, txt| "      #{abbr} - #{txt}" }.join("\n"),
+      "\n\n"
+      ]
+
+      lines.join("\n")
+    end
+
+    def initialize(args)
+      if args.include?('--version')
+        puts "grep-fu #{File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION'))}"
+        exit(0)
+      end
+
+      @verbose = (args -= ['--verbose'] if args.include?('--verbose'))
+      @single_line = (args -= ['--single-line'] if args.include?('--single-line'))
+
+      @color = (args -= ['--color'] if (args.include?('--color')) || COLOR_ON_BY_DEFAULT)
+      if args.include?('--no-color')
+        args -= ['--no-color']
+        @color = false
+      end
+
+      @search_criteria = args.last
+      @file_path = args.size == 2 ? PATH_REPLACEMENTS[args.first] || args.first : './'
+    end
+
+    def to_s
+      options = @verbose ? '-rin' : '-ril'
+      options << ' --color=always' if @color
+      options
+    end
+
+  end
+end

data/lib/grep-fu.rb

@@ -0,0 +1,26 @@
+require 'grep-fu/options'
+require 'grep-fu/find_builder'
+
+module GrepFu
+  def self.run!(args = [])
+    unless args.size > 0
+      puts Options.usage(__FILE__)
+      return
+    end
+
+    options = Options.new(args)
+
+    find_command = FindBuilder.find_command(options)
+
+    if options.verbose
+      `#{find_command}`.each_line do |found|
+        file_and_line = found.slice!(/^.*?:.*?:/)
+        puts "#{file_and_line}\n\t#{found.strip}"
+      end
+    elsif options.single_line
+      puts `#{find_command}`.map { |found| found.chomp }.join(' ')
+    else
+      puts `#{find_command}`
+    end
+  end
+end

data/spec/find_builder_spec.rb

@@ -0,0 +1,58 @@
+require 'grep-fu/find_builder'
+require 'spec/spec_helper'
+
+describe GrepFu::FindBuilder do
+  describe "#delicious_prunes" do
+    it "should create command-line options for pruning path" do
+      silence_warnings { GrepFu::FindBuilder::PRUNE_PATHS = ['/pruney'] }
+      GrepFu::FindBuilder.delicious_prunes.should == "-path '*/pruney' -prune -o"
+    end
+
+    it "should create command-line options for multiple pruning paths" do
+      silence_warnings { GrepFu::FindBuilder::PRUNE_PATHS = ['/pruney', '/apply'] }
+      GrepFu::FindBuilder.delicious_prunes.should == "-path '*/pruney' -prune -o -path '*/apply' -prune -o"
+    end
+  end
+
+  describe "#find_command" do
+    before(:each) do
+      GrepFu::FindBuilder.stub!(:delicious_prunes).and_return('prune_list')
+      @options = mock(Object,
+                      :file_path => 'path',
+                      :to_s => 'str_opts',
+                      :search_criteria => 'crits')
+      @find_command = GrepFu::FindBuilder.find_command(@options)
+    end
+
+    it "should start with the find command" do
+      @find_command.should =~ /^find\s/
+    end
+
+    it "should contain the file path" do
+      @find_command.should =~ /\spath\s/
+    end
+
+    it "should contain all the pruned directories" do
+      @find_command.should =~ /\sprune_list\s/
+    end
+
+    it "should contain a blob of bash muck" do
+      @find_command.should =~ /\s.. -size -100000c -type f .. -print0 | xargs -0 grep\s/
+    end
+
+    it "should contain the options" do
+      @find_command.should =~ /\sstr_opts\s/
+    end
+
+    it "should end with the quoted search criteria" do
+      @find_command.should =~ /\s"crits"$/
+    end
+
+    it "should stitch together a long, long find command" do
+      @find_command.should =~ /find path prune_list .. -size -100000c -type f .. -print0 | xargs -0 grep str_opts \"crits\"/
+    end
+
+  end
+
+end
+

data/spec/grep_fu_spec.rb

@@ -0,0 +1,76 @@
+require 'grep-fu'
+require 'spec/spec_helper'
+
+describe GrepFu do
+  describe "#run!" do
+    before(:each) do
+      GrepFu.stub!(:puts)
+    end
+
+    describe "with no arguments provided" do
+      it "should print the usage and exit if no arguments are provided" do
+        GrepFu::Options.should_receive(:usage).and_return('Usage: etc.')
+        GrepFu.should_receive(:puts).with('Usage: etc.')
+        GrepFu.run!
+      end
+
+      it "should exit early if no arguments are provided" do
+        GrepFu::Options.should_not_receive(:new)
+        GrepFu.run!
+      end
+    end
+
+    describe "with valid arguments" do
+      before(:each) do
+        @options = mock(GrepFu::Options, :verbose => false, :single_line => false)
+        @find_command = "find me"
+        GrepFu::Options.stub!(:new).and_return(@options)
+        GrepFu::FindBuilder.stub!(:find_command).and_return(@find_command)
+        GrepFu.stub!(:'`')
+      end
+
+      it "should create options from provided arguments" do
+        GrepFu::Options.should_receive(:new).with('arguments!')
+        GrepFu.run!('arguments!')
+      end
+
+      it "should build a find command from options" do
+        GrepFu::FindBuilder.should_receive(:find_command).with(@options)
+        GrepFu.run!('arguments!')
+      end
+
+      it "should display the results of the find" do
+        GrepFu.should_receive(:'`').with(@find_command)
+        GrepFu.run!(['stuff_to_find'])
+      end
+
+      it "should appropriately format results for single-line requests" do
+        @options.stub!(:single_line).and_return(true)
+        GrepFu.stub!(:'`').and_return("line one\nline two\nlast line\n")
+        GrepFu.should_receive(:puts).with('line one line two last line')
+        GrepFu.run!(['--single-line'])
+      end
+
+      it "should appropriately format results for verbose requests" do
+        @options.stub!(:verbose).and_return(true)
+        verbose_returns = [
+          "app/views/mailer/new_notification.text.plain.erb:1:A new notification has arrived!",
+          "README:45:                    although it's not clear who might have",
+          "app/models/funge.rb:22:       Hugenot.new"
+        ].join("\n")
+
+        formatted_returns = [
+          "app/views/mailer/new_notification.text.plain.erb:1:\n\tA new notification has arrived!",
+          "README:45:\n\talthough it's not clear who might have",
+          "app/models/funge.rb:22:\n\tHugenot.new"
+        ]
+
+        GrepFu.stub!(:'`').and_return(verbose_returns)
+        GrepFu.should_receive(:puts).with(formatted_returns[0])
+        GrepFu.should_receive(:puts).with(formatted_returns[1])
+        GrepFu.should_receive(:puts).with(formatted_returns[2])
+        GrepFu.run!(['not', '--verbose'])
+      end
+    end
+  end
+end

data/spec/options_spec.rb

@@ -0,0 +1,55 @@
+require 'grep-fu/options'
+require 'spec/spec_helper'
+
+describe GrepFu::Options do
+  it "should instantiate correctly" do
+    GrepFu::Options.new([])
+  end
+
+  it "should set the verbose option to true, if provided" do
+    GrepFu::Options.new(['--verbose']).verbose.should be_true
+  end
+
+  it "should set the single-line option to true, if provided" do
+    GrepFu::Options.new(['--single-line']).single_line.should be_true
+  end
+
+  it "should set the color option to true, if provided" do
+    GrepFu::Options.new(['--color']).color.should be_true
+  end
+
+  it "should default to no color" do
+    GrepFu::Options.new([]).color.should be_false
+  end
+
+  it "should allow color to be disabled from the command line" do
+    GrepFu::Options.new(['--no_color']).color.should be_false
+  end
+
+  it "should change color default based on constant" do
+    silence_warnings { GrepFu::Options::COLOR_ON_BY_DEFAULT = true }
+    GrepFu::Options.new([]).color.should be_true
+  end
+
+  it "should allow color to be disabled from the command line when default is color=true" do
+    silence_warnings { GrepFu::Options::COLOR_ON_BY_DEFAULT = true }
+    GrepFu::Options.new(['--no-color']).color.should be_false
+  end
+
+  it "should set the search criteria to the last non-option flag in the list" do
+    GrepFu::Options.new(%w{offer}).search_criteria.should == 'offer'
+    GrepFu::Options.new(%w{a help --color}).search_criteria.should == 'help'
+    GrepFu::Options.new(%w{lib/tasks unrake --verbose --color}).search_criteria.should == 'unrake'
+  end
+
+  it "should expand the file_path to one of the replacement variables, if found" do
+    GrepFu::Options.new(%w{a value}).file_path.should == 'app'
+    GrepFu::Options.new(%w{s hoozits}).file_path.should == 'spec'
+    GrepFu::Options.new(%w{mig down --color}).file_path.should == 'db/migrate'
+  end
+
+  it "should accept an explicit find path, if provided" do
+    GrepFu::Options.new(%w{lib/tasks value}).file_path.should == 'lib/tasks'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+def silence_warnings
+  old_verbose, $VERBOSE = $VERBOSE, nil
+  yield
+ensure
+  $VERBOSE = old_verbose
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Eric Budd
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-27 00:00:00 -05:00
+date: 2010-06-16 00:00:00 -05:00
 default_executable: grep-fu
 dependencies: []
 
@@ -28,12 +28,20 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files: 
+- .gitignore
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
 - bin/grep-fu
 - grep-fu.gemspec
+- lib/grep-fu.rb
+- lib/grep-fu/find_builder.rb
+- lib/grep-fu/options.rb
+- spec/find_builder_spec.rb
+- spec/grep_fu_spec.rb
+- spec/options_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/Calamitous/grep-fu
 licenses: []
@@ -64,5 +72,8 @@ rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Grep-Fu is a very fast, Rails-oriented command-line helper script for grep.
-test_files: []
-
+test_files: 
+- spec/find_builder_spec.rb
+- spec/options_spec.rb
+- spec/spec_helper.rb
+- spec/grep_fu_spec.rb