gem-man 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Chris Wanstrath
+
+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,80 @@
+gem-man(1) -- view a gem's man page
+===================================
+
+## SYNOPSIS
+
+`gem man` <GEM>  
+`gem man` --latest <GEM>  
+`gem man` --exact <GEM>  
+`gem man` --all
+
+## DESCRIPTION
+
+The `gem man` command can be used to display a man page for an
+installed RubyGem. The man page must be included with the gem -
+`gem-man` does no generation or magic.
+
+For an introduction to man pages, see `man(1)` (or type `man man` in
+your shell).
+
+## GEM
+
+`gem man` expects to be passed the name of an installed gem. If there
+are multiple man pages found for the gem, you will be asked which
+you'd like to view. If only a single man page is found it will be
+displayed.
+
+Man pages are any files whose extension is a single digit [0-9],
+e.g. `ron.1`.
+
+## OPTIONS
+
+`gem man`'s default mode of operation is to open a man page for a
+single gem or, if multiple man pages are found, ask which you'd like
+to open. If there are any ambiguities as to which gem to use, `gem
+man` will ask which you'd prefer.
+
+You can specify gems or list available gems using a few options.
+
+  * `-l`, `--latest`:
+    If there are multiple versions of a gem, open the latest.
+
+  * `-v`, `--version`:
+    Specify version of gem to man.
+
+  * `-e`, `--exact`:
+    Only list exact matches.
+
+  * `-a`, `--all`:
+    List all installed gems that have manuals.
+
+See `gem help man` to view the options at any time.
+
+## INSTALL
+
+    gem install gem-man
+
+## BUGS
+
+Requires the `man(1)` script to be in your path, executable, and to
+accept a full path to a manual.
+
+Requires Ruby and RubyGems 1.3.2 (or higher).
+
+Please report other bugs at <http://github.com/defunkt/gem-man>
+
+## THANKS
+
+* adamsanderson for open_gem
+* rtomayko for ron
+
+## COPYRIGHT
+
+gem-man is Copyright (C) 2010 Chris Wanstrath with parts from Adam
+Sanderson.
+
+## SEE ALSO
+
+ron(5), man(1), less(1), roff(7), groff(1),
+<http://en.wikipedia.org/wiki/Man_page>,
+<http://github.com/defunkt/gem-man>

data/Rakefile

@@ -0,0 +1,16 @@
+desc "Build the manual"
+task :build_man do
+  sh "ron -br5 --organization=DEFUNKT --manual='RubyGems Manual' man/*.ron"
+end
+
+desc "Show the manual"
+task :man => :build_man do
+  exec "man man/gem-man.1"
+end
+
+begin
+  require 'mg'
+  MG.new('gem-man.gemspec')
+rescue Loaderror
+  warn "gem install mg to get gem tasks"
+end

data/lib/rubygems/commands/man_command.rb

@@ -0,0 +1,113 @@
+# Much of this is stolen from the `open_gem` RubyGem's "read"
+# command - thanks Adam!
+#
+# http://github.com/adamsanderson/open_gem/blob/dfddaa286e/lib/rubygems/commands/read_command.rb
+class Gem::Commands::ManCommand < Gem::Command
+  include Gem::VersionOption
+
+  def initialize
+    super 'man', "Open a gem's manual",
+      :command => nil,
+      :version => Gem::Requirement.default,
+      :latest  => false,
+      :all     => false
+
+    add_all_gems_option
+    add_latest_version_option
+    add_version_option
+    add_exact_match_option
+  end
+
+  def add_all_gems_option
+    add_option('-a', '--all',
+      'List all installed gems that have manuals.') do |value, options|
+      options[:all] = true
+    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 add_exact_match_option
+    add_option('-x', '--exact', 'Only list exact matches') do |value, options|
+      options[:exact] = true
+    end
+  end
+
+  def arguments
+    "GEMNAME       gem whose manual you wish to read"
+  end
+
+  def execute
+    if options[:all]
+      puts "These gems have man pages:", ''
+      Gem.source_index.gems.each do |name, spec|
+        puts "#{spec.name} #{spec.version}" if spec.has_manpage?
+      end
+    else
+      # Grab our target gem.
+      name = get_one_gem_name
+
+      # Try to read manpages.
+      read_manpage get_spec(name) { |s| s.has_manpage? }
+    end
+  end
+
+  def read_manpage(spec)
+    return if spec.nil?
+
+    paths = spec.manpages
+
+    # man/ron.1 => ron(1)
+    names = paths.map do |path|
+      path.sub(/.*\/(.+)\.(\d+)/, '\1(\2)')
+    end
+
+    if paths.size == 1
+      manpath = paths[0]
+    elsif paths.size > 1
+      name, index = choose_from_list("View which manual?", names)
+      manpath = paths[index]
+    end
+
+    if manpath
+      exec "man #{File.join(gem_path(spec), manpath)}"
+    else
+      abort "no manuals found for #{spec.name}"
+    end
+  end
+
+  def gem_path(spec)
+    File.join(spec.installation_path, "gems", spec.full_name)
+  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"
+        nil
+      end
+    elsif specs.length == 1 || options[:latest]
+      specs.last
+    else
+      choices = specs.map { |s| "#{s.name} #{s.version}" }
+      c, i = choose_from_list "Open which gem?", choices
+      specs[i] if i
+    end
+  end
+end

