Merge branch '28930-add-project-reference-filter' into 'master'

Resolve "GFM : provide 'project' reference in comment"

Closes #28930

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

3 files changed, 143 insertions, 73 deletions

diff --git a/spec/lib/banzai/filter/project_reference_filter_spec.rb b/spec/lib/banzai/filter/project_reference_filter_spec.rb
new file mode 100644
index 00000000000..13e1fc2d3e2
--- /dev/null
+++ b/spec/lib/banzai/filter/project_reference_filter_spec.rb
@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Banzai::Filter::ProjectReferenceFilter do
+  include FilterSpecHelper
+
+  def invalidate_reference(reference)
+    "#{reference.reverse}"
+  end
+
+  def get_reference(project)
+    project.to_reference_with_postfix
+  end
+
+  let(:project)   { create(:project, :public) }
+  subject { project }
+  let(:subject_name) { "project" }
+  let(:reference) { get_reference(project) }
+
+  it_behaves_like 'user reference or project reference'
+
+  it 'ignores invalid projects' do
+    exp = act = "Hey #{invalidate_reference(reference)}"
+
+    expect(reference_filter(act).to_html).to eq(CGI.escapeHTML(exp))
+  end
+
+  it 'allows references with text after the > character' do
+    doc = reference_filter("Hey #{reference}foo")
+    expect(doc.css('a').first.attr('href')).to eq urls.project_url(subject)
+  end
+
+  %w(pre code a style).each do |elem|
+    it "ignores valid references contained inside '#{elem}' element" do
+      exp = act = "<#{elem}>Hey #{CGI.escapeHTML(reference)}</#{elem}>"
+      expect(reference_filter(act).to_html).to eq exp
+    end
+  end
+
+  it 'includes default classes' do
+    doc = reference_filter("Hey #{reference}")
+    expect(doc.css('a').first.attr('class')).to eq 'gfm gfm-project has-tooltip'
+  end
+
+  context 'in group context' do
+    let(:group) { create(:group) }
+    let(:project) { create(:project, group: group) }
+
+    let(:nested_group) { create(:group, :nested) }
+    let(:nested_project) { create(:project, group: nested_group) }
+
+    it 'supports mentioning a project' do
+      reference = get_reference(project)
+      doc = reference_filter("Hey #{reference}")
+
+      expect(doc.css('a').first.attr('href')).to eq urls.project_url(project)
+    end
+
+    it 'supports mentioning a project in a nested group' do
+      reference = get_reference(nested_project)
+      doc = reference_filter("Hey #{reference}")
+
+      expect(doc.css('a').first.attr('href')).to eq urls.project_url(nested_project)
+    end
+  end
+
+  describe '#projects_hash' do
+    it 'returns a Hash containing all Projects' do
+      document = Nokogiri::HTML.fragment("<p>#{get_reference(project)}</p>")
+      filter = described_class.new(document, project: project)
+
+      expect(filter.projects_hash).to eq({ project.full_path => project })
+    end
+  end
+
+  describe '#projects' do
+    it 'returns the projects mentioned in a document' do
+      document = Nokogiri::HTML.fragment("<p>#{get_reference(project)}</p>")
+      filter = described_class.new(document, project: project)
+
+      expect(filter.projects).to eq([project.full_path])
+    end
+  end
+end
diff --git a/spec/lib/banzai/filter/user_reference_filter_spec.rb b/spec/lib/banzai/filter/user_reference_filter_spec.rb
index 2f86a046d28..334d29a5368 100644
--- a/spec/lib/banzai/filter/user_reference_filter_spec.rb
+++ b/spec/lib/banzai/filter/user_reference_filter_spec.rb
@@ -3,9 +3,17 @@ require 'spec_helper'
 describe Banzai::Filter::UserReferenceFilter do
   include FilterSpecHelper
 
+  def get_reference(user)
+    user.to_reference
+  end
+
   let(:project)   { create(:project, :public) }
   let(:user)      { create(:user) }
-  let(:reference) { user.to_reference }
+  subject { user }
+  let(:subject_name) { "user" }
+  let(:reference) { get_reference(user) }
+
+  it_behaves_like 'user reference or project reference'
 
   it 'requires project context' do
     expect { described_class.call('') }.to raise_error(ArgumentError, /:project/)
@@ -66,45 +74,6 @@ describe Banzai::Filter::UserReferenceFilter do
     end
   end
 
