gem_readme 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 jugyo
+
+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.rdoc

@@ -0,0 +1,15 @@
+= gem_readme
+
+The 'gem readme' command that open gem's README.
+
+== Synopsis
+
+  gem readme GEMNAME
+
+== See Also
+
+* http://github.com/lmarlow/gemedit
+
+== Copyright
+
+Copyright (c) 2010 jugyo. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gem_readme"
+    gem.summary = %Q{gem readme}
+    gem.description = %Q{The 'gem readme' command open REAME file of specified gem.}
+    gem.email = "jugyo.org@gmail.com"
+    gem.homepage = "http://github.com/jugyo/gem_readme"
+    gem.authors = ["jugyo"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/gem_readme/readme_command.rb

@@ -0,0 +1,61 @@
+require 'rubygems/command'
+require 'rubygems/version_option'
+
+class Gem::Commands::ReadmeCommand < Gem::Command
+
+  OPTIONS = {
+    :version => Gem::Requirement.default,
+    :editor => 'less'
+  }
+
+  include Gem::VersionOption
+
+  def initialize
+    super 'readme', 'Open a README of an installed gem', OPTIONS
+
+    add_version_option
+
+    add_option('-e', '--editor EDITOR', String,
+               'The editor to use to open the gems',
+               "Default: #{OPTIONS[:editor]}") do |editor, options|
+      options[:editor] = editor
+    end
+  end
+
+  def arguments # :nodoc:
+    "GEMNAME       name of gem to open README"
+  end
+
+  def defaults_str # :nodoc:
+    "--version '#{OPTIONS[:version]}' --editor #{OPTIONS[:editor]}"
+  end
+
+  def usage # :nodoc:
+    "#{program_name} [options] GEMNAME [GEMNAME ...]"
+  end
+
+  def execute
+    version = options[:version] || OPTIONS[:version]
+
+    gem_specs = get_all_gem_names.map { |gem_name| Gem.source_index.find_name(gem_name, version).last }.compact
+
+    if gem_specs.size > 0
+      paths = gem_specs.map { |spec| spec.full_gem_path }
+
+      readmes = paths.inject([]) do |result, path|
+        result + Dir[File.join(path, '*')].select{ |i| File.basename(i) =~ /^readme/i }
+      end
+
+      if readmes.empty?
+        say "README not found!"
+        exit!
+      end
+
+      cmd = "#{options[:editor]} #{readmes.join(' ')}"
+      exec cmd unless options[:dryrun]
+    else
+      say "No gems found for #{get_all_gem_names.join(', ')}"
+      raise Gem::SystemExitException, 1
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,4 @@
+require 'rubygems/command_manager'
+
+require 'gem_readme/readme_command'
+Gem::CommandManager.instance.register_command :readme

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: gem_readme
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- jugyo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-16 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: The 'gem readme' command open REAME file of specified gem.
+email: jugyo.org@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/gem_readme/readme_command.rb
+- lib/rubygems_plugin.rb
+has_rdoc: true
+homepage: http://github.com/jugyo/gem_readme
+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: gem readme
+test_files: []
+