asciidoctor-doctest 1.5.1.2 → 1.5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b53dc962dc9b4a814b1311a5178533de5ad77dbc
-  data.tar.gz: 66551c6bd3d034b34d5ae53a0bd060b75afda60c
+  metadata.gz: 17448118b205d1f1a39fb2ccde52df38b512899e
+  data.tar.gz: 22caa40c2925809f7931347b267639676cc9c88a
 SHA512:
-  metadata.gz: ac106abb1cff5378e3f8884ff1b2d48dc93f28851d9411ccfa00edfa27b26443ee3f3c05548dd9fd3dcbd9d32405cc8e2e7f53a79a5e63d83a49770c2d7c85fe
-  data.tar.gz: b31a3fbb5fdaa396edfbba6dbf735032c3bce9bd91f11d339000b69506841e9f43567896f92f01b60881650c4a694953d769adae2cd3c12259c571e595e5489b
+  metadata.gz: 098697a3599f989cf9b39a463182467c06ef6c2fb8dfeb9beca1510967899ad8a406368fcc392cdf16e7eef287b0d2deda3097f3692bb18207326891716fb41e
+  data.tar.gz: 119b67494d4af4d29eb09ddb22e1a2f189290b5bc3e095bd74a40469109c16317754d30111178e7a4b1a10eb677d9f283b9887b7b5cb7ac7a4d33ed75837c6ae

data/CHANGELOG.adoc

@@ -7,6 +7,18 @@ This document provides a high-level view of the changes introduced in DocTest by
 For a detailed view of what has changed, refer to the {repo-uri}/commits/master[commit history] on GitHub.
 
 
+== 1.5.2.0 (2015-04-04)
+
+Improvements::
+  * Update https://github.com/threedaymonk/htmlbeautifier[htmlbeautifier] to 1.0.0 and remove workaround in `html/html_beautifier` [{commit-uri}/6caafb0[6caafb0]].
+  * Extract formatting (serialization) of example’s options into `BaseExamplesSuite#format_options` to be reusable [{commit-uri}/c4d779c[c4d779c]].
+  * Implement serialization of examples suite into AsciiDoc [{commit-uri}/900aab8[900aab8]].
+  * Replace custom core extensions, ActiveSupport and Colorize with https://github.com/jirutka/corefines[Corefines]. This also means that refinements will be used instead of global monkey-patching, when running on Ruby that supports refinements (currently MRI ≥2.1.0). [{commit-uri}/50e05c1[50e05c1], {commit-uri}/2f4a42e[2f4a42e]]
+
+Bug fixes::
+  * Fix implementation of `eql?` and `hash` in BaseExample [{commit-uri}/c27615b[c27615b]].
+
+
 == 1.5.1.2 (2015-01-03)
 
 Improvements::

data/README.adoc

@@ -56,12 +56,12 @@ mkdir -p test/examples/asciidoc
 . Add development dependency on `asciidoctor-doctest` to your gemspec:
 +
 [source]
-s.add_development_dependency 'asciidoctor-doctest', '~> 1.5'
+s.add_development_dependency 'asciidoctor-doctest', '~> 1.5.2'
 +
 or Gemfile if you’re not distributing the backend as a gem:
 +
 [source]
-gem 'asciidoctor-doctest', '~> 1.5'
+gem 'asciidoctor-doctest', '~> 1.5.2'
 +
 and run `bundle install`.
 

data/lib/asciidoctor/doctest/asciidoc/examples_suite.rb

@@ -1,5 +1,9 @@
 require 'asciidoctor/doctest/base_examples_suite'
-require 'asciidoctor/doctest/core_ext'
+require 'corefines'
+
+using Corefines::Enumerable::map_send
+using Corefines::Object[:blank?, :presence]
+using Corefines::String::concat!
 
 module Asciidoctor::DocTest
   module Asciidoc
@@ -8,8 +12,12 @@ module Asciidoctor::DocTest
     #
     # @example Format of the example's header
     #   // .example-name
-    #   // Any text that is not the example's name is considered
+    #   // Any text that is not the example's name or an option is considered
     #   // as a description.