data/lib/rubygems/gem/specification.rb

@@ -0,0 +1,13 @@
+class Gem::Specification
+  # Does this specification include a manpage?
+  def has_manpage?
+    manpages.any?
+  end
+
+  # Paths to the manpages included in this gem.
+  def manpages
+    @files.select do |file|
+      file =~ /man\/(.+).\d$/
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,4 @@
+require 'rubygems/command_manager'
+require 'rubygems/gem/specification'
+
+Gem::CommandManager.instance.register_command :man

data/man/gem-man.1

@@ -0,0 +1,102 @@
+.\" generated with Ron/v0.3
+.\" http://github.com/rtomayko/ron/
+.
+.TH "GEM\-MAN" "1" "March 2010" "DEFUNKT" "RubyGems Manual"
+.
+.SH "NAME"
+\fBgem-man\fR \-\- view a gem's man page
+.
+.SH "SYNOPSIS"
+\fBgem man\fR \fIGEM\fR
+.
+.br
+\fBgem man\fR \-\-latest \fIGEM\fR
+.
+.br
+\fBgem man\fR \-\-exact \fIGEM\fR
+.
+.br
+\fBgem man\fR \-\-list
+.
+.br
+.
+.SH "DESCRIPTION"
+The \fBgem man\fR command can be used to display a man page for an
+installed RubyGem. The man page must be included with the gem \- \fBgem-man\fR does no generation or magic.
+.
+.P
+For an introduction to man pages, see \fBman(1)\fR (or type \fBman man\fR in
+your shell).
+.
+.SH "GEM"
+\fBgem man\fR expects to be passed the name of an installed gem. If there
+are multiple man pages found for the gem, you will be asked which
+you'd like to view. If only a single man page is found it will be
+displayed.
+.
+.P
+Man pages are any files whose extension is a single digit [0\-9],
+e.g. \fBron.1\fR.
+.
+.SH "OPTIONS"
+\fBgem man\fR's default mode of operation is to open a man page for a
+single gem or, if multiple man pages are found, ask which you'd like
+to open. If there are any ambiguities as to which gem to use, \fBgem
+man\fR will ask which you'd prefer.
+.
+.P
+You can specify gems or list available gems using a few options.
+.
+.TP
+\fB-l\fR, \fB--latest\fR 
+If there are multiple versions of a gem, open the latest.
+.
+.TP
+\fB-v\fR, \fB--version\fR 
+Specify version of gem to man.
+.
+.TP
+\fB-e\fR, \fB--exact\fR 
+Only list exact matches.
+.
+.TP
+\fB-a\fR, \fB--all\fR 
+List all installed gems that have manuals.
+.
+.P
+See \fBgem help man\fR to view the options at any time.
+.
+.SH "INSTALL"
+.
+.nf
+
+\fBgem install gem-man \fR
+.
+.fi
+.
+.SH "BUGS"
+Requires the \fBman(1)\fR script to be in your path, executable, and to
+accept a full path to a manual.
+.
+.P
+Requires Ruby and RubyGems 1.3.2 (or higher).
+.
+.P
+Please report other bugs at \fIhttp://github.com/defunkt/gem\-man\fR
+.
+.SH "THANKS"
+.
+.IP "\(bu" 4
+adamsanderson for open_gem
+.
+.IP "\(bu" 4
+rtomayko for ron
+.
+.IP "" 0
+.
+.SH "COPYRIGHT"
+gem\-man is Copyright (C) 2010 Chris Wanstrath with parts from Adam
+Sanderson.
+.
+.SH "SEE ALSO"
+ron(5), man(1), less(1), roff(7), groff(1),\fIhttp://en.wikipedia.org/wiki/Man_page\fR, \fIhttp://github.com/defunkt/gem\-man\fR

data/man/gem-man.1.html

