lazylead 0.10.3 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2a3f17c4f0160f62b3faa0dd25179669f902d359961612701ab5b123ef2a7a2
-  data.tar.gz: d2a4ba8aa4d282362268a4b8911c1af9eaf425f83db9643f10dddefb8564eb53
+  metadata.gz: 333915b333e6a6ed286d3ee7e5b984b30ec77745195d0a522b38453c8946bddd
+  data.tar.gz: 3ad06509a4714b6317a0f013f61a74e3c3de05b58c424de6faf435fe877c7079
 SHA512:
-  metadata.gz: 8093e705ee5fe376e98755ec187b3e981dce7b55243c497debb1b1f5384df8c6cab62f60f01949affe0cf8218d0d1acc7a21c62cc935a538e18df80efe7b0d15
-  data.tar.gz: c73d5edeede58fb972d219681456832f089ed2b08b75893c657dda86ef3c4c1d9eae47fde49e8335ea0f193b94e053744da47cea44c0c804d0e4145b95abcbab
+  metadata.gz: db6709844e1f8175a32fadef567cc661d469ce2fd6fbd69050726bb9d0368e41133765b730c4efb5da353c074db2d9a875e51dfffa3e408b65279a13e7f33b33
+  data.tar.gz: 2189335ff6852e008d489d582653de84653413396283e92724e7ae2c058549dc8a7d0d11d13f431020ec62517179bcab758b05571aa5067a614f64a4f86116d2

data/.githooks/commit-msg

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+def check_message_format
+  regex = /^#\d+:\s\w+/
+  message_file = ARGV[0]
+  message = File.read(message_file)
+  unless regex.match(message)
+    puts "Your message is not formatted correctly"
+    puts "Message should have following format: '#issue_id: Commit message'"
+    exit 1
+  end
+end
+check_message_format

data/.rultor.yml

@@ -25,6 +25,7 @@ release:
     curl -s -X POST --url "https://circleci.com/api/v2/project/gh/dgroup/lazylead/envvar" -H @../circleci.header -H "accept: application/json" -H "content-type: application/json" -d "{ \"name\": \"DOCKER_RELEASE_TAGS\", \"value\": \"${tag}\" }" -o /dev/null
     curl -s -X POST --url https://circleci.com/api/v2/project/gh/dgroup/lazylead/pipeline -H @../circleci.header -H 'accept: application/json' -H 'content-type: application/json' -H 'x-attribution-login: dgroup' -o /dev/null
 merge:
+  squash: true
   script: |-
     bundle install
     bundle exec rake test rubocop sqlint xcop

data/Rakefile

@@ -28,6 +28,7 @@ require "date"
 require "rdoc"
 require "colorize"
 require "rake/clean"
+require "concurrent"
 
 # @todo #/DEV Investigate the possibility of using migrations from active_record
 #  - Rake tasks https://gist.github.com/schickling/6762581
@@ -45,11 +46,18 @@ def version
   Gem::Specification.load(Dir["*.gemspec"].first).version
 end
 
-task default: %i[clean rubocop test sqlint xcop copyright docker]
+task default: %i[init_hooks clean rubocop test sqlint xcop copyright docker]
+
+task :init_hooks do
+  next if File.file?(".git/hooks/commit-msg")
+  FileUtils.copy(".githooks/commit-msg", ".git/hooks/commit-msg")
+  FileUtils.chmod("+x", ".git/hooks/commit-msg")
+end
 
 require "rake/testtask"
 desc "Run all unit tests"
 Rake::TestTask.new(:test) do |t|
+  ENV["MT_CPU"] = Concurrent.processor_count.to_s
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]

data/lazylead.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = "2.2"
   s.required_ruby_version = ">=2.6.5"
   s.name = "lazylead"
-  s.version = "0.10.3"
+  s.version = "0.11.1"
   s.license = "MIT"
   s.summary = "Eliminate the annoying work within bug-trackers."
   s.description = "Ticketing systems (Github, Jira, etc.) are strongly
@@ -45,7 +45,7 @@ tasks instead of solving technical problems."
   s.authors = ["Yurii Dubinka"]
   s.email = "yurii.dubinka@gmail.com"
   s.homepage = "http://github.com/dgroup/lazylead"
-  s.post_install_message = "Thanks for installing Lazylead v0.10.3!
+  s.post_install_message = "Thanks for installing Lazylead v0.11.1!
   Read our blog posts: https://lazylead.org
   Stay in touch with the community in Telegram: https://t.me/lazylead
   Follow us on Twitter: https://twitter.com/lazylead
