lazylead 0.7.2 → 0.9.0

data/lib/lazylead/postman.rb

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),

data/{Guardfile → lib/lazylead/requires.rb}

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),
@@ -22,12 +22,17 @@
 # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
-# Guardfile for Lazylead
-guard :minitest, all_after_pass: false, all_on_start: false do
-  # with Minitest::Unit
-  watch(%r{^test/(.*)/?test_(.*)\.rb$})
-  watch(%r{^test/test\.rb$}) { "test" }
-  watch(%r{^lib/lazylead/(.*/)?([^/]+)\.rb$}) do |m|
-    "test/#{m[1]}test_#{m[2]}.rb"
+module Lazylead
+  #
+  # Allows to load all ruby files within particular dir.
+  #
+  class Requires
+    def initialize(dir)
+      @dir = dir
+    end
+
+    def load
+      Dir[File.join(@dir, "*.rb")].sort.each { |f| require f }
+    end
   end
 end

data/lib/lazylead/salt.rb

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),

data/lib/lazylead/schedule.rb

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),

data/lib/lazylead/smtp.rb

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),

data/lib/lazylead/system/empty.rb

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),

data/lib/lazylead/system/fake.rb

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),

data/lib/lazylead/system/jira.rb

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),
@@ -26,10 +26,15 @@ require "jira-ruby"
 require "forwardable"
 require_relative "../salt"
 require_relative "../opts"
+require_relative "../log"
 
 module Lazylead
   # Jira system for manipulation with issues.
   #
+  # Jira official documentation:
+  #  - https://docs.atlassian.com/jira-software/REST/7.3.1/#agile/1.0/issue-getIssue
+  #  - https://developer.atlassian.com/server/jira/platform/rest-apis/
+  #
   # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
   # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
   # License:: MIT
@@ -82,22 +87,7 @@ module Lazylead
       @opts[:auth_type] = :basic if @opts[:auth_type].nil?
       @opts["username"] = @salt.decrypt(@opts["username"]) if @salt.specified?
       @opts["password"] = @salt.decrypt(@opts["password"]) if @salt.specified?
-      cp("site", :site)
-      cp("username", :username)
-      cp("password", :password)
-      cp("context_path", :context_path)
-      @client = JIRA::Client.new(@opts)
-    end
-
-    # Copy the required/mandatory parameter(s) for Jira client which can't
-    #  be specified/defined at database level.
-    #
-    # @todo #/DEV Jira.cp - find a way how to avoid this method.
-    #  Potentially, hash with indifferent access might be used.
-    #  http://jocellyn.cz/2014/05/03/hash-with-indifferent-access.html
-    #  key.kind_of?(Symbol) ? key.to_s : key
-    def cp(act, exp)
-      @opts[exp] = @opts[act] if @opts.key? act
+      @client = JIRA::Client.new(@opts.symbolize_keys)
     end
   end
 
@@ -139,11 +129,7 @@ module Lazylead
     end
 
     def to_s
-      inspect
-    end
-
-    def inspect
-      "#{@opts['site']} (#{@opts['username']})"
+      "#{name} (#{id})"
     end
   end
 
@@ -267,13 +253,20 @@ module Lazylead
 
     # Update the labels for a particular issue
     def labels!(lbl)
-      return if lbl.nil? || lbl.empty?
-      save!("fields" => { "labels" => lbl.uniq })
+      save!("fields" => { "labels" => lbl.uniq }) unless lbl.empty?
     end
 
     def save!(opts)
       @issue.save(opts)
     end
+
+    def sprint(field = "customfield_10480")
+      @sprint ||= if fields[field].nil? || fields[field].empty?
+                    ""
+                  else
+                    fields[field].first.split(",").find { |text| text.starts_with? "name=" }[5..]
+                  end
+    end
   end
 
   # The jira issue comments
@@ -313,7 +306,19 @@ module Lazylead
 
     # Check that comment has expected text
     def include?(text)
-      @comment.attrs["body"].include? text
+      to_s.include? text
+    end
+
+    def to_s
+      @comment.attrs["body"]
+    end
+
+    def lines
+      to_s.split("\n").reject(&:blank?)
+    end
+
+    def author
+      @comment.attrs["author"]["displayName"]
     end
   end
 

data/lib/lazylead/system/synced.rb

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),

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

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),
@@ -27,6 +27,7 @@ require_relative "../../opts"
 require_relative "../../email"
 require_relative "../../version"
 require_relative "../../postman"
+require_relative "../../requires"
 
 module Lazylead
   module Task
@@ -43,36 +44,33 @@ module Lazylead
       end
 
       def run(sys, postman, opts)
-        Dir[File.join(__dir__, "*.rb")].sort.each { |f| require f }
-        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?
+        Requires.new(__dir__).load
+        opts[:rules] = opts.construct("rules")
+        opts[:total] = opts[:rules].sum(&:score)
+        opts[:tickets] = sys.issues(opts["jql"], opts.jira_defaults.merge(expand: "changelog"))
+                            .map { |i| Score.new(i, opts) }
+                            .each(&:evaluate)
+                            .each(&:post)
+        postman.send(opts) unless opts[:tickets].empty?
       end
     end
   end
 
   # The ticket score based on fields content.
   class Score
