From ea090291bba6bb665b3631cc5a2659e6673a6959 Mon Sep 17 00:00:00 2001 From: Eric Eastwood Date: Wed, 31 May 2017 00:50:53 -0500 Subject: Rename "Slash commands" to "Quick actions" Fix https://gitlab.com/gitlab-org/gitlab-ce/issues/27070 Deprecate "chat commands" in favor of "slash commands" We looked for things like: - `slash commmand` - `slash_command` - `slash-command` - `SlashCommand` --- spec/services/notes/quick_actions_service_spec.rb | 252 +++++++++++++++++++++ spec/services/notes/slash_commands_service_spec.rb | 252 --------------------- 2 files changed, 252 insertions(+), 252 deletions(-) create mode 100644 spec/services/notes/quick_actions_service_spec.rb delete mode 100644 spec/services/notes/slash_commands_service_spec.rb (limited to 'spec/services/notes') diff --git a/spec/services/notes/quick_actions_service_spec.rb b/spec/services/notes/quick_actions_service_spec.rb new file mode 100644 index 00000000000..9a98499826f --- /dev/null +++ b/spec/services/notes/quick_actions_service_spec.rb @@ -0,0 +1,252 @@ +require 'spec_helper' + +describe Notes::QuickActionsService, services: true do + shared_context 'note on noteable' do + let(:project) { create(:empty_project) } + let(:master) { create(:user).tap { |u| project.team << [u, :master] } } + let(:assignee) { create(:user) } + + before do + project.team << [assignee, :master] + end + end + + shared_examples 'note on noteable that does not support quick actions' do + include_context 'note on noteable' + + before do + note.note = note_text + end + + describe 'note with only command' do + describe '/close, /label, /assign & /milestone' do + let(:note_text) { %(/close\n/assign @#{assignee.username}") } + + it 'saves the note and does not alter the note text' do + content, command_params = service.extract_commands(note) + + expect(content).to eq note_text + expect(command_params).to be_empty + end + end + end + + describe 'note with command & text' do + describe '/close, /label, /assign & /milestone' do + let(:note_text) { %(HELLO\n/close\n/assign @#{assignee.username}\nWORLD) } + + it 'saves the note and does not alter the note text' do + content, command_params = service.extract_commands(note) + + expect(content).to eq note_text + expect(command_params).to be_empty + end + end + end + end + + shared_examples 'note on noteable that supports quick actions' do + include_context 'note on noteable' + + before do + note.note = note_text + end + + let!(:milestone) { create(:milestone, project: project) } + let!(:labels) { create_pair(:label, project: project) } + + describe 'note with only command' do + describe '/close, /label, /assign & /milestone' do + let(:note_text) do + %(/close\n/label ~#{labels.first.name} ~#{labels.last.name}\n/assign @#{assignee.username}\n/milestone %"#{milestone.name}") + end + + it 'closes noteable, sets labels, assigns, and sets milestone to noteable, and leave no note' do + content, command_params = service.extract_commands(note) + service.execute(command_params, note) + + expect(content).to eq '' + expect(note.noteable).to be_closed + expect(note.noteable.labels).to match_array(labels) + expect(note.noteable.assignees).to eq([assignee]) + expect(note.noteable.milestone).to eq(milestone) + end + end + + describe '/reopen' do + before do + note.noteable.close! + expect(note.noteable).to be_closed + end + let(:note_text) { '/reopen' } + + it 'opens the noteable, and leave no note' do + content, command_params = service.extract_commands(note) + service.execute(command_params, note) + + expect(content).to eq '' + expect(note.noteable).to be_open + end + end + + describe '/spend' do + let(:note_text) { '/spend 1h' } + + it 'updates the spent time on the noteable' do + content, command_params = service.extract_commands(note) + service.execute(command_params, note) + + expect(content).to eq '' + expect(note.noteable.time_spent).to eq(3600) + end + end + end + + describe 'note with command & text' do + describe '/close, /label, /assign & /milestone' do + let(:note_text) do + %(HELLO\n/close\n/label ~#{labels.first.name} ~#{labels.last.name}\n/assign @#{assignee.username}\n/milestone %"#{milestone.name}"\nWORLD) + end + + it 'closes noteable, sets labels, assigns, and sets milestone to noteable' do + content, command_params = service.extract_commands(note) + service.execute(command_params, note) + + expect(content).to eq "HELLO\nWORLD" + expect(note.noteable).to be_closed + expect(note.noteable.labels).to match_array(labels) + expect(note.noteable.assignees).to eq([assignee]) + expect(note.noteable.milestone).to eq(milestone) + end + end + + describe '/reopen' do + before do + note.noteable.close + expect(note.noteable).to be_closed + end + let(:note_text) { "HELLO\n/reopen\nWORLD" } + + it 'opens the noteable' do + content, command_params = service.extract_commands(note) + service.execute(command_params, note) + + expect(content).to eq "HELLO\nWORLD" + expect(note.noteable).to be_open + end + end + end + end + + describe '.noteable_update_service' do + include_context 'note on noteable' + + it 'returns Issues::UpdateService for a note on an issue' do + note = create(:note_on_issue, project: project) + + expect(described_class.noteable_update_service(note)).to eq(Issues::UpdateService) + end + + it 'returns Issues::UpdateService for a note on a merge request' do + note = create(:note_on_merge_request, project: project) + + expect(described_class.noteable_update_service(note)).to eq(MergeRequests::UpdateService) + end + + it 'returns nil for a note on a commit' do + note = create(:note_on_commit, project: project) + + expect(described_class.noteable_update_service(note)).to be_nil + end + end + + describe '.supported?' do + include_context 'note on noteable' + + let(:note) { create(:note_on_issue, project: project) } + + context 'with no current_user' do + it 'returns false' do + expect(described_class.supported?(note, nil)).to be_falsy + end + end + + context 'when current_user cannot update the noteable' do + it 'returns false' do + user = create(:user) + + expect(described_class.supported?(note, user)).to be_falsy + end + end + + context 'when current_user can update the noteable' do + it 'returns true' do + expect(described_class.supported?(note, master)).to be_truthy + end + + context 'with a note on a commit' do + let(:note) { create(:note_on_commit, project: project) } + + it 'returns false' do + expect(described_class.supported?(note, nil)).to be_falsy + end + end + end + end + + describe '#supported?' do + include_context 'note on noteable' + + it 'delegates to the class method' do + service = described_class.new(project, master) + note = create(:note_on_issue, project: project) + + expect(described_class).to receive(:supported?).with(note, master) + + service.supported?(note) + end + end + + describe '#execute' do + let(:service) { described_class.new(project, master) } + + it_behaves_like 'note on noteable that supports quick actions' do + let(:note) { build(:note_on_issue, project: project) } + end + + it_behaves_like 'note on noteable that supports quick actions' do + let(:note) { build(:note_on_merge_request, project: project) } + end + + it_behaves_like 'note on noteable that does not support quick actions' do + let(:note) { build(:note_on_commit, project: project) } + end + end + + context 'CE restriction for issue assignees' do + describe '/assign' do + let(:project) { create(:empty_project) } + let(:master) { create(:user).tap { |u| project.team << [u, :master] } } + let(:assignee) { create(:user) } + let(:master) { create(:user) } + let(:service) { described_class.new(project, master) } + let(:note) { create(:note_on_issue, note: note_text, project: project) } + + let(:note_text) do + %(/assign @#{assignee.username} @#{master.username}\n") + end + + before do + project.team << [master, :master] + project.team << [assignee, :master] + end + + it 'adds only one assignee from the list' do + _, command_params = service.extract_commands(note) + service.execute(command_params, note) + + expect(note.noteable.assignees.count).to eq(1) + end + end + end +end diff --git a/spec/services/notes/slash_commands_service_spec.rb b/spec/services/notes/slash_commands_service_spec.rb deleted file mode 100644 index d5ffc1908a9..00000000000 --- a/spec/services/notes/slash_commands_service_spec.rb +++ /dev/null @@ -1,252 +0,0 @@ -require 'spec_helper' - -describe Notes::SlashCommandsService, services: true do - shared_context 'note on noteable' do - let(:project) { create(:empty_project) } - let(:master) { create(:user).tap { |u| project.team << [u, :master] } } - let(:assignee) { create(:user) } - - before do - project.team << [assignee, :master] - end - end - - shared_examples 'note on noteable that does not support slash commands' do - include_context 'note on noteable' - - before do - note.note = note_text - end - - describe 'note with only command' do - describe '/close, /label, /assign & /milestone' do - let(:note_text) { %(/close\n/assign @#{assignee.username}") } - - it 'saves the note and does not alter the note text' do - content, command_params = service.extract_commands(note) - - expect(content).to eq note_text - expect(command_params).to be_empty - end - end - end - - describe 'note with command & text' do - describe '/close, /label, /assign & /milestone' do - let(:note_text) { %(HELLO\n/close\n/assign @#{assignee.username}\nWORLD) } - - it 'saves the note and does not alter the note text' do - content, command_params = service.extract_commands(note) - - expect(content).to eq note_text - expect(command_params).to be_empty - end - end - end - end - - shared_examples 'note on noteable that supports slash commands' do - include_context 'note on noteable' - - before do - note.note = note_text - end - - let!(:milestone) { create(:milestone, project: project) } - let!(:labels) { create_pair(:label, project: project) } - - describe 'note with only command' do - describe '/close, /label, /assign & /milestone' do - let(:note_text) do - %(/close\n/label ~#{labels.first.name} ~#{labels.last.name}\n/assign @#{assignee.username}\n/milestone %"#{milestone.name}") - end - - it 'closes noteable, sets labels, assigns, and sets milestone to noteable, and leave no note' do - content, command_params = service.extract_commands(note) - service.execute(command_params, note) - - expect(content).to eq '' - expect(note.noteable).to be_closed - expect(note.noteable.labels).to match_array(labels) - expect(note.noteable.assignees).to eq([assignee]) - expect(note.noteable.milestone).to eq(milestone) - end - end - - describe '/reopen' do - before do - note.noteable.close! - expect(note.noteable).to be_closed - end - let(:note_text) { '/reopen' } - - it 'opens the noteable, and leave no note' do - content, command_params = service.extract_commands(note) - service.execute(command_params, note) - - expect(content).to eq '' - expect(note.noteable).to be_open - end - end - - describe '/spend' do - let(:note_text) { '/spend 1h' } - - it 'updates the spent time on the noteable' do - content, command_params = service.extract_commands(note) - service.execute(command_params, note) - - expect(content).to eq '' - expect(note.noteable.time_spent).to eq(3600) - end - end - end - - describe 'note with command & text' do - describe '/close, /label, /assign & /milestone' do - let(:note_text) do - %(HELLO\n/close\n/label ~#{labels.first.name} ~#{labels.last.name}\n/assign @#{assignee.username}\n/milestone %"#{milestone.name}"\nWORLD) - end - - it 'closes noteable, sets labels, assigns, and sets milestone to noteable' do - content, command_params = service.extract_commands(note) - service.execute(command_params, note) - - expect(content).to eq "HELLO\nWORLD" - expect(note.noteable).to be_closed - expect(note.noteable.labels).to match_array(labels) - expect(note.noteable.assignees).to eq([assignee]) - expect(note.noteable.milestone).to eq(milestone) - end - end - - describe '/reopen' do - before do - note.noteable.close - expect(note.noteable).to be_closed - end - let(:note_text) { "HELLO\n/reopen\nWORLD" } - - it 'opens the noteable' do - content, command_params = service.extract_commands(note) - service.execute(command_params, note) - - expect(content).to eq "HELLO\nWORLD" - expect(note.noteable).to be_open - end - end - end - end - - describe '.noteable_update_service' do - include_context 'note on noteable' - - it 'returns Issues::UpdateService for a note on an issue' do - note = create(:note_on_issue, project: project) - - expect(described_class.noteable_update_service(note)).to eq(Issues::UpdateService) - end - - it 'returns Issues::UpdateService for a note on a merge request' do - note = create(:note_on_merge_request, project: project) - - expect(described_class.noteable_update_service(note)).to eq(MergeRequests::UpdateService) - end - - it 'returns nil for a note on a commit' do - note = create(:note_on_commit, project: project) - - expect(described_class.noteable_update_service(note)).to be_nil - end - end - - describe '.supported?' do - include_context 'note on noteable' - - let(:note) { create(:note_on_issue, project: project) } - - context 'with no current_user' do - it 'returns false' do - expect(described_class.supported?(note, nil)).to be_falsy - end - end - - context 'when current_user cannot update the noteable' do - it 'returns false' do - user = create(:user) - - expect(described_class.supported?(note, user)).to be_falsy - end - end - - context 'when current_user can update the noteable' do - it 'returns true' do - expect(described_class.supported?(note, master)).to be_truthy - end - - context 'with a note on a commit' do - let(:note) { create(:note_on_commit, project: project) } - - it 'returns false' do - expect(described_class.supported?(note, nil)).to be_falsy - end - end - end - end - - describe '#supported?' do - include_context 'note on noteable' - - it 'delegates to the class method' do - service = described_class.new(project, master) - note = create(:note_on_issue, project: project) - - expect(described_class).to receive(:supported?).with(note, master) - - service.supported?(note) - end - end - - describe '#execute' do - let(:service) { described_class.new(project, master) } - - it_behaves_like 'note on noteable that supports slash commands' do - let(:note) { build(:note_on_issue, project: project) } - end - - it_behaves_like 'note on noteable that supports slash commands' do - let(:note) { build(:note_on_merge_request, project: project) } - end - - it_behaves_like 'note on noteable that does not support slash commands' do - let(:note) { build(:note_on_commit, project: project) } - end - end - - context 'CE restriction for issue assignees' do - describe '/assign' do - let(:project) { create(:empty_project) } - let(:master) { create(:user).tap { |u| project.team << [u, :master] } } - let(:assignee) { create(:user) } - let(:master) { create(:user) } - let(:service) { described_class.new(project, master) } - let(:note) { create(:note_on_issue, note: note_text, project: project) } - - let(:note_text) do - %(/assign @#{assignee.username} @#{master.username}\n") - end - - before do - project.team << [master, :master] - project.team << [assignee, :master] - end - - it 'adds only one assignee from the list' do - _, command_params = service.extract_commands(note) - service.execute(command_params, note) - - expect(note.noteable.assignees.count).to eq(1) - end - end - end -end -- cgit v1.2.1