@@ -58,7 +58,7 @@ tasks instead of solving technical problems."
   s.add_runtime_dependency "activerecord", "6.1.3"
   s.add_runtime_dependency "backtrace", "0.3"
   s.add_runtime_dependency "colorize", "0.8.1"
-  s.add_runtime_dependency "faraday", "1.5.1"
+  s.add_runtime_dependency "faraday", "1.7.1"
   s.add_runtime_dependency "get_process_mem", "0.2.7"
   s.add_runtime_dependency "inifile", "3.0.0"
   s.add_runtime_dependency "jira-ruby", "2.1.5"
@@ -66,6 +66,7 @@ tasks instead of solving technical problems."
   s.add_runtime_dependency "logging", "2.3.0"
   s.add_runtime_dependency "mail", "2.7.1"
   s.add_runtime_dependency "memory_profiler", "1.0.0"
+  s.add_runtime_dependency "nokogiri", "1.11.3"
   s.add_runtime_dependency "openssl", "2.1.2"
   s.add_runtime_dependency "railties", "6.1.3"
   s.add_runtime_dependency "require_all", "3.0.0"
@@ -79,7 +80,7 @@ tasks instead of solving technical problems."
   s.add_runtime_dependency "tzinfo-data", "1.2021.1"
   s.add_runtime_dependency "vcs4sql", "0.1.1"
   s.add_runtime_dependency "viewpoint", "1.1.1"
-  s.add_development_dependency "codecov", "0.5.2"
+  s.add_development_dependency "codecov", "0.6.0"
   s.add_development_dependency "guard", "2.18.0"
   s.add_development_dependency "guard-minitest", "2.4.6"
   s.add_development_dependency "minitest", "5.14.4"
@@ -90,12 +91,12 @@ tasks instead of solving technical problems."
   s.add_development_dependency "rake", "13.0.6"
   s.add_development_dependency "random-port", "0.5.1"
   s.add_development_dependency "rdoc", "6.3.2"
-  s.add_development_dependency "rubocop", "1.18.3"
-  s.add_development_dependency "rubocop-minitest", "0.14.0"
-  s.add_development_dependency "rubocop-performance", "1.11.4"
+  s.add_development_dependency "rubocop", "1.20.0"
+  s.add_development_dependency "rubocop-minitest", "0.15.0"
+  s.add_development_dependency "rubocop-performance", "1.11.5"
   s.add_development_dependency "rubocop-rake", "0.6.0"
   s.add_development_dependency "rubocop-rspec", "2.4.0"
   s.add_development_dependency "sqlint", "0.2.0"
   s.add_development_dependency "tempfile", "0.1.1"
-  s.add_development_dependency "xcop", "0.6.2"
+  s.add_development_dependency "xcop", "0.6.3"
 end

data/lib/lazylead/cli/app.rb

@@ -70,7 +70,7 @@ module Lazylead
         ActiveRecord::Base.establish_connection(
           adapter: "sqlite3",
           database: @db,
-          pool: opts[:max_connections]
+          pool: opts[:max_connections] || ENV["MT_CPU"]
         )
         @log.debug "Database connection established"
       end

data/lib/lazylead/model.rb

@@ -170,10 +170,9 @@ module Lazylead
 
     # A task with extended logging
     # @see Lazylead::ORM::Task
-    class VerboseTask
+    class Verbose
       extend Forwardable
-      def_delegators :@orig, :id, :name, :team, :to_s, :inspect, :props, :type,
-                     :unit
+      def_delegators :@orig, :id, :name, :team, :to_s, :inspect, :props, :type, :unit
 
       def initialize(orig, log = Log.new)
         @orig = orig
@@ -203,6 +202,28 @@ module Lazylead
       # rubocop:enable Metrics/AbcSize
     end
 
+    # A task which support retry in case of failure.
+    # @see Lazylead::ORM::Task
+    class Retry
+      extend Forwardable
+      def_delegators :@orig, :id, :name, :team, :to_s, :inspect, :props, :type, :unit
+
+      def initialize(orig, log = Log.new)
+        @orig = orig
+        @log = log
+      end
+
+      def exec
+        retries ||= 0
+        @orig.exec
+        @orig
+      rescue StandardError
+        sleep(props.fetch("attempt_wait", 0).to_f) if props.key? "attempt_wait"
+        retry if (retries += 1) < props.fetch("attempt", 0).to_i
+        @orig
+      end
+    end
+
     # Ticketing systems to monitor.
     class System < ActiveRecord::Base
       include ORM

