summaryrefslogtreecommitdiff
path: root/lib/gitlab/quick_actions/command_definition.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/gitlab/quick_actions/command_definition.rb')
-rw-r--r--lib/gitlab/quick_actions/command_definition.rb89
1 files changed, 89 insertions, 0 deletions
diff --git a/lib/gitlab/quick_actions/command_definition.rb b/lib/gitlab/quick_actions/command_definition.rb
new file mode 100644
index 00000000000..3937d9c153a
--- /dev/null
+++ b/lib/gitlab/quick_actions/command_definition.rb
@@ -0,0 +1,89 @@
+module Gitlab
+ module QuickActions
+ class CommandDefinition
+ attr_accessor :name, :aliases, :description, :explanation, :params,
+ :condition_block, :parse_params_block, :action_block
+
+ def initialize(name, attributes = {})
+ @name = name
+
+ @aliases = attributes[:aliases] || []
+ @description = attributes[:description] || ''
+ @explanation = attributes[:explanation] || ''
+ @params = attributes[:params] || []
+ @condition_block = attributes[:condition_block]
+ @parse_params_block = attributes[:parse_params_block]
+ @action_block = attributes[:action_block]
+ end
+
+ def all_names
+ [name, *aliases]
+ end
+
+ def noop?
+ action_block.nil?
+ end
+
+ def available?(opts)
+ return true unless condition_block
+
+ context = OpenStruct.new(opts)
+ context.instance_exec(&condition_block)
+ end
+
+ def explain(context, opts, arg)
+ return unless available?(opts)
+
+ if explanation.respond_to?(:call)
+ execute_block(explanation, context, arg)
+ else
+ explanation
+ end
+ end
+
+ def execute(context, opts, arg)
+ return if noop? || !available?(opts)
+
+ execute_block(action_block, context, arg)
+ end
+
+ def to_h(opts)
+ context = OpenStruct.new(opts)
+
+ desc = description
+ if desc.respond_to?(:call)
+ desc = context.instance_exec(&desc) rescue ''
+ end
+
+ prms = params
+ if prms.respond_to?(:call)
+ prms = Array(context.instance_exec(&prms)) rescue params
+ end
+
+ {
+ name: name,
+ aliases: aliases,
+ description: desc,
+ params: prms
+ }
+ end
+
+ private
+
+ def execute_block(block, context, arg)
+ if arg.present?
+ parsed = parse_params(arg, context)
+ context.instance_exec(parsed, &block)
+ elsif block.arity == 0
+ context.instance_exec(&block)
+ end
+ end
+
+ def parse_params(arg, context)
+ return arg unless parse_params_block
+
+ context.instance_exec(arg, &parse_params_block)
+ end
+ end
+ end
+end