asciidoctor-doctest 1.5.2.0 → 2.0.0.beta.1

data/spec/no_fallback_template_converter_spec.rb

@@ -0,0 +1,38 @@
+describe DocTest::NoFallbackTemplateConverter do
+
+  subject(:delegator) { described_class.new('html5', template_dirs: ['/tmp/html5']) }
+
+  describe '#convert' do
+
+    let(:converter) { delegator.__getobj__ }
+    let(:node) { double('Node', node_name: 'block_foo') }
+
+    before do
+      expect(converter).to receive(:handles?).with('block_foo').and_return(handles)
+    end
+
+    context 'when template is not found' do
+      let(:handles) { false }
+
+      it 'returns a not found marker instead of converted node' do
+        expect(converter).to_not receive(:convert)
+        expect(delegator.convert node).to eq described_class::NOT_FOUND_MARKER
+      end
+
+      it 'prints a warning on stderr' do
+        expect { delegator.convert node }.to output(/Could not find a custom template/i).to_stderr
+      end
+    end
+
+    context 'when template is found' do
+      let(:handles) { true }
+
+      it 'delegates to the original #convert and returns result' do
+        expect(converter).to receive(:convert)
+          .with(node, 'block_foo', {}).and_return('allons-y!')
+
+        expect(delegator.convert node).to eq 'allons-y!'
+      end
+    end
+  end
+end

data/spec/shared_examples/{base_examples_suite.rb → base_examples.rb}

@@ -3,13 +3,10 @@ require 'forwardable'
 
 using Corefines::Array::second
 
-shared_examples DocTest::BaseExamplesSuite do
-  extend Forwardable
+shared_examples DocTest::IO::Base do
 
-  def_delegator :suite, :create_example
-
-  subject(:suite) { described_class.new(file_ext: '.adoc', examples_path: ex_path) }
-  let(:ex_path) { ['/tmp/alpha', '/tmp/beta'] }
+  subject(:suite) { described_class.new(file_ext: '.adoc', path: path) }
+  let(:path) { ['/tmp/alpha', '/tmp/beta'] }
 
 
   describe '#initialize' do
@@ -19,16 +16,16 @@ shared_examples DocTest::BaseExamplesSuite do
 
     {'nil' => nil, 'blank' => ' '}.each do |desc, file_ext|
       context "with file_ext #{desc}" do
-        let(:args) { {file_ext: file_ext, examples_path: ex_path} }
+        let(:args) { {file_ext: file_ext, path: path} }
         it { expect { init }.to raise_error ArgumentError }
       end
     end
 
-    context 'with examples_path string' do
-      let(:args) { {file_ext: '.html', examples_path: '/foo/bar'} }
+    context 'with path string' do
+      let(:args) { {file_ext: '.html', path: '/foo/bar'} }
 
       it 'wraps string to array' do
-        is_expected.to have_attributes(examples_path: ['/foo/bar'])
+        is_expected.to have_attributes(path: ['/foo/bar'])
       end
     end
   end
@@ -51,8 +48,8 @@ shared_examples DocTest::BaseExamplesSuite do
     let(:group_name) { 'section' }
 
     before do
-      ex_path.each { |p| FileUtils.mkpath p }
-      create_and_write_group ex_path.first, 'noise', '.adoc', 'foo', 'bar'
+      path.each { |p| FileUtils.mkpath p }
+      create_and_write_group path.first, 'noise', '.adoc', 'foo', 'bar'
 
       allow(suite).to receive(:parse) do |input, group_name|
         path, file_name, *example_names = input.split("\n")
@@ -71,7 +68,7 @@ shared_examples DocTest::BaseExamplesSuite do
 
     context "when the group's file has a wrong file extension" do
       before do
-        create_and_write_group ex_path.first, group_name, '.html', 'level1', 'level2'
+        create_and_write_group path.first, group_name, '.html', 'level1', 'level2'
       end
 
       it { is_expected.to be_empty }
@@ -79,7 +76,7 @@ shared_examples DocTest::BaseExamplesSuite do
 
     context 'when single group file is found' do
       let! :examples do
-        create_and_write_group ex_path.second, group_name, '.adoc', 'level1', 'level2'
+        create_and_write_group path.second, group_name, '.adoc', 'level1', 'level2'
       end
 
       it 'returns parsed examples' do
@@ -89,8 +86,8 @@ shared_examples DocTest::BaseExamplesSuite do
 
     context 'when multiple group files are found and contains example with same name' do
       let! :examples do
-        first = create_and_write_group ex_path.first, group_name, '.adoc', 'level1', 'level2'
-        second = create_and_write_group ex_path.second, group_name, '.adoc', 'level2', 'level3'
+        first = create_and_write_group path.first, group_name, '.adoc', 'level1', 'level2'
+        second = create_and_write_group path.second, group_name, '.adoc', 'level2', 'level3'
         [*first, second[1]]
       end
 
@@ -108,7 +105,7 @@ shared_examples DocTest::BaseExamplesSuite do
       (1..2).map { |i| create_example "section:level#{i}", content: 'yada' }
     end
 
-    before { ex_path.each { |p| FileUtils.mkpath p } }
+    before { path.each { |p| FileUtils.mkpath p } }
 
     it 'writes serialized examples to file named after the group with file extension' do
       expect(suite).to receive :serialize do |exmpls|
@@ -116,7 +113,7 @@ shared_examples DocTest::BaseExamplesSuite do
       end
       suite.write_examples examples
 
-      file = File.read "#{ex_path.first}/section.adoc"
+      file = File.read "#{path.first}/section.adoc"
       expect(file).to eq examples.map(&:name).join("\n")
     end
   end
@@ -127,7 +124,7 @@ shared_examples DocTest::BaseExamplesSuite do
 
     subject(:result) { suite.group_names }
 
-    before { ex_path.each { |p| FileUtils.mkpath p } }
+    before { path.each { |p| FileUtils.mkpath p } }
 
     context 'when no file is found' do
       it { is_expected.to be_empty }
@@ -135,22 +132,22 @@ shared_examples DocTest::BaseExamplesSuite do
 
     it 'returns names of files with matching file extension only' do
       %w[block_image.html block_ulist.adoc].each do |name|
-        File.write "#{ex_path.first}/#{name}", 'yada'
+        File.write "#{path.first}/#{name}", 'yada'
       end
       is_expected.to contain_exactly 'block_ulist'
     end
 
     it 'returns names sorted and deduplicated' do
       (names = %w[z j d c k d]).each_with_index do |name, i|
-        File.write "#{ex_path[i % 2]}/#{name}.adoc", 'yada'
+        File.write "#{path[i % 2]}/#{name}.adoc", 'yada'
       end
 
       is_expected.to eq names.uniq.sort
     end
 
     it 'ignores directories and files in subdirectories' do
-      Dir.mkdir "#{ex_path.first}/invalid.adoc"
-      File.write "#{ex_path.first}/invalid.adoc/wat.adoc", 'yada'
+      Dir.mkdir "#{path.first}/invalid.adoc"
+      File.write "#{path.first}/invalid.adoc/wat.adoc", 'yada'
 
       is_expected.to be_empty
     end
@@ -190,14 +187,14 @@ shared_examples DocTest::BaseExamplesSuite do
     let(:result_names) { result.map(&:first).map(&:name) }
 
     let(:ours_suite) { described_class.new(file_ext: '.xyz') }
-    let(:theirs_suite) { DocTest::Asciidoc::ExamplesSuite.new(file_ext: '.adoc') }
+    let(:theirs_suite) { DocTest::IO::Asciidoc.new(file_ext: '.adoc') }
 
     def ours_exmpl(suffix, group = 0)
-      ours_suite.create_example "gr#{group}:ex#{suffix}", content: 'ours!'
+      create_example "gr#{group}:ex#{suffix}", content: 'ours!'
     end
 
     def theirs_exmpl(suffix, group = 0)
-      theirs_suite.create_example "gr#{group}:ex#{suffix}", content: 'theirs!'
+      create_example "gr#{group}:ex#{suffix}", content: 'theirs!'
     end
 
     before do
@@ -235,7 +232,7 @@ shared_examples DocTest::BaseExamplesSuite do
         end
 
         it 'replaces the missing example with empty one with the name' do
-          expect(result.second.last).to eq theirs_suite.create_example 'gr0:ex1'
+          expect(result.second.last).to eq create_example 'gr0:ex1'
         end
       end
 
@@ -247,7 +244,7 @@ shared_examples DocTest::BaseExamplesSuite do
         end
 
         it 'replaces the missing example with empty one with the name' do
-          expect(result.last.first).to eq ours_suite.create_example 'gr0:ex0'
+          expect(result.last.first).to eq create_example 'gr0:ex0'
         end
       end
     end

data/spec/spec_helper.rb

@@ -33,3 +33,7 @@ RSpec.configure do |config|
 
   config.color = true
 end
+
+def create_example(*args)
+  DocTest::Example.new(*args)
+end

data/spec/tester_spec.rb