data/lib/lazylead/opts.rb

@@ -64,7 +64,8 @@ module Lazylead
     def jira_defaults
       {
         max_results: fetch("max_results", 50),
-        fields: jira_fields
+        fields: jira_fields,
+        limit: to_h["limit"]
       }
     end
 
@@ -142,5 +143,16 @@ module Lazylead
     def construct(field, delim: ",")
       slice(field, delim).map(&:constantize).map(&:new)
     end
+
+    # Get the value by key
+    # @param key
+    #         The key to fetch value. The key might be a plain text or symbol
+    # @param default
+    #         The default/alternative value if key not found
+    # @return The value by key or alternative/default value.
+    def find(key, default = nil)
+      return default if key.nil?
+      to_h[key.to_s] || to_h[key.to_sym] || default
+    end
   end
 end

data/lib/lazylead/schedule.rb

@@ -47,7 +47,14 @@ module Lazylead
       raise "ll-002: task can't be a null" if task.nil?
       @trigger.method(task.type).call(task.unit) do
         ActiveRecord::Base.connection_pool.with_connection do
-          ORM::VerboseTask.new(task, @log).exec
+          if task.props.key? "no_logs"
+            ORM::Retry.new(task, @log).exec
+          else
+            ORM::Verbose.new(
+              ORM::Retry.new(task, @log),
+              @log
+            ).exec
+          end
         end
       end
       @log.debug "Task scheduled: #{task}"

data/lib/lazylead/system/jira.rb

@@ -57,17 +57,18 @@ module Lazylead
     #   :max_results => maximum number of tickets per one iteration.
     #   :fields      => ticket fields to be fetched like assignee, summary, etc.
     def issues(jql, opts = { max_results: 50, fields: nil, expand: nil })
+      opts = Opts.new(opts)
       raw do |jira|
         start = 0
         tickets = []
         total = jira.Issue.jql(jql, max_results: 0)
         @log.debug "Found #{total} ticket(s) in '#{jql}'"
         loop do
