lazylead 0.1.0 → 0.3.1

data/CNAME

@@ -0,0 +1 @@
+lazylead.org

data/Rakefile

@@ -26,6 +26,7 @@ require "rubygems"
 require "rake"
 require "date"
 require "rdoc"
+require "rainbow"
 require "rake/clean"
 
 # @todo #/DEV Investigate the possibility of using migrations from active_record
@@ -44,7 +45,7 @@ def version
   Gem::Specification.load(Dir["*.gemspec"].first).version
 end
 
-task default: %i[clean test rubocop xcop copyright]
+task default: %i[clean test rubocop sqlint xcop copyright docker]
 
 require "rake/testtask"
 desc "Run all unit tests"
@@ -88,6 +89,42 @@ Xcop::RakeTask.new :xcop do |task|
   task.excludes = %w[target/**/* coverage/**/* wp/**/*]
 end
 
+# @todo #/DEV Enable rule "Checks SQL against the ANSI syntax" fully.
+#  Right now all violations related to PRAGMA https://www.sqlite.org/pragma.html
+#  are suppressed as PRAGMA is sqlite specific option.
+#  Potential fix is to move this option into vcs4sql lib and remove from our
+#  sql files.
+task :sqlint do
+  puts "Running sqlint..."
+  require "sqlint"
+  src = Dir.glob("upgrades/**/*.sql")
+  puts "Inspecting #{src.size} files"
+  total = 0
+  src.each do |f|
+    violations = SQLint::Linter.new(f, File.open(f, "r"))
+                               .run
+                               .first(1000)
+                               .reject { |v| v.message.include? '"PRAGMA"' }
+    violations.each do |v|
+      msg_lines = v.message.split("\n")
+      p [v.filename, v.line, v.column, "#{v.type} #{msg_lines.shift}"].join ":"
+    end
+    total += violations.count { |lint| lint.type == :error }
+  end
+  if total.positive?
+    abort "#{Rainbow(total).red} SQL violations found."
+  else
+    puts "#{src.size} files inspected, #{Rainbow('no offenses').green} detected"
+  end
+end
+
 task :clean do
   Dir.glob("test/resources/**/*.db").each { |f| File.delete(f) }
 end
+
+task :docker do
+  puts "Building docker image..."
+  system "docker-compose -f .docker/docker-compose.yml build "\
+          " --build-arg release_tags='latest 1.0'"\
+          " --build-arg version=1.0"
+end

data/bin/lazylead

@@ -34,6 +34,7 @@ require "logging"
 require "backtrace"
 require "memory_profiler"
 require_relative "../lib/lazylead/log"
+require_relative "../lib/lazylead/home"
 require_relative "../lib/lazylead/schedule"
 require_relative "../lib/lazylead/allocated"
 require_relative "../lib/lazylead/cli/app"
@@ -51,14 +52,17 @@ Available options:"
   o.bool "--memory-dump", "Dump memory snapshot afterwards, to the console",
          default: false
   o.string "--home",
-           "Home directory (default: #{Dir.pwd})",
-           default: ENV["LL_HOME"].nil? ? Dir.pwd : ENV["LL_HOME"]
+           "Home directory (default #{Lazylead::Home.new.dir})",
+           default: Lazylead::Home.new.dir
   o.string "--sqlite",
            "SQLite database file name",
            default: "lazylead.db"
   o.string "--vcs4sql",
            "Home directory with database version control(vcs) scripts",
            default: "upgrades/sqlite"
+  o.integer "--max-connections",
+            "SQL connections pool size",
+            default: 5
   o.bool "--testdata",
          "Apply the database VCS migration with test data",
          default: false
@@ -70,6 +74,7 @@ Available options:"
     exit
   end
 end
