rubygems-gman 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 752ce505aa9161ab73ffa1828d2656e7d228e563
+  data.tar.gz: 6ef2ae0f07e4592fc728e0f3a27ae016449c9d3c
+SHA512:
+  metadata.gz: ecd08f03b1f50b0d48b0fe17ae67fb0c4c0f825147ef88269637c217ce26f6b6201756d9f839ed3e7846c77f5a2761db10082e6634d986141c3fc1fd84b0a1a9
+  data.tar.gz: c9e0bd148723ea02f859800d1ec3f2387df7745afaaefa296efa31aa615b2d4745cee1b6dbfc412251f9407a393976dc32ea2df5ceeda0fcaf99c0c1a86b1272

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Calle Erlandsson
+
+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,27 @@
+rubygems-gman
+=============
+
+Generate and install man pages for installed gems.
+
+Installation
+------------
+
+Install the `rubygems-gman` gem using `gem`:
+
+    $ gem install rubygems-gman
+
+Usage
+-----
+
+After installing the `rubygems-gman` gem, man pages will automatically be
+generated and installed when installing new gems using `gem install`. The below
+commands can be used to generate or regenerate and install man pages after
+installing a new version of `rubygems-gman`.
+
+Generate and install man pages for all currently installed gems:
+
+    $ gem gman
+
+Generate and install man pages for a specific gem:
+
+    $ gem gman GEM

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rubygems/commands/gman_command.rb

@@ -0,0 +1,58 @@
+require "rubygems/command"
+require "rdoc"
+require "rdoc/generator/mdoc"
+
+class Gem::Commands::GmanCommand < Gem::Command
+  def initialize
+    super "gman", "Generate and install man pages for gems"
+  end
+
+  def usage
+    "gem gman [GEMNAME]"
+  end
+
+  def arguments
+    "GEMNAME       name of gem to generate man pages for"
+  end
+
+  def execute
+    if name = get_one_optional_argument
+      document_gem_with_name name
+    else
+      document_all_gems
+    end
+  end
+
+  def document(gem)
+    say "Generating man pages for #{gem.full_name}..."
+    RDoc::RDoc.new.document [
+      "-q",
+      "-f", "mdoc",
+      "--section", "#{mandb_section(gem)}",
+      "-o", "#{output_directory}",
+      *Dir.glob(gem.lib_dirs_glob),
+    ]
+  rescue => exception
+    say "Failed to generate man pages for #{gem.full_name} (#{exception})."
+  end
+
+  private
+
+  def document_gem_with_name(name)
+    document Gem::Specification.find_by_name(name)
+  rescue Gem::LoadError
+    say "Could not find a gem with the name \"#{name}\"."
+  end
+
+  def document_all_gems
+    Gem::Specification.each { |gem| document gem }
+  end
+
+  def output_directory
+    File.join(Dir.home, ".man")
+  end
+
+  def mandb_section(gem)
+    "3-rubygems-#{gem.name}-#{gem.version.to_s.gsub(".", "-")}"
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,8 @@
+require "rubygems/command_manager"
+require "rubygems/commands/gman_command"
+
+Gem::CommandManager.instance.register_command :gman
+
+Gem.post_install do |installer|
+  Gem::Commands::GmanCommand.new.document(installer.spec)
+end

data/rubygems-gman.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubygems-gman"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Calle Erlandsson"]
+  spec.email         = ["calle@thoughtbot.com", "hello@thoughtbot.com"]
+  spec.summary       = "Generate and install man pages for installed gems."
+  spec.homepage      = "https://github.com/thoughtbot/rubygems-gman"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "rdoc-generator-mdoc"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rubygems-gman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Calle Erlandsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc-generator-mdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- calle@thoughtbot.com
+- hello@thoughtbot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rubygems/commands/gman_command.rb
+- lib/rubygems_plugin.rb
+- rubygems-gman.gemspec
+homepage: https://github.com/thoughtbot/rubygems-gman
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Generate and install man pages for installed gems.
+test_files: []
+has_rdoc: