asciidoctor-doctest 1.5.2.0 → 2.0.0.beta.1

data/features/fixtures/html-slim/test/html_test.rb

@@ -1,6 +0,0 @@
-require 'test_helper'
-
-class TestHtml < DocTest::Test
-  converter_opts template_dirs: 'templates'
-  generate_tests! DocTest::HTML::ExamplesSuite
-end

data/features/fixtures/html-slim/test/test_helper.rb

@@ -1,5 +0,0 @@
-require 'asciidoctor/doctest'
-require 'minitest/autorun'
-require 'tilt'
-
-DocTest.examples_path = ['examples/html', 'examples/asciidoc']

data/lib/asciidoctor/doctest/asciidoc_renderer.rb

@@ -1,111 +0,0 @@
-require 'asciidoctor'
-require 'asciidoctor/converter/template'
-require 'corefines'
-require 'delegate'
-
-using Corefines::Object[:blank?, :presence]
-
-module Asciidoctor
-  module DocTest
-    ##
-    # This class is basically a wrapper for +Asciidoctor.convert+ that allows to
-    # preset and validate some common parameters.
-    class AsciidocRenderer
-
-      attr_reader :backend_name, :converter, :template_dirs
-
-      ##
-      # @param backend_name [#to_s, nil] the name of the tested backend.
-      #
-      # @param converter [Class, Asciidoctor::Converter::Base, nil]
-      #        the backend's converter class (or its instance). If not
-      #        specified, the default converter for the specified backend will
-      #        be used.
-      #
-      # @param template_dirs [Array<String>, String] path of the directory (or
-      #        multiple directories) where to look for the backend's templates.
-      #        Relative paths are referenced from the working directory.
-      #
-      # @param templates_fallback [Boolean] allow to fall back to using an
-      #        appropriate built-in converter when there is no required
-      #        template in the tested backend?
-      #        This is actually a default behaviour in Asciidoctor, but since
-      #        it's inappropriate for testing of custom backends, it's disabled
-      #        by default.
-      #
-      # @raise [ArgumentError] if some path from the +template_dirs+ doesn't
-      #        exist or is not a directory.
-      #
-      def initialize(backend_name: nil, converter: nil, template_dirs: [],
-                     templates_fallback: false)
-
-        @backend_name = backend_name.to_s.freeze.presence
-        @converter = converter
-        @converter ||= NoFallbackTemplateConverter unless template_dirs.empty? || templates_fallback
-
-        template_dirs = Array(template_dirs).freeze
-        template_dirs.each do |path|
-          fail ArgumentError, "Templates directory '#{path}' doesn't exist!" unless Dir.exist? path
-        end
-        @template_dirs = template_dirs unless template_dirs.empty?
-      end
-
-      ##
-      # Converts the given +text+ into AsciiDoc syntax with Asciidoctor using
-      # the tested backend.
-      #
-      # @param text [#to_s] the input text in AsciiDoc syntax.
-      # @param opts [Hash] options to pass to Asciidoctor.
-      # @return [String] converted input.
-      #
-      def convert(text, opts = {})
-        converter_opts = {
-          safe: :safe,
-          backend: backend_name,
-          converter: converter,
-          template_dirs: template_dirs
-        }.merge(opts)
-
-        Asciidoctor.convert(text.to_s, converter_opts)
-      end
-
-      # Alias for backward compatibility.
-      alias_method :render, :convert
-    end
-
-    ##
-    # @private
-    # TemplateConverter that doesn't fallback to a built-in converter when
-    # no template for a node is found.
-    class NoFallbackTemplateConverter < SimpleDelegator
-      # NOTE: It didn't work with subclass of TemplateConverter instead of
-      # delegator, I have no idea why.
-
-      # Placeholder to be written in a rendered output in place of the node's
-      # content that cannot be rendered due to missing template.
-      NOT_FOUND_MARKER = '--TEMPLATE NOT FOUND--'
-
-      def initialize(backend, opts = {})
-        super Asciidoctor::Converter::TemplateConverter.new(backend, opts[:template_dirs], opts)
-      end
-
-      ##
-      # Delegates to the template converter and returns results, or prints
-      # warning and returns {NOT_FOUND_MARKER} if there is no template to
-      # handle the specified +template_name+.
-      def convert(node, template_name = nil, opts = {})
-        template_name ||= node.node_name
-
-        if handles? template_name
-          super
-        else
-          warn "Could not find a custom template to handle template_name: #{template_name}"
-          NOT_FOUND_MARKER
-        end
-      end
-
-      # Alias for backward compatibility.
-      alias_method :convert_with_options, :convert
-    end
-  end
-end

data/lib/asciidoctor/doctest/generator_task.rb

