kramdown-man 0.1.3 → 0.1.4

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 0.1.4 / 2013-05-05
+
+* Improve detection of tagged paragraphs.
+* Support emitted a hanging paragraph (`.HP`) for command synopsis lines.
+* Strip leading whitespace from each line of emitted text.
+
 ### 0.1.3 / 2013-05-05
 
 * Initial release:

data/README.md

@@ -15,7 +15,7 @@ A [Kramdown][kramdown] convert for converting Markdown files into man pages.
 
 * Converts markdown to [roff]:
   * Supports codespans, emphasis and strong fonts.
-  * Supports normal and tagged paragraphs.
+  * Supports normal, hanging and tagged paragraphs.
   * Supports bullet lists.
   * Supports multi-paragraph list items and blockquotes.
   * Supports horizontal rules.
@@ -69,6 +69,10 @@ Define a `man` and file tasks which render all `*.md` files within the
 
 Normal paragraph.
 
+    `command` [`--foo`] *FILE*
+
+`command` [`--foo`] *FILE*
+
     `--tagged`
       Text here.
 

data/Rakefile

@@ -41,5 +41,5 @@ task :doc => :yard
 
 $LOAD_PATH.unshift(File.expand_path('lib'))
 
-require 'kramdown/man/tasks'
-Kramdown::Man::Tasks.new
+require 'kramdown/man/task'
+Kramdown::Man::Task.new

data/lib/kramdown/converter/man.rb

@@ -115,7 +115,7 @@ module Kramdown
       #   The roff output.
       #
       def convert_text(text)
-        escape(text.value)
+        escape(text.value.gsub(/^(  +|\t)/,''))
       end
 
       #
@@ -325,14 +325,19 @@ module Kramdown
         children = p.children
 
         if (children.length >= 2) &&
-           (children[0].type == :em   || children[0].type == :codespan) &&
-           (children[1].type == :text && children[1].value =~ /^(  |\t)/)
-          [
-            '.TP',
-            convert_element(children[0]),
-            convert_text(children[1]).lstrip,
-            convert_children(children[2..-1])
-          ].join("\n").rstrip
+           (children.first.type == :em || children.first.type == :codespan)
+          newline = children.find_index { |el|
+            el.type == :text && el.value.start_with?("\n")
+          }
+
+          if newline
+            first_line = convert_children(children[0...newline])
+            rest       = convert_children(children[newline..-1]).strip
+
+            ".TP\n#{first_line}\n#{rest}"
+          else
+            ".HP\n#{convert_children(children)}"
+          end
         else
           ".PP\n#{convert_children(children)}"
         end

data/lib/kramdown/man/version.rb

@@ -1,6 +1,6 @@
 module Kramdown
   module Man
     # kramdown-man version
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/man/kramdown-man.1

@@ -1,4 +1,4 @@
-.\" Generated by kramdown-man 0.1.0
+.\" Generated by kramdown-man 0.1.4
 .\" https://github.com/postmodern/kramdown-roff#readme
 .TH kramdown-man.1 "April 2013" kramdown-man "User Manuals"
 .LP
@@ -55,6 +55,13 @@ Normal paragraph.
 Normal paragraph.
 .LP
 .nf
+`command` [`\-\-foo`] *FILE*
+.fi
+.LP
+.HP
+\fB\fCcommand\fR [\fB\fC--foo\fR] \fIFILE\fP
+.LP
+.nf
 `\-\-tagged`
   Text here.
 .fi

data/man/kramdown-man.1.md

@@ -35,6 +35,10 @@ A [Kramdown][kramdown] convert for converting Markdown files into man pages.
 
 Normal paragraph.
 
+    `command` [`--foo`] *FILE*
+
+`command` [`--foo`] *FILE*
+
     `--tagged`
       Text here.
 

data/spec/kramdown/converter/man_spec.rb

@@ -77,6 +77,22 @@ Hello world.
     it "should convert text elements" do
       subject.convert_text(text).should == content
     end
+
+    context "when the text has two-space indentation" do
+      let(:content) { "Foo\n  bar\n  baz" }
+
+      it "should strip leading whitespace from each line" do
+        subject.convert_text(text).should == content.gsub("\n  ","\n")
+      end
+    end
+
+    context "when the text has tab indentation" do
+      let(:content) { "Foo\n\tbar\n\tbaz" }
+
+      it "should strip leading whitespace from each line" do
+        subject.convert_text(text).should == content.gsub("\n\t","\n")
+      end
+    end
   end
 
   describe "#convert_typographic_sym" do