-    attr_reader :issue, :total, :score, :accuracy
+    attr_reader :issue, :score, :accuracy
 
-    def initialize(issue, opts, rules)
+    def initialize(issue, opts)
       @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.sum(&:score)
-      @score = @rules.select { |r| r.passed(@issue) }.sum(&:score)
-      @accuracy = (score / @total * 100).round(digits)
+      @score = @opts[:rules].select { |r| r.passed(@issue) }.sum(&:score)
+      @accuracy = (score / @opts[:total] * 100).round(digits)
+      self
     end
 
     # Post the comment with score and accuracy to the ticket.
@@ -85,13 +83,13 @@ module Lazylead
     # The jira comment in markdown format
     def comment
       comment = [
-        "Hi [~#{@issue.reporter.id}],",
+        "Hi [~#{reporter}],",
         "",
         "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|
+      @opts[:rules].each do |r|
         comment << "|#{r.desc}|#{r.passed(@issue) ? '(/)' : '(-)'}|#{r.field}|"
       end
       comment << docs_link
@@ -103,11 +101,11 @@ module Lazylead
 
     # Link to ticket formatting rules
     def docs_link
-      if @link.nil? || @link.blank?
+      if @opts["docs"].nil? || @opts["docs"].blank?
         ""
       else
         "The requirements/examples of ticket formatting rules you may find " \
-          "[here|#{@link}]."
+          "[here|#{@opts['docs']}]."
       end
     end
 
@@ -120,13 +118,11 @@ module Lazylead
     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
+      @colors ||= JSON.parse(@opts["colors"])
+                      .to_h
+                      .to_a
+                      .each { |e| e[0] = e[0].to_i }
+                      .sort_by { |e| e[0] }
     end
 
     # Calculate grade for accuracy
@@ -137,5 +133,17 @@ module Lazylead
     def grade(value)
       (value / 10).floor * 10
     end
+
+    # Detect the ticket reporter.
+    #
+    # If ticket created by some automatic/admin user account then reporter is the first non-system
+    #  user account who modified the ticket.
+    def reporter
+      sys = @opts.slice("system-users", ",")
+      return @issue.reporter.id if sys.empty? || sys.none? { |susr| susr.eql? @issue.reporter.id }
+      first = @issue.history.find { |h| sys.none? { |susr| susr.eql? h["author"]["key"] } }
+      return @issue.reporter.id if first.nil?
+      first["author"]["key"]
+    end
   end
 end

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

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),

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

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),

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

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),

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

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),

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

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),
@@ -94,13 +94,11 @@ module Lazylead
 
     # Detect the percentage grid for tickets, by default its 0%, 10%, 20%, etc.
     def grid
-      @grid ||= begin
-        if @opts.key? "grid"
-          @opts.slice("grid", ",")
-        else
-          %w[0% 10% 20% 30% 40% 50% 60% 70% 80% 90% 100%]
-        end
-      end
+      @grid ||= if @opts.key? "grid"
+                  @opts.slice("grid", ",")
+                else
+                  %w[0% 10% 20% 30% 40% 50% 60% 70% 80% 90% 100%]
+                end
     end
 
     # Remove score labels from the ticket.

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

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),

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

@@ -2,7 +2,7 @@
 
 # The MIT License
 #
-# Copyright (c) 2019-2020 Yurii Dubinka
+# Copyright (c) 2019-2021 Yurii Dubinka
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# The MIT License
+#
+# Copyright (c) 2019-2021 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 "requirement"
+
+module Lazylead
+  #
+  # Check that ticket has screenshot(s).
+  # The screenshots should
+  #  1. present as attachments
+  #  2. has extension .jpg .jpeg .exif .tiff .tff .bmp .png .svg
+  #  3. mentioned in description with !<name>.<extension>|thumbnail! (read more https://bit.ly/3rusNgW)
+  #
+  class Screenshots < Lazylead::Requirement
+    # @param minimum The number of expected screenshots
+    def initialize(minimum: 1, score: 2, ext: %w[.jpg .jpeg .exif .tiff .tff .bmp .png .svg])
+      super "Screenshots", score, "Description,Attachments"
+      @minimum = minimum
+      @ext = ext
+    end
+
+    def passed(issue)
+      return false if issue.attachments.nil? || blank?(issue, "description")
+      references = issue.description
+                        .to_enum(:scan, /!.+!/)
+                        .map { Regexp.last_match }
+                        .map(&:to_s)
+      return false if references.size < @minimum
+      references.all? { |ref| pictures(issue).any? { |file| ref.include? file } }
+    end
+
+    # Detect all pictures in ticket attachments and returns an array with file names.
+    def pictures(issue)
+      @pictures ||= issue.attachments
+                         .select { |a| @ext.include? File.extname(a.filename).downcase }
+                         .map(&:filename)
+    end
+  end
+end