summaryrefslogtreecommitdiff
path: root/spec/lib/banzai/filter/front_matter_filter_spec.rb
blob: f3543ab9582c065617e77f02aa3b72d41e4f570a (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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Banzai::Filter::FrontMatterFilter do
  include FilterSpecHelper

  it 'allows for `encoding:` before the front matter' do
    content = <<~MD
      # encoding: UTF-8
      ---
      foo: foo
      bar: bar
      ---

      # Header

      Content
    MD

    output = filter(content)

    expect(output).not_to match 'encoding'
  end

  it 'converts YAML front matter to a fenced code block' do
    content = <<~MD
      ---
      foo: :foo_symbol
      bar: :bar_symbol
      ---

      # Header

      Content
    MD

    output = filter(content)

    aggregate_failures do
      expect(output).not_to include '---'
      expect(output).to include "```yaml:frontmatter\nfoo: :foo_symbol\n"
    end
  end

  it 'converts TOML frontmatter to a fenced code block' do
    content = <<~MD
      +++
      foo = :foo_symbol
      bar = :bar_symbol
      +++

      # Header

      Content
    MD

    output = filter(content)

    aggregate_failures do
      expect(output).not_to include '+++'
      expect(output).to include "```toml:frontmatter\nfoo = :foo_symbol\n"
    end
  end

  it 'converts JSON front matter to a fenced code block' do
    content = <<~MD
      ;;;
      {
        "foo": ":foo_symbol",
        "bar": ":bar_symbol"
      }
      ;;;

      # Header

      Content
    MD

    output = filter(content)

    aggregate_failures do
      expect(output).not_to include ';;;'
      expect(output).to include "```json:frontmatter\n{\n  \"foo\": \":foo_symbol\",\n"
    end
  end

  it 'converts arbitrary front matter to a fenced code block' do
    content = <<~MD
      ---arbitrary
      foo = :foo_symbol
      bar = :bar_symbol
      ---

      # Header

      Content
    MD

    output = filter(content)

    aggregate_failures do
      expect(output).not_to include '---arbitrary'
      expect(output).to include "```arbitrary:frontmatter\nfoo = :foo_symbol\n"
    end
  end

  context 'source position mapping' do
    it 'keeps spaces before and after' do
      content = <<~MD


        ---

        foo: :foo_symbol

        ---  


        # Header
      MD

      output = filter(content)

      expect(output).to eq <<~MD


        ```yaml:frontmatter

        foo: :foo_symbol

        ```


        # Header
      MD
    end

    it 'keeps an empty line in place of the encoding' do
      content = <<~MD
        # encoding: UTF-8
        ---
        foo: :foo_symbol
        ---
      MD

      output = filter(content)

      expect(output).to eq <<~MD

        ```yaml:frontmatter
        foo: :foo_symbol
        ```
      MD
    end
  end

  context 'on content without front matter' do
    it 'returns the content unmodified' do
      content = <<~MD
        # This is some Markdown

        It has no YAML front matter to parse.
      MD

      expect(filter(content)).to eq content
    end
  end

  context 'on front matter without content' do
    it 'converts YAML front matter to a fenced code block' do
      content = <<~MD.rstrip
        ---
        foo: :foo_symbol
        bar: :bar_symbol
        ---
      MD

      output = filter(content)

      aggregate_failures do
        expect(output).to eq <<~MD
          ```yaml:frontmatter
          foo: :foo_symbol
          bar: :bar_symbol
          ```
        MD
      end
    end
  end

  it 'fails fast for strings with many spaces' do
    content = "coding:" + " " * 50_000 + ";"

    expect do
      Timeout.timeout(3.seconds) { filter(content) }
    end.not_to raise_error
  end

  it 'fails fast for strings with many newlines' do
    content = "coding:\n" + ";;;" + "\n" * 10_000 + "x"

    expect do
      Timeout.timeout(3.seconds) { filter(content) }
    end.not_to raise_error
  end
end