binman 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59dacb035f95229d4261bc1ede0d49c5351d2bfd
-  data.tar.gz: 3d08a026878970843143de1234a6f9274b94c166
+  metadata.gz: 3f3b3687542b1a69561f529fc61d665362d8f24c
+  data.tar.gz: eec321fbae059b219be9abfefc3787ef7a962c6f
 SHA512:
-  metadata.gz: b4687dde4ceb788cdb51a298d0e10a4798904467d7aac99531401f327e7e4c02d7c873503f81a63ee8310b5fc80f7a2cd95b901b6f06e762fcd1e47926a23089
-  data.tar.gz: aa1b36901f76a242909f99595eaee06f4b63897cf6197c9b6b8e9d9d6b7b3b6d7780cfe671f7e81b380004a248486ef15661545368df46b3e051b868ef8fbae0
+  metadata.gz: 9a33ac785e0c5f5cb781d378eeff7af67b383718109f8e660a6576a6c17a25fabe4c453d30a6cce5119bc3e87d1aacd83e31fd34f67a6c45c0fe18b65e222760
+  data.tar.gz: 47392e910b2c75e9f3d5590c357485e1c917a6d1df5bc3f17766b5230f108871a7aac8b7f1fb1e91ca83e7e73fd9dc8e00f02e3c3d05dd7b1b82f426c575879a

data/README.markdown

@@ -12,7 +12,7 @@
 
   * Individual extraction, conversion, and display commands.
 
-  * Implemented in roughly 100 lines of pure Ruby code! :-)
+  * Implemented in roughly 130 lines of pure Ruby code! :-)
 
 ### Demonstration
 

data/VERSION.markdown

@@ -1,3 +1,9 @@
+## Version 3.3.1 (2013-06-01)
+
+Patch:
+
+  * Ensure that md2man 2.0 is loaded before running any BinMan rake tasks.
+
 ## Version 3.3.0 (2013-05-08)
 
 Minor:

data/bin/binman

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# BINMAN 1 2013-05-08 3.3.0
+# BINMAN 1 2013-06-01 3.3.1
 
 ## NAME
 
