gitlab-triage 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff4171b6337da58a1c33a3cd9bc903e1d2c31292462117b1b479b1445948a603
-  data.tar.gz: 219a8eac9342d358f4a6bccd2e1abc4338d5b10a766d3a7b81ab41a5ed797cbd
+  metadata.gz: 565a738248a7ded7917c1dd9f43962bc564b86a391083c93b91a8e1dc70b40f3
+  data.tar.gz: 2faa52c47be6f7823b9a70efa108bdea330b42a60defaa72ceba563cf7820a76
 SHA512:
-  metadata.gz: 7123c4fc8ea9722acd47db48aafa651437e64a78bc5c5172aec35cf48a7714650d8385dd0842a4a7bc68a27bccf3af1d0275b29b139a4f9de14b8a36db99c9ec
-  data.tar.gz: d9308ca1eed39ca94712203796015763c846a042db1a1865001d2046ef94b146696aa3f26a0ad4f6a3474f335b4947cf61659eae38294655a1c76ea662fee506
+  metadata.gz: a248b17fdaf0faf77e7462e2d69d29efdee698680398643bf575961860a06f996f2114856cc05b146570eac93872786db654c7496389f734084de89bbe129142
+  data.tar.gz: 16bcfc3e4ed9e2db7d52358d4630e94cc5bf4158b37a63000e19ce75a5ad9f5b0cb013ec4e8f43f52782e33632476eea25798fd7a7a86a9c13ab65f397a841b6

data/README.md

@@ -54,7 +54,7 @@ resource_rules:
           mention:
             - markglenfletcher
           comment: |
-            {{author}} This issue is unlabelled after 5 days. It needs attention.
+            {{author}} This issue is unlabelled after 5 days. It needs attention. Please take care of this before the end of #{2.days.from_now.strftime('%Y-%m-%d')}
   merge_requests:
     rules:
       []
@@ -358,31 +358,8 @@ conditions:
 This will make it only act on resources which have active milestones and
 there exists next milestone which has already started.
 
