gem-open 0.1.0

data/README.rdoc

@@ -0,0 +1,62 @@
+= GemOpen
+
+Open gems into your favorite editor by running a specific gem command.
+
+To install it just run
+
+  sudo gem install gem-open
+
+Then add the following lines to your <tt>~/.bash_profile</tt> file.
+
+  export GEM_EDITOR="mate"
+
+Finally, run <tt>gem open GEMNAME</tt> to open that gem.
+
+== Usage
+
+To open the most recent version you just need to type the gem name.
+
+  $ gem open activesupport
+
+If you want to open a specific version you'll have to type the full name.
+
+  $ gem open activesupport-3.0.0.beta3
+
+== Bash completion
+
+Want some completion? Add this snippet to your <tt>~/.bash_profile</tt> file.
+
+  _gemopencomplete() {
+      local cmd=${COMP_WORDS[0]}
+      local subcmd=${COMP_WORDS[1]}
+      local cur=${COMP_WORDS[COMP_CWORD]}
+
+      case "$subcmd" in
+          open)
+              words=`ruby -rubygems -e 'puts Dir["{#{Gem::SourceIndex.installed_spec_directories.join(",")}}/*.gemspec"].collect {|s| File.basename(s).gsub(/\.gemspec$/, "")}'`
+              ;;
+          *)
+              return
+              ;;
+      esac
+
+      COMPREPLY=($(compgen -W "$words" -- $cur))
+      return 0
+  }
+
+  complete -o default -F _gemopencomplete gem
+
+== License
+
+(The MIT License)
+
+Copyright © 2010:
+
+* Nando Vieira - http://simplesideias.com.br
+
+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/Rakefile

@@ -0,0 +1,21 @@
+require "rake/testtask"
+require "jeweler"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "gem-open"
+  gem.version = "0.1.0"
+  gem.summary = "Open gems into your favorite editor by running a specific gem command."
+  gem.email = "fnando.vieira@gmail.com"
+  gem.homepage = "http://github.com/fnando/open-gem"
+  gem.authors = ["Nando Vieira"]
+  gem.files = FileList["lib/**/*", "Rakefile", "README.rdoc"]
+end
+
+Jeweler::GemcutterTasks.new

data/lib/rubygems/commands/open.rb

@@ -0,0 +1,67 @@
+class Gem::Commands::OpenCommand < Gem::Command
+  def description
+    "Open a gem into your favorite editor"
+  end
+
+  def arguments
+    "GEM       gem's name"
+  end
+
+  def usage
+    "#{program_name} GEM"
+  end
+
+  def initialize
+    super "open", description
+  end
+
+  def execute
+    gemname = options[:args].first
+
+    unless gemname
+      say "Usage: #{usage}"
+      return terminate_interaction
+    end
+
+    spec = search(gemname)
+
+    if spec
+      open(spec)
+    else
+      say "The #{gemname.inspect} gem couldn't be found"
+      return terminate_interaction
+    end
+  end
+
+  def search(gemname)
+    regex = /^(.*?)(?:-(.*?))?$/
+    _, required_name, required_version = *gemname.match(regex)
+
+    gemspecs = Dir["{#{Gem::SourceIndex.installed_spec_directories.join(",")}}/*.gemspec"].select do |gemspec|
+      basename = File.basename(gemspec).gsub(/\.gemspec$/, "")
+      _, name, version = *basename.match(regex)
+
+      if required_version
+        basename == gemname
+      else
+        name == gemname
+      end
+    end
+
+    gemspec = gemspecs.sort.last
+
+    return unless gemspec
+
+    Gem::SourceIndex.load_specification(gemspec)
+  end
+
+  def open(spec)
+    if ENV["GEM_EDITOR"]
+      system "#{ENV["GEM_EDITOR"]} #{spec.full_gem_path}"
+    else
+      say "You must set your editor in your .bash_profile or equivalent:"
+      say "  export GEM_EDITOR='mate'"
+      return terminate_interaction
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,5 @@
+require "rubygems/command_manager"
+require "rubygems/commands/open"
+require "pathname"
+
+Gem::CommandManager.instance.register_command :open

data/test/gem_open_test.rb

@@ -0,0 +1,69 @@
+require "rubygems"
+gem "test-unit"
+require "test/unit"
+require "mocha"
+require "rubygems_plugin"
+require "FileUtils"
+
+class GemOpenTest < Test::Unit::TestCase
+  def setup
+    ENV["GEM_EDIT"] = "mate"
+    @plugin = Gem::Commands::OpenCommand.new
+    @gemdir = File.expand_path(File.dirname(__FILE__) + "/gems")
+  end
+
+  def test_require_gem_name_to_be_set
+    @plugin.expects(:options).returns(:args => [])
+    @plugin.expects(:say).with("Usage: #{@plugin.usage}")
+    @plugin.expects(:terminate_interaction).returns(true)
+
+    @plugin.execute
+  end
+
+  def test_require_installed_gem_name
+    gemname = "invalid"
+
+    @plugin.expects(:options).returns(:args => [gemname])
+    @plugin.expects(:search).with(gemname).returns(nil)
+    @plugin.expects(:say).with("The #{gemname.inspect} gem couldn't be found")
+    @plugin.expects(:terminate_interaction).returns(true)
+
+    @plugin.execute
+  end
+
+  def test_gem_without_version
+    gemname = "activesupport"
+
+    Gem::SourceIndex.expects(:installed_spec_directories).returns([File.dirname(__FILE__) + "/resources"])
+
+    @plugin.expects(:options).returns(:args => [gemname])
+    @plugin.expects(:system).with("mate #{@gemdir}/activesupport-3.0.0.beta3")
+
+    @plugin.execute
+  end
+
+  def test_gem_with_version
+    gemname = "activesupport-2.3.5"
+
+    Gem::SourceIndex.expects(:installed_spec_directories).returns([File.dirname(__FILE__) + "/resources"])
+
+    @plugin.expects(:options).returns(:args => [gemname])
+    @plugin.expects(:system).with("mate #{@gemdir}/activesupport-2.3.5")
+
+    @plugin.execute
+  end
+
+  def test_unset_editor
+    ENV["GEM_EDITOR"] = nil
+    gemname = "activesupport"
+
+    Gem::SourceIndex.expects(:installed_spec_directories).returns([File.dirname(__FILE__) + "/resources"])
+
+    @plugin.expects(:options).returns(:args => [gemname])
+    @plugin.expects(:say).with("You must set your editor in your .bash_profile or equivalent:")
+    @plugin.expects(:say).with("  export GEM_EDITOR='mate'")
+    @plugin.expects(:terminate_interaction)
+
+    @plugin.execute
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: gem-open
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-17 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/rubygems/commands/open.rb
+- lib/rubygems_plugin.rb
+has_rdoc: true
+homepage: http://github.com/fnando/open-gem
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Open gems into your favorite editor by running a specific gem command.
+test_files: 
+- test/gem_open_test.rb