gem-toolbox 0.0.1

data/CHANGES.md

@@ -0,0 +1,3 @@
+## 0.0.1, released 2010-09-13
+
+* Initial version with doc, history, open, readme and visit commands

data/README.rdoc

@@ -0,0 +1,63 @@
+= Gem-Toolbox
+
+This is a gem that adds a few extra commands to RubyGem: *open*, *readme*, *history* and *doc* and *visit*.
+
+== Usage
+
+
+=== Opening a gem
+
+To open a gem's installation folder in textmate:
+
+    $ export EDITOR=mate
+    $ gem open gem-toolbox
+
+Note: This is the same command as the one in open_gem.
+
+    
+=== Displaying the README
+
+The readme command will try to find a readme file and 
+display it using $GEM_PAGER or $PAGER:
+
+    $ export PAGER=less
+    $ gem readme gem-toolbox
+
+If you prefer to read it using a editor:
+
+    $ gem readme gem-toolbox -c vim
+
+
+=== Viewing the gem's changelog
+
+You can view the changelog using the *history* command:
+
+    $ gem history gem-toolbox
+    
+It will search the gem for a typical changelog file (history, changes, changelog) 
+and display it using $GEM_PAGER or $PAGER or a custom command (-c).
+
+
+=== Browsing the documentation  
+
+To browse the documentation for a gem in your browser:
+
+    $ gem doc gem-toolbox
+    
+You can use a custom command too:
+
+    $ gem doc gem-toolbox -c lynx
+
+Note: This is the same command as *read* from open_gem.
+
+
+=== Visiting the gem's homepage
+
+This opens the gem's homepage in your favorite browser
+
+    $ gem visit gem-toolbox
+
+
+== Credits
+
+This gem is based on adamsanderson's open_gem, thank you!

data/lib/gem_toolbox/common_options.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+module GemToolbox
+
+  # This module was ripped from open_gem
+  module CommonOptions
+    
+    def add_command_option(description=nil)
+      add_option('-c', '--command COMMAND', description || 'Execute command at path of the gem') { |value,options| options[:command] = value }
+    end
+    
+    def add_latest_version_option
+      add_option('-l', '--latest', 'If there are multiple versions, use the latest') { |value,options| options[:latest] = true }
+    end
+    
+    def add_exact_match_option
+      add_option('-x', '--exact', 'Only list exact matches') { |value,options| options[:exact] = true }
+    end
+    
+    def get_spec(name)
+      dep = Gem::Dependency.new(name, options[:version])
+      specs = Gem.source_index.search(dep)
+      if block_given?
+        specs = specs.select{|spec| yield spec}
+      end
+
+      if specs.length == 0
+        # If we have not tried to do a pattern match yet, fall back on it.
+        if(!options[:exact] && !name.is_a?(Regexp))
+          pattern = /#{Regexp.escape name}/
+          get_spec(pattern)
+        else
+          say "#{name.inspect} is not available"
+          return nil
+        end
+
+      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
+    
+    def get_path(name)
+      if spec = get_spec(name)
+        spec.full_gem_path
+      end
+    end
+    
+    def show(file)
+      pager = options[:command] || ENV['GEM_PAGER'] || ENV['PAGER']
+
+      if !pager
+        say "Either set $GEM_PAGER, $PAGER, or use -c <command_name>"
+      else
+        command_parts = Shellwords.shellwords(pager)
+        command_parts << file
+        success = system(*command_parts)
+        if !success 
+          raise Gem::CommandLineError, "Could not run '#{pager} #{file}', exit code: #{$?.exitstatus}"
+        end
+      end    
+
+    end
+    
+    
+  end
+  
+end

data/lib/rubygems/commands/doc_command.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+require 'launchy'
+
+# DocCommand will open a gem's rdoc
+# This command is the same as the open_gem ReadCommand
+class Gem::Commands::DocCommand < Gem::Command
+  include GemToolbox::CommonOptions
+  include Gem::VersionOption
+  
+  def initialize
+    super 'doc', "Read 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
+    add_exact_match_option
+  end
+  
+  def arguments # :nodoc:
+    "GEMNAME       gem to read"
+  end
+
+  def execute
+    name = get_one_gem_name
+    spec = get_spec(name){|s| s.has_rdoc? }
+    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 read_gem(path)
+    if options[:command]
+      command_parts = Shellwords.shellwords(options[:command])
+      command_parts << path
+      success = system(*command_parts)
+      if !success 
+        raise Gem::CommandLineError, "Could not run '#{options[:command]} #{path}', exit code: #{$?.exitstatus}"
+      end
+    else
+      Launchy::Browser.run("file://"+path)
+    end
+  end
+  
+end

data/lib/rubygems/commands/history_command.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+# HistoryCommand displays the gem's changelog using $GEM_PAGER or $PAGER
+class Gem::Commands::HistoryCommand < Gem::Command
+  include GemToolbox::CommonOptions
+  include Gem::VersionOption
+  
+  CHANGELOG_PATTERN = /^(history|changelog|changes)/i
+
+  def initialize
+    super "history", "Show gem's changelog using $GEM_PAGER or $PAGER",
+      :command => nil, 
+      :version => Gem::Requirement.default,
+      :latest  => false
+    
+    add_latest_version_option
+    add_exact_match_option
+    add_version_option
+    add_command_option
+  end
+  
+  def arguments # :nodoc:
+    "GEMNAME      Gem to show changelog for"
+  end
+  
+  def execute
+    name = get_one_optional_argument
+    path = get_path(name)
+    
+    if path
+      if log = find_changelog(path)
+        show log
+      else
+        say "No changelog found for #{name}"
+      end
+    end
+  end
+  
+  def find_changelog(path)
+    Dir.glob(File.join(path, "*")).each do |file|
+      return file if File.file?(file) && File.basename(file) =~ CHANGELOG_PATTERN
+    end
+    nil
+  end
+  
+end

data/lib/rubygems/commands/open_command.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+# OpenCommand will open a gem's source path
+# This command is the same as +open+ in open_gem 
+class Gem::Commands::OpenCommand < Gem::Command
+  include GemToolbox::CommonOptions
+  include Gem::VersionOption
+  
+  def initialize
+    super 'open', "Opens the gem's source directory with $GEM_OPEN_EDITOR or $EDITOR", 
+      :command => nil, 
+      :version=>  Gem::Requirement.default,
+      :latest=>   false
+    
+    add_command_option
+    add_latest_version_option
+    add_version_option
+    add_exact_match_option
+  end
+  
+  def arguments # :nodoc:
+    "GEMNAME       gem to open"
+  end
+
+  def execute
+    name = get_one_gem_name
+    path = get_path(name)
+    
+    open_gem(path) if path
+  end
+  
+  def open_gem(path)
+    editor = options[:command] || ENV['GEM_OPEN_EDITOR'] || ENV['VISUAL'] || ENV['EDITOR']
+    if !editor
+      say "Either set $GEM_OPEN_EDITOR, $VISUAL, $EDITOR, or use -c <command_name>"
+    else
+      command_parts = Shellwords.shellwords(editor)
+      command_parts << path
+      success = system(*command_parts)
+      if !success 
+        raise Gem::CommandLineError, "Could not run '#{editor} #{path}', exit code: #{$?.exitstatus}"
+      end
+    end
+  end
+end

data/lib/rubygems/commands/readme_command.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+# ReadmeCommand opens the gem's readme file using $PAGER or $GEM_PAGER
+class Gem::Commands::ReadmeCommand < Gem::Command
+  include GemToolbox::CommonOptions
+  include Gem::VersionOption
+
+  def initialize
+    super "readme", "Show gem's readme file using $GEM_PAGER or $PAGER",
+      :command => nil, 
+      :version => Gem::Requirement.default,
+      :latest  => false
+    
+    add_latest_version_option
+    add_exact_match_option
+    add_version_option
+    add_command_option
+  end
+  
+  def arguments # :nodoc:
+    "GEMNAME      Gem to show readme for"
+  end
+  
+  def execute
+    name = get_one_optional_argument
+    path = get_path(name)
+    
+    if path
+      if file = find_readme(path)
+        show file
+      else
+        say "No readme found for #{name}"
+      end
+    end
+  end
+  
+  def find_readme(path)
+    Dir.glob(File.join(path, "{README,readme,Readme,ReadMe}*")).first
+  end
+  
+
+end

data/lib/rubygems/commands/visit_command.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'launchy'
+# VisitCommand opens the gem's homepage in a browser
+class Gem::Commands::VisitCommand < Gem::Command
+  include GemToolbox::CommonOptions
+  include Gem::VersionOption
+
+  def initialize
+    super "readme", "Visit gem's homepage in a browser",
+      :command => nil, 
+      :version => Gem::Requirement.default,
+      :latest  => false
+    
+    add_latest_version_option
+    add_exact_match_option
+    add_version_option
+  end
+  
+  def arguments # :nodoc:
+    "GEMNAME      Gem to visit"
+  end
+  
+  def execute
+    name = get_one_gem_name
+    spec = get_spec(name)    
+    
+    if spec.homepage
+      Launchy::Browser.run(spec.homepage)
+    else
+      say "Homepage not defined for #{name}"
+    end
+  end
+  
+
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+require 'rubygems/command_manager'
+require 'rubygems/command'
+require 'rubygems/dependency'
+require 'rubygems/version_option'
+require 'shellwords'
+require 'gem_toolbox/common_options'
+
+Gem::CommandManager.instance.register_command :open
+Gem::CommandManager.instance.register_command :doc
+Gem::CommandManager.instance.register_command :history
+Gem::CommandManager.instance.register_command :readme
+Gem::CommandManager.instance.register_command :visit

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: gem-toolbox
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gudleik Rasch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-13 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: "Gem-Toolbox is a RubyGems plugin that adds extra commands to RubyGems: open, doc, history, readme and visit"
+email: 
+- gudleik@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/gem_toolbox/common_options.rb
+- lib/rubygems/commands/doc_command.rb
+- lib/rubygems/commands/history_command.rb
+- lib/rubygems/commands/open_command.rb
+- lib/rubygems/commands/readme_command.rb
+- lib/rubygems/commands/visit_command.rb
+- lib/rubygems_plugin.rb
+- README.rdoc
+- CHANGES.md
+has_rdoc: true
+homepage: http://github.com/gudleik/gem-toolbox
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "Adds extra commands to RubyGems: open, doc, history, readme and visit"
+test_files: []
+