open_gem 1.2.0 → 1.3.0

data/CHANGELOG.markdown

@@ -0,0 +1,15 @@
+OpenGem
+========
+
+1.3
+----
+* Added the read command for your reading pleasure.  
+  Very similar to open, except it will launch the rdoc files for the gem, or generate them.
+  
+1.2
+----
+* Fixed shell parsing so that commands can include arguments
+
+1.0
+----
+* Initial release!

data/README.markdown

@@ -5,6 +5,10 @@ Simply opens the specified gem in your default editor.
   
   gem open rails
   
+If you just want to read documentation you can do:
+
+  gem read activerecord
+  
 Installation:
 ------------
 OpenGem require rubygems 1.3.2 or higher.  You may need

data/VERSION.yml

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

data/lib/open_gem/common_options.rb

@@ -0,0 +1,36 @@
+module OpenGem
+  module CommonOptions
+    def add_command_option(description=nil)
+      add_option('-c', '--command COMMAND',
+                 description || 'Execute command at path of the rubygem') do |value, options|
+        options[:command] = value
+      end
+    end
+
+    def add_latest_version_option
+      add_option('-l', '--latest',
+                 'If there are multiple versions, open the latest') do |value, options|
+        options[:latest] = true
+      end
+    end
+    
+    def get_spec(name)
+      dep = Gem::Dependency.new name, options[:version]
+      specs = Gem.source_index.search(dep).select{|spec| spec.has_rdoc?}
+
+      if specs.length == 0
+        say "Could not find docs for '#{name}'"
+        return nil
+
+      elsif specs.length == 1 || options[:latest]
+        return specs.last
+
+      else
+        choices = specs.map{|s|"#{s.name} #{s.version}"}
+        c,i = choose_from_list "Open which gem?", choices
+        return specs[i] if i
+
+      end
+    end
+  end
+end

data/lib/rubygems/commands/open_command.rb

@@ -1,11 +1,6 @@
-require 'shellwords'
-
-require 'rubygems/command'
-require 'rubygems/dependency'
-require 'rubygems/version_option'
-
 # OpenCommand will open a gem's source path
 class Gem::Commands::OpenCommand < Gem::Command
+  include OpenGem::CommonOptions
   include Gem::VersionOption
   
   def initialize
@@ -14,16 +9,8 @@ class Gem::Commands::OpenCommand < Gem::Command
       :version=>  Gem::Requirement.default,
       :latest=>   false
     
-    add_option('-c', '--command COMMAND',
-               'Execute command at path of the rubygem') do |value, options|
-      options[:command] = value
-    end
-    
-    add_option('-l', '--latest',
-               'If there are multiple versions, open the latest') do |value, options|
-      options[:latest] = true
-    end
-    
+    add_command_option
+    add_latest_version_option
     add_version_option
   end
   
@@ -39,21 +26,8 @@ class Gem::Commands::OpenCommand < Gem::Command
   end
   
   def get_path(name)
-    dep = Gem::Dependency.new name, options[:version]
-    specs = Gem.source_index.search dep
-    
-    if specs.length == 0
-      say "Could not find '#{name}'"
-      return nil
-      
-    elsif specs.length == 1 || options[:latest]
-      return specs.last.full_gem_path
-      
-    else
-      choices = specs.map{|s|"#{s.name} #{s.version}"}
-      c,i = choose_from_list "Open which gem?", choices
-      return specs[i].full_gem_path if i
-      
+    if spec = get_spec(name)
+      spec.full_gem_path
     end
   end
 

data/lib/rubygems/commands/read_command.rb

@@ -0,0 +1,60 @@
+# ReadCommand will open a gem's rdoc
+class Gem::Commands::ReadCommand < Gem::Command
+  include OpenGem::CommonOptions
+  include Gem::VersionOption
+  
+  def initialize
+    super 'read', "Opens the gem's documentation", 
+      :command => nil, 
+      :version=>  Gem::Requirement.default,
+      :latest=>   false
+    
+    add_command_option "Application to read rdoc with"
+    add_latest_version_option
+    add_version_option
+  end
+  
+  def arguments # :nodoc:
+    "GEMNAME       gem to read"
+  end
+
+  def execute
+    name = get_one_gem_name
+    spec = get_spec name
+    if spec && path = get_path(spec)
+      if File.exists? path
+        read_gem path
+      elsif ask_yes_no "The rdoc seems to be missing, would you like to generate one?", true
+        generate_rdoc spec
+        read_gem path
+      end
+    end
+  end
+  
+  def get_path(spec)
+    File.join(spec.installation_path, "doc", spec.full_name, 'rdoc','index.html')
+  end
+  
+  def generate_rdoc spec
+    Gem::DocManager.new(spec).generate_rdoc
+  end
+  
+  def rdoc_reader
+    options[:command] || case RUBY_PLATFORM.downcase
+      when /darwin/ then 'open'
+      when /mswin/  then 'explorer'
+      when /linux/  then 'firefox'
+      else               'firefox' # Come on, if you write ruby, you probably have firefox installed ;)
+    end
+  end
+  
+  def read_gem(path)
+    command_parts = Shellwords.shellwords(rdoc_reader)
+    command_parts << path
+    success = system(*command_parts)
+    if !success 
+      raise Gem::CommandLineError, "Could not run '#{editor} #{path}', exit code: #{$?.exitstatus}"
+    end
+  end
+  
+end

data/lib/rubygems_plugin.rb

@@ -1,3 +1,11 @@
 require 'rubygems/command_manager'
 
-Gem::CommandManager.instance.register_command :open
+require 'rubygems/command'
+require 'rubygems/dependency'
+require 'rubygems/version_option'
+
+require 'shellwords'
+require 'open_gem/common_options'
+
+Gem::CommandManager.instance.register_command :open
+Gem::CommandManager.instance.register_command :read

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: open_gem
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Adam Sanderson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-02 00:00:00 -07:00
+date: 2009-06-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,10 +31,13 @@ extensions: []
 extra_rdoc_files: 
 - README.markdown
 files: 
+- CHANGELOG.markdown
 - README.markdown
 - Rakefile
 - VERSION.yml
+- lib/open_gem/common_options.rb
 - lib/rubygems/commands/open_command.rb
+- lib/rubygems/commands/read_command.rb
 - lib/rubygems_plugin.rb
 - test/open_command_test.rb
 has_rdoc: false