gitlab-triage 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 565a738248a7ded7917c1dd9f43962bc564b86a391083c93b91a8e1dc70b40f3
-  data.tar.gz: 2faa52c47be6f7823b9a70efa108bdea330b42a60defaa72ceba563cf7820a76
+  metadata.gz: 29ce6bb293cf3eb96b5c9f11179351472211bc15014fa365235013930ea8e951
+  data.tar.gz: '039d533aace6b86fd0518259e0dc2a5dc73a3b49a5ee87a55b6e4a4fa256fd52'
 SHA512:
-  metadata.gz: a248b17fdaf0faf77e7462e2d69d29efdee698680398643bf575961860a06f996f2114856cc05b146570eac93872786db654c7496389f734084de89bbe129142
-  data.tar.gz: 16bcfc3e4ed9e2db7d52358d4630e94cc5bf4158b37a63000e19ce75a5ad9f5b0cb013ec4e8f43f52782e33632476eea25798fd7a7a86a9c13ab65f397a841b6
+  metadata.gz: 06273cdd4019d0619648b3b7b0ef8dfaa93f37fd152945faad44f92e119bcedc30c6db8235e5f8ba5c6a7126b1137a0cbad5920efe91bb732b4cb7f0d7899df2
+  data.tar.gz: c0a6940c1eb46580b77a1c0addbb2f6e19bcc69bc36f0bab34de6d36072cfa1111438cbdd057798a803e8bf252dd1acf26395c8e1095fdb57cd0ebc59f44d490

data/.gitlab/CODEOWNERS

@@ -0,0 +1,2 @@
+# The official maintainers
+* @rymai @godfat @markglenfletcher

data/README.md

