Merge branch 'rs-wiki-pipeline-spec' into 'master'

Add a spec for WikiPipeline

Removes the specs from GollumTagsFilter that were more like integration
tests for the pipeline than unit tests of the filter.

See merge request !3054

lib/banzai/filter/gollum_tags_filter.rb

@@ -26,6 +26,10 @@ module Banzai
     #   * [[http://example.com/images/logo.png]]
     #   * [[http://example.com/images/logo.png|alt=Logo]]
     #
+    # - Insert a Table of Contents list:
+    #
+    #   * [[_TOC_]]
+    #
     # Based on Gollum::Filter::Tags
     #
     # Context options:
@@ -61,8 +65,6 @@ module Banzai
           # before this one, it will be converted into `[[<em>TOC</em>]]`, so it
           # needs special-case handling
           if toc_tag?(node)
-            next unless result[:toc].present?
-
             process_toc_tag(node)
           else
             content = node.content
@@ -85,7 +87,7 @@ module Banzai
       # Replace an entire `[[<em>TOC</em>]]` node with the result generated by
       # TableOfContentsFilter
       def process_toc_tag(node)
-        node.parent.parent.replace(result[:toc])
+        node.parent.parent.replace(result[:toc].presence || '')
       end
 
       # Process a single tag into its final HTML form.

spec/lib/banzai/filter/gollum_tags_filter_spec.rb

@@ -88,54 +88,17 @@ describe Banzai::Filter::GollumTagsFilter, lib: true do
   end
 
   context 'table of contents' do
-    let(:pipeline) { Banzai::Pipeline[:wiki] }
+    it 'replaces [[<em>TOC</em>]] with ToC result' do
+      doc = described_class.call("<p>[[<em>TOC</em>]]</p>", { project_wiki: project_wiki }, { toc: "FOO" })
 
-    it 'replaces the tag with the TableOfContentsFilter result' do
-      markdown = <<-MD.strip_heredoc
-        [[_TOC_]]
-
-        ## Header
-
-        Foo
-      MD
-
-      result = pipeline.call(markdown, project_wiki: project_wiki, project: project)
-
-      aggregate_failures do
-        expect(result[:output].text).not_to include '[[_TOC_]]'
-        expect(result[:output].text).not_to include '[['
-        expect(result[:output].to_html).to include(result[:toc])
-      end
-    end
-
-    it 'is case-sensitive' do
-      markdown = <<-MD.strip_heredoc
-        [[_toc_]]
-
-        # Header 1
-
-        Foo
-      MD
-
-      output = pipeline.to_html(markdown, project_wiki: project_wiki, project: project)
-
-      expect(output).to include('[[<em>toc</em>]]')
+      expect(doc.to_html).to eq("FOO")
     end
 
-    it 'handles an empty pipeline result' do
-      # No Markdown headers in this doc, so `result[:toc]` will be empty
-      markdown = <<-MD.strip_heredoc
-        [[_TOC_]]
+    it 'handles an empty ToC result' do
+      input = "<p>[[<em>TOC</em>]]</p>"
+      doc = described_class.call(input, project_wiki: project_wiki)
 
-        Foo
-      MD
-
-      output = pipeline.to_html(markdown, project_wiki: project_wiki, project: project)
-
-      aggregate_failures do
-        expect(output).not_to include('<ul>')
-        expect(output).to include('[[<em>TOC</em>]]')
-      end
+      expect(doc.to_html).to eq ''
     end
   end
 end

spec/lib/banzai/pipeline/wiki_pipeline_spec.rb

+require 'rails_helper'
+
+describe Banzai::Pipeline::WikiPipeline do
+  describe 'TableOfContents' do
+    it 'replaces the tag with the TableOfContentsFilter result' do
+      markdown = <<-MD.strip_heredoc
+          [[_TOC_]]
+
+          ## Header
+
+          Foo
+      MD
+
+      result = described_class.call(markdown, project: spy, project_wiki: double)
+
+      aggregate_failures do
+        expect(result[:output].text).not_to include '[['
+        expect(result[:output].text).not_to include 'TOC'
+        expect(result[:output].to_html).to include(result[:toc])
+      end
+    end
+
+    it 'is case-sensitive' do
+      markdown = <<-MD.strip_heredoc
+          [[_toc_]]
+
+          # Header 1
+
+          Foo
+      MD
+
+      output = described_class.to_html(markdown, project: spy, project_wiki: double)
+
+      expect(output).to include('[[<em>toc</em>]]')
+    end
+
+    it 'handles an empty pipeline result' do
+      # No Markdown headers in this doc, so `result[:toc]` will be empty
+      markdown = <<-MD.strip_heredoc
+          [[_TOC_]]
+
+          Foo
+      MD
+
+      output = described_class.to_html(markdown, project: spy, project_wiki: double)
+
+      aggregate_failures do
+        expect(output).not_to include('<ul>')
+        expect(output).not_to include('[[<em>TOC</em>]]')
+      end
+    end
+  end
+end