gitlab-org--gitlab-foss/lib/gitlab/slash_commands/extractor.rb

module Gitlab
  module SlashCommands
    # This class takes an array of commands that should be extracted from a
    # given text.
    #
    # ```
    # extractor = Gitlab::SlashCommands::Extractor.new([:open, :assign, :labels])
    # ```
    class Extractor
      attr_reader :command_definitions

      def initialize(command_definitions)
        @command_definitions = command_definitions
      end

      # Extracts commands from content and return an array of commands.
      # The array looks like the following:
      # [
      #   ['command1'],
      #   ['command3', 'arg1 arg2'],
      # ]
      # The command and the arguments are stripped.
      # The original command text is removed from the given `content`.
      #
      # Usage:
      # ```
      # extractor = Gitlab::SlashCommands::Extractor.new([:open, :assign, :labels])
      # msg = %(hello\n/labels ~foo ~"bar baz"\nworld)
      # commands = extractor.extract_commands(msg) #=> [['labels', '~foo ~"bar baz"']]
      # msg #=> "hello\nworld"
      # ```
      def extract_commands(content, opts = {})
        return [content, []] unless content

        content = content.dup

        commands = []

        content.delete!("\r")
        content.gsub!(commands_regex(opts)) do
          if $~[:cmd]
            commands << [$~[:cmd], $~[:arg]].reject(&:blank?)
            ''
          else
            $~[0]
          end
        end

        [content.strip, commands]
      end

      private

      # Builds a regular expression to match known commands.
      # First match group captures the command name and
      # second match group captures its arguments.
      #
      # It looks something like:
      #
      #   /^\/(?<cmd>close|reopen|...)(?:( |$))(?<arg>[^\/\n]*)(?:\n|$)/
      def commands_regex(opts)
        names = command_names(opts).map(&:to_s)

        @commands_regex ||= %r{
            (?<code>
              # Code blocks:
              # ```
              # Anything, including `/cmd arg` which are ignored by this filter
              # ```

              ^```
              .+?
              \n```$
            )
          |
            (?<html>
              # HTML block:
              # <tag>
              # Anything, including `/cmd arg` which are ignored by this filter
              # </tag>

              ^<[^>]+?>\n
              .+?
              \n<\/[^>]+?>$
            )
          |
            (?<html>
              # Quote block:
              # >>>
              # Anything, including `/cmd arg` which are ignored by this filter
              # >>>

              ^>>>
              .+?
              \n>>>$
            )
          |
            (?:
              # Command not in a blockquote, blockcode, or HTML tag:
              # /close

              ^\/
              (?<cmd>#{Regexp.union(names)})
              (?:
                [ ]
                (?<arg>[^\n]*)
              )?
              (?:\n|$)
            )
        }mx
      end

      def command_names(opts)
        command_definitions.flat_map do |command|
          next if command.noop?

          command.all_names
        end.compact
      end
    end
  end
end
Support slash commands in noteable description and notes Some important things to note: - commands are removed from noteable.description / note.note - commands are translated to params so that they are treated as normal params in noteable Creation services - the logic is not in the models but in the Creation services, which is the right place for advanced logic that has nothing to do with what models should be responsible of! - UI/JS needs to be updated to handle notes which consist of commands only - the `/merge` command is not handled yet Other improvements: - Don't process commands in commit notes and display a flash is note is only commands - Add autocomplete for slash commands - Add description and params to slash command DSL methods - Ensure replying by email with a commands-only note works - Use :subscription_event instead of calling noteable.subscribe - Support :todo_event in IssuableBaseService Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-06-30 11:34:19 -04:00			`module Gitlab`
			`module SlashCommands`
			`# This class takes an array of commands that should be extracted from a`
			`# given text.`
			`#`
			# ```
			`# extractor = Gitlab::SlashCommands::Extractor.new([:open, :assign, :labels])`
			# ```
			`class Extractor`
Refactor slash command definition 2016-08-12 21:17:18 -04:00			`attr_reader :command_definitions`
Support slash commands in noteable description and notes Some important things to note: - commands are removed from noteable.description / note.note - commands are translated to params so that they are treated as normal params in noteable Creation services - the logic is not in the models but in the Creation services, which is the right place for advanced logic that has nothing to do with what models should be responsible of! - UI/JS needs to be updated to handle notes which consist of commands only - the `/merge` command is not handled yet Other improvements: - Don't process commands in commit notes and display a flash is note is only commands - Add autocomplete for slash commands - Add description and params to slash command DSL methods - Ensure replying by email with a commands-only note works - Use :subscription_event instead of calling noteable.subscribe - Support :todo_event in IssuableBaseService Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-06-30 11:34:19 -04:00
Refactor slash command definition 2016-08-12 21:17:18 -04:00			`def initialize(command_definitions)`
			`@command_definitions = command_definitions`
Support slash commands in noteable description and notes Some important things to note: - commands are removed from noteable.description / note.note - commands are translated to params so that they are treated as normal params in noteable Creation services - the logic is not in the models but in the Creation services, which is the right place for advanced logic that has nothing to do with what models should be responsible of! - UI/JS needs to be updated to handle notes which consist of commands only - the `/merge` command is not handled yet Other improvements: - Don't process commands in commit notes and display a flash is note is only commands - Add autocomplete for slash commands - Add description and params to slash command DSL methods - Ensure replying by email with a commands-only note works - Use :subscription_event instead of calling noteable.subscribe - Support :todo_event in IssuableBaseService Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-06-30 11:34:19 -04:00			`end`

			`# Extracts commands from content and return an array of commands.`
			`# The array looks like the following:`
			`# [`
			`# ['command1'],`
			`# ['command3', 'arg1 arg2'],`
			`# ]`
			`# The command and the arguments are stripped.`
			# The original command text is removed from the given `content`.
			`#`
			`# Usage:`
			# ```
			`# extractor = Gitlab::SlashCommands::Extractor.new([:open, :assign, :labels])`
			`# msg = %(hello\n/labels ~foo ~"bar baz"\nworld)`
Refactor slash command definition 2016-08-12 21:17:18 -04:00			`# commands = extractor.extract_commands(msg) #=> [['labels', '~foo ~"bar baz"']]`
Support slash commands in noteable description and notes Some important things to note: - commands are removed from noteable.description / note.note - commands are translated to params so that they are treated as normal params in noteable Creation services - the logic is not in the models but in the Creation services, which is the right place for advanced logic that has nothing to do with what models should be responsible of! - UI/JS needs to be updated to handle notes which consist of commands only - the `/merge` command is not handled yet Other improvements: - Don't process commands in commit notes and display a flash is note is only commands - Add autocomplete for slash commands - Add description and params to slash command DSL methods - Ensure replying by email with a commands-only note works - Use :subscription_event instead of calling noteable.subscribe - Support :todo_event in IssuableBaseService Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-06-30 11:34:19 -04:00			`# msg #=> "hello\nworld"`
			# ```
Fixed specs and fixes based on failing specs 2016-08-13 12:58:51 -04:00			`def extract_commands(content, opts = {})`
			`return [content, []] unless content`
Support slash commands in noteable description and notes Some important things to note: - commands are removed from noteable.description / note.note - commands are translated to params so that they are treated as normal params in noteable Creation services - the logic is not in the models but in the Creation services, which is the right place for advanced logic that has nothing to do with what models should be responsible of! - UI/JS needs to be updated to handle notes which consist of commands only - the `/merge` command is not handled yet Other improvements: - Don't process commands in commit notes and display a flash is note is only commands - Add autocomplete for slash commands - Add description and params to slash command DSL methods - Ensure replying by email with a commands-only note works - Use :subscription_event instead of calling noteable.subscribe - Support :todo_event in IssuableBaseService Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-06-30 11:34:19 -04:00
Refactor slash command definition 2016-08-12 21:17:18 -04:00			`content = content.dup`

Support slash commands in noteable description and notes Some important things to note: - commands are removed from noteable.description / note.note - commands are translated to params so that they are treated as normal params in noteable Creation services - the logic is not in the models but in the Creation services, which is the right place for advanced logic that has nothing to do with what models should be responsible of! - UI/JS needs to be updated to handle notes which consist of commands only - the `/merge` command is not handled yet Other improvements: - Don't process commands in commit notes and display a flash is note is only commands - Add autocomplete for slash commands - Add description and params to slash command DSL methods - Ensure replying by email with a commands-only note works - Use :subscription_event instead of calling noteable.subscribe - Support :todo_event in IssuableBaseService Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-06-30 11:34:19 -04:00			`commands = []`

Don't extract slash commands inside blockcode, blockquote or HTML tags Improve slash command descriptions, support /due tomorrow Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-08-09 16:47:29 -04:00			`content.delete!("\r")`
Refactor slash command definition 2016-08-12 21:17:18 -04:00			`content.gsub!(commands_regex(opts)) do`
Don't extract slash commands inside blockcode, blockquote or HTML tags Improve slash command descriptions, support /due tomorrow Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-08-09 16:47:29 -04:00			`if $~[:cmd]`
Fix behavior around commands with optional arguments 2016-08-18 15:21:52 -04:00			`commands << [$~[:cmd], $~[:arg]].reject(&:blank?)`
Don't extract slash commands inside blockcode, blockquote or HTML tags Improve slash command descriptions, support /due tomorrow Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-08-09 16:47:29 -04:00			`''`
			`else`
			`$~[0]`
			`end`
Support slash commands in noteable description and notes Some important things to note: - commands are removed from noteable.description / note.note - commands are translated to params so that they are treated as normal params in noteable Creation services - the logic is not in the models but in the Creation services, which is the right place for advanced logic that has nothing to do with what models should be responsible of! - UI/JS needs to be updated to handle notes which consist of commands only - the `/merge` command is not handled yet Other improvements: - Don't process commands in commit notes and display a flash is note is only commands - Add autocomplete for slash commands - Add description and params to slash command DSL methods - Ensure replying by email with a commands-only note works - Use :subscription_event instead of calling noteable.subscribe - Support :todo_event in IssuableBaseService Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-06-30 11:34:19 -04:00			`end`

Refactor slash command definition 2016-08-12 21:17:18 -04:00			`[content.strip, commands]`
Support slash commands in noteable description and notes Some important things to note: - commands are removed from noteable.description / note.note - commands are translated to params so that they are treated as normal params in noteable Creation services - the logic is not in the models but in the Creation services, which is the right place for advanced logic that has nothing to do with what models should be responsible of! - UI/JS needs to be updated to handle notes which consist of commands only - the `/merge` command is not handled yet Other improvements: - Don't process commands in commit notes and display a flash is note is only commands - Add autocomplete for slash commands - Add description and params to slash command DSL methods - Ensure replying by email with a commands-only note works - Use :subscription_event instead of calling noteable.subscribe - Support :todo_event in IssuableBaseService Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-06-30 11:34:19 -04:00			`end`

			`private`
Fix behavior around commands with optional arguments 2016-08-18 15:21:52 -04:00
Support slash commands in noteable description and notes Some important things to note: - commands are removed from noteable.description / note.note - commands are translated to params so that they are treated as normal params in noteable Creation services - the logic is not in the models but in the Creation services, which is the right place for advanced logic that has nothing to do with what models should be responsible of! - UI/JS needs to be updated to handle notes which consist of commands only - the `/merge` command is not handled yet Other improvements: - Don't process commands in commit notes and display a flash is note is only commands - Add autocomplete for slash commands - Add description and params to slash command DSL methods - Ensure replying by email with a commands-only note works - Use :subscription_event instead of calling noteable.subscribe - Support :todo_event in IssuableBaseService Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-06-30 11:34:19 -04:00			`# Builds a regular expression to match known commands.`
			`# First match group captures the command name and`
			`# second match group captures its arguments.`
			`#`
			`# It looks something like:`
			`#`
Fix behavior around commands with optional arguments 2016-08-18 15:21:52 -04:00			`# /^\/(?<cmd>close\|reopen\|...)(?:( \|$))(?<arg>[^\/\n]*)(?:\n\|$)/`
Refactor slash command definition 2016-08-12 21:17:18 -04:00			`def commands_regex(opts)`
			`names = command_names(opts).map(&:to_s)`

Don't extract slash commands inside blockcode, blockquote or HTML tags Improve slash command descriptions, support /due tomorrow Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-08-09 16:47:29 -04:00			`@commands_regex \|\|= %r{`
			`(?<code>`
			`# Code blocks:`
			# ```
Fix behavior around commands with optional arguments 2016-08-18 15:21:52 -04:00			# Anything, including `/cmd arg` which are ignored by this filter
Don't extract slash commands inside blockcode, blockquote or HTML tags Improve slash command descriptions, support /due tomorrow Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-08-09 16:47:29 -04:00			# ```

			^```
			`.+?`
			\n```$
			`)`
			`\|`
			`(?<html>`
			`# HTML block:`
			`# <tag>`
Fix behavior around commands with optional arguments 2016-08-18 15:21:52 -04:00			# Anything, including `/cmd arg` which are ignored by this filter
Don't extract slash commands inside blockcode, blockquote or HTML tags Improve slash command descriptions, support /due tomorrow Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-08-09 16:47:29 -04:00			`# </tag>`

			`^<[^>]+?>\n`
			`.+?`
			`\n<\/[^>]+?>$`
			`)`
			`\|`
			`(?<html>`
			`# Quote block:`
			`# >>>`
Fix behavior around commands with optional arguments 2016-08-18 15:21:52 -04:00			# Anything, including `/cmd arg` which are ignored by this filter
Don't extract slash commands inside blockcode, blockquote or HTML tags Improve slash command descriptions, support /due tomorrow Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-08-09 16:47:29 -04:00			`# >>>`

			`^>>>`
			`.+?`
			`\n>>>$`
			`)`
			`\|`
			`(?:`
			`# Command not in a blockquote, blockcode, or HTML tag:`
			`# /close`

Fixed specs and fixes based on failing specs 2016-08-13 12:58:51 -04:00			`^\/`
			`(?<cmd>#{Regexp.union(names)})`
			`(?:`
			`[ ]`
Allow slashes in slash command arguments Signed-off-by: Rémy Coutable <remy@rymai.me> 2017-02-17 04:25:34 -05:00			`(?<arg>[^\n]*)`
Fixed specs and fixes based on failing specs 2016-08-13 12:58:51 -04:00			`)?`
			`(?:\n\|$)`
Don't extract slash commands inside blockcode, blockquote or HTML tags Improve slash command descriptions, support /due tomorrow Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-08-09 16:47:29 -04:00			`)`
			`}mx`
Support slash commands in noteable description and notes Some important things to note: - commands are removed from noteable.description / note.note - commands are translated to params so that they are treated as normal params in noteable Creation services - the logic is not in the models but in the Creation services, which is the right place for advanced logic that has nothing to do with what models should be responsible of! - UI/JS needs to be updated to handle notes which consist of commands only - the `/merge` command is not handled yet Other improvements: - Don't process commands in commit notes and display a flash is note is only commands - Add autocomplete for slash commands - Add description and params to slash command DSL methods - Ensure replying by email with a commands-only note works - Use :subscription_event instead of calling noteable.subscribe - Support :todo_event in IssuableBaseService Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-06-30 11:34:19 -04:00			`end`
Address feedback 2016-08-17 19:58:44 -04:00
			`def command_names(opts)`
			`command_definitions.flat_map do \|command\|`
			`next if command.noop?`

			`command.all_names`
			`end.compact`
			`end`
Support slash commands in noteable description and notes Some important things to note: - commands are removed from noteable.description / note.note - commands are translated to params so that they are treated as normal params in noteable Creation services - the logic is not in the models but in the Creation services, which is the right place for advanced logic that has nothing to do with what models should be responsible of! - UI/JS needs to be updated to handle notes which consist of commands only - the `/merge` command is not handled yet Other improvements: - Don't process commands in commit notes and display a flash is note is only commands - Add autocomplete for slash commands - Add description and params to slash command DSL methods - Ensure replying by email with a commands-only note works - Use :subscription_event instead of calling noteable.subscribe - Support :todo_event in IssuableBaseService Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-06-30 11:34:19 -04:00			`end`
			`end`
			`end`