alkesh-gemedit 0.0.2

data/History.txt

@@ -0,0 +1,9 @@
+== 0.0.2 2008-03-07
+
+* 1 minor enhancement:
+  * add -p/--pretend option to show what gem(s) would be edited and with what command
+
+== 0.0.1 2008-02-27
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Lee Marlow
+
+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 @@
+ gemedit
+	http://gemedit.rubyforge.org/
+	by Lee Marlow
+
+== DESCRIPTION:
+
+Gemedit lets you quickly open up the source for a gem in your favorite editor.
+
+Looking through other people's code is a great way to learn.  I often use it when a gem's RDoc isn't as helpful as I'd like or just want to see how someone put a library together.  Gemedit just makes it easier to get to the code.
+
+== INSTALLATION:
+
+Gemedit can be installed via RubyGems:
+
+  $ sudo gem install gemedit
+
+If you would like some basic command completion for installed gems add the following to your ~/.bashrc or ~/.profile:
+
+  complete -C "/usr/bin/gemedit --complete" gemedit
+
+== USAGE:
+
+If you want to see how gemedit works just install it and run this:
+  $ gemedit gemedit
+
+Gemedit tries to use your favorite editor from your <tt>$VISUAL</tt> or <tt>$EDITOR</tt> environment variable.  It will fall back to <em>everyone's</em> favorite editor: *vi*.  You can specify the editor with the <tt>-e/--editor</tt> switch.  Run this to view the source for +rake+ in TextMate[http://macromates.com]:
+  $ gemedit -e mate rake
+
+And of course, help is available:
+  $ gemedit -h
+  $ gemedit --help
+
+== DOCUMENTATION:
+
+There isn't much more to document than what is on this page, but feel free to browse the RDoc[http://gemedit.rubyforge.org/rdoc/].  Or checkout the Rubyforge project page here[http://rubyforge.org/projects/gemedit/].
+
+== SOURCE REPOSITORY:
+
+The source is currently on github[http://github.com/].  You can browse through it at http://github.com/lmarlow/gemedit or pull it down and play with it yourself with 
+
+  $ git clone git://github.com/lmarlow/gemedit.git

data/bin/gemedit

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-2-27.
+#  Copyright (c) 2008. All rights reserved.
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+require 'optparse'
+
+OPTIONS = {
+  :verbose => false,
+  :pretend => false,
+  :editor => ENV['VISUAL'] || ENV['EDITOR'] || 'vi'
+}
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+Open the source of installed gems in your favorite editor
+
+Usage: #{File.basename($0)} GEM_NAME...
+
+Options are:
+BANNER
+  opts.on("-e", "--editor=EDITOR", String,
+          "The editor to open the gems with", "Default: #{OPTIONS[:editor]}") { |editor| OPTIONS[:editor] = editor }
+  opts.on("-p", "--pretend",
+          "Shows what command would be run without running it", "Turns on verbose logging", "Default: #{OPTIONS[:pretend]}") { |pretend|
+            OPTIONS[:pretend] = OPTIONS[:verbose] = true
+  }
+  opts.on("-v", "--verbose",
+          "Enable verbose logging", "Default: #{OPTIONS[:verbose]}") { |verbose| OPTIONS[:verbose] = true }
+  opts.on("-h", "--help",
+          "Show this help message.") { puts opts; exit }
+end
+
+if ARGV.include?('--complete')
+  exit 0 unless /\b#{Regexp.escape(File.basename($0))}\b/ =~ ENV["COMP_LINE"]
+  after_match = $'
+  complete_term = (after_match.empty? || after_match =~ /\s$/) ? nil : after_match.split.last
+  completions = if complete_term =~ /\A-/
+    parser.top.list.select { |opt| OptionParser::Switch === opt }.inject([]) { |ary, opt|
+      ary + opt.short + opt.long
+    }.select { |opt_string| opt_string =~ /\A#{Regexp.escape(complete_term)}/ }
+  elsif complete_term
+    Gem.source_index.inject([]) { |ary, (full_name, spec)| ary << full_name if /^#{Regexp.escape(complete_term)}/i =~ full_name; ary }
+  else
+    Gem.source_index.map { |full_name, spec| full_name }
+  end
+  puts completions
+  exit 0
+end
+
+parser.parse!(ARGV)
+
+def get_gem(gem_name)
+  possible_gems = Gem.source_index.inject([]) { |ary, (name, spec)| ary << spec if /^#{Regexp.escape(gem_name)}/i =~ spec.full_name; ary }.sort_by { |gem| gem.version }.reverse
+  if possible_gems.size < 1
+    puts "No gems found for #{gem_name}... skipping"
+  end
+  gem = possible_gems.first if possible_gems.map { |g| g.name }.uniq.size == 1
+  gem ||= begin
+    require 'rubygems/user_interaction'
+    include Gem::DefaultUserInteraction
+    list = possible_gems.map { |g| "#{g.name} #{g.version}" }
+    list << 'None of the above'
+    name, index = ui.choose_from_list("Choose which gem to view for '#{gem_name}':", list)
+    possible_gems[index] if (0...possible_gems.size).include?(index)
+  end
+  gem
+end
+
+gems = ARGV.reject { |arg| arg.empty? }.map { |gem_name| get_gem(gem_name) }.compact
+
+if gems.size > 0
+  puts "Opening the following gems with #{OPTIONS[:editor]}:" if OPTIONS[:verbose]
+  paths = gems.map do |gem|
+    puts "  #{gem.full_name}: #{gem.full_gem_path}" if OPTIONS[:verbose]
+    %Q{"#{gem.full_gem_path}"}
+  end
+  cmd = "#{OPTIONS[:editor]} #{paths.join(' ')}"
+  puts "Running `#{cmd}`" if OPTIONS[:verbose]
+  exec cmd unless OPTIONS[:pretend]
+else
+  puts "No gems found for editing"
+end
+exit 0

data/lib/gemedit.rb

@@ -0,0 +1,5 @@
+$:.unshift File.dirname(__FILE__)
+
+module Gemedit
+  
+end

data/lib/gemedit/version.rb

@@ -0,0 +1,9 @@
+module Gemedit #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: alkesh-gemedit
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Lee Marlow
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-26 00:00:00 -07:00
+default_executable: gemedit
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: A utility to view a gem's source in your favorite editor
+email: 
+- lmarlow@rubyforge.org
+executables: 
+- gemedit
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- README.txt
+- bin/gemedit
+- lib/gemedit.rb
+- lib/gemedit/version.rb
+has_rdoc: false
+homepage: http://gemedit.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: gemedit
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A utility to view a gem's source in your favorite editor
+test_files: []
+