kramdown-asciidoc 1.0.0.alpha.12 → 1.0.0.alpha.13

data/lib/kramdown-asciidoc/core_ext/regexp/is_match.rb

@@ -1,3 +1,5 @@
-class Regexp
-  alias match? === unless method_defined? :match? # nocov
-end
+module Kramdown; module AsciiDoc; module CoreExt
+  refine Regexp do
+    alias match? === unless method_defined? :match? # nocov
+  end
+end; end; end

data/lib/kramdown-asciidoc/kramdown_ext/parser/base.rb

@@ -0,0 +1,7 @@
+class Kramdown::Parser::Base
+  # Overload parse to force value of :auto_ids option to false; handled by converter instead
+  def self.parse source, options
+    (parser = new source, (options.merge auto_ids: false, auto_id_stripping: false)).parse
+    [parser.root, parser.warnings]
+  end
+end

data/lib/kramdown-asciidoc/version.rb

@@ -1,3 +1,3 @@
 module Kramdown; module AsciiDoc
-  VERSION = '1.0.0.alpha.12'
+  VERSION = '1.0.0.alpha.13'
 end; end

data/lib/kramdown-asciidoc/writer.rb

@@ -2,11 +2,13 @@ module Kramdown; module AsciiDoc
   class Writer
     LF = ?\n
 
-    attr_reader :header
+    attr_accessor :doctitle
     attr_reader :body
 
     def initialize
-      @header = []
+      @prologue = []
+      @doctitle = nil
+      @attributes = {}
       @body = []
       @nesting_stack = []
       @block_delimiter = nil
@@ -14,29 +16,16 @@ module Kramdown; module AsciiDoc
       @list_level = { list: 0, dlist: 0 }
     end
 
-    def doctitle
-      if (doctitle_line = @header.find {|l| l.start_with? '= ' })
-        doctitle_line.slice 2, doctitle_line.length
-      end
-    end
-
-    def doctitle= new_doctitle
-      if (doctitle_idx = @header.index {|l| l.start_with? '= ' })
-        @header[doctitle_idx] = %(= #{new_doctitle})
-      else
-        @header.unshift %(= #{new_doctitle})
-      end
-      nil
+    def add_attributes new_attributes
+      @attributes.update new_attributes
     end
 
-    def add_attributes attributes
-      attributes.each {|k, v| add_attribute k, v }
-      nil
+    def add_prologue_line line
+      @prologue << line
     end
 
-    def add_attribute name, value
-      @header << %(:#{name}:#{value.empty? ? '' : ' ' + value.to_s})
-      nil
+    def add_prologue_lines lines
+      @prologue.push(*lines)
     end
 
     def start_block
@@ -125,7 +114,12 @@ module Kramdown; module AsciiDoc
     end
 
     def to_s
-      (@header.empty? ? @body : (@header + (@body.empty? ? [] : [''] + @body))).join LF
+      header = @prologue.dup
+      header << %(= #{@doctitle}) if @doctitle
+      @attributes.sort.each do |name, val|
+        header << (val.empty? ? %(:#{name}:) : %(:#{name}: #{val}))
+      end unless @attributes.empty?
+      (header.empty? ? @body : (header + (@body.empty? ? [] : [''] + @body))).join LF
     end
   end
 end; end

data/spec/api_spec.rb

@@ -76,6 +76,15 @@ describe Kramdown::AsciiDoc do
       end
     end
 
+    it 'does not mutate options argument' do
+      the_output_file = Pathname.new output_file 'convert-with-options.adoc'
+      opts = { encode: true, to: the_output_file, attributes: {} }
+      hash = opts.hash
+      (expect subject.convert '**File > Save**', opts).to be_nil
+      (expect the_output_file.read).to eql %(:experimental:\n\nmenu:File[Save]\n)
+      (expect opts.hash).to eql hash
+    end
+
     it 'adds line feed (EOL) to end of output document if non-empty' do
       (expect subject.convert 'paragraph').to end_with ?\n
     end
@@ -83,6 +92,32 @@ describe Kramdown::AsciiDoc do
     it 'does not add line feed (EOL) to end of output document if empty' do
       (expect subject.convert '').to be_empty
     end
+
+    it 'duplicates value of :attributes option' do
+      input = <<~EOS
+      # Document Title
+      
+      # Part 1
+      
+      ## Chapter A
+
+      so it begins
+      EOS
+
+      expected = <<~EOS
+      = Document Title
+      :doctype: book
+      
+      = Part 1
+      
+      == Chapter A
+
+      so it begins
+      EOS
+
+      (expect subject.convert input, attributes: (attributes = {})).to eql expected
+      (expect attributes).to be_empty
+    end
   end
 
   context '#convert_file' do
@@ -144,6 +179,41 @@ describe Kramdown::AsciiDoc do
       `#{ruby} -E ISO-8859-1:ISO-8859-1 #{Shellwords.escape script_file}`
       (expect IO.read the_output_file, mode: 'r:UTF-8').to eql %(#{source}\n)
     end
+
+    it 'does not mutate options argument' do
+      another_source_file = Pathname.new output_file 'convert-file-with-options.md'
+      another_source_file.write '**File > Save**'
+      the_output_file = Pathname.new output_file 'convert-file-with-options.adoc'
+      opts = { to: the_output_file, attributes: {} }
+      hash = opts.hash
+      (expect subject.convert_file another_source_file, opts).to be_nil
+      (expect the_output_file.read).to eql %(:experimental:\n\nmenu:File[Save]\n)
+      (expect opts.hash).to eql hash
+    end
+
+    it 'passes result through postprocess callback if given' do
+      the_output_file = output_file %(convert-file-api-#{object_id}.adoc)
+      postprocess = -> (asciidoc) { asciidoc.gsub 'become', 'become glorious' }
+      (expect subject.convert_file the_source_file, postprocess: postprocess).to be_nil
+      (expect Pathname.new the_output_file).to exist
+      (expect (IO.read the_output_file)).to eql %(Markdown was _here_, but it has become glorious *AsciiDoc*!\n)
+    end
+
+    it 'passes krawdown document to postprocess method if arity is not 1' do
+      the_output_file = output_file %(convert-file-api-#{object_id}.adoc)
+      postprocess = -> (asciidoc, kramdown_doc) { asciidoc.gsub 'Markdown', kramdown_doc.options[:input] }
+      (expect subject.convert_file the_source_file, postprocess: postprocess).to be_nil
+      (expect Pathname.new the_output_file).to exist
+      (expect (IO.read the_output_file)).to eql %(GFM was _here_, but it has become *AsciiDoc*!\n)
+    end
+
+    it 'uses original source if postprocess callback returns falsy' do
+      the_output_file = output_file %(convert-file-api-#{object_id}.adoc)
+      postprocess = -> (asciidoc) { nil }
+      (expect subject.convert_file the_source_file, postprocess: postprocess).to be_nil
+      (expect Pathname.new the_output_file).to exist
+      (expect (IO.read the_output_file)).to eql %(Markdown was _here_, but it has become *AsciiDoc*!\n)
+    end
   end
 end
 

data/spec/cli_spec.rb

@@ -206,21 +206,24 @@ describe Kramdown::AsciiDoc::Cli do
       (expect $stdout.string).to eql expected
     end
 
-    it 'automatically generates IDs for section titles when --auto-ids is used' do
-      the_source_file = scenario_file 'heading/auto-ids.md'
-      expected = IO.read scenario_file 'heading/auto-ids.adoc'
+    it 'auto generates IDs for section titles when --auto-ids is used' do
+      the_source_file = scenario_file 'heading/auto_ids/no-ids.md'
+      expected = IO.read scenario_file 'heading/auto_ids/no-ids.adoc'
       (expect subject.run %W(-o - --auto-ids #{the_source_file})).to eql 0
       (expect $stdout.string).to eql expected
     end
 
-    it 'adds prefix specified by --auto-id-prefix to any automatically generated section title ID' do
-      the_source_file = scenario_file 'heading/auto-ids.md'
+    it 'adds prefix specified by --auto-id-prefix to any auto-generated section title ID' do
+      the_source_file = scenario_file 'heading/auto_ids/explicit-id.md'
       expected = <<~EOS
       [#_heading-1]
       = Heading 1
 
+      [#_heading]
+      == Heading
+
       [#_heading-2]
-      == Heading 2
+      == Heading
 
       [#explicit-id]
       === Heading 3
@@ -232,6 +235,35 @@ describe Kramdown::AsciiDoc::Cli do
       (expect $stdout.string).to eql expected
     end
 
+    it 'uses separator specified by --auto-id-separator to any auto-generated section title ID' do
+      the_source_file = scenario_file 'heading/auto_ids/explicit-id.md'
+      expected = <<~EOS
+      [#_heading_1]
+      = Heading 1
+
+      [#_heading]
+      == Heading
+
+      [#_heading_2]
+      == Heading
+
+      [#explicit-id]
+      === Heading 3
+
+      [#_back_to_heading_2]
+      == Back to Heading 2
+      EOS
+      (expect subject.run %W(-o - --auto-id-prefix=_ --auto-id-separator=_ --auto-ids #{the_source_file})).to eql 0
+      (expect $stdout.string).to eql expected
+    end
+
+    it 'drops ID if matches auto-generated value when --lazy-ids is used' do
+      the_source_file = scenario_file 'heading/lazy_ids/explicit-ids.md'
+      expected = IO.read scenario_file 'heading/lazy_ids/explicit-ids.adoc'
+      (expect subject.run %W(-o - --lazy-ids #{the_source_file})).to eql 0
+      (expect $stdout.string).to eql expected
+    end
+
     it 'adds specified attributes to document header' do
       the_source_file = scenario_file 'root/header-and-body.md'
       (expect subject.run %W(-o - -a idprefix -a idseparator=- #{the_source_file})).to eql 0

data/spec/scenarios/attributes/sorting.adoc

@@ -0,0 +1,6 @@
+= Document Title
+:bar: bar
+:experimental:
+:foo: foo
+
+menu:Terminal[Quit]

data/spec/scenarios/attributes/sorting.md

@@ -0,0 +1,3 @@
+# Document Title
+
+**Terminal > Quit**

data/spec/scenarios/attributes/sorting.opts

@@ -0,0 +1,3 @@
+:attributes:
+  foo: 'foo'
+  bar: 'bar'

data/spec/scenarios/codeblock/dlist-like.adoc

@@ -0,0 +1,4 @@
+....
+filter :: *
+matched 10 results
+....

data/spec/scenarios/codeblock/dlist-like.md

@@ -0,0 +1,2 @@
+    filter :: *
+    matched 10 results

data/spec/scenarios/codeblock/list-like.adoc

@@ -0,0 +1,5 @@
+....
+* Connected to localhost (127.0.0.1) port 5252 (#0)
+> GET / HTTP/1.1
+> Host: localhost:5252
+....

data/spec/scenarios/codeblock/list-like.md

@@ -0,0 +1,3 @@
+    * Connected to localhost (127.0.0.1) port 5252 (#0)
+    > GET / HTTP/1.1
+    > Host: localhost:5252

data/spec/scenarios/heading/anchor-with-dot.adoc

@@ -0,0 +1,2 @@
+[id=a.b.and.c]
+== A, B, & C

data/spec/scenarios/heading/anchor-with-dot.md

@@ -0,0 +1 @@
+## <a id="a.b.and.c">A, B, & C</a>

data/spec/scenarios/heading/{auto-id-prefix.opts → auto_ids/auto-id-prefix.opts}

@@ -1,2 +1,2 @@
-:auto_id_prefix: id-
 :auto_ids: true
+:auto_id_prefix: id-

data/spec/scenarios/heading/auto_ids/character-reference.adoc

@@ -0,0 +1,8 @@
+[#use-for-copyright]
+== Use © for copyright
+
+[#when-to-use-in-tables]
+== When to use | in tables
+
+[#all-in]
+== *All In!*

data/spec/scenarios/heading/auto_ids/character-reference.md

@@ -0,0 +1,5 @@
+## Use © for copyright
+
+## When to use | in tables
+
+## **All In!**

data/spec/scenarios/heading/auto_ids/dot-separator.adoc

@@ -0,0 +1,2 @@
+[id=a.b.and.c]
+== A, B, and C

data/spec/scenarios/heading/auto_ids/dot-separator.md

@@ -0,0 +1 @@
+## A, B, and C

data/spec/scenarios/heading/auto_ids/dot-separator.opts

@@ -0,0 +1,2 @@
+:auto_ids: true
+:auto_id_separator: .

data/spec/scenarios/heading/{auto-ids.adoc → auto_ids/explicit-id.adoc}

@@ -1,8 +1,11 @@
 [#heading-1]
 = Heading 1
 
+[#heading]
+== Heading
+
 [#heading-2]
-== Heading 2
+== Heading
 
 [#explicit-id]
 === Heading 3

data/spec/scenarios/heading/{auto-ids.md → auto_ids/explicit-id.md}

@@ -1,6 +1,8 @@
 # Heading 1
 
-## Heading 2
+## Heading
+
+## Heading
 
 ### <a id="explicit-id"></a>Heading 3
 

data/spec/scenarios/heading/auto_ids/explicit-id.opts

@@ -0,0 +1 @@
+:auto_ids: true

data/spec/scenarios/heading/auto_ids/kramdown-input-character-reference.adoc

@@ -0,0 +1,8 @@
+[#use-for-copyright]
+== Use © for copyright
+
+[#when-to-use-in-tables]
+== When to use | in tables
+
+[#all-in]
+== *All In!*

data/spec/scenarios/heading/auto_ids/kramdown-input-character-reference.md

@@ -0,0 +1,5 @@
+## Use © for copyright
+
+## When to use | in tables
+
+## **All In!**

data/spec/scenarios/heading/auto_ids/kramdown-input-character-reference.opts

@@ -0,0 +1,2 @@
+:auto_ids: true
+:input: kramdown

data/spec/scenarios/heading/auto_ids/kramdown-input.adoc

@@ -0,0 +1,14 @@
+[#document-title]
+= Document Title
+
+[#heading]
+== Heading
+
+[#heading-2]
+== Heading
+
+[#explicit-id]
+=== Heading 3
+
+[#back-to-heading-2]
+== Back to Heading 2

data/spec/scenarios/heading/auto_ids/kramdown-input.md

@@ -0,0 +1,9 @@
+# Document Title
+
+## Heading
+
+## Heading
+
+### Heading 3 {#explicit-id}
+
+## Back to Heading 2

data/spec/scenarios/heading/auto_ids/kramdown-input.opts

@@ -0,0 +1,2 @@
+:auto_ids: true
+:input: kramdown

data/spec/scenarios/heading/auto_ids/no-ids.adoc

@@ -0,0 +1,14 @@
+[#heading-1]
+= Heading 1
+
+[#heading]
+== Heading
+
+[#heading-2]
+== Heading
+
+[#heading-3]
+=== Heading 3
+
+[#back-to-heading-2]
+== Back to Heading 2

data/spec/scenarios/heading/auto_ids/no-ids.md

@@ -0,0 +1,9 @@
+# Heading 1
+
+## Heading
+
+## Heading
+
+### Heading 3
+
+## Back to Heading 2

data/spec/scenarios/heading/auto_ids/no-ids.opts

@@ -0,0 +1 @@
+:auto_ids: true