asciidoctor 0.1.4 → 1.5.0

data/test/extensions_test.rb

@@ -1,7 +1,14 @@
-require 'test_helper'
+# encoding: UTF-8
+unless defined? ASCIIDOCTOR_PROJECT_DIR
+  $: << File.dirname(__FILE__); $:.uniq!
+  require 'test_helper'
+end
 require 'asciidoctor/extensions'
 
 class SamplePreprocessor < Asciidoctor::Extensions::Preprocessor
+  def process doc, reader
+    nil
+  end
 end
 
 class SampleIncludeProcessor < Asciidoctor::Extensions::IncludeProcessor
@@ -23,12 +30,14 @@ class SampleInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
 end
 
 class ScrubHeaderPreprocessor < Asciidoctor::Extensions::Preprocessor
-  def process reader, lines
+  def process doc, reader
+    lines = reader.lines
+    skipped = []
     while !lines.empty? && !lines.first.start_with?('=')
-      lines.shift
+      skipped << lines.shift
       reader.advance
     end
-    #lines
+    doc.set_attr 'skipped', (skipped * "\n")
     reader
   end
 end
@@ -38,7 +47,7 @@ class BoilerplateTextIncludeProcessor < Asciidoctor::Extensions::IncludeProcesso
     target.end_with? '.txt'
   end
 
-  def process reader, target, attributes
+  def process document, reader, target, attributes
     case target
     when 'lorem-ipsum.txt'
       content = ["Lorem ipsum dolor sit amet...\n"]
@@ -50,84 +59,109 @@ class BoilerplateTextIncludeProcessor < Asciidoctor::Extensions::IncludeProcesso
 end
 
 class ReplaceAuthorTreeprocessor < Asciidoctor::Extensions::Treeprocessor
-  def process
-    @document.attributes['firstname'] = 'Ghost'
-    @document.attributes['author'] = 'Ghost Writer'
+  def process document
+    document.attributes['firstname'] = 'Ghost'
+    document.attributes['author'] = 'Ghost Writer'
+    document
+  end
+end
+
+class ReplaceTreeTreeprocessor < Asciidoctor::Extensions::Treeprocessor
+  def process document
+    if document.doctitle == 'Original Document'
+      Asciidoctor.load %(== Replacement Document\nReplacement Author\n\ncontent)
+    else
+      document
+    end
   end
 end
 
 class StripAttributesPostprocessor < Asciidoctor::Extensions::Postprocessor
-  def process output
+  def process document, output
     output.gsub(/<(\w+).*?>/m, "<\\1>")
   end
 end
 
-class UppercaseBlock < Asciidoctor::Extensions::BlockProcessor
+class UppercaseBlock < Asciidoctor::Extensions::BlockProcessor; use_dsl
+  match_name :yell
+  on_contexts :paragraph
+  parse_content_as :simple
   def process parent, reader, attributes
-    Asciidoctor::Block.new parent, :paragraph, :source => reader.lines.map {|line| line.upcase }
+    create_paragraph parent, reader.lines.map(&:upcase), attributes
   end
 end
 
 class SnippetMacro < Asciidoctor::Extensions::BlockMacroProcessor
   def process parent, target, attributes
-    Asciidoctor::Block.new parent, :pass, :content_model => :raw, :source => %(<script src="http://example.com/#{target}.js"></script>)
+    create_pass_block parent, %(<script src="http://example.com/#{target}.js"></script>), {}, :content_model => :raw
   end
 end
 
-class TemperatureMacro < Asciidoctor::Extensions::InlineMacroProcessor
+class TemperatureMacro < Asciidoctor::Extensions::InlineMacroProcessor; use_dsl
+  named :degrees
+  name_attributes 'units'
   def process parent, target, attributes
-    temperature_unit = @document.attr('temperature-unit', 'C')
+    units = attributes['units'] || (parent.document.attr 'temperature-unit', 'C')
     c = target.to_f
