BigW Consortium Gitlab

mentionable_shared_examples.rb 4.65 KB
Newer Older
1 2
# Specifications for behavior common to all Mentionable implementations.
# Requires a shared context containing:
3
# - subject { "the mentionable implementation" }
4 5 6
# - let(:backref_text) { "the way that +subject+ should refer to itself in backreferences " }
# - let(:set_mentionable_text) { lambda { |txt| "block that assigns txt to the subject's mentionable_text" } }

7
shared_context 'mentionable context' do
Douwe Maan committed
8
  let(:project) { subject.project }
9 10 11
  let(:author)  { subject.author }

  let(:mentioned_issue)  { create(:issue, project: project) }
12
  let!(:mentioned_mr)     { create(:merge_request, :simple, source_project: project) }
Douwe Maan committed
13
  let(:mentioned_commit) { project.commit("HEAD~1") }
14 15 16 17

  let(:ext_proj)   { create(:project, :public) }
  let(:ext_issue)  { create(:issue, project: ext_proj) }
  let(:ext_mr)     { create(:merge_request, :simple, source_project: ext_proj) }
Douwe Maan committed
18
  let(:ext_commit) { ext_proj.commit("HEAD~2") }
19

20 21 22 23 24 25
  # Override to add known commits to the repository stub.
  let(:extra_commits) { [] }

  # A string that mentions each of the +mentioned_.*+ objects above. Mentionables should add a self-reference
  # to this string and place it in their +mentionable_text+.
  let(:ref_string) do
26 27
    <<-MSG.strip_heredoc
      These references are new:
28 29 30
        Issue:  #{mentioned_issue.to_reference}
        Merge:  #{mentioned_mr.to_reference}
        Commit: #{mentioned_commit.to_reference}
31 32

      This reference is a repeat and should only be mentioned once:
33
        Repeat: #{mentioned_issue.to_reference}
34 35

      These references are cross-referenced:
36 37 38
        Issue:  #{ext_issue.to_reference(project)}
        Merge:  #{ext_mr.to_reference(project)}
        Commit: #{ext_commit.to_reference(project)}
39 40 41 42

      This is a self-reference and should not be mentioned at all:
        Self: #{backref_text}
    MSG
43 44 45
  end

  before do
46 47
    # Wire the project's repository to return the mentioned commit, and +nil+
    # for any unrecognized commits.
Douwe Maan committed
48 49 50 51 52
    allow_any_instance_of(::Repository).to receive(:commit).and_call_original
    allow_any_instance_of(::Repository).to receive(:commit).with(mentioned_commit.short_id).and_return(mentioned_commit)
    extra_commits.each do |commit|
      allow_any_instance_of(::Repository).to receive(:commit).with(commit.short_id).and_return(commit)
    end
53

54
    set_mentionable_text.call(ref_string)
55 56

    project.team << [author, :developer]
57 58 59 60
  end
end

shared_examples 'a mentionable' do
61
  include_context 'mentionable context'
62 63

  it 'generates a descriptive back-reference' do
64
    expect(subject.gfm_reference).to eq(backref_text)
65 66 67 68
  end

  it "extracts references from its reference property" do
    # De-duplicate and omit itself
69
    refs = subject.referenced_mentionables
70 71 72 73 74 75 76
    expect(refs.size).to eq(6)
    expect(refs).to include(mentioned_issue)
    expect(refs).to include(mentioned_mr)
    expect(refs).to include(mentioned_commit)
    expect(refs).to include(ext_issue)
    expect(refs).to include(ext_mr)
    expect(refs).to include(ext_commit)
77 78 79
  end

  it 'creates cross-reference notes' do
80 81 82 83
    mentioned_objects = [mentioned_issue, mentioned_mr, mentioned_commit,
                         ext_issue, ext_mr, ext_commit]

    mentioned_objects.each do |referenced|
84
      expect(SystemNoteService).to receive(:cross_reference).
85
        with(referenced, subject.local_reference, author)
86 87
    end

88
    subject.create_cross_references!
89 90 91 92
  end
end

shared_examples 'an editable mentionable' do
93
  include_context 'mentionable context'
94 95 96

  it_behaves_like 'a mentionable'

97 98 99 100
  let(:new_issues) do
    [create(:issue, project: project), create(:issue, project: ext_proj)]
  end

101
  it 'creates new cross-reference notes when the mentionable text is edited' do
Douwe Maan committed
102 103
    subject.save

Douwe Maan committed
104
    new_text = <<-MSG.strip_heredoc
105
      These references already existed:
Douwe Maan committed
106 107 108 109 110 111

      Issue:  #{mentioned_issue.to_reference}

      Commit: #{mentioned_commit.to_reference}

      ---
112 113

      This cross-project reference already existed:
Douwe Maan committed
114 115 116 117

      Issue:  #{ext_issue.to_reference(project)}

      ---
118 119

      These two references are introduced in an edit:
Douwe Maan committed
120 121 122 123

      Issue: #{new_issues[0].to_reference}

      Cross: #{new_issues[1].to_reference(project)}
124
    MSG
125

126 127
    # These three objects were already referenced, and should not receive new
    # notes
128
    [mentioned_issue, mentioned_commit, ext_issue].each do |oldref|
129
      expect(SystemNoteService).not_to receive(:cross_reference).
130
        with(oldref, any_args)
131 132
    end

133 134
    # These two issues are new and should receive reference notes
    new_issues.each do |newref|
135
      expect(SystemNoteService).to receive(:cross_reference).
136
        with(newref, subject.local_reference, author)
137
    end
138 139

    set_mentionable_text.call(new_text)
140
    subject.create_new_cross_references!(author)
141 142
  end
end