Only yield valid references in ReferenceFilter.references_inonly-yield-valid-reference-matches

3 files changed, 33 insertions, 2 deletions

diff --git a/changelogs/unreleased/only-yield-valid-reference-matches.yml b/changelogs/unreleased/only-yield-valid-reference-matches.yml
new file mode 100644
index 00000000000..95da3cc56fd
--- /dev/null
+++ b/changelogs/unreleased/only-yield-valid-reference-matches.yml
@@ -0,0 +1,4 @@
+---
+title: Only yield valid references in ReferenceFilter.references_in
+merge_request:
+author:
diff --git a/lib/banzai/filter/abstract_reference_filter.rb b/lib/banzai/filter/abstract_reference_filter.rb
index 955d857c679..3b15ff6566f 100644
--- a/lib/banzai/filter/abstract_reference_filter.rb
+++ b/lib/banzai/filter/abstract_reference_filter.rb
@@ -33,7 +33,12 @@ module Banzai
       # Returns a String replaced with the return of the block.
       def self.references_in(text, pattern = object_class.reference_pattern)
         text.gsub(pattern) do |match|
-          yield match, $~[object_sym].to_i, $~[:project], $~[:namespace], $~
+          symbol = $~[object_sym]
+          if object_class.reference_valid?(symbol)
+            yield match, symbol.to_i, $~[:project], $~[:namespace], $~
+          else
+            match
+          end
         end
       end
 
diff --git a/spec/lib/banzai/filter/issue_reference_filter_spec.rb b/spec/lib/banzai/filter/issue_reference_filter_spec.rb
index 456dbac0698..11607d4fb26 100644
--- a/spec/lib/banzai/filter/issue_reference_filter_spec.rb
+++ b/spec/lib/banzai/filter/issue_reference_filter_spec.rb
@@ -311,7 +311,7 @@ describe Banzai::Filter::IssueReferenceFilter, lib: true do
     end
   end
 
-  describe '#issues_per_Project' do
+  describe '#issues_per_project' do
     context 'using an internal issue tracker' do
       it 'returns a Hash containing the issues per project' do
         doc = Nokogiri::HTML.fragment('')
@@ -346,4 +346,26 @@ describe Banzai::Filter::IssueReferenceFilter, lib: true do
       end
     end
   end
+
+  describe '.references_in' do
+    let(:merge_request)  { create(:merge_request) }
+
+    it 'yields valid references' do
+      expect do |b|
+        described_class.references_in(issue.to_reference, &b)
+      end.to yield_with_args(issue.to_reference, issue.iid, nil, nil, MatchData)
+    end
+
+    it "doesn't yield invalid references" do
+      expect do |b|
+        described_class.references_in('#0', &b)
+      end.not_to yield_control
+    end
+
+    it "doesn't yield unsupported references" do
+      expect do |b|
+        described_class.references_in(merge_request.to_reference, &b)
+      end.not_to yield_control
+    end
+  end
 end