@@ -34,7 +34,7 @@ A leading comment header can be one of the following two things:
 ### Markdown processing divergence
 
 Although your leading comment headers are written in markdown(7), `binman
-conv` inherits the following additions to markdown(7) syntax from [md2man]:
+conv` inherits the following additions to markdown(7) syntax from md2man(5):
 
   * There can be at most one top-level heading (H1).  It is emitted as `.TH`
     in the roff(7) output to define the UNIX manual page's header and footer.
@@ -55,7 +55,6 @@ The following [Redcarpet] extensions are enabled while processing markdown(7):
   * autolink
   * superscript
   * strikethrough
-  * no\_intra\_emphasis
   * fenced\_code\_blocks
 
 ## OPTIONS
@@ -88,7 +87,7 @@ The following [Redcarpet] extensions are enabled while processing markdown(7):
 
 ## SEE ALSO
 
-man(1), roff(7), markdown(7)
+binman-rake(1), man(1), roff(7), markdown(7)
 
 [binman]: https://github.com/sunaku/binman
 [md2man]: https://github.com/sunaku/md2man

data/bin/binman-rake

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# BINMAN-RAKE 1 2013-05-08 3.3.0
+# BINMAN-RAKE 1 2013-06-01 3.3.1
 
 ## NAME
 

data/lib/binman.rb

@@ -31,10 +31,9 @@ module BinMan
 
   # Converts given markdown(7) source into roff(7).
   def conv source=nil
+    require_md2man
     require 'md2man/roff/engine'
     Md2Man::Roff::ENGINE.render(read(source))
-  rescue LoadError
-    raise 'Run `gem install md2man --version "~> 2.0"` to use BinMan::conv().'
   end
 
   # Extracts leading comment header content from given
@@ -91,6 +90,15 @@ module BinMan
     end
   end
 
+  # Requires that the correct version of Md2Man is available on this system.
+  def require_md2man
+    require 'rubygems' unless respond_to? :gem
+    gem 'md2man', '~> 2.0' if respond_to? :gem
+    require 'md2man/version'
+  rescue LoadError
+    raise "Run `gem install md2man --version '~> 2.0'` for #{library.inspect}."
+  end
+
 private
 
   # Returns contents of given source I/O, file name, or string.

data/lib/binman/rakefile.rb

@@ -1,3 +1,4 @@
+require 'binman'
 require 'rake'
 
 # build man pages before building ruby gem using bundler
@@ -16,7 +17,6 @@ mkds = bins.pathmap("#{dir}/%n.1.markdown")
 
 bins.zip(mkds).each do |src, dst|
   file dst => [dir, src] do
-    require 'binman'
     output = BinMan.load(src)
     File.open(dst, 'w') {|f| f << output }
   end
@@ -26,6 +26,7 @@ end
 desc 'Build UNIX manual pages for bin/ scripts.'
 task 'binman:man' => mkds do
 #-----------------------------------------------------------------------------
+  BinMan.require_md2man
   load 'md2man/rakefile.rb'
   Rake::Task['md2man:man'].invoke
 end
@@ -34,6 +35,7 @@ end
 desc 'Build HTML manual pages for bin/ scripts.'
 task 'binman:web' => mkds do
 #-----------------------------------------------------------------------------
+  BinMan.require_md2man
   load 'md2man/rakefile.rb'
   Rake::Task['md2man:web'].invoke
 end

data/lib/binman/version.rb

@@ -1,3 +1,3 @@
 module BinMan
-  VERSION = "3.3.0"
+  VERSION = "3.3.1"
 end

data/man/man0/README.html

@@ -14,7 +14,7 @@ comments or uses <code>#</code> for single-line comments: Ruby,
 Perl, Python, Node.js, Tcl, AWK, UNIX shell, and more!</p></li>
 <li><p>Provides a Ruby library and a command-line client too.</p></li>
 <li><p>Individual extraction, conversion, and display commands.</p></li>
-<li><p>Implemented in roughly 100 lines of pure Ruby code! :-)</p></li>
+<li><p>Implemented in roughly 130 lines of pure Ruby code! :-)</p></li>
 </ul>
 <h3 id="Demonstration">Demonstration</h3><p><img src="http://ompldr.org/vYm5mcg" alt="Obligatory screen-shot of binman(1) in action!"></p><p>Here is <a href="https://raw.github.com/sunaku/binman/master/bin/binman">a complete example in Ruby</a> to help you get started.
 For examples in other scripting languages, see the &quot;Usage&quot; section below!</p><h2 id="Installation">Installation</h2><p>If you only want to view pre-built manual pages:</p>

data/man/man0/README.markdown

@@ -12,7 +12,7 @@
 
   * Individual extraction, conversion, and display commands.
 
-  * Implemented in roughly 100 lines of pure Ruby code! :-)
+  * Implemented in roughly 130 lines of pure Ruby code! :-)
 
 ### Demonstration
 

data/man/man0/VERSION.html

@@ -7,7 +7,11 @@
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/VERSION</span></div></div><div class="container-fluid"><h2 id="Version-3-3-0-2013-05-08">Version 3.3.0 (2013-05-08)</h2><p>Minor:</p>
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/VERSION</span></div></div><div class="container-fluid"><h2 id="Version-3-3-1-2013-06-01">Version 3.3.1 (2013-06-01)</h2><p>Patch:</p>
+<ul>
+<li>Ensure that md2man 2.0 is loaded before running any BinMan rake tasks.</li>
+</ul>
+<h2 id="Version-3-3-0-2013-05-08">Version 3.3.0 (2013-05-08)</h2><p>Minor:</p>
 <ul>
 <li><p>Add <a class="md2man-xref" href="../man1/binman-rake.1.html">binman-rake(1)</a> script to provide access to <code>binman/rakefile</code> tasks.</p></li>
 <li><p>Always try showing HTML manual page in web browser from <code>BinMan.show()</code>.</p></li>

data/man/man0/VERSION.markdown

@@ -1,3 +1,9 @@
+## Version 3.3.1 (2013-06-01)
+
+Patch:
+
+  * Ensure that md2man 2.0 is loaded before running any BinMan rake tasks.
+
 ## Version 3.3.0 (2013-05-08)
 
 Minor:

data/man/man1/binman-rake.1

@@ -1,4 +1,4 @@
-.TH BINMAN\-RAKE 1 2013\-05\-08 3.3.0
+.TH BINMAN\-RAKE 1 2013\-06\-01 3.3.1
 .SH NAME
 .PP
 binman\-rake \- run 

data/man/man1/binman-rake.1.html

@@ -7,7 +7,7 @@
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman-rake.1</span></div></div><div class="container-fluid"><h1 id="BINMAN-RAKE-1-2013-05-08-3-3-0">BINMAN-RAKE 1 2013-05-08 3.3.0</h1><h2 id="NAME">NAME</h2><p>binman-rake - run <a class="md2man-xref">rake(1)</a> tasks from <a class="md2man-xref" href="../man1/binman.1.html">binman(1)</a></p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>binman-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="DESCRIPTION">DESCRIPTION</h2><p>This program lets you run <a class="md2man-xref">rake(1)</a> tasks provided by <a class="md2man-xref" href="../man1/binman.1.html">binman(1)</a> without having
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman-rake.1</span></div></div><div class="container-fluid"><h1 id="BINMAN-RAKE-1-2013-06-01-3-3-1">BINMAN-RAKE 1 2013-06-01 3.3.1</h1><h2 id="NAME">NAME</h2><p>binman-rake - run <a class="md2man-xref">rake(1)</a> tasks from <a class="md2man-xref" href="../man1/binman.1.html">binman(1)</a></p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>binman-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="DESCRIPTION">DESCRIPTION</h2><p>This program lets you run <a class="md2man-xref">rake(1)</a> tasks provided by <a class="md2man-xref" href="../man1/binman.1.html">binman(1)</a> without having
 to create a special file named <code>Rakefile</code> that contains the following snippet:</p>
 <pre><code>require &#39;binman/rakefile&#39;
 </code></pre>

data/man/man1/binman.1

@@ -1,4 +1,4 @@
-.TH BINMAN 1 2013\-05\-08 3.3.0
+.TH BINMAN 1 2013\-06\-01 3.3.1
 .SH NAME
 .PP
 binman \- man pages for bin scripts
@@ -42,9 +42,8 @@ Although your leading comment headers are written in
 \fB\fCbinman
 conv\fR inherits the following additions to 
 .BR markdown (7) 
-syntax from md2man
-.UR https://github.com/sunaku/md2man
-.UE :
+syntax from 
+.BR md2man (5):
 .RS
 .IP \(bu 2
 There can be at most one top\-level heading (H1).  It is emitted as \fB\fC.TH\fR
@@ -81,8 +80,6 @@ superscript
 .IP \(bu 2
 strikethrough
 .IP \(bu 2
-no_intra_emphasis
-.IP \(bu 2
 fenced_code_blocks
 .RE
 .SH OPTIONS
@@ -127,6 +124,7 @@ document read from the given
 \fIFILE\fP or STDIN.
 .SH SEE ALSO
 .PP
+.BR binman-rake (1), 
 .BR man (1), 
 .BR roff (7), 
 .BR markdown (7)

data/man/man1/binman.1.html

@@ -7,7 +7,7 @@
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman.1</span></div></div><div class="container-fluid"><h1 id="BINMAN-1-2013-05-08-3-3-0">BINMAN 1 2013-05-08 3.3.0</h1><h2 id="NAME">NAME</h2><p>binman - man pages for bin scripts</p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>binman</code> [<em>OPTION</em>]... <em>COMMAND</em></p><h2 id="DESCRIPTION">DESCRIPTION</h2><p><a href="https://github.com/sunaku/binman">binman</a> produces UNIX manual pages for your executable scripts. It can
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman.1</span></div></div><div class="container-fluid"><h1 id="BINMAN-1-2013-06-01-3-3-1">BINMAN 1 2013-06-01 3.3.1</h1><h2 id="NAME">NAME</h2><p>binman - man pages for bin scripts</p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>binman</code> [<em>OPTION</em>]... <em>COMMAND</em></p><h2 id="DESCRIPTION">DESCRIPTION</h2><p><a href="https://github.com/sunaku/binman">binman</a> produces UNIX manual pages for your executable scripts. It can
 extract their leading comment headers (defined below), convert them from
 <a class="md2man-xref">markdown(7)</a> into <a class="md2man-xref">roff(7)</a> using <a href="https://github.com/sunaku/md2man">md2man</a>, and display them using <a class="md2man-xref">man(1)</a>.</p><h3 id="Leading-comment-headers">Leading comment headers</h3><p>A leading comment header can be one of the following two things:</p>
 <ol>
@@ -21,7 +21,7 @@ begin with the respective delimiters and optionally continue with a single
 space followed by any number of characters until the end of the line.</p></li>
 </ol>
 <h3 id="Markdown-processing-divergence">Markdown processing divergence</h3><p>Although your leading comment headers are written in <a class="md2man-xref">markdown(7)</a>, <code>binman
-conv</code> inherits the following additions to <a class="md2man-xref">markdown(7)</a> syntax from <a href="https://github.com/sunaku/md2man">md2man</a>:</p>
+conv</code> inherits the following additions to <a class="md2man-xref">markdown(7)</a> syntax from <a class="md2man-xref">md2man(5)</a>:</p>
 <ul>
 <li><p>There can be at most one top-level heading (H1).  It is emitted as <code>.TH</code>
 in the <a class="md2man-xref">roff(7)</a> output to define the UNIX manual page&#39;s header and footer.</p></li>
@@ -38,7 +38,6 @@ are unindented accordingly before emission as <code>.TP</code> in the <a class="
 <li>autolink</li>
 <li>superscript</li>
 <li>strikethrough</li>
-<li>no_intra_emphasis</li>
 <li>fenced_code_blocks</li>
 </ul>
 <h2 id="OPTIONS">OPTIONS</h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="COMMANDS">COMMANDS</h2><dl><dt><code>help</code> <em>FILE</em> [<em>ARGUMENT</em>]...</dt><dd>If the given <em>ARGUMENT</em> sequence contains <code>-h</code> or <code>--help</code> except after
@@ -47,5 +46,5 @@ converts it into <a class="md2man-xref">roff(7)</a>, and displays it using <a cl
 status code <code>0</code>.  Otherwise, this program exits with status code <code>111</code>.</dd></dl><dl><dt><code>show</code> [<em>FILE</em>]</dt><dd>Use <a class="md2man-xref">man(1)</a> to display the <a class="md2man-xref">roff(7)</a> conversion of the leading comment header
 extracted from the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>load</code> [<em>FILE</em>]</dt><dd>Print the leading comment header extracted from the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>dump</code> [<em>FILE</em>]</dt><dd>Print the <a class="md2man-xref">roff(7)</a> conversion of the leading comment header extracted from
 the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>conv</code> [<em>FILE</em>]</dt><dd>Print the <a class="md2man-xref">roff(7)</a> conversion of the <a class="md2man-xref">markdown(7)</a> document read from the given
-<em>FILE</em> or STDIN.</dd></dl><h2 id="SEE-ALSO">SEE ALSO</h2><p><a class="md2man-xref">man(1)</a>, <a class="md2man-xref">roff(7)</a>, <a class="md2man-xref">markdown(7)</a></p></div></body>
+<em>FILE</em> or STDIN.</dd></dl><h2 id="SEE-ALSO">SEE ALSO</h2><p><a class="md2man-xref" href="../man1/binman-rake.1.html">binman-rake(1)</a>, <a class="md2man-xref">man(1)</a>, <a class="md2man-xref">roff(7)</a>, <a class="md2man-xref">markdown(7)</a></p></div></body>
 </html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binman
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Suraj N. Kurapati
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-08 00:00:00.000000000 Z
+date: 2013-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: md2man