lazylead 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8f6929a5583f40fca08c1d1293b77cf2f19ea22b1844eb9888a860b79c86b7c
-  data.tar.gz: 07b70000fe7e00aeb7c33b321d1f35c99dccb8220f477650b90a693ea8688c0c
+  metadata.gz: b58ee14de8c573012698a15d145941155e6c282249bc2938bf4938c4e677d7cd
+  data.tar.gz: 34bed5a73b2186b9e229a121973ad11891037d604faa0134fe31d5a9380ead6a
 SHA512:
-  metadata.gz: 1699bbdc2484d6a77715b11bb0f666e70e18e3bc5927d79ee02cee3bfcc4e6bf6d848a74a5c287990e56d059f669f07dc9e450f7af6992b63881288f481e062e
-  data.tar.gz: 0c471418e7ed2a92d740d0e362c0bcd9ce37eca1538272eab8abe0eff4fb3b01df1559b5f16d7af9ed3dfa52d06ebb5ff1c6a10cb897df7aeab3e119f8fe63c3
+  metadata.gz: f1a8e4032492f97b2672078c908f37599f3d32a01bf31d7a67911732b90f682410123fb1234e07315b9ccd6d4e675e4b9d4867e06f265c06ace44f33c7d1cb1f
+  data.tar.gz: 22f2d3fb9b3ed8a8bb9e2e8f6f29393f65e2ab6bea033c9f0f82741775032098383614f280433f64fcd16dbd6ab6c4c46115b197307c684a9c03ffc736b95714

data/.docs/accuracy.md

@@ -66,14 +66,14 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
                values (1,'{"type":"Lazylead::Jira", "username":"${jira_user}", "password":"${jira_password}", "site":"${jira_url}", "context_path":""}');
     insert into tasks (name, cron, enabled, id, system, team_id, action, properties)
                values ('Post ticket score and accuracy to the tickets', 
-                       '0 8 * * 1-5', 
+                       'cron:0 8 * * 1-5', 
                        'true',
                        1, 1, 1, 
                        'Lazylead::Task::Accuracy',
                        '{
                             "jql":    "filter=222", 
                             "to":     "lead@fake.com",
-                            "rules":  "Lazylead::RequirementAffectedBuild",
+                            "rules":  "Lazylead::AffectedBuild",
                             "colors": "{ "0": "#FF4F33", "35": "#FF9F33", "57": "#19DD1E", "90": "#0FA81A" }",
                             "docs":         "https://github.com/dgroup/lazylead/blob/master/.github/ISSUE_TEMPLATE/bug_report.md",
                             "max_results":  "200",
@@ -82,7 +82,7 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
                         }
                        ');
     ```
-    Yes, for task scheduling we are using [cron](https://crontab.guru).
+    Yes, for task scheduling we are using [cron](https://crontab.guru) here, but you may use other scheduling types from [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler).
 
 4.  Once you changed `./ll.db`, please restart the container using `docker-compose -f .github/tasks.yml restart`
     ```bash
@@ -104,4 +104,4 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
 
 #### How can I add my own rules?
 The custom rules should extend `Lazylead::Requirement` class and placed it to the `lib/lazylead/task/accuracy` folder.
-After that, you need to mention your custom rules in `rules` option in the column `properties` from `tasks` table
+After that, you need to mention your custom rules in `rules` option in the column `properties` from `tasks` table

data/.docs/duedate_expired.md

@@ -68,16 +68,16 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
                values (1, 'Dream team with lazylead', '{}');
     insert into systems(id, properties)    
                values (1,'{"type":"Lazylead::Jira", "username":"${jira_user}", "password":"${jira_password}", "site":"${jira_url}", "context_path":""}');
-    insert into tasks (name, cron, enabled, id, system, team_id, action, properties)
+    insert into tasks (name, schedule, enabled, id, system, team_id, action, properties)
                values ('Expired due dates', 
-                       '0 8 * * 1-5', 
+                       'cron:0 8 * * 1-5', 
                        'true',
                        1, 1, 1, 
                        'Lazylead::Task::AssigneeAlert',
                        '{"sql":"filter=222", "cc":"<youremail.com>", "subject":"[LL] Expired due dates", "template":"lib/messages/due_date_expired.erb", "postman":"Lazylead::Exchange"}');
     
     ```
-    Yes, for task scheduling we are using [cron](https://crontab.guru).
+    Yes, for task scheduling we are using [cron](https://crontab.guru) here, but you may use other scheduling types from [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler).
 
 4.  Once you changed `./ll.db`, please restart the container using `docker-compose -f .github/tasks.yml restart`
     ```bash

data/.docs/propagate_down.md

