lazylead 0.3.1 → 0.5.0

data/lib/lazylead/opts.rb

@@ -0,0 +1,80 @@
+# 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 "forwardable"
+require_relative "salt"
+
+module Lazylead
+  #
+  # Default options for all lazylead tasks.
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Opts
+    extend Forwardable
+    def_delegators :@origin, :[], :[]=, :to_s, :key?, :fetch, :merge, :except
+
+    def initialize(origin = {})
+      @origin = origin
+    end
+
+    # Split text value by delimiter, trim all spaces and reject blank items
+    def slice(key, delim)
+      to_h[key].split(delim).map(&:chomp).map(&:strip).reject(&:blank?)
+    end
+
+    def blank?(key)
+      to_h[key].nil? || @origin[key].blank?
+    end
+
+    def to_h
+      @origin
+    end
+
+    # Default Jira options to use during search for all Jira-based tasks.
+    def jira_defaults
+      {
+        max_results: fetch("max_results", 50),
+        fields: jira_fields
+      }
+    end
+
+    # Default fields which to fetch within the Jira issue
+    def jira_fields
+      to_h.fetch("fields", "").split(",").map(&:to_sym)
+    end
+
+    # Decrypt particular option using cryptography salt
+    # @param key option to be decrypted
+    # @param sid the name of the salt to be used for the description
+    # @see Lazylead::Salt
+    def decrypt(key, sid)
+      text = to_h[key]
+      return text if text.blank? || text.nil?
+      return Salt.new(sid).decrypt(text) if ENV.key? sid
+      text
+    end
+  end
+end

data/lib/lazylead/postman.rb

@@ -46,7 +46,7 @@ module Lazylead
   class Postman
     include Emailing
 
-    def initialize(log = Log::NOTHING)
+    def initialize(log = Log.new)
       @log = log
     end
 

data/lib/lazylead/schedule.rb

@@ -34,25 +34,20 @@ module Lazylead
   # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
   # License:: MIT
   class Schedule
-    # @todo #/DEV New scheduling types like 'at', 'once' is required.
-    #  The minimum time period for cron is 1 minute and it's not suitable for
-    #  unit testing, thus its better to introduce new types which allows to
-    #  schedule some task once or at particular time period like in next 200ms).
-    #  For cron expressions we should define separate test suite which will test
-    #  in parallel without blocking main CI process.
-    def initialize(log = Log::NOTHING, cling = true)
+    def initialize(log: Log.new, cling: true, trigger: Rufus::Scheduler.new)
       @log = log
       @cling = cling
-      @trigger = Rufus::Scheduler.new
+      @trigger = trigger
     end
 
-    # @todo #/DEV error code is required for reach 'raise' statement within the
-    #  application.
+    # @todo #/DEV error code is required for each 'raise' statement within the
+    #  application. Align the naming of existing one, the error code should be
+    #  like ll-xxx.
     def register(task)
       raise "ll-002: task can't be a null" if task.nil?
-      @trigger.cron task.cron do
+      @trigger.method(task.type).call(task.unit) do
         ActiveRecord::Base.connection_pool.with_connection do
-          task.exec @log
+          ORM::VerboseTask.new(task, @log).exec
         end
       end
       @log.debug "Task scheduled: #{task}"
@@ -60,7 +55,9 @@ module Lazylead
 
     # @todo #/DEV inspect the current execution status. This method should
     #  support several format for output, by default is `json`.
-    def ps; end
+    def ps
+      @log.debug "#{self}#ps"
+    end
 
     def join
       @trigger.join if @cling
@@ -75,16 +72,20 @@ module Lazylead
 
   # Fake application schedule for unit testing purposes
   class NoSchedule
-    def initialize(log = Log::NOTHING)
+    def initialize(log = Log.new)
       @log = log
     end
 
     def register(task)
-      @log.debug("Task registered: #{task}")
+      @log.debug "Task registered: #{task}"
     end
 
-    def ps; end
+    def ps
+      @log.debug "#{self}#ps"
+    end
 
-    def join; end
+    def join
+      @log.debug "#{self}#join"
+    end
   end
 end

data/lib/lazylead/smtp.rb

@@ -34,7 +34,7 @@ module Lazylead
   # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
   # License:: MIT
   class Smtp
-    def initialize(log = Log::NOTHING, salt = NoSalt.new, opts = {})
+    def initialize(log = Log.new, salt = NoSalt.new, opts = {})
       @log = log
       @salt = salt
       @opts = opts

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
@@ -149,6 +150,11 @@ module Lazylead
       @issue.key
     end
 
+    def description
+      return "" if @issue.description.nil?
+      @issue.description
+    end
+
     def summary
       fields["summary"]
     end
@@ -174,9 +180,24 @@ module Lazylead
     end
 
     def fields
+      return {} if @issue.nil?
+      return {} unless @issue.respond_to? :fields
+      return {} if @issue.fields.nil?
+      return {} unless @issue.fields.respond_to? :[]
       @issue.fields
     end
 
+    def [](name)
+      return "" if fields[name].nil? || fields[name].blank?
+      fields[name]
+    end
+
+    def components
+      return [] unless @issue.respond_to? :components
+      return [] if @issue.components.nil?
+      @issue.components.map(&:name)
+    end
+
     def history
       return [] unless @issue.respond_to? :changelog
       return [] if @issue.changelog == nil? || @issue.changelog.empty?
@@ -201,6 +222,29 @@ module Lazylead
     def status
       @issue.status.attrs["name"]
     end
+
+    def post(markdown)
+      @issue.comments.build.save!(body: markdown)
+    end
+
+    def remote_links
+      @issue.remotelink.all
+    end
+
+    def attachments
+      @issue.attachments
+    end
+
+    def add_label(label, *more)
+      labels = @issue.labels
+      labels << label
+      labels += more if more.size.positive?
+      save!("fields" => { "labels" => labels.uniq })
+    end
+
+    def save!(opts)
+      @issue.save(opts)
+    end
   end
 
   # The jira issue comments
@@ -247,24 +291,21 @@ module Lazylead
   # Jira instance without authentication in order to access public filters
   #  or dashboards.
   class NoAuthJira
-    def initialize(url, path = "", 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: path },
+        {
+          username: nil,
+          password: nil,
+          site: url,
+          context_path: path
+        },
         NoSalt.new,
         log
       )
     end
-
-    def issues(jql, opts = {})
-      @jira.issues(jql, opts)
-    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)
-    end
   end
 
   # A fake jira system which allows to work with sub-tasks.

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,136 @@
+# 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)
+        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?
+      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
+      return if @opts.key? "silent"
+      @issue.post comment
+      @issue.add_label "LL.accuracy", "#{(@accuracy / 10) * 10}%"
+    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,39 @@
+# 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 "requirement"
+
+module Lazylead
+  # A requirement that Jira field "Affects Version/s" provided by the reporter.
+  class AffectedBuild < 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)
+      non_blank? issue, "versions"
+    end
+  end
+end