lazylead 0.1.1 → 0.4.0

data/lib/lazylead/system/fake.rb

@@ -34,7 +34,7 @@ module Lazylead
       @issues = issues
     end
 
-    def issues(_)
+    def issues(*)
       @issues
     end
   end

data/lib/lazylead/system/jira.rb

@@ -23,6 +23,7 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require "jira-ruby"
+require "forwardable"
 require_relative "../salt"
 
 module Lazylead
@@ -35,7 +36,7 @@ module Lazylead
     # @todo #57/DEV The debug method should be moved outside of ctor.
     #  This was moved here from 'client' method because Rubocop failed the build
     #  due to 'Metrics/AbcSize' violation.
-    def initialize(opts, salt = NoSalt.new, log = Log::NOTHING)
+    def initialize(opts, salt = NoSalt.new, log = Log.new)
       @opts = opts
       @salt = salt
       @log = log
@@ -46,7 +47,7 @@ module Lazylead
 
     def issues(jql, opts = {})
       raw do |jira|
-        jira.Issue.jql(jql, opts).map { |i| Lazylead::Issue.new(i) }
+        jira.Issue.jql(jql, opts).map { |i| Lazylead::Issue.new(i, jira) }
       end
     end
 
@@ -136,8 +137,9 @@ module Lazylead
   # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
   # License:: MIT
   class Issue
-    def initialize(issue)
+    def initialize(issue, jira)
       @issue = issue
+      @jira = jira
     end
 
     def id
@@ -183,7 +185,10 @@ module Lazylead
     end
 
     def comments
-      @issue.comments
+      return @comments if defined? @comments
+      @comments = @jira.Issue.find(@issue.id, expand: "comments", fields: "")
+                       .comments
+                       .map { |c| Comment.new(c) }
     end
 
     def to_s
@@ -193,6 +198,14 @@ module Lazylead
     def inspect
       to_s
     end
+
+    def status
+      @issue.status.attrs["name"]
+    end
+
+    def post(markdown)
+      @issue.comments.build.save!(body: markdown)
+    end
   end
 
   # The jira issue comments
@@ -224,26 +237,56 @@ module Lazylead
     end
   end
 
+  # Comment in jira ticket
+  class Comment
+    def initialize(comment)
+      @comment = comment
+    end
+
+    # Check that comment has expected text
+    def include?(text)
+      @comment.attrs["body"].include? text
+    end
+  end
+
   # Jira instance without authentication in order to access public filters
   #  or dashboards.
   class NoAuthJira
-    def initialize(url, log = Log::NOTHING)
+    extend Forwardable
+    def_delegators :@jira, :issues, :raw
+
+    def initialize(url, path = "", log = Log.new)
       @jira = Jira.new(
-        { username: nil, password: nil, site: url, context_path: "" },
+        {
+          username: nil,
+          password: nil,
+          site: url,
+          context_path: path
+        },
         NoSalt.new,
         log
       )
     end
+  end
 
-    def issues(jql, opts = {})
-      @jira.issues(jql, opts)
+  # A fake jira system which allows to work with sub-tasks.
+  class Fake
+    def initialize(issues)
+      @issues = issues
+    end
+
+    def issues(*)
+      @issues
     end
 
     # Execute request to the ticketing system using raw client.
-    # For Jira the raw client is 'jira-ruby' gem.
-    def raw(&block)
-      raise "ll-07: No block given to method" unless block_given?
-      @jira.raw(&block)
+    def raw
+      raise "ll-08: No block given to method" unless block_given?
+      yield(OpenStruct.new(Issue: self))
+    end
+
+    def find(id)
+      @issues.detect { |i| i.id.eql? id }
     end
   end
 end

data/lib/lazylead/system/synced.rb

@@ -30,7 +30,8 @@ module Lazylead
       @sys = sys
     end
 
-    # @todo #/DEV Unit tests for 'issues' function
+    # @todo #/DEV Unit tests for 'issues' function, moreover the other methods
+    #  from ticketing system obj are required
     #
     def issues(jql)
       @mutex.synchronize do

