summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/markdown/snippet_reference_filter_spec.rb
blob: 3a9acc9d6d4b6598b79910d9d72e415883232369 (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
require 'spec_helper'

module Gitlab::Markdown
  describe SnippetReferenceFilter do
    include FilterSpecHelper

    let(:project)   { create(:empty_project, :public) }
    let(:snippet)   { create(:project_snippet, project: project) }
    let(:reference) { snippet.to_reference }

    it 'requires project context' do
      expect { described_class.call('') }.to raise_error(ArgumentError, /:project/)
    end

    %w(pre code a style).each do |elem|
      it "ignores valid references contained inside '#{elem}' element" do
        exp = act = "<#{elem}>Snippet #{reference}</#{elem}>"
        expect(reference_filter(act).to_html).to eq exp
      end
    end

    context 'internal reference' do
      it 'links to a valid reference' do
        doc = reference_filter("See #{reference}")

        expect(doc.css('a').first.attr('href')).to eq urls.
          namespace_project_snippet_url(project.namespace, project, snippet)
      end

      it 'links with adjacent text' do
        doc = reference_filter("Snippet (#{reference}.)")
        expect(doc.to_html).to match(/\(<a.+>#{Regexp.escape(reference)}<\/a>\.\)/)
      end

      it 'ignores invalid snippet IDs' do
        exp = act = "Snippet #{invalidate_reference(reference)}"

        expect(reference_filter(act).to_html).to eq exp
      end

      it 'includes a title attribute' do
        doc = reference_filter("Snippet #{reference}")
        expect(doc.css('a').first.attr('title')).to eq "Snippet: #{snippet.title}"
      end

      it 'escapes the title attribute' do
        snippet.update_attribute(:title, %{"></a>whatever<a title="})

        doc = reference_filter("Snippet #{reference}")
        expect(doc.text).to eq "Snippet #{reference}"
      end

      it 'includes default classes' do
        doc = reference_filter("Snippet #{reference}")
        expect(doc.css('a').first.attr('class')).to eq 'gfm gfm-snippet'
      end

      it 'includes a data-project attribute' do
        doc = reference_filter("Snippet #{reference}")
        link = doc.css('a').first

        expect(link).to have_attribute('data-project')
        expect(link.attr('data-project')).to eq project.id.to_s
      end

      it 'includes a data-snippet attribute' do
        doc = reference_filter("See #{reference}")
        link = doc.css('a').first

        expect(link).to have_attribute('data-snippet')
        expect(link.attr('data-snippet')).to eq snippet.id.to_s
      end

      it 'supports an :only_path context' do
        doc = reference_filter("Snippet #{reference}", only_path: true)
        link = doc.css('a').first.attr('href')

        expect(link).not_to match %r(https?://)
        expect(link).to eq urls.namespace_project_snippet_url(project.namespace, project, snippet, only_path: true)
      end

      it 'adds to the results hash' do
        result = reference_pipeline_result("Snippet #{reference}")
        expect(result[:references][:snippet]).to eq [snippet]
      end
    end

    context 'cross-project reference' do
      let(:namespace) { create(:namespace, name: 'cross-reference') }
      let(:project2)  { create(:empty_project, :public, namespace: namespace) }
      let(:snippet)   { create(:project_snippet, project: project2) }
      let(:reference) { snippet.to_reference(project) }

      it 'links to a valid reference' do
        doc = reference_filter("See #{reference}")

        expect(doc.css('a').first.attr('href')).
          to eq urls.namespace_project_snippet_url(project2.namespace, project2, snippet)
      end

      it 'links with adjacent text' do
        doc = reference_filter("See (#{reference}.)")
        expect(doc.to_html).to match(/\(<a.+>#{Regexp.escape(reference)}<\/a>\.\)/)
      end

      it 'ignores invalid snippet IDs on the referenced project' do
        exp = act = "See #{invalidate_reference(reference)}"

        expect(reference_filter(act).to_html).to eq exp
      end

      it 'adds to the results hash' do
        result = reference_pipeline_result("Snippet #{reference}")
        expect(result[:references][:snippet]).to eq [snippet]
      end
    end

    context 'cross-project URL reference' do
      let(:namespace) { create(:namespace, name: 'cross-reference') }
      let(:project2)  { create(:empty_project, :public, namespace: namespace) }
      let(:snippet)   { create(:project_snippet, project: project2) }
      let(:reference) { urls.namespace_project_snippet_url(project2.namespace, project2, snippet) }

      it 'links to a valid reference' do
        doc = reference_filter("See #{reference}")

        expect(doc.css('a').first.attr('href')).
          to eq urls.namespace_project_snippet_url(project2.namespace, project2, snippet)
      end

      it 'links with adjacent text' do
        doc = reference_filter("See (#{reference}.)")
        expect(doc.to_html).to match(/\(<a.+>#{Regexp.escape(snippet.to_reference(project))}<\/a>\.\)/)
      end

      it 'ignores invalid snippet IDs on the referenced project' do
        act = "See #{invalidate_reference(reference)}"

        expect(reference_filter(act).to_html).to match(/<a.+>#{Regexp.escape(invalidate_reference(reference))}<\/a>/)
      end

      it 'adds to the results hash' do
        result = reference_pipeline_result("Snippet #{reference}")
        expect(result[:references][:snippet]).to eq [snippet]
      end
    end
  end
end