@@ -0,0 +1,153 @@
+describe DocTest::Tester do
+
+  subject(:tester) { described_class.new(input_suite, output_suite, converter, reporter) }
+
+  let(:converter) { double 'converter' }
+  let(:input_suite) { double 'ExamplesSuite' }
+  let(:output_suite) { double 'ExamplesSuite' }
+  let(:reporter) { spy 'Reporter' }
+  let(:examples) { fixtures }
+
+
+  describe '#initialize' do
+
+    context "with default reporter" do
+      subject(:tester) { described_class.new(input_suite, output_suite, converter, nil) }
+
+      it { expect(tester.reporter).to be_a DocTest::TestReporter }
+    end
+  end
+
+
+  describe '#run_tests' do
+
+    before do |ex|
+      next if ex.metadata[:skip_before]
+
+      expect(input_suite).to receive(:pair_with)
+          .with(output_suite).and_return(examples.values)
+      allow(tester).to receive(:test_example)
+    end
+
+    context "with default pattern" do
+
+      it "pairs the examples and tests all valid pairs" do
+        ['ex:alpha', 'ex:beta', 'ex:nooutput'].each do |name|
+          expect(tester).to receive(:test_example).with(*examples[name])
+        end
+        tester.run_tests
+      end
+    end
+
+    context "with specific pattern" do
+
+      it "pairs the examples and tests those matching the pattern" do
+        expect(tester).to receive(:test_example).with(*examples['ex:beta'])
+        tester.run_tests(pattern: 'ex:b*')
+      end
+    end
+
+    it "ignores pairs with empty input example" do
+      expect(tester).to_not receive(:test_example).with(*examples['ex:noinput'])
+      tester.run_tests
+    end
+
+    it "calls reporter's methods in the correct order", :skip_before do
+      expect(reporter).to receive(:start).ordered
+      expect(input_suite).to receive(:pair_with).and_return([]).ordered
+      expect(reporter).to receive(:report).ordered
+      expect(reporter).to receive(:passed?).ordered
+
+      tester.run_tests
+    end
+  end
+
+
+  describe '#test_example' do
+
+    subject(:failures) { tester.test_example input_exmpl, output_exmpl }
+
+    let(:examples_pair) { examples['ex:alpha'] }
+    let(:input_exmpl) { examples_pair[0] }
+    let(:output_exmpl) { examples_pair[1] }
+    let(:actual) { output_exmpl.content }
+    let(:expected) { output_exmpl.content }
+
+    shared_examples :example do
+      it "calls reporter" do
+        expect(reporter).to receive(:record)
+        tester.test_example input_exmpl, output_exmpl
+      end
+    end
+
+    before do |ex|
+      next if ex.metadata[:skip_before]
+
+      expect(converter).to receive(:convert_examples)
+        .with(input_exmpl, output_exmpl)
+        .and_return([actual, expected])
+    end
+
+
+    context "when output example is empty", :skip_before do
+
+      let(:examples_pair) { examples['ex:nooutput'] }
+
+      it "skips the test" do
+        is_expected.to contain_exactly Minitest::Skip
+      end
+
+      include_examples :example
+    end
+
+    context "when examples are equivalent" do
+
+      it "returns no failure" do
+        is_expected.to be_empty
+      end
+
+      include_examples :example
+    end
+
+    context "when examples are not equivalent" do
+
+      let(:actual) { '<em>meh</em>' }
+
+      it "returns failure" do
+        is_expected.to include Minitest::Assertion
+      end
+
+      context "and input example has desc:" do
+
+        it "returns failure with message that starts with the desc" do
+          expect(failures.first.message).to match /^yada.*/
+        end
+      end
+
+      context "and both input and output examples have desc:" do
+
+        let(:examples_pair) { examples['ex:beta'] }
+
+        it "returns failure with message that starts with the output's example desc" do
+          expect(failures.first.message).to match /^Yoda.*/
+        end
+      end
+
+      include_examples :example
+    end
+  end
+
+
+  def fixtures
+    data = {
+      'ex:alpha'    => [ {content: '_alpha_', desc: 'yada'}, {content: '<i>alpha</i>'}              ],
+      'ex:beta'     => [ {content: '*beta*',  desc: 'yada'}, {content: '<b>beta</b>', desc: 'Yoda'} ],
+      'ex:noinput'  => [ {},                                 {content: '<del>noinput</del>'}        ],
+      'ex:nooutput' => [ {content: 'nooutput'},              {}                                     ]
+    }
+    data = data.map { |name, tuple|
+      [ name, tuple.map { |opts| DocTest::Example.new(name, opts) } ]
+    }
+    Hash[data]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-doctest
 version: !ruby/object:Gem::Version
-  version: 1.5.2.0
+  version: 2.0.0.beta.1
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-03 00:00:00.000000000 Z
+date: 2017-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
@@ -80,34 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.4'
-- !ruby/object:Gem::Dependency
-  name: minitest-rg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: thread_safe
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.4
+        version: 0.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.4
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -254,14 +240,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: slim
   requirement: !ruby/object:Gem::Requirement