@@ -368,23 +384,79 @@ Hello world.
       subject.convert_p(p).should == ".PP\n#{text}"
     end
 
-    context "when the second line is indented with two spaces" do
+    context "when the paragraph starts with a codespan element" do
       let(:option) { '--foo' }
       let(:text)   { 'Foo bar baz' }
-      let(:doc)    { Kramdown::Document.new("`#{option}`\n  #{text}") }
+      let(:doc)    { Kramdown::Document.new("`#{option}`\n\t#{text}") }
 
       it "should convert p elements into '.TP\\n\\fB\\fC--option\\fR\\ntext...'" do
         subject.convert_p(p).should == ".TP\n\\fB\\fC#{option}\\fR\n#{text}"
       end
+
+      context "when there is only one codespan element" do
+        let(:code) { 'code' }
+        let(:doc)  { Kramdown::Document.new("`#{code}`") }
+
+        it "should convert p elements into '.PP\\n\\fB\\fC...\\fR'" do
+          subject.convert_p(p).should == ".PP\n\\fB\\fC#{code}\\fR"
+        end
+      end
+
+      context "when there are more than one codespan element" do
+        let(:flag)   { '-f'    }
+        let(:option) { '--foo' }
+        let(:text)   { 'Foo bar baz' }
+        let(:doc)    { Kramdown::Document.new("`#{flag}`, `#{option}`\n\t#{text}") }
+
+        it "should convert p elements into '.TP\\n\\fB\\fC-o\\fR, \\fB\\fC--option\\fR\\ntext...'" do
+          subject.convert_p(p).should == ".TP\n\\fB\\fC#{flag}\\fR, \\fB\\fC#{option}\\fR\n#{text}"
+        end
+
+        context "when there is no newline" do
+          let(:doc) { Kramdown::Document.new("`#{flag}` `#{option}`") }
+
+          it "should convert the p element into a '.HP\\n...'" do
+            subject.convert_p(p).should == ".HP\n\\fB\\fC#{flag}\\fR \\fB\\fC#{option}\\fR"
+          end
+        end
+      end
     end
 
-    context "when the second line is indented with a tab" do
+    context "when the paragraph starts with a em element" do
       let(:option) { '--foo' }
       let(:text)   { 'Foo bar baz' }
-      let(:doc)    { Kramdown::Document.new("`#{option}`\n\t#{text}") }
+      let(:doc)    { Kramdown::Document.new("*#{option}*\n\t#{text}") }
 
       it "should convert p elements into '.TP\\n\\fB\\fC--option\\fR\\ntext...'" do
-        subject.convert_p(p).should == ".TP\n\\fB\\fC#{option}\\fR\n#{text}"
+        subject.convert_p(p).should == ".TP\n\\fI#{option}\\fP\n#{text}"
+      end
+
+      context "when there is only one em element" do
+        let(:text)   { 'foo' }
+        let(:doc)    { Kramdown::Document.new("*#{text}*") }
+
+        it "should convert p elements into '.PP\\n\\fB\\fC...\\fR'" do
+          subject.convert_p(p).should == ".PP\n\\fI#{text}\\fP"
+        end
+      end
+
+      context "when there are more than one em element" do
+        let(:flag)    { '-f'    }
+        let(:option)  { '--foo' }
+        let(:text)    { 'Foo bar baz' }
+        let(:doc)     { Kramdown::Document.new("*#{flag}*, *#{option}*\n\t#{text}") }
+
+        it "should convert p elements into '.TP\\n\\fI-o\\fP, \\fI--option\\fP\\ntext...'" do
+          subject.convert_p(p).should == ".TP\n\\fI\\#{flag}\\fP, \\fI#{option}\\fP\n#{text}"
+        end
+
+        context "when there is no newline" do
+          let(:doc) { Kramdown::Document.new("*#{flag}* *#{option}*") }
+
+          it "should convert the p element into a '.HP\\n...'" do
+            subject.convert_p(p).should == ".HP\n\\fI\\#{flag}\\fP \\fI#{option}\\fP"
+          end
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-man
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors: