# frozen_string_literal: true require 'spec_helper' require 'html/pipeline' describe Banzai::Filter::LabelReferenceFilter do include FilterSpecHelper let(:project) { create(:project, :public, name: 'sample-project') } let(:label) { create(:label, project: project) } let(:reference) { label.to_reference } it 'requires project context' do expect { described_class.call('') }.to raise_error(ArgumentError, /:project/) end %w(pre code a style).each do |elem| it "ignores valid references contained inside '#{elem}' element" do exp = act = "<#{elem}>Label #{reference}" expect(reference_filter(act).to_html).to eq exp end end it 'includes default classes' do doc = reference_filter("Label #{reference}") expect(doc.css('a').first.attr('class')).to eq 'gfm gfm-label has-tooltip' end it 'includes a data-project attribute' do doc = reference_filter("Label #{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 it 'includes a data-label attribute' do doc = reference_filter("See #{reference}") link = doc.css('a').first expect(link).to have_attribute('data-label') expect(link.attr('data-label')).to eq label.id.to_s end it 'supports an :only_path context' do doc = reference_filter("Label #{reference}", only_path: true) link = doc.css('a').first.attr('href') expect(link).not_to match %r(https?://) expect(link).to eq urls.project_issues_path(project, label_name: label.name) end context 'project that does not exist referenced' do let(:result) { reference_filter('aaa/bbb~ccc') } it 'does not link reference' do expect(result.to_html).to eq 'aaa/bbb~ccc' end end describe 'label span element' do it 'includes default classes' do doc = reference_filter("Label #{reference}") expect(doc.css('a span').first.attr('class')).to eq 'badge color-label has-tooltip' end it 'includes a style attribute' do doc = reference_filter("Label #{reference}") expect(doc.css('a span').first.attr('style')).to match(/\Abackground-color: #\h{6}; color: #\h{6}\z/) end end context 'Integer-based references' do it 'links to a valid reference' do doc = reference_filter("See #{reference}") expect(doc.css('a').first.attr('href')).to eq urls .project_issues_url(project, label_name: label.name) end it 'links with adjacent text' do doc = reference_filter("Label (#{reference}.)") expect(doc.to_html).to match(%r(\(#{label.name}\.\))) end it 'ignores invalid label IDs' do exp = act = "Label #{invalidate_reference(reference)}" expect(reference_filter(act).to_html).to eq exp end end context 'String-based single-word references' do let(:label) { create(:label, name: 'gfm', project: project) } let(:reference) { "#{Label.reference_prefix}#{label.name}" } it 'links to a valid reference' do doc = reference_filter("See #{reference}") expect(doc.css('a').first.attr('href')).to eq urls .project_issues_url(project, label_name: label.name) expect(doc.text).to eq 'See gfm' end it 'links with adjacent text' do doc = reference_filter("Label (#{reference}).") expect(doc.to_html).to match(%r(\(#{label.name}\)\.)) end it 'ignores invalid label names' do exp = act = "Label #{Label.reference_prefix}#{label.name.reverse}" expect(reference_filter(act).to_html).to eq exp end end context 'String-based single-word references that begin with a digit' do let(:label) { create(:label, name: '2fa', project: project) } let(:reference) { "#{Label.reference_prefix}#{label.name}" } it 'links to a valid reference' do doc = reference_filter("See #{reference}") expect(doc.css('a').first.attr('href')).to eq urls .project_issues_url(project, label_name: label.name) expect(doc.text).to eq 'See 2fa' end it 'links with adjacent text' do doc = reference_filter("Label (#{reference}).") expect(doc.to_html).to match(%r(\(#{label.name}\)\.)) end it 'ignores invalid label names' do exp = act = "Label #{Label.reference_prefix}#{label.id}#{label.name.reverse}" expect(reference_filter(act).to_html).to eq exp end end context 'String-based single-word references with special characters' do let(:label) { create(:label, name: '?g.fm&', project: project) } let(:reference) { "#{Label.reference_prefix}#{label.name}" } it 'links to a valid reference' do doc = reference_filter("See #{reference}") expect(doc.css('a').first.attr('href')).to eq urls .project_issues_url(project, label_name: label.name) expect(doc.text).to eq 'See ?g.fm&' end it 'does not include trailing punctuation', :aggregate_failures do ['.', ', ok?', '...', '?', '!', ': is that ok?'].each do |trailing_punctuation| doc = filter("Label #{reference}#{trailing_punctuation}") expect(doc.to_html).to match(%r(\?g\.fm&#{Regexp.escape(trailing_punctuation)})) end end it 'ignores invalid label names' do act = "Label #{Label.reference_prefix}#{label.name.reverse}" exp = "Label #{Label.reference_prefix}&mf.g?" expect(reference_filter(act).to_html).to eq exp end end context 'String-based multi-word references in quotes' do let(:label) { create(:label, name: 'gfm references', project: project) } let(:reference) { label.to_reference(format: :name) } it 'links to a valid reference' do doc = reference_filter("See #{reference}") expect(doc.css('a').first.attr('href')).to eq urls .project_issues_url(project, label_name: label.name) expect(doc.text).to eq 'See gfm references' end it 'links with adjacent text' do doc = reference_filter("Label (#{reference}.)") expect(doc.to_html).to match(%r(\(#{label.name}\.\))) end it 'ignores invalid label names' do exp = act = %(Label #{Label.reference_prefix}"#{label.name.reverse}") expect(reference_filter(act).to_html).to eq exp end end context 'String-based multi-word references that begin with a digit' do let(:label) { create(:label, name: '2 factor authentication', project: project) } let(:reference) { label.to_reference(format: :name) } it 'links to a valid reference' do doc = reference_filter("See #{reference}") expect(doc.css('a').first.attr('href')).to eq urls .project_issues_url(project, label_name: label.name) expect(doc.text).to eq 'See 2 factor authentication' end it 'links with adjacent text' do doc = reference_filter("Label (#{reference}.)") expect(doc.to_html).to match(%r(\(#{label.name}\.\))) end it 'ignores invalid label names' do exp = act = "Label #{Label.reference_prefix}#{label.id}#{label.name.reverse}" expect(reference_filter(act).to_html).to eq exp end end context 'String-based multi-word references with special characters in quotes' do let(:label) { create(:label, name: 'g.fm & references?', project: project) } let(:reference) { label.to_reference(format: :name) } it 'links to a valid reference' do doc = reference_filter("See #{reference}") expect(doc.css('a').first.attr('href')).to eq urls .project_issues_url(project, label_name: label.name) expect(doc.text).to eq 'See g.fm & references?' end it 'links with adjacent text' do doc = reference_filter("Label (#{reference}.)") expect(doc.to_html).to match(%r(\(g\.fm & references\?\.\))) end it 'ignores invalid label names' do act = %(Label #{Label.reference_prefix}"#{label.name.reverse}") exp = %(Label #{Label.reference_prefix}"?secnerefer & mf.g\") expect(reference_filter(act).to_html).to eq exp end end context 'References with html entities' do let!(:label) { create(:label, name: '<html>', project: project) } it 'links to a valid reference' do doc = reference_filter('See ~"<html>"') expect(doc.css('a').first.attr('href')).to eq urls .project_issues_url(project, label_name: label.name) expect(doc.text).to eq 'See ' end it 'ignores invalid label names and escapes entities' do act = %(Label #{Label.reference_prefix}"<non valid>") expect(reference_filter(act).to_html).to eq act end end describe 'consecutive references' do let(:bug) { create(:label, name: 'bug', project: project) } let(:feature_proposal) { create(:label, name: 'feature proposal', project: project) } let(:technical_debt) { create(:label, name: 'technical debt', project: project) } let(:bug_reference) { "#{Label.reference_prefix}#{bug.name}" } let(:feature_proposal_reference) { feature_proposal.to_reference(format: :name) } let(:technical_debt_reference) { technical_debt.to_reference(format: :name) } context 'separated with a comma' do let(:references) { "#{bug_reference}, #{feature_proposal_reference}, #{technical_debt_reference}" } it 'links to valid references' do doc = reference_filter("See #{references}") expect(doc.css('a').map { |a| a.attr('href') }).to match_array([ urls.project_issues_url(project, label_name: bug.name), urls.project_issues_url(project, label_name: feature_proposal.name), urls.project_issues_url(project, label_name: technical_debt.name) ]) expect(doc.text).to eq 'See bug, feature proposal, technical debt' end end context 'separated with a space' do let(:references) { "#{bug_reference} #{feature_proposal_reference} #{technical_debt_reference}" } it 'links to valid references' do doc = reference_filter("See #{references}") expect(doc.css('a').map { |a| a.attr('href') }).to match_array([ urls.project_issues_url(project, label_name: bug.name), urls.project_issues_url(project, label_name: feature_proposal.name), urls.project_issues_url(project, label_name: technical_debt.name) ]) expect(doc.text).to eq 'See bug feature proposal technical debt' end end end describe 'edge cases' do it 'gracefully handles non-references matching the pattern' do exp = act = '(format nil "~0f" 3.0) ; 3.0' expect(reference_filter(act).to_html).to eq exp end end describe 'referencing a label in a link href' do let(:reference) { %Q{Label} } it 'links to a valid reference' do doc = reference_filter("See #{reference}") expect(doc.css('a').first.attr('href')).to eq urls .project_issues_url(project, label_name: label.name) end it 'links with adjacent text' do doc = reference_filter("Label (#{reference}.)") expect(doc.to_html).to match(%r(\(Label\.\))) end it 'includes a data-project attribute' do doc = reference_filter("Label #{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 it 'includes a data-label attribute' do doc = reference_filter("See #{reference}") link = doc.css('a').first expect(link).to have_attribute('data-label') expect(link.attr('data-label')).to eq label.id.to_s end end describe 'group label references' do let(:group) { create(:group) } let(:project) { create(:project, :public, namespace: group) } let(:group_label) { create(:group_label, name: 'gfm references', group: group) } context 'without project reference' do let(:reference) { group_label.to_reference(format: :name) } it 'links to a valid reference' do doc = reference_filter("See #{reference}", project: project) expect(doc.css('a').first.attr('href')).to eq urls .project_issues_url(project, label_name: group_label.name) expect(doc.text).to eq 'See gfm references' end it 'links with adjacent text' do doc = reference_filter("Label (#{reference}.)") expect(doc.to_html).to match(%r(\(#{group_label.name}\.\))) end it 'ignores invalid label names' do exp = act = %(Label #{Label.reference_prefix}"#{group_label.name.reverse}") expect(reference_filter(act).to_html).to eq exp end end context 'with project reference' do let(:reference) { "#{project.to_reference}#{group_label.to_reference(format: :name)}" } it 'links to a valid reference' do doc = reference_filter("See #{reference}", project: project) expect(doc.css('a').first.attr('href')).to eq urls .project_issues_url(project, label_name: group_label.name) expect(doc.text).to eq "See gfm references" end it 'links with adjacent text' do doc = reference_filter("Label (#{reference}.)") expect(doc.to_html).to match(%r(\(#{group_label.name}\.\))) end it 'ignores invalid label names' do exp = act = %(Label #{project.to_reference}#{Label.reference_prefix}"#{group_label.name.reverse}") expect(reference_filter(act).to_html).to eq exp end end end describe 'cross-project / cross-namespace complete reference' do let(:project2) { create(:project) } let(:label) { create(:label, project: project2, color: '#00ff00') } let(:reference) { "#{project2.full_path}~#{label.name}" } let!(:result) { reference_filter("See #{reference}") } it 'links to a valid reference' do expect(result.css('a').first.attr('href')) .to eq urls.project_issues_url(project2, label_name: label.name) end it 'has valid color' do expect(result.css('a span').first.attr('style')).to match /background-color: #00ff00/ end it 'has valid link text' do expect(result.css('a').first.text).to eq "#{label.name} in #{project2.full_name}" end it 'has valid text' do expect(result.text).to eq "See #{label.name} in #{project2.full_name}" end it 'ignores invalid IDs on the referenced label' do exp = act = "See #{invalidate_reference(reference)}" expect(reference_filter(act).to_html).to eq exp end end describe 'cross-project / same-namespace complete reference' do let(:namespace) { create(:namespace) } let(:project) { create(:project, namespace: namespace) } let(:project2) { create(:project, namespace: namespace) } let(:label) { create(:label, project: project2, color: '#00ff00') } let(:reference) { "#{project2.full_path}~#{label.name}" } let!(:result) { reference_filter("See #{reference}") } it 'links to a valid reference' do expect(result.css('a').first.attr('href')) .to eq urls.project_issues_url(project2, label_name: label.name) end it 'has valid color' do expect(result.css('a span').first.attr('style')).to match /background-color: #00ff00/ end it 'has valid link text' do expect(result.css('a').first.text).to eq "#{label.name} in #{project2.name}" end it 'has valid text' do expect(result.text).to eq "See #{label.name} in #{project2.name}" end it 'ignores invalid IDs on the referenced label' do exp = act = "See #{invalidate_reference(reference)}" expect(reference_filter(act).to_html).to eq exp end end describe 'cross-project shorthand reference' do let(:namespace) { create(:namespace) } let(:project) { create(:project, namespace: namespace) } let(:project2) { create(:project, namespace: namespace) } let(:label) { create(:label, project: project2, color: '#00ff00') } let(:reference) { "#{project2.path}~#{label.name}" } let!(:result) { reference_filter("See #{reference}") } it 'links to a valid reference' do expect(result.css('a').first.attr('href')) .to eq urls.project_issues_url(project2, label_name: label.name) end it 'has valid color' do expect(result.css('a span').first.attr('style')) .to match /background-color: #00ff00/ end it 'has valid link text' do expect(result.css('a').first.text).to eq "#{label.name} in #{project2.name}" end it 'has valid text' do expect(result.text).to eq "See #{label.name} in #{project2.name}" end it 'ignores invalid IDs on the referenced label' do exp = act = "See #{invalidate_reference(reference)}" expect(reference_filter(act).to_html).to eq exp end end describe 'cross group label references' do let(:group) { create(:group) } let(:project) { create(:project, :public, namespace: group) } let(:another_group) { create(:group) } let(:another_project) { create(:project, :public, namespace: another_group) } let(:group_label) { create(:group_label, group: another_group, color: '#00ff00') } let(:reference) { "#{another_project.full_path}~#{group_label.name}" } let!(:result) { reference_filter("See #{reference}", project: project) } it 'points to referenced project issues page' do expect(result.css('a').first.attr('href')) .to eq urls.project_issues_url(another_project, label_name: group_label.name) end it 'has valid color' do expect(result.css('a span').first.attr('style')) .to match /background-color: #00ff00/ end it 'has valid link text' do expect(result.css('a').first.text) .to eq "#{group_label.name} in #{another_project.full_name}" end it 'has valid text' do expect(result.text) .to eq "See #{group_label.name} in #{another_project.full_name}" end it 'ignores invalid IDs on the referenced label' do exp = act = "See #{invalidate_reference(reference)}" expect(reference_filter(act).to_html).to eq exp end end describe 'cross-project / same-group_label complete reference' do let(:group) { create(:group) } let(:project) { create(:project, :public, namespace: group) } let(:another_project) { create(:project, :public, namespace: group) } let(:group_label) { create(:group_label, group: group, color: '#00ff00') } let(:reference) { "#{another_project.full_path}~#{group_label.name}" } let!(:result) { reference_filter("See #{reference}", project: project) } it 'points to referenced project issues page' do expect(result.css('a').first.attr('href')) .to eq urls.project_issues_url(another_project, label_name: group_label.name) end it 'has valid color' do expect(result.css('a span').first.attr('style')) .to match /background-color: #00ff00/ end it 'has valid link text' do expect(result.css('a').first.text) .to eq "#{group_label.name} in #{another_project.name}" end it 'has valid text' do expect(result.text) .to eq "See #{group_label.name} in #{another_project.name}" end it 'ignores invalid IDs on the referenced label' do exp = act = "See #{invalidate_reference(reference)}" expect(reference_filter(act).to_html).to eq exp end end describe 'same project / same group_label complete reference' do let(:group) { create(:group) } let(:project) { create(:project, :public, namespace: group) } let(:group_label) { create(:group_label, group: group, color: '#00ff00') } let(:reference) { "#{project.full_path}~#{group_label.name}" } let!(:result) { reference_filter("See #{reference}", project: project) } it 'points to referenced project issues page' do expect(result.css('a').first.attr('href')) .to eq urls.project_issues_url(project, label_name: group_label.name) end it 'has valid color' do expect(result.css('a span').first.attr('style')) .to match /background-color: #00ff00/ end it 'has valid link text' do expect(result.css('a').first.text).to eq group_label.name end it 'has valid text' do expect(result.text).to eq "See #{group_label.name}" end it 'ignores invalid IDs on the referenced label' do exp = act = "See #{invalidate_reference(reference)}" expect(reference_filter(act).to_html).to eq exp end end describe 'same project / same group_label shorthand reference' do let(:group) { create(:group) } let(:project) { create(:project, :public, namespace: group) } let(:group_label) { create(:group_label, group: group, color: '#00ff00') } let(:reference) { "#{project.path}~#{group_label.name}" } let!(:result) { reference_filter("See #{reference}", project: project) } it 'points to referenced project issues page' do expect(result.css('a').first.attr('href')) .to eq urls.project_issues_url(project, label_name: group_label.name) end it 'has valid color' do expect(result.css('a span').first.attr('style')) .to match /background-color: #00ff00/ end it 'has valid link text' do expect(result.css('a').first.text).to eq group_label.name end it 'has valid text' do expect(result.text).to eq "See #{group_label.name}" end it 'ignores invalid IDs on the referenced label' do exp = act = "See #{invalidate_reference(reference)}" expect(reference_filter(act).to_html).to eq exp end end describe 'group context' do it 'points to the page defined in label_url_method' do group = create(:group) label = create(:group_label, group: group) reference = "~#{label.name}" result = reference_filter("See #{reference}", { project: nil, group: group, label_url_method: :group_url } ) expect(result.css('a').first.attr('href')).to eq(urls.group_url(group, label_name: label.name)) end it 'finds labels also in ancestor groups' do group = create(:group) label = create(:group_label, group: group) subgroup = create(:group, parent: group) reference = "~#{label.name}" result = reference_filter("See #{reference}", { project: nil, group: subgroup, label_url_method: :group_url } ) expect(result.css('a').first.attr('href')).to eq(urls.group_url(subgroup, label_name: label.name)) end it 'points to referenced project issues page' do project = create(:project) label = create(:label, project: project) reference = "#{project.full_path}~#{label.name}" result = reference_filter("See #{reference}", { project: nil, group: create(:group) } ) expect(result.css('a').first.attr('href')).to eq(urls.project_issues_url(project, label_name: label.name)) expect(result.css('a').first.text).to eq "#{label.name} in #{project.full_name}" end end end