@@ -58,16 +58,16 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
                values (1, 'Dream team with lazylead', '{}');
     insert into systems(id, properties)    
                values (1,'{"type":"Lazylead::Jira", "username":"${jira_user}", "password":"${jira_password}", "site":"${jira_url}", "context_path":""}');
-    insert into tasks (name, cron, enabled, id, system, team_id, action, properties)
+    insert into tasks (name, schedule, enabled, id, system, team_id, action, properties)
                values ('Propagate customfield_1 (External ID) to sub-tasks', 
-                       '0 8 * * 1-5', 
+                       'cron:0 8 * * 1-5', 
                        'true',
                        1, 1, 1, 
                        'Lazylead::Task::PropagateDown',
                        '{"jql":"filter=222", "propagate":"customfield_1"}');
     
     ```
-    Yes, for task scheduling we are using [cron](https://crontab.guru).
+    Yes, for task scheduling we are using [cron](https://crontab.guru) here, but you may use other scheduling types from [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler).
 
 4.  Once you changed `./ll.db`, please restart the container using `docker-compose -f .github/tasks.yml restart`
     ```bash

data/.gitattributes

@@ -7,3 +7,4 @@
 *.xml ident
 *.png binary
 *.pdf binary
+*.db binary

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/Rakefile

@@ -127,4 +127,6 @@ task :docker do
   system "docker-compose -f .docker/docker-compose.yml build "\
           " --build-arg release_tags='latest 1.0'"\
           " --build-arg version=1.0"
+  system "docker-compose -f .docker/docker-compose.yml rm --force -s lazylead"
+  system "docker-compose -f .docker/docker-compose.yml up"
 end

data/bin/lazylead

