asciidoctor-doctest 2.0.0.beta.4 → 2.0.0.beta.5

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

@@ -1,13 +0,0 @@
-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

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

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

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

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

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

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

@@ -1,7 +0,0 @@
-*{: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/generator_html.feature

@@ -1,171 +0,0 @@
-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 doctest:generate`
-    Then the output should contain:
-      """
-      Generating test examples *:* in examples/html
-       --> Skipping document:title-with-author
-       --> Generating inline_quoted:emphasis
-       --> Unchanged quote:with-id-and-role
-       --> Generating quote:with-title
-       --> Skipping quote:with-attribution
-       --> Unknown quote:basic, doesn't exist in input examples!
-
-      """
-    And the file "examples/html/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>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 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 doctest:generate FORCE=yes`
-    Then the output should contain:
-      """
-      Generating test examples *:* in examples/html
-       --> Rewriting document:title-with-author
-       --> Generating inline_quoted:emphasis
-       --> Unchanged quote:with-id-and-role
-       --> Generating quote:with-title
-       --> Rewriting quote:with-attribution
-       --> Unknown quote:basic, doesn't exist in input examples!
-
-      """
-    And the file "examples/html/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 doctest:generate PATTERN="*:*attribution" FORCE=yes`
-    Then the output should contain:
-      """
-      Generating test examples *:*attribution in examples/html
-       --> Rewriting quote:with-attribution
-
-      """
-    And the file "examples/html/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>
-
-      """

data/features/step_definitions/doctest_steps.rb

@@ -1,5 +0,0 @@
-require 'fileutils'
-
-Given 'I do have a template-based HTML backend with DocTest' do
-  FileUtils.cp_r Dir.glob("#{FIXTURES_DIR}/html-slim/**"), TEMP_DIR
-end

data/features/support/env.rb

@@ -1,24 +0,0 @@
-require 'aruba'
-require 'aruba/cucumber'
-require 'asciidoctor/doctest'
-require 'fileutils'
-require 'rspec/expectations'
-
-Dir["#{__dir__}/../step_definitions/**/*.rb"].each { |file| require file }
-
-PROJECT_DIR  = File.expand_path('../../', __dir__)
-FIXTURES_DIR = File.expand_path('../fixtures', __dir__)
-TEMP_DIR     = File.join(PROJECT_DIR, 'tmp/aruba')
-
-Before do
-  FileUtils.mkdir_p TEMP_DIR
-  # overwrite Aruba's default temp directory location
-  @dirs = [TEMP_DIR]
-
-  # Increase timeout for JRuby, that is very slooow...
-  @aruba_timeout_seconds = 50
-end
-
-After do
-  FileUtils.rm_rf(TEMP_DIR) if Dir.exist? TEMP_DIR
-end

data/features/test_html.feature

@@ -1,98 +0,0 @@
-Feature: Testing a custom HTML backend
-
-  Background:
-    Given I do have a template-based HTML backend with DocTest
-
-  Scenario: Some examples do not match the expected output
-    When I run `bundle exec rake doctest:test`
-    Then the output should contain:
-      """
-      Running DocTest for the templates: templates.
-
-      FS.SF
-      """
-    Then the output should contain:
-      """
-      ✗  Failure: quote:with-attribution
-         Failing example..
-
-            <div class="quoteblock">
-              <blockquote>A person who never made a mistake <em>never</em> tried anything new.</blockquote>
-         E    <div>Albert Einstein</div>
-         A    <div class="attribution">— Albert Einstein</div>
-            </div>
-      """
-    And the output should contain:
-      """
-      ✗  Failure: document:title-with-author
-         This example should fail..
-
-            <div id="header">
-              <h1>The Dangerous and Thrilling Documentation Chronicles</h1>
-         E    <div id="author">Kismet Rainbow Chameleon</div>
-         A    <div class="details"><span id="author">Kismet Rainbow Chameleon</span></div>
-            </div>
-      """
-    And the output should contain:
-      """
-      5 examples (1 passed, 2 failed, 2 skipped)
-      """
-    And the output should contain:
-      """
-      You have skipped tests. Run with VERBOSE=yes for details.
-      """
-
-    When I run `bundle exec rake doctest:test VERBOSE=yes`
-    Then the output should contain:
-      """
-      Running DocTest for the templates: templates.
-
-      ✗  document:title-with-author
-      ∅  inline_quoted:emphasis
-      ✓  quote:with-id-and-role
-      ∅  quote:with-title
-      ✗  quote:with-attribution
-
-      """
-    And the output should contain:
-      """
-      ∅  Skipped: quote:with-title
-         No expected output found
-      """
-    And the output should contain:
-      """
-      ∅  Skipped: inline_quoted:emphasis
-         No expected output found
-      """
-
-  Scenario: Test only examples matching the pattern
-    When I run `bundle exec rake doctest:test PATTERN=quot*:* VERBOSE=yes`
-    Then the output should contain:
-      """
-      Running DocTest for the templates: templates.
-
-      ✓  quote:with-id-and-role
-      ∅  quote:with-title
-      ✗  quote:with-attribution
-
-      """
-
-  Scenario: A necessary template is missing and fallback to the built-in converter is disabled
-    When I remove the file "templates/inline_quoted.html.slim"
-    And I run `bundle exec rake doctest:test`
-    Then the output should contain:
-      """
-      Could not find a custom template to handle template_name: inline_quoted
-      """
-    And the output should contain:
-      """
-      ✗  Failure: quote:with-attribution
-         Failing example..
-
-            <div class="quoteblock">
-         E    <blockquote>A person who never made a mistake <em>never</em> tried anything new.</blockquote>
-         E    <div>Albert Einstein</div>
-         A    <blockquote>A person who never made a mistake --TEMPLATE NOT FOUND-- tried anything new.</blockquote>
-         A    <div class="attribution">— Albert Einstein</div>
-            </div>
-      """

data/spec/asciidoc_converter_spec.rb

@@ -1,64 +0,0 @@
-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/example_spec.rb

@@ -1,180 +0,0 @@
-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
-  end
-
-  describe '#name' do
-
-    it 'returns #{group_name}:#{local_name}' do
-      o.group_name = 'block_olist'
-      o.local_name = 'with-start'
-
-      expect(o.name).to eq "#{o.group_name}:#{o.local_name}"
-    end
-  end
-
-  describe '#name=' do
-
-    shared_examples :example do
-      it 'sets group_name and local_name' do
-        is_expected.to have_attributes group_name: 'section', local_name: 'basic'
-      end
-    end
-
-    context 'with String' do
-      before { o.name = 'section:basic' }
-      include_examples :example
-    end
-
-    context 'with Array' do
-      before { o.name = ['section', 'basic'] }
-      include_examples :example
-    end
-  end
-
-  describe '#name_match?' do
-    name = 'block_ulist:with-title'
-
-    context "when name is e.g. #{name}" do
-      subject(:o) { described_class.new(name) }
-
-      [ '*', '*:*', 'block_ulist:*', '*:with-title', 'block_*:*',
-        'block_ulist:with-*', 'block_ulist:*title'
-      ].each do |pattern|
-        it "returns true for #{pattern}" do
-          expect(o.name_match?(pattern)).to be_truthy
-        end
-      end
-
-      [ 'block_foo:with-title', 'block_ulist:foo', 'foo:*' '*:foo', 'foo'
-      ].each do |pattern|
-        it "returns false for #{pattern}" do
-          expect(o.name_match?(pattern)).to be_falsy
-        end
-      end
-    end
-  end
-
-  describe '#empty?' do
-    subject { o.empty? }
-
-    context 'when content is nil' do
-      before { o.content = nil }
-      it { is_expected.to be_truthy }
-    end
-
-    context 'when content is blank' do
-      before { o.content = ' ' }
-      it { is_expected.to be_truthy }
-    end
-
-    context 'when content is not blank' do
-      before { o.content = 'allons-y!' }
-      it { is_expected.to be_falsy }
-    end
-  end
-
-  describe '#[]' do
-
-    context 'when option exists' do
-      it 'returns the option value' do
-        o.opts[:foo] = 'bar'
-        expect(o['foo']).to eq 'bar'
-      end
-    end
-
-    context 'when option does not exist' do
-      it 'returns nil' do
-        expect(o[:nothing]).to be_nil
-      end
-    end
-  end
-
-  describe '#[]=' do
-    subject { o.opts }
-
-    context 'with boolean value' do
-      [true, false].each do |value|
-        it "associates the option with #{value}" do
-          o['foo'] = value
-          is_expected.to eq(foo: value)
-        end
-      end
-    end
-
-    context 'with Array value' do
-      it 'associates the option with the value' do
-        o['foo'] = ['a', 'b']
-        is_expected.to eq(foo: ['a', 'b'])
-      end
-    end
-
-    context 'with String value' do
-
-      context 'when option is not defined' do
-        it 'associates the option with the value wrapped in an array' do
-          o['key'] = 'foo'
-          is_expected.to eq(key: ['foo'])
-        end
-      end
-
-      context 'when option is already defined' do
-        before { o.opts[:key] = ['foo'] }
-
-        it 'adds the value to array associated with the option' do
-          o[:key] = 'bar'
-          is_expected.to eq(key: ['foo', 'bar'])
-        end
-      end
-    end
-
-    context 'with nil value' do
-      before { o.opts[:key] = ['foo'] }
-
-      it 'deletes the option' do
-        o[:key] = nil
-        is_expected.to be_empty
-      end
-    end
-  end
-
-  describe '#==' do
-
-    let(:first) { described_class.new('a:b', content: 'allons-y!') }
-    let(:second) { described_class.new('a:b', content: 'allons-y!') }
-
-    it 'returns true for different instances with the same name and content' do
-      expect(first).to eq second
-    end
-
-    it 'returns false for instances with different name' do
-      second.name = 'a:x'
-      expect(first).to_not eq second
-    end
-
-    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
-
-  describe '#dup' do
-    using Corefines::Object::instance_values
-
-    it 'returns deep copy' do
-      origo = described_class.new('a:b', content: 'allons-y!', desc: 'who?', opts: {key: ['value']})
-      copy = origo.dup
-
-      expect(origo).to eql copy
-      expect(origo).to_not equal copy
-
-      origo.instance_values.values.zip(copy.instance_values.values).each do |val1, val2|
-        expect(val1).to_not equal val2 unless val1.nil? && val2.nil?
-      end
-      expect(origo.opts[:key].first).to_not equal copy.opts[:key].first
-    end
-  end
-end