+log.debug("Version: #{Lazylead::VERSION}")
 log.debug("Memory footprint at start is #{Lazylead::Allocated.new}")
 cmd = lambda do
   Lazylead::CLI::App.new(

data/lazylead.gemspec

@@ -26,14 +26,13 @@ require "English"
 
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "lazylead/version"
 
 Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
   s.rubygems_version = "2.2"
   s.required_ruby_version = ">=2.6.5"
   s.name = "lazylead"
-  s.version = Lazylead::VERSION
+  s.version = "0.3.1"
   s.license = "MIT"
   s.summary = "Eliminate the annoying work within bug-trackers."
   s.description = "Ticketing systems (Github, Jira, etc.) are strongly
@@ -46,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.0.0!
+  s.post_install_message = "Thanks for installing Lazylead v0.3.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
@@ -55,15 +54,11 @@ tasks instead of solving technical problems."
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files = s.files.grep(%r{^(test|features)/})
   s.rdoc_options = ["--charset=UTF-8"]
-  s.extra_rdoc_files = ["readme.md", "license.txt"]
+  s.extra_rdoc_files = %w[readme.md license.txt]
   s.add_runtime_dependency "activerecord", "6.0.3"
   s.add_runtime_dependency "backtrace", "0.3"
-  s.add_runtime_dependency "concurrent-ruby", "1.1.5"
-  s.add_runtime_dependency "diffy", "3.3.0"
   s.add_runtime_dependency "faraday", "1.0.1"
-  s.add_runtime_dependency "futex", "0.8.5"
   s.add_runtime_dependency "get_process_mem", "0.2.5"
-  s.add_runtime_dependency "haml", "5.0.4"
   s.add_runtime_dependency "jira-ruby", "1.7.1"
   s.add_runtime_dependency "json", "2.2.0"
   s.add_runtime_dependency "logging", "2.2.2"
@@ -73,21 +68,13 @@ tasks instead of solving technical problems."
   s.add_runtime_dependency "rainbow", "3.0.0"
   s.add_runtime_dependency "require_all", "3.0.0"
   s.add_runtime_dependency "rufus-scheduler", "3.6.0"
-  s.add_runtime_dependency "semantic", "1.6.1"
-  s.add_runtime_dependency "sinatra", "2.0.5"
   s.add_runtime_dependency "slop", "4.4"
   s.add_runtime_dependency "sqlite3", "1.4.2"
-  s.add_runtime_dependency "sys-proctable", "1.2.1"
-  s.add_runtime_dependency "threads", "0.3"
   s.add_runtime_dependency "tilt", "2.0.10"
-  s.add_runtime_dependency "total", "0.3"
-  s.add_runtime_dependency "typhoeus", "1.3.1"
   s.add_runtime_dependency "tzinfo", "1.1"
   s.add_runtime_dependency "tzinfo-data", "1.2019.3"
-  s.add_runtime_dependency "usagewatch_ext", "0.2.1"
   s.add_runtime_dependency "vcs4sql", "0.1.0"
   s.add_runtime_dependency "viewpoint", "1.1.0"
-  s.add_runtime_dependency "zache", "0.12"
   s.add_development_dependency "codecov", "0.1.14"
   s.add_development_dependency "guard", "2.15.0"
   s.add_development_dependency "guard-minitest", "2.4.6"
@@ -95,12 +82,13 @@ 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 "rake", "12.3.2"
+  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"
   s.add_development_dependency "rubocop", "0.82"
   s.add_development_dependency "rubocop-minitest", "0.5.1"
   s.add_development_dependency "rubocop-performance", "1.5.2"
   s.add_development_dependency "rubocop-rspec", "1.33.0"
+  s.add_development_dependency "sqlint", "0.1.10"
   s.add_development_dependency "xcop", "0.6"
 end

data/lib/lazylead/cc.rb

@@ -0,0 +1,180 @@
+# 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"
+
+module Lazylead
+  # Entry point for email CC detection.
+  # The email may need CC email addresses, thus, there are various strategies
+  #  how it can be done.
+  class CC
+    # Build an CC in order to detect email addresses by different conditions.
+    #
+    # Supported conditions(types):
+    #  - PlainCC
+    #  - PredefinedCC
+    #  - ComponentCC
+    #  - Empty
+    #
+    def detect(emails, sys)
+      return emails if recognized?(emails)
+      return PlainCC.new(emails) if plain?(emails)
+      return EmptyCC.new if undefined?(emails)
+      type = emails["type"].constantize
+      return ComponentCC.new(emails["project"], sys) if type.is_a? ComponentCC
+      type.new(emails["opts"])
+    end
+
+    # Detect that raw CC is a string which may has plain email addresses
+    def plain?(text)
+      (text.is_a? String) && text.to_s.include?("@")
+    end
+
+    def recognized?(emails)
+      [EmptyCC, PlainCC, ComponentCC, PredefinedCC].member? emails.class
+    end
+
+    def undefined?(emails)
+      return true unless emails.key? "type"
+      emails["type"].nil? || emails["type"].blank?
+    end
+  end
+
+  # Array of CC addresses from text for email notification.
+  #
+  #   PlainCC.new("a@f.com, , -,b@f.com").cc    # ==> ["a@f.com", "b@f.com"]
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class PlainCC
+    include Enumerable
+    extend Forwardable
+    def_delegators :@cc, :each
+
+    # The regexp expression for email notification is very simple, here is the
+    # reason why https://bit.ly/38iLKeo
+    def initialize(text, regxp = /[^\s]@[^\s]/)
+      @text = text
+      @regxp = regxp
+    end
+
+    def cc
+      @cc ||= begin
+                if @text.include? ","
+                  @text.split(",").map(&:strip).select { |e| e[@regxp] }
+                elsif @text[@regxp]
+                  [@text.strip]
+                end
+              end
+    end
+
+    def each(&block)
+      cc.each(&block)
+    end
+  end
+
+  # Empty CC email addresses.
+  class EmptyCC
+    def cc
+      []
+    end
+  end
+
+  # Predefined CC addresses for email notification.
+  # You may define a hash where
+  #  - key is Jira ticket component
+  #  - value is CC email address(es)
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class PredefinedCC
+    def initialize(orig)
+      @orig = orig
+    end
+
+    def [](key)
+      to_h[key]
+    end
+
+    def cc(*names)
+      return to_h.values.flatten.uniq.compact if names.count.zero?
+      return self[names.first] if names.count == 1
+      to_h.values_at(names.first, *names.drop(1)).flatten.uniq.compact
+    end
+
+    def to_h
+      @to_h ||= begin
+                  if @orig.is_a? Hash
+                    @orig.each_with_object({}) do |i, o|
+                      o[i.first] = Lazylead::PlainCC.new(i.last).cc
+                    end
+                  else
+                    {}
+                  end
+                end
+    end
+  end
+
+  # CC addresses based on Jira component owners for email notification.
+  # Allows to detect the CC for particular ticket based on its component.
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class ComponentCC < Lazylead::PredefinedCC
+    def initialize(prj, jira)
+      @prj = prj
+      @jira = jira
+    end
+
+    def to_h
+      @to_h ||= begin
+                  components.each_with_object({}) do |c, h|
+                    email = lead(c.attrs["id"])
+                    next if email.nil? || email.blank?
+                    h[c.attrs["name"]] = email
+                  end
+                end
+    end
+
+    private
+
+    def lead(component_id)
+      @jira.raw do |j|
+        lead = j.Component
+                .find(component_id, expand: "", fields: "")
+                .attrs["lead"]
+        next if lead.nil? || lead.empty?
+        j.User.find(lead["key"]).attrs["emailAddress"]
+      end
+    end
+
+    def components
+      @jira.raw do |j|
+        j.Project.find(@prj, expand: "components", fields: "").components
+      end
+    end
+  end
+end

data/lib/lazylead/cli/app.rb

@@ -48,7 +48,7 @@ module Lazylead
 
       def run(opts)
         apply_vcs_migration opts
-        enable_active_record
+        enable_active_record opts
         @smtp.enable
         schedule_tasks
       end
@@ -63,10 +63,11 @@ module Lazylead
         @log.debug "Migration applied to #{@db} from #{vcs}"
       end
 
-      def enable_active_record
+      def enable_active_record(opts)
         ActiveRecord::Base.establish_connection(
           adapter: "sqlite3",
-          database: @db
+          database: @db,
+          pool: opts[:max_connections]
         )
         @log.debug "Database connection established"
       end

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
@@ -88,17 +91,36 @@ module Lazylead
       belongs_to :team, foreign_key: "team_id"
       belongs_to :system, foreign_key: "system"
 
+      # @todo #/DEV Add error handling for StandartError with support of
+      #  verbose key from ARGV like in /bin/lazylead. That will make error
+      #  messages more human readable. Maybe there is some integration between
+      #  Slop and ARGV in order to avoid logic duplication.
       def exec(log = Log::NOTHING)
         log.debug("Task ##{id} '#{name}' is started")
-        action.constantize
-              .new(log)
-              .run(system.connect(log), postman(log), props)
+        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 props
-        return @prop if defined? @prop
-        @prop = team.to_hash.merge(to_hash)
+      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.")
+                       env(to_hash)
+                     else
+                       env(team.to_hash.merge(to_hash))
+                     end
+                   end
       end
 
       def postman(log = Log::NOTHING)