diff --git a/app/models/label.rb b/app/models/label.rb index c34f4e4ba602de1135b40e0d35f025a671e2a6d9..02683a08dd6035e5c29255530f6ce5bebec26dba 100644 --- a/app/models/label.rb +++ b/app/models/label.rb @@ -66,16 +66,13 @@ class Label < ActiveRecord::Base # # format - Symbol format to use (default: :id, optional: :name) # - # Note that its argument differs from other objects implementing Referable. If - # a non-Symbol argument is given (such as a Project), it will default to :id. - # # Examples: # - # Label.first.to_reference # => "~1" - # Label.first.to_reference(:name) # => "~\"bug\"" + # Label.first.to_reference # => "~1" + # Label.first.to_reference(format: :name) # => "~\"bug\"" # # Returns a String - def to_reference(format = :id) + def to_reference(_from_project = nil, format: :id) if format == :name && !name.include?('"') %(#{self.class.reference_prefix}"#{name}") else diff --git a/app/services/system_note_service.rb b/app/services/system_note_service.rb index edced010811b9b9a7fe5a4579751a0d1755d8a09..58a861ee08e24dee09eef1a96d1a585619a268d5 100644 --- a/app/services/system_note_service.rb +++ b/app/services/system_note_service.rb @@ -66,7 +66,7 @@ class SystemNoteService def self.change_label(noteable, project, author, added_labels, removed_labels) labels_count = added_labels.count + removed_labels.count - references = ->(label) { label.to_reference(:id) } + references = ->(label) { label.to_reference(format: :id) } added_labels = added_labels.map(&references).join(' ') removed_labels = removed_labels.map(&references).join(' ') diff --git a/spec/fixtures/markdown.md.erb b/spec/fixtures/markdown.md.erb index fe6d42acee256560713932f405849d5e640a3ffe..1772cc3f6a4a30d7ea520b8fff466e94d8a70191 100644 --- a/spec/fixtures/markdown.md.erb +++ b/spec/fixtures/markdown.md.erb @@ -209,7 +209,7 @@ References should be parseable even inside _<%= merge_request.to_reference %>_ e - Label by ID: <%= simple_label.to_reference %> - Label by name: <%= Label.reference_prefix %><%= simple_label.name %> -- Label by name in quotes: <%= label.to_reference(:name) %> +- Label by name in quotes: <%= label.to_reference(format: :name) %> - Ignored in code: `<%= simple_label.to_reference %>` - Ignored in links: [Link to <%= simple_label.to_reference %>](#label-link) - Link to label by reference: [Label](<%= label.to_reference %>) diff --git a/spec/lib/banzai/filter/label_reference_filter_spec.rb b/spec/lib/banzai/filter/label_reference_filter_spec.rb index b46ccc4760509f809da2a597e474c4ecfff72537..9d9e5cbac3de1f69b9b402deeea576e5b2e74a10 100644 --- a/spec/lib/banzai/filter/label_reference_filter_spec.rb +++ b/spec/lib/banzai/filter/label_reference_filter_spec.rb @@ -111,7 +111,7 @@ describe Banzai::Filter::LabelReferenceFilter, lib: true do context 'String-based multi-word references in quotes' do let(:label) { create(:label, name: 'gfm references', project: project) } - let(:reference) { label.to_reference(:name) } + let(:reference) { label.to_reference(format: :name) } it 'links to a valid reference' do doc = reference_filter("See #{reference}") diff --git a/spec/models/label_spec.rb b/spec/models/label_spec.rb index 696fbf7e0aa0a87e3d3f6abd6f4c6c4646b67435..fd133e1ca1bec0fea29004bea80fd377f710aed9 100644 --- a/spec/models/label_spec.rb +++ b/spec/models/label_spec.rb @@ -65,12 +65,12 @@ describe Label, models: true do context 'using name' do it 'returns a String reference to the object' do - expect(label.to_reference(:name)).to eq %(~"#{label.name}") + expect(label.to_reference(format: :name)).to eq %(~"#{label.name}") end it 'uses id when name contains double quote' do label = create(:label, name: %q{"irony"}) - expect(label.to_reference(:name)).to eq "~#{label.id}" + expect(label.to_reference(format: :name)).to eq "~#{label.id}" end end end