@@ -82,7 +82,7 @@ log.debug("Memory footprint at start is #{Lazylead::Allocated.new}")
 cmd = lambda do
   Lazylead::CLI::App.new(
     log,
-    Lazylead::Schedule.new(log),
+    Lazylead::Schedule.new(log: log),
     Lazylead::Smtp.new(
       log, Lazylead::Salt.new("smtp_salt"),
       smtp_host: ENV["smtp_host"],

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.4.0"
+  s.version = "0.5.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.4.0!
+  s.post_install_message = "Thanks for installing Lazylead v0.5.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
@@ -82,6 +82,7 @@ tasks instead of solving technical problems."
   s.add_development_dependency "minitest-fail-fast", "0.1.0"
   s.add_development_dependency "minitest-hooks", "1.5.0"
   s.add_development_dependency "minitest-reporters", "1.3.6"
+  s.add_development_dependency "net-ping", "2.0.8"
   s.add_development_dependency "rake", "12.3.3"
   s.add_development_dependency "random-port", "0.3.1"
   s.add_development_dependency "rdoc", "6.1.1"

data/lib/lazylead/exchange.rb

@@ -54,19 +54,25 @@ module Lazylead
     def send(opts)
       to = opts["to"] || opts[:to]
       to = [to] unless to.is_a? Array
-      html = make_body(opts)
-      msg = {
-        subject: opts["subject"],
-        body: html,
-        body_type: "HTML",
-        to_recipients: to
-      }
+      if to.reject { |e| e.nil? || e.blank? }.empty?
+        @log.warn "Email can't be sent to '#{to}, more: '#{opts}'"
+        return
+      end
+      msg = make_msg(to, opts)
       msg.update(cc_recipients: opts["cc"]) if opts.key? "cc"
       add_attachments(msg, opts)
       cli.send_message msg
       close_attachments msg
-      @log.debug "Email was generated from #{opts} and send by #{__FILE__}. " \
-                 "Here is the body: #{html}"
+      @log.debug "#{__FILE__} sent email based on #{opts}."
+    end
+
+    def make_msg(to, opts)
+      {
+        subject: opts["subject"],
+        body: make_body(opts),
+        body_type: "HTML",
+        to_recipients: to
+      }
     end
 
     def add_attachments(msg, opts)

data/lib/lazylead/model.rb

@@ -94,11 +94,31 @@ module Lazylead
       belongs_to :team, foreign_key: "team_id"
       belongs_to :system, foreign_key: "system"
 
+      # Execute task
       def exec
         sys = system.connect
         opts = props
         opts = detect_cc(sys) if opts.key? "cc"
-        action.constantize.new(log).run(sys, postman, opts)
+        action.constantize.new.run(sys, postman, opts)
+      end
+
+      # Scheduling type.
+      # Current implementation is based on 'rufus-scheduler' gem and supports
+      #  the following types: 'cron', 'interval', 'in', 'at', 'every'
+      def type
+        trigger.first
+      end
+
+      # Scheduling unit.
+      # Current implementation is based on 'rufus-scheduler' gem thus each
+      # scheduling type has own arguments:
+      #  1. Scheduling type 'cron' has 'unit' = '00 09 * * *'
+      #  2. Scheduling type 'interval' has 'unit' = '2h'
+      #  3. Scheduling type 'every' has 'unit' = '3h'
+      #  4. Scheduling type 'in' has 'unit' = '10d'
+      #  5. Scheduling type 'at' has 'unit' = '2014/12/24 2000'
+      def unit
+        trigger.last
       end
 
       def detect_cc(sys)
@@ -125,13 +145,27 @@ module Lazylead
           Postman.new
         end
       end
+
+      private
+
+      # Parse scheduling #type and #unit
+      def trigger
+        @trigger ||= begin
+                       trg = schedule.split(":")
+                       unless trg.size == 2
+                         raise "ll-007: illegal schedule format '#{schedule}'"
+                       end
+                       trg.map(&:strip).map(&:chomp)
+                     end
+      end
     end
 
     # A task with extended logging
     # @see Lazylead::ORM::Task
     class VerboseTask
       extend Forwardable
-      def_delegators :@orig, :id, :name, :team, :to_s, :inspect, :props
+      def_delegators :@orig, :id, :name, :team, :to_s, :inspect, :props, :type,
+                     :unit
 
       def initialize(orig, log = Log.new)
         @orig = orig
@@ -143,7 +177,7 @@ module Lazylead
         @log.debug "'#{name}' is started."
         @log.warn "No postman, stub is used." unless props.key? "postman"
         @log.warn "No team." if team.nil?
-        @orig.exec @log
+        @orig.exec
         @log.debug "'#{name}' is completed"
       rescue StandardError => e
         msg = <<~MSG

data/lib/lazylead/opts.rb

@@ -23,6 +23,7 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require "forwardable"
+require_relative "salt"
 
 module Lazylead
   #
@@ -33,7 +34,7 @@ module Lazylead
   # License:: MIT
   class Opts
     extend Forwardable
-    def_delegators :@origin, :[], :[]=, :to_s, :key?, :fetch, :merge
+    def_delegators :@origin, :[], :[]=, :to_s, :key?, :fetch, :merge, :except
 
     def initialize(origin = {})
       @origin = origin
@@ -64,5 +65,16 @@ module Lazylead
     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

@@ -65,8 +65,7 @@ module Lazylead
       end
       add_attachments mail, opts
       mail.deliver
-      @log.debug "Email was generated from #{opts} and send by #{__FILE__}. " \
-                 "Here is the body: #{html}"
+      @log.debug "#{__FILE__} sent email based on #{opts}."
     end
 
     def add_attachments(mail, opts)

data/lib/lazylead/schedule.rb

@@ -34,23 +34,18 @@ 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.new, 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
           ORM::VerboseTask.new(task, @log).exec
         end
@@ -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
@@ -80,11 +77,15 @@ module Lazylead
     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/system/jira.rb

@@ -150,6 +150,11 @@ module Lazylead
       @issue.key
     end
 
+    def description
+      return "" if @issue.description.nil?
+      @issue.description
+    end
+
     def summary
       fields["summary"]
     end
@@ -175,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?
@@ -206,6 +226,29 @@ module Lazylead
     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)
+      lbl = labels
+      lbl << label
+      lbl += more if more.size.positive?
+      save!("fields" => { "labels" => lbl.uniq })
+    end
+
+    def labels
+      fields["labels"]
+    end
+
+    def save!(opts)
+      @issue.save(opts)
+    end
   end
 
   # The jira issue comments

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

@@ -43,7 +43,7 @@ module Lazylead
       end
 
       def run(sys, postman, opts)
-        require_rules
+        Dir[File.join(__dir__, "*.rb")].sort.each { |f| require f }
         rules = opts.slice("rules", ",")
                     .map(&:constantize)
                     .map(&:new)
@@ -53,12 +53,6 @@ module Lazylead
                     .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
 
@@ -85,7 +79,9 @@ module Lazylead
 
     # Post the comment with score and accuracy to the ticket.
     def post
-      @issue.post(comment) unless @opts.key? "silent"
+      return if @opts.key? "silent"
+      @issue.post comment
+      @issue.add_label "LL.accuracy", grade(@accuracy)
     end
 
     # The jira comment in markdown format
@@ -136,5 +132,14 @@ module Lazylead
                         .sort_by { |e| e[0] }
                   end
     end
+
+    # Calculate grade for accuracy
+    # For example,
+    #  grade(7.5)   => 0
+    #  grade(12)    => 10
+    #  grade(25.5)  => 20
+    def grade(value)
+      (value / 10).floor * 10
+    end
   end
 end