- Fix inline Table of Contents invalid parsing of code blocks

Author: DannyBen

lib/madness/inline_table_of_contents.rb

@@ -0,0 +1,54 @@
+module Madness
+  # Generate a markdown Table of Contents for a single document
+  class InlineTableOfContents
+    include ServerHelper
+    using StringRefinements
+
+    attr_reader :text
+
+    def initialize(text)
+      @text = text
+    end
+
+    def markdown
+      @markdown ||= markdown!
+    end
+
+  protected
+
+    def markdown!
+      result = ["#{caption}\n"]
+      text.lines(chomp: true).each do |line|
+        next unless line.start_with?('#', '```')
+        next if inside_code_block? line
+
+        matches = line.match(/^(?<level>\#{2,3})\s+(?<text>.+)/)
+        next unless matches
+
+        level = matches[:level].size - 2
+        text = matches[:text]
+
+        spacer = '  ' * level
+        result.push "#{spacer}- [#{text}](##{text.to_slug})"
+      end
+
+      result.join "\n"
+    end
+
+    def caption
+      @caption ||= config.auto_toc.is_a?(String) ? config.auto_toc : '## Table of Contents'
+    end
+
+    def inside_code_block?(line)
+      @marker ||= false
+
+      if !@marker && line.start_with?('```')
+        @marker = line[/^`{3,4}/]
+      elsif @marker && line.start_with?(@marker)
+        @marker = false
+      end
+
+      !!@marker
+    end
+  end
+end

lib/madness/markdown_document.rb

@@ -74,30 +74,12 @@ def redcarpet_handler
       config.highlighter ? HighlightRenderer : Redcarpet::Render::HTML
     end
 
-    def toc_caption
-      @toc_caption ||= if config.auto_toc.is_a?(String)
-        config.auto_toc
-      else
-        '## Table of Contents'
-      end
-    end
-
     def toc
-      result = ["#{toc_caption}\n"]
-      markdown.lines(chomp: true).each do |line|
-        next unless line.start_with? '#'
-
-        matches = line.match(/^(?<level>\#{2,3})\s+(?<text>.+)/)
-        next unless matches
-
-        level = matches[:level].size - 1
-        text = matches[:text]
-
-        spacer = '  ' * level
-        result.push "#{spacer}- [#{text}](##{text.to_slug})"
-      end
+      @toc ||= toc_handler.markdown
+    end
 
-      result.join "\n"
+    def toc_handler
+      @toc_handler ||= Madness::InlineTableOfContents.new markdown
     end
   end
 end

lib/madness/table_of_contents.rb

@@ -1,5 +1,5 @@
 module Madness
-  # Generate a markdown Table of Contents
+  # Generate a markdown Table of Contents for the entire site
   class TableOfContents
     include ServerHelper
 

spec/approvals/inline-toc

@@ -0,0 +1,5 @@
+## Table of Contents
+
+- [Header 2](#header-2)
+  - [Level 3 header](#level-3-header)
+- [Another Header 2](#another-header-2)

spec/approvals/toc

@@ -40,5 +40,6 @@
 1. [File with H1 alt](/File%20with%20H1%20alt)
 1. [File with Shortlink](/File%20with%20Shortlink)
 1. [File with Spaces](/File%20with%20Spaces)
+1. [File with TOC and Code](/File%20with%20TOC%20and%20Code)
 1. [File with TOC](/File%20with%20TOC)
 1. [File without H1](/File%20without%20H1)

spec/fixtures/docroot/File with TOC and Code.md

@@ -0,0 +1,35 @@
+# File with TOC and Code
+
+<!-- TOC -->
+
+This file ensures that headers in code blocks (including nested code blocks)
+are ignored in TOC generation
+
+````
+
+## Header trap (should not be included)
+
+The below is displayed as is (unparsed)
+
+```
+## Code block in code block (also a trap)
+```
+
+````
+
+```markdown
+## Header in code block with language identifier
+```
+
+## Header 2
+
+Some text
+
+### Level 3 header
+
+More text
+
+## Another Header 2
+
+Even more text
+

spec/madness/inline_table_of_contents_spec.rb

@@ -0,0 +1,11 @@
+describe InlineTableOfContents do
+  subject { described_class.new markdown }
+
+  let(:markdown) { File.read 'spec/fixtures/docroot/File with TOC and Code.md' }
+
+  describe '#markdown' do
+    it 'returns a markdown table of contents' do
+      expect(subject.markdown).to match_approval('inline-toc')
+    end
+  end
+end