lazylead 0.2.0 → 0.3.0

data/lib/lazylead/exchange.rb

@@ -61,12 +61,25 @@ module Lazylead
         body_type: "HTML",
         to_recipients: to
       }
-      msg.update(cc_recipients: split("cc", opts)) if opts.key? "cc"
+      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}"
     end
 
+    def add_attachments(msg, opts)
+      return unless opts.key? "attachments"
+      files = split("attachments", opts).map { |f| File.open(f, "r") }
+      msg[:file_attachments] = files
+    end
+
+    def close_attachments(msg)
+      return if msg[:file_attachments].nil? || msg[:file_attachments].empty?
+      msg[:file_attachments].each(&:close)
+    end
+
     private
 
     def cli

data/lib/lazylead/home.rb

@@ -0,0 +1,38 @@
+# 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 "logging"
+
+module Lazylead
+  # Home directory for lazylead
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Home
+    def dir
+      ENV["LL_HOME"].nil? ? Dir.pwd : ENV["LL_HOME"]
+    end
+  end
+end

data/lib/lazylead/model.rb

@@ -26,6 +26,7 @@ require "active_record"
 require "require_all"
 require_rel "task"
 require_rel "system"
+require_relative "cc"
 require_relative "log"
 require_relative "postman"
 require_relative "exchange"
@@ -64,7 +65,9 @@ module Lazylead
       opts.each_with_object({}) do |e, o|
         k = e[0]
         v = e[1]
-        v = ENV[v.slice(2, v.length - 3)] if v.start_with? "${"
+        if v.respond_to? :start_with?
+          v = ENV[v.slice(2, v.length - 3)] if v.start_with? "${"
+        end
         o[k] = v
       end
     end
@@ -90,21 +93,30 @@ module Lazylead
 
       def exec(log = Log::NOTHING)
         log.debug("Task ##{id} '#{name}' is started")
-        action.constantize
-              .new(log)
-              .run(system.connect(log), postman(log), props(log))
+        sys = system.connect(log)
+        pman = postman(log)
+        opts = props(log)
+        opts = detect_cc(sys) if opts.key? "cc"
+        action.constantize.new(log).run(sys, pman, opts)
         log.debug("Task ##{id} '#{name}' is completed")
       end
 
+      def detect_cc(sys)
+        opts = props
+        opts["cc"] = CC.new.detect(opts["cc"], sys)
+        return opts.except "cc" if opts["cc"].is_a? EmptyCC
+        opts
+      end
+
       def props(log = Log::NOTHING)
         @props ||= begin
-                    if team.nil?
-                      log.warn("Team for task #{id} isn't defined.")
-                      to_hash
-                    else
-                      team.to_hash.merge(to_hash)
-                    end
-                  end
+                     if team.nil?
+                       log.warn("Team for task #{id} isn't defined.")
+                       env(to_hash)
+                     else
+                       env(team.to_hash.merge(to_hash))
+                     end
+                   end
       end
 
       def postman(log = Log::NOTHING)

data/lib/lazylead/postman.rb

@@ -54,25 +54,25 @@ module Lazylead
     # :opts   :: the mail configuration like to, from, cc, subject, template.
     def send(opts)
       html = make_body(opts)
-      cc = detect_cc(opts)
-      Mail.deliver do
-        to opts[:to] || opts["to"]
-        from opts["from"]
-        cc cc if opts.key? "cc"
-        subject opts["subject"]
-        html_part do
-          content_type "text/html; charset=UTF-8"
-          body html
-        end
+      mail = Mail.new
+      mail.to opts[:to] || opts["to"]
+      mail.from opts["from"]
+      mail.cc opts["cc"] if opts.key? "cc"
+      mail.subject opts["subject"]
+      mail.html_part do
+        content_type "text/html; charset=UTF-8"
+        body html
       end
+      add_attachments mail, opts
+      mail.deliver
       @log.debug "Email was generated from #{opts} and send by #{__FILE__}. " \
                  "Here is the body: #{html}"
     end
 
-    def detect_cc(opts)
-      cc = opts["cc"]
-      cc = split("cc", opts) if !cc.nil? && cc.include?(",")
-      cc
+    def add_attachments(mail, opts)
+      return unless opts.key? "attachments"
+      opts["attachments"].select { |a| File.file? a }
+                         .each { |a| mail.add_file a }
     end
   end
 end

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

@@ -46,7 +46,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 +136,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 +184,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
@@ -228,12 +232,24 @@ 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)
+    def initialize(url, path = "", log = Log::NOTHING)
       @jira = Jira.new(
-        { username: nil, password: nil, site: url, context_path: "" },
+        { username: nil, password: nil, site: url, context_path: path },
         NoSalt.new,
         log
       )
@@ -250,4 +266,25 @@ module Lazylead
       @jira.raw(&block)
     end
   end
+
+  # 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.
+    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/task/propagate_down.rb