data/lib/lazylead/task/accuracy/accuracy.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+# The MIT License
+#
+# Copyright (c) 2019-2020 Yurii Dubinka
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"),
+# to deal in the Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom
+# the Software is  furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+# OR OTHER DEALINGS IN THE SOFTWARE.
+
+require_relative "../../log"
+require_relative "../../opts"
+require_relative "../../email"
+require_relative "../../version"
+require_relative "../../postman"
+
+module Lazylead
+  module Task
+    #
+    # Evaluate ticket format and accuracy
+    #
+    # The task supports the following features:
+    #  - fetch issues from remote ticketing system by query
+    #  - evaluate each field within the ticket
+    #  - post the score to the ticket
+    class Accuracy
+      def initialize(log = Log.new)
+        @log = log
+      end
+
+      def run(sys, postman, opts)
+        require_rules
+        rules = opts.slice("rules", ",")
+                    .map(&:constantize)
+                    .map(&:new)
+        raised = sys.issues(opts["jql"], opts.jira_defaults)
+                    .map { |i| Score.new(i, opts, rules) }
+                    .each(&:evaluate)
+                    .each(&:post)
+        postman.send opts.merge(tickets: raised) unless raised.empty?
+      end
+
+      # Load all ticket accuracy rules for future verification
+      def require_rules
+        rules = File.dirname(__FILE__)
+        $LOAD_PATH.unshift(rules) unless $LOAD_PATH.include?(rules)
+      end
+    end
+  end
+
+  # The ticket score based on fields content.
+  class Score
+    attr_reader :issue, :total, :score, :accuracy
+
+    def initialize(issue, opts, rules)
+      @issue = issue
+      @link = opts["docs"]
+      @opts = opts
+      @rules = rules
+    end
+
+    # Estimate the ticket score and accuracy.
+    # Accuracy is a percentage between current score and maximum possible value.
+    def evaluate(digits = 2)
+      @total = @rules.map(&:score).sum
+      @score = @rules.select { |r| r.passed(@issue) }
+                     .map(&:score)
+                     .sum
+      @accuracy = (score / @total * 100).round(digits)
+    end
+
+    # Post the comment with score and accuracy to the ticket.
+    def post
+      @issue.post(comment) unless @opts.key? "silent"
+    end
+
+    # The jira comment in markdown format
+    def comment
+      comment = [
+        "Hi [~#{@issue.reporter.id}],",
+        "",
+        "The triage accuracy is '{color:#{color}}#{@score}{color}'" \
+          " (~{color:#{color}}#{@accuracy}%{color}), here are the reasons why:",
+        "|| Ticket requirement || Status || Field ||"
+      ]
+      @rules.each do |r|
+        comment << "|#{r.desc}|#{r.passed(@issue) ? '(/)' : '(-)'}|#{r.field}|"
+      end
+      comment << docs_link
+      comment << ""
+      comment << "Posted by [lazylead v#{Lazylead::VERSION}|" \
+                    "https://bit.ly/2NjdndS]."
+      comment.join("\r\n")
+    end
+
+    # Link to ticket formatting rules
+    def docs_link
+      if @link.nil? || @link.blank?
+        ""
+      else
+        "The requirements/examples of ticket formatting rules you may find " \
+          "[here|#{@link}]."
+      end
+    end
+
+    def color
+      if colors.nil? || !defined?(@score) || !@score.is_a?(Numeric)
+        return "#061306"
+      end
+      colors.reverse_each do |color|
+        return color.last if @accuracy >= color.first
+      end
+      "#061306"
+    end
+
+    def colors
+      @colors ||= begin
+                    JSON.parse(@opts["colors"])
+                        .to_h
+                        .to_a
+                        .each { |e| e[0] = e[0].to_i }
+                        .sort_by { |e| e[0] }
+                  end
+    end
+  end
+end

data/lib/lazylead/task/accuracy/affected_build.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# The MIT License
+#
+# Copyright (c) 2019-2020 Yurii Dubinka
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"),
+# to deal in the Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom
+# the Software is  furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+# OR OTHER DEALINGS IN THE SOFTWARE.
+
+require_relative "../../log"
+require_relative "../../email"
+require_relative "../../version"
+require_relative "../../postman"
+require_relative "requirement"
+
+module Lazylead
+  # A requirement that Jira field "Affects Version/s" provided by the reporter.
+  class RequirementAffectedBuild < Requirement
+    def initialize(score = 0.5)
+      super "Affected build", score, "Affects Version/s"
+    end
+
+    # @return true if an issue has non-empty "Affects Version/s" field
+    def passed(issue)
+      !issue.fields["versions"].nil? && !issue.fields["versions"].empty?
+    end
+  end
+end

