Merge branch '53907-improve-milestone-links' into 'master'

Add % prefix to milestone reference link text

Closes #53907

See merge request gitlab-org/gitlab-ce!23928

app/models/milestone.rb

@@ -212,7 +212,7 @@ class Milestone < ActiveRecord::Base
   end
 
   def reference_link_text(from = nil)
-    self.title
+    self.class.reference_prefix + self.title
   end
 
   def milestoneish_ids

changelogs/unreleased/53907-improve-milestone-links.yml

+---
+title: Add % prefix to milestone reference links
+merge_request: 23928
+author:
+type: changed

spec/lib/banzai/filter/milestone_reference_filter_spec.rb

@@ -59,7 +59,7 @@ describe Banzai::Filter::MilestoneReferenceFilter do
 
     it 'links with adjacent text' do
       doc = reference_filter("Milestone (#{reference}.)")
-      expect(doc.to_html).to match(%r(\(<a.+>#{milestone.name}</a>\.\)))
+      expect(doc.to_html).to match(%r(\(<a.+>#{milestone.reference_link_text}</a>\.\)))
     end
 
     it 'ignores invalid milestone IIDs' do
@@ -80,12 +80,12 @@ describe Banzai::Filter::MilestoneReferenceFilter do
       doc = reference_filter("See #{reference}")
 
       expect(doc.css('a').first.attr('href')).to eq urls.milestone_url(milestone)
-      expect(doc.text).to eq 'See gfm'
+      expect(doc.text).to eq "See #{milestone.reference_link_text}"
     end
 
     it 'links with adjacent text' do
       doc = reference_filter("Milestone (#{reference}.)")
-      expect(doc.to_html).to match(%r(\(<a.+>#{milestone.name}</a>\.\)))
+      expect(doc.to_html).to match(%r(\(<a.+>#{milestone.reference_link_text}</a>\.\)))
     end
 
     it 'ignores invalid milestone names' do
@@ -106,12 +106,12 @@ describe Banzai::Filter::MilestoneReferenceFilter do
       doc = reference_filter("See #{reference}")
 
       expect(doc.css('a').first.attr('href')).to eq urls.milestone_url(milestone)
-      expect(doc.text).to eq 'See gfm references'
+      expect(doc.text).to eq "See #{milestone.reference_link_text}"
     end
 
     it 'links with adjacent text' do
       doc = reference_filter("Milestone (#{reference}.)")
-      expect(doc.to_html).to match(%r(\(<a.+>#{milestone.name}</a>\.\)))
+      expect(doc.to_html).to match(%r(\(<a.+>#{milestone.reference_link_text}</a>\.\)))
     end
 
     it 'ignores invalid milestone names' do
@@ -201,14 +201,14 @@ describe Banzai::Filter::MilestoneReferenceFilter do
       doc = reference_filter("See (#{reference}.)")
 
       expect(doc.css('a').first.text)
-        .to eq("#{milestone.name} in #{another_project.full_path}")
+        .to eq("#{milestone.reference_link_text} in #{another_project.full_path}")
     end
 
     it 'has valid text' do
       doc = reference_filter("See (#{reference}.)")
 
       expect(doc.text)
-        .to eq("See (#{milestone.name} in #{another_project.full_path}.)")
+        .to eq("See (#{milestone.reference_link_text} in #{another_project.full_path}.)")
     end
 
     it 'escapes the name attribute' do
@@ -217,7 +217,7 @@ describe Banzai::Filter::MilestoneReferenceFilter do
       doc = reference_filter("See #{reference}")
 
       expect(doc.css('a').first.text)
-        .to eq "#{milestone.name} in #{another_project.full_path}"
+        .to eq "#{milestone.reference_link_text} in #{another_project.full_path}"
     end
   end
 
@@ -238,14 +238,14 @@ describe Banzai::Filter::MilestoneReferenceFilter do
       doc = reference_filter("See (#{reference}.)")
 
       expect(doc.css('a').first.text)
-        .to eq("#{milestone.name} in #{another_project.path}")
+        .to eq("#{milestone.reference_link_text} in #{another_project.path}")
     end
 
     it 'has valid text' do
       doc = reference_filter("See (#{reference}.)")
 
       expect(doc.text)
-        .to eq("See (#{milestone.name} in #{another_project.path}.)")
+        .to eq("See (#{milestone.reference_link_text} in #{another_project.path}.)")
     end
 
     it 'escapes the name attribute' do
@@ -254,7 +254,7 @@ describe Banzai::Filter::MilestoneReferenceFilter do
       doc = reference_filter("See #{reference}")
 
       expect(doc.css('a').first.text)
-        .to eq "#{milestone.name} in #{another_project.path}"
+        .to eq "#{milestone.reference_link_text} in #{another_project.path}"
     end
   end
 
@@ -275,14 +275,14 @@ describe Banzai::Filter::MilestoneReferenceFilter do
       doc = reference_filter("See (#{reference}.)")
 
       expect(doc.css('a').first.text)
-        .to eq("#{milestone.name} in #{another_project.path}")
+        .to eq("#{milestone.reference_link_text} in #{another_project.path}")
     end
 
     it 'has valid text' do
       doc = reference_filter("See (#{reference}.)")
 
       expect(doc.text)
-        .to eq("See (#{milestone.name} in #{another_project.path}.)")
+        .to eq("See (#{milestone.reference_link_text} in #{another_project.path}.)")
     end
 
     it 'escapes the name attribute' do
@@ -291,7 +291,7 @@ describe Banzai::Filter::MilestoneReferenceFilter do
       doc = reference_filter("See #{reference}")
 
       expect(doc.css('a').first.text)
-        .to eq "#{milestone.name} in #{another_project.path}"
+        .to eq "#{milestone.reference_link_text} in #{another_project.path}"
     end
   end
 
@@ -346,7 +346,7 @@ describe Banzai::Filter::MilestoneReferenceFilter do
       milestone.update!(group: parent_group)
 
       doc = reference_filter("See #{reference}")
-      expect(doc.css('a').first.text).to eq(milestone.name)
+      expect(doc.css('a').first.text).to eq(milestone.reference_link_text)
     end
   end
 

spec/models/milestone_spec.rb

@@ -316,6 +316,15 @@ describe Milestone do
     end
   end
 
+  describe '#reference_link_text' do
+    let(:project) { build_stubbed(:project, name: 'sample-project') }
+    let(:milestone) { build_stubbed(:milestone, iid: 1, project: project, name: 'milestone') }
+
+    it 'returns the title with the reference prefix' do
+      expect(milestone.reference_link_text).to eq '%milestone'
+    end
+  end
+
   describe '#participants' do
     let(:project) { build(:project, name: 'sample-project') }
     let(:milestone) { build(:milestone, iid: 1, project: project) }