Support references to group milestones

Group milestones can only be referred to by name, not IID. They also do not
support cross-project references.

1 files changed, 129 insertions, 67 deletions

diff --git a/spec/lib/banzai/filter/milestone_reference_filter_spec.rb b/spec/lib/banzai/filter/milestone_reference_filter_spec.rb
index 5db77566513..ebd6c79077e 100644
--- a/spec/lib/banzai/filter/milestone_reference_filter_spec.rb
+++ b/spec/lib/banzai/filter/milestone_reference_filter_spec.rb
@@ -3,57 +3,57 @@ require 'spec_helper'
 describe Banzai::Filter::MilestoneReferenceFilter do
   include FilterSpecHelper
 
-  let(:project)   { create(:project, :public) }
-  let(:milestone) { create(:milestone, project: project) }
-  let(:reference) { milestone.to_reference }
+  let(:group) { create(:group, :public) }
+  let(:project) { create(:project, :public, group: group) }
 
   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}>milestone #{milestone.to_reference}</#{elem}>"
-      expect(reference_filter(act).to_html).to eq exp
+  shared_examples 'reference parsing' do
+    %w(pre code a style).each do |elem|
+      it "ignores valid references contained inside '#{elem}' element" do
+        exp = act = "<#{elem}>milestone #{reference}</#{elem}>"
+        expect(reference_filter(act).to_html).to eq exp
+      end
     end
-  end
 
-  it 'includes default classes' do
-    doc = reference_filter("Milestone #{reference}")
-    expect(doc.css('a').first.attr('class')).to eq 'gfm gfm-milestone has-tooltip'
-  end
+    it 'includes default classes' do
+      doc = reference_filter("Milestone #{reference}")
 
-  it 'includes a data-project attribute' do
-    doc = reference_filter("Milestone #{reference}")
-    link = doc.css('a').first
+      expect(doc.css('a').first.attr('class')).to eq 'gfm gfm-milestone has-tooltip'
+    end
 
-    expect(link).to have_attribute('data-project')
-    expect(link.attr('data-project')).to eq project.id.to_s
-  end
+    it 'includes a data-project attribute' do
+      doc = reference_filter("Milestone #{reference}")
+      link = doc.css('a').first
 