@@ -0,0 +1,166 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ron/v0.3'>
+  <title>gem-man(1) -- view a gem's man page</title>
+  <style type='text/css'>
+    body {margin:0}
+    #man, #man code, #man pre, #man tt, #man kbd, #man samp {
+      font-family:consolas,monospace;
+      font-size:16px;
+      line-height:1.3;
+      color:#343331;
+      background:#fff; }
+    #man { max-width:89ex; text-align:justify; margin:0 25px 25px 25px }
+    #man h1, #man h2, #man h3 { color:#232221;clear:left }
+    #man h1 { font-size:28px; margin:15px 0 30px 0; text-align:center }
+    #man h2 { font-size:18px; margin-bottom:0; margin-top:10px; line-height:1.3; }
+    #man h3 { font-size:16px; margin:0 0 0 4ex; }
+    #man p, #man ul, #man ol, #man dl, #man pre { margin:0 0 18px 0; }
+    #man pre {
+      color:#333231;
+      background:#edeceb;
+      padding:5px 7px;
+      margin:0px 0 20px 0;
+      border-left:2ex solid #ddd}
+    #man pre + h2, #man pre + h3 {
+      margin-top:22px;
+    }
+    #man h2 + pre, #man h3 + pre {
+      margin-top:5px;
+    }
+    #man > p, #man > ul, #man > ol, #man > dl, #man > pre { margin-left:8ex; }
+    #man dt { margin:0; clear:left }
+    #man dt.flush { float:left; width:8ex }
+    #man dd { margin:0 0 0 9ex }
+    #man code, #man strong, #man b { font-weight:bold; color:#131211; }
+    #man pre code { font-weight:normal; color:#232221; background:inherit }
+    #man em, var, u {
+      font-style:normal; color:#333231; border-bottom:1px solid #999; }
+    #man h1.man-title { display:none; }
+    #man ol.man, #man ol.man li { margin:2px 0 10px 0; padding:0;
+      float:left; width:33%; list-style-type:none;
+      text-transform:uppercase; font-size:18px; color:#999;
+      letter-spacing:1px;}
+    #man ol.man { width:100%; }
+    #man ol.man li.tl { text-align:left }
+    #man ol.man li.tc { text-align:center;letter-spacing:4px }
+    #man ol.man li.tr { text-align:right }
+    #man ol.man a { color:#999 }
+    #man ol.man a:hover { color:#333231 }
+  </style>
+</head>
+<body>
+<div id='man'>
+
+<h1 class='man-title'>gem-man(1)</h1>
+
+<ol class='head man'>
+  <li class='tl'>gem-man(1)</li>
+  <li class='tc'>RubyGems Manual</li>
+  <li class='tr'>gem-man(1)</li>
+</ol>
+
+<h2 id='NAME'>NAME</h2>
+<p><code>gem-man</code> -- view a gem's man page</p>
+<h2>SYNOPSIS</h2>
+
+<p><code>gem man</code> <var>GEM</var><br>
+<code>gem man</code> --latest <var>GEM</var><br>
+<code>gem man</code> --exact <var>GEM</var><br>
+<code>gem man</code> --list<br>
+</p>
+
+<h2>DESCRIPTION</h2>
+
+<p>The <code>gem man</code> command can be used to display a man page for an
+installed RubyGem. The man page must be included with the gem -
+<code>gem-man</code> does no generation or magic.</p>
+
+<p>For an introduction to man pages, see <code>man(1)</code> (or type <code>man man</code> in
+your shell).</p>
+
+<h2>GEM</h2>
+
+<p><code>gem man</code> expects to be passed the name of an installed gem. If there
+are multiple man pages found for the gem, you will be asked which
+you'd like to view. If only a single man page is found it will be
+displayed.</p>
+
+<p>Man pages are any files whose extension is a single digit [0-9],
+e.g. <code>ron.1</code>.</p>
+
+<h2>OPTIONS</h2>
+
+<p><code>gem man</code>'s default mode of operation is to open a man page for a
+single gem or, if multiple man pages are found, ask which you'd like
+to open. If there are any ambiguities as to which gem to use, <code>gem
+man</code> will ask which you'd prefer.</p>
+
+<p>You can specify gems or list available gems using a few options.</p>
+
+<dl>
+<dt>
+<code>-l</code>, <code>--latest</code>
+</dt>
+<dd><p>If there are multiple versions of a gem, open the latest.</p></dd>
+<dt>
+<code>-v</code>, <code>--version</code>
+</dt>
+<dd><p>Specify version of gem to man.</p></dd>
+<dt>
+<code>-e</code>, <code>--exact</code>
+</dt>
+<dd><p>Only list exact matches.</p></dd>
+<dt>
+<code>-a</code>, <code>--all</code>
+</dt>
+<dd><p>List all installed gems that have manuals.</p></dd>
+</dl>
+
+
+<p>See <code>gem help man</code> to view the options at any time.</p>
+
+<h2>INSTALL</h2>
+
+<pre><code>gem install gem-man
+</code></pre>
+
+<h2>BUGS</h2>
+
+<p>Requires the <code>man(1)</code> script to be in your path, executable, and to
+accept a full path to a manual.</p>
+
+<p>Requires Ruby and RubyGems 1.3.2 (or higher).</p>
+
+<p>Please report other bugs at <a href="http://github.com/defunkt/gem-man">http://github.com/defunkt/gem-man</a></p>
+
+<h2>THANKS</h2>
+
+<ul>
+<li>adamsanderson for open_gem</li>
+<li>rtomayko for ron</li>
+</ul>
+
+
+<h2>COPYRIGHT</h2>
+
+<p>gem-man is Copyright (C) 2010 Chris Wanstrath with parts from Adam
+Sanderson.</p>
+
+<h2>SEE ALSO</h2>
+
+<p>ron(5), man(1), less(1), roff(7), groff(1),
+<a href="http://en.wikipedia.org/wiki/Man_page">http://en.wikipedia.org/wiki/Man_page</a>,
+<a href="http://github.com/defunkt/gem-man">http://github.com/defunkt/gem-man</a></p>
+
+<ol class='foot man'>
+  <li class='tl'>DEFUNKT</li>
+  <li class='tc'>March 2010</li>
+  <li class='tr'>gem-man(1)</li>
+</ol>
+
+</div>
+</body>
+</html>