@@ -55,6 +55,18 @@ resource_rules:
             - markglenfletcher
           comment: |
             {{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')}
+          summarize:
+            title: Issues require labels
+            item: |
+              - [ ] [{{title}}]({{web_url}}) {{labels}}
+            summary: |
+              The following issues require labels:
+
+              {{items}}
+
+              Please take care of them before the end of #{7.days.from_now.strftime('%Y-%m-%d')}
+
+              /label ~"needs attention"
   merge_requests:
     rules:
       []
@@ -395,6 +407,7 @@ Available action types:
 - [`status` action](#status-action)
 - [`mention` action](#mention-action)
 - [`comment` action](#comment-action)
+- [`summarize` action](#summarize-action)
 
 ##### Labels action
 
@@ -482,6 +495,8 @@ The following placeholders are supported:
 - `labels`: the resource's labels as `~label1, ~label2`
 - `upvotes`: the resources's upvotes count
 - `downvotes`: the resources's downvotes count
+- `title`: the resource's title
+- `web_url`: the web URL pointing to the resource
 
 If the resource doesn't respond to the placeholder, or if the field is `nil`,
 the placeholder is not replaced.
@@ -499,7 +514,7 @@ Example with placeholders:
 ```yml
 actions:
   comment: |
-    @{{author}} Are you still interested in finishing this merge request?
+    {{author}} Are you still interested in finishing this merge request?
 ```
 
 ###### Ruby expression
@@ -527,6 +542,68 @@ actions:
     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.
 ```
 
+##### Summarize action
+
+Generates an issue summarizing what was triaged.
+
+Accepts a hash of fields.
+
+| Field     | Type   | Description                            | Required | Placeholders | Ruby expression |
+| ----      | ----   | ----                                   | ----     | ----         | ----            |
+| `title`   | string | The title of the generated issue       | yes      | no           | no              |
+| `item`    | string | Template representing each triaged resource | no       | yes          | yes             |
+| `summary` | string | The description of the generated issue | no       | Only `{{items}}` and `{{title}}` | yes |
+
+**Note:**: Both `item` and `summary` fields act like a
+[comment action](#comment-action), therefore
+[Ruby expression](#ruby-expression) is supported.
+Placeholders work regularly for `item`, but for `summary` only
+`{{items}}` and `{{title}}` are supported because it's not tied to a
+particular resource like the comment action.
+
+The following placeholders are supported for `summary`:
+
+- `items`: Concatenated markdown separated by a newline for each `item`
+- `title`: The title of the generated issue
+
+Example:
+
+```yml
+limits:
+  most_recent: 15
+actions:
+  summarize:
+    title: Issues require labels
+    item: |
+      - [ ] [{{title}}]({{web_url}}) {{labels}}
+    summary: |
+      The following issues require labels:
+
+      {{items}}
+
+      Please take care of them before the end of #{7.days.from_now.strftime('%Y-%m-%d')}
+
+      /label ~"needs attention"
+```
+
+Which could generate an issue like:
+
+* Title:
+  ```
+  Issues require labels
+  ```
+* Description:
+  ``` markdown
+  The following issues require labels:
+
+  - [ ] [An example issue](http://example.com/group/project/issues/1) ~"label A", ~"label B"
+  - [ ] [Another issue](http://example.com/group/project/issues/2) ~"label B", ~"label C"
+
+  Please take care of them before the end of 2000-01-01
+
+  /label ~"needs attention"
+  ```
+
 ### Ruby expression API
 
 Here's a list of currently available Ruby expression API:

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

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require_relative 'base'
-require_relative '../command_builders/comment_body_builder'
+require_relative '../command_builders/text_content_builder'
 require_relative '../command_builders/comment_command_builder'
 require_relative '../command_builders/label_command_builder'
 require_relative '../command_builders/remove_label_command_builder'
@@ -37,7 +39,7 @@ module Gitlab
         def build_comment(resource)
           CommandBuilders::CommentCommandBuilder.new(
             [
-              CommandBuilders::CommentBodyBuilder.new(rule[:comment], resource: resource, net: net).build_command,
+              CommandBuilders::TextContentBuilder.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,
@@ -50,7 +52,7 @@ module Gitlab
           net[:network].post_api(
             net[:token],
             build_post_url(resource),
-            comment)
+            body: comment)
         end
 
         def build_post_url(resource)

data/lib/gitlab/triage/action/summarize/issue_builder.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../../command_builders/text_content_builder'
+
+module Gitlab
+  module Triage
+    module Action
+      class IssueBuilder
+        attr_reader :title
+
+        def initialize(action, resources, net)
+          @title = action[:title]
+          @item_template = action[:item]
+          @summary_template = action[:summary]
+          @resources = resources
+          @net = net
+        end
+
+        def description
+          return '' unless @summary_template
+
+          @description ||= CommandBuilders::TextContentBuilder.new(
+            @summary_template, resource: summary_resource, net: @net)
+            .build_command
+        end
+
+        def valid?
+          title =~ /\S+/
+        end
+
+        private
+
+        def summary_resource
+          @summary_resource ||= {
+            'items' => items,
+            'title' => title
+          }
+        end
+
+        def items
+          return '' unless @item_template
+
+          @items ||= @resources.map(&method(:build_item)).join("\n")
+        end
+
+        def build_item(resource)
+          CommandBuilders::TextContentBuilder.new(
+            @item_template, resource: resource, net: @net)
+            .build_command.chomp
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'summarize/issue_builder'
+
+module Gitlab
+  module Triage
+    module Action
+      class Summarize < Base
+        class Dry < Summarize
+          private
+
+          def perform
+            puts "\nThe following issue would be created for the rule **#{name}**:\n\n"
+            puts ">>>"
+            puts "* Title: #{issue.title}"
+            puts "* Description: #{issue.description}"
+            puts ">>>"
+          end
+        end
+
+        def act
+          perform if resources.any? && issue.valid?
+        end
+
+        private
+
+        def perform
+          net[:network].post_api(net[:token], post_issue_url, post_issue_body)
+        end
+
+        def issue
+          @issue ||= IssueBuilder.new(rule, resources, net)
+        end
+
+        def post_issue_url
+          # POST /projects/:id/issues
+          # https://docs.gitlab.com/ee/api/issues.html#new-issue
+          post_url = UrlBuilders::UrlBuilder.new(
+            host_url: net[:host_url],
+            api_version: net[:api_version],
+            source_id: net[:source_id],
+            resource_type: 'issues'
+          ).build
+
+          puts Gitlab::Triage::UI.debug "post_issue_url: #{post_url}" if net[:debug]
+
+          post_url
+        end
+
+        def post_issue_body
+          {
+            title: issue.title,
+            description: issue.description
+          }
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/action.rb

@@ -1,15 +1,18 @@
+require_relative 'action/summarize'
 require_relative 'action/comment'
 
 module Gitlab
   module Triage
     module Action
       def self.process(rules:, **args)
+        summarize = rules.delete(:summarize)
         comment = rules.any? && rules
 
         {
+          Summarize => summarize,
           Comment => comment
         }.compact.each do |action, rule|
-          act(action: action, rule: rule, **args)
+          act(action: action, rule: rule, **args) if rule
         end
       end
 

data/lib/gitlab/triage/command_builders/{comment_body_builder.rb → text_content_builder.rb}

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/array/wrap'
+
 require_relative 'base_command_builder'
 require_relative '../resource/context'
 
 module Gitlab
   module Triage
     module CommandBuilders
-      class CommentBodyBuilder < BaseCommandBuilder
+      class TextContentBuilder < BaseCommandBuilder
         SUPPORTED_PLACEHOLDERS = {
           created_at: "{{created_at}}",
           updated_at: "{{updated_at}}",
@@ -21,7 +23,10 @@ module Gitlab
           milestone: %(%"{{milestone.title}}"),
           labels: %(~"{{labels}}"),
           upvotes: "{{upvotes}}",
-          downvotes: "{{downvotes}}"
+          downvotes: "{{downvotes}}",
+          title: "{{title}}",
+          web_url: "{{web_url}}",
+          items: "{{items}}"
         }.freeze
         PLACEHOLDER_REGEX = /{{([\w\.]+)}}/
 

data/lib/gitlab/triage/network_adapters/httparty_adapter.rb

@@ -31,7 +31,7 @@ module Gitlab
         def post(token, url, body)
           HTTParty.post(
             url,
-            body: { body: body }.to_json,
+            body: body.to_json,
             headers: {
               'Content-type' => 'application/json',
               'PRIVATE-TOKEN' => token

data/lib/gitlab/triage/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-triage
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-05 00:00:00.000000000 Z
+date: 2018-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -119,6 +119,7 @@ files:
 - ".codeclimate.yml"
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".gitlab/CODEOWNERS"
 - ".gitlab/issue_templates/Policy.md"
 - ".rubocop.yml"
 - ".triage-policies.yml"
@@ -134,16 +135,18 @@ files:
 - lib/gitlab/triage/action.rb
 - lib/gitlab/triage/action/base.rb
 - lib/gitlab/triage/action/comment.rb
+- lib/gitlab/triage/action/summarize.rb
+- lib/gitlab/triage/action/summarize/issue_builder.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
 - lib/gitlab/triage/command_builders/base_command_builder.rb
 - lib/gitlab/triage/command_builders/cc_command_builder.rb
-- lib/gitlab/triage/command_builders/comment_body_builder.rb
 - lib/gitlab/triage/command_builders/comment_command_builder.rb
 - lib/gitlab/triage/command_builders/label_command_builder.rb
 - lib/gitlab/triage/command_builders/remove_label_command_builder.rb
 - lib/gitlab/triage/command_builders/status_command_builder.rb
+- lib/gitlab/triage/command_builders/text_content_builder.rb
 - lib/gitlab/triage/engine.rb
 - lib/gitlab/triage/expand_condition.rb
 - lib/gitlab/triage/expand_condition/sequence.rb