ssoroka-grepmate 1.0.1 → 2.0.0

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Steven Soroka
+
+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.rdoc

@@ -0,0 +1,60 @@
+= Grepmate
+
+Extremely fast search of rails projects or rails source for code, open in textmate or browser with html output
+
+== Usage
+
+    NAME
+      grepmate
+
+    SYNOPSIS
+      grepmate [what_to_search_for*] [dir=dir] [options]+
+
+    PARAMETERS
+      what_to_search_for (-1 ~> what_to_search_for) 
+          Search terms. Enclose in quotes to search for phrase. use with -e or 
+          --regex option for regular expression support 
+      dir=dir (-1 ~> dir) 
+          Directories to search. Defaults to project dirs. 
+      --case 
+          Case sensitive search (default is off). 
+      --textmate, -t 
+          open matches in textmate 
+      --html 
+          Turn on html output (default) 
+      --text 
+          show matches as text, file and line number 
+      --file_and_line, -f 
+          output only match file and line number 
+      --rails, -r 
+          Search Rails source, in addition to whatever is named by dir parameter 
+          etc. 
+      --only_rails, -R 
+          Search only Rails source, not the project. Takes precedence over dir 
+          parameter 
+      --gems, -g 
+          Search all gems, in addition to whatever is named by dir parameter 
+          etc. 
+      --only_gems, -G 
+          Search only gems, not the project. Takes precedence over dir parameter 
+      --wait, -w 
+          Wait between finds until TextMate file is closed. Only works with 
+          textmate output (--textmate or -t). 
+      --count, -c 
+          Display only the number of matches. 
+      --regex, -e 
+          use regular expression search terms 
+      --verbose, -v 
+          Turn on verbose mode and explain everything 
+      --help, -h 
+
+== Authors
+
+- Steven Soroka
+- Zach Holt
+
+== To Do
+
+- check ~/.grepmate for current rails repo to use instead of always using latest
+- add include parameter to selectively include file extensions
+- Allow global and cwd .gmconfig files to determine things like exclusions and inclusions.

data/Rakefile

@@ -1,14 +1,52 @@
 require 'rubygems'
 require 'rake'
-require 'echoe'
 
-Echoe.new('grepmate', '1.0.1') do |p|
-  p.description = 'Extremely fast search of rails projects or rails source for code, open in textmate or browser with html output'
-  p.url = 'http://github.com/ssoroka/grepmate'
-  p.author = 'Steven Soroka'
-  p.email = 'ssoroka78@gmail.com'
-  p.ignore_pattern = ["tmp/*"]
-  p.development_dependencies = ['main']
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "grepmate"
+    gem.summary = %Q{Extremely fast search of rails projects or rails source for code, open in textmate or browser with html output}
+    gem.description = gem.summary
+    gem.email = "ssoroka78@gmail.com"
+    gem.homepage = "http://github.com/ssoroka/grepmate"
+    gem.authors = ["Steven Soroka", 'Zach Holt']
+    gem.add_dependency 'main', '>= 2.8.3'
+    gem.add_dependency 'syntax', '>= 1.0.0'
+    gem.executables = ['grepmate']
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "grepmate #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each{|f| load f }

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/bin/grepmate

@@ -1,300 +1,86 @@
 #!/usr/bin/env ruby
-# script/grepmate    brought to you by Steven Soroka and Zach Holt
-# script/grepmate --help for help screen
 require 'rubygems'
 gem 'main', '>=2.8.0'
-require 'main' # don't think this line is needed. gem should require it
-
-def gem_path
-  `gem environment gemdir`.chomp
-end
-
-def gems_path
-  File.join(gem_path, 'gems')
-end
-
-def rails_version
-  `rails -v`.chomp.split(' ').last
-end
-
-def rails_path
-  vendor_rails = "vendor/rails"
-
-  if File.exist?(vendor_rails)
-    vendor_rails
-  else
-    Dir["#{gems_path}/acti*-#{rails_version}"]
-  end
-end
+require 'main'
+require File.join(File.dirname(__FILE__), %w(.. lib grepmate))
 
 Main {
-  option( 'case' ) {
+  option('case') {
+    cast :bool
+    description 'Case sensitive search (default is off).'
+  }
+
+  option('textmate', 't') {
+    cast :bool
+    description 'open matches in textmate'
+  }
+  
+  option('html') {
     cast :bool
-    description 'Case sensitive search (exclude for case insensitive).'
+    description 'Turn on html output (default)'
   }
 
-  option( 'no_html', 'H' ) {
+  option('text') {
     cast :bool
-    description 'Turn off HTML output.'
+    description 'show matches as text, file and line number'
   }
 
-  option( 'only_rails', 'R' ) {
+  option('file_and_line', 'f') {
     cast :bool
-    description 'Search Rails source, not the project.  Takes precedence over dir='
+    description 'output only match file and line number'
   }
 
-  option( 'rails', 'r' ) {
+  option('rails', 'r') {
     cast :bool
-    description 'Search Rails source, in addition to whatever is named by dir= dir= etc.'
+    description 'Search Rails source, in addition to whatever is named by dir parameter etc.'
   }
   
+  option('only_rails', 'R') {
+    cast :bool
+    description 'Search only Rails source, not the project.  Takes precedence over dir parameter'
+  }
+
   option('gems', 'g') {
     cast :bool
-    description "Search all gems, in addition to whatever is named by dir= dir= etc."
+    description "Search all gems, in addition to whatever is named by dir parameter etc."
   }
 
   option('only_gems', 'G') {
     cast :bool
-    description "Search only gems, not the project.  Takes precedence over dir="
+    description "Search only gems, not the project.  Takes precedence over dir parameter"
   }
 
-  option( 'wait', 'w' ) {
+  option('wait', 'w') {
     cast :bool
-    description 'Wait between finds until TextMate is closed.  Only works with --no_html.'
+    description 'Wait between finds until TextMate file is closed.  Only works with textmate output (--textmate or -t).'
   }
 
-  option( 'count', 'c' ) {
+  option('count', 'c') {
     cast :bool
     description 'Display only the number of matches.'
   }
 
-  keyword( 'dir', 'd' ) {
-    arity -1
-    default 'app', 'config', 'db', 'lib', 'spec', 'public', 'vendor/plugins', 'test/selenium_fixtures', 'test/selenium'
-    description 'Directories to search. Defaults to project.'
+  option('regex', 'e') {
+    description 'use regular expression search terms'
   }
-
-  keyword( 'exclude' ) {
-    arity -1
-    cast { |v| Regexp.new( v ) }
-    default '\.sql$', '\.log$', '\.tmp$', '\.gz$', '\.bz2$', '\.tar$', '\.db$', '\.sqlite$', '\.sqlite3$', '\.csv$', '\.DS_Store$', '\.svn', '\.git', '\.CSV$', 'grepmate\.html$'
-    description 'Exclude paths matching these patterns.'
+  
+  option('verbose', 'v') {
+    description 'Turn on verbose mode and explain everything'
   }
 
-  keyword( 'tempfile' ) {
-    arity 1
-    default '/tmp/grepmate_out.html'
-    description "Where to store search results for HTML output.  Terminate with .html"
+  keyword('dir', 'd') {
+    arity -1
+    description 'Directories to search. Defaults to project dirs.'
   }
-
-  argument( 'what_to_search_for' ) {
+  
+  argument('what_to_search_for') {
     arity -1
-    description "What to search for.  Enclose in quotes to search for phrase."
+    description "Search terms.  Enclose in quotes to search for phrase.  use with -e or --regex option for regular expression support"
   }
 
-
-  def determine_directories_to_search
-    if @stdin.tty?
-      dirs = if params['only_rails'].value || params['only_gems'].value
-        [] 
-      else
-        params['dir'].values
-      end
-      dirs += Array(rails_path) if params['only_rails'].value || params['rails'].value
-      dirs << gems_path if params['only_gems'].value || params['gems'].value
-    else
-      dirs = []
-      input = @stdin.read
-
-      input.split( "\n" ).each do |ln|
-        if ln =~ /^([^:]*)/ # Assume everything to the first colon is a file name
-          filename = File.expand_path( $1 )
-          if File.exist?( filename ) # But actually check that it is
-            dirs << filename
-          end
-        end
-      end
-    end
-    dirs.map{ |dir| File.expand_path( dir ) }.uniq
-  end
-
-  def determine_what_to_search_for
-    # funny bunny => 'funny' 'bunny'
-    # 'funny bunny' => 'funny bunny'
-    params['what_to_search_for'].values.map {|v| "\"#{v.gsub( /"/, '\\"' )}\"" }.join( " " )
-  end
-
-  def determine_javascript_highlight_text
-    # funny bunny => 'funny' 'bunny'
-    # 'funny bunny' => 'funny bunny'
-    params['what_to_search_for'].values.map {|v| "highlightSearchTerms('#{v.gsub( /'/, "\\'" ).gsub( /:/, "\\:" )}', false)" }.join( ";" )
-  end
-
-  def find( what_to_find, opts={} )
-    directories = opts[:in]
-
-    paths = `find #{directories.join(' ')}`.split( "\n" )
-
-    paths.delete_if { |path| params['exclude'].values.any?{ |exclude| path =~ exclude } }
-
-    cmd = 'grep '
-    cmd << '-i ' unless params['case'].value
-    # 3 lines of context unless we're not displaying html, or we're counting, or we're piping into another process
-    cmd << '-C 3 ' if !params['no_html'].value && !params['count'].value && @stdout.tty?
-
-    # paths get too large for grep to handle, so limit the number it has to deal with at once.
-    results = []
-    paths.each_slice(100) {|paths|
-      results += `#{cmd} -n #{what_to_find} #{paths.join(" ")}`.split( "\n" )
-    }
-    results
-  end
-
-  def display( results )
-    if results.empty?
-      puts "Nothing found!"
-      exit
-    elsif params['count'].value
-      puts "Matches: #{results.size}"
-      exit
-    end
-
-    if @stdout.tty?
-      if params['no_html'].value
-        display_textmate results
-      else
-        display_html results
-      end
-    else
-      puts results
-    end
-  end
-
-  def display_textmate( results )
-    print "Found #{results.size} matches.  "
-    if results.size > 20
-      puts  "Display? [Y/n]..."
-      exit if $stdin.gets.chomp.downcase == 'n'
-    end
-
-    results.each { |f|
-      file, line = f.split( ':' )
-      system( "mate #{'-w ' if params['wait'].value}-l #{line} #{file}" )
-    }
-  end
-
-  def display_html( results )
-    syntax_installed = true
-    begin
-      require 'syntax/convertors/html'
-    rescue LoadError
-      syntax_installed = false
-    end
-
-    html = '<html><head>'
-    html << <<-CSS
-<style type="text/css">body { background-color: #EEEEEE; } pre {
-display: inline; } .ruby { font-family: Monaco; font-size: 10pt;
-background-color: white } .ruby .normal {} .ruby .comment { color:
-#005; font-style: italic; } .ruby .keyword { color: #A00; font-weight:
-bold; } .ruby .method { color: #077; } .ruby .class { color: #074; }
-.ruby .module { color: #050; } .ruby .punct { color: #447; font-weight:
-bold; } .ruby .symbol { color: #099; } .ruby .string { color: #944;
-background: #FFE; } .ruby .char { color: #F07; } .ruby .ident { color:
-#004; } .ruby .constant { color: #07F; } .ruby .regex { color: #B66;
-background: #FEF; } .ruby .number { color: #F99; } .ruby .attribute {
-color: #7BB; } .ruby .global { color: #7FB; } .ruby .expr { color:
-#227; } .ruby .escape { color: #277; } .ruby .highlight {
-background-color: yellow; font-weight: 900; } td.lineno { text-align:
-right; font-family: Monaco; font-size: 9pt; padding-right: 10px; }
-td.filename { padding-top: 35px; font-family: Monaco; font-size: 14pt;
-}</style>
-
-<script type="text/javascript">
-// http://www.nsftools.com/misc/SearchAndHighlight.htm
-
-function doHighlight(bodyText,searchTerm,highlightStartTag,highlightEndTag)
-{if((!highlightStartTag)||(!highlightEndTag)){highlightStartTag="<font style='color:blue; background-color:yellow;'>";highlightEndTag="</font>";}
-var newText="";var i=-1;var lcSearchTerm=searchTerm.toLowerCase();var lcBodyText=bodyText.toLowerCase();while(bodyText.length>0){i=lcBodyText.indexOf(lcSearchTerm,i+1);if(i<0){newText+=bodyText;bodyText="";}else{if(bodyText.lastIndexOf(">",i)>=bodyText.lastIndexOf("<",i)){if(lcBodyText.lastIndexOf("/script>",i)>=lcBodyText.lastIndexOf("<script",i)){newText+=bodyText.substring(0,i)+highlightStartTag+bodyText.substr(i,searchTerm.length)+highlightEndTag;bodyText=bodyText.substr(i+searchTerm.length);lcBodyText=bodyText.toLowerCase();i=-1;}}}}
-return newText;}
-function highlightSearchTerms(searchText,treatAsPhrase,warnOnFailure,highlightStartTag,highlightEndTag)
-{if(treatAsPhrase){searchArray=[searchText];}else{searchArray=searchText.split(" ");}
-if(!document.body||typeof(document.body.innerHTML)=="undefined"){if(warnOnFailure){alert("Sorry, for some reason the text of this page is unavailable. Searching will not work.");}
-return false;}
-var bodyText=document.body.innerHTML;for(var i=0;i<searchArray.length;i++){bodyText=doHighlight(bodyText,searchArray[i],highlightStartTag,highlightEndTag);}
-document.body.innerHTML=bodyText;return true;}</script></script>
-  CSS
-
-    html << "</head><body onLoad=\"#{determine_javascript_highlight_text}\">"
-
-    syntax_converter = ( syntax_installed ? Syntax::Convertors::HTML.for_syntax( "ruby" ) : nil )
-    html << '<pre>sudo gem install syntax</pre> to get syntax highlighting<br><br>' unless syntax_installed
-
-    html << '<table cellspacing="0" cellpadding="2">'
-
-    last_file = ''
-    separator = false
-
-    html << results.map{ |line|
-      if line == '--'
-        separator = true
-        ''
-      elsif line =~ /^(.+?)-(\d+)-(.*)$/ || line =~ /^(.+?):(\d+):(.*)$/
-        file = $1
-        line = $2
-        context = $3
-
-        file_group = ''
-
-        if file == last_file
-          file_group << "<tr><td class=\"lineno\">...</td><td></td></tr>" if separator
-        else
-          parts = file.split( /\// )
-          path = ''
-          file_group << "<tr><td colspan=\"2\" class=\"filename\">"
-          parts.each do |part|
-            path << "/#{part}"
-            file_group << "/" unless part.equal?( parts.first )
-            if part.equal?( parts.last )
-              file_group << "<a href=\"txmt://open?url=file://#{file}\">#{part}</a>"
-            else
-              file_group << "<a href=\"file:/#{path}\">#{part}</a>"
-            end
-          end
-          file_group << "</td></tr>\n"
-        end
-
-        separator = false
-        last_file = file
-
-        file_group << "<tr><td class=\"lineno\"><a href=\"txmt://open?url=file://#{file}&line=#{line}\">#{line}</a></td>"
-
-        converted = begin
-          syntax_converter ? syntax_converter.convert( context =~ /^(.+?)\s*$/ ? $1 : context ) : context
-        rescue Exception => e
-          "TOKENIZING ERROR: #{context} <!-- \n#{e.message}\n#{e.backtrace.join("\n")}\n -->"
-        end
-        file_group << "<td class=\"ruby\">#{ converted }</td></tr>\n"
-
-        file_group
-      end
-    }.join
-
-    html << '</table></body></html>'
-
-    FileUtils.makedirs( File.dirname( params['tempfile'].value ) )
-    FileUtils.touch( params['tempfile'].value )
-    File.open( params['tempfile'].value, 'w' ) { |f| f.write(html) }
-
-    system( "open #{params['tempfile'].value}" )
-  end
-
   def run
-    haystack = determine_directories_to_search
-    needle = determine_what_to_search_for
-
-    results = find needle, :in => haystack
-
-    display results
+    grepmate = Grepmate.new(params)
+    grepmate.find
+    grepmate.display
   end
 }