@@ -1,115 +0,0 @@
-require 'asciidoctor/doctest/generator'
-require 'corefines'
-require 'rake/tasklib'
-
-using Corefines::String::unindent
-
-module Asciidoctor
-  module DocTest
-    ##
-    # Rake task for generating output examples.
-    # @see Generator
-    class GeneratorTask < Rake::TaskLib
-
-      # List of values representing +true+.
-      TRUE_VALUES = %w[yes y true]
-
-      # This attribute is used only for the default {#input_suite}.
-      # @return (see DocTest.examples_path)
-      attr_accessor :examples_path
-
-      # @return [Boolean] whether to rewrite an already existing testing
-      #   example. May be overriden with +FORCE+ variable on the command line
-      #   (default: false).
-      attr_accessor :force
-
-      # @return [BaseExamplesSuite] an instance of {BaseExamplesSuite} subclass
-      #         to read the reference input examples
-      #         (default: +Asciidoc::ExamplesSuite.new(examples_path: examples_path)+).
-      attr_accessor :input_suite
-
-      # @return [BaseExamplesSuite] an instance of {BaseExamplesSuite} subclass
-      #         to read and generate the output examples.
-      attr_accessor :output_suite
-
-      # @return [#to_sym] name of the task.
-      attr_accessor :name
-
-      # @return [String] glob pattern to select examples to (re)generate.
-      #   May be overriden with +PATTERN+ variable on the command line
-      #   (default: *:*).
-      attr_accessor :pattern
-
-      # @return [Hash] options for Asciidoctor converter.
-      # @see AsciidocRenderer#initialize
-      attr_accessor :converter_opts
-
-      # @return [String] title of the task's description.
-      attr_accessor :title
-
-      # Alias for backward compatibility.
-      alias_method :renderer_opts, :converter_opts
-
-
-      ##
-      # @param name [#to_sym] name of the task.
-      # @yield The block to configure this task.
-      def initialize(name)
-        @name = name
-        @examples_path = DocTest.examples_path.dup
-        @force = false
-        @input_suite = nil
-        @output_suite = nil
-        @converter_opts = {}
-        @pattern = '*:*'
-        @title = "Generate testing examples #{pattern}#{" for #{name}" if name != :generate}."
-
-        yield self
-
-        fail 'The output_suite is not provided!' unless @output_suite
-        if @output_suite.examples_path.first == DocTest::BUILTIN_EXAMPLES_PATH
-          fail "The examples_path in output suite is invalid: #{@output_suite.examples_path}"
-        end
-
-        @input_suite ||= Asciidoc::ExamplesSuite.new(examples_path: @examples_path)
-        @renderer ||= AsciidocRenderer.new(converter_opts)
-
-        define
-      end
-
-      def pattern
-        ENV['PATTERN'] || @pattern
-      end
-
-      def force?
-        return TRUE_VALUES.include?(ENV['FORCE'].downcase) if ENV.key? 'FORCE'
-        !!force
-      end
-
-      private
-
-      def define
-        desc description
-
-        task name.to_sym do
-          puts title
-          Generator.generate! output_suite, input_suite, @renderer,
-                              pattern: pattern, rewrite: force?
-        end
-        self
-      end
-
-      def description
-        <<-EOS.unindent
-          #{title}
-
-          Options (environment variables):
-            PATTERN   glob pattern to select examples to (re)generate. [default: #{@pattern}]
-                      E.g. *:*, block_toc:basic, block*:*, *list:with*, ...
-            FORCE     overwrite existing examples (yes/no)? [default: #{@force ? 'yes' : 'no'}]
-
-        EOS
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-require 'asciidoctor/doctest/base_example'
-require 'asciidoctor/doctest/html/normalizer'
-require 'htmlbeautifier'
-require 'nokogiri'
-
-module Asciidoctor::DocTest
-  module HTML
-    ##
-    # Subclass of {BaseExample} for HTML-based backends.
-    class Example < BaseExample
-
-      def content_normalized
-        Nokogiri::HTML.fragment(content).normalize!.to_s
-      end
-
-      def content_pretty
-        HtmlBeautifier.beautify content_normalized
-      end
-    end
-  end
-end

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

@@ -1,118 +0,0 @@
-require 'asciidoctor/doctest/base_examples_suite'
-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
-    ##
-    # Subclass of {BaseExamplesSuite} for HTML-based backends.
-    #
-    # @example Format of the example's header
-    #   <!-- .example-name
-    #     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>
-    #
-    #   <div class="note">The trailing new line (below this) will be removed.</div>
-    #
-    class ExamplesSuite < BaseExamplesSuite
-
-      def initialize(file_ext: '.html', paragraph_xpath: './p/node()', **kwargs)
-        super file_ext: file_ext, **kwargs
-        @paragraph_xpath = paragraph_xpath
-      end
-
-      def parse(input, group_name)
-        examples = []
-        current = create_example(nil)
-        in_comment = false
-
-        input.each_line do |line|
-          line.chomp!
-          if line =~ /^<!--\s*\.([^ \n]+)/
-            name = $1
-            current.content.chomp!
-            examples << (current = create_example([group_name, name]))
-            in_comment = true
-          elsif in_comment
-            if line =~ /^\s*:([^:]+):(.*)/
-              current[$1.to_sym] = $2.blank? ? true : $2.strip
-            else
-              desc = line.rstrip.chomp('-->').strip
-              (current.desc ||= '').concat!(desc, "\n") unless desc.empty?
-            end
-          else
-            current.content.concat!(line, "\n")
-          end
-          in_comment &= !line.end_with?('-->')
-        end
-
-        examples
-      end
-
-      def serialize(examples)
-        Array(examples).map { |exmpl|
-          header = [
-            ".#{exmpl.local_name}",
-            exmpl.desc.presence,
-            *format_options(exmpl.opts)
-          ].compact
-
-          header_str = header.one? ? (header.first + ' ') : (header.join("\n") + "\n")
-          [ "<!-- #{header_str}-->", exmpl.content.presence ].compact.join("\n") + "\n"
-        }.join("\n")
-      end
-
-      def create_example(*args)
-        Example.new(*args)
-      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')
-
-        # When asserting inline examples, defaults to ignore paragraph "wrapper".
-        includes = opts[:include] || (@paragraph_xpath if example.name.start_with? 'inline_')
-
-        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
-
-      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
-
-      def remove_nodes(html, xpaths)
-        return html unless xpaths
-
-        Array(xpaths).each_with_object(html.clone) do |xpath, htm|
-          htm.xpath(xpath).remove
-        end
-      end
-
-      def parse_html(str, fragment = true)
-        fragment ? ::Nokogiri::HTML.fragment(str) : ::Nokogiri::HTML.parse(str)
-      end
-    end
-  end
-end

data/lib/asciidoctor/doctest/test.rb

@@ -1,125 +0,0 @@
-require 'asciidoctor/doctest/asciidoc_renderer'
-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
-    ##
-    # Test class for Asciidoctor backends.
-    class Test < Minitest::Test
-      include MinitestDiffy
-
-      ##
-      # (see AsciidocRenderer#initialize)
-      def self.converter_opts(**kwargs)
-        @renderer = AsciidocRenderer.new(**kwargs)
-      end
-
-      # Alias for backward compatibility.
-      alias_class_method :renderer_opts, :converter_opts
-
-      ##
-      # Generates tests for all the input/output examples.
-      # When some output example is missing, it's reported as skipped test.
-      #
-      # @param output_suite [BaseExamplesSuite, Class] the examples suite class
-      #        (or its instance) to read the output examples from (i.e. an
-      #        expected output).
-      # @param input_suite [BaseExamplesSuite, Class] the examples suite class
-      #        (or its instance) to read the reference input examples from.
-      #
-      # If class is given, then it's instantiated with zero arguments.
-      #
-      def self.generate_tests!(output_suite, input_suite = Asciidoc::ExamplesSuite)
-        instance = ->(o) { o.is_a?(Class) ? o.new : o }
-        @output_suite = instance[output_suite]
-        @input_suite  = instance[input_suite]
-
-        @input_suite.pair_with(@output_suite).each do |input, output|
-          next if input.empty?
-
-          define_test input.name do
-            if output.empty?
-              skip 'No expected output found'
-            else
-              test_example output, input
-            end
-          end
-        end
-      end
-
-      ##
-      # Defines a new test method.
-      #
-      # @param name [String] name of the test (method).
-      # @param block [Proc] the test method's body.
-      #
-      def self.define_test(name, &block)
-        (@test_methods ||= []) << name
-        define_method name, block
-      end
-
-      ##
-      # @!method self.test
-      #   @see .define_test
-      alias_class_method :test, :define_test
-
-      ##
-      # @private
-      # @note Overrides method from +Minitest::Test+.
-      # @return [Array] names of the test methods to run.
-      def self.runnable_methods
-        (@test_methods || []) + super - ['test_example']
-      end
-
-      ##
-      # Tests if the given reference input is matching the expected output
-      # after conversion through the tested backend.
-      #
-      # @param output_exmpl [BaseExample] the expected output example.
-      # @param input_exmpl [BaseExample] the reference input example.
-      # @raise [Minitest::Assertion] if the assertion fails.
-      #
-      def test_example(output_exmpl, input_exmpl)
-        converted_exmpl = output_suite.convert_example(input_exmpl, output_exmpl.opts, renderer)
-        msg = output_exmpl.desc.presence || input_exmpl.desc
-
-        assert_equal output_exmpl, converted_exmpl, msg
-      end
-
-      ##
-      # @private
-      # @note Overrides method from +Minitest::Test+.
-      # @return [String] name of this test that will be printed in a report.
-      def location
-        prefix = self.class.name.split('::').last
-        name = self.name.sub(':', ' : ')
-        "#{prefix} :: #{name}"
-      end
-
-      ##
-      # @private
-      # Returns a human-readable (formatted) version of the asserted object.
-      #
-      # @note Overrides method from +Minitest::Assertions+.
-      #
-      # @param example [#to_s]
-      # @return [String]
-      #
-      def mu_pp(example)
-        example.to_s
-      end
-
-      [:input_suite, :output_suite, :renderer].each do |name|
-        define_method name do
-          self.class.instance_variable_get(:"@#{name}")
-        end
-      end
-    end
-  end
-end