dgroup/lazylead

View on GitHub
lib/lazylead/opts.rb

Summary

Maintainability
A
25 mins
Test Coverage
# frozen_string_literal: true

# The MIT License
#
# Copyright (c) 2019-2022 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, :except, :each, :each_pair, :sort_by

    def initialize(origin = {})
      @origin = origin
    end

    # Split text value by delimiter, trim all spaces and reject blank items
    def slice(key, delim)
      return [] unless to_h.key? key
      trim to_h[key].split(delim)
    end

    # Trim all spaces and reject blank items in array
    def trim(arr)
      return [] if arr.nil?
      arr.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,
        limit: to_h["limit"]
      }
    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

    def merge(args)
      return self unless args.is_a? Hash
      Opts.new @origin.merge(args)
    end

    # Construct html document from template and binds.
    def msg_body(template = "template")
      Email.new(
        to_h[template],
        to_h.merge(version: Lazylead::VERSION)
      ).render
    end

    def msg_to(delim = ",")
      sliced delim, :to, "to"
    end

    def msg_cc(delim = ",")
      sliced delim, :cc, "cc"
    end

    def msg_from(delim = ",")
      sliced delim, :from, "from"
    end

    def msg_attachments(delim = ",")
      sliced(delim, :attachments, "attachments").select { |f| File.file? f }
    end

    #
    # Find the option by key and split by delimiter
    #   Opts.new("key" => "a,b").sliced(",", "key")     => [a, b]
    #   Opts.new(key: "a,b").sliced(",", :key)          => [a, b]
    #   Opts.new(key: "a,b").sliced(",", "key", :key)   => [a, b]
    #   Opts.new(key: "").sliced ",", :key)             => []
    #
    def sliced(delim, *keys)
      return [] if keys.empty?
      key = keys.detect { |k| key? k }
      val = to_h[key]
      return [] if val.nil? || val.blank?
      return val if val.is_a? Array
      return [val] unless val.include? delim
      slice key, delim
    end

    # Ensure that particular key from options is a positive numer
    #   Opts.new("key" => "1").numeric? "key"   => true
    #   Opts.new("key" => "0").numeric? "key"   => false
    #   Opts.new("key" => ".").numeric? "key"   => false
    #   Opts.new("key" => "nil").numeric? "key" => false
    def numeric?(key)
      to_h[key].to_i.positive?
    end

    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