data/lib/lazylead/task/accuracy/requirement.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# The MIT License
+#
+# Copyright (c) 2019-2020 Yurii Dubinka
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"),
+# to deal in the Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom
+# the Software is  furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+# OR OTHER DEALINGS IN THE SOFTWARE.
+
+module Lazylead
+  # An single requirement regarding ticket format.
+  class Requirement
+    attr_reader :score, :desc, :field
+
+    def initialize(desc, score, field)
+      @desc = desc
+      @score = score
+      @field = field
+    end
+
+    def passed(_)
+      true
+    end
+  end
+end

data/lib/lazylead/task/alert.rb

@@ -23,6 +23,7 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require_relative "../log"
+require_relative "../opts"
 require_relative "../email"
 require_relative "../version"
 require_relative "../postman"
@@ -43,12 +44,13 @@ module Lazylead
     #  - prepare email based on predefined template (*.erb)
     #  - send the required notifications pre-defined "addressee".
     class Alert
-      def initialize(log = Log::NOTHING)
+      def initialize(log = Log.new)
         @log = log
       end
 
       def run(sys, postman, opts)
-        postman.send opts.merge(tickets: sys.issues(opts["sql"]))
+        tickets = sys.issues(opts["sql"], opts.jira_defaults)
+        postman.send opts.merge(tickets: tickets) unless tickets.empty?
       end
     end
 
@@ -64,12 +66,12 @@ module Lazylead
     # The email message is sending to the assignee regarding all his/her issues,
     #  not like one email per each issue.
     class AssigneeAlert
-      def initialize(log = Log::NOTHING)
+      def initialize(log = Log.new)
         @log = log
       end
 
       def run(sys, postman, opts)
-        sys.issues(opts["sql"])
+        sys.issues(opts["sql"], opts.jira_defaults)
            .group_by(&:assignee)
            .each do |a, t|
           postman.send opts.merge(to: a.email, addressee: a.name, tickets: t)
@@ -89,12 +91,12 @@ module Lazylead
     # The email message is sending to the assignee regarding all his/her issues,
     #  not like one email per each issue.
     class ReporterAlert
-      def initialize(log = Log::NOTHING)
+      def initialize(log = Log.new)
         @log = log
       end
 
       def run(sys, postman, opts)
-        sys.issues(opts["sql"])
+        sys.issues(opts["sql"], opts.jira_defaults)
            .group_by(&:reporter)
            .each do |a, t|
           postman.send opts.merge(to: a.email, addressee: a.name, tickets: t)

data/lib/lazylead/task/confluence_ref.rb

@@ -26,6 +26,7 @@ require "json"
 require "faraday"
 require_relative "../system/jira"
 require_relative "../log"
+require_relative "../opts"
 require_relative "../confluence"
 
 module Lazylead
@@ -35,14 +36,14 @@ module Lazylead
     # @todo #/DEV Support sub-task for link search. Potentially, the issue
     #  might have sub-tasks where discussion ongoing.
     class ConfluenceRef
-      def initialize(log = Log::NOTHING)
+      def initialize(log = Log.new)
         @log = log
       end
 
       def run(sys, _, opts)
         confluences = confluences(opts)
         return if confluences.empty?
-        sys.issues(opts["jql"])
+        sys.issues(opts["jql"], opts.jira_defaults)
            .map { |i| Link.new(i, sys, confluences) }
            .each(&:fetch_links)
            .select(&:need_link?)
@@ -50,7 +51,7 @@ module Lazylead
       end
 
       def confluences(opts)
-        return [] if opts["confluences"].nil? || opts["confluences"].blank?
+        return [] if opts.blank? "confluences"
         JSON.parse(opts["confluences"], object_class: OpenStruct)
             .map { |c| Confluence.new(c) }
       end