@@ -276,8 +262,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-description: |
-  A tool for end-to-end testing of Asciidoctor backends based on comparing of textual output.
+description: 'A tool for end-to-end testing of Asciidoctor backends based on comparing
+  of textual output.
+
+'
 email: jakub@jirutka.cz
 executables: []
 extensions: []
@@ -339,36 +327,41 @@ files:
 - features/fixtures/html-slim/templates/document.html.slim
 - features/fixtures/html-slim/templates/embedded.html.slim
 - features/fixtures/html-slim/templates/inline_quoted.html.slim
-- features/fixtures/html-slim/test/html_test.rb
-- features/fixtures/html-slim/test/test_helper.rb
 - features/generator_html.feature
 - features/step_definitions/doctest_steps.rb
 - features/support/env.rb
 - features/test_html.feature
 - lib/asciidoctor-doctest.rb
 - lib/asciidoctor/doctest.rb
-- lib/asciidoctor/doctest/asciidoc/examples_suite.rb
-- lib/asciidoctor/doctest/asciidoc_renderer.rb
-- lib/asciidoctor/doctest/base_example.rb
-- lib/asciidoctor/doctest/base_examples_suite.rb
+- lib/asciidoctor/doctest/asciidoc_converter.rb
+- lib/asciidoctor/doctest/example.rb
+- lib/asciidoctor/doctest/factory.rb
 - lib/asciidoctor/doctest/generator.rb
-- lib/asciidoctor/doctest/generator_task.rb
-- lib/asciidoctor/doctest/html/example.rb
-- lib/asciidoctor/doctest/html/examples_suite.rb
-- lib/asciidoctor/doctest/html/normalizer.rb
+- lib/asciidoctor/doctest/html/converter.rb
+- lib/asciidoctor/doctest/html_normalizer.rb
+- lib/asciidoctor/doctest/io.rb
+- lib/asciidoctor/doctest/io/asciidoc.rb
+- lib/asciidoctor/doctest/io/base.rb
+- lib/asciidoctor/doctest/io/xml.rb
 - lib/asciidoctor/doctest/minitest_diffy.rb
-- lib/asciidoctor/doctest/test.rb
+- lib/asciidoctor/doctest/no_fallback_template_converter.rb
+- lib/asciidoctor/doctest/rake_tasks.rb
+- lib/asciidoctor/doctest/test_reporter.rb
+- lib/asciidoctor/doctest/tester.rb
 - lib/asciidoctor/doctest/version.rb
-- spec/asciidoc/examples_suite_spec.rb
-- spec/asciidoc_renderer_spec.rb
-- spec/base_example_spec.rb
-- spec/html/examples_suite_spec.rb
-- spec/html/normalizer_spec.rb
+- spec/asciidoc_converter_spec.rb
+- spec/example_spec.rb
+- spec/factory_spec.rb
+- spec/html/converter_spec.rb
+- spec/html_normalizer_spec.rb
+- spec/io/asciidoc_spec.rb
+- spec/io/xml_spec.rb
 - spec/minitest_diffy_spec.rb
-- spec/shared_examples/base_examples_suite.rb
+- spec/no_fallback_template_converter_spec.rb
+- spec/shared_examples/base_examples.rb
 - spec/spec_helper.rb
 - spec/support/matchers.rb
-- spec/test_spec.rb
+- spec/tester_spec.rb
 homepage: https://github.com/asciidoctor/asciidoctor-doctest
 licenses:
 - MIT
@@ -384,12 +377,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Test suite for Asciidoctor backends
@@ -406,20 +399,20 @@ test_files:
 - features/fixtures/html-slim/templates/document.html.slim
 - features/fixtures/html-slim/templates/embedded.html.slim
 - features/fixtures/html-slim/templates/inline_quoted.html.slim
-- features/fixtures/html-slim/test/html_test.rb
-- features/fixtures/html-slim/test/test_helper.rb
 - features/generator_html.feature
 - features/step_definitions/doctest_steps.rb
 - features/support/env.rb
 - features/test_html.feature
-- spec/asciidoc/examples_suite_spec.rb
-- spec/asciidoc_renderer_spec.rb
-- spec/base_example_spec.rb
-- spec/html/examples_suite_spec.rb
-- spec/html/normalizer_spec.rb
+- spec/asciidoc_converter_spec.rb
+- spec/example_spec.rb
+- spec/factory_spec.rb
+- spec/html/converter_spec.rb
+- spec/html_normalizer_spec.rb
+- spec/io/asciidoc_spec.rb
+- spec/io/xml_spec.rb
 - spec/minitest_diffy_spec.rb
-- spec/shared_examples/base_examples_suite.rb
+- spec/no_fallback_template_converter_spec.rb
+- spec/shared_examples/base_examples.rb
 - spec/spec_helper.rb
 - spec/support/matchers.rb
-- spec/test_spec.rb
-has_rdoc: yard
+- spec/tester_spec.rb