summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/markdown/table_of_contents_filter_spec.rb
blob: f383a5850d5419ca307b45f317225d31f993d938 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# encoding: UTF-8

require 'spec_helper'

module Gitlab::Markdown
  describe TableOfContentsFilter do
    def filter(html, options = {})
      described_class.call(html, options)
    end

    def header(level, text)
      "<h#{level}>#{text}</h#{level}>\n"
    end

    it 'does nothing when :no_header_anchors is truthy' do
      exp = act = header(1, 'Header')
      expect(filter(act, no_header_anchors: 1).to_html).to eq exp
    end

    it 'does nothing with empty headers' do
      exp = act = header(1, nil)
      expect(filter(act).to_html).to eq exp
    end

    1.upto(6) do |i|
      it "processes h#{i} elements" do
        html = header(i, "Header #{i}")
        doc = filter(html)

        expect(doc.css("h#{i} a").first.attr('id')).to eq "header-#{i}"
      end
    end

    describe 'anchor tag' do
      it 'has an `anchor` class' do
        doc = filter(header(1, 'Header'))
        expect(doc.css('h1 a').first.attr('class')).to eq 'anchor'
      end

      it 'links to the id' do
        doc = filter(header(1, 'Header'))
        expect(doc.css('h1 a').first.attr('href')).to eq '#header'
      end

      describe 'generated IDs' do
        it 'translates spaces to dashes' do
          doc = filter(header(1, 'This header has spaces in it'))
          expect(doc.css('h1 a').first.attr('id')).to eq 'this-header-has-spaces-in-it'
        end

        it 'squeezes multiple spaces and dashes' do
          doc = filter(header(1, 'This---header     is poorly-formatted'))
          expect(doc.css('h1 a').first.attr('id')).to eq 'this-header-is-poorly-formatted'
        end

        it 'removes punctuation' do
          doc = filter(header(1, "This, header! is, filled. with @ punctuation?"))
          expect(doc.css('h1 a').first.attr('id')).to eq 'this-header-is-filled-with-punctuation'
        end

        it 'appends a unique number to duplicates' do
          doc = filter(header(1, 'One') + header(2, 'One'))

          expect(doc.css('h1 a').first.attr('id')).to eq 'one'
          expect(doc.css('h2 a').first.attr('id')).to eq 'one-1'
        end

        it 'supports Unicode' do
          doc = filter(header(1, '한글'))
          expect(doc.css('h1 a').first.attr('id')).to eq '한글'
          expect(doc.css('h1 a').first.attr('href')).to eq '#한글'
        end
      end
    end

    describe 'result' do
      def result(html)
        HTML::Pipeline.new([described_class]).call(html)
      end

      let(:results) { result(header(1, 'Header 1') + header(2, 'Header 2')) }
      let(:doc) { Nokogiri::XML::DocumentFragment.parse(results[:toc]) }

      it 'is contained within a `ul` element' do
        expect(doc.children.first.name).to eq 'ul'
        expect(doc.children.first.attr('class')).to eq 'section-nav'
      end

      it 'contains an `li` element for each header' do
        expect(doc.css('li').length).to eq 2

        links = doc.css('li a')

        expect(links.first.attr('href')).to eq '#header-1'
        expect(links.first.text).to eq 'Header 1'
        expect(links.last.attr('href')).to eq '#header-2'
        expect(links.last.text).to eq 'Header 2'
      end
    end
  end
end