From 65349c22129fcdf2ae0c7103094bbf50ae73db61 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9my=20Coutable?= <remy@rymai.me>
Date: Wed, 10 Aug 2016 17:51:01 +0200
Subject: Make slash commands contextual
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Return only slash commands that make sense for the current noteable
- Allow slash commands decription to be dynamic

Other improvements:

- Add permission checks in slash commands definition
- Use IssuesFinder and MergeRequestsFinder
- Use next if instead of a unless block, and use splat operator instead of flatten

Signed-off-by: Rémy Coutable <remy@rymai.me>
---
 spec/lib/gitlab/slash_commands/dsl_spec.rb | 82 ++++++++++++++++++++++++------
 1 file changed, 67 insertions(+), 15 deletions(-)

(limited to 'spec/lib/gitlab/slash_commands')

diff --git a/spec/lib/gitlab/slash_commands/dsl_spec.rb b/spec/lib/gitlab/slash_commands/dsl_spec.rb
index 39e1996c891..893a7692f11 100644
--- a/spec/lib/gitlab/slash_commands/dsl_spec.rb
+++ b/spec/lib/gitlab/slash_commands/dsl_spec.rb
@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 describe Gitlab::SlashCommands::Dsl do
+  COND_LAMBDA = ->(opts) { opts[:project] == 'foo' }
   before :all do
     DummyClass = Class.new do
       include Gitlab::SlashCommands::Dsl
@@ -20,18 +21,23 @@ describe Gitlab::SlashCommands::Dsl do
         arg1
       end
 
-      desc 'A command with two args'
+      desc ->(opts) { "A dynamic description for #{opts.fetch(:noteable)}" }
       params 'The first argument', 'The second argument'
       command :two_args do |arg1, arg2|
         [arg1, arg2]
       end
 
-      command :wildcard do |*args|
+      noop true
+      command :cc do |*args|
         args
       end
 
-      noop true
-      command :cc do |*args|
+      condition COND_LAMBDA
+      command :cond_action do |*args|
+        args
+      end
+
+      command :wildcard do |*args|
         args
       end
     end
@@ -39,27 +45,73 @@ describe Gitlab::SlashCommands::Dsl do
   let(:dummy) { DummyClass.new }
 
   describe '.command_definitions' do
-    it 'returns an array with commands definitions' do
-      expected = [
-        { name: :no_args, aliases: [:none], description: 'A command with no args', params: [], noop: false },
-        { name: :returning, aliases: [], description: 'A command returning a value', params: [], noop: false },
-        { name: :one_arg, aliases: [:once, :first], description: '', params: ['The first argument'], noop: false },
-        { name: :two_args, aliases: [], description: 'A command with two args', params: ['The first argument', 'The second argument'], noop: false },
-        { name: :wildcard, aliases: [], description: '', params: [], noop: false },
-        { name: :cc, aliases: [], description: '', params: [], noop: true }
+    let(:base_expected) do
+      [
+        { name: :no_args, aliases: [:none], description: 'A command with no args', params: [] },
+        { name: :returning, aliases: [], description: 'A command returning a value', params: [] },
+        { name: :one_arg, aliases: [:once, :first], description: '', params: ['The first argument'] },
+        { name: :two_args, aliases: [], description: '', params: ['The first argument', 'The second argument'] },
+        { name: :cc, aliases: [], description: '', params: [], noop: true },
+        { name: :wildcard, aliases: [], description: '', params: [] }
       ]
+    end
 
-      expect(DummyClass.command_definitions).to eq expected
+    it 'returns an array with commands definitions' do
+      expect(DummyClass.command_definitions).to match_array base_expected
+    end
+
+    context 'with options passed' do
+      context 'when condition is met' do
+        let(:expected) { base_expected << { name: :cond_action, aliases: [], description: '', params: [], cond_lambda: COND_LAMBDA } }
+
+        it 'returns an array with commands definitions' do
+          expect(DummyClass.command_definitions(project: 'foo')).to match_array expected
+        end
+      end
+
+      context 'when condition is not met' do
+        it 'returns an array with commands definitions without actions that did not met conditions' do
+          expect(DummyClass.command_definitions(project: 'bar')).to match_array base_expected
+        end
+      end
+
+      context 'when description can be generated dynamically' do
+        it 'returns an array with commands definitions with dynamic descriptions' do
+          base_expected[3][:description] = 'A dynamic description for merge request'
+
+          expect(DummyClass.command_definitions(noteable: 'merge request')).to match_array base_expected
+        end
+      end
     end
   end
 
   describe '.command_names' do
-    it 'returns an array with commands definitions' do
-      expect(DummyClass.command_names).to eq [
+    let(:base_expected) do
+      [
         :no_args, :none, :returning, :one_arg,
         :once, :first, :two_args, :wildcard
       ]
     end
+
+    it 'returns an array with commands definitions' do
+      expect(DummyClass.command_names).to eq base_expected
+    end
+
+    context 'with options passed' do
+      context 'when condition is met' do
+        let(:expected) { base_expected << :cond_action }
+
+        it 'returns an array with commands definitions' do
+          expect(DummyClass.command_names(project: 'foo')).to match_array expected
+        end
+      end
+
+      context 'when condition is not met' do
+        it 'returns an array with commands definitions without action that did not met conditions' do
+          expect(DummyClass.command_names(project: 'bar')).to match_array base_expected
+        end
+      end
+    end
   end
 
   describe 'command with no args' do
-- 
cgit v1.2.1