binman 0.1.1 → 0.1.2

data/HISTORY.markdown

@@ -1,3 +1,15 @@
+------------------------------------------------------------------------------
+Version 0.1.2 (2011-10-13)
+------------------------------------------------------------------------------
+
+Housekeeping:
+
+* Extracted `BinMan::Renderer` into [redcarpet-manpage] library.
+
+* The [Redcarpet2] library is not a runtime gem dependency anymore.
+
+* Forgot to introduce leading comment headers in binman(1) man page.
+
 ------------------------------------------------------------------------------
 Version 0.1.1 (2011-10-13)
 ------------------------------------------------------------------------------

data/bin/binman

@@ -2,7 +2,7 @@
 # encoding: utf-8
 =begin
 
-BINMAN 1 "2011-10-13" "0.1.1" "Ruby User Manuals"
+BINMAN 1 "2011-10-13" "0.1.2" "Ruby User Manuals"
 =================================================
 
 NAME
@@ -24,6 +24,8 @@ into roff(7) using [Redcarpet2], and display them using man(1).
 
 ### Leading Comment Headers
 
+A leading comment header can be one of the following two things:
+
 1. A contiguous sequence of single-line comments starting at the
    beginning of the file (after shebang and encoding comments plus
    optional blank lines) and ending at the first single blank line.
@@ -32,6 +34,15 @@ into roff(7) using [Redcarpet2], and display them using man(1).
 
 ### Markdown Processing Extensions
 
+The following [Redcarpet2] markdown processing extensions are enabled:
+
+* autolink
+* no_intra_emphasis
+* fenced_code_blocks
+* space_after_headers
+
+### Markdown Processing Divergence
+
 Although your leading comment headers are written in markdown(7), `binman`
 introduces the following additional conventions to simplify common tasks:
 

data/binman.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
   # s.add_runtime_dependency "rest-client"
-  s.add_runtime_dependency "redcarpet", ">= 2.0.0b5"
+  s.add_development_dependency "redcarpet-manpage", ">= 0.0.1"
 end

data/lib/binman.rb

@@ -41,8 +41,10 @@ module BinMan
   # Converts given leading comment header (produced by #read) into roff(7).
   #
   def dump header
-    require 'binman/renderer'
-    RENDERER.render(header)
+    require 'redcarpet-manpage'
+    RedcarpetManpage::RENDERER.render(header)
+  rescue LoadError
+    raise 'Run `gem install binman --development` to use dump().'
   end
 
   ##
@@ -59,7 +61,8 @@ module BinMan
     begin
       roff = dump(header)
       IO.popen('man -l -', 'w') {|man| man.puts roff }
-    rescue
+    rescue => error
+      warn "binman: #{error}"
       puts header
     end
   end

data/lib/binman/version.rb

@@ -1,3 +1,3 @@
 module BinMan
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/man/man1/binman.1

@@ -1,4 +1,4 @@
-.TH BINMAN 1 "2011-10-13" "0.1.1" "Ruby User Manuals"
+.TH BINMAN 1 "2011-10-13" "0.1.2" "Ruby User Manuals"
 .SH NAME
 .PP
 binman \- UNIX man pages for Ruby \fBbin/\fP scripts
@@ -15,6 +15,8 @@ into
 using \fBRedcarpet2\fP \fIhttps://github.com/tanoku/redcarpet\fP, and display them using 
 .BR man (1).
 .SS Leading Comment Headers
+.PP
+A leading comment header can be one of the following two things:
 .nr step 0 1
 .IP \n+[step]
 A contiguous sequence of single-line comments starting at the
@@ -24,6 +26,18 @@ optional blank lines) and ending at the first single blank line.
 First embedded document delimited by \fB=begin\fP and \fB=end\fP lines.
 .SS Markdown Processing Extensions
 .PP
+The following \fBRedcarpet2\fP \fIhttps://github.com/tanoku/redcarpet\fP markdown processing extensions are enabled:
+.
+.IP \[bu] 2 
+autolink
+.IP \[bu] 2 
+no_intra_emphasis
+.IP \[bu] 2 
+fenced_code_blocks
+.IP \[bu] 2 
+space_after_headers
+.SS Markdown Processing Divergence
+.PP
 Although your leading comment headers are written in 
 .BR markdown (7), 
 \fBbinman\fP

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binman
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,19 +9,19 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-13 00:00:00.000000000 Z
+date: 2011-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: &19851600 !ruby/object:Gem::Requirement
+  name: redcarpet-manpage
+  requirement: &21068040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0b5
-  type: :runtime
+        version: 0.0.1
+  type: :development
   prerelease: false
-  version_requirements: *19851600
+  version_requirements: *21068040
 description: ''
 email:
 - sunaku@gmail.com
@@ -40,7 +40,6 @@ files:
 - binman.gemspec
 - lib/binman.rb
 - lib/binman/rake_tasks.rb
-- lib/binman/renderer.rb
 - lib/binman/version.rb
 - man/man1/binman.1
 homepage: http://github.com/sunaku/binman

data/lib/binman/renderer.rb

@@ -1,58 +0,0 @@
-require 'redcarpet'
-require 'redcarpet/render_man'
-
-module BinMan
-  class Renderer < Redcarpet::Render::ManPage
-    def normal_text text
-      text.gsub(/(?<=\W)-(?=\W)/, '\\-') if text
-    end
-
-    def paragraph(text)
-      "\n.PP\n#{text}\n"
-    end
-
-    alias codespan double_emphasis
-    alias triple_emphasis double_emphasis
-
-    def autolink link, link_type
-      emphasis link
-    end
-
-    def link link, title, content
-      "#{triple_emphasis content} #{emphasis link}"
-    end
-
-    DEFINITION_INDENT = '  ' # two spaces
-
-    def postprocess document
-      document.
-        # squeeze blank lines to prevent double-spaced output
-        gsub(/^\n/, '').
-
-        # first paragraphs inside list items
-        gsub(/^(\.IP.*)\n\.PP/, '\1').
-
-        # paragraphs beginning with bold/italic and followed by
-        # at least one definition-indented line are definitions
-        gsub(/^\.PP(?=\n\\f.+\n#{DEFINITION_INDENT}\S)/, '.TP').
-
-        # make indented paragraphs occupy less space on screen:
-        # roff will fit the second line of the paragraph along
-        # side the first line if it has enough room to do so!
-        gsub(/^#{DEFINITION_INDENT}(?=\S)/, '').
-
-        # encode references to other man pages as "hyperlinks"
-        gsub(/(\w+)(\([1-9nol]\)[[:punct:]]?\s*)/, "\n.BR \\1 \\2\n").
-        # keep the SEE ALSO sequence of references in-line
-        gsub(/(?:^\.BR.+\n)+/m){ |sequence| sequence.squeeze("\n") }
-    end
-  end
-
-  RENDERER = Redcarpet::Markdown.new(Renderer,
-                                     #:tables => true,
-                                     :autolink => true,
-                                     #:superscript => true,
-                                     :no_intra_emphasis => true,
-                                     :fenced_code_blocks => true,
-                                     :space_after_headers => true)
-end