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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec24e69c7ff58e4b915b286679f62ff3b02bdc993efe5951b2289ef117e05305
-  data.tar.gz: c6d2872af018a5ed5efb201fd29d87d89c164502897223f61c0eebabe18faebe
+  metadata.gz: 7666c4f1e1efbdee6e39c2506ecec46b77df092366ca3762af7a00d5c926c7c0
+  data.tar.gz: ee1c0de6b84814b1eff1d1c655d2099df112890d36ba11c60ac5bd4e00ae453b
 SHA512:
-  metadata.gz: d0d0e0bd0fd69bb4f9134784e5bea5d1192a918273d41469bc650bf02d82dc68867f0fae6ddce3fcae434af92bc098b9f0a7d1529c40866c949e5122963de652
-  data.tar.gz: 8d1415772fbe71e934d254e43c067c8573220c1ebaeb0b4f2cca69e4c68e88643b50c6464fbff441c0d955d0f713e80312948a0be19d863ec3a40bf2a19302f4
+  metadata.gz: 692a6a4801eaaca673ed8b590544929eeaa76425b5c87859fd9c4819e9cf96f3f8bea606bcbe3f72e19251a498497822dd13d81de6f6de8edc89e72056c460a4
+  data.tar.gz: 5b382ae595d9c4f68d76a1bcd6f8749836b7f5d064ce0963cc1478b31d12fa413c88fbecff2a91c0af8fb15d1c609eaf6b6edc49f69b72d2f3d90fa787c727a3

data/CHANGELOG.adoc

@@ -5,6 +5,15 @@
 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.9 (2018-07-10) - @mojavelinux
+
+=== Changed
+
+* escape codespan using pass macro if text contains double plus
+* add specialcharacters replacement to inline pass macro
+* don't add newline after period at start of line when producing ventilated prose
+* use :imagesdir API option or --imagesdir CLI option to set implicit imagesdir instead of attribute
+
 == 1.0.0.alpha.8 (2018-07-03) - @mojavelinux
 
 === Added

data/README.adoc

@@ -1,6 +1,6 @@
 = {project-name} (Markdown to AsciiDoc)
 Dan Allen <https://github.com/mojavelinux>
-v1.0.0.alpha.8, 2018-07-03
+v1.0.0.alpha.9, 2018-07-10
 // Aliases:
 :project-name: Kramdown AsciiDoc
 :project-handle: kramdown-asciidoc
@@ -85,6 +85,48 @@ To see all the options the `kramdoc` command accepts, pass the `-h` option to th
 
  $ kramdoc -h
 
+== 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.
+
+Let's assume you want to convert the following Markdown source:
+
+[source,markdown]
+----
+# Document Title
+
+![Octocat](images/octocat.png)
+----
+
+You can extract the [.path]_images/_ prefix from the image reference and promote this value to the header of the output document by setting the `imagesdir` attribute:
+
+ $ kramdoc -a imagesdir=images sample.md
+
+Setting this attribute will produce the following document:
+
+[source,asciidoc]
+----
+= Document Title
+:imagesdir: images
+
+image::octocat.png[Octocat]
+----
+
+If you want the [.path]_images/_ prefix to be removed altogether and not added to the document header (i.e., an implied prefix), set the `--imagesdir` option instead:
+
+ $ kramdoc --imagesdir=images sample.md
+
+Setting this option will produce the following document:
+
+[source,asciidoc]
+----
+= Document Title
+
+image::octocat.png[Octocat]
+----
+
+In this scenario, you may need to pass the `imagesdir` attribute to the AsciiDoc processor when converting the output document so the image is resolved, depending on where the image is stored.
+
 == Development
 
 To help develop {project-name}, or to simply test-drive the development version, you need to retrieve the source from GitHub.

data/lib/kramdown-asciidoc/cli.rb

@@ -20,7 +20,7 @@ module Kramdown; module AsciiDoc
         EOS
 
         opts.on '-o FILE', '--output=FILE', 'Set the output filename or stream' do |file|
-          options[:output] = file
+          options[:output_file] = file
         end
 
         opts.on '--format=GFM|kramdown|markdown', %w(kramdown markdown GFM), 'Set the flavor of Markdown to parse (default: GFM)' do |format|
@@ -33,11 +33,15 @@ module Kramdown; module AsciiDoc
           options[:attributes][key] = val
         end
 
-        opts.on '--wrap=preserve|none|ventilate', %w(none preserve ventilate), 'Set how lines are wrapped in the AsciiDoc document (default: preserve)' do |wrap|
-          options[:wrap] = wrap.to_sym
+        opts.on '--wrap=preserve|none|ventilate', [:none, :preserve, :ventilate], 'Set how lines are wrapped in the AsciiDoc document (default: preserve)' do |wrap|
+          options[:wrap] = wrap
         end
 
-        opts.on '--heading-offset=NUMBER', 'Shift the heading level by the specified number', ::Integer do |offset|
+        opts.on '--imagesdir=DIR', 'Set the leading directory to remove from image references' do |dir|
+          options[:imagesdir] = dir
+        end
+
+        opts.on '--heading-offset=NUMBER', ::Integer, 'Shift the heading level by the specified number' do |offset|
           options[:heading_offset] = offset
         end
 
@@ -69,7 +73,7 @@ module Kramdown; module AsciiDoc
       end
 
       if args.size == 1
-        options[:source] = args[0]
+        options[:input_file] = args[0]
         [0, options]
       else
         opt_parser.warn %(extra arguments detected (unparsed arguments: #{(args.drop 1).join ' '}))
@@ -85,22 +89,31 @@ module Kramdown; module AsciiDoc
     def self.run args = ARGV
       code, options = new.parse args
       return code unless code == 0 && options
-      if (source_file = options.delete :source) == '-'
+      if (input_file = options.delete :input_file) == '-'
+        pipe_in = true
         markdown = $stdin.read.rstrip
       else
-        markdown = (::IO.read source_file, mode: 'r:UTF-8', newline: :universal).rstrip
+        markdown = (::IO.read input_file, mode: 'r:UTF-8', newline: :universal).rstrip
       end
-      if (output_file = options.delete :output)
-        (Pathname output_file).dirname.mkpath
+      if (output_file = options.delete :output_file)
+        if output_file == '-'
+          pipe_out = true
+        else
+          (::Pathname.new output_file).dirname.mkpath
+        end
       else
-        output_file = ((Pathname source_file).sub_ext '.adoc').to_s
+        output_file = ((::Pathname.new input_file).sub_ext '.adoc').to_s
+      end
+      if !(pipe_in || pipe_out) && (::File.absolute_path input_file) == (::File.absolute_path output_file)
+        $stderr.puts %(kramdoc: input and output file cannot be the same: #{input_file})
+        return 1
       end
       markdown = markdown.slice 1, markdown.length while markdown.start_with? ?\n
       attributes = options[:attributes]
       markdown = ::Kramdown::AsciiDoc.extract_front_matter markdown, attributes
       markdown = ::Kramdown::AsciiDoc.replace_toc markdown, attributes
       doc = ::Kramdown::Document.new markdown, (::Kramdown::AsciiDoc::DEFAULT_PARSER_OPTS.merge options)
-      if output_file == '-'
+      if pipe_out
         $stdout.puts doc.to_asciidoc
       else
         ::IO.write output_file, doc.to_asciidoc

data/lib/kramdown-asciidoc/converter.rb

@@ -81,10 +81,10 @@ module Kramdown; module AsciiDoc
 
     NON_DEFAULT_TABLE_ALIGNMENTS = [:center, :right]
 
-    AccidentalReplacementsRx = /[-=]>|<[-=]|\.\.\.|\{\p{Word}[\p{Word}-]*\}/
     CommentPrefixRx = /^ *! ?/m
     CssPropDelimRx = /\s*;\s*/
-    FullStopRx = /(?<=\.)\p{Blank}+(?!\Z)/
+    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)\)/
     SmartApostropheRx = /\b’\b/
@@ -102,7 +102,7 @@ module Kramdown; module AsciiDoc
     def initialize root, opts
       super
       @attributes = opts[:attributes] || {}
-      @imagesdir = (@attributes.delete 'implicit-imagesdir') || @attributes['imagesdir']
+      @imagesdir = opts[:imagesdir] || @attributes['imagesdir']
       @heading_offset = opts[:heading_offset] || 0
       @current_heading_level = nil
       @wrap = opts[:wrap] || :preserve
@@ -426,18 +426,11 @@ module Kramdown; module AsciiDoc
       mark = (unconstrained? opts[:prev], opts[:next], :codespan) ? '``' : '`'
       text = el.value
       pass = (replaceable? text) ? :shorthand : nil
-      if text.include? '++'
-        if pass
-          pass = :macro
-        else
-          @attributes['pp'] = '{plus}{plus}'
-          text = text.gsub '++', '{pp}'
-        end
-      end
+      pass = :macro if text.include? '++'
       if pass == :shorthand
         opts[:writer].append %(#{mark}+#{text}+#{mark})
       elsif pass == :macro
-        opts[:writer].append %(#{mark}pass:[#{text}]#{mark})
+        opts[:writer].append %(#{mark}pass:c[#{text}]#{mark})
       else
         opts[:writer].append %(#{mark}#{text}#{mark})
       end
@@ -489,7 +482,8 @@ module Kramdown; module AsciiDoc
     end
 
     def escape_replacements text
-      text = text.gsub AccidentalReplacementsRx, '\\\\\0' if AccidentalReplacementsRx.match? 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 '^', '{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.8'
+  VERSION = '1.0.0.alpha.9'
 end; end

data/spec/cli_spec.rb

@@ -69,6 +69,23 @@ describe Kramdown::AsciiDoc::Cli do
       (expect (IO.read the_output_file).chomp).to eql 'Everything is going to be fine.'
     end
 
+    it 'prevents computed output file from overwriting input file' do
+      the_source_file = output_file 'implicit-conflict.adoc'
+      IO.write the_source_file, 'No can do.'
+      expected = %(kramdoc: input and output file cannot be the same: #{the_source_file})
+      (expect subject.run %W(#{the_source_file})).to eql 1
+      (expect $stderr.string.chomp).to eql expected
+    end
+
+    it 'prevents explicit output file from overwriting input file' do
+      the_source_file = output_file 'explicit-conflict.md'
+      the_output_file = the_source_file
+      IO.write the_source_file, 'No can do.'
+      expected = %(kramdoc: input and output file cannot be the same: #{the_source_file})
+      (expect subject.run %W(-o #{the_output_file} #{the_source_file})).to eql 1
+      (expect $stderr.string.chomp).to eql expected
+    end
+
     it 'writes output to stdout when -o option equals -' do
       the_source_file = scenario_file 'p/single-line.md'
       (expect subject.run %W(-o - #{the_source_file})).to eql 0
@@ -100,6 +117,13 @@ describe Kramdown::AsciiDoc::Cli do
       (expect $stdout.string.chomp).to eql %(= Heading\n\nBody content.)
     end
 
+    it 'converts all newlines to line feed characters' do
+      the_source_file = output_file 'newlines.md'
+      IO.write the_source_file, %(\r\n\r\n# Document Title\r\n\r\nFirst paragraph.\r\n\r\nSecond paragraph.\r\n)
+      (expect subject.run %W(-o - #{the_source_file})).to eql 0
+      (expect $stdout.string.chomp).to eql %(= Document Title\n\nFirst paragraph.\n\nSecond paragraph.)
+    end
+
     it 'processes front matter in source' do
       the_source_file = output_file 'front-matter.md'
       IO.write the_source_file, <<~EOS
@@ -136,6 +160,13 @@ describe Kramdown::AsciiDoc::Cli do
       (expect $stdout.string.chomp).to eql '= Heading'
     end
 
+    it 'removes directory prefix from image references specified by the --imagesdir option' do
+      the_source_file = scenario_file 'img/implicit-imagesdir.md'
+      expected = IO.read scenario_file 'img/implicit-imagesdir.adoc'
+      (expect subject.run %W(-o - --imagesdir=images #{the_source_file})).to eql 0
+      (expect $stdout.string).to eql expected
+    end
+
     it 'wraps output as specified by the --wrap option' do
       the_source_file = scenario_file 'wrap/ventilate.md'
       expected = IO.read scenario_file 'wrap/ventilate.adoc'

data/spec/scenarios/codespan/literal.adoc

@@ -8,6 +8,6 @@ Use an `+<!-- XML comment -->+` to disable or hide markup.
 
 In AsciiDoc, `+{name}+` is the syntax for an attribute reference.
 
-`pass:[{lang}++]` is simply better than `+{lang}+`.
+`pass:c[{lang}++]` is simply better than `+{lang}+`.
 
 Type `+&copy;+` or `+(C)+` to enter a copyright symbol.

data/spec/scenarios/codespan/plus-plus.adoc

@@ -1,3 +1 @@
-:pp: {plus}{plus}
-
-`C{pp}` is hard. `C{pp}` is fast.
+`pass:c[C++]` is a programming language. The name comes from the `pass:c[++]` operator, which increments the value of a variable by one.

data/spec/scenarios/codespan/plus-plus.md

@@ -1 +1 @@
-`C++` is hard. `C++` is fast.
+`C++` is a programming language. The name comes from the `++` operator, which increments the value of a variable by one.

data/spec/scenarios/img/implicit-imagesdir.opts

@@ -1,2 +1 @@
-:attributes:
-  implicit-imagesdir: images
+:imagesdir: images

data/spec/scenarios/text/typographic_sym/apostrophe.adoc

@@ -1 +1,3 @@
 That's all folks!
+
+This is the Killers`' third album.

data/spec/scenarios/text/typographic_sym/apostrophe.md

@@ -1 +1,3 @@
 That’s all folks!
+
+This is the Killers’ third album.

data/spec/scenarios/wrap/ventilate-table-cell.adoc

@@ -3,4 +3,7 @@
 | Turn left.
 Then turn right.
 | left \| right
+
+| Operator
+| . (period)
 |===

data/spec/scenarios/wrap/ventilate-table-cell.md

@@ -1,2 +1,3 @@
 | --------------------------- | ------------- |
 | Turn left. Then turn right. | left \| right |
+| Operator                    | . (period)    |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-asciidoc
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.8
+  version: 1.0.0.alpha.9
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-03 00:00:00.000000000 Z
+date: 2018-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown