asciidoctor-doctest 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc9498892db6acc24257809bff779818ee7472f4
-  data.tar.gz: a8a13d69add1fe26c44d6bb14c5931e521f73aff
+  metadata.gz: 479daec9ac0dc0ec44479eb7675e59a7bc17889d
+  data.tar.gz: ee45df8e137d9e67c1e042f132b4c729bd3c021d
 SHA512:
-  metadata.gz: 3afb3a87af3908787ca1a3b6e450217ee6e38e4b3fd7d454c2547d60197b3f657b2b5efe024e1fb4317dd77660df9421896905806df9829ea125e3393a51f607
-  data.tar.gz: ffa8177c85f0437636060d786b2174cb4dbb42624b17b45cfa4b81c38fc8bd030f35ae36bb9fc3e6918efc7efda4ed0aed336277cb718fcb54582629da797556
+  metadata.gz: 6e5edb9b2d8b24065e3546422d93be5632ae76295cefad0d60b502ced846bad0e5144974e4e4f64dc35832ef08c5b222a2b7e78204424d4c73a645c98a40c3be
+  data.tar.gz: d76d62985066c12587a7233d2546a5c923aa97a4578eb5e3895c930aa986a00ad5bcbf0f6b1c5f7addf75310f2a4ff6fddcb245572dca26e61a0c9d178a0e75d

data/CHANGELOG.adoc

