Merge branch 'fix-42459-#-in-branch' into 'master'

changelogs/unreleased/fix-42459---in-branch.yml

+---
+title: Fix relative uri when "#" is in branch name
+merge_request:
+author: Jan
+type: fixed

lib/banzai/filter/relative_link_filter.rb

@@ -84,7 +84,7 @@ module Banzai
           relative_url_root,
           project.full_path,
           uri_type(file_path),
-          Addressable::URI.escape(ref),
+          Addressable::URI.escape(ref).gsub('#', '%23'),
           Addressable::URI.escape(file_path)
         ].compact.join('/').squeeze('/').chomp('/')
 

spec/lib/banzai/filter/relative_link_filter_spec.rb

@@ -217,6 +217,23 @@ describe Banzai::Filter::RelativeLinkFilter do
       end
     end
 
+    context 'when ref name contains special chars' do
+      let(:ref) {'mark#\'@],+;-._/#@!$&()+down'}
+
+      it 'correctly escapes the ref' do
+        # Adressable won't escape the '#', so we do this manually
+        ref_escaped = 'mark%23\'@%5D,+;-._/%23@!$&()+down'
+
+        # Stub this method so the branch doesn't actually need to be in the repo
+        allow_any_instance_of(described_class).to receive(:uri_type).and_return(:raw)
+
+        doc = filter(link('files/images/logo-black.png'))
+
+        expect(doc.at_css('a')['href'])
+          .to eq "/#{project_path}/raw/#{ref_escaped}/files/images/logo-black.png"
+      end
+    end
+
     context 'when requested path is a directory with space in the repo' do
       let(:ref) { 'master' }
       let(:commit) { project.commit('38008cb17ce1466d8fec2dfa6f6ab8dcfe5cf49e') }