+    #   // :option_1: value 1
+    #   // :option_2: value 1
+    #   // :option_2: value 2
+    #   // :boolean_option:
     #   The example's content in *AsciiDoc*.
     #
     #   NOTE: The trailing new line (below this) will be removed.
@@ -25,20 +33,35 @@ module Asciidoctor::DocTest
         current = create_example(nil)
 
         input.each_line do |line|
-          line.chomp!
-          if line =~ %r{^//\s*\.([^ \n]+)}
+          case line.chomp!
+          when %r{^//\s*\.([^ \n]+)}
             local_name = $1
             current.content.chomp!
             examples << (current = create_example([group_name, local_name]))
-          elsif line =~ %r{^//\s*(.*)\s*$}
-            (current.desc ||= '').concat($1, "\n")
+          when %r{^//\s*:([^:]+):(.*)}
+            current[$1.to_sym] = $2.blank? ? true : $2.strip
+          when %r{^//\s*(.*)\s*$}
+            (current.desc ||= '').concat!($1, "\n")
           else
-            current.content.concat(line, "\n")
+            current.content.concat!(line, "\n")
           end
         end
 
         examples
       end
+
+      def serialize(examples)
+        Array(examples).map { |exmpl|
+          Array.new.push(".#{exmpl.local_name}")
+            .push(*exmpl.desc.lines.map(&:chomp))
+            .push(*format_options(exmpl.opts))
+            .map_send(:prepend, '// ')
+            .push(exmpl.content.presence)
+            .compact
+            .join("\n")
+            .concat("\n")
+        }.join("\n")
+      end
     end
   end
 end

data/lib/asciidoctor/doctest/asciidoc_renderer.rb

@@ -1,10 +1,10 @@
-require 'active_support/core_ext/array/wrap'
-require 'active_support/core_ext/object/blank'
 require 'asciidoctor'
 require 'asciidoctor/converter/template'
-require 'asciidoctor/doctest/core_ext'
+require 'corefines'
 require 'delegate'
 
+using Corefines::Object[:blank?, :presence]
+
 module Asciidoctor
   module DocTest
     ##
@@ -43,7 +43,7 @@ module Asciidoctor
         @converter = converter
         @converter ||= NoFallbackTemplateConverter unless template_dirs.empty? || templates_fallback
 
-        template_dirs = Array.wrap(template_dirs).freeze
+        template_dirs = Array(template_dirs).freeze
         template_dirs.each do |path|
           fail ArgumentError, "Templates directory '#{path}' doesn't exist!" unless Dir.exist? path
         end

data/lib/asciidoctor/doctest/base_example.rb

@@ -1,6 +1,6 @@
-require 'active_support/core_ext/object/blank'
-require 'active_support/core_ext/object/deep_dup'
-require 'active_support/core_ext/object/instance_variables'
+require 'corefines'
+
+using Corefines::Object[:blank?, :deep_dup, :instance_values]
 
 module Asciidoctor
   module DocTest
@@ -146,12 +146,12 @@ module Asciidoctor
       #         otherwise +false+.
       def eql?(other)
         self.class == other.class &&
-          instance_variables == other.instance_variables
+          instance_values == other.instance_values
       end
 
       # :nocov:
       def hash
-        self.class.hash ^ instance_variables.hash
+        self.class.hash ^ instance_values.hash
       end
       # :nocov:
 

data/lib/asciidoctor/doctest/base_examples_suite.rb

@@ -1,8 +1,9 @@
-require 'active_support/core_ext/enumerable'
-require 'active_support/core_ext/array/wrap'
-require 'active_support/core_ext/class/attribute'
+require 'corefines'
 require 'pathname'
 
+using Corefines::Object::blank?
+using Corefines::Enumerable::index_by
+
 module Asciidoctor
   module DocTest
     ##
@@ -24,7 +25,7 @@ module Asciidoctor
         fail ArgumentError, 'file_ext must not be blank or nil' if file_ext.blank?
 
         @file_ext = file_ext.strip.freeze
-        @examples_path = Array.wrap(examples_path).freeze
+        @examples_path = Array(examples_path).freeze
         @examples_cache = {}
       end
 
@@ -150,7 +151,7 @@ module Asciidoctor
         examples.group_by(&:group_name).each do |group, exmpls|
           # replace cached examples with the given ones and preserve original order
           updated_group = [ read_examples(group), exmpls ]
-            .map_send(:index_by, &:local_name)
+            .map { |e| e.index_by(&:local_name) }
             .reduce(:merge)
             .values
 
@@ -173,6 +174,36 @@ module Asciidoctor
         }.sort
       end
 
+      protected
+
+      ##
+      # Converts the given options into the format used in examples file.
+      #
+      # @example
+      #   {
+      #     option1: 'value 1',
+      #     option2: ['value 1', 'value 2']
+      #     option3: true
+      #   }
+      #   V---V---V---V---V---V---V---V---V
+      #   [
+      #     ':option1: value 1',
+      #     ':option2: value 1',
+      #     ':option2: value 2',
+      #     ':option3:'
+      #   ]
+      #
+      # @param opts [Hash] options
+      # @return [Array<String>] formatted options
+      #
+      def format_options(opts)
+        opts.each_with_object([]) do |(name, vals), ary|
+          Array(vals).each do |val|
+            ary << (val == true ? ":#{name}:" : ":#{name}: #{val}")
+          end
+        end
+      end
+
       private
 
       def read_files(file_name)

data/lib/asciidoctor/doctest/generator.rb

@@ -1,5 +1,7 @@
 require 'asciidoctor'
-require 'colorize'
+require 'corefines'
+
+using Corefines::String::color
 
 module Asciidoctor
   module DocTest
@@ -35,7 +37,7 @@ module Asciidoctor
           next unless input.name_match? pattern
 
           log = ->(msg, color = :default) do
-            log_os << " --> #{(msg % input.name).colorize(color)}\n" if log_os
+            log_os << " --> #{(msg % input.name).color(color)}\n" if log_os
           end
 
           if input.empty?

data/lib/asciidoctor/doctest/generator_task.rb

@@ -1,8 +1,9 @@
-require 'active_support/core_ext/string/strip'
 require 'asciidoctor/doctest/generator'
-require 'asciidoctor/doctest/core_ext'
+require 'corefines'
 require 'rake/tasklib'
 
+using Corefines::String::unindent
+
 module Asciidoctor
   module DocTest
     ##
@@ -99,7 +100,7 @@ module Asciidoctor
       end
 
       def description
-        <<-EOS.strip_heredoc
+        <<-EOS.unindent
           #{title}
 
           Options (environment variables):

data/lib/asciidoctor/doctest/html/example.rb

@@ -1,6 +1,6 @@
 require 'asciidoctor/doctest/base_example'
-require 'asciidoctor/doctest/html/html_beautifier'
 require 'asciidoctor/doctest/html/normalizer'
+require 'htmlbeautifier'
 require 'nokogiri'
 
 module Asciidoctor::DocTest

data/lib/asciidoctor/doctest/html/examples_suite.rb

@@ -1,11 +1,12 @@
-require 'active_support/core_ext/array/wrap'
-require 'active_support/core_ext/object/blank'
 require 'asciidoctor/doctest/base_examples_suite'
-require 'asciidoctor/doctest/core_ext'
 require 'asciidoctor/doctest/html/example'
 require 'asciidoctor/doctest/html/normalizer'
+require 'corefines'
 require 'nokogiri'
 
+using Corefines::Object[:blank?, :presence, :then]
+using Corefines::String::concat!
+
 module Asciidoctor::DocTest
   module HTML
     ##
@@ -13,12 +14,12 @@ module Asciidoctor::DocTest
     #
     # @example Format of the example's header
     #   <!-- .example-name
-    #     Any text that is not the example's name or an option and doesn't
-    #     start with // is considered as a description.
-    #     :option-1: value 1
-    #     :option-2: value 1
-    #     :option-2: value 2
-    #     :boolean-option:
+    #     Any text that is not the example's name or an option is considered
+    #     as a description.
+    #     :option_1: value 1
+    #     :option_2: value 1
+    #     :option_2: value 2
+    #     :boolean_option:
     #   -->
     #   <p>The example's content in <strong>HTML</strong>.</p>
     #
@@ -46,12 +47,12 @@ module Asciidoctor::DocTest
           elsif in_comment
             if line =~ /^\s*:([^:]+):(.*)/
               current[$1.to_sym] = $2.blank? ? true : $2.strip
-            elsif !line.start_with?('//')
+            else
               desc = line.rstrip.chomp('-->').strip
-              (current.desc ||= '').concat(desc, "\n") unless desc.empty?
+              (current.desc ||= '').concat!(desc, "\n") unless desc.empty?
             end
           else
-            current.content.concat(line, "\n")
+            current.content.concat!(line, "\n")
           end
           in_comment &= !line.end_with?('-->')
         end
@@ -60,16 +61,14 @@ module Asciidoctor::DocTest
       end
 
       def serialize(examples)
-        Array.wrap(examples).map { |exmpl|
-          header = [ ".#{exmpl.local_name}", exmpl.desc.presence ].compact
+        Array(examples).map { |exmpl|
+          header = [
+            ".#{exmpl.local_name}",
+            exmpl.desc.presence,
+            *format_options(exmpl.opts)
+          ].compact
 
-          exmpl.opts.each do |name, vals|
-            Array.wrap(vals).each do |val|
-              header << (val == true ? ":#{name}:" : ":#{name}: #{val}")
-            end
-          end
           header_str = header.one? ? (header.first + ' ') : (header.join("\n") + "\n")
-
           [ "<!-- #{header_str}-->", exmpl.content.presence ].compact.join("\n") + "\n"
         }.join("\n")
       end
@@ -79,30 +78,38 @@ module Asciidoctor::DocTest
       end
 
       def convert_example(example, opts, renderer)
+        # The header & footer are excluded by default; always enable for document examples.
         header_footer = !!opts[:header_footer] || example.name.start_with?('document')
 
-        html = renderer.convert(example.content, header_footer: header_footer)
-        html = parse_html(html, !header_footer)
-
-        # When asserting inline examples, ignore paragraph "wrapper".
+        # When asserting inline examples, defaults to ignore paragraph "wrapper".
         includes = opts[:include] || (@paragraph_xpath if example.name.start_with? 'inline_')
 
-        Array.wrap(includes).each do |xpath|
-          # XPath returns NodeSet, but we need DocumentFragment, so convert it again.
-          html = parse_html(html.xpath(xpath).to_html)
-        end
+        renderer.convert(example.content, header_footer: header_footer)
+          .then { |s| parse_html s, !header_footer }
+          .then { |h| find_nodes h, includes }
+          .then { |h| remove_nodes h, opts[:exclude] }
+          .then { |h| h.normalize! }
+          .then { |h| HtmlBeautifier.beautify h }
+          .then { |h| create_example example.name, content: h, opts: opts }
+      end
+
+      protected
 
-        Array.wrap(opts[:exclude]).each do |xpath|
-          html.xpath(xpath).remove
+      def find_nodes(html, xpaths)
+        Array(xpaths).reduce(html) do |htm, xpath|
+          # XPath returns NodeSet, but we need DocumentFragment, so convert it again.
+          parse_html htm.xpath(xpath).to_html
         end
+      end
 
-        html.normalize!
+      def remove_nodes(html, xpaths)
+        return html unless xpaths
 
-        create_example example.name, content: HtmlBeautifier.beautify(html), opts: opts
+        Array(xpaths).each_with_object(html.clone) do |xpath, htm|
+          htm.xpath(xpath).remove
+        end
       end
 
-      private
-
       def parse_html(str, fragment = true)
         fragment ? ::Nokogiri::HTML.fragment(str) : ::Nokogiri::HTML.parse(str)
       end

data/lib/asciidoctor/doctest/html/normalizer.rb

@@ -1,6 +1,8 @@
-require 'active_support/core_ext/object/try'
+require 'corefines'
 require 'nokogiri'
 
+using Corefines::Object::try
+
 module Asciidoctor::DocTest
   module HTML
     ##

data/lib/asciidoctor/doctest/minitest_diffy.rb

@@ -1,6 +1,8 @@
-require 'colorize'
+require 'corefines'
 require 'diffy'
 
+using Corefines::String::color
+
 module Asciidoctor
   module DocTest
     ##
@@ -59,9 +61,9 @@ module Diffy
         when /^\\\s*No newline at end of file/
           # ignore
         when /^\+/
-          line.chomp.sub(/^\+/, 'A' + padding).red
+          line.chomp.sub(/^\+/, 'A' + padding).color(:red)
         when /^-/
-          line.chomp.sub(/^\-/, 'E' + padding).green
+          line.chomp.sub(/^\-/, 'E' + padding).color(:green)
         else
           padding + line.chomp
         end

data/lib/asciidoctor/doctest/test.rb

@@ -1,10 +1,12 @@
-require 'active_support/core_ext/object/blank'
 require 'asciidoctor/doctest/asciidoc_renderer'
-require 'asciidoctor/doctest/core_ext'
 require 'asciidoctor/doctest/minitest_diffy'
 require 'asciidoctor/doctest/asciidoc/examples_suite'
+require 'corefines'
 require 'minitest'
 
+using Corefines::Object[:blank?, :presence]
+using Corefines::Module::alias_class_method
+
 module Asciidoctor
   module DocTest
     ##

data/lib/asciidoctor/doctest/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module DocTest
-    VERSION = '1.5.1.2'
+    VERSION = '1.5.2.0'
   end
 end

data/spec/asciidoc/examples_suite_spec.rb

@@ -1,6 +1,7 @@
-require 'active_support/core_ext/string/strip'
 require 'forwardable'
 
+using Corefines::String::unindent
+
 describe DocTest::Asciidoc::ExamplesSuite do
   extend Forwardable
 
@@ -19,18 +20,23 @@ describe DocTest::Asciidoc::ExamplesSuite do
   end
 
 
-  describe '#parse' do
+  describe 'parsing/serialization:' do
 
     context 'one example' do
 
       shared_examples :example do
-        subject(:parsed) { suite.parse input, 's' }
+        let(:parsed) { suite.parse input, 's' }
+        let(:serialized) { suite.serialize output }
 
-        it { is_expected.to have(1).items }
+        it { expect(parsed).to have(1).items }
 
-        it 'returns an array with parsed Example object' do
+        it 'returns an array with parsed example object' do
           expect(parsed.first).to eql output
         end
+
+        it 'returns a serialized example as string' do
+          expect(serialized).to eql input
+        end
       end
 
       context 'with name only' do
@@ -42,7 +48,7 @@ describe DocTest::Asciidoc::ExamplesSuite do
 
       context 'with multiline content' do
         let :content do
-          <<-EOF.strip_heredoc
+          <<-EOF.unindent
             Paragraphs don't require
             any special markup.
 
@@ -58,7 +64,7 @@ describe DocTest::Asciidoc::ExamplesSuite do
 
       context 'with description' do
         let :input do
-          <<-EOF.strip_heredoc
+          <<-EOF.unindent
             // .strong
             // This is a description,
             // see?
@@ -73,11 +79,50 @@ describe DocTest::Asciidoc::ExamplesSuite do
 
         include_examples :example
       end
+
+      context 'with options' do
+        let :input do
+          <<-EOF.unindent
+            // .basic
+            // :exclude: /^=+.*/
+            // :exclude: /^#+.*/
+            // :include: /^----\\n(.*)\\n----/m
+            // :header_footer:
+            _dummy_
+          EOF
+        end
+
+        let :output do
+          create_example 's:basic', content: '_dummy_', opts: {
+            exclude: ['/^=+.*/', '/^#+.*/'],
+            include: ['/^----\\n(.*)\\n----/m'],
+            header_footer: true
+          }
+        end
+        include_examples :example
+      end
+
+      context 'with description and options' do
+        let :input do
+          <<-EOF.unindent
+            // .basic
+            // This is a description.
+            // :exclude: /^=+.*/
+          EOF
+        end
+
+        let :output do
+          create_example 's:basic', desc: 'This is a description.', opts: {
+            exclude: ['/^=+.*/']
+          }
+        end
+        include_examples :example
+      end
     end
 
     context 'multiple examples' do
       let :input do
-        <<-EOF.strip_heredoc
+        <<-EOF.unindent
           // .basic
           http://asciidoctor.org
 

data/spec/base_example_spec.rb

@@ -163,6 +163,8 @@ describe DocTest::BaseExample do
   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

data/spec/html/examples_suite_spec.rb

@@ -1,4 +1,6 @@
-require 'active_support/core_ext/string/strip'
+require 'forwardable'
+
+using Corefines::String::unindent
 
 describe DocTest::HTML::ExamplesSuite do
   extend Forwardable
@@ -46,7 +48,7 @@ describe DocTest::HTML::ExamplesSuite do
 
       context 'with multiline content' do
         let :content do
-          <<-EOF.strip_heredoc
+          <<-EOF.unindent
             <p>Paragraphs don't require
             any special markup.</p>
 
@@ -62,7 +64,7 @@ describe DocTest::HTML::ExamplesSuite do
 
       context 'with description' do
         let :input do
-          <<-EOF.strip_heredoc
+          <<-EOF.unindent
             <!-- .strong
             This is a description,
             see?
@@ -80,11 +82,12 @@ describe DocTest::HTML::ExamplesSuite do
 
       context 'with options' do
         let :input do
-          <<-EOF.strip_heredoc
+          <<-EOF.unindent
             <!-- .basic
             :exclude: .//code
             :exclude: .//section
             :include: ./p/node()
+            :header_footer:
             -->
             <p>dummy</p>
           EOF
@@ -93,34 +96,26 @@ describe DocTest::HTML::ExamplesSuite do
         let :output do
           create_example 's:basic', content: '<p>dummy</p>', opts: {
             exclude: ['.//code', './/section'],
-            include: ['./p/node()']
+            include: ['./p/node()'],
+            header_footer: true
           }
         end
         include_examples :example
       end
 
-      context 'with boolean option' do
-        let(:input) { "<!-- .basic\n:header_footer:\n-->\n" }
-        let(:output) { create_example 's:basic', opts: { header_footer: true } }
-
-        include_examples :example
-      end
-
       context 'with description and options' do
         let :input do
-          <<-EOF.strip_heredoc
+          <<-EOF.unindent
             <!-- .basic
             This is a description.
             :exclude: .//code
-            :header_footer:
             -->
           EOF
         end
 
         let :output do
           create_example 's:basic', desc: 'This is a description.', opts: {
-            exclude: ['.//code'],
-            header_footer: true
+            exclude: ['.//code']
           }
         end
         include_examples :example
@@ -129,7 +124,7 @@ describe DocTest::HTML::ExamplesSuite do
 
     context 'multiple examples' do
       let :input do
-        <<-EOF.strip_heredoc
+        <<-EOF.unindent
           <!-- .basic -->
           http://asciidoctor.org
 

data/spec/minitest_diffy_spec.rb

@@ -1,5 +1,7 @@
-require 'active_support/core_ext/string/strip'
 require 'asciidoctor/doctest/minitest_diffy'
+require 'corefines'
+
+using Corefines::String::color
 
 describe Diffy::Format do
 
@@ -34,7 +36,7 @@ describe Diffy::Format do
       let(:input) { ['+ <div><p>chunky bacon</p></div>'] }
 
       it 'replaces "+" with "A", adds padding and colour' do
-        is_expected.to eq "\n" + 'A   <div><p>chunky bacon</p></div>'.red
+        is_expected.to eq "\n" + 'A   <div><p>chunky bacon</p></div>'.color(:red)
       end
     end
 
@@ -42,7 +44,7 @@ describe Diffy::Format do
       let(:input) { ['- <p>chunky bacon</p>'] }
 
       it 'replaces "-" with "E", adds padding and colour' do
-        is_expected.to eq "\n" + 'E   <p>chunky bacon</p>'.green
+        is_expected.to eq "\n" + 'E   <p>chunky bacon</p>'.color(:green)
       end
     end
 

data/spec/shared_examples/base_examples_suite.rb

@@ -1,7 +1,8 @@
-require 'active_support/core_ext/array/access'
 require 'fileutils'
 require 'forwardable'
 
+using Corefines::Array::second
+
 shared_examples DocTest::BaseExamplesSuite do
   extend Forwardable
 
@@ -253,6 +254,33 @@ shared_examples DocTest::BaseExamplesSuite do
   end
 
 
+  describe '#format_options' do
+
+    shared_examples :format_options do |input, output|
+      it "returns #{output} for #{input}" do
+        expect(suite.send(:format_options, input)).to eq output
+      end
+    end
+
+    context 'empty' do
+      include_examples :format_options, {}, []
+    end
+
+    context 'options with one value' do
+      include_examples :format_options, {opt1: 'val1', opt2: 'val2'}, [':opt1: val1', ':opt2: val2']
+    end
+
+    context 'options with multiple values' do
+      include_examples :format_options, {opt1: %w[val11 val12], opt2: ['val2']},
+                       [':opt1: val11', ':opt1: val12', ':opt2: val2']
+    end
+
+    context 'boolean options' do
+      include_examples :format_options, {opt1: true, opt2: false}, [':opt1:', ':opt2: false']
+    end
+  end
+
+
   def create_and_write_group(path, group_name, file_ext, *examples)
     content = [path, group_name + file_ext, *examples].join("\n")
     File.write File.join(path, group_name + file_ext), content

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
+require 'corefines'
 require 'rspec/collection_matchers'
 require 'simplecov'
 require 'asciidoctor/doctest'
+require 'fakefs/spec_helpers'
 
 Dir['./spec/{shared_examples,support}/**/*.rb'].each { |file| require file }
 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-doctest
 version: !ruby/object:Gem::Version
-  version: 1.5.1.2
+  version: 1.5.2.0
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-03 00:00:00.000000000 Z
+date: 2015-04-03 00:00:00.000000000 Z
 dependencies:
-- !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
@@ -39,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.5.0
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: corefines
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.11
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.11
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -114,20 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.3
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: 1.6.0
   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
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -156,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -190,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.6.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.6.4
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -357,12 +351,10 @@ files:
 - 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
@@ -370,13 +362,11 @@ files:
 - spec/asciidoc/examples_suite_spec.rb
 - spec/asciidoc_renderer_spec.rb
 - spec/base_example_spec.rb
-- spec/core_ext_spec.rb
 - spec/html/examples_suite_spec.rb
 - spec/html/normalizer_spec.rb
 - spec/minitest_diffy_spec.rb
 - spec/shared_examples/base_examples_suite.rb
 - spec/spec_helper.rb
-- spec/support/fakefs.rb
 - spec/support/matchers.rb
 - spec/test_spec.rb
 homepage: https://github.com/asciidoctor/asciidoctor-doctest
@@ -399,7 +389,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Test suite for Asciidoctor backends
@@ -425,13 +415,11 @@ test_files:
 - spec/asciidoc/examples_suite_spec.rb
 - spec/asciidoc_renderer_spec.rb
 - spec/base_example_spec.rb
-- spec/core_ext_spec.rb
 - spec/html/examples_suite_spec.rb
 - spec/html/normalizer_spec.rb
 - spec/minitest_diffy_spec.rb
 - spec/shared_examples/base_examples_suite.rb
 - spec/spec_helper.rb
-- spec/support/fakefs.rb
 - spec/support/matchers.rb
 - spec/test_spec.rb
 has_rdoc: yard

data/lib/asciidoctor/doctest/core_ext.rb

@@ -1,64 +0,0 @@
-module Enumerable
-
-  ##
-  # Sends a message to each element and collects the result.
-  #
-  # @example
-  #   [1, 2, 3].map_send(:+, 3) #=> [4, 5, 6]
-  #
-  # @param method_name [Symbol] name of the public method to call.
-  # @param args arguments to pass to the method.
-  # @param block [Proc] block to pass to the method.
-  # @return [Enumerable]
-  #
-  def map_send(method_name, *args, &block)
-    map { |e| e.public_send(method_name, *args, &block) }
-  end
-end
-
-class Module
-
-  ##
-  # Makes +new_name+ a new copy of the class method +old_name+.
-  #
-  # @param new_name [Symbol] name of the new class method to create.
-  # @param old_name [Symbol] name of the existing class method to alias.
-  #
-  def alias_class_method(new_name, old_name)
-    singleton_class.send(:alias_method, new_name, old_name)
-  end
-end
-
-class String
-
-  ##
-  # Appends (concatenates) the given object to +str+.
-  #
-  # @param obj [String, Integer] the string, or codepoint to append.
-  # @param separator [String, nil] the separator to append when this +str+ is
-  #        not empty.
-  # @return [String] self
-  #
-  def concat(obj, separator = nil)
-    if separator && !self.empty?
-      self << separator << obj
-    else
-      self << obj
-    end
-  end
-end
-
-
-# Workarounds for JRuby.
-if RUBY_ENGINE == 'jruby'
-  require 'delegate'
-
-  # @private
-  class SimpleDelegator
-
-    # https://github.com/jruby/jruby/issues/2412
-    def warn(*msg)
-      Kernel.warn(*msg)
-    end
-  end
-end

data/lib/asciidoctor/doctest/html/html_beautifier.rb

@@ -1,17 +0,0 @@
-require 'htmlbeautifier'
-
-module HtmlBeautifier
-
-  ##
-  # Beautifies the +input+ HTML.
-  #
-  # @param input [String, #to_html]
-  # @return [String] a beautified copy of the +input+.
-  #
-  def self.beautify(input)
-    input = input.to_html unless input.is_a? String
-    output = []
-    Beautifier.new(output).scan(input)
-    output.join
-  end
-end

data/spec/core_ext_spec.rb

@@ -1,67 +0,0 @@
-describe Enumerable do
-
-  describe '#map_send' do
-
-    it 'sends a message to each element and collects the result' do
-      expect([1, 2, 3].map_send(:+, 3)).to eq [4, 5, 6]
-    end
-  end
-end
-
-describe String do
-
-  describe '#concat' do
-
-    context 'without separator' do
-      subject { 'foo' }
-
-      it 'appends the given string to self' do
-        subject.concat 'bar'
-        is_expected.to eq 'foobar'
-      end
-    end
-
-    context 'with separator' do
-
-      context 'when self is empty' do
-        subject { '' }
-
-        it 'appends the given string to self' do
-          subject.concat 'bar', "\n"
-          is_expected.to eq 'bar'
-        end
-      end
-
-      context 'when self is not empty' do
-        subject { 'foo' }
-
-        it 'appends the given separator and string to self' do
-          subject.concat 'bar', "\n"
-          is_expected.to eq "foo\nbar"
-        end
-      end
-    end
-  end
-end
-
-
-describe Module do
-
-  describe '#alias_class_method' do
-
-    subject(:klass) do
-      Class.new do
-        def self.salute
-          'Meow!'
-        end
-      end
-    end
-
-    it 'defines new class method that calls the old class method' do
-      klass.alias_class_method :say_hello!, :salute
-
-      expect(klass).to respond_to :say_hello!
-      expect(klass.say_hello!).to eq klass.salute
-    end
-  end
-end

data/spec/support/fakefs.rb

@@ -1,19 +0,0 @@
-require 'fakefs/spec_helpers'
-
-module FakeFS
-  # XXX remove after merging of https://github.com/defunkt/fakefs/pull/270
-  module FileTest
-
-    def readable?(file_name)
-      File.readable?(file_name)
-    end
-    module_function :readable?
-  end
-
-  # XXX remove after merging of https://github.com/defunkt/fakefs/pull/269
-  class Pathname
-    def read(*args)
-      File.read(@path, *args)
-    end
-  end
-end