gollum_tags_filter_spec.rb 4.04 KB
Newer Older
1
2
require 'spec_helper'

3
describe Banzai::Filter::GollumTagsFilter do
4
5
  include FilterSpecHelper

6
  let(:project) { create(:project) }
7
8
9
10
11
12
13
14
15
16
17
  let(:user) { double }
  let(:project_wiki) { ProjectWiki.new(project, user) }

  describe 'validation' do
    it 'ensure that a :project_wiki key exists in context' do
      expect { filter("See [[images/image.jpg]]", {}) }.to raise_error ArgumentError, "Missing context keys for Banzai::Filter::GollumTagsFilter: :project_wiki"
    end
  end

  context 'linking internal images' do
    it 'creates img tag if image exists' do
18
19
20
21
22
23
24
      gollum_file_double = double('Gollum::File',
                                  mime_type: 'image/jpeg',
                                  name: 'images/image.jpg',
                                  path: 'images/image.jpg',
                                  raw_data: '')
      wiki_file = Gitlab::Git::WikiFile.new(gollum_file_double)
      expect(project_wiki).to receive(:find_file).with('images/image.jpg').and_return(wiki_file)
25
26
27
28

      tag = '[[images/image.jpg]]'
      doc = filter("See #{tag}", project_wiki: project_wiki)

29
      expect(doc.at_css('img')['data-src']).to eq "#{project_wiki.wiki_base_path}/images/image.jpg"
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
    end

    it 'does not creates img tag if image does not exist' do
      expect(project_wiki).to receive(:find_file).with('images/image.jpg').and_return(nil)

      tag = '[[images/image.jpg]]'
      doc = filter("See #{tag}", project_wiki: project_wiki)

      expect(doc.css('img').size).to eq 0
    end
  end

  context 'linking external images' do
    it 'creates img tag for valid URL' do
      tag = '[[http://example.com/image.jpg]]'
      doc = filter("See #{tag}", project_wiki: project_wiki)

47
      expect(doc.at_css('img')['data-src']).to eq "http://example.com/image.jpg"
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
    end

    it 'does not creates img tag for invalid URL' do
      tag = '[[http://example.com/image.pdf]]'
      doc = filter("See #{tag}", project_wiki: project_wiki)

      expect(doc.css('img').size).to eq 0
    end
  end

  context 'linking external resources' do
    it "the created link's text will be equal to the resource's text" do
      tag = '[[http://example.com]]'
      doc = filter("See #{tag}", project_wiki: project_wiki)

      expect(doc.at_css('a').text).to eq 'http://example.com'
      expect(doc.at_css('a')['href']).to eq 'http://example.com'
    end

    it "the created link's text will be link-text" do
      tag = '[[link-text|http://example.com/pdfs/gollum.pdf]]'
      doc = filter("See #{tag}", project_wiki: project_wiki)

      expect(doc.at_css('a').text).to eq 'link-text'
      expect(doc.at_css('a')['href']).to eq 'http://example.com/pdfs/gollum.pdf'
    end
  end

  context 'linking internal resources' do
77
    it "the created link's text includes the resource's text and wiki base path" do
78
79
      tag = '[[wiki-slug]]'
      doc = filter("See #{tag}", project_wiki: project_wiki)
80
      expected_path = ::File.join(project_wiki.wiki_base_path, 'wiki-slug')
81
82

      expect(doc.at_css('a').text).to eq 'wiki-slug'
83
      expect(doc.at_css('a')['href']).to eq expected_path
84
85
86
87
88
    end

    it "the created link's text will be link-text" do
      tag = '[[link-text|wiki-slug]]'
      doc = filter("See #{tag}", project_wiki: project_wiki)
89
      expected_path = ::File.join(project_wiki.wiki_base_path, 'wiki-slug')
90
91

      expect(doc.at_css('a').text).to eq 'link-text'
92
      expect(doc.at_css('a')['href']).to eq expected_path
93
    end
94
95
96
97
98
99

    it "inside back ticks will be exempt from linkification" do
      doc = filter('<code>[[link-in-backticks]]</code>', project_wiki: project_wiki)

      expect(doc.at_css('code').text).to eq '[[link-in-backticks]]'
    end
100
  end
101
102

  context 'table of contents' do
Robert Speicher's avatar
Robert Speicher committed
103
104
    it 'replaces [[<em>TOC</em>]] with ToC result' do
      doc = described_class.call("<p>[[<em>TOC</em>]]</p>", { project_wiki: project_wiki }, { toc: "FOO" })
105

Robert Speicher's avatar
Robert Speicher committed
106
      expect(doc.to_html).to eq("FOO")
107
108
    end

Robert Speicher's avatar
Robert Speicher committed
109
    it 'handles an empty ToC result' do
110
      input = "<p>[[<em>TOC</em>]]</p>"
Robert Speicher's avatar
Robert Speicher committed
111
      doc = described_class.call(input, project_wiki: project_wiki)
112

113
      expect(doc.to_html).to eq ''
114
115
    end
  end
116
end