asciidoctor-doctest 2.0.0.beta.2 → 2.0.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d85bdcda3e26954a6f4e42e9825d3a5e033db0c
-  data.tar.gz: 3a10413538b9524867318215b715205c096d99ab
+  metadata.gz: 22928854e2f234ef48e4ddf8180e8c0c94f82341
+  data.tar.gz: 8b0c16c9b9373c95245c2a559363e1caf0e06618
 SHA512:
-  metadata.gz: f3c70197f8139884fba053dfc57c69d2d30f318b06b4df04e246af603592df20e579156108671902341ff69f93b46882fc514c984e97c9137c29cc0b42a1a9ab
-  data.tar.gz: 8080e196a4b71d0aa87711368abaee6d7d2a2191d068d8dfc9567d71310146c2fcd92cf9649c34e981e41b29579b2dbd51f82fba8a9932c2f9ba860ce954e4e2
+  metadata.gz: d4d4ba60bd2919139cd2717d54696f967f423e0e6cdd2c264f5a7547c4bed6765a4c72f5c2efada82a7798fe3faf75cd650af08e6ad734805f055e091cad4724
+  data.tar.gz: 8634445f1342b9cfdc5b86485d9bbf9b8568dfd0b22f57932cb829bb62b54ee5d2e4c5e5227666e9f59435183d3ca787ee32f22a3b91e46a7b5aedc633b02171

data/README.adoc

@@ -100,7 +100,7 @@ bundle exec rake doctest:test
 To test only specific examples, use `PATTERN` with glob-like expression:
 
 [source, sh]
-bundle exec rake doctest:test PATTERN='block_*:*'
+bundle exec rake doctest:test PATTERN='inline_*:*'
 
 For verbose output, use `VERBOSE=yes`:
 
@@ -117,10 +117,10 @@ Example should consider one case of the generated output, i.e. it should reflect
 Examples are grouped in _example groups_.
 Each group focuses on one block or inline element — more precisely Asciidoctor’s AST node (paragraph, table, anchor, footnote…).
 
-Examples group is a text file named similar to Asciidoctor templates, i.e. the AST node name with an extension according to syntax, for example `block_table.adoc`, `block_table.html`. See below for a list of the AST nodes.
+Examples group is a text file named similar to Asciidoctor templates, i.e. the AST node name with an extension according to syntax, for example `table.adoc`, `table.html`. See below for a list of the AST nodes.
 Individual examples in the group file are separated by a special header with the name of the example, an optional description and options.
 
-Each example is identified by its name and the group name like this: `{group_name}:{example_name}` (e.g. `block_table:with_title`).
+Each example is identified by its name and the group name like this: `{group_name}:{example_name}` (e.g. `table:with-title`).
 Input and output examples are paired — for every input example there should be an output example with the same identifier.
 When you <<run-tests, run tests>>, the input example is converted using the tested backend (or templates) and its actual output is compared with the expected output example.
 
@@ -129,31 +129,31 @@ When you <<run-tests, run tests>>, the input example is converted using the test
 document:: TODO
 embedded:: TODO
 section:: {doctor-man-uri}/#sections[document sections], i.e. headings