-Here's a list of currently available API:
-
-##### API
-
-| Name      | Return type | Description |
-| ----      | ----        | ----        |
-| milestone | Milestone   | The milestone attached to the resource |
-
-##### Methods for `Milestone`
-
-| Method      | Return type | Description |
-| ----        | ----        | ----        |
-| id          | Integer     | The id of the milestone |
-| iid         | Integer     | The iid of the milestone |
-| project_id  | Integer     | The project id of the milestone if available |
-| group_id    | Integer     | The group id of the milestone if available |
-| title       | String      | The title of the milestone |
-| description | String      | The description of the milestone |
-| state       | String      | The state of the milestone. Could be `active` or `closed` |
-| due_date    | Date        | The due date of the milestone. Could be `nil` |
-| start_date  | Date        | The start date of the milestone. Could be `nil` |
-| updated_at  | Time        | The updated timestamp of the milestone |
-| created_at  | Time        | The created timestamp of the milestone |
-| succ        | Milestone   | The next active milestone beside this milestone |
-| active?     | Boolean     | `true` if `state` is `active`; `false` otherwise |
+See [Ruby expression API](#ruby-expression-api) for the list of currently
+available API.
 
 #### Limits field
 
@@ -525,6 +502,60 @@ actions:
     @{{author}} Are you still interested in finishing this merge request?
 ```
 
+###### Ruby expression
+
+The comment can also contain Ruby expression, using Ruby's own string
+interpolation syntax: `#{ expression }`. This gives you the most flexibility.
+Suppose you want to mention the next active milestone relative to the one
+associated with the resource, you can write:
+
+```yml
+actions:
+  comment: |
+    Please move this to %"#{milestone.succ.title}".
+```
+
+See [Ruby expression API](#ruby-expression-api) for the list of currently
+available API.
+
+**Note:** If you get a syntax error due to stray braces (`{` or `}`), use `\`
+to escape it. For example:
+
+```yml
+actions:
+  comment: |
+    If \} comes first and/or following \{, you'll need to escape them. If it's just { wrapping something } then you don't need to, but it's also fine to escape them like \{ this \} if you prefer.
+```
+
+### Ruby expression API
+
+Here's a list of currently available Ruby expression API:
+
+##### API
+
+| Name      | Return type | Description |
+| ----      | ----        | ----        |
+| resource  | Hash        | The hash containing the raw data of the resource |
+| milestone | Milestone   | The milestone attached to the resource |
+
+##### Methods for `Milestone`
+
+| Method      | Return type | Description |
+| ----        | ----        | ----        |
+| id          | Integer     | The id of the milestone |
+| iid         | Integer     | The iid of the milestone |
+| project_id  | Integer     | The project id of the milestone if available |
+| group_id    | Integer     | The group id of the milestone if available |
+| title       | String      | The title of the milestone |
+| description | String      | The description of the milestone |
+| state       | String      | The state of the milestone. Could be `active` or `closed` |
+| due_date    | Date        | The due date of the milestone. Could be `nil` |
+| start_date  | Date        | The start date of the milestone. Could be `nil` |
+| updated_at  | Time        | The updated timestamp of the milestone |
+| created_at  | Time        | The created timestamp of the milestone |
+| succ        | Milestone   | The next active milestone beside this milestone |
+| active?     | Boolean     | `true` if `state` is `active`; `false` otherwise |
+
 ### Usage
 
 ```

data/gitlab-triage.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['remy@rymai.me']
 
   spec.summary       = 'GitLab triage automation project.'
-  spec.homepage      = 'https://gitlab.com/gitlab-org/triage'
+  spec.homepage      = 'https://gitlab.com/gitlab-org/gitlab-triage'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/lib/gitlab/triage/action.rb

@@ -0,0 +1,28 @@
+require_relative 'action/comment'
+
+module Gitlab
+  module Triage
+    module Action
+      def self.process(rules:, **args)
+        comment = rules.any? && rules
+
+        {
+          Comment => comment
+        }.compact.each do |action, rule|
+          act(action: action, rule: rule, **args)
+        end
+      end
+
+      def self.act(action:, dry:, **args)
+        klass =
+          if dry
+            action.const_get(:Dry)
+          else
+            action
+          end
+
+        klass.new(**args).act
+      end
+    end
+  end
+end

data/lib/gitlab/triage/action/base.rb

@@ -0,0 +1,17 @@
+module Gitlab
+  module Triage
+    module Action
+      class Base
+        attr_reader :name, :type, :rule, :resources, :net
+
+        def initialize(name:, type:, rule:, resources:, net:)
+          @name = name
+          @type = type
+          @rule = rule
+          @resources = resources
+          @net = net
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/action/comment.rb

@@ -0,0 +1,74 @@
+require_relative 'base'
+require_relative '../command_builders/comment_body_builder'
+require_relative '../command_builders/comment_command_builder'
+require_relative '../command_builders/label_command_builder'
+require_relative '../command_builders/remove_label_command_builder'
+require_relative '../command_builders/cc_command_builder'
+require_relative '../command_builders/status_command_builder'
+
+module Gitlab
+  module Triage
+    module Action
+      class Comment < Base
+        class Dry < Comment
+          def act
+            puts "\nThe following comments would be posted for the rule **#{name}**:\n\n"
+
+            super
+          end
+
+          private
+
+          def perform(resource, comment)
+            puts "# #{resource[:web_url]}\n```\n#{comment}\n```\n"
+          end
+        end
+
+        def act
+          resources.each do |resource|
+            comment = build_comment(resource)
+
+            perform(resource, comment)
+          end
+        end
+
+        private
+
+        def build_comment(resource)
+          CommandBuilders::CommentCommandBuilder.new(
+            [
+              CommandBuilders::CommentBodyBuilder.new(rule[:comment], resource: resource, net: net).build_command,
+              CommandBuilders::LabelCommandBuilder.new(rule[:labels]).build_command,
+              CommandBuilders::RemoveLabelCommandBuilder.new(rule[:remove_labels]).build_command,
+              CommandBuilders::CcCommandBuilder.new(rule[:mention]).build_command,
+              CommandBuilders::StatusCommandBuilder.new(rule[:status]).build_command
+            ]
+          ).build_command
+        end
+
+        def perform(resource, comment)
+          net[:network].post_api(
+            net[:token],
+            build_post_url(resource),
+            comment)
+        end
+
+        def build_post_url(resource)
+          # POST /projects/:id/issues/:issue_iid/notes
+          post_url = UrlBuilders::UrlBuilder.new(
+            host_url: net[:host_url],
+            api_version: net[:api_version],
+            source_id: net[:source_id],
+            resource_type: type,
+            resource_id: resource['iid'],
+            sub_resource_type: 'notes'
+          ).build
+
+          puts Gitlab::Triage::UI.debug "post_url: #{post_url}" if net[:debug]
+
+          post_url
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/command_builders/comment_body_builder.rb

@@ -1,32 +1,36 @@
+# frozen_string_literal: true
+
 require_relative 'base_command_builder'
+require_relative '../resource/context'
 
 module Gitlab
   module Triage
     module CommandBuilders
       class CommentBodyBuilder < BaseCommandBuilder
         SUPPORTED_PLACEHOLDERS = {
-          created_at: "{{created_at}}".freeze,
-          updated_at: "{{updated_at}}".freeze,
-          closed_at: "{{closed_at}}".freeze,
-          merged_at: "{{merged_at}}".freeze,
-          state: "{{state}}".freeze,
-          author: "@{{author.username}}".freeze,
-          assignee: "@{{assignee.username}}".freeze,
-          assignees: "@{{assignees.username}}".freeze,
-          closed_by: "@{{closed_by.username}}".freeze,
-          merged_by: "@{{merged_by.username}}".freeze,
-          milestone: %(%"{{milestone.title}}").freeze,
-          labels: %(~"{{labels}}").freeze,
-          upvotes: "{{upvotes}}".freeze,
-          downvotes: "{{downvotes}}".freeze
+          created_at: "{{created_at}}",
+          updated_at: "{{updated_at}}",
+          closed_at: "{{closed_at}}",
+          merged_at: "{{merged_at}}",
+          state: "{{state}}",
+          author: "@{{author.username}}",
+          assignee: "@{{assignee.username}}",
+          assignees: "@{{assignees.username}}",
+          closed_by: "@{{closed_by.username}}",
+          merged_by: "@{{merged_by.username}}",
+          milestone: %(%"{{milestone.title}}"),
+          labels: %(~"{{labels}}"),
+          upvotes: "{{upvotes}}",
+          downvotes: "{{downvotes}}"
         }.freeze
         PLACEHOLDER_REGEX = /{{([\w\.]+)}}/
 
-        attr_reader :resource
+        attr_reader :resource, :net
 
-        def initialize(items, resource: nil)
+        def initialize(items, resource: nil, net: {})
           super(items)
           @resource = resource
+          @net = net
         end
 
         private
@@ -38,6 +42,16 @@ module Gitlab
         def format_item(item)
           return item unless resource
 
+          replace_placeholders(eval_interpolation(item))
+        end
+
+        def eval_interpolation(item)
+          quoted_comment = "%Q{#{item}}"
+
+          Resource::Context.new(resource, net).eval(quoted_comment)
+        end
+
+        def replace_placeholders(item)
           SUPPORTED_PLACEHOLDERS.inject(item) do |comment, (placeholder, formatted_text)|
             next comment unless comment.include?("{{#{placeholder}}}")
 

data/lib/gitlab/triage/engine.rb

@@ -9,12 +9,7 @@ require_relative 'filters/author_member_conditions_filter'
 require_relative 'filters/assignee_member_conditions_filter'
 require_relative 'filters/ruby_conditions_filter'
 require_relative 'limiters/date_field_limiter'
-require_relative 'command_builders/comment_body_builder'
-require_relative 'command_builders/comment_command_builder'
-require_relative 'command_builders/label_command_builder'
-require_relative 'command_builders/remove_label_command_builder'
-require_relative 'command_builders/cc_command_builder'
-require_relative 'command_builders/status_command_builder'
+require_relative 'action'
 require_relative 'api_query_builders/single_query_param_builder'
 require_relative 'api_query_builders/multi_query_param_builder'
 require_relative 'url_builders/url_builder'
@@ -77,6 +72,17 @@ module Gitlab
         @network ||= Network.new(network_adapter, options)
       end
 
+      def net
+        @net ||= {
+          host_url: host_url,
+          api_version: api_version,
+          token: options.token,
+          source_id: options.project_id,
+          debug: options.debug,
+          network: network
+        }
+      end
+
       def network_adapter
         @network_adapter ||= @network_adapter_class.new(options)
       end
@@ -105,13 +111,17 @@ module Gitlab
           print "* Limiting resources..."
           resources = limit_resources(resources, rule_limits(rule))
           puts "\n* Total after limiting: #{resources.count} resources"
-          process_resources(resource_type, resources, rule)
+          Action.process(
+            name: rule[:name],
+            type: resource_type,
+            rules: rule_actions(rule),
+            resources: resources,
+            net: net,
+            dry: options.dry_run)
         end
       end
 
       def filter_resources(resources, conditions)
-        net = { host_url: host_url, api_version: api_version, token: options.token, network: network }
-
         resources.select do |resource|
           results = []
 
@@ -135,34 +145,6 @@ module Gitlab
         end
       end
 
-      def process_resources(resource_type, resources, rule)
-        if options.dry_run
-          puts "\nThe following comments would be posted for the rule **#{rule[:name]}**:\n\n"
-        end
-
-        resources.each do |resource|
-          comment = build_comment(rule_actions(rule), resource: resource)
-
-          if options.dry_run
-            puts "# #{resource[:web_url]}\n```\n#{comment}\n```\n"
-          else
-            network.post_api(options.token, build_post_url(resource_type, resource), comment)
-          end
-        end
-      end
-
-      def build_comment(actions, resource: nil)
-        CommandBuilders::CommentCommandBuilder.new(
-          [
-            CommandBuilders::CommentBodyBuilder.new(actions[:comment], resource: resource).build_command,
-            CommandBuilders::LabelCommandBuilder.new(actions[:labels]).build_command,
-            CommandBuilders::RemoveLabelCommandBuilder.new(actions[:remove_labels]).build_command,
-            CommandBuilders::CcCommandBuilder.new(actions[:mention]).build_command,
-            CommandBuilders::StatusCommandBuilder.new(actions[:status]).build_command
-          ]
-        ).build_command
-      end
-
       def build_get_url(resource_type, conditions)
         # Example issues query with state and labels
         # https://gitlab.com/api/v4/projects/test-triage%2Fissue-project/issues?state=open&labels=project%20label%20with%20spaces,group_label_no_spaces
@@ -191,22 +173,6 @@ module Gitlab
 
         get_url
       end
-
-      def build_post_url(resource_type, resource)
-        # POST /projects/:id/issues/:issue_iid/notes
-        post_url = UrlBuilders::UrlBuilder.new(
-          host_url: host_url,
-          api_version: api_version,
-          source_id: options.project_id,
-          resource_type: resource_type,
-          resource_id: resource['iid'],
-          sub_resource_type: 'notes'
-        ).build
-
-        puts Gitlab::Triage::UI.debug "post_url: #{post_url}" if options.debug
-
-        post_url
-      end
     end
   end
 end

data/lib/gitlab/triage/limiters/date_field_limiter.rb

@@ -27,10 +27,10 @@ module Gitlab
 
         def limit
           case @criterion
-          when :most_recent
-            @resources.first(@threshold)
           when :oldest
-            @resources.last(@threshold)
+            @resources.first(@threshold)
+          when :most_recent
+            @resources.last(@threshold).reverse
           end
         end
 

data/lib/gitlab/triage/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Triage
-    VERSION = '0.8.1'.freeze
+    VERSION = '0.9.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-triage
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2018-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -131,6 +131,9 @@ files:
 - bin/gitlab-triage
 - gitlab-triage.gemspec
 - lib/gitlab/triage.rb
+- lib/gitlab/triage/action.rb
+- lib/gitlab/triage/action/base.rb
+- lib/gitlab/triage/action/comment.rb
 - lib/gitlab/triage/api_query_builders/base_query_param_builder.rb
 - lib/gitlab/triage/api_query_builders/multi_query_param_builder.rb
 - lib/gitlab/triage/api_query_builders/single_query_param_builder.rb
@@ -172,7 +175,7 @@ files:
 - lib/gitlab/triage/version.rb
 - support/.gitlab-ci.example.yml
 - support/.triage-policies.example.yml
-homepage: https://gitlab.com/gitlab-org/triage
+homepage: https://gitlab.com/gitlab-org/gitlab-triage
 licenses:
 - MIT
 metadata: {}