@@ -0,0 +1,32 @@
+= Asciidoctor::DocTest Changelog
+:repo-uri: https://github.com/asciidoctor/asciidoctor-doctest
+:commit-uri: {repo-uri}/commit
+:issue-uri: {repo-uri}/issues
+
+This document provides a high-level view of the changes introduced in DocTest by release.
+For a detailed view of what has changed, refer to the {repo-uri}/commits/master[commit history] on GitHub.
+
+
+== 1.5.1 (2014-12-29)
+
+Improvements::
+  * Rename parameter `renderer_opts` to `converter_opts` and method `render` to `convert` to be consistent with Asciidoctor (old names are aliased for now). {issue-uri}/2[#2] [{commit-uri}/97c06af[97c06af]]
+  * Rename `to_s` to `content_pretty` in BaseExample and make alias. [{commit-uri}/3b610e2[3b610e2]]
+
+Bug fixes::
+  * Allow to modify default `examples_path` in GeneratorTask (was frozen). [{commit-uri}/7251e6c[7251e6c]]
+  * Fix `template_dirs` validation and default `backend_name` in AsciidocRenderer. [{commit-uri}/2a4413d[2a4413d]]
+  * Beautify generated HTML examples. [{commit-uri}/e9d42be[e9d42be]]
+  * Fix Generator to not lose description of the updated example. [{commit-uri}/0d2f4ee[0d2f4ee]]
+
+Tests::
+  * Add end-to-end integration tests using Cucumber.
+  * Increase (unit) test coverage from 84.2% to 88.5%.
+
+Known issues::
+  * HTML beautifier doesn’t work as expected. {issue-uri}/3[#3]
+
+
+== 1.5.0 (2014-12-09)
+
+The first stable release.

data/README.adoc

@@ -6,23 +6,28 @@ ifdef::env-github[:idprefix: user-content-]
 :idseparator: -
 :source-language: ruby
 :language: {source-language}
-// links
+// custom
+:gem-name: asciidoctor-doctest
+:gh-name: asciidoctor/{gem-name}
+:gh-branch: master
+:badge-style: flat
 :doctor-man-uri: http://asciidoctor.org/docs/user-manual
+:rawgit-base: https://cdn.rawgit.com/{gh-name}/master
 :src-base: lib/asciidoctor/doctest
 
-image:https://travis-ci.org/asciidoctor/asciidoctor-doctest.svg?branch=master[Build Status, link=https://travis-ci.org/asciidoctor/asciidoctor-doctest]
-image:https://codeclimate.com/github/asciidoctor/asciidoctor-doctest/badges/coverage.svg[Test Coverage, link="https://codeclimate.com/github/asciidoctor/asciidoctor-doctest"]
-image:https://codeclimate.com/github/asciidoctor/asciidoctor-doctest/badges/gpa.svg[Code Climate, link="https://codeclimate.com/github/asciidoctor/asciidoctor-doctest"]
-image:http://inch-ci.org/github/asciidoctor/asciidoctor-doctest.svg?branch=master[Inline docs, link="http://inch-ci.org/github/asciidoctor/asciidoctor-doctest"]
-image:https://badge.fury.io/rb/asciidoctor-doctest.svg[Gem Version, link="http://badge.fury.io/rb/asciidoctor-doctest"]
-image:https://img.shields.io/badge/yard-docs-blue.svg[Yard Docs, link="http://www.rubydoc.info/github/asciidoctor/asciidoctor-doctest/frames"]
+image:https://img.shields.io/travis/{gh-name}/{gh-branch}.svg?style={badge-style}[Build Status, link="https://travis-ci.org/{gh-name}"]
+image:https://img.shields.io/codeclimate/coverage/github/{gh-name}.svg?style={badge-style}[Test Coverage, link="https://codeclimate.com/github/{gh-name}"]
+image:https://img.shields.io/codeclimate/github/{gh-name}.svg?style={badge-style}[Code Climate, link="https://codeclimate.com/github/{gh-name}"]
+image:https://inch-ci.org/github/{gh-name}.svg?branch={gh-branch}&style={badge-style}[Inline docs, link="http://inch-ci.org/github/{gh-name}"]
+image:https://img.shields.io/gem/v/{gem-name}.svg?style={badge-style}[Gem Version, link="https://rubygems.org/gems/{gem-name}"]
+image:https://img.shields.io/badge/yard-docs-blue.svg?style={badge-style}[Yard Docs, link="http://www.rubydoc.info/github/{gh-name}/frames"]
 
 DocTest is a tool for end-to-end testing of Asciidoctor _backends_ based on comparing of textual output.
 
 It provides a collection of categorized <<input-examples, input _examples_>> (documents in AsciiDoc syntax) to simplify and systematize writing tests for new backends.
 You just write or <<generate-examples, generate>> the expected output, i.e. what the backend should produce for the given input.
 
-image::https://cdn.rawgit.com/asciidoctor/asciidoctor-doctest/master/doc/img/doctest-diag.svg[diagram, align="center"]
+image::{rawgit-base}/doc/img/doctest-diag.svg[diagram, align="center"]
 
 Each example should be focused on one use case, so when writing a new backend, you can incrementally implement new features following the reference input examples.
 However, they are not strictly isolated like unit tests.
@@ -80,14 +85,14 @@ DocTest.examples_path.unshift 'test/examples/asciidoc'
 DocTest.examples_path.unshift 'test/examples/shiny'
 ----
 
-. Create test file `test/templates_test.rb` and extend class link:{src-base}/test.rb[DocTest::Test]. Specify `renderer_opts` and then call `generate_tests!` macro with a specific subclass of `BaseExamplesSuite`:
+. Create test file `test/templates_test.rb` and extend class link:{src-base}/test.rb[DocTest::Test]. Specify `converter_opts` and then call `generate_tests!` macro with a specific subclass of `BaseExamplesSuite`:
 +
 [source]
 ----
 require 'test_helper'
 
 class TestTemplates < DocTest::Test
-  renderer_opts template_dirs: 'data/templates'
+  converter_opts template_dirs: 'data/templates'
   generate_tests! DocTest::HTML::ExamplesSuite
 end
 ----
@@ -109,7 +114,7 @@ end
 
 DocTest::GeneratorTask.new(:generate) do |task|
   task.output_suite = DocTest::HTML::ExamplesSuite.new(examples_path: 'test/examples/shiny')
-  task.renderer_opts[:template_dirs] = 'data/templates'
+  task.converter_opts[:template_dirs] = 'data/templates'
   #
   # add extra input examples (optional)
   task.examples_path.unshift 'test/examples/asciidoc'
@@ -223,7 +228,7 @@ If it’s not your case, then you must overwrite it:
 [source]
 ----
 class TestShiny < DocTest::Test
-  renderer_opts template_dirs: 'data/templates'
+  converter_opts template_dirs: 'data/templates'
   generate_tests! DocTest::HTML::ExamplesSuite.new(paragraph_xpath: './div/p/node()')
 end
 ----

data/Rakefile

@@ -1,12 +1,37 @@
+require 'rake/clean'
 require 'bundler/gem_tasks'
 
+default_tasks = []
+
 begin
   require 'rspec/core/rake_task'
 
   RSpec::Core::RakeTask.new(:spec)
 
   task :test => :spec
-  task :default => :spec
-rescue LoadError
-  warn 'no rspec available'
+  default_tasks << :spec
+rescue LoadError => e
+  warn "#{e.path} is not available"
+end
+
+begin
+  require 'cucumber/rake/task'
+
+  Cucumber::Rake::Task.new do |t|
+    t.cucumber_opts = ['-r features/support', '--format pretty']
+  end
+
+  default_tasks << :cucumber
+rescue LoadError => e
+  warn "#{e.path} is not available"
 end
+
+begin
+  require 'yard'
+  # options are defined in .yardopts
+  YARD::Rake::YardocTask.new(:yard)
+rescue LoadError => e
+  warn "#{e.path} is not available"
+end
+
+task :default => default_tasks

data/features/README

@@ -0,0 +1 @@
+This directory contains end-to-end integration tests (not acceptance tests).

data/features/fixtures/html-slim/Rakefile

@@ -0,0 +1,15 @@
+require 'asciidoctor/doctest'
+require 'rake/testtask'
+require 'tilt'
+
+DocTest::GeneratorTask.new(:generate) do |task|
+  task.output_suite = DocTest::HTML::ExamplesSuite.new(examples_path: 'examples/html')
+  task.examples_path = 'examples/asciidoc'
+  task.converter_opts[:template_dirs] = 'templates'
+end
+
+Rake::TestTask.new(:test) do |task|
+  task.description = 'Run tests for custom HTML backend'
+  task.pattern = 'test/html_test.rb'
+  task.libs << 'test'
+end

data/features/fixtures/html-slim/examples/asciidoc/block_quote.adoc

@@ -0,0 +1,12 @@
+// .with_id_and_role
+[quote, id="parking", role="startrek"]
+Everybody remember where we parked.
+
+// .with_title
+.After landing the cloaked Klingon bird of prey in Golden Gate park:
+[quote]
+Everybody remember where we parked.
+
+// .with_attribution
+[quote, Albert Einstein]
+A person who never made a mistake _never_ tried anything new.

data/features/fixtures/html-slim/examples/asciidoc/document.adoc

@@ -0,0 +1,4 @@
+// .title_with_author
+// This example should fail.
+= The Dangerous and Thrilling Documentation Chronicles
+Kismet Rainbow Chameleon <kismet@asciidoctor.org>

data/features/fixtures/html-slim/examples/asciidoc/inline_quoted.adoc

@@ -0,0 +1,2 @@
+// .emphasis
+_chunky bacon_

data/features/fixtures/html-slim/examples/html/block_quote.html

@@ -0,0 +1,26 @@
+<!-- .basic
+Doesn't exist in input examples.
+-->
+<div class="quoteblock">
+  <blockquote>Four score and seven years ago our fathers brought forth
+on this continent a new nation&#8230;&#8203;</blockquote>
+</div>
+
+<!-- .with_id_and_role
+Correct example.
+-->
+<div id="parking"
+     class="quoteblock startrek">
+  <blockquote>
+    Everybody   remember
+    where   we    parked.
+  </blockquote>
+</div>
+
+<!-- .with_attribution
+Failing example.
+-->
+<div class="quoteblock">
+  <blockquote>A person who never made a mistake <em>never</em> tried anything new.</blockquote>
+  <span>Albert Einstein</span>
+</div>

data/features/fixtures/html-slim/examples/html/document.html

@@ -0,0 +1,7 @@
+<!-- .title_with_author
+:include: .//body/div[@id="header"]
+-->
+<div id="header">
+  <h1>The Dangerous and Thrilling Documentation Chronicles</h1>
+  <div id="author">Kismet Rainbow Chameleon</div>
+</div>

data/features/fixtures/html-slim/templates/block_paragraph.html.slim

@@ -0,0 +1 @@
+p =content

data/features/fixtures/html-slim/templates/block_quote.html.slim

@@ -0,0 +1,7 @@
+*{:tag=>(title.nil_or_empty? ? 'div' : 'section'), :id=>id, :class=>['quoteblock', *role]}
+  - unless title.nil_or_empty?
+    h6 =captioned_title
+  blockquote =content
+  - if attr? :attribution
+    .attribution
+      | — #{attr :attribution}

data/features/fixtures/html-slim/templates/document.html.slim

@@ -0,0 +1,13 @@
+doctype 5
+html lang=(attr :lang, 'en' unless attr? :nolang)
+  head
+    meta charset='UTF-8'
+    title=((doctitle sanitize: true) || (attr 'untitled-label'))
+  body
+    - unless noheader && notitle
+      #header
+        h1 =header.title
+        - if attr? :author
+          .details
+            span#author =(attr :author)
+    #content =content

data/features/fixtures/html-slim/templates/embedded.html.slim

@@ -0,0 +1,3 @@
+- unless notitle || !has_header?
+  h1 id=id =header.title
+=content

data/features/fixtures/html-slim/templates/inline_quoted.html.slim

@@ -0,0 +1,8 @@
+- case type
+- when :emphasis
+  em class=role =text
+- when :strong
+  strong class=role =text
+- else
+  .span class=role
+    =text

data/features/fixtures/html-slim/test/html_test.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+class TestHtml < DocTest::Test
+  converter_opts template_dirs: 'templates'
+  generate_tests! DocTest::HTML::ExamplesSuite
+end

data/features/fixtures/html-slim/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'asciidoctor/doctest'
+require 'minitest/autorun'
+require 'tilt'
+
+DocTest.examples_path = ['examples/html', 'examples/asciidoc']

data/features/generator_html.feature

@@ -0,0 +1,171 @@
+Feature: Generating output examples for a custom HTML backend
+
+  Background:
+    Given I do have a template-based HTML backend with DocTest
+
+  Scenario: Generate missing output examples
+    When I run `bundle exec rake generate`
+    Then the output should contain:
+      """
+      Generate testing examples *:*.
+       --> Unchanged block_quote:with_id_and_role
+       --> Generating block_quote:with_title
+       --> Skipping block_quote:with_attribution
+       --> Unknown block_quote:basic, doesn't exist in input examples!
+       --> Skipping document:title_with_author
+       --> Generating inline_quoted:emphasis
+
+      """
+    And the file "examples/html/block_quote.html" should contain exactly:
+      """
+      <!-- .basic
+      Doesn't exist in input examples.
+      -->
+      <div class="quoteblock">
+        <blockquote>Four score and seven years ago our fathers brought forth
+      on this continent a new nation&#8230;&#8203;</blockquote>
+      </div>
+
+      <!-- .with_id_and_role
+      Correct example.
+      -->
+      <div id="parking"
+           class="quoteblock startrek">
+        <blockquote>
+          Everybody   remember
+          where   we    parked.
+        </blockquote>
+      </div>
+
+      <!-- .with_attribution
+      Failing example.
+      -->
+      <div class="quoteblock">
+        <blockquote>A person who never made a mistake <em>never</em> tried anything new.</blockquote>
+        <span>Albert Einstein</span>
+      </div>
+
+      <!-- .with_title -->
+      <section class="quoteblock"><h6>After landing the cloaked Klingon bird of prey in Golden Gate park:</h6>
+        <blockquote>Everybody remember where we parked.</blockquote></section>
+
+      """
+    And the file "examples/html/document.html" should contain exactly:
+      """
+      <!-- .title_with_author
+      :include: .//body/div[@id="header"]
+      -->
+      <div id="header">
+        <h1>The Dangerous and Thrilling Documentation Chronicles</h1>
+        <div id="author">Kismet Rainbow Chameleon</div>
+      </div>
+
+      """
+    And the file "examples/html/inline_quoted.html" should contain exactly:
+      """
+      <!-- .emphasis -->
+      <em>chunky bacon</em>
+
+      """
+
+  Scenario: Regenerate all outdated output examples
+    When I run `bundle exec rake generate FORCE=yes`
+    Then the output should contain:
+      """
+      Generate testing examples *:*.
+       --> Unchanged block_quote:with_id_and_role
+       --> Generating block_quote:with_title
+       --> Rewriting block_quote:with_attribution
+       --> Unknown block_quote:basic, doesn't exist in input examples!
+       --> Rewriting document:title_with_author
+       --> Generating inline_quoted:emphasis
+
+      """
+    And the file "examples/html/block_quote.html" should contain exactly:
+      """
+      <!-- .basic
+      Doesn't exist in input examples.
+      -->
+      <div class="quoteblock">
+        <blockquote>Four score and seven years ago our fathers brought forth
+      on this continent a new nation&#8230;&#8203;</blockquote>
+      </div>
+
+      <!-- .with_id_and_role
+      Correct example.
+      -->
+      <div id="parking"
+           class="quoteblock startrek">
+        <blockquote>
+          Everybody   remember
+          where   we    parked.
+        </blockquote>
+      </div>
+
+      <!-- .with_attribution
+      Failing example.
+      -->
+      <div class="quoteblock">
+        <blockquote>A person who never made a mistake
+          <em>never</em>
+          tried anything new.</blockquote>
+        <div class="attribution">— Albert Einstein</div>
+      </div>
+
+      <!-- .with_title -->
+      <section class="quoteblock"><h6>After landing the cloaked Klingon bird of prey in Golden Gate park:</h6>
+        <blockquote>Everybody remember where we parked.</blockquote></section>
+
+      """
+    And the file "examples/html/document.html" should contain exactly:
+      """
+      <!-- .title_with_author
+      :include: .//body/div[@id="header"]
+      -->
+      <div id="header">
+        <h1>The Dangerous and Thrilling Documentation Chronicles</h1>
+        <div class="details"><span id="author">Kismet Rainbow Chameleon</span></div>
+      </div>
+
+      """
+
+  Scenario: Regenerate outdated output examples specified by filter
+    When I run `bundle exec rake generate PATTERN="*:*attribution" FORCE=yes`
+    Then the output should contain:
+      """
+      Generate testing examples *:*attribution.
+       --> Rewriting block_quote:with_attribution
+
+      """
+    And the file "examples/html/block_quote.html" should contain exactly:
+      """
+      <!-- .basic
+      Doesn't exist in input examples.
+      -->
+      <div class="quoteblock">
+        <blockquote>Four score and seven years ago our fathers brought forth
+      on this continent a new nation&#8230;&#8203;</blockquote>
+      </div>
+
+      <!-- .with_id_and_role
+      Correct example.
+      -->
+      <div id="parking"
+           class="quoteblock startrek">
+        <blockquote>
+          Everybody   remember
+          where   we    parked.
+        </blockquote>
+      </div>
+
+      <!-- .with_attribution
+      Failing example.
+      -->
+      <div class="quoteblock">
+        <blockquote>A person who never made a mistake
+          <em>never</em>
+          tried anything new.</blockquote>
+        <div class="attribution">— Albert Einstein</div>
+      </div>
+
+      """