-block_admonition:: {doctor-man-uri}/#admonition[an admonition block]
-block_audio:: {doctor-man-uri}/#audio[an audio block]
-block_colist:: {doctor-man-uri}/#callouts[a code callouts] list
-block_dlist:: {doctor-man-uri}/#labeled-list[a labeled list] (aka definition list) and {doctor-man-uri}/#question-and-answer-style-list[a Q&A style list]
-block_example:: {doctor-man-uri}/#example[an example block]
-block_floating_title:: {doctor-man-uri}/#discrete-or-floating-section-titles[a discrete or floating section title]
-block_image:: {doctor-man-uri}/#images[an image block]
-block_listing:: {doctor-man-uri}/#listing-blocks[a listing and source code block]
-block_literal:: {doctor-man-uri}/#literal-text-and-blocks[a literal block]
-block_olist:: {doctor-man-uri}/#ordered-lists[an ordered list] (i.e. numbered list)
-block_open:: {doctor-man-uri}/#open-blocks[open blocks], {doctor-man-uri}/#user-abstractabstract[abstract], …
-block_outline:: an actual {doctor-man-uri}/#user-toc[TOC] content (i.e. list of links), usually recursively called
-block_page_break:: {doctor-man-uri}/#page-break[page break]
-block_paragraph:: {doctor-man-uri}/#paragraph[a paragraph]
-block_pass:: {doctor-man-uri}/#pass-bl[a passthrough block]
-block_preamble:: {doctor-man-uri}/#doc-preamble[a preamble], optionally with a TOC
-block_quote:: {doctor-man-uri}/#quote[a quote block]
-block_sidebar:: {doctor-man-uri}/#sidebar[a sidebar]
-block_stem:: {doctor-man-uri}/#stem[a STEM block] (Science, Technology, Engineering and Math)
-block_table:: {doctor-man-uri}/#tables[a table]
-block_thematic_break:: {doctor-man-uri}/#horizontal-rules[a thematic break] (i.e. horizontal rule)
-block_toc:: {doctor-man-uri}/#manual-placement[a TOC macro] (i.e. manually placed TOC); This block is used for `toc::[]` macro only and it’s responsible just for rendering of a the TOC “envelope,” not an actual TOC content.
-block_ulist:: {doctor-man-uri}/#unordered-lists[an unordered list] (aka bullet list) and a {doctor-man-uri}/#checklist[checklist] (e.g. TODO list)
-block_verse:: {doctor-man-uri}/#verse[a verse block]
-block_video:: {doctor-man-uri}/#video[a video block]
+admonition:: {doctor-man-uri}/#admonition[an admonition block]
+audio:: {doctor-man-uri}/#audio[an audio block]
+colist:: {doctor-man-uri}/#callouts[a code callouts] list
+dlist:: {doctor-man-uri}/#labeled-list[a labeled list] (aka definition list) and {doctor-man-uri}/#question-and-answer-style-list[a Q&A style list]
+example:: {doctor-man-uri}/#example[an example block]
+floating_title:: {doctor-man-uri}/#discrete-or-floating-section-titles[a discrete or floating section title]
+image:: {doctor-man-uri}/#images[an image block]
+listing:: {doctor-man-uri}/#listing-blocks[a listing and source code block]
+literal:: {doctor-man-uri}/#literal-text-and-blocks[a literal block]
+olist:: {doctor-man-uri}/#ordered-lists[an ordered list] (i.e. numbered list)
+open:: {doctor-man-uri}/#open-blocks[open blocks], {doctor-man-uri}/#user-abstractabstract[abstract], …
+outline:: an actual {doctor-man-uri}/#user-toc[TOC] content (i.e. list of links), usually recursively called
+page_break:: {doctor-man-uri}/#page-break[page break]
+paragraph:: {doctor-man-uri}/#paragraph[a paragraph]
+pass:: {doctor-man-uri}/#pass-bl[a passthrough block]
+preamble:: {doctor-man-uri}/#doc-preamble[a preamble], optionally with a TOC
+quote:: {doctor-man-uri}/#quote[a quote block]
+sidebar:: {doctor-man-uri}/#sidebar[a sidebar]
+stem:: {doctor-man-uri}/#stem[a STEM block] (Science, Technology, Engineering and Math)
+table:: {doctor-man-uri}/#tables[a table]
+thematic_break:: {doctor-man-uri}/#horizontal-rules[a thematic break] (i.e. horizontal rule)
+toc:: {doctor-man-uri}/#manual-placement[a TOC macro] (i.e. manually placed TOC); This block is used for `toc::[]` macro only and it’s responsible just for rendering of a the TOC “envelope,” not an actual TOC content.
+ulist:: {doctor-man-uri}/#unordered-lists[an unordered list] (aka bullet list) and a {doctor-man-uri}/#checklist[checklist] (e.g. TODO list)
+verse:: {doctor-man-uri}/#verse[a verse block]
+video:: {doctor-man-uri}/#video[a video block]
 inline_anchor:: {doctor-man-uri}/#url[anchors] (links, cross references and bibliography references)
 inline_break:: {doctor-man-uri}/#line-breaks[line break]
 inline_button:: {doctor-man-uri}/#ui-buttons[UI button]