-  context 'mentioning a user' do
-    it_behaves_like 'a reference containing an element node'
-
-    it 'links to a User' do
-      doc = reference_filter("Hey #{reference}")
-      expect(doc.css('a').first.attr('href')).to eq urls.user_url(user)
-    end
-
-    it 'links to a User with a period' do
-      user = create(:user, name: 'alphA.Beta')
-
-      doc = reference_filter("Hey #{user.to_reference}")
-      expect(doc.css('a').length).to eq 1
-    end
-
-    it 'links to a User with an underscore' do
-      user = create(:user, name: 'ping_pong_king')
-
-      doc = reference_filter("Hey #{user.to_reference}")
-      expect(doc.css('a').length).to eq 1
-    end
-
-    it 'links to a User with different case-sensitivity' do
-      user = create(:user, username: 'RescueRanger')
-
-      doc = reference_filter("Hey #{user.to_reference.upcase}")
-      expect(doc.css('a').length).to eq 1
-      expect(doc.css('a').text).to eq(user.to_reference)
-    end
-
-    it 'includes a data-user attribute' do
-      doc = reference_filter("Hey #{reference}")
-      link = doc.css('a').first
-
-      expect(link).to have_attribute('data-user')
-      expect(link.attr('data-user')).to eq user.namespace.owner_id.to_s
-    end
-  end
-
   context 'mentioning a group' do
     it_behaves_like 'a reference containing an element node'
 
@@ -154,36 +123,6 @@ describe Banzai::Filter::UserReferenceFilter do
     expect(doc.css('a').first.attr('class')).to eq 'gfm gfm-project_member has-tooltip'
   end
 
-  it 'supports an :only_path context' do
-    doc = reference_filter("Hey #{reference}", only_path: true)
-    link = doc.css('a').first.attr('href')
-
-    expect(link).not_to match %r(https?://)
-    expect(link).to eq urls.user_path(user)
-  end
-
-  context 'referencing a user in a link href' do
-    let(:reference) { %Q{<a href="#{user.to_reference}">User</a>} }
-
-    it 'links to a User' do
-      doc = reference_filter("Hey #{reference}")
-      expect(doc.css('a').first.attr('href')).to eq urls.user_url(user)
-    end
-
-    it 'links with adjacent text' do
-      doc = reference_filter("Mention me (#{reference}.)")
-      expect(doc.to_html).to match(%r{\(<a.+>User</a>\.\)})
-    end
-
-    it 'includes a data-user attribute' do
-      doc = reference_filter("Hey #{reference}")
-      link = doc.css('a').first
-
-      expect(link).to have_attribute('data-user')
-      expect(link.attr('data-user')).to eq user.namespace.owner_id.to_s
-    end
-  end
-
   context 'when a project is not specified' do
     let(:project) { nil }
 
@@ -227,7 +166,7 @@ describe Banzai::Filter::UserReferenceFilter do
     end
 
     it 'supports mentioning a single user' do
-      reference = group_member.to_reference
+      reference = get_reference(group_member)
       doc = reference_filter("Hey #{reference}", context)
 
       expect(doc.css('a').first.attr('href')).to eq urls.user_url(group_member)
@@ -243,7 +182,7 @@ describe Banzai::Filter::UserReferenceFilter do
 
   describe '#namespaces' do
     it 'returns a Hash containing all Namespaces' do
-      document = Nokogiri::HTML.fragment("<p>#{user.to_reference}</p>")
+      document = Nokogiri::HTML.fragment("<p>#{get_reference(user)}</p>")
       filter = described_class.new(document, project: project)
       ns = user.namespace
 
@@ -253,7 +192,7 @@ describe Banzai::Filter::UserReferenceFilter do
 
   describe '#usernames' do
     it 'returns the usernames mentioned in a document' do
-      document = Nokogiri::HTML.fragment("<p>#{user.to_reference}</p>")
+      document = Nokogiri::HTML.fragment("<p>#{get_reference(user)}</p>")
       filter = described_class.new(document, project: project)
 
       expect(filter.usernames).to eq([user.username])
diff --git a/spec/lib/banzai/reference_parser/project_parser_spec.rb b/spec/lib/banzai/reference_parser/project_parser_spec.rb
new file mode 100644
index 00000000000..c6a4d15e47c
--- /dev/null
+++ b/spec/lib/banzai/reference_parser/project_parser_spec.rb
@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Banzai::ReferenceParser::ProjectParser do
+  include ReferenceParserHelpers
+
+  let(:project) { create(:project, :public) }
+  let(:user) { create(:user) }
+  subject { described_class.new(Banzai::RenderContext.new(project, user)) }
+  let(:link) { empty_html_link }
+
+  describe '#referenced_by' do
+    describe 'when the link has a data-project attribute' do
+      context 'using an existing project ID' do
+        it 'returns an Array of projects' do
+          link['data-project'] = project.id.to_s
+
+          expect(subject.gather_references([link])).to eq([project])
+        end
+      end
+
+      context 'using a non-existing project ID' do
+        it 'returns an empty Array' do
+          link['data-project'] = ''
+
+          expect(subject.gather_references([link])).to eq([])
+        end
+      end
+
+      context 'using a private project ID' do
+        it 'returns an empty Array when unauthorized' do
+          private_project = create(:project, :private)
+
+          link['data-project'] = private_project.id.to_s
+
+          expect(subject.gather_references([link])).to eq([])
+        end
+
+        it 'returns an Array when authorized' do
+          private_project = create(:project, :private, namespace: user.namespace)
+
+          link['data-project'] = private_project.id.to_s
+
+          expect(subject.gather_references([link])).to eq([private_project])
+        end
+      end
+    end
+  end
+end