-    if temperature_unit == 'C'
-      text = %(#{c} &#176;C)
-    elsif temperature_unit == 'F'
-      f = c * 1.8 + 32 
-      text = %(#{f} &#176;F)
+    case units
+    when 'C'
+      %(#{c} &#176;C)
+    when 'F'
+      %(#{c * 1.8 + 32 } &#176;F)
     else
-      text = target
+      c
     end
-
-    text
   end
 end
 
-class SampleExtension < Asciidoctor::Extensions::Extension
-  def self.activate(registry, document)
-    document.attributes['activate-method-called'] = ''
+class SampleExtensionGroup < Asciidoctor::Extensions::Group
+  def activate registry
+    registry.document.attributes['activate-method-called'] = ''
     registry.preprocessor SamplePreprocessor
   end
 end
 
 context 'Extensions' do
   context 'Register' do
-    test 'should register extension class' do
+    test 'should register extension group class' do
       begin
-        Asciidoctor::Extensions.register SampleExtension
-        assert_not_nil Asciidoctor::Extensions.registered
-        assert_equal 1, Asciidoctor::Extensions.registered.size
-        assert_equal SampleExtension, Asciidoctor::Extensions.registered.first
+        Asciidoctor::Extensions.register :sample, SampleExtensionGroup
+        refute_nil Asciidoctor::Extensions.groups
+        assert_equal 1, Asciidoctor::Extensions.groups.size
+        assert_equal SampleExtensionGroup, Asciidoctor::Extensions.groups[:sample]
       ensure
         Asciidoctor::Extensions.unregister_all
       end
     end
 
-    test 'should be able to self register extension class' do
+    test 'should self register extension group class' do
       begin
-        SampleExtension.register
-        assert_not_nil Asciidoctor::Extensions.registered
-        assert_equal 1, Asciidoctor::Extensions.registered.size
-        assert_equal SampleExtension, Asciidoctor::Extensions.registered.first
+        SampleExtensionGroup.register :sample
+        refute_nil Asciidoctor::Extensions.groups
+        assert_equal 1, Asciidoctor::Extensions.groups.size
+        assert_equal SampleExtensionGroup, Asciidoctor::Extensions.groups[:sample]
       ensure
         Asciidoctor::Extensions.unregister_all
       end
     end
 
-    test 'should register extension class from string' do
+    test 'should register extension group from class name' do
       begin
-        Asciidoctor::Extensions.register 'SampleExtension'
-        assert_not_nil Asciidoctor::Extensions.registered
-        assert_equal 1, Asciidoctor::Extensions.registered.size
-        assert_equal SampleExtension, Asciidoctor::Extensions.registered.first
+        Asciidoctor::Extensions.register :sample, 'SampleExtensionGroup'
+        refute_nil Asciidoctor::Extensions.groups
+        assert_equal 1, Asciidoctor::Extensions.groups.size
+        assert_equal SampleExtensionGroup, Asciidoctor::Extensions.groups[:sample]
+      ensure
+        Asciidoctor::Extensions.unregister_all
+      end
+    end
+
+    test 'should register extension group from instance' do
+      begin
+        Asciidoctor::Extensions.register :sample, SampleExtensionGroup.new
+        refute_nil Asciidoctor::Extensions.groups
+        assert_equal 1, Asciidoctor::Extensions.groups.size
+        assert Asciidoctor::Extensions.groups[:sample].is_a? SampleExtensionGroup
       ensure
         Asciidoctor::Extensions.unregister_all
       end
@@ -135,11 +169,11 @@ context 'Extensions' do
 
     test 'should register extension block' do
       begin
-        Asciidoctor::Extensions.register do |document|
+        Asciidoctor::Extensions.register(:sample) do
         end
-        assert_not_nil Asciidoctor::Extensions.registered
-        assert_equal 1, Asciidoctor::Extensions.registered.size
-        assert Asciidoctor::Extensions.registered.first.is_a?(Proc)
+        refute_nil Asciidoctor::Extensions.groups
+        assert_equal 1, Asciidoctor::Extensions.groups.size
+        assert Asciidoctor::Extensions.groups[:sample].is_a? Proc
       ensure
         Asciidoctor::Extensions.unregister_all
       end
@@ -147,26 +181,26 @@ context 'Extensions' do
 
     test 'should get class for top-level class name' do
       clazz = Asciidoctor::Extensions.class_for_name('Asciidoctor')
-      assert_not_nil clazz
+      refute_nil clazz
       assert_equal Asciidoctor, clazz
     end
 
     test 'should get class for class name in module' do
       clazz = Asciidoctor::Extensions.class_for_name('Asciidoctor::Extensions')
-      assert_not_nil clazz
+      refute_nil clazz
       assert_equal Asciidoctor::Extensions, clazz
     end
 
     test 'should get class for class name resolved from root' do
       clazz = Asciidoctor::Extensions.class_for_name('::Asciidoctor::Extensions')
-      assert_not_nil clazz
+      refute_nil clazz
       assert_equal Asciidoctor::Extensions, clazz
     end
 
     test 'should raise exception if cannot find class for name' do
       begin
-      Asciidoctor::Extensions.class_for_name('InvalidModule::InvalidClass')
-      flunk 'Expecting RuntimeError to be raised'
+        Asciidoctor::Extensions.class_for_name('InvalidModule::InvalidClass')
+        flunk 'Expecting RuntimeError to be raised'
       rescue RuntimeError => e
         assert_equal 'Could not resolve class for name: InvalidModule::InvalidClass', e.message
       end
@@ -174,23 +208,24 @@ context 'Extensions' do
 
     test 'should resolve class if class is given' do
       clazz = Asciidoctor::Extensions.resolve_class(Asciidoctor::Extensions)
-      assert_not_nil clazz
+      refute_nil clazz
       assert_equal Asciidoctor::Extensions, clazz
     end
 
     test 'should resolve class if class from string' do
       clazz = Asciidoctor::Extensions.resolve_class('Asciidoctor::Extensions')
-      assert_not_nil clazz
+      refute_nil clazz
       assert_equal Asciidoctor::Extensions, clazz
     end
   end
 
   context 'Activate' do
-    test 'should call activate on extension class' do
+    test 'should call activate on extension group class' do
       begin
         doc = Asciidoctor::Document.new
-        Asciidoctor::Extensions.register SampleExtension
-        registry = Asciidoctor::Extensions::Registry.new doc
+        Asciidoctor::Extensions.register :sample, SampleExtensionGroup
+        registry = Asciidoctor::Extensions::Registry.new
+        registry.activate doc
         assert doc.attr? 'activate-method-called'
         assert registry.preprocessors?
       ensure
@@ -201,11 +236,12 @@ context 'Extensions' do
     test 'should invoke extension block' do
       begin
         doc = Asciidoctor::Document.new
-        Asciidoctor::Extensions.register do |document|
-          document.attributes['block-called'] = ''
+        Asciidoctor::Extensions.register do
+          @document.attributes['block-called'] = ''
           preprocessor SamplePreprocessor
         end
-        registry = Asciidoctor::Extensions::Registry.new doc
+        registry = Asciidoctor::Extensions::Registry.new
+        registry.activate doc
         assert doc.attr? 'block-called'
         assert registry.preprocessors?
       ensure
@@ -215,7 +251,7 @@ context 'Extensions' do
 
     test 'should create registry in Document if extensions are loaded' do
       begin
-        SampleExtension.register
+        SampleExtensionGroup.register
         doc = Asciidoctor::Document.new
         assert doc.extensions?
         assert doc.extensions.is_a? Asciidoctor::Extensions::Registry
@@ -230,79 +266,102 @@ context 'Extensions' do
     test 'should instantiate preprocessors' do
       registry = Asciidoctor::Extensions::Registry.new
       registry.preprocessor SamplePreprocessor
+      registry.activate Asciidoctor::Document.new
       assert registry.preprocessors?
-      processors = registry.load_preprocessors Asciidoctor::Document.new
-      assert_equal 1, processors.size
-      assert processors.first.is_a? SamplePreprocessor
+      extensions = registry.preprocessors
+      assert_equal 1, extensions.size
+      assert extensions.first.is_a? Asciidoctor::Extensions::ProcessorExtension
+      assert extensions.first.instance.is_a? SamplePreprocessor
+      assert extensions.first.process_method.is_a? ::Method
     end
 
     test 'should instantiate include processors' do
       registry = Asciidoctor::Extensions::Registry.new
       registry.include_processor SampleIncludeProcessor
+      registry.activate Asciidoctor::Document.new
       assert registry.include_processors?
-      processors = registry.load_include_processors Asciidoctor::Document.new
-      assert_equal 1, processors.size
-      assert processors.first.is_a? SampleIncludeProcessor
+      extensions = registry.include_processors
+      assert_equal 1, extensions.size
+      assert extensions.first.is_a? Asciidoctor::Extensions::ProcessorExtension
+      assert extensions.first.instance.is_a? SampleIncludeProcessor
+      assert extensions.first.process_method.is_a? ::Method
     end
 
     test 'should instantiate treeprocessors' do
       registry = Asciidoctor::Extensions::Registry.new
       registry.treeprocessor SampleTreeprocessor
+      registry.activate Asciidoctor::Document.new
       assert registry.treeprocessors?
-      processors = registry.load_treeprocessors Asciidoctor::Document.new
-      assert_equal 1, processors.size
-      assert processors.first.is_a? SampleTreeprocessor
+      extensions = registry.treeprocessors
+      assert_equal 1, extensions.size
+      assert extensions.first.is_a? Asciidoctor::Extensions::ProcessorExtension
+      assert extensions.first.instance.is_a? SampleTreeprocessor
+      assert extensions.first.process_method.is_a? ::Method
     end
 
     test 'should instantiate postprocessors' do
       registry = Asciidoctor::Extensions::Registry.new
       registry.postprocessor SamplePostprocessor
+      registry.activate Asciidoctor::Document.new
       assert registry.postprocessors?
-      processors = registry.load_postprocessors Asciidoctor::Document.new
-      assert_equal 1, processors.size
-      assert processors.first.is_a? SamplePostprocessor
+      extensions = registry.postprocessors
+      assert_equal 1, extensions.size
+      assert extensions.first.is_a? Asciidoctor::Extensions::ProcessorExtension
+      assert extensions.first.instance.is_a? SamplePostprocessor
+      assert extensions.first.process_method.is_a? ::Method
     end
 
     test 'should instantiate block processor' do
       registry = Asciidoctor::Extensions::Registry.new
-      registry.block :sample, SampleBlock
+      registry.block SampleBlock, :sample
+      registry.activate Asciidoctor::Document.new
       assert registry.blocks?
-      assert registry.processor_registered_for_block? :sample, :paragraph
-      processor = registry.load_block_processor :sample, Asciidoctor::Document.new
-      assert processor.is_a? SampleBlock
+      assert registry.registered_for_block? :sample, :paragraph
+      extension = registry.find_block_extension :sample
+      assert extension.is_a? Asciidoctor::Extensions::ProcessorExtension
+      assert extension.instance.is_a? SampleBlock
+      assert extension.process_method.is_a? ::Method
     end
 
     test 'should not match block processor for unsupported context' do
       registry = Asciidoctor::Extensions::Registry.new
-      registry.block :sample, SampleBlock
-      assert !(registry.processor_registered_for_block? :sample, :sidebar)
+      registry.block SampleBlock, :sample
+      registry.activate Asciidoctor::Document.new
+      assert !(registry.registered_for_block? :sample, :sidebar)
     end
 
     test 'should instantiate block macro processor' do
       registry = Asciidoctor::Extensions::Registry.new
-      registry.block_macro 'sample', SampleBlockMacro
+      registry.block_macro SampleBlockMacro, 'sample'
+      registry.activate Asciidoctor::Document.new
       assert registry.block_macros?
-      assert registry.processor_registered_for_block_macro? 'sample'
-      processor = registry.load_block_macro_processor 'sample', Asciidoctor::Document.new
-      assert processor.is_a? SampleBlockMacro
+      assert registry.registered_for_block_macro? 'sample'
+      extension = registry.find_block_macro_extension 'sample'
+      assert extension.is_a? Asciidoctor::Extensions::ProcessorExtension
+      assert extension.instance.is_a? SampleBlockMacro
+      assert extension.process_method.is_a? ::Method
     end
 
     test 'should instantiate inline macro processor' do
       registry = Asciidoctor::Extensions::Registry.new
-      registry.inline_macro 'sample', SampleInlineMacro
+      registry.inline_macro SampleInlineMacro, 'sample'
+      registry.activate Asciidoctor::Document.new
       assert registry.inline_macros?
-      assert registry.processor_registered_for_inline_macro? 'sample'
-      processor = registry.load_inline_macro_processor 'sample', Asciidoctor::Document.new
-      assert processor.is_a? SampleInlineMacro
+      assert registry.registered_for_inline_macro? 'sample'
+      extension = registry.find_inline_macro_extension 'sample'
+      assert extension.is_a? Asciidoctor::Extensions::ProcessorExtension
+      assert extension.instance.is_a? SampleInlineMacro
+      assert extension.process_method.is_a? ::Method
     end
 
     test 'should allow processors to be registered by a string name' do
       registry = Asciidoctor::Extensions::Registry.new
       registry.preprocessor 'SamplePreprocessor'
+      registry.activate Asciidoctor::Document.new
       assert registry.preprocessors?
-      processors = registry.load_preprocessors Asciidoctor::Document.new
-      assert_equal 1, processors.size
-      assert processors.first.is_a? SamplePreprocessor
+      extensions = registry.preprocessors
+      assert_equal 1, extensions.size
+      assert extensions.first.is_a? Asciidoctor::Extensions::ProcessorExtension
     end
   end
 
@@ -317,11 +376,13 @@ sample content
       EOS
 
       begin
-        Asciidoctor::Extensions.register do |document|
+        Asciidoctor::Extensions.register do
           preprocessor ScrubHeaderPreprocessor
         end
 
         doc = document_from_string input
+        assert doc.attr? 'skipped'
+        assert_equal 'junk line', (doc.attr 'skipped').strip
         assert doc.has_header?
         assert_equal 'Document Title', doc.doctitle
       ensure
@@ -339,7 +400,7 @@ after
       EOS
 
       begin
-        Asciidoctor::Extensions.register do |document|
+        Asciidoctor::Extensions.register do
           include_processor BoilerplateTextIncludeProcessor
         end
 
@@ -352,6 +413,39 @@ after
         Asciidoctor::Extensions.unregister_all
       end
     end
+  
+    test 'should call include processor to process include directive' do
+      input = <<-EOS
+first line
+
+include::include-file.asciidoc[]
+
+last line
+      EOS
+
+      # Safe Mode is not required here
+      document = empty_document :base_dir => File.expand_path(File.dirname(__FILE__))
+      document.extensions.include_processor do
+        process do |doc, reader, target, attributes|
+          # demonstrate that push_include normalizes endlines
+          content = ["include target:: #{target}\n", "\n", "middle line\n"]
+          reader.push_include content, target, target, 1, attributes
+        end
+      end
+      reader = Asciidoctor::PreprocessorReader.new document, input
+      lines = []
+      lines << reader.read_line
+      lines << reader.read_line
+      lines << reader.read_line
+      assert_equal 'include target:: include-file.asciidoc', lines.last
+      assert_equal 'include-file.asciidoc: line 2', reader.line_info
+      while reader.has_more_lines?
+        lines << reader.read_line
+      end
+      source = lines * ::Asciidoctor::EOL
+      assert_match(/^include target:: include-file.asciidoc$/, source)
+      assert_match(/^middle line$/, source)
+    end
 
     test 'should invoke treeprocessors after parsing document' do
       input = <<-EOS
@@ -362,7 +456,7 @@ content
       EOS
 
       begin
-        Asciidoctor::Extensions.register do |document|
+        Asciidoctor::Extensions.register do
           treeprocessor ReplaceAuthorTreeprocessor
         end
 
@@ -373,6 +467,26 @@ content
       end
     end
 
+    test 'should allow treeprocessor to replace tree' do
+      input = <<-EOS
+= Original Document
+Doc Writer
+
+content
+      EOS
+
+      begin
+        Asciidoctor::Extensions.register do
+          treeprocessor ReplaceTreeTreeprocessor
+        end
+
+        doc = document_from_string input
+        assert_equal 'Replacement Document', doc.doctitle
+      ensure
+        Asciidoctor::Extensions.unregister_all
+      end
+    end
+
     test 'should invoke postprocessors after rendering document' do
       input = <<-EOS
 * one
@@ -381,12 +495,12 @@ content
       EOS
 
       begin
-        Asciidoctor::Extensions.register do |document|
+        Asciidoctor::Extensions.register do
           postprocessor StripAttributesPostprocessor
         end
 
         output = render_string input
-        assert_no_match(/<div class="ulist">/, output)
+        refute_match(/<div class="ulist">/, output)
       ensure
         Asciidoctor::Extensions.unregister_all
       end
@@ -399,8 +513,8 @@ Hi there!
       EOS
 
       begin
-        Asciidoctor::Extensions.register do |document|
-          block :yell, UppercaseBlock
+        Asciidoctor::Extensions.register do
+          block UppercaseBlock
         end
 
         output = render_embedded_string input
@@ -417,8 +531,8 @@ snippet::12345[]
       EOS
 
       begin
-        Asciidoctor::Extensions.register do |document|
-          block_macro :snippet, SnippetMacro
+        Asciidoctor::Extensions.register do
+          block_macro SnippetMacro, :snippet
         end
 
         output = render_embedded_string input
@@ -429,20 +543,76 @@ snippet::12345[]
     end
 
     test 'should invoke processor for custom inline macro' do
-      input = <<-EOS
-Room temperature is degrees:25[].
-      EOS
-
       begin
-        Asciidoctor::Extensions.register do |document|
-          inline_macro :degrees, TemperatureMacro
+        Asciidoctor::Extensions.register do
+          inline_macro TemperatureMacro, :degrees
         end
 
-        output = render_embedded_string input, :attributes => {'temperature-unit' => 'F'}
+        output = render_embedded_string 'Room temperature is degrees:25[C].', :attributes => {'temperature-unit' => 'F'}
+        assert output.include?('Room temperature is 25.0 &#176;C.')
+
+        output = render_embedded_string 'Room temperature is degrees:25[].', :attributes => {'temperature-unit' => 'F'}
         assert output.include?('Room temperature is 77.0 &#176;F.')
       ensure
         Asciidoctor::Extensions.unregister_all
       end
     end
+
+    test 'should not carry over attributes if block processor returns nil' do
+      begin
+        Asciidoctor::Extensions.register do
+          block do
+            named :skip
+            on_context :paragraph
+            parse_content_as :raw
+            process do |parent, reader, attrs|
+              nil
+            end
+          end
+        end
+        input = <<-EOS
+.unused title
+[skip]
+not rendered
+
+--
+rendered
+--
+        EOS
+        doc = document_from_string input
+        assert_equal 1, doc.blocks.size
+        assert_nil doc.blocks[0].attributes['title']
+      ensure
+        Asciidoctor::Extensions.unregister_all
+      end
+    end
+
+    test 'should pass attributes by value to block processor' do
+      begin
+        Asciidoctor::Extensions.register do
+          block do
+            named :foo
+            on_context :paragraph
+            parse_content_as :raw
+            process do |parent, reader, attrs|
+              original_attrs = attrs.dup
+              attrs.delete('title')
+              create_paragraph parent, reader.read_lines, original_attrs.merge('id' => 'value')
+            end
+          end
+        end
+        input = <<-EOS
+.title
+[foo]
+content
+        EOS
+        doc = document_from_string input
+        assert_equal 1, doc.blocks.size
+        assert_equal 'title', doc.blocks[0].attributes['title']
+        assert_equal 'value', doc.blocks[0].id
+      ensure
+        Asciidoctor::Extensions.unregister_all
+      end
+    end
   end
 end