@@ -172,7 +172,7 @@ You can find them in link:data/examples/asciidoc[].footnote:[Since GitHub implic
 There are a lot of test examples and some of them may not be relevant to your backend — that’s okay, when some output example is not found, it’s marked as skipped in test.
 
 You can also write your own input examples and use them together with those provided (or replace them).
-Just add another directory to your examples_path (e.g. `test/examples/asciidoc`) and create example group files with `.adoc` suffix here (e.g. `block_video.adoc`).
+Just add another directory to your examples_path (e.g. `test/examples/asciidoc`) and create example group files with `.adoc` suffix here (e.g. `video.adoc`).
 When DocTest is looking for examples to test, it indexes all examples found in files with `.adoc` suffix on the examples_path.
 If there are two files with the same name, it simply merges their content, and if they contain two examples with the same name, then the first wins (i.e. that from the file that is ahead on the examples_path).
 
@@ -180,7 +180,7 @@ If there are two files with the same name, it simply merges their content, and i
 
 [source, asciidoc]
 ----
-// .first_example
+// .first-example
 // Each block must be preceded by a header (comment); the first line must
 // contain the example’s name prefixed with a dot. This text is interpreted
 // as a description.
@@ -188,7 +188,7 @@ The example’s content in *Asciidoc*.
 
 NOTE: The trailing new line (below this) will be removed.
 
-// .second_example
+// .second-example
 * List item level 1
 ** List item level 2
 
@@ -233,7 +233,7 @@ header_footer::
 
 [source, html]
 ----
-<!-- .first_example
+<!-- .first-example
   Each example must be preceded by a header (comment); the first line must
   contain the example’s name prefixed with a dot. This text is interpreted
   as a description.
@@ -242,7 +242,7 @@ header_footer::
 
 <div class="note">The trailing new line (below this) will be removed.</div>
 
-<!-- .second_example
+<!-- .second-example
   You may also specify options for comparing or Asciidoctor renderer. Option
   line starts with a semicolon, then comes the option name ended by a
   semicolon and after that the option’s value (may be omitted for boolean
@@ -282,15 +282,15 @@ Same as previous, but rewrite existing tested examples:
 [source, sh]
 bundle exec rake doctest:generate FORCE=yes
 
-Generate just examples for `block_ulist` node (i.e. all examples in `block_ulist.adoc` file(s) found on the examples_path) that doesn’t exist yet:
+Generate just examples for `ulist` node (i.e. all examples in `ulist.adoc` file(s) found on the examples_path) that doesn’t exist yet:
 
 [source, sh]
-bundle exec rake doctest:generate PATTERN='block_ulist:*'
+bundle exec rake doctest:generate PATTERN='ulist:*'
 
-(Re)generate examples which name starts with `basic` for all _block_ nodes (i.e. files that starts with `block_`):
+(Re)generate examples which name starts with `basic` for all _inline_ nodes (i.e. files that starts with `inline_`):
 
 [source, sh]
-bundle exec rake doctest:generate PATTERN='block_*:basic*' FORCE=yes
+bundle exec rake doctest:generate PATTERN='inline_*:basic*' FORCE=yes
 
 
 == How to extend it

data/data/examples/asciidoc/{block_admonition.adoc → admonition.adoc}

@@ -1,15 +1,15 @@
 // .note
 NOTE: This is a note.
 
-// .note_with_title
+// .note-with-title
 .Title of note
 NOTE: This is a note with title.
 
-// .note_with_id_and_role
+// .note-with-id-and-role
 [#note-1.yellow]
 NOTE: This is a note with id and role.
 
-// .note_block
+// .note-block
 [NOTE]
 ====
 This is a note with complex content.
@@ -20,15 +20,15 @@ This is a note with complex content.
 // .tip
 TIP: This is a tip.
 
-// .tip_with_title
+// .tip-with-title
 .Title of tip
 TIP: This is a tip with title.
 
-// .tip_with_id_and_role
+// .tip-with-id-and-role
 [#tip-1.blue]
 TIP: This is a tip with id and role.
 
-// .tip_block
+// .tip-block
 [TIP]
 ====
 This is a tip with complex content.
@@ -39,15 +39,15 @@ This is a tip with complex content.
 // .important
 IMPORTANT: This is an important notice.
 
-// .important_with_title
+// .important-with-title
 .Title of important notice
 IMPORTANT: This is an important notice with title.
 
-// .important_with_id_and_role
+// .important-with-id-and-role
 [#important-1.red]
 IMPORTANT: This is an important notice with id and role.
 
-// .important_block
+// .important-block
 [IMPORTANT]
 ====
 This is an important notice with complex content.
@@ -58,15 +58,15 @@ This is an important notice with complex content.
 // .caution
 CAUTION: This is a caution.
 
-// .caution_with_title
+// .caution-with-title
 .Title of caution
 CAUTION: This is a caution with title.
 
-// .caution_with_id_and_role
+// .caution-with-id-and-role
 [#caution-1.red]
 CAUTION: This is a caution with id and role.
 
-// .caution_block
+// .caution-block
 [CAUTION]
 ====
 This is a caution with complex content.
@@ -77,15 +77,15 @@ This is a caution with complex content.
 // .warning
 WARNING: This is a warning.
 
-// .warning_with_title
+// .warning-with-title
 .Title of warning
 WARNING: This is a warning with title.
 
-// .warning_with_id_and_role
+// .warning-with-id-and-role
 [#warning-1.red]
 WARNING: This is a warning with id and role.
 
-// .warning_block
+// .warning-block
 [WARNING]
 ====
 This is a warning with complex content.

data/data/examples/asciidoc/{block_audio.adoc → audio.adoc}

@@ -1,13 +1,13 @@
 // .basic
 audio::ocean_waves.mp3[]
 
-// .with_all_options
+// .with-all-options
 audio::ocean_waves.mp3[options="autoplay, nocontrols, loop"]
 
-// .with_title
+// .with-title
 .Waves!
 audio::ocean_waves.mp3[]
 
-// .with_id_and_role
+// .with-id-and-role
 [#ocean.wave]
 audio::ocean_waves.mp3[]

data/data/examples/asciidoc/{block_colist.adoc → colist.adoc}

@@ -13,7 +13,7 @@ end
 <2> URL mapping
 <3> Content for response
 
-// .with_title
+// .with-title
 // This example should assert only callouts list below the code listing.
 // For callouts inside the listing is responsible inline_callout.
 [source, ruby]
@@ -29,7 +29,7 @@ end
 <2> URL mapping
 <3> Content for response
 
-// .with_id_and_role
+// .with-id-and-role
 // This example should assert only callouts list below the code listing.
 // For callouts inside the listing is responsible inline_callout.
 [source, ruby]

data/data/examples/asciidoc/{block_dlist.adoc → dlist.adoc}

@@ -4,7 +4,7 @@ Asciidoc::
   A text document format for writing notes, documentation, articles, books,
   ebooks, slideshows, web pages, man pages and blogs.
 
-// .basic_block
+// .basic-block
 About::
 * An implementation of the AsciiDoc processor in Ruby.
 * Fast text processor and publishing toolchain.
@@ -15,14 +15,14 @@ from many other individuals in Asciidoctor’s awesome community.
 +
 AsciiDoc was started by Stuart Rackham.
 
-// .basic_missing_description
+// .basic-missing-description
 Definition without a description::
 
-// .basic_with_title
+// .basic-with-title
 .Asciidoctor
 License:: MIT
 
-// .basic_with_id_and_role
+// .basic-with-id-and-role
 [#licenses.open]
 License:: MIT
 
@@ -32,7 +32,7 @@ What is Asciidoctor?::
   An implementation of the AsciiDoc processor in Ruby.
 What is the answer to the Ultimate Question?:: 42
 
-// .qanda_block
+// .qanda-block
 [qanda]
 What is Asciidoctor?::
 * An implementation of the AsciiDoc processor in Ruby.
@@ -44,16 +44,16 @@ from many other individuals in Asciidoctor’s awesome community.
 +
 AsciiDoc was started by Stuart Rackham.
 
-// .qanda_missing_answer
+// .qanda-missing-answer
 [qanda]
 Who knows the answer?::
 
-// .qanda_with_title
+// .qanda-with-title
 [qanda]
 .The most important questions
 What is the answer to the Ultimate Question?:: 42
 
-// .qanda_with_id_and_role
+// .qanda-with-id-and-role
 [qanda, id=faq, role=galaxy]
 What is the answer to the Ultimate Question?:: 42
 
@@ -62,18 +62,18 @@ What is the answer to the Ultimate Question?:: 42
 Hard drive:: Permanent storage for operating system and/or user files.
 RAM:: Temporarily stores information the CPU uses during operation.
 
-// .horizontal_with_dimensions
+// .horizontal-with-dimensions
 [horizontal, labelwidth="20", itemwidth="50%"]
 Hard drive:: Permanent storage for operating system and/or user files.
 RAM:: Temporarily stores information the CPU uses during operation.
 
-// .horizontal_with_title
+// .horizontal-with-title
 [horizontal]
 .Computer terminology for noobs
 Hard drive:: Permanent storage for operating system and/or user files.
 RAM:: Temporarily stores information the CPU uses during operation.
 
-// .horizontal_with_id_and_role
+// .horizontal-with-id-and-role
 [horizontal, id=computer, role=terms]
 Hard drive:: Permanent storage for operating system and/or user files.
 RAM:: Temporarily stores information the CPU uses during operation.

data/data/examples/asciidoc/document.adoc

@@ -1,29 +1,29 @@
 // .title
 = The Dangerous and Thrilling Documentation Chronicles
 
-// .title_with_author
+// .title-with-author
 = The Dangerous and Thrilling Documentation Chronicles
 Kismet Rainbow Chameleon <kismet@asciidoctor.org>
 
-// .title_with_author_no_email
+// .title-with-author-no-email
 = The Dangerous and Thrilling Documentation Chronicles
 Kismet Rainbow Chameleon
 
-// .title_with_multiple_authors
+// .title-with-multiple-authors
 = The Dangerous and Thrilling Documentation Chronicles
 Kismet Rainbow Chameleon <kismet@asciidoctor.org>; Lazarus het_Draeke <lazarus@asciidoctor.org>
 
-// .title_with_revnumber
+// .title-with-revnumber
 = Document Title
 Kismet Chameleon
 v1.0
 
-// .title_with_revdate
+// .title-with-revdate
 = Document Title
 Kismet Chameleon
 v1.0, 2013-10-02
 
-// .title_with_revremark
+// .title-with-revremark
 = Document Title
 Kismet Chameleon
 v1.0, October 2, 2013: First incarnation
@@ -36,14 +36,14 @@ A bold statement.footnoteref:[disclaimer,Opinions are my own.]
 Another outrageous statement.footnoteref:[disclaimer]
 
 // .toc
-// Actual TOC content is rendered in block_outline, this template usually
-// renders just a "border".
+// Actual TOC content is rendered in the outline template, this template
+// usually renders just a "border".
 = Document Title
 :toc:
 
 == Cavern Glow
 
-// .toc_title
+// .toc-title
 = Document Title
 :toc:
 :toc-title: Table of Adventures

data/data/examples/asciidoc/{block_example.adoc → example.adoc}

@@ -4,7 +4,7 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
 incididunt ut labore et dolore magna aliqua.
 ====
 
-// .with_title
+// .with-title
 .Sample document
 ====
 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
@@ -13,7 +13,7 @@ incididunt ut labore et dolore magna aliqua.
 The document header is useful, but not required.
 ====
 
-// .with_id_and_role
+// .with-id-and-role
 [#lorem.ipsum]
 ====
 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor

data/data/examples/asciidoc/{block_floating_title.adoc → floating_title.adoc}

@@ -18,10 +18,10 @@
 [discrete]
 ====== Discrete Title Level 5
 
-// .with_custom_id
+// .with-custom-id
 [discrete, id=flying]
 == Discrete Title Level 1
 
-// .with_roles
+// .with-roles
 [discrete.flying.circus]
 === Discrete Title Level 2

data/data/examples/asciidoc/{block_image.adoc → image.adoc}

@@ -1,28 +1,28 @@
 // .basic
 image::sunset.jpg[]
 
-// .with_alt_text
+// .with-alt-text
 image::sunset.jpg[Shining sun]
 
-// .with_align
+// .with-align
 image::sunset.jpg[align="center"]
 
-// .with_float
+// .with-float
 image::sunset.jpg[float="right"]
 
-// .with_dimensions
+// .with-dimensions
 image::sunset.jpg[Shining sun, 300, 200]
 
-// .with_link
+// .with-link
 image::sunset.jpg[link="http://www.flickr.com/photos/javh/5448336655"]
 
-// .with_title
+// .with-title
 .A mountain sunset
 image::sunset.jpg[]
 
-// .with_id
+// .with-id
 [[img-sunset]]
 image::sunset.jpg[]
 
-// .with_roles
+// .with-roles
 image::sunset.jpg[role="right text-center"]