kramdown-asciidoc 1.0.0.alpha.9 → 1.0.0.alpha.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7666c4f1e1efbdee6e39c2506ecec46b77df092366ca3762af7a00d5c926c7c0
-  data.tar.gz: ee1c0de6b84814b1eff1d1c655d2099df112890d36ba11c60ac5bd4e00ae453b
+  metadata.gz: 8c9eaf28d5d26d6a4fe664121fa5d19507c9144644711cca82e348330428a1b2
+  data.tar.gz: d4a0b308bb683012ccc1ed75a54aeeb8f6ceefcf6fbabd54ce4728b34f728895
 SHA512:
-  metadata.gz: 692a6a4801eaaca673ed8b590544929eeaa76425b5c87859fd9c4819e9cf96f3f8bea606bcbe3f72e19251a498497822dd13d81de6f6de8edc89e72056c460a4
-  data.tar.gz: 5b382ae595d9c4f68d76a1bcd6f8749836b7f5d064ce0963cc1478b31d12fa413c88fbecff2a91c0af8fb15d1c609eaf6b6edc49f69b72d2f3d90fa787c727a3
+  metadata.gz: c2b4579e6829ae8b230ac72d9fb5f8e9880c4c40ad037784f695e916cfbd4b83353e44a8b507bd4c92baa1b3805d389420dc12944be0f283c3a30969e5444b50
+  data.tar.gz: 8a73cc65511611f3f5aa541818314bd938e5b0be9aa0f8585e3f2883065fafee1c1d96018c5a552ca6936f73ffa6ec36d67b68e7a9316a305d1ac7f6bba62ab5

data/CHANGELOG.adoc

@@ -5,6 +5,24 @@
 This document provides a high-level view of the changes to {project-name} by release.
 For a detailed view of what has changed, refer to the {uri-repo}/commits/master[commit history] on GitHub.
 