data/man/gem-man.1.ron

@@ -0,0 +1,80 @@
+gem-man(1) -- view a gem's man page
+===================================
+
+## SYNOPSIS
+
+`gem man` <GEM>  
+`gem man` --latest <GEM>  
+`gem man` --exact <GEM>  
+`gem man` --all
+
+## DESCRIPTION
+
+The `gem man` command can be used to display a man page for an
+installed RubyGem. The man page must be included with the gem -
+`gem-man` does no generation or magic.
+
+For an introduction to man pages, see `man(1)` (or type `man man` in
+your shell).
+
+## GEM
+
+`gem man` expects to be passed the name of an installed gem. If there
+are multiple man pages found for the gem, you will be asked which
+you'd like to view. If only a single man page is found it will be
+displayed.
+
+Man pages are any files whose extension is a single digit [0-9],
+e.g. `ron.1`.
+
+## OPTIONS
+
+`gem man`'s default mode of operation is to open a man page for a
+single gem or, if multiple man pages are found, ask which you'd like
+to open. If there are any ambiguities as to which gem to use, `gem
+man` will ask which you'd prefer.
+
+You can specify gems or list available gems using a few options.
+
+  * `-l`, `--latest`:
+    If there are multiple versions of a gem, open the latest.
+
+  * `-v`, `--version`:
+    Specify version of gem to man.
+
+  * `-e`, `--exact`:
+    Only list exact matches.
+
+  * `-a`, `--all`:
+    List all installed gems that have manuals.
+
+See `gem help man` to view the options at any time.
+
+## INSTALL
+
+    gem install gem-man
+
+## BUGS
+
+Requires the `man(1)` script to be in your path, executable, and to
+accept a full path to a manual.
+
+Requires Ruby and RubyGems 1.3.2 (or higher).
+
+Please report other bugs at <http://github.com/defunkt/gem-man>
+
+## THANKS
+
+* adamsanderson for open_gem
+* rtomayko for ron
+
+## COPYRIGHT
+
+gem-man is Copyright (C) 2010 Chris Wanstrath with parts from Adam
+Sanderson.
+
+## SEE ALSO
+
+ron(5), man(1), less(1), roff(7), groff(1),
+<http://en.wikipedia.org/wiki/Man_page>,
+<http://github.com/defunkt/gem-man>

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: gem-man
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Wanstrath
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-06 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: "  The `gem man` command can be used to display a man page for an\n  installed RubyGem. The man page must be included with the gem -\n  `gem-man` does no generation or magic.\n\n  For an introduction to man pages, see `man(1)` (or type `man man` in\n  your shell).\n"
+email: chris@ozmm.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- LICENSE
+- lib/rubygems/commands/man_command.rb
+- lib/rubygems/gem/specification.rb
+- lib/rubygems_plugin.rb
+- man/gem-man.1
+- man/gem-man.1.html
+- man/gem-man.1.ron
+has_rdoc: true
+homepage: http://github.com/defunkt/gem-man
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: View a gem's man page.
+test_files: []
+