kramdown-asciidoc 1.0.0.alpha.1

data/lib/kramdown-asciidoc/version.rb

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

data/spec/converter_spec.rb

@@ -0,0 +1,114 @@
+require_relative 'spec_helper'
+
+describe Kramdown::AsciiDoc::Converter do
+  let(:opts) { Kramdown::AsciiDoc::DEFAULT_PARSER_OPTS }
+  let(:doc) { Kramdown::Document.new input, opts }
+  let(:root) { doc.root }
+
+  context '#convert' do
+    let (:input) { %(# Document Title\n\nBody text.) }
+    it 'adds line feed (EOL) to end of output document' do
+      converter = described_class.send :new, root, {}
+      (expect converter.convert root).to end_with %(\n)
+      (expect doc.to_asciidoc).to end_with %(\n)
+    end
+  end
+
+  context '.replace_toc' do
+    it 'does not modify source if TOC directive not detected' do
+      input = <<~EOS
+      # Database Guide
+
+      ...
+      EOS
+
+      attributes = {}
+      (expect Kramdown::AsciiDoc.replace_toc input, attributes).to be input
+      (expect attributes).to be_empty
+    end
+
+    it 'replaces TOC directive with a toc block macro' do
+      input = <<~EOS
+      # Database Guide
+
+      This tutorial walks you through the steps to set up a database instance.
+
+      <!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 -->
+
+      - [Prerequisites](#prerequisites)
+      - [Create an Instance](#1-create-instance)
+      - [Create a User](#2-create-user)
+      	- [Create a user using the CLI](#create-user-using-cli)
+      	- [Create a user using the UI](#create-user-using-ui)
+      - [Insert Data](#3-insert-data)
+      - [Start Instance](#4-start-instance)
+
+      <!-- /TOC -->
+
+      ...
+      EOS
+
+      expected = <<~EOS
+      # Database Guide
+
+      This tutorial walks you through the steps to set up a database instance.
+
+      toc::[]
+
+      ...
+      EOS
+
+      attributes = {}
+      (expect Kramdown::AsciiDoc.replace_toc input, attributes).to eql expected
+      (expect attributes['toc']).to eql 'macro'
+    end
+  end
+
+  context '.extract_front_matter' do
+    it 'does not modify source if front matter not detected' do
+      input = <<~EOS
+      # Introduction
+
+      content
+
+      ---
+
+      more content
+      EOS
+
+      attributes = {}
+      (expect Kramdown::AsciiDoc.extract_front_matter input, attributes).to be input
+      (expect attributes).to be_empty
+    end
+
+    it 'extracts front matter and assigns entries to attributes' do
+      input = <<~EOS
+      ---
+      title: Introduction
+      description: An introduction to this amazing technology.
+      keywords: buzz, transformative
+      layout: default
+      ---
+
+      # Introduction
+
+      When using this technology, anything is possible.
+      EOS
+
+      expected = <<~EOS
+      # Introduction
+
+      When using this technology, anything is possible.
+      EOS
+
+      expected_attributes = {
+        'description' => 'An introduction to this amazing technology.',
+        'keywords' => 'buzz, transformative',
+      }
+
+      attributes = {}
+      (expect Kramdown::AsciiDoc.extract_front_matter input, attributes).to eql expected
+      (expect attributes).to eql expected_attributes
+    end
+  end
+end

data/spec/fixtures/a/bare-url.adoc

@@ -0,0 +1 @@
+Use https://ecosia.org to plant trees while you search the web.

data/spec/fixtures/a/bare-url.md

@@ -0,0 +1 @@
+Use https://ecosia.org to plant trees while you search the web.

data/spec/fixtures/a/interdoc-xref.adoc

@@ -0,0 +1 @@
+See xref:prerequisites.adoc[prerequisites] for details.

data/spec/fixtures/a/interdoc-xref.md

@@ -0,0 +1 @@
+See [prerequisites](prerequisites.md) for details.

data/spec/fixtures/a/internal.adoc

@@ -0,0 +1,5 @@
+Use <<comparison-operators,Comparison Operators>> to compare the result of two expressions.
+
+== Comparison Operators
+
+Comparison operators are used to compare values.

data/spec/fixtures/a/internal.md

@@ -0,0 +1,5 @@
+Use [Comparison Operators](#comparison-operators) to compare the result of two expressions.
+
+## Comparison Operators
+
+Comparison operators are used to compare values.

data/spec/fixtures/a/local.adoc

@@ -0,0 +1 @@
+Take a look at the link:release-notes.html[release notes] to find a list of what changed.

data/spec/fixtures/a/local.md

@@ -0,0 +1 @@
+Take a look at the [release notes](release-notes.html) to find a list of what changed.

data/spec/fixtures/a/url-matches-text.adoc

@@ -0,0 +1 @@
+Visit https://info.ecosia.org/what/ to learn about Ecosia's mission.

data/spec/fixtures/a/url-matches-text.md

@@ -0,0 +1 @@
+Visit [https://info.ecosia.org/what](https://info.ecosia.org/what/) to learn about Ecosia's mission.

data/spec/fixtures/a/url-with-text.adoc

@@ -0,0 +1 @@
+Use https://ecosia.org[Ecosia] to plant trees while you search the web.

data/spec/fixtures/a/url-with-text.md

@@ -0,0 +1 @@
+Use [Ecosia](https://ecosia.org) to plant trees while you search the web.

data/spec/fixtures/blockquote/basic.adoc

@@ -0,0 +1,3 @@
+____
+Something someone said.
+____

data/spec/fixtures/blockquote/basic.md

@@ -0,0 +1 @@
+> Something someone said.

data/spec/fixtures/blockquote/list.adoc

@@ -0,0 +1,5 @@
+____
+* Liberté
+* Égalité
+* Fraternité
+____

data/spec/fixtures/blockquote/list.md

@@ -0,0 +1,3 @@
+> - Liberté
+> - Égalité
+> - Fraternité

data/spec/fixtures/blockquote/multiple-lines.adoc

@@ -0,0 +1,5 @@
+____
+Roads?
+
+Where we're going, we don't need roads.
+____

data/spec/fixtures/blockquote/multiple-lines.md

@@ -0,0 +1,3 @@
+> Roads?
+>
+> Where we're going, we don't need roads.

data/spec/fixtures/blockquote/nested.adoc

@@ -0,0 +1,7 @@
+____
+______
+What's new?
+______
+
+I'm switching to AsciiDoc!
+____

data/spec/fixtures/blockquote/nested.md

@@ -0,0 +1,3 @@
+> > What's new?
+>
+> I'm switching to AsciiDoc!

data/spec/fixtures/blockquote/with-attribution.adoc

@@ -0,0 +1,5 @@
+[,James Baldwin]
+____
+Not everything that is faced can be changed.
+But nothing can be changed until it is faced.
+____

data/spec/fixtures/blockquote/with-attribution.md

@@ -0,0 +1,3 @@
+> Not everything that is faced can be changed.
+> But nothing can be changed until it is faced.
+> -- James Baldwin

data/spec/fixtures/br/tag-followed-by-newline.adoc

@@ -0,0 +1,3 @@
+break +
+your +
+_lines_

data/spec/fixtures/br/tag-followed-by-newline.md

@@ -0,0 +1,3 @@
+break<br>
+your<br>
+*lines*

data/spec/fixtures/br/tag-preceded-by-space.adoc

@@ -0,0 +1,3 @@
+break +
+your +
+_lines_

data/spec/fixtures/br/tag-preceded-by-space.md

@@ -0,0 +1 @@
+break <br/>your <br/>*lines*

data/spec/fixtures/br/tag.adoc

@@ -0,0 +1,3 @@
+break +
+your +
+_lines_

data/spec/fixtures/br/tag.md

@@ -0,0 +1 @@
+break<br>your<br>*lines*

data/spec/fixtures/br/trailing-double-space.adoc

@@ -0,0 +1,3 @@
+break +
+your +
+_lines_

data/spec/fixtures/br/trailing-double-space.md

@@ -0,0 +1,3 @@
+break  
+your  
+*lines*

data/spec/fixtures/codeblock/contiguous-lines.adoc

@@ -0,0 +1,5 @@
+----
+baseImage: server
+version: 5.0.1
+paused: false
+----

data/spec/fixtures/codeblock/contiguous-lines.md

@@ -0,0 +1,3 @@
+    baseImage: server
+    version: 5.0.1
+    paused: false

data/spec/fixtures/codeblock/fenced/bash-to-console.adoc

@@ -0,0 +1,4 @@
+[source,console]
+----
+$ docker -it --run node:8-alpine
+----

data/spec/fixtures/codeblock/fenced/bash-to-console.md

@@ -0,0 +1,3 @@
+```bash
+$ docker -it --run node:8-alpine
+```

data/spec/fixtures/codeblock/fenced/with-command-prompt.adoc

@@ -0,0 +1 @@
+ $ docker -it --run node:8-alpine

data/spec/fixtures/codeblock/fenced/with-command-prompt.md

@@ -0,0 +1,3 @@
+```
+$ docker -it --run node:8-alpine
+```

data/spec/fixtures/codeblock/fenced/with-language.adoc

@@ -0,0 +1,8 @@
+[source,java]
+----
+public class AllYourCode {
+  public String getBelongsTo() {
+    return "Us!";
+  }
+}
+----

data/spec/fixtures/codeblock/fenced/with-language.md

@@ -0,0 +1,7 @@
+```java
+public class AllYourCode {
+  public String getBelongsTo() {
+    return "Us!";
+  }
+}
+```

data/spec/fixtures/codeblock/fenced/with-non-contiguous-command-prompts.adoc

@@ -0,0 +1,5 @@
+....
+$ cd project
+
+$ docker build
+....

data/spec/fixtures/codeblock/fenced/with-non-contiguous-command-prompts.md

@@ -0,0 +1,5 @@
+```
+$ cd project
+
+$ docker build
+```

data/spec/fixtures/codeblock/fenced/without-language.adoc

@@ -0,0 +1,5 @@
+----
+All your code.
+
+Belong to us.
+----

data/spec/fixtures/codeblock/fenced/without-language.md

@@ -0,0 +1,5 @@
+```
+All your code.
+
+Belong to us.
+```

data/spec/fixtures/codeblock/non-contiguous-lines.adoc

@@ -0,0 +1,7 @@
+----
+SelectBlock        ::= SelectClause
+                       ( FromClause )?
+                       ( WhereClause )?
+
+SelectClause       ::= <SELECT> ( <ALL> | <DISTINCT> )? ( SelectRegular | SelectValue )
+----

data/spec/fixtures/codeblock/non-contiguous-lines.md

@@ -0,0 +1,5 @@
+    SelectBlock        ::= SelectClause
+                           ( FromClause )?
+                           ( WhereClause )?
+
+    SelectClause       ::= <SELECT> ( <ALL> | <DISTINCT> )? ( SelectRegular | SelectValue )

data/spec/fixtures/codeblock/with-command-prompt.adoc

@@ -0,0 +1 @@
+ $ docker -it --run node:8-alpine

data/spec/fixtures/codeblock/with-command-prompt.md

@@ -0,0 +1 @@
+    $ docker -it --run node:8-alpine

data/spec/fixtures/codeblock/with-non-contiguous-command-prompts.adoc

@@ -0,0 +1,5 @@
+....
+$ cd project
+
+$ docker build
+....

data/spec/fixtures/codeblock/with-non-contiguous-command-prompts.md

@@ -0,0 +1,3 @@
+    $ cd project
+
+    $ docker build

data/spec/fixtures/codespan/constrained.adoc

@@ -0,0 +1 @@
+A boolean value can be `true` or `false`.

data/spec/fixtures/codespan/constrained.md

@@ -0,0 +1 @@
+A boolean value can be `true` or `false`.

data/spec/fixtures/codespan/literal.adoc

@@ -0,0 +1,3 @@
+Use the `+<=+` operator to define a version that is less than or equal to a specific version.
+
+Use `+(start...end)+` to create a range from start to end that excludes the last element.

data/spec/fixtures/codespan/literal.md

@@ -0,0 +1,3 @@
+Use the `<=` operator to define a version that is less than or equal to a specific version.
+
+Use `(start...end)` to create a range from start to end that excludes the last element.

data/spec/fixtures/em/asterisks.adoc

@@ -0,0 +1 @@
+This is known as a _*composite type*_.

data/spec/fixtures/em/asterisks.md

@@ -0,0 +1 @@
+This is known as a _*composite type*_.

data/spec/fixtures/em/constrained.adoc

@@ -0,0 +1 @@
+This is so _easy_.

data/spec/fixtures/em/constrained.md

@@ -0,0 +1 @@
+This is so *easy*.

data/spec/fixtures/entity/numeric.adoc

@@ -0,0 +1 @@
+1 + 1 = 2

data/spec/fixtures/entity/numeric.md

@@ -0,0 +1 @@
+1 + 1 = 2

data/spec/fixtures/entity/reverse.adoc

@@ -0,0 +1 @@
+<undefined>

data/spec/fixtures/entity/reverse.md

@@ -0,0 +1 @@
+<undefined>

data/spec/fixtures/heading/out-of-sequence.adoc

@@ -0,0 +1,23 @@
+= User Guide
+
+[discrete]
+=== DISCLAIMER
+
+This is not a section.
+
+[discrete]
+=== Before we get started
+
+Also not a section.
+
+== Let's get going
+
+Now we're talking.
+
+=== Installation
+
+Do this stuff.
+
+== Next steps
+
+Now we're getting to the good stuff.

data/spec/fixtures/heading/out-of-sequence.md

@@ -0,0 +1,21 @@
+# User Guide
+
+### DISCLAIMER
+
+This is not a section.
+
+### Before we get started
+
+Also not a section.
+
+## Let's get going
+
+Now we're talking.
+
+### Installation
+
+Do this stuff.
+
+## Next steps
+
+Now we're getting to the good stuff.