gem_grep 0.1.1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2009 Gabriel Horner
+
+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,148 @@
+== Description
+
+Enhances search command by displaying results in an ascii table and providing options to search (--fields) and display (--columns) gemspec attributes. These options take any gemspec attribute and more than one when comma delimited. Gemspec attributes can be aliased by specifying the first unique string that it starts with i.e. "su" for "summary".
+
+== Install
+
+Install the gem with:
+
+    gem source -a http://gems.github.com && sudo gem install cldwalker-gem_grep
+
+== Examples
+
+If you want to choose what gemspec attributes (columns) you see in your results, no problem. Pass a
+comma delimited list to --columns/-c in the order you want to see them. For any gemspec attribute, you can pass its alias which is the first unique string that it starts with.
+
+    # n,ho,da are shortcuts for name,homepage,date
+    bash> gem grep -c n,ho,da irb
+
+    *** LOCAL GEMS ***
+
+    +----------------+-------------------------------------------------+--------------------------------+
+    | name           | homepage                                        | date                           |
+    +----------------+-------------------------------------------------+--------------------------------+
+    | cldwalker-hirb | http://github.com/cldwalker/hirb                | Thu Mar 12 00:00:00 -0400 2009 |
+    | irb_callbacks  | http://rubysideshow.rubyforge.org/irb_callbacks | Tue May 13 00:00:00 -0400 2008 |
+    | irb_rocket     | http://blog.s21g.com/genki                      | Sat Feb 07 00:00:00 -0500 2009 |
+    | sirb           | http://github.com/davidrichards/sirb            | Sun Mar 22 00:00:00 -0400 2009 |
+    | wirble         | http://pablotron.org/software/wirble/           | Fri Sep 08 00:00:00 -0400 2006 |
+    +----------------+-------------------------------------------------+--------------------------------+
+    5 rows in set
+
+Choosing your columns works for remote gems as well.
+
+    bash> gem grep console -r -c n,ho,des
+
+    *** REMOTE GEMS ***
+
+    +---------------------------+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
+    | name                      | homepage                                    | description                                                                                                              |
+    +---------------------------+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
+    | CapConsole                | http://handle.rubyforge.org                 | This adds a new capistrano task called console:shell which, when run, opens a script/console shell on your remote pro... |
+    | cldwalker-console_update  | http://github.com/cldwalker/console_update  | A rails plugin which allows you to edit your database records via the console and your favorite editor.                  |
+    | Console                   | http://www.nebulargauntlet.org              |                                                                                                                          |
+    | jtrupiano-timecop-console | http://github.com/jtrupiano/timecop-console |                                                                                                                          |
+    | live_console              | http://debu.gs/live-console                 |                                                                                                                          |
+    | mongrel_console           |                                             | Provides a combined Mongrel and Rails IRB console.                                                                       |
+    | simpleconsole             | http://simpleconsole.rubyforge.org          |                                                                                                                          |
+    | takai-twitty-console      | http://github.com/takai/twitty-console/     | TwittyConsole is a console based client for Twitter.                                                                     |
+    | timecop-console           | http://github.com/jtrupiano/timecop-console |                                                                                                                          |
+    | win32console              | http://rubyforge.org/projects/winconsole    | This gem packages Gonzalo Garramuno's Win32::Console project, and includes a compiled binary for speed. The Win32::Co... |
+    +---------------------------+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
+    10 rows in set
+
+For <b>local gems only</b>, you get increased searching ability with --fields/-f. Pass it a comma delimited list of gemspec attributes you want to search on, aliased as shown above. Let's see my gems that were created/authored by jamis:
+
+    bash> gem grep jamis -f a
+
+    *** LOCAL GEMS ***
+
+    +-----------------+------------------------------------------------------------------------------------------------------------------------------------------+------------+
+    | name            | summary                                                                                                                                  | authors    |
+    +-----------------+------------------------------------------------------------------------------------------------------------------------------------------+------------+
+    | capistrano      | Capistrano is a utility and framework for executing commands in parallel on multiple remote machines, via SSH.                           | Jamis Buck |
+    | needle          | Needle is a Dependnjection/Inversion of Control container for Ruby. It supports (constructor) i... | Jamis Buck |
+    | net-scp         | A pur                                                                     | Net::SFTP is a pure-Ruby implementation of the SFTP c                                        | Jamis Buck |
+    | net-ation of the SSH2 client protocol.                             Buck |
+    | net-ssh-gateway | A simple library to assist in esta                                                             |  to allow Ruby scripts to interface with a SQLite3 database.      | Jamis Buck |
+    | syntax          | Syntax is Ruby library for performing simple syntax highlighting.                                                                        | Jamis Buck |
+    +-----------------+------------------------------------------------------------------------------------------------------------------------------------------+------------+
+    8 rows in set
+
+As already mentioned, you can search multiple attributes. Let's search for irb inside gemspec attributes name, description and summary:
+
+    bash> gem grep irb -f n,su,des
+
+    *** LOCAL GEMS ***
+
+    +-----------------------+----------------------------------------------------------------------------------------------------------+------------------------------+
+    | name                  | summary                                                                                                  | authors                      |
+    +-----------------------+----------------------------------------------------------------------------------------------------------+------------------------------+
+    | cldwalker-hirb        | A mini view framework for irb that's easy to use, even while under its influence.                        | Gabriel Horner               |
+    | irb_callbacks         | Adds three callbacks to the prompt, eval, and output phases of irb                                       | Mike Judge                   |
+    | irb_rocket            | irb plugin that makes irb #=> rocket                                                                     | Genki Takiuchi               |
+    | matthew-method_lister | Pretty method listers and finders, for use in IRB.                                                       | Matthew O'Connor             |
+    | rtags                 | rtags is a Ruby replacement for ctags - allowing for name navigation in source code using vim, emacs ... | Pjotr Prins, Keiju Ishitsuka |
+    | sirb                  | Descriptive statistics + IRB + any other useful numerical library you may have around                    | David Richards               |
+    | utility_belt          | A grab-bag of IRB power user madness.                                                                    | Giles Bowkett                |
+    | wirble                | Handful of common Irb features, made easy.                                                               | Paul Duncan                  |
+    +-----------------------+----------------------------------------------------------------------------------------------------------+------------------------------+
+
+Like the default search and query commands, grep converts your search term to a regular expression. Let's use this to find out my gems that were created from 2000-2005. Hopefully not too many.
+
+    bash> gem grep 200[0-5] -f da -c n,da,su
+
+    *** LOCAL GEMS ***
+
+    +-------------+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+    | name        | date                           | summary                                                                                                                           |
+    +-------------+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+    | dnssd       | Thu Oct 07 00:00:00 -0400 2004 | DNS Service Discovery (aka Rendezvous) API for Ruby                                                                               |
+    | extensions  | Thu Dec 09 00:00:00 -0500 2004 | 'extensions' is a set of extensions to Ruby's built-in classes.  It gathers common idioms, useful additions, and aliases, comp... |
+    | mysql       | Sun Oct 09 00:00:00 -0400 2005 | MySQL/Ruby provides the same functions for Ruby programs that the MySQL C API provides for C programs.                            |
+    | needle      | Fri Dec 23 00:00:00 -0500 2005 | Needle is a Dependency Injection/Inversion of Control container for Ruby. It supports both type-2 (setter) and type-3 (constru... |
+    | Platform    | Thu Dec 01 00:00:00 -0500 2005 | Hopefully robust platform sensing                                                                                                 |
+    | RedCloth    | Thu Sep 15 00:00:00 -0400 2005 | RedCloth is a module for using Textile and Markdown in Ruby. Textile and Markdown are text formats.  A very simple text format... |
+    | stemmer     | Wed Apr 20 00:00:00 -0400 2005 | Word stemming algorithm(s)                                                                                                        |
+    | syntax      | Sat Jun 18 00:00:00 -0400 2005 | Syntax is Ruby library for performing simple syntax highlighting.                                                                 |
+    | termios     | Fri Sep 24 00:00:00 -0400 2004 | Termios module are simple wrapper for termios(3). It can be included into IO-family classes and can extend IO-family objects. ... |
+    | text-format | Fri Jun 24 00:00:00 -0400 2005 | Text::Format formats fixed-width text nicely.                                                                                     |
+    | text-hyphen | Mon Dec 20 00:00:00 -0500 2004 | Multilingual word hyphenation according to modified TeX hyphenation pattern files.                                                |
+    | tree        | Thu Dec 29 00:00:00 -0500 2005 | Ruby implementation of the Tree data structure.                                                                                   |
+    +-------------+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+    12 rows in set
+
+
+gem grep can also search inside gemspec attributes that are arrays i.e. @dependencies@. Let's see my gems that depend on rake:
+
+    bash> gem grep rake -f dep -c n,dep
+
+    *** LOCAL GEMS ***
+
+    +---------------+----------------------------------------------------------------------------------------------------------------------------------------------+
+    | name          | dependencies                                                                                                                                 |
+    +---------------+----------------------------------------------------------------------------------------------------------------------------------------------+
+    | bones         | rake (>= 0.8.3, runtime)                                                                                                                     |
+    | echoe         | rake (>= 0, runtime),rubyforge (>= 1.0.0, runtime),highline (>= 0, runtime)                                                                  |
+    | ferret        | rake (> 0.0.0, runtime)                                                                                                                      |
+    | hoe           | rubyforge (>= 1.0.1, runtime),rake (>= 0.8.3, runtime)                                                                                       |
+    | launchy       | rake (>= 0.8.1, runtime),configuration (>= 0.0.5, runtime)                                                                                   |
+    | mislav-hanna  | rdoc (~> 2.2.0, runtime),haml (~> 2.0.4, runtime),rake (~> 0.8.2, runtime),echoe (>= 0, runtime)                                             |
+    | mocha         | rake (>= 0, runtime)                                                                                                                         |
+    | rails         | rake (>= 0.7.2, runtime),activesupport (= 1.4.4, runtime),activerecord (= 1.15.6, runtime),actionpack (= 1.13.6, runtime),actionmailer (=... |
+    | red           | ParseTree (~> 2.2.0, runtime),rake (~> 0.8.3, runtime),newgem (>= 1.0.6, development),hoe (>= 1.8.0, development)                            |
+    | www-delicious | rake (>= 0.8, development),echoe (>= 3.1, development),mocha (>= 0.9, development)                                                           |
+    +---------------+----------------------------------------------------------------------------------------------------------------------------------------------+
+    10 rows in set
+
+== Bugs/Tickets
+
+Please submit tickets through {github's issue tracker}[http://github.com/cldwalker/gem_grep/issues].
+
+== TODO
+
+* Tests!
+
+== LICENSE
+
+See LICENSE.txt

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+begin
+  require 'rcov/rcovtask'
+
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    t.rcov_opts = ["-T -x '/Library/Ruby/*'"]
+    t.verbose = true
+  end
+rescue LoadError
+  puts "Rcov not available. Install it for rcov-related tasks with: sudo gem install rcov"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "gem_grep"
+    s.description = 'Enhances search command by displaying results in an ascii table and providing options to search (--fields) and display (--columns) gemspec attributes. These options take any gemspec attribute and more than one when comma delimited. Gemspec attributes can be aliased by specifying the first unique string that it starts with i.e. "su" for "summary".'
+    s.summary = "A gem command plugin which enhances the search command by providing extra search options and displaying results as a table."
+    s.email = "gabriel.horner@gmail.com"
+    s.homepage = "http://github.com/cldwalker/gem_grep"
+    s.authors = ["Gabriel Horner"]
+    s.has_rdoc = true
+    s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
+    s.files = FileList["[A-Z]*", "{bin,lib,test}/**/*"]
+    s.add_dependency 'cldwalker-hirb'
+    s.rubyforge_project = 'tagaholic'
+  end
+
+rescue LoadError
+  puts "Jeweler not available. Install it for jeweler-related tasks with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'test'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :test

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 1
+:major: 0

data/lib/rubygems/commands/grep_command.rb

@@ -0,0 +1,90 @@
+require 'rubygems/commands/query_command'
+require 'rubygems/super_search'
+require 'hirb'
+
+class Gem::Commands::GrepCommand < Gem::Commands::QueryCommand
+  class<<self
+    def valid_gemspec_columns
+      @valid_gemspec_columns ||= Gem::Specification.attribute_names.map {|e| e.to_s}.sort
+    end
+  end
+
+  def initialize
+    super 'grep', "Enhances search command by providing extra search options and displaying results as a table"
+    defaults.merge!(:columns=>[:name,:summary,:authors])
+
+    add_option('-c', '--columns STRING', 'Gemspec columns/attributes to display per gem') do |value, options|
+      options[:columns] = value.split(/\s*,\s*/).map {|e|
+        self.class.valid_gemspec_columns.detect {|c| c =~ /^#{e}/ }
+      }.compact.map {|e| e.to_sym}
+    end
+
+    add_option('-f', '--fields STRING', 'Gemspec fields/attributes to search (only for local gems)') do |value, options|
+      options[:fields] = value.split(/\s*,\s*/).map {|e|
+        self.class.valid_gemspec_columns.detect {|c| c =~ /^#{e}/ }
+      }.compact
+    end
+    remove_option '--name-matches'
+    remove_option '-d'
+    remove_option '--versions'
+  end
+
+  def arguments # :nodoc:
+    "REGEXP          regular expression string to search specified gemspec attributes"
+  end
+
+  def usage # :nodoc:
+    "#{program_name} [REGEXP]"
+  end
+
+  def defaults_str # :nodoc:
+    "--local --columns name,summary,authors --fields name --no-installed"
+  end
+  
+  def description # :nodoc:
+    'Enhances search command by providing options to search (--fields) and display (--columns) ' +
+   'gemspec attributes. Results are displayed in an ascii table. Gemspec attributes can be specified '+
+   'by the first unique string that it starts with i.e. "su" for "summary". To specify multiple gemspec attributes, delimit ' +
+   "them with commas. Gemspec attributes available to options are: #{self.class.valid_gemspec_columns.join(', ')}."
+  end
+  
+  def execute
+    string = get_one_optional_argument
+    options[:name] = /#{string}/i
+    Gem.source_index.extend Gem::SuperSearch
+    super
+  end
+  
+  def output_query_results(tuples)
+    tuples = cleanup_tuples(tuples)
+    records = tuples.map {|e|
+      options[:columns].inject({:name=>e[0][0]}) {|h,c|
+        val = e[0][-1].send(c)
+        h[c] = val.is_a?(Array) ? val.join(',') : val; h 
+      }
+    }
+    say Hirb::Helpers::Table.render(records, :fields=>options[:columns])
+  end
+  
+  # borrowed from query command
+  def cleanup_tuples(spec_tuples)
+    versions = Hash.new { |h,name| h[name] = [] }
+
+    spec_tuples.each do |spec_tuple, source_uri|
+      versions[spec_tuple.first] << [spec_tuple, source_uri]
+    end
+
+    versions = versions.sort_by do |(name,_),_|
+      name.downcase
+    end
+    tuples = options[:all] ? versions.inject([]) {|t,e| t += e[1]; t } : versions.map {|e| e[1].first }
+    tuples.each {|e|
+      if e.first.length != 4
+       uri = URI.parse e.last
+       spec = Gem::SpecFetcher.fetcher.fetch_spec e.first, uri
+       e.first.push(spec)
+      end
+    }
+    tuples
+  end
+end

data/lib/rubygems/super_search.rb

@@ -0,0 +1,50 @@
+# Extends Gem::SourceIndex#search to allow searching of any gemspec attribute field.
+# Differs from original method (from rubygems v1.3.2) by a couple of lines.
+module Gem::SuperSearch
+  def search(gem_pattern, platform_only = false)
+    version_requirement = nil
+    only_platform = false
+
+    # TODO - Remove support and warning for legacy arguments after 2008/11
+    unless Gem::Dependency === gem_pattern
+      warn "#{Gem.location_of_caller.join ':'}:Warning: Gem::SourceIndex#search support for #{gem_pattern.class} patterns is deprecated"
+    end
+
+    case gem_pattern
+    when Regexp then
+      version_requirement = platform_only || Gem::Requirement.default
+    when Gem::Dependency then
+      only_platform = platform_only
+      version_requirement = gem_pattern.version_requirements
+      gem_pattern = if Regexp === gem_pattern.name then
+                      gem_pattern.name
+                    elsif gem_pattern.name.empty? then
+                      //
+                    else
+                      /^#{Regexp.escape gem_pattern.name}$/
+                    end
+    else
+      version_requirement = platform_only || Gem::Requirement.default
+      gem_pattern = /#{gem_pattern}/i
+    end
+
+    unless Gem::Requirement === version_requirement then
+      version_requirement = Gem::Requirement.create version_requirement
+    end
+    
+    # only changes from original method
+    search_fields = Gem::CommandManager.instance['grep'].options[:fields] || ['name']
+    specs = @gems.values.select do |spec|
+      search_fields.map {|e| spec.send(e).to_s}.any? {|e| e =~ gem_pattern} and
+        version_requirement.satisfied_by? spec.version
+    end
+
+    if only_platform then
+      specs = specs.select do |spec|
+        Gem::Platform.match spec.platform
+      end
+    end
+
+    specs.sort_by { |s| s.sort_obj }
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,3 @@
+require 'rubygems/command_manager'
+
+Gem::CommandManager.instance.register_command :grep

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: gem_grep
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Gabriel Horner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-25 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cldwalker-hirb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Enhances search command by displaying results in an ascii table and providing options to search (--fields) and display (--columns) gemspec attributes. These options take any gemspec attribute and more than one when comma delimited. Gemspec attributes can be aliased by specifying the first unique string that it starts with i.e. "su" for "summary".
+email: gabriel.horner@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/rubygems/commands/grep_command.rb
+- lib/rubygems/super_search.rb
+- lib/rubygems_plugin.rb
+has_rdoc: true
+homepage: http://github.com/cldwalker/gem_grep
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: tagaholic
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: A gem command plugin which enhances the search command by providing extra search options and displaying results as a table.
+test_files: []
+