redcarpet-manpage 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in redcarpet-manpage.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,16 @@
+(the ISC license)
+
+Copyright 2011 Vicent Martí <vicent@github.com>
+Copyright 2011 Suraj N. Kurapati <sunaku@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.markdown

@@ -0,0 +1,78 @@
+RedcarpetManpage - UNIX man page renderer for Redcarpet2
+========================================================
+
+RedcarpetManpage is a Ruby library that converts [Markdown] documents into
+UNIX man pages ([roff] documents) using the awesome [Redcarpet2] library.
+
+[Markdown]: http://daringfireball.net/projects/markdown/
+[roff]: http://man.cx/roff(7)
+[Redcarpet2]: https://github.com/tanoku/redcarpet
+
+------------------------------------------------------------------------------
+Installation
+------------------------------------------------------------------------------
+
+As a Ruby gem:
+
+    gem install redcarpet-manpage
+
+As a Git clone:
+
+    git clone git://github.com/sunaku/redcarpet-manpage
+    cd redcarpet-manpage
+    bundle install
+
+------------------------------------------------------------------------------
+Specification
+------------------------------------------------------------------------------
+
+### Markdown Processing Extensions
+
+`RedcarpetManpage::RENDERER` enables the following [Redcarpet2] extensions:
+
+* `autolink`
+* `no_intra_emphasis`
+* `fenced_code_blocks`
+* `space_after_headers`
+
+### Markdown Processing Divergence
+
+Although your input documents are written in [Markdown], RedcarpetManpage
+introduces the following additional conventions to simplify common tasks:
+
+1. Paragraphs beginning with bold/italic and followed by at least
+   one two-space indented line are considered to be definitions.
+   The first line of such a paragraph is the term being defined and
+   the subsequent two-space indented lines are the definition body.
+
+------------------------------------------------------------------------------
+Usage
+------------------------------------------------------------------------------
+
+Use the default renderer:
+
+``` ruby
+require 'redcarpet-manpage'
+your_roff_output = RedcarpetManpage::RENDERER.render(your_markdown_input)
+```
+
+Or extend it for yourself:
+
+``` ruby
+require 'redcarpet-manpage'
+
+class YourManpageRenderer < RedcarpetManpage::Renderer
+  # ... your stuff here ...
+  # See Redcarpet::Render::Base documentation for more information:
+  # http://rdoc.info/github/tanoku/redcarpet/master/Redcarpet/Render/Base
+end
+
+renderer = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
+your_roff_output = renderer.render(your_markdown_input)
+```
+
+------------------------------------------------------------------------------
+License
+------------------------------------------------------------------------------
+
+Released under the ISC license.  See the LICENSE file for details.

data/Rakefile

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

data/lib/redcarpet-manpage.rb

@@ -0,0 +1,107 @@
+require 'redcarpet'
+
+module RedcarpetManpage
+
+  class Renderer < Redcarpet::Render::Base
+    def normal_text(text)
+      text.gsub(/(?<=\W)-(?=\W)/, '\\-') if text
+    end
+
+    def triple_emphasis(text)
+      "\\fB#{text}\\fP"
+    end
+
+    alias double_emphasis triple_emphasis
+
+    def emphasis(text)
+      "\\fI#{text}\\fP"
+    end
+
+    def block_code(code, language)
+      "\n.nf\n#{normal_text(code)}\n.fi\n"
+    end
+
+    alias codespan double_emphasis
+
+    def link(link, title, content)
+      "#{triple_emphasis(content)} #{emphasis(link)}"
+    end
+
+    def autolink(link, link_type)
+      emphasis(link)
+    end
+
+    def header(title, level)
+      case level
+      when 1
+        "\n.TH #{title}\n"
+
+      when 2
+        "\n.SH #{title}\n"
+
+      when 3
+        "\n.SS #{title}\n"
+      end
+    end
+
+    def paragraph(text)
+      "\n.PP\n#{text}\n"
+    end
+
+    def linebreak
+      "\n.LP\n"
+    end
+
+    def list(content, list_type)
+      case list_type
+      when :ordered
+        "\n\n.nr step 0 1\n#{content}\n"
+      when :unordered
+        "\n.\n#{content}\n"
+      end
+    end
+
+    def list_item(content, list_type)
+      case list_type
+      when :ordered
+        ".IP \\n+[step]\n#{content.strip}\n"
+      when :unordered
+        ".IP \\[bu] 2 \n#{content.strip}\n"
+      end
+    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

data/lib/redcarpet-manpage/version.rb

@@ -0,0 +1,3 @@
+module RedcarpetManpage
+  VERSION = "0.0.1"
+end

data/redcarpet-manpage.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "redcarpet-manpage/version"
+
+Gem::Specification.new do |s|
+  s.name        = "redcarpet-manpage"
+  s.version     = RedcarpetManpage::VERSION
+  s.authors,
+  s.email       = File.read('LICENSE').scan(/Copyright \d+ (.+) <(.+?)>/).transpose
+  s.homepage    = "http://github.com/sunaku/redcarpet-manpage"
+  s.summary     = "UNIX man page renderer for Redcarpet2"
+  s.description = nil
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # 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"
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: redcarpet-manpage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Vicent Martí
+- Suraj N. Kurapati
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &14053840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0b5
+  type: :runtime
+  prerelease: false
+  version_requirements: *14053840
+description: ''
+email:
+- vicent@github.com
+- sunaku@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/redcarpet-manpage.rb
+- lib/redcarpet-manpage/version.rb
+- redcarpet-manpage.gemspec
+homepage: http://github.com/sunaku/redcarpet-manpage
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: UNIX man page renderer for Redcarpet2
+test_files: []