+== 1.0.0.alpha.10 (2018-07-16) - @mojavelinux
+
+=== Added
+
+* add --auto-id-prefix CLI option to set the prefix added to all auto-generated section title IDs (#26)
+* add :auto_links API option and --no-auto-links CLI option to control whether bare URLs are converted into links
+
+=== Changed
+
+* escape codespan text using passthrough if it contains a URL
+* add blank line after list item that contains a table
+* reset list level inside delimited block (e.g., quote block)
+* move list level handling into writer
+
+=== Fixed
+
+* insert blank line above list continuation to attach to parent list item (#27)
+
 == 1.0.0.alpha.9 (2018-07-10) - @mojavelinux
 
 === Changed

data/README.adoc

@@ -1,6 +1,6 @@
 = {project-name} (Markdown to AsciiDoc)
 Dan Allen <https://github.com/mojavelinux>
-v1.0.0.alpha.9, 2018-07-10
+v1.0.0.alpha.10, 2018-07-16
 // Aliases:
 :project-name: Kramdown AsciiDoc
 :project-handle: kramdown-asciidoc
@@ -85,6 +85,12 @@ To see all the options the `kramdoc` command accepts, pass the `-h` option to th
 
  $ kramdoc -h
 
+For example, you can inject attributes (key/value pairs) into the header of the AsciiDoc output document using the `-a` option.
+
+ $ kramdoc -a product-name="ACME Cloud" -a hide-uri-scheme sample.md
+
+Another use for attributes is setting the shared images directory, which is coverd in the next section.
+
 == Configure shared images directory
 
 If the images in the source document share a common directory prefix, such as [.path]_images/_, you can configure the converter to extract that prefix, optionally promoting it to the document header.

data/lib/kramdown-asciidoc/cli.rb

@@ -49,10 +49,18 @@ module Kramdown; module AsciiDoc
           options[:html_to_native] = html_to_native
         end
 
-        opts.on '--auto-ids', 'Set whether to auto-generate IDs for section titles' do |auto_ids|
+        opts.on '--auto-ids', 'Set whether to auto-generate IDs for all section titles' do |auto_ids|
           options[:auto_ids] = auto_ids
         end
 
+        opts.on '--auto-id-prefix=STRING', 'Set the prefix to add to auto-generated section title IDs' do |string|
+          options[:auto_id_prefix] = string
+        end
+
+        opts.on '--[no-]auto-links', 'Set whether to automatically convert bare URLs into links (default: true)' do |auto_links|
+          options[:auto_links] = auto_links
+        end
+
         opts.on '-h', '--help', 'Display this help text and exit' do
           $stdout.puts opts.help
           return 0

data/lib/kramdown-asciidoc/converter.rb

@@ -49,7 +49,7 @@ module Kramdown; module AsciiDoc
     ADMON_MARKERS_ASCIIDOC = %w(NOTE TIP CAUTION WARNING IMPORTANT).map {|l| %(#{l}: ) }
     ADMON_FORMATTED_MARKERS = ADMON_LABELS.map {|l, _| [%(#{l}:), l] }.to_h
     ADMON_TYPE_MAP = ADMON_LABELS.map {|l, _| [l, l.upcase] }.to_h.merge 'Attention' => 'IMPORTANT', 'Hint' => 'TIP'
-    BLOCK_TYPES = [:p, :blockquote, :codeblock]
+    BLOCK_TYPES = [:p, :blockquote, :codeblock, :table]
     DLIST_MARKERS = %w(:: ;; ::: ::::)
     # FIXME here we reverse the smart quotes; add option to allow them (needs to be handled carefully)
     SMART_QUOTE_ENTITY_TO_MARKUP = { ldquo: ?", rdquo: ?", lsquo: ?', rsquo: ?' }
@@ -86,10 +86,11 @@ module Kramdown; module AsciiDoc
     FullStopRx = /(?<=.\.)\p{Blank}+(?!\Z)/
     InadvertentReplacementsRx = /[-=]>|<[-=]|\.\.\.|\{\p{Word}[\p{Word}-]*\}/
     MenuRefRx = /^([\p{Word}&].*?)\s>\s([\p{Word}&].*(?:\s>\s|$))+/
-    ReplaceableTextRx = /[-=]>|<[-=]| -- |\p{Word}--\p{Word}|\*\*|\.\.\.|&\S+;|\{\p{Word}[\p{Word}-]*\}|\((?:C|R|TM)\)/
+    ReplaceableTextRx = /[-=]>|<[-=]| -- |\p{Word}--\p{Word}|\*\*|\.\.\.|&\S+;|\{\p{Word}[\p{Word}-]*\}|(?:https?|ftp):\/\/\p{Word}|\((?:C|R|TM)\)/
     SmartApostropheRx = /\b’\b/
     TrailingSpaceRx = / +$/
     TypographicSymbolRx = /[“”‘’—–…]/
+    UriSchemeRx = /(?:https?|ftp):\/\/\p{Word}/
     WordishRx = /[\p{Word};:<>&]/
     WordRx = /\p{Word}/
     XmlCommentRx = /\A<!--(.*)-->\Z/m
@@ -102,10 +103,11 @@ module Kramdown; module AsciiDoc
     def initialize root, opts
       super
       @attributes = opts[:attributes] || {}
-      @imagesdir = opts[:imagesdir] || @attributes['imagesdir']
+      @auto_links = opts.fetch :auto_links, true
       @heading_offset = opts[:heading_offset] || 0
-      @current_heading_level = nil
+      @imagesdir = opts[:imagesdir] || @attributes['imagesdir']
       @wrap = opts[:wrap] || :preserve
+      @current_heading_level = nil
     end
 
     def convert el, opts = {}
@@ -291,12 +293,11 @@ module Kramdown; module AsciiDoc
     end
 
     def convert_ul el, opts
-      (writer = opts[:writer]).start_list (parent = opts[:parent]).type != :dd && !parent.options[:compound]
-      level_opt = el.type == :dl ? :dlist_level : :list_level
-      opts[level_opt] = (opts[level_opt] || 0) + 1
+      kin = el.type == :dl ? :dlist : :list
+      (writer = opts[:writer]).start_list (parent = opts[:parent]).type == :dd || parent.options[:compound], kin
       traverse el, opts
-      opts.delete level_opt if (opts[level_opt] -= 1) < 1
-      writer.end_list
+      writer.end_list kin
+      writer.add_blank_line if writer.in_list? && opts[:next]
     end
 
     alias convert_ol convert_ul
@@ -306,7 +307,7 @@ module Kramdown; module AsciiDoc
       writer = opts[:writer]
       writer.add_blank_line if (prev = opts[:prev]) && prev.options[:compound]
       marker = opts[:parent].type == :ol ? '.' : '*'
-      indent = (level = opts[:list_level]) - 1
+      indent = (level = writer.list_level) - 1
       if (children = el.children)[0].type == :p
         primary, remaining = [(children = children.dup).shift, children]
         primary_lines = compose_text [primary], parent: el, strip: true, split: true, wrap: @wrap
@@ -324,12 +325,13 @@ module Kramdown; module AsciiDoc
     end
 
     def convert_dt el, opts
+      writer = opts[:writer]
       # NOTE kramdown removes newlines from term
       term = compose_text el, strip: true
-      marker = DLIST_MARKERS[opts[:dlist_level] - 1]
-      #opts[:writer].add_blank_line if (prev = opts[:prev]) && prev.options[:compound]
-      opts[:writer].add_blank_line if opts[:prev]
-      opts[:writer].add_line %(#{term}#{marker})
+      marker = DLIST_MARKERS[(writer.list_level :dlist) - 1]
+      #writer.add_blank_line if (prev = opts[:prev]) && prev.options[:compound]
+      writer.add_blank_line if opts[:prev]
+      writer.add_line %(#{term}#{marker})
     end
 
     def convert_dd el, opts
@@ -457,12 +459,12 @@ module Kramdown; module AsciiDoc
     end
 
     def prev_char_wordish? prev_el
-      prev_el && (prev_el.type == :entity || ((prev_ch = prev_el.type == :text && prev_el.value[-1]) && (WordishRx.match? prev_ch)))
+      prev_el && (prev_el.type == :entity || (prev_el.type == :text && (WordishRx.match? prev_el.value[-1])))
     end
 
     def next_char_word? next_el, enclosure
       if next_el.type == :text
-        (next_ch = next_el.value.chr) && ((WordRx.match? next_ch) || (enclosure == :codespan && next_ch == ?'))
+        (WordRx.match? (next_ch = next_el.value.chr)) || (enclosure == :codespan && next_ch == ?')
       elsif enclosure == :codespan && next_el.type == :smart_quote
         true
       end if next_el
@@ -484,6 +486,7 @@ module Kramdown; module AsciiDoc
     def escape_replacements text
       # NOTE the replacement \\\\\& inserts a single backslash in front of the matched text
       text = text.gsub InadvertentReplacementsRx, '\\\\\&' if InadvertentReplacementsRx.match? text
+      text = text.gsub UriSchemeRx, '\\\\\&' if !@auto_links && (text.include? '://')
       text = text.gsub '^', '{caret}' if (text.include? '^') && text != '^'
       unless text.ascii_only?
         text = (text.gsub SmartApostropheRx, ?').gsub TypographicSymbolRx, TYPOGRAPHIC_SYMBOL_TO_MARKUP

data/lib/kramdown-asciidoc/version.rb

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

data/lib/kramdown-asciidoc/writer.rb

@@ -10,7 +10,8 @@ module Kramdown; module AsciiDoc
       @body = []
       @nesting_stack = []
       @block_delimiter = nil
-      @block_separator = []
+      @block_separator = ['']
+      @list_level = { list: 0, dlist: 0 }
     end
 
     def doctitle
@@ -39,37 +40,48 @@ module Kramdown; module AsciiDoc
     end
 
     def start_block
-      @body << (@block_separator.last || '') unless empty?
+      @body << @block_separator[-1] unless empty?
       nil
     end
 
-    # Q: perhaps in_list that takes a block?
-    # Q: should we keep stack of list depth?
-    def start_list compound
-      @body << '' unless (compound && @block_separator.last == '+') || empty?
-      @block_separator << '+'
+    def start_delimited_block delimiter
+      @body << (@block_delimiter = delimiter.length == 1 ? delimiter * 4 : delimiter)
+      @nesting_stack << [(@body.pop @body.length), @block_delimiter, @block_separator, @list_level]
+      @block_separator = ['']
+      @list_level = { list: 0, dlist: 0 }
       nil
     end
 
-    def end_list
-      @block_separator.pop
+    def end_delimited_block
+      parent_body, @block_delimiter, @block_separator, @list_level = @nesting_stack.pop
+      @body = (parent_body + @body) << @block_delimiter
+      @block_delimiter = nil
       nil
     end
 
-    def start_delimited_block delimiter
-      @body << (@block_delimiter = delimiter.length == 1 ? delimiter * 4 : delimiter)
-      @nesting_stack << [(@body.pop @body.length), @block_delimiter, @block_separator]
-      @block_separator = []
+    # Q: perhaps do_in_list that takes a block?
+    def start_list compound, kin = :list
+      # Q: can this be further optimized?
+      @body << '' if in_list? ? compound : !empty?
+      @block_separator << '+'
+      @list_level[kin] += 1
       nil
     end
 
-    def end_delimited_block
-      parent_body, @block_delimiter, @block_separator = @nesting_stack.pop
-      @body = (parent_body + @body) << @block_delimiter
-      @block_delimiter = nil
+    def end_list kin = :list
+      @block_separator.pop
+      @list_level[kin] -= 1
       nil
     end
 
+    def list_level kin = :list
+      @list_level[kin]
+    end
+
+    def in_list?
+      @block_separator[-1] == '+'
+    end
+
     def add_blank_line
       @body << ''
       nil

data/spec/cli_spec.rb

@@ -174,6 +174,20 @@ describe Kramdown::AsciiDoc::Cli do
       (expect $stdout.string).to eql expected
     end
 
+    it 'does not escape bare URLs when --auto-links is used' do
+      the_source_file = scenario_file 'a/bare-url.md'
+      expected = IO.read scenario_file 'a/bare-url.adoc'
+      (expect subject.run %W(-o - --auto-links #{the_source_file})).to eql 0
+      (expect $stdout.string).to eql expected
+    end
+
+    it 'escapes bare URLs when --no-auto-links is used' do
+      the_source_file = scenario_file 'a/no-auto-links.md'
+      expected = IO.read scenario_file 'a/no-auto-links.adoc'
+      (expect subject.run %W(-o - --no-auto-links #{the_source_file})).to eql 0
+      (expect $stdout.string).to eql expected
+    end
+
     it 'shifts headings by offset when --heading-offset is used' do
       the_source_file = scenario_file 'heading/offset.md'
       expected = IO.read scenario_file 'heading/offset.adoc'
@@ -188,6 +202,25 @@ describe Kramdown::AsciiDoc::Cli do
       (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'
+      expected = <<~EOS
+      [#_heading-1]
+      = Heading 1
+
+      [#_heading-2]
+      == Heading 2
+
+      [#_heading-3]
+      === Heading 3
+
+      [#_back-to-heading-2]
+      == Back to Heading 2
+      EOS
+      (expect subject.run %W(-o - --auto-id-prefix=_ --auto-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/a/no-auto-links.adoc

@@ -0,0 +1,3 @@
+Search the web using \https://ecosia.org
+
+A URL begins with https://, though you'll still find sites using http://.

data/spec/scenarios/a/no-auto-links.md

@@ -0,0 +1,3 @@
+Search the web using https://ecosia.org
+
+A URL begins with https://, though you'll still find sites using http://.

data/spec/scenarios/a/no-auto-links.opts

@@ -0,0 +1 @@
+:auto_links: false

data/spec/scenarios/codespan/literal.adoc

@@ -11,3 +11,5 @@ In AsciiDoc, `+{name}+` is the syntax for an attribute reference.
 `pass:c[{lang}++]` is simply better than `+{lang}+`.
 
 Type `+©+` or `+(C)+` to enter a copyright symbol.
+
+The admin console is available at `+http://localhost:8080+` or `http://[::1]:8080` (IPv6).

data/spec/scenarios/codespan/literal.md

@@ -11,3 +11,5 @@ In AsciiDoc, `{name}` is the syntax for an attribute reference.
 `{lang}++` is simply better than `{lang}`.
 
 Type `©` or `(C)` to enter a copyright symbol.
+
+The admin console is available at `http://localhost:8080` or `http://[::1]:8080` (IPv6).

data/spec/scenarios/dl/nested-bookended.adoc

@@ -0,0 +1,8 @@
+simple rule::
+
+* A = always
+* B = be
+* C = charging
+
++
+Follow it faithfully.

data/spec/scenarios/dl/nested-bookended.md

@@ -0,0 +1,6 @@
+simple rule
+: * A = always
+  * B = be
+  * C = charging
+  
+  Follow it faithfully.

data/spec/scenarios/strong/unconstrained.adoc

@@ -3,5 +3,6 @@
 **U**pdate.
 **D**elete.
 Also known as *CRUD*.
+*CRUD*--the essential database operations.
 Not to be confused with E**CRU**, which is a color.
 ®**CRUD** it is not.

data/spec/scenarios/strong/unconstrained.md

@@ -3,5 +3,6 @@
 **U**pdate.
 **D**elete.
 Also known as **CRUD**.
+**CRUD**--the essential database operations.
 Not to be confused with E**CRU**, which is a color.
 ®**CRUD** it is not.

data/spec/scenarios/ul/compound-nested.adoc

@@ -3,6 +3,8 @@
 attached paragraph
 
  ** nested list item
++
+deep paragraph
 
 * another list item
 +

data/spec/scenarios/ul/compound-nested.md

@@ -3,6 +3,8 @@
   attached paragraph
 
   * nested list item
+
+    deep paragraph
 * another list item
 
   > attached blockquote

data/spec/scenarios/ul/compound-separated.adoc

@@ -19,6 +19,18 @@ This is equivalent to the following command:
 
  $ git init project
 
+* Create boilerplate files
++
+|===
+| Filename | Purpose
+
+| README.adoc
+| Introduces the project
+
+| .gitignore
+| Ignores non-versioned files
+|===
+
 * Create source files
 +
 We can't help you here.

data/spec/scenarios/ul/compound-separated.md

@@ -17,6 +17,13 @@
 
       $ git init project
 
+* Create boilerplate files
+
+  | Filename    | Purpose                     |
+  | ----------- | --------------------------- |
+  | README.adoc | Introduces the project      |
+  | .gitignore  | Ignores non-versioned files |
+
 * Create source files
 
   We can't help you here.

data/spec/scenarios/ul/compound.adoc

@@ -19,6 +19,18 @@ This is equivalent to the following command:
 
  $ git init project
 
+* Create boilerplate files
++
+|===
+| Filename | Purpose
+
+| README.adoc
+| Introduces the project
+
+| .gitignore
+| Ignores non-versioned files
+|===
+
 * Create source files
 +
 We can't help you here.

data/spec/scenarios/ul/compound.md

@@ -12,6 +12,12 @@
   This is equivalent to the following command:
 
       $ git init project
+* Create boilerplate files
+
+  | Filename    | Purpose                     |
+  | ----------- | --------------------------- |
+  | README.adoc | Introduces the project      |
+  | .gitignore  | Ignores non-versioned files |
 * Create source files
 
   We can't help you here.

data/spec/scenarios/ul/inside-delimited-block.adoc

@@ -0,0 +1,9 @@
+* Follow these rules:
++
+____
+* Work hard
+* Play hard
+* Drink beer
+____
+
+* Profit!

data/spec/scenarios/ul/inside-delimited-block.md

@@ -0,0 +1,7 @@
+* Follow these rules:
+
+  > * Work hard
+  > * Play hard
+  > * Drink beer
+
+* Profit!

data/spec/scenarios/ul/nested-bookended.adoc

@@ -0,0 +1,7 @@
+* One simple rule:
+ ** A = always
+ ** B = be
+ ** C = charging
+
++
+Follow it faithfully.

data/spec/scenarios/ul/nested-bookended.md

@@ -0,0 +1,7 @@
+* One simple rule:
+
+  * A = always
+  * B = be
+  * C = charging
+  
+  Follow it faithfully.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-asciidoc
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.9
+  version: 1.0.0.alpha.10
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-10 00:00:00.000000000 Z
+date: 2018-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -104,6 +104,9 @@ files:
 - spec/scenarios/a/internal.md
 - spec/scenarios/a/local.adoc
 - spec/scenarios/a/local.md
+- spec/scenarios/a/no-auto-links.adoc
+- spec/scenarios/a/no-auto-links.md
+- spec/scenarios/a/no-auto-links.opts
 - spec/scenarios/a/url-matches-text.adoc
 - spec/scenarios/a/url-matches-text.md
 - spec/scenarios/a/url-with-text.adoc
@@ -168,6 +171,8 @@ files:
 - spec/scenarios/dl/compound.md
 - spec/scenarios/dl/empty-dd.adoc
 - spec/scenarios/dl/empty-dd.md
+- spec/scenarios/dl/nested-bookended.adoc
+- spec/scenarios/dl/nested-bookended.md
 - spec/scenarios/dl/nested-mixed.adoc
 - spec/scenarios/dl/nested-mixed.md
 - spec/scenarios/dl/nested.adoc
@@ -384,6 +389,10 @@ files:
 - spec/scenarios/ul/compound.md
 - spec/scenarios/ul/formatted.adoc
 - spec/scenarios/ul/formatted.md
+- spec/scenarios/ul/inside-delimited-block.adoc
+- spec/scenarios/ul/inside-delimited-block.md
+- spec/scenarios/ul/nested-bookended.adoc
+- spec/scenarios/ul/nested-bookended.md
 - spec/scenarios/ul/nested-separated.adoc
 - spec/scenarios/ul/nested-separated.md
 - spec/scenarios/ul/nested.adoc
@@ -475,6 +484,9 @@ test_files:
 - spec/scenarios/a/internal.md
 - spec/scenarios/a/local.adoc
 - spec/scenarios/a/local.md
+- spec/scenarios/a/no-auto-links.adoc
+- spec/scenarios/a/no-auto-links.md
+- spec/scenarios/a/no-auto-links.opts
 - spec/scenarios/a/url-matches-text.adoc
 - spec/scenarios/a/url-matches-text.md
 - spec/scenarios/a/url-with-text.adoc
@@ -539,6 +551,8 @@ test_files:
 - spec/scenarios/dl/compound.md
 - spec/scenarios/dl/empty-dd.adoc
 - spec/scenarios/dl/empty-dd.md
+- spec/scenarios/dl/nested-bookended.adoc
+- spec/scenarios/dl/nested-bookended.md
 - spec/scenarios/dl/nested-mixed.adoc
 - spec/scenarios/dl/nested-mixed.md
 - spec/scenarios/dl/nested.adoc
@@ -755,6 +769,10 @@ test_files:
 - spec/scenarios/ul/compound.md
 - spec/scenarios/ul/formatted.adoc
 - spec/scenarios/ul/formatted.md
+- spec/scenarios/ul/inside-delimited-block.adoc
+- spec/scenarios/ul/inside-delimited-block.md
+- spec/scenarios/ul/nested-bookended.adoc
+- spec/scenarios/ul/nested-bookended.md
 - spec/scenarios/ul/nested-separated.adoc
 - spec/scenarios/ul/nested-separated.md
 - spec/scenarios/ul/nested.adoc