gem_locate 0.5.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kabari Hendrick
+
+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.textile

@@ -0,0 +1,57 @@
+h1. Gem Locate
+
+Searches gems by name, summary, and description in case you want to find a gem by what it is doing rather than it's name. Currently this only searches your *local* gems.
+
+_I think someone made something like this before...but I couldn't find it_
+
+h2. Install
+
+@[sudo] gem install gem_locate@
+
+h2. Usage
+
+pre.. $ gem help locate
+Usage: gem locate [STRING] [options]
+  Options:
+    -i, --[no-]installed             Check for installed gem
+    -v, --version VERSION            Specify version of gem to locate
+    -n, --name-matches REGEXP        Name of gem(s) to query on matches the
+                                     provided REGEXP
+    -d, --[no-]details               Display detailed information of gem(s)
+        --[no-]versions              Display only gem names
+    -a, --all                        Display all gem versions
+        --prerelease                 Display prerelease versions
+        
+  Local/Remote Options:
+    -l, --local                      Restrict operations to the LOCAL domain
+    -B, --bulk-threshold COUNT       Threshold for switching to bulk
+                                     synchronization (default 1000)
+                                     
+  Common Options:
+    -h, --help                       Get help on this command
+    -V, --[no-]verbose               Set the verbose level of output
+    -q, --quiet                      Silence commands
+        --config-file FILE           Use this config file instead of default
+        --backtrace                  Show stack backtrace on errors
+        --debug                      Turn on Ruby debugging
+        
+  Arguments:
+    STRING        fragment of gem name,summary, or description to search for
+    
+  Summary:
+    Find all gems whose name, summary, or description match STRING
+    
+  Defaults:
+    --local
+
+h1. Note on Patches/Pull Requests
+ 
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Commit, do not mess with rakefile, version, or history.
+    (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+  * Send me a pull request :)
+
+h1. Copyright
+
+Copyright (c) 2010 Kabari Hendrick. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gem_locate"
+    gem.summary = %Q{Same as 'gem search' but search description and summary also}
+    gem.description = %Q{Searches gems by name, summary, and description in case you want to find a gem by what it is doing rather than it's name.}
+    gem.email = "kabari@gmail.com"
+    gem.homepage = "http://github.com/kabari/gem_locate"
+    gem.authors = ["Kabari Hendrick"]
+    gem.files = FileList["lib/rubygems_plugin.rb",
+                         "lib/commands/locate.rb",
+                         "lib/gem_extension/source_index.rb",
+                         "README.rdoc",
+                         "LICENSE",
+                         "VERSION",
+                         "Rakefile"]
+    gem.test_files = []
+    gem.executables = []
+    gem.required_rubygems_version = Gem::Requirement.new(">= 1.3.5") if gem.respond_to? :required_rubygems_version=
+    gem.post_install_message = <<MESSAGE
+
+========================================================================
+
+           Thanks for installing Gem Locate! You can now run:
+
+    gem locate STRING   Same as 'gem search' but search description and summary also
+    
+========================================================================
+
+MESSAGE
+    
+    gem.add_development_dependency "yard", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+task :default => :check_dependencies
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/lib/commands/locate.rb

@@ -0,0 +1,66 @@
+class Gem::Commands::LocateCommand < Gem::Commands::QueryCommand
+  def initialize
+    super 'locate', 'Find all gems whose name, summary, or description match STRING'
+    
+     %w(-r -b --source -p -u).each{|com| remove_option com } 
+  end
+  
+  def arguments # :nodoc:
+    "STRING        fragment of gem name,summary, or description to search for"
+  end
+
+  def defaults_str # :nodoc:
+    "--local"
+  end
+
+  def usage # :nodoc:
+    "#{program_name} [STRING]"
+  end
+
+  def execute
+    string = get_one_optional_argument
+    options[:name] = /#{string}/i
+    exit_code = 0
+
+    name = options[:name]
+    prerelease = options[:prerelease]
+
+    if options[:installed] then
+      if name.source.empty? then
+        alert_error "You must specify a gem name"
+        exit_code |= 4
+      elsif installed? name, options[:version] then
+        say "true"
+      else
+        say "false"
+        exit_code |= 1
+      end
+
+      raise Gem::SystemExitException, exit_code
+    end
+
+    dep = Gem::Dependency.new name, Gem::Requirement.default
+
+    if prerelease and not both? then
+      alert_warning "prereleases are always shown locally"
+    end
+
+    if ui.outs.tty? or both? then
+      say
+      say "*** LOCAL GEMS ***"
+      say
+    end
+
+    specs = Gem.source_index.locate dep
+
+    spec_tuples = specs.map do |spec|
+      [[spec.name, spec.version, spec.original_platform, spec], :local]
+    end
+
+    output_query_results spec_tuples
+    
+    # TODO support remote gem search
+  end
+  
+end
+ 

data/lib/gem_extension/source_index.rb

@@ -0,0 +1,49 @@
+class Gem::SourceIndex
+    
+  # This is basically the same as Gem::SourceIndex.search
+  def locate(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, use #find_name"
+    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
+
+    specs = all_gems.values.select do |spec|
+      if version_requirement.satisfied_by? spec.version
+        [spec.name, spec.description, spec.summary].detect{|q| (q =~ gem_pattern) if q }
+      end
+    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,10 @@
+$:.unshift File.dirname(__FILE__)     # For use/testing when no gem is installed
+
+require 'rubygems/command_manager'
+require 'rubygems/command'
+require 'rubygems/commands/query_command'
+
+require "commands/locate"
+require "gem_extension/source_index"
+# register gem command
+Gem::CommandManager.instance.register_command :locate

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: gem_locate
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Kabari Hendrick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-11 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Searches gems by name, summary, and description in case you want to find a gem by what it is doing rather than it's name.
+email: kabari@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- LICENSE
+- Rakefile
+- VERSION
+- lib/commands/locate.rb
+- lib/gem_extension/source_index.rb
+- lib/rubygems_plugin.rb
+- README.textile
+has_rdoc: true
+homepage: http://github.com/kabari/gem_locate
+licenses: []
+
+post_install_message: |+
+  
+  ========================================================================
+  
+             Thanks for installing Gem Locate! You can now run:
+  
+      gem locate STRING   Same as 'gem search' but search description and summary also
+      
+  ========================================================================
+  
+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: 1.3.5
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Same as 'gem search' but search description and summary also
+test_files: []
+