A working implementation of a project reference filter which links project references to project profile.

3 files changed, 188 insertions, 0 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..2ace8496b08
--- /dev/null
+++ b/spec/lib/banzai/filter/project_reference_filter_spec.rb
@@ -0,0 +1,149 @@
+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) }
+  let(:reference) { get_reference(project) }
+
+  it 'ignores invalid projects' do
+    exp = act = "Hey #{invalidate_reference(reference)}"
+
+    expect(reference_filter(act).to_html).to eq(CGI.escapeHTML(exp))
+  end
+
+  it 'ignores references with text after the > sign' do
+    exp = act = "Hey #{reference}foo"
+    expect(reference_filter(act).to_html).to eq CGI.escapeHTML(exp)
+  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
+
+  context 'mentioning a project' do
+    it_behaves_like 'a reference containing an element node'
+
+    it 'links to a Project' do
+      doc = reference_filter("Hey #{reference}")
+      expect(doc.css('a').first.attr('href')).to eq urls.project_url(project)
+    end
+
+    it 'links to a Project with a period' do
+      project = create(:project, name: 'alphA.Beta')
+
+      doc = reference_filter("Hey #{get_reference(project)}")
+      expect(doc.css('a').length).to eq 1
+    end
+
+    it 'links to a Project with an underscore' do
+      project = create(:project, name: 'ping_pong_king')
+
+      doc = reference_filter("Hey #{get_reference(project)}")
+      expect(doc.css('a').length).to eq 1
+    end
+
+    it 'links to a Project with different case-sensitivity' do
+      project = create(:project, name: 'RescueRanger')
+      reference = get_reference(project)
+
+      doc = reference_filter("Hey #{reference.upcase}")
+      expect(doc.css('a').length).to eq 1
+      expect(doc.css('a').text).to eq(reference)
+    end
+
+    it 'includes a data-project attribute' do
+      doc = reference_filter("Hey #{reference}")
+      link = doc.css('a').first
+
+      expect(link).to have_attribute('data-project')
+      expect(link.attr('data-project')).to eq project.namespace.owner_id.to_s
+    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
+
+  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.project_path(project)
+  end
+
+  context 'referencing a project in a link href' do
+    let(:reference) { %Q{<a href="#{get_reference(project)}">Project</a>} }
+
+    it 'links to a Project' do
+      doc = reference_filter("Hey #{reference}")
+      expect(doc.css('a').first.attr('href')).to eq urls.project_url(project)
+    end
+
+    it 'links with adjacent text' do
+      doc = reference_filter("Mention me (#{reference}.)")
+      expect(doc.to_html).to match(%r{\(<a.+>Project</a>\.\)})
+    end
+
+    it 'includes a data-project attribute' do
+      doc = reference_filter("Hey #{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
+  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/reference_parser/project_parser_spec.rb b/spec/lib/banzai/reference_parser/project_parser_spec.rb
new file mode 100644
index 00000000000..4a6c2294fbd
--- /dev/null
+++ b/spec/lib/banzai/reference_parser/project_parser_spec.rb
@@ -0,0 +1,30 @@
+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.referenced_by([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.referenced_by([link])).to eq([])
+        end
+      end
+    end
+  end
+end
diff --git a/spec/models/project_spec.rb b/spec/models/project_spec.rb
index abdc65336ca..acc7821a21e 100644
--- a/spec/models/project_spec.rb
+++ b/spec/models/project_spec.rb
@@ -344,6 +344,15 @@ describe Project do
     it { is_expected.to delegate_method(:name).to(:owner).with_prefix(true).with_arguments(allow_nil: true) }
   end
 
+  describe '#to_reference_with_postfix' do
+    it 'returns the full path with reference_postfix' do
+      namespace = create(:namespace, path: 'sample-namespace')
+      project = create(:project, path: 'sample-project', namespace: namespace)
+
+      expect(project.to_reference_with_postfix).to eq 'sample-namespace/sample-project>'
+    end
+  end
+
   describe '#to_reference' do
     let(:owner)     { create(:user, name: 'Gitlab') }
     let(:namespace) { create(:namespace, path: 'sample-namespace', owner: owner) }