@@ -0,0 +1,118 @@
+# 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 "../version"
+require_relative "../system/jira"
+
+module Lazylead
+  module Task
+    #
+    # Propagate particular JIRA fields from parent ticket to sub-tasks.
+    #
+    # The task algorithm:
+    #  - fetch parent issues from remote ticketing system by JQL
+    #  - reject issues without sub-tasks
+    #  - fetch sub-tasks details
+    #  - make a diff for pre-defined fields provided by the user
+    #  - apply diff to sub-tasks
+    #  - make a comment to sub-task with clarification.
+    class PropagateDown
+      def initialize(log = Log::NOTHING)
+        @log = log
+      end
+
+      # @todo #/DEV Define a new module Lazylead::Task with basic methods like
+      #  split, groupBy(assignee, reporter, etc), blank?
+      def run(sys, _, opts)
+        fields = opts["fields"].split(",").map(&:strip).reject(&:blank?)
+        sys.issues(opts["jql"], fields: ["subtasks"] + fields)
+           .map { |i| Parent.new(i, sys, fields) }
+           .select(&:subtasks?)
+           .each(&:fetch)
+           .each(&:propagate)
+      end
+    end
+
+    # The parent ticket as a source for propagation to children.
+    class Parent
+      def initialize(issue, sys, fields)
+        @issue = issue
+        @sys = sys
+        @fields = fields
+      end
+
+      # Ensure that parent ticket has sub-tasks.
+      def subtasks?
+        !@issue.fields["subtasks"].empty?
+      end
+
+      # Take sub-tasks with their fields from external JIRA system.
+      def fetch
+        @subtasks = @issue.fields["subtasks"]
+                          .map do |sub|
+          @sys.raw { |j| j.Issue.find(sub["id"]) }
+        end
+      end
+
+      # Fill pre-defined fields for sub-tasks from parent ticket
+      #  and post comment to ticket with clarification.
+      def propagate
+        expected = Hash[@fields.collect { |f| [f, @issue.fields[f]] }]
+        @subtasks.each do |subtask|
+          actual = Hash[@fields.collect { |f| [f, subtask.fields[f]] }]
+          diff = diff(expected, actual)
+          next if diff.empty?
+          subtask.save(fields: diff)
+          subtask.comments.build.save!(body: comment(diff))
+        end
+      end
+
+      # Detect difference between fields in parent ticket and sub-task.
+      # The sub-tasks expected be updated by this diff.
+      def diff(expected, actual)
+        diff = {}
+        actual.each_with_object(diff) do |a, d|
+          k = a.first
+          v = a.last
+          d[k] = expected[k] if v.nil? || v.blank?
+          next if v.nil?
+          d[k] = v + "," + expected[k] unless v.to_s.include? expected[k]
+        end
+      end
+
+      # Build a jira comment in markdown(*.md) format with diff table.
+      def comment(diff)
+        markdown = [
+          "The following fields were propagated from #{@issue.key}:",
+          "||Field||Value||"
+        ]
+        diff.each { |k, v| markdown << "|#{k}|#{v}|" }
+        markdown << "Posted by [lazylead v#{Lazylead::VERSION}|" \
+                    "https://bit.ly/2NjdndS]"
+        markdown.join("\r\n")
+      end
+    end
+  end
+end

data/lib/lazylead/task/savepoint.rb

@@ -0,0 +1,58 @@
+# 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 "../home"
+require_relative "../email"
+require_relative "../version"
+require_relative "../postman"
+
+module Lazylead
+  module Task
+    #
+    # Send current configuration to admin user.
+    #
+    class Savepoint
+      def initialize(log = Log::NOTHING)
+        @log = log
+      end
+
+      def run(_, postman, opts)
+        opts["max_size"] = "25" unless opts.key? "max_size"
+        path = File.join(
+          Lazylead::Home.new.dir,
+          ARGV[ARGV.find_index("--sqlite") + 1]
+        )
+        return unless File.file?(path) && less_mb(path, opts["max_size"])
+        postman.send opts.merge("attachments" => [path])
+      end
+
+      private
+
+      def less_mb(path, megabytes)
+        (File.size(path).to_f / 2**20).round(2) < megabytes.to_i
+      end
+    end
+  end
+end

data/lib/lazylead/version.rb

@@ -23,5 +23,5 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 module Lazylead
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/messages/due_date_expired.erb

@@ -1,4 +1,5 @@
-<html>
+<!DOCTYPE html>
+<html lang="en">
 <head>
   <style>
     /* CSS styles taken from https://github.com/yegor256/tacit */
@@ -68,13 +69,13 @@
   them accordingly or actualize the
   <span style="font-weight:bold">"Due date"</span> field for the following
   ticket(s):</p>
-<table>
+<table summary="table with ticket(s) which have expired due dates">
   <tr>
-    <th>Key</th>
-    <th>Due date</th>
-    <th>Priority</th>
-    <th>Reporter</th>
-    <th>Summary</th>
+    <th id="key">Key</th>
+    <th id="duedate">Due date</th>
+    <th id="priority">Priority</th>
+    <th id="reporter">Reporter</th>
+    <th id="summary">Summary</th>
   </tr>
   <% tickets.each do |ticket| %>
     <tr>