asciidoctor-doctest 1.5.2.0 → 2.0.0.beta.1

data/lib/asciidoctor/doctest/tester.rb

@@ -0,0 +1,134 @@
+require 'asciidoctor/doctest/minitest_diffy'
+require 'asciidoctor/doctest/test_reporter'
+require 'corefines'
+require 'minitest'
+
+using Corefines::Object::presence
+
+module Asciidoctor
+  module DocTest
+    class Tester
+
+      ##
+      # @return [Minitest::Reporter] an instance of minitest's +Reporter+
+      #   to report test results.
+      attr_reader :reporter
+
+      ##
+      # @param input_suite [IO::Base] an instance of {IO::Base} subclass to
+      #        read the reference input examples from.
+      #
+      # @param output_suite [IO::Base] an instance of {IO::Base} subclass to
+      #        read the output examples from (i.e. an expected output).
+      #
+      # @param converter [#call] a callable that accepts a string content of
+      #        an input example and a hash with options for the converter, and
+      #        returns the converted content.
+      #
+      # @param reporter [Minitest::Reporter, nil] an instance of minitest's
+      #        +Reporter+ to report test results. When omitted or +nil+, then
+      #        {TestReporter} is used.
+      #
+      def initialize(input_suite, output_suite, converter, reporter = nil)
+        @input_suite = input_suite
+        @output_suite = output_suite
+        @converter = converter
+        @reporter = reporter || TestReporter.new
+      end
+
+      ##
+      # Runs tests for all the input/output examples which name matches
+      # the _pattern_. When some output example is missing, it's reported as
+      # a skipped test.
+      #
+      # @param pattern [String] glob-like pattern to select examples to test
+      #        (see {Example#name_match?}).
+      #
+      def run_tests(pattern: '*:*')
+        @reporter.start
+
+        @input_suite.pair_with(@output_suite).each do |input, output|
+          next if input.empty? || !input.name_match?(pattern)
+          test_example input, output
+        end
+
+        @reporter.report
+        @reporter.passed?
+      end
+
+      ##
+      # Tests if the given reference input is matching the expected output
+      # after conversion through the tested backend.
+      #
+      # @param input_exmpl [Example] the reference input example.
+      # @param output_exmpl [Example] the expected output example.
+      #
+      def test_example(input_exmpl, output_exmpl)
+        test_with_minitest input_exmpl.name do |test|
+          if output_exmpl.empty?
+            test.skip 'No expected output found'
+          else
+            actual, expected = @converter.convert_examples(input_exmpl, output_exmpl)
+            msg = output_exmpl.desc.presence || input_exmpl.desc
+
+            test.assert_equal expected, actual, msg
+          end
+        end
+      end
+
+      protected
+
+      ##
+      # Runs the given block with Minitest as a single test.
+      #
+      # @param [String, Symbol] test name.
+      # @yield [Minitest::Test] Gives the test context to the block.
+      #
+      def test_with_minitest(name, &block)
+        MinitestSingleTest.test! @reporter, name, name, block
+      end
+
+
+      # @private
+      class MinitestSingleTest < Minitest::Test
+        include MinitestDiffy
+
+        # @note Overrides method from +Minitest::Test+.
+        attr_reader :location
+
+        def self.test!(reporter, name, location, callable)
+          new(reporter, name, location, callable).failures
+        end
+
+        private
+
+        def initialize(reporter, name, location, callable)
+          super name
+          @reporter = reporter
+          @location = location
+          @callable = callable
+          run
+          @reporter.record(self)
+        end
+
+        # @note Overrides method from +Minitest::Test+.
+        def run
+          with_info_handler do
+            time_it do
+              capture_exceptions do
+                @callable.call(self)
+              end
+            end
+          end
+
+          self # per contract
+        end
+
+        # @note Overrides method from +Minitest::Assertions+.
+        def mu_pp(example)
+          example.to_s
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/doctest/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module DocTest
-    VERSION = '1.5.2.0'
+    VERSION = '2.0.0.beta.1'
   end
 end

data/spec/asciidoc_converter_spec.rb

@@ -0,0 +1,64 @@
+require 'fileutils'
+
+describe DocTest::AsciidocConverter do
+
+  subject { described_class }
+
+  it { is_expected.to have_method :convert, :call }
+
+
+  describe '#initialize' do
+
+    context 'with defaults' do
+      subject { described_class.new.opts }
+      it { is_expected.to include safe: :safe }
+    end
+
+    context 'with backend_name' do
+      subject { described_class.new(backend_name: 'html5').opts }
+      it { is_expected.to include backend: 'html5' }
+
+      context 'empty string' do
+        subject { described_class.new(backend_name: '').opts }
+        it { is_expected.to_not include :backend }
+      end
+    end
+
+    context 'with template_dirs' do
+      include FakeFS::SpecHelpers
+
+      subject { described_class.new(template_dirs: template_dirs).opts }
+      let(:template_dirs) { ['/tmp/html5'] }
+
+      before { FileUtils.mkpath template_dirs[0] }
+
+      context 'that exists' do
+        it do
+          is_expected.to include(
+            template_dirs: template_dirs,
+            converter: DocTest::NoFallbackTemplateConverter
+          )
+        end
+
+        context 'and templates_fallback is true' do
+          subject { described_class.new(template_dirs: template_dirs, templates_fallback: true).opts }
+          it { is_expected.to include template_dirs: template_dirs }
+          it { is_expected.to_not include :converter }
+        end
+
+        context 'and custom converter' do
+          subject { described_class.new(template_dirs: template_dirs, converter: converter).opts }
+          let(:converter) { Asciidoctor::Converter::TemplateConverter }
+
+          it { is_expected.to include template_dirs: template_dirs, converter: converter }
+        end
+      end
+
+      context "that doesn't exist" do
+        let(:template_dirs) { ['/tmp/html5', '/tmp/revealjs'] }
+
+        it { expect { subject }.to raise_error ArgumentError }
+      end
+    end
+  end
+end

data/spec/{base_example_spec.rb → example_spec.rb}

@@ -1,10 +1,9 @@
-describe DocTest::BaseExample do
+describe DocTest::Example do
 
   subject(:o) { described_class.new ['foo', 'bar'] }
 
   it do
-    is_expected.to respond_to :group_name, :local_name, :desc, :opts, :content,
-                              :content_normalized, :content_pretty
+    is_expected.to respond_to :group_name, :local_name, :desc, :opts, :content
   end
 
   describe '#name' do
@@ -156,8 +155,8 @@ describe DocTest::BaseExample do
       expect(first).to_not eq second
     end
 
-    it 'returns false for instances with different content_normalized' do
-      expect(second).to receive(:content_normalized).and_return('ALLONS-Y!')
+    it 'returns false for instances with different content' do
+      expect(second).to receive(:content).and_return('ALLONS-Y!')
       expect(first).to_not eq second
     end
   end

data/spec/factory_spec.rb

@@ -0,0 +1,46 @@
+require 'ostruct'
+
+describe DocTest::Factory do
+
+  subject(:factory) { Module.new { extend DocTest::Factory } }
+
+  let(:default_opts) { {} }
+
+  before do
+    factory.register(:foo, OpenStruct, default_opts)
+    factory.register(:bar, String, 'illegal')
+    factory.register(:baz, Integer)
+  end
+
+  describe '.create' do
+    it "returns instance of registered class" do
+      expect( factory.create(:foo) ).to eq OpenStruct.new
+    end
+
+    context "with opts" do
+      it "initializes class with opts" do
+        expect( factory.create(:foo, a: 42) ).to eq OpenStruct.new(a: 42)
+      end
+
+      context "when class with default_opts" do
+        let(:default_opts) { {a: 1, b: 2} }
+
+        it "initializes class with opts merged with default_opts" do
+          expect( factory.create(:foo, b: 6) ).to eq OpenStruct.new(a: 1, b: 6)
+        end
+      end
+    end
+
+    context "when class with default_opts" do
+      let(:default_opts) { {a: 1, b: 2} }
+
+      it "initializes class with default_opts" do
+        expect( factory.create(:foo) ).to eq OpenStruct.new(default_opts)
+      end
+    end
+
+    context "with unregistered name" do
+      it { expect { factory.create(:unknown) }.to raise_error(ArgumentError) }
+    end
+  end
+end

data/spec/html/converter_spec.rb

@@ -0,0 +1,95 @@
+require 'forwardable'
+
+module DocTest
+  describe HTML::Converter do
+    extend Forwardable
+
+    def_delegator :converter, :convert_examples
+
+    subject(:converter) { described_class.new }
+
+    describe '#convert_examples' do
+
+      let(:input) { Example.new 's:dummy', content: '*chunky* bacon' }
+      let(:output) { Example.new 's:dummy', content: '<b>chunky</b> bacon', opts: opts }
+      let(:opts) { {dummy: 'value'} }
+      let(:converter_opts) { {header_footer: false} }
+
+      subject(:result) { convert_examples input, output }
+
+      let :rendered do
+        <<-EOF
+          <section>
+            <h1>Title</h1>
+            <div>
+              <p><b>Chunky</b> bacon</p>
+            </div>
+            <code>meh</code>
+          </section>
+          <div>
+            <p>why?</p>
+          </div>
+        EOF
+      end
+
+      before do
+        expect(converter).to receive(:convert)
+          .with(input.content, converter_opts).and_return(rendered)
+      end
+
+      it 'returns array of converted input content and output content'
+
+      context 'with :exclude option' do
+        let(:opts) { {exclude: ['.//p', './/code']} }
+
+        it 'returns content without HTML (sub)elements specified by XPath' do
+          expect(result.first.gsub(/\s*/, '')).to eq \
+            '<section><h1>Title</h1><div></div></section><div></div>'
+        end
+      end
+
+      context 'with :include option' do
+        let(:opts) { {include: ['.//p']} }
+
+        it 'returns content with only HTML (sub)elements specified by XPath' do
+          expect(result.first.gsub(/\s*/, '')).to eq '<p><b>Chunky</b>bacon</p><p>why?</p>'
+        end
+      end
+
+      context 'with :header_footer option' do
+        let(:opts) { {header_footer: true} }
+        let(:converter_opts) { {header_footer: true} }
+
+        it 'renders content with :header_footer => true' do
+          convert_examples input, output
+        end
+      end
+
+      context 'with example named /^document.*/' do
+        let(:input) { Example.new 'document:dummy', content: '*chunky* bacon' }
+        let(:converter_opts) { {header_footer: true} }
+
+        it 'renders content with :header_footer => true' do
+          convert_examples input, output
+        end
+      end
+
+      context 'with example named /inline_.*/' do
+        let(:input) { Example.new 'inline_quoted:dummy', content: '*chunky* bacon' }
+        let(:rendered) { '<p><b>chunky</b> bacon</p>' }
+
+        it 'returns content without top-level <p> tags' do
+          expect(result.first).to eq '<b>chunky</b> bacon'
+        end
+
+        context 'with :include option' do
+          let(:opts) { {include: ['.//b']} }
+
+          it 'preferes the include option' do
+            expect(result.first).to eq '<b>chunky</b>'
+          end
+        end
+      end
+    end
+  end
+end

data/spec/{html/normalizer_spec.rb → html_normalizer_spec.rb}

@@ -1,4 +1,4 @@
-describe DocTest::HTML::Normalizer do
+describe DocTest::HtmlNormalizer do
 
   [Nokogiri::HTML::Document, Nokogiri::HTML::DocumentFragment].each do |klass|
     it "HtmlNormalizer should be included in #{klass}" do

data/spec/{asciidoc/examples_suite_spec.rb → io/asciidoc_spec.rb}

@@ -1,15 +1,10 @@
-require 'forwardable'
-
 using Corefines::String::unindent
 
-describe DocTest::Asciidoc::ExamplesSuite do
-  extend Forwardable
-
-  it_should_behave_like DocTest::BaseExamplesSuite
+describe DocTest::IO::Asciidoc do
 
-  def_delegator :suite, :create_example
+  it_should_behave_like DocTest::IO::Base
 
-  subject(:suite) { described_class.new }
+  subject(:suite) { described_class.new(file_ext: '.adoc') }
 
 
   describe '#initialize' do

data/spec/{html/examples_suite_spec.rb → io/xml_spec.rb}

@@ -1,15 +1,10 @@
-require 'forwardable'
-
 using Corefines::String::unindent
 
-describe DocTest::HTML::ExamplesSuite do
-  extend Forwardable
-
-  it_should_behave_like DocTest::BaseExamplesSuite
+describe DocTest::IO::XML do
 
-  def_delegator :suite, :create_example
+  it_should_behave_like DocTest::IO::Base
 
-  subject(:suite) { described_class.new }
+  subject(:suite) { described_class.new(file_ext: '.html') }
 
 
   describe '#initialize' do
@@ -143,102 +138,4 @@ describe DocTest::HTML::ExamplesSuite do
       end
     end
   end
-
-
-  describe '#convert_example' do
-
-    let(:input) { create_example 's:dummy', content: '*chunky* bacon' }
-    let(:opts) { {dummy: 'value'} }
-    let(:renderer) { double 'AsciidocRenderer' }
-    let(:converter_opts) { {header_footer: false} }
-
-    subject(:result) { suite.convert_example input, opts, renderer }
-
-    let :rendered do
-      <<-EOF
-        <section>
-          <h1>Title</h1>
-          <div>
-            <p><b>Chunky</b> bacon</p>
-          </div>
-          <code>meh</code>
-        </section>
-        <div>
-          <p>why?</p>
-        </div>
-      EOF
-    end
-
-    before do
-      expect(renderer).to receive(:convert)
-        .with(input.content, converter_opts).and_return(rendered)
-    end
-
-    it 'returns instance of HTML::Example' do
-      is_expected.to be_instance_of DocTest::HTML::Example
-    end
-
-    it 'returns Example with the same name as input_example' do
-      expect(result.name).to eq input.name
-    end
-
-    it 'returns Example with the given opts' do
-      expect(result.opts).to eq opts
-    end
-
-    context 'with :exclude option' do
-      let(:opts) { {exclude: ['.//p', './/code']} }
-
-      it 'returns content without HTML (sub)elements specified by XPath' do
-        expect(result.content.gsub(/\s*/, '')).to eq \
-          '<section><h1>Title</h1><div></div></section><div></div>'
-      end
-    end
-
-    context 'with :include option' do
-      let(:opts) { {include: ['.//p']} }
-
-      it 'returns content with only HTML (sub)elements specified by XPath' do
-        expect(result.content.gsub(/\s*/, '')).to eq '<p><b>Chunky</b>bacon</p><p>why?</p>'
-      end
-    end
-
-    context 'with :header_footer option' do
-      let(:opts) { {header_footer: true} }
-
-      it 'renders content with :header_footer => true' do
-        suite.convert_example input, {}, renderer
-      end
-    end
-
-    context 'with example named /^document.*/' do
-      let(:input) { create_example 'document:dummy', content: '*chunky* bacon' }
-      let(:converter_opts) { {header_footer: true} }
-
-      it 'renders content with :header_footer => true' do
-        suite.convert_example input, {}, renderer
-      end
-    end
-
-    context 'with example named /inline_.*/' do
-      let(:input) { create_example 'inline_quoted:dummy', content: '*chunky* bacon' }
-      let(:rendered) { '<p><b>chunky</b> bacon</p>' }
-
-      it 'returns content without top-level <p> tags' do
-        expect(result.content).to eq '<b>chunky</b> bacon'
-      end
-
-      it 'does not add implicit include into returned example' do
-        expect(result.opts).to_not include :include
-      end
-
-      context 'with :include option' do
-        let(:opts) { {include: ['.//b']} }
-
-        it 'preferes the include option' do
-          expect(result.content).to eq '<b>chunky</b>'
-        end
-      end
-    end
-  end
 end