gem-browse 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Tim Pope
+
+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.markdown

@@ -0,0 +1,64 @@
+gem-browse
+==========
+
+Open a library file you can require in your editor.  That's it.
+
+    gem edit active_support/all
+    gem edit rake/task thor/task
+    gem edit -e mvim fileutils
+
+Actually that's not it.  You can also open a gem by name.
+
+    gem open bundler
+
+Your editor's current working directory will be the root of the gem.
+
+I almost forgot.  You can also clone a gem from GitHub.
+
+    gem clone rails
+    gem clone -d ~/src capybara
+
+And you can tell it to open the gem in your editor afterwards.
+
+    gem clone -o rack
+    gem clone -oe mvim -d /tmp gem-browse
+
+This one doesn't work if the neither the homepage nor the source code
+URL point back at GitHub.
+
+That's really it.  I mean other than the command that lets you open a
+gem's homepage in your browser.  You know, the command this gem is named
+after.
+
+    gem browse sprockets
+
+Installation
+------------
+
+RubyGems 1.8 is required to use `gem edit`, but the other commands will
+work on any version that supports RubyGems plugins.
+
+    gem install gem-browse
+
+If you're using RVM, you can put it in the global gemset (relax, it has
+no dependencies):
+
+    echo gem-browse >> ~/.rvm/gemsets/global.gems
+    rvm @global gem install gem-browse
+
+Protip:  Install [gem-ctags](https://github.com/tpope/gem-ctags) to
+automatically invoke [Ctags](http://ctags.sourceforge.net/) on gems as
+they are installed.
+
+Contributing
+------------
+
+Don't submit a pull request with [an ugly commit
+message](http://stopwritingramblingcommitmessages.com) or I will ignore
+your patch until I have the energy to politely explain my zero tolerance
+policy.
+
+License
+-------
+
+Copyright (c) Tim Pope.  MIT License.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/gem-browse.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "gem-browse"
+  s.version     = "1.0.0"
+  s.authors     = ["Tim Pope"]
+  s.email       = ["ruby@tpop"+'e.org']
+  s.homepage    = "https://github.com/tpope/gem-browse"
+  s.summary     = %q{gem edit, gem open, gem clone, gem browse}
+  s.description = <<-EOS
+gem edit: edit a library file you can require.
+gem open: edit a gem by name.
+gem clone: clone a gem from GitHub.
+gem browse: open a gem's homepage in your browser.
+  EOS
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('rake', '~> 0.8')
+end

data/lib/rubygems/browse/command.rb

@@ -0,0 +1,46 @@
+require 'rubygems/command'
+
+module Gem::Browse
+  class Command < Gem::Command
+
+    def add_editor_option
+      add_option('-e', '--editor EDITOR', 'Specify editor to invoke') do |editor, options|
+        options[:editor] = editor
+      end
+    end
+
+    def editor
+      options[:editor] ||
+        ENV['GEM_EDITOR'] ||
+        ENV['VISUAL'] ||
+        ENV['EDITOR'] ||
+        'vi'
+    end
+
+    def edit(*args)
+      unless system(*editor.split(/\s+/) + args)
+        alert_error "Problem with editor #{editor}"
+        terminate_interaction 1
+      end
+    end
+
+    def find_by_name(*args)
+      if Gem::Specification.respond_to?(:find_by_name)
+        Gem::Specification.find_by_name(*args)
+      else
+        Gem.source_index.find_name(*args).last or raise Gem::LoadError
+      end
+    end
+
+    def get_json(name)
+      require 'open-uri'
+      begin
+        open("http://rubygems.org/api/v1/gems/#{name}.json").read
+      rescue OpenURI::HTTPError
+        alert_error "Cannot retrieve gem information for #{name} from rubygems.org."
+        terminate_interaction 1
+      end
+    end
+
+  end
+end

data/lib/rubygems/commands/browse_command.rb

@@ -0,0 +1,25 @@
+require 'rubygems/browse/command'
+
+class Gem::Commands::BrowseCommand < Gem::Browse::Command
+
+  def initialize
+    super 'open', "Open a gem's homepage in your web browser"
+  end
+
+  def execute
+    name = get_one_gem_name
+    homepage =
+      begin
+        find_by_name(name).homepage
+      rescue Gem::LoadError
+        get_json(name)[/"homepage_uri":\s*"([^"]*)"/, 1]
+      end
+    if homepage.to_s.empty?
+      alert_warning "Gem '#{name}' lacks a homepage."
+    elsif !system('git', 'web--browse', homepage)
+      alert_error('Error starting web browser (using git web--browse).')
+      terminate_interaction 1
+    end
+  end
+
+end

data/lib/rubygems/commands/clone_command.rb

@@ -0,0 +1,67 @@
+require 'rubygems/browse/command'
+
+class Gem::Commands::CloneCommand < Gem::Browse::Command
+
+  def description
+    <<-EOF
+The clone command performs a Git clone of a gem's upstream repository.
+It looks for this repository by checking the homepage field of the gemspec
+and the source code URL field at rubygems.org.  Currently, only GitHub
+repositories are recognized.
+    EOF
+  end
+
+  def initialize
+    super 'clone', "Clone a gem's source from GitHub"
+    add_editor_option
+    add_option('-o', '--[no-]open', 'Open in editor afterwards') do |open, options|
+      options[:open] = open
+    end
+    add_option('-d', '--directory DIR', 'Parent directory to clone into') do |directory, options|
+      options[:directory] = directory
+    end
+  end
+
+  def execute
+    name = get_one_gem_name
+    json = nil
+
+    homepage =
+      begin
+        find_by_name(name).homepage
+      rescue Gem::LoadError
+        json = get_json(name)
+        json[/"homepage_uri":\s*"([^"]*)"/, 1]
+      end
+
+    unless url = repo(homepage)
+      json ||= get_json(name)
+      unless url = repo(json[/"source_code_uri":\s*"([^"]*)"/, 1])
+        alert_error "Could not find a GitHub URL for #{name}"
+        terminate_interaction 1
+      end
+    end
+
+    target = File.join(*[options[:directory], url[/([^\/]*)\.git$/, 1]].compact)
+    unless system('git', 'clone', url, target)
+      alert_error "Failed to clone #{url}"
+      terminate_interaction 1
+    end
+
+    if options[:open]
+      Dir.chdir(target) do
+        edit('.')
+      end
+    end
+  end
+
+  def repo(url)
+    case url.to_s
+    when %r{://(?:wiki\.)?github\.com/([^/]*/[^/]*)}
+      "git://github.com/#$1.git"
+    when %r{://([^./]*)\.github\.com/([^/]*)}
+      "git://github.com/#$1/#$2.git"
+    end
+  end
+
+end

data/lib/rubygems/commands/edit_command.rb

@@ -0,0 +1,64 @@
+require 'rubygems/browse/command'
+
+class Gem::Commands::EditCommand < Gem::Browse::Command
+
+  def description
+    <<-EOF
+The edit command looks through the require paths of each gem for the
+specified library file and loads said file in your editor.  If no file is
+found, $LOAD_PATH is searched before giving up.
+    EOF
+  end
+
+  def initialize
+    super 'edit', 'Edit a library file you can require'
+    add_editor_option
+  end
+
+  def execute
+    unless Gem::Specification.respond_to?(:find_by_path)
+      $stderr.puts "RubyGems >= 1.8.0 is required to use gem edit."
+      terminate_interaction 1
+    end
+
+    specs = options[:args].map do |lib|
+      [lib, Gem::Specification.find_by_path(lib)]
+    end
+
+    paths = specs.map do |(lib, spec)|
+      if spec
+        find(lib, spec.require_paths.map {|p| File.join(spec.full_gem_path, p)})
+      else
+        find(lib, $LOAD_PATH)
+      end
+    end.compact
+
+    gemspecs = specs.map {|s| s.last}.compact.uniq
+    dir = if gemspecs.size == 1
+            gemspecs.first.full_gem_path
+          else
+            File.join(Gem.dir, 'gems')
+          end
+
+    unless paths.empty?
+      Dir.chdir(dir) do
+        edit(*paths)
+      end
+    end
+  end
+
+  # Adapted from Gem::Commands::WhichCommand
+  def find(lib, paths)
+    paths.each do |path|
+      Gem.suffixes.each do |ext|
+        full_path = File.join(path, "#{lib}#{ext}")
+        if File.exist?(full_path) && !File.directory?(full_path)
+          return full_path
+        end
+      end
+    end
+
+    alert_warning("Could not find #{lib.inspect} in any require path")
+  end
+
+end

data/lib/rubygems/commands/open_command.rb

@@ -0,0 +1,24 @@
+require 'rubygems/browse/command'
+require 'rubygems/version_option'
+
+class Gem::Commands::OpenCommand < Gem::Browse::Command
+  include Gem::VersionOption
+
+  def initialize
+    super 'open', 'Open a gem in your editor', :version => '>= 0'
+    add_editor_option
+    add_version_option
+  end
+
+  def execute
+    name = get_one_gem_name
+    gemspec = find_by_name(name, options[:version])
+    Dir.chdir(gemspec.full_gem_path) do
+      edit(gemspec.full_gem_path)
+    end
+  rescue Gem::LoadError
+    alert_error "Could not find a valid gem #{name} (#{options[:version]})"
+    terminate_interaction 1
+  end
+
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,6 @@
+require 'rubygems/command_manager'
+
+Gem::CommandManager.instance.register_command :edit
+Gem::CommandManager.instance.register_command :open
+Gem::CommandManager.instance.register_command :clone
+Gem::CommandManager.instance.register_command :browse

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: gem-browse
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tim Pope
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-29 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70874650 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: *70874650
+description: ! 'gem edit: edit a library file you can require.
+
+  gem open: edit a gem by name.
+
+  gem clone: clone a gem from GitHub.
+
+  gem browse: open a gem''s homepage in your browser.
+
+'
+email:
+- ruby@tpope.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- gem-browse.gemspec
+- lib/rubygems/browse/command.rb
+- lib/rubygems/commands/browse_command.rb
+- lib/rubygems/commands/clone_command.rb
+- lib/rubygems/commands/edit_command.rb
+- lib/rubygems/commands/open_command.rb
+- lib/rubygems_plugin.rb
+homepage: https://github.com/tpope/gem-browse
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: gem edit, gem open, gem clone, gem browse
+test_files: []