-          tickets.concat(jira.Issue.jql(jql, opts.merge(start_at: start))
+          tickets.concat(jira.Issue.jql(jql, range(start, opts))
                              .map { |i| Lazylead::Issue.new(i, jira) })
           @log.debug "Fetched #{tickets.size}"
-          start += opts.fetch(:max_results, 50).to_i
-          break if start > total
+          start += opts.find(:max_results, 50).to_i
+          break if (start > total) || (start >= opts.find(:limit, total).to_i)
         end
         tickets
       end
@@ -82,6 +83,26 @@ module Lazylead
 
     private
 
+    # Detect tickets range in remote search result.
+    #
+    # In jira you may navigate through the search result using following parameters:
+    # https://docs.atlassian.com/jira-software/REST/7.3.1/#agile/1.0/epic-getIssuesForEpic
+    #  :start_at
+    #     The starting index of the returned issues. Base index: 0. See the 'Pagination' section at
+    #     the top of this page for more details.
+    #  :max_results
+    #     The maximum number of issues to return per page. Default: 50. See the 'Pagination' section
+    #     at the top of this page for more details. Note, the total number of issues returned is
+    #     limited by the property 'jira.search.views.default.max' in your JIRA instance. If you
+    #     exceed this limit, your results will be truncated.
+    def range(start, opts)
+      limit = opts.find(:limit, 0).to_i
+      max_results = opts.find(:max_results, 50).to_i
+      opts[:start_at] = start
+      opts[:max_results] = [limit, max_results].min if limit.positive?
+      opts
+    end
+
     def client
       return @client if defined? @client
       @opts[:auth_type] = :basic if @opts[:auth_type].nil?
@@ -326,7 +347,7 @@ module Lazylead
   #  or dashboards.
   class NoAuthJira
     extend Forwardable
-    def_delegators :@jira, :issues, :raw
+    def_delegators :@jira, :issues, :raw, :max_results, :limit
 
     def initialize(url, path = "", log = Log.new)
       @jira = Jira.new(

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

@@ -22,6 +22,7 @@
 # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
+require_relative "memes"
 require_relative "../../log"
 require_relative "../../opts"
 require_relative "../../email"
@@ -44,14 +45,21 @@ module Lazylead
       end
 
       def run(sys, postman, opts)
-        Requires.new(__dir__).load
-        opts[:rules] = opts.construct("rules")
-        opts[:total] = opts[:rules].sum(&:score)
+        init_rules(opts)
         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?
+        opts
+      end
+
+      # Initialize accuracy rules and configuration for tickets verification.
+      def init_rules(opts)
+        Requires.new(__dir__).load
+        opts[:rules] = opts.construct("rules")
+        opts[:total] = opts[:rules].sum(&:score)
+        opts[:memes] = Memes.new(opts["memes"])
       end
     end
   end
@@ -93,7 +101,7 @@ module Lazylead
         comment << "|#{r.desc}|#{r.passed(@issue) ? '(/)' : '(-)'}|#{r.field}|"
       end
       comment << docs_link
-      comment << ""
+      comment << reaction
       comment << "Posted by [lazylead v#{Lazylead::VERSION}|https://bit.ly/2NjdndS]."
       comment.join("\r\n")
     end
@@ -144,5 +152,26 @@ module Lazylead
       return @issue.reporter.id if first.nil?
       first["author"]["key"]
     end
+
+    # Add reaction meme to the ticket comment based on score.
+    # The meme details are represented as array, where each element is a separate line in future
+    #  comment in jira.
+    #
+    # @todo #339/DEV Seems jira doesn't support the rendering of external images by url, thus so far
+    #  we might have several options:
+    #  - attach meme to ticket and make rendering using [^attach.jpg!thumbnail] option
+    #  - have a link to meme (like it implemented now)
+    #  The 1st option with attachment might generate multiple events in jira and spam ticket
+    #  watchers, thus, some research & UX testing needed how to make it better.
+    def reaction
+      return [] if @opts[:memes].nil? && !@opts[:memes].enabled?
+      url = @opts[:memes].find(@accuracy)
+      return [] if url.blank?
+      [
+        "",
+        "Our reaction when we got the ticket with triage accuracy #{@accuracy}% is [here|#{url}].",
+        ""
+      ]
+    end
   end
 end

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

@@ -0,0 +1,48 @@
+# 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 specified label.
+  class HasLabel < Lazylead::Requirement
+    #
+    # @param label which should be present in ticket.
+    #
+    def initialize(label, desc: "Has label", score: 0.5)
+      super(desc, score, "Labels")
+      @label = label
+    end
+
+    def passed(issue)
+      return false if issue.labels.empty?
+      issue.labels.any? { |l| match?(l) }
+    end
+
+    # Ensure that particular label matches expected label.
+    def match?(label)
+      @label.eql? label
+    end
+  end
+end

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

@@ -30,7 +30,7 @@ module Lazylead
   #  or attachment with plain log file
   class LogsLink < Lazylead::Logs
     def initialize(link)
-      super
+      super()
       @link = link
     end
 
@@ -48,7 +48,7 @@ module Lazylead
            .flat_map(&:split)
            .reject(&:blank?)
            .any? do |word|
-        @link.is_a?(Array) ? @link.any? { |l| word.start_with? l } : word.start_with?(@link)
+        @link.is_a?(Array) ? @link.any? { |l| word.include? l } : word.include?(@link)
       end
     end
   end

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

@@ -0,0 +1,77 @@
+# 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 "json"
+require_relative "../../log"
+require_relative "../../opts"
+
+module Lazylead
+  # Meme generator based on tickets accuracy.
+  # For each range of scores there might be several available memes to be chosen randomly.
+  # If no meme found for score, empty url should be provided.
+  #
+  # @todo #339/DEV Prepare the meme list and attach them to the github, section .docs/accuracy/memes
+  #  As url they will be required for configuration of the each task.
+  class Memes
+    def initialize(memes, log: Log.new)
+      @log = log
+      @memes = memes
+    end
+
+    def enabled?
+      !@memes.nil? && !range.empty?
+    end
+
+    # Detect meme url based on accuracy score.
+    # @param score
+    #        Accuracy score in percentage
+    def find(score)
+      r = range.find { |m| score >= m[0] && score <= m[1] }
+      return "" if r.nil?
+      r.last.sample
+    end
+
+    # Parse json-based memes configuration.
+    # Expected format is
+    #   "memes": {
+    #     "0-9.9": "https://meme.com?id=awful1.gif,https://meme.com?id=awful2.gif",
+    #     "70-89.9": "https://meme.com?id=nice.gif",
+    #     "90-100": "https://meme.com?id=wow.gif"
+    #   }
+    def range
+      @range ||= if @memes.nil?
+                   []
+                 else
+                   rng = JSON.parse(@memes).to_h
+                   return [] if rng.empty?
+                   rng.map do |k, v|
+                     next unless k.include? "-"
+                     row = k.split("-").map(&:to_f)
+                     row << v.split(",")
+                     row
+                   end
+                 end
+    end
+  end
+end