-  it 'includes a data-milestone attribute' do
-    doc = reference_filter("See #{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
 
-    expect(link).to have_attribute('data-milestone')
-    expect(link.attr('data-milestone')).to eq milestone.id.to_s
-  end
+    it 'includes a data-milestone attribute' do
+      doc = reference_filter("See #{reference}")
+      link = doc.css('a').first
+
+      expect(link).to have_attribute('data-milestone')
+      expect(link.attr('data-milestone')).to eq milestone.id.to_s
+    end
 
-  it 'supports an :only_path context' do
-    doc = reference_filter("Milestone #{reference}", only_path: true)
-    link = doc.css('a').first.attr('href')
+    it 'supports an :only_path context' do
+      doc = reference_filter("Milestone #{reference}", only_path: true)
+      link = doc.css('a').first.attr('href')
 
-    expect(link).not_to match %r(https?://)
-    expect(link).to eq urls
-      .project_milestone_path(project, milestone)
+      expect(link).not_to match %r(https?://)
+      expect(link).to eq urls.milestone_path(milestone)
+    end
   end
 
-  context 'Integer-based references' do
+  shared_examples 'Integer-based references' do
     it 'links to a valid reference' do
       doc = reference_filter("See #{reference}")
 
-      expect(doc.css('a').first.attr('href')).to eq urls
-        .project_milestone_url(project, milestone)
+      expect(doc.css('a').first.attr('href')).to eq urls.milestone_url(milestone)
     end
 
     it 'links with adjacent text' do
@@ -68,15 +68,17 @@ describe Banzai::Filter::MilestoneReferenceFilter do
     end
   end
 
-  context 'String-based single-word references' do
-    let(:milestone) { create(:milestone, name: 'gfm', project: project) }
+  shared_examples 'String-based single-word references' do
     let(:reference) { "#{Milestone.reference_prefix}#{milestone.name}" }
 
+    before do
+      milestone.update!(name: 'gfm')
+    end
+
     it 'links to a valid reference' do
       doc = reference_filter("See #{reference}")
 
-      expect(doc.css('a').first.attr('href')).to eq urls
-        .project_milestone_url(project, milestone)
+      expect(doc.css('a').first.attr('href')).to eq urls.milestone_url(milestone)
       expect(doc.text).to eq 'See gfm'
     end
 
@@ -92,15 +94,17 @@ describe Banzai::Filter::MilestoneReferenceFilter do
     end
   end
 
-  context 'String-based multi-word references in quotes' do
-    let(:milestone) { create(:milestone, name: 'gfm references', project: project) }
+  shared_examples 'String-based multi-word references in quotes' do
     let(:reference) { milestone.to_reference(format: :name) }
 
+    before do
+      milestone.update!(name: 'gfm references')
+    end
+
     it 'links to a valid reference' do
       doc = reference_filter("See #{reference}")
 
-      expect(doc.css('a').first.attr('href')).to eq urls
-        .project_milestone_url(project, milestone)
+      expect(doc.css('a').first.attr('href')).to eq urls.milestone_url(milestone)
       expect(doc.text).to eq 'See gfm references'
     end
 
@@ -116,23 +120,27 @@ describe Banzai::Filter::MilestoneReferenceFilter do
     end
   end
 
-  describe 'referencing a milestone in a link href' do
-    let(:reference) { %Q{<a href="#{milestone.to_reference}">Milestone</a>} }
+  shared_examples 'referencing a milestone in a link href' do
+    let(:unquoted_reference) { "#{Milestone.reference_prefix}#{milestone.name}" }
+    let(:link_reference) { %Q{<a href="#{unquoted_reference}">Milestone</a>} }
+
+    before do
+      milestone.update!(name: 'gfm')
+    end
 
     it 'links to a valid reference' do
-      doc = reference_filter("See #{reference}")
+      doc = reference_filter("See #{link_reference}")
 
-      expect(doc.css('a').first.attr('href')).to eq urls
-        .project_milestone_url(project, milestone)
+      expect(doc.css('a').first.attr('href')).to eq urls.milestone_url(milestone)
     end
 
     it 'links with adjacent text' do
-      doc = reference_filter("Milestone (#{reference}.)")
+      doc = reference_filter("Milestone (#{link_reference}.)")
       expect(doc.to_html).to match(%r(\(<a.+>Milestone</a>\.\)))
     end
 
     it 'includes a data-project attribute' do
-      doc = reference_filter("Milestone #{reference}")
+      doc = reference_filter("Milestone #{link_reference}")
       link = doc.css('a').first
 
       expect(link).to have_attribute('data-project')
@@ -140,7 +148,7 @@ describe Banzai::Filter::MilestoneReferenceFilter do
     end
 
     it 'includes a data-milestone attribute' do
-      doc = reference_filter("See #{reference}")
+      doc = reference_filter("See #{link_reference}")
       link = doc.css('a').first
 
       expect(link).to have_attribute('data-milestone')
@@ -148,7 +156,35 @@ describe Banzai::Filter::MilestoneReferenceFilter do
     end
   end
 
-  describe 'cross-project / cross-namespace complete reference' do
+  shared_examples 'linking to a milestone as the entire link' do
+    let(:unquoted_reference) { "#{Milestone.reference_prefix}#{milestone.name}" }
+    let(:link) { urls.milestone_url(milestone) }
+    let(:link_reference) { %Q{<a href="#{link}">#{link}</a>} }
+
+    it 'replaces the link text with the milestone reference' do
+      doc = reference_filter("See #{link}")
+
+      expect(doc.css('a').first.text).to eq(unquoted_reference)
+    end
+
+    it 'includes a data-project attribute' do
+      doc = reference_filter("Milestone #{link_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-milestone attribute' do
+      doc = reference_filter("See #{link_reference}")
+      link = doc.css('a').first
+
+      expect(link).to have_attribute('data-milestone')
+      expect(link.attr('data-milestone')).to eq milestone.id.to_s
+    end
+  end
+
+  shared_examples 'cross-project / cross-namespace complete reference' do
     let(:namespace)       { create(:namespace) }
     let(:another_project) { create(:project, :public, namespace: namespace) }
     let(:milestone)       { create(:milestone, project: another_project) }
@@ -184,7 +220,7 @@ describe Banzai::Filter::MilestoneReferenceFilter do
     end
   end
 
-  describe 'cross-project / same-namespace complete reference' do
+  shared_examples 'cross-project / same-namespace complete reference' do
     let(:namespace)       { create(:namespace) }
     let(:project)         { create(:project, :public, namespace: namespace) }
     let(:another_project) { create(:project, :public, namespace: namespace) }
@@ -221,7 +257,7 @@ describe Banzai::Filter::MilestoneReferenceFilter do
     end
   end
 
-  describe 'cross project shorthand reference' do
+  shared_examples 'cross project shorthand reference' do
     let(:namespace)       { create(:namespace) }
     let(:project)         { create(:project, :public, namespace: namespace) }
     let(:another_project) { create(:project, :public, namespace: namespace) }
@@ -258,27 +294,53 @@ describe Banzai::Filter::MilestoneReferenceFilter do
     end
   end
 
-  describe 'cross project milestone references' do
-    let(:another_project)  { create(:project, :public) }
-    let(:project_path) { another_project.full_path }
-    let(:milestone) { create(:milestone, project: another_project) }
-    let(:reference) { milestone.to_reference(project) }
+  context 'project milestones' do
+    let(:milestone) { create(:milestone, project: project) }
+    let(:reference) { milestone.to_reference }
 
-    let!(:result) { reference_filter("See #{reference}") }
+    include_examples 'reference parsing'
 
-    it 'points to referenced project milestone page' do
-      expect(result.css('a').first.attr('href')).to eq urls
-        .project_milestone_url(another_project, milestone)
+    it_behaves_like 'Integer-based references'
+    it_behaves_like 'String-based single-word references'
+    it_behaves_like 'String-based multi-word references in quotes'
+    it_behaves_like 'referencing a milestone in a link href'
+    it_behaves_like 'cross-project / cross-namespace complete reference'
+    it_behaves_like 'cross-project / same-namespace complete reference'
+    it_behaves_like 'cross project shorthand reference'
+  end
+
+  context 'group milestones' do
+    let(:milestone) { create(:milestone, group: group) }
+    let(:reference) { milestone.to_reference(format: :name) }
+
+    include_examples 'reference parsing'
+
+    it_behaves_like 'String-based single-word references'
+    it_behaves_like 'String-based multi-word references in quotes'
+    it_behaves_like 'referencing a milestone in a link href'
+
+    it 'does not support references by IID' do
+      doc = reference_filter("See #{Milestone.reference_prefix}#{milestone.iid}")
+
+      expect(doc.css('a')).to be_empty
     end
 
-    it 'contains cross project content' do
-      expect(result.css('a').first.text).to eq "#{milestone.name} in #{project_path}"
+    it 'does not support references by link' do
+      doc = reference_filter("See #{urls.milestone_url(milestone)}")
+
+      expect(doc.css('a').first.text).to eq(urls.milestone_url(milestone))
     end
 
-    it 'escapes the name attribute' do
-      allow_any_instance_of(Milestone).to receive(:title).and_return(%{"></a>whatever<a title="})
-      doc = reference_filter("See #{reference}")
-      expect(doc.css('a').first.text).to eq "#{milestone.name} in #{project_path}"
+    it 'does not support cross-project references' do
+      another_group = create(:group)
+      another_project = create(:project, :public, group: group)
+      project_reference = another_project.to_reference(project)
+
+      milestone.update!(group: another_group)
+
+      doc = reference_filter("See #{project_reference}#{reference}")
+
+      expect(doc.css('a')).to be_empty
     end
   end
 end