asciidoctor-doctest 1.5.0

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'rspec/collection_matchers'
+require 'simplecov'
+require 'asciidoctor/doctest'
+
+Dir['./spec/{shared_examples,support}/**/*.rb'].each { |file| require file }
+
+RSpec.configure do |config|
+
+  # rspec-expectations config
+  config.expect_with :rspec do |expects|
+
+    # This option disables deprecated 'should' syntax.
+    expects.syntax = :expect
+
+    # This option makes the +description+ and +failure_message+ of custom
+    # matchers include text for helper methods defined using +chain+, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expects.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config
+  config.mock_with :rspec do |mocks|
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object.
+    mocks.verify_partial_doubles = true
+  end
+
+  config.color = true
+end

data/spec/support/matchers.rb

@@ -0,0 +1,7 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :have_method do |*names|
+  match do |klass|
+    names.all? { |name| klass.method_defined? name }
+  end
+end

data/spec/test_spec.rb

@@ -0,0 +1,164 @@
+describe DocTest::Test do
+
+  subject(:test_class) { Class.new described_class }
+
+  let(:renderer) { double 'Renderer' }
+  let(:input_suite) { double 'ExamplesSuite' }
+  let(:output_suite) { double 'ExamplesSuite' }
+
+  before do
+    test_class.instance_variable_set(:@renderer, renderer)
+  end
+
+  it { is_expected.to have_method :input_suite, :output_suite, :renderer }
+
+
+  describe '.define_test' do
+    before { test_class.define_test('dummy') { 42 } }
+
+    it 'defines method with the given name' do
+      is_expected.to have_method :dummy
+      expect(test_class.new('dummy').send(:dummy)).to eq 42
+    end
+
+    it "adds the method's name to runnable_methods" do
+      expect(test_class.runnable_methods).to eq ['dummy']
+    end
+  end
+
+
+  describe '.runnable_methods' do
+    subject { test_class.runnable_methods }
+
+    context 'when no test defined yet' do
+      it { is_expected.to be_empty }
+    end
+
+    context 'when some test is defined using test macro' do
+      it 'returns array with the test method name' do
+        test_class.define_test('dummy') { 42 }
+        is_expected.to eq ['dummy']
+      end
+    end
+
+    context 'when any method named /test_.*/ exists' do
+      it 'returns array with the method name' do
+        test_class.send(:define_method, :test_me) { 42 }
+        is_expected.to eq ['test_me']
+      end
+    end
+  end
+
+
+  describe '.generate_tests!' do
+
+    let :examples do
+      [
+        [ (create_example 'bl:basic', content: '_meh_'),
+          (create_example 'bl:basic', content: '<i>meh</i>') ],
+        [ (create_example 'bl:noinput'),
+          (create_example 'bl:noinput') ],
+        [ (create_example 'bl:nooutput', content: '_meh_'),
+          (create_example 'bl:nooutput') ]
+      ]
+    end
+
+    before do
+      expect(input_suite).to receive(:pair_with)
+        .with(output_suite).and_return(examples)
+      test_class.generate_tests! output_suite, input_suite
+    end
+
+    context 'when both input and output examples are present' do
+      subject(:test_inst) { test_class.new('bl:basic') }
+
+      it 'defines test method that calls method :test_example'do
+        is_expected.to receive(:test_example)
+        test_inst.send(:'bl:basic')
+      end
+    end
+
+    context 'when input example is missing' do
+      it "doesn't define a test method for it" do
+        is_expected.to_not have_method :'bl:noinput'
+      end
+    end
+
+    context 'when output example is missing' do
+      subject { test_class.new('bl:nooutput') }
+
+      it 'defines test method with "skip"' do
+        expect { subject.send(:'bl:nooutput') }.to raise_error Minitest::Skip
+      end
+    end
+  end
+
+
+  describe '#location' do
+    subject { test_class.new('block_ulist:basic').location }
+
+    # test_class is anonymous, so we must give it some name
+    before { DummyTest = test_class unless defined? DummyTest }
+
+    it 'returns formatted example name' do
+      is_expected.to eq 'DummyTest :: block_ulist : basic'
+    end
+  end
+
+
+  describe '#test_example' do
+    subject(:test_inst) { test_class.new('bl:basic') }
+
+    let(:input_exmpl) { create_example 'bl:basic', content: '_meh_' }
+    let(:output_exmpl) { create_example 'bl:basic', content: '<i>meh</i>', opts: {foo: 42} }
+    let(:test_example!) { test_inst.test_example output_exmpl, input_exmpl }
+
+    before do
+      allow(input_suite).to receive(:pair_with)
+        .with(output_suite)
+        .and_return([])
+
+      expect(output_suite).to receive(:convert_example)
+        .with(input_exmpl, output_exmpl.opts, renderer)
+        .and_return(actual_exmpl)
+
+      test_class.generate_tests! output_suite, input_suite
+    end
+
+    context 'when examples are equivalent' do
+      let(:actual_exmpl) { output_exmpl.dup }
+
+      it 'no error is thrown' do
+        expect { test_example! }.not_to raise_error
+      end
+    end
+
+    context 'when examples are not equivalent' do
+      let(:input_exmpl) { create_example 'bl:basic', content: '_meh_', desc: 'yada yada' }
+      let(:actual_exmpl) { output_exmpl.dup.tap { |o| o.content = '<em>meh</em>' } }
+
+      it 'throws Minitest::Assertion error' do
+        expect { test_example! }.to raise_error Minitest::Assertion
+      end
+
+      context 'and input example has desc:' do
+        it 'throws error which message starts with the desc' do
+          expect { test_example! }.to raise_error(/^yada yada.*/)
+        end
+      end
+
+      context 'and both input and output examples have desc:' do
+        let(:output_exmpl) { create_example 'bl:basic', content: '<i>meh</i>', desc: 'Yoda' }
+
+        it "throws error which message starts with the output's example desc" do
+          expect { test_example! }.to raise_error(/^Yoda.*/)
+        end
+      end
+    end
+  end
+
+
+  def create_example(*args)
+    DocTest::BaseExample.new(*args)
+  end
+end

metadata

@@ -0,0 +1,360 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-doctest
+version: !ruby/object:Gem::Version
+  version: 1.5.0
+platform: ruby
+authors:
+- Jakub Jirutka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: htmlbeautifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.6.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'
+description: |
+  A tool for end-to-end testing of Asciidoctor backends based on comparing of textual output.
+email: jakub@jirutka.cz
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+files:
+- CHANGELOG.adoc
+- LICENSE
+- README.adoc
+- Rakefile
+- data/examples/asciidoc/block_admonition.adoc
+- data/examples/asciidoc/block_audio.adoc
+- data/examples/asciidoc/block_colist.adoc
+- data/examples/asciidoc/block_dlist.adoc
+- data/examples/asciidoc/block_example.adoc
+- data/examples/asciidoc/block_floating_title.adoc
+- data/examples/asciidoc/block_image.adoc
+- data/examples/asciidoc/block_listing.adoc
+- data/examples/asciidoc/block_literal.adoc
+- data/examples/asciidoc/block_olist.adoc
+- data/examples/asciidoc/block_open.adoc
+- data/examples/asciidoc/block_outline.adoc
+- data/examples/asciidoc/block_page_break.adoc
+- data/examples/asciidoc/block_paragraph.adoc
+- data/examples/asciidoc/block_pass.adoc
+- data/examples/asciidoc/block_preamble.adoc
+- data/examples/asciidoc/block_quote.adoc
+- data/examples/asciidoc/block_sidebar.adoc
+- data/examples/asciidoc/block_stem.adoc
+- data/examples/asciidoc/block_table.adoc
+- data/examples/asciidoc/block_thematic_break.adoc
+- data/examples/asciidoc/block_toc.adoc
+- data/examples/asciidoc/block_ulist.adoc
+- data/examples/asciidoc/block_verse.adoc
+- data/examples/asciidoc/block_video.adoc
+- data/examples/asciidoc/document.adoc
+- data/examples/asciidoc/embedded.adoc
+- data/examples/asciidoc/inline_anchor.adoc
+- data/examples/asciidoc/inline_break.adoc
+- data/examples/asciidoc/inline_button.adoc
+- data/examples/asciidoc/inline_callout.adoc
+- data/examples/asciidoc/inline_footnote.adoc
+- data/examples/asciidoc/inline_image.adoc
+- data/examples/asciidoc/inline_kbd.adoc
+- data/examples/asciidoc/inline_menu.adoc
+- data/examples/asciidoc/inline_quoted.adoc
+- data/examples/asciidoc/section.adoc
+- doc/img/doctest-diag.odf
+- doc/img/doctest-diag.svg
+- doc/img/failing-test-term.gif
+- 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/core_ext.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/html_beautifier.rb
+- lib/asciidoctor/doctest/html/normalizer.rb
+- lib/asciidoctor/doctest/minitest_diffy.rb
+- lib/asciidoctor/doctest/test.rb
+- lib/asciidoctor/doctest/version.rb
+- spec/asciidoc/examples_suite_spec.rb
+- spec/base_example_spec.rb
+- spec/core_ext_spec.rb
+- spec/html/examples_suite_spec.rb
+- spec/html/normalizer_spec.rb
+- spec/shared_examples/base_examples_suite.rb
+- spec/spec_helper.rb
+- spec/support/matchers.rb
+- spec/test_spec.rb
+homepage: https://github.com/asciidoctor/asciidoctor-doctest
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Test suite for Asciidoctor backends
+test_files:
+- spec/asciidoc/examples_suite_spec.rb
+- spec/base_example_spec.rb
+- spec/core_ext_spec.rb
+- spec/html/examples_suite_spec.rb
+- spec/html/normalizer_spec.rb
+- spec/shared_examples/base_examples_suite.rb
+- spec/spec_helper.rb
+- spec/support/matchers.rb
+- spec/test_spec.rb
+has_rdoc: yard