gem-readme 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2495001a3130eec6372d5200c1efb03d46a67c89
+  data.tar.gz: bf2a4ad1fd309dd4df137c3076ceb658a52476d7
+SHA512:
+  metadata.gz: e8053aa7f21b6cba8c0c1bd978a8ee4d3c6c0781b0a786228e9333e7af0f3f4c2217268f4d202af7915af11f087b39965c4586f03ebca53653ffb47a129f9f1a
+  data.tar.gz: eb65d87ad217b26a922da1589abb82b4aaa9e268ce8e2c163e0000dca8edc83d0c3b40bd7863b761ae0bf036f9b1d99eb04048b9de01bb0e05ebc5322fc2b084

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gem-readme.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Thomas Storti
+
+MIT License
+
+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.md

@@ -0,0 +1,22 @@
+# gem-readme
+
+Your gems' README, right in your terminal, 'cuz life is too short to be wasted in a browser.
+
+## Installation
+
+As simples as it can be: `gem install gem-readme`
+
+## Usage
+
+Just type `gem readme [GEMNAME]` in your terminal. If you have multiple versions of this gem installed, you can choose the specific version.  
+Your `$README_EDITOR`, `$EDITOR` or `less` will be opened with the desired README file.
+
+## License
+
+Copyright (c) 2013 Brian Thomas Storti
+
+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 @@
+require "bundler/gem_tasks"

data/gem-readme.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "gem-readme"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Brian Thomas Storti"]
+  spec.email         = ["btstorti@gmail.com"]
+  spec.description   = %q{Read a gem's README file directlty in your terminal}
+  spec.summary       = %q{Read a gem's README file directlty in your terminal}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/rubygems/commands/readme_command.rb

@@ -0,0 +1,42 @@
+class Gem::Commands::ReadmeCommand < Gem::Command
+  def initialize
+    super("readme",
+          "Open the README file of a given gem",
+          editor: ENV["README_EDITOR"] || ENV["EDITOR"] || "less")
+  end
+
+  def execute
+    gem_specification = get_gem_specification
+
+    if gem_specification.nil?
+      say "Gem not found."
+      raise Gem::SystemExitException, 1
+    end
+
+    gem_path = gem_specification.full_gem_path
+    system "#{options[:editor]} $(find #{gem_path} -type f -iname 'readme.*')"
+  end
+
+  def get_gem_specification
+    gem_name, _ = options[:args]
+    specifications = Gem::Specification.each.select { |spec| spec.name == gem_name }
+
+    return if specifications.empty?
+    return specifications.first if specifications.size == 1
+
+    ask_for_specific_version(specifications)
+  end
+  private :get_gem_specification
+
+  def ask_for_specific_version(gem_specifications)
+    say("Choose a version:")
+    gem_specifications.each_with_index do |gem_specification, index|
+      say("[#{index}] #{gem_specification.version}")
+    end
+
+    print ">> "
+    index = STDIN.getc.to_i
+    gem_specifications[index]
+  end
+  private :ask_for_specific_version
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,6 @@
+require "rubygems/version"
+require 'rubygems/command_manager'
+require 'rubygems/version_option'
+require 'rubygems/gem/specification'
+
+Gem::CommandManager.instance.register_command :readme

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: gem-readme
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Thomas Storti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Read a gem's README file directlty in your terminal
+email:
+- btstorti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gem-readme.gemspec
+- lib/rubygems/commands/readme_command.rb
+- lib/rubygems_plugin.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Read a gem's README file directlty in your terminal
+test_files: []