takeltau 0.34.9

data/lib/takeltau/init/takelage/templates/bitrequireyml.tt

@@ -0,0 +1,5 @@
+---
+scopes:
+  takelage.rake:
+  - name: rake/meta
+  - name: rake/rubylint

data/lib/takeltau/init/takelage/templates/projectyml.tt

@@ -0,0 +1,3 @@
+---
+name: <%= name %>
+version: 0.1.0

data/lib/takeltau/init/templates/Rakefile.tt

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+load 'rake/meta/Rakefile'

data/lib/takeltau/init/templates/gitignore.tt

@@ -0,0 +1,16 @@
+.DS_Store
+.idea
+*.iml
+*.iso
+packer/images
+packer/packer_cache
+__pycache__/
+*.pyc
+.pytest_cache
+pytestdebug.log
+*.retry
+takelage.log
+takelage.yml
+.vagrant
+vault-password-file
+*.vdi

data/lib/takeltau/lib/config.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+# takeltau config module
+module ConfigModule
+  # takeltau config class.
+  class TakeltauConfig
+    include Singleton
+    include LoggingModule
+    include SystemModule
+
+    attr_accessor :active, :default, :home, :project
+
+    def initialize
+      @active = {}
+      @default = {}
+      @home = {}
+      @project = {}
+    end
+  end
+
+  # Initialze config
+  # rubocop:disable Metrics/AbcSize
+  def initialize_config
+    project_root_dir = _get_project_root_dir
+
+    log.debug "takelage version: #{Takeltau::VERSION}"
+    log.debug "Current working directory: #{Dir.pwd}"
+    log.debug "Project root directory: #{project_root_dir}" unless project_root_dir.empty?
+
+    TakeltauConfig.instance.default = _config_read_default project_root_dir
+    TakeltauConfig.instance.home = _config_read_home
+    TakeltauConfig.instance.project = _config_read_project project_root_dir
+    TakeltauConfig.instance.active = _config_merge_active
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  # @return [Object] global singleton config
+  def config
+    TakeltauConfig.instance
+  end
+
+  # @return [Boolean] check if config keys are configured
+  def configured?(config_keys)
+    @configured = true
+    config_keys.each do |config_key|
+      next unless _check_key_defined? config_key
+      next unless _check_key_set? config_key
+    end
+    @configured
+  end
+
+  private
+
+  # Check if config key is defined.
+  def _check_key_defined?(config_key)
+    return true if TakeltauConfig.instance.active.key? config_key
+
+    log.error "Undefined config key. Please configure \"#{config_key}\""
+    @configured = false
+    false
+  end
+
+  # Check if config key is nil or empty.
+  def _check_key_set?(config_key)
+    takel_config_key = TakeltauConfig.instance.active[config_key]
+    return true unless takel_config_key.nil? || takel_config_key.empty?
+
+    if config_key == 'project_root_dir'
+      log.error 'Please create a "Rakefile" in the project root directory'
+    else
+      log.error "Missing config key. Please configure \"#{config_key}\""
+    end
+    @configured = false
+    false
+  end
+
+  # Read default config file in lib.
+  def _config_read_default(project_root_dir)
+    default_file = File.expand_path("#{File.dirname(__FILE__)}/../default.yml")
+
+    return { project_root_dir: project_root_dir } unless File.exist? default_file
+
+    default_yaml = read_yaml_file(default_file) || {}
+
+    default_yaml['project_root_dir'] = project_root_dir
+
+    default_yaml.sort.to_h
+  end
+
+  # Read custom config file in $HOME.
+  def _config_read_home
+    home_file = "#{Dir.home}/.takelage.yml"
+
+    return {} unless File.exist? home_file
+
+    (read_yaml_file(home_file) || {}).sort.to_h
+  end
+
+  # Read custom config file in project root.
+  def _config_read_project(project_root_dir)
+    project_file = "#{project_root_dir}/takelage.yml"
+
+    return {} unless File.exist? project_file
+
+    (read_yaml_file(project_file) || {}).sort.to_h
+  end
+
+  # Merge active config.
+  def _config_merge_active
+    # make a clone or else we'll change the original hash
+    default = TakeltauConfig.instance.default.clone
+    home = TakeltauConfig.instance.home.clone
+    project = TakeltauConfig.instance.project.clone
+
+    # merge default and home and project to active
+    # project wins against home wins against default
+    project_over_home = home.merge!(project)
+    default.merge!(project_over_home).sort.to_h
+  end
+
+  # Get project root directory.
+  # @return [String] project root directory
+  def _get_project_root_dir
+    _rakefile, path = Rake.application.find_rakefile_location
+    return path unless path.nil?
+
+    log.debug 'No "Rakefile" found. Cannot determine project root directory.'
+    ''
+  end
+end

data/lib/takeltau/lib/logging.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# takeltau logging module
+module LoggingModule
+  # takeltau logger
+  class TakeltauLogger
+    include Singleton
+
+    attr_accessor :logger
+
+    def initialize
+      @logger = Logger.new($stdout)
+    end
+  end
+
+  # Initialize logger with loglevel.
+  def initialize_logging(loglevel)
+    TakeltauLogger.instance.logger.formatter = _logging_get_log_format
+    log_level_in_use = _logging_get_log_level loglevel
+    TakeltauLogger.instance.logger.level = log_level_in_use
+    TakeltauLogger.instance.logger.debug "Using loglevel #{log_level_in_use}"
+  end
+
+  # @return [Object] global singleton logger
+  def log
+    TakeltauLogger.instance.logger
+  end
+
+  private
+
+  # Get log format.
+  def _logging_get_log_format
+    proc do |severity, _datetime, _progname, msg|
+      "[#{severity}] #{msg}\n"
+    end
+  end
+
+  # Get log level.
+  def _logging_get_log_level(loglevel)
+    if %w[FATAL ERROR WARN INFO DEBUG].include? loglevel
+      loglevel
+    else
+      TakeltauLogger.instance.logger.error 'The parameter "loglevel"' \
+          ' must be one of FATAL, ERROR, WARN, INFO, DEBUG'
+      TakeltauLogger.instance.logger.info 'Using loglevel INFO'
+      Logger::INFO
+    end
+  end
+end

data/lib/takeltau/lib/project.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# takeltau project module
+module ProjectModule
+  # takeltau config class.
+  class TakeltauProject
+    include Singleton
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+
+    attr_accessor :active, :private, :main, :dir
+
+    def initialize
+      @active = {}
+      @private = {}
+      @main = {}
+      @dir = {}
+    end
+  end
+
+  # Initialze project
+  def initialize_project
+    TakeltauProject.instance.main = _project_read_main
+    TakeltauProject.instance.private = _project_read_private
+    TakeltauProject.instance.active = _project_merge_active
+    TakeltauProject.instance.dir =
+      TakeltauProject.instance.config.active['project_root_dir']
+  end
+
+  # @return [Object] global singleton project
+  def project
+    TakeltauProject.instance
+  end
+
+  private
+
+  # Read main YAML file.
+  def _project_read_main
+    dir = TakeltauProject.instance.config.active['project_root_dir']
+    main_file = "#{dir}/" \
+        "#{TakeltauProject.instance.config.active['info_project_main']}"
+
+    return {} unless File.exist? main_file
+
+    (read_yaml_erb_file(main_file) || {}).sort.to_h
+  end
+
+  # Read private YAML file.
+  def _project_read_private
+    dir = TakeltauProject.instance.config.active['project_root_dir']
+    private_file = "#{dir}/" \
+        "#{TakeltauProject.instance.config.active['info_project_private']}"
+
+    return {} unless File.exist? private_file
+
+    private_yaml = read_yaml_erb_file(private_file) || {}
+
+    private_yaml.sort.to_h
+  end
+
+  # Merge active configuration.
+  def _project_merge_active
+    # make a clone or else we'll change the original hash
+    main = TakeltauProject.instance.main.clone
+    private = TakeltauProject.instance.private.clone
+
+    # merge main and private to active
+    # private wins against main
+    main.merge!(private).sort.to_h
+  end
+end

data/lib/takeltau/lib/subcmd.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Thor with subcommands that work correctly with help
+class SubCommandBase < Thor
+  # Set the subcommand banner.
+  # rubocop:disable Style/OptionalBooleanParameter
+  def self.banner(command, _namespace = nil, _subcommand = false)
+    "#{basename} #{subcommand_prefix} #{command.usage}"
+  end
+  # rubocop:enable Style/OptionalBooleanParameter
+
+  # Set the subcommand prefix.
+  def self.subcommand_prefix
+    name.gsub(/.*::/, '')
+        .gsub(/^[A-Z]/) { |match| match[0].downcase }
+        .gsub(/[A-Z]/) { |match| " #{match[0].downcase}" }
+  end
+end

data/lib/takeltau/lib/system.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'open3'
+require 'yaml'
+
+# Interaction with the operating system
+# rubocop:disable Metrics/ModuleLength
+module SystemModule
+  # Check if a command is available else log error message
+  # @return [Boolean] is the command available?
+  def command_available_else_error?(command)
+    unless _command_available? command
+      log.error "The command \"#{command}\" is not available"
+      return false
+    end
+
+    command_available command
+  end
+
+  # Check if a command is available else log warning message
+  # @return [Boolean] is the command available?
+  def command_available_else_warn?(command)
+    unless _command_available? command
+      log.warn "The command \"#{command}\" is not available"
+      return false
+    end
+
+    command_available command
+  end
+
+  # Convert hash to yaml.
+  # @return [String] yaml of hash
+  def hash_to_yaml(hash)
+    return nil.to_yaml if hash == {}
+
+    hash.to_yaml({ line_width: -1 })
+  end
+
+  # Read yaml file.
+  # @return [Hash] content of yaml file
+  def read_yaml_file(file)
+    log.debug "Reading YAML file \"#{file}\""
+    return nil unless _file_exists? file
+    return nil unless _file_read file
+    return nil unless _parse_yaml file, @content_file
+
+    @content
+  end
+
+  # Read yaml file with erb templates.
+  # @return [Hash] content of yaml file
+  def read_yaml_erb_file(file)
+    log.debug "Reading YAML ERB file \"#{file}\""
+    return nil unless _file_exists? file
+    return nil unless _file_read file
+    return nil unless _parse_erb file, @content_file
+    return nil unless _parse_yaml file, @content_yaml
+
+    @content
+  end
+
+  # Remove directory tree.
+  def rm_fr(directory)
+    unless File.directory? directory
+      log.error "Cannot remove non-existing directory \"#{directory}\""
+      return
+    end
+    log.debug "Removing directory \"#{directory}\" recursively"
+    Pathname.new(directory).rmtree
+  end
+
+  # Run a command and return the standard output.
+  # @return [String] stdout of command
+  def run(command)
+    log.debug "Running command \"#{command}\""
+    stdout_str, stderr_str, status = Open3.capture3 command
+    log.debug "Command \"#{command}\" has stdout:\n\"\"\"\n#{stdout_str}\"\"\""
+    log.debug "Command \"#{command}\" has stderr:\n\"\"\"\n#{stderr_str}\"\"\""
+    log.debug "Command \"#{command}\" has exit status: \"#{status.exitstatus}\""
+    stdout_str
+  end
+
+  # Run a command and return the standard output
+  # the standard error and the exit status
+  # @return [[String, String, Integer]] array of
+  # stdout, stderr, exitstatus of command
+  def run_and_capture(command)
+    log.debug "Running amd capturing command \"#{command}\""
+    stdout_str, stderr_str, status = Open3.capture3 command
+    log.debug "Command \"#{command}\" has stdout:\n\"\"\"\n#{stdout_str}\"\"\""
+    log.debug "Command \"#{command}\" has stderr:\n\"\"\"\n#{stderr_str}\"\"\""
+    log.debug "Command \"#{command}\" has exit status: \"#{status.exitstatus}\""
+    [stdout_str, stderr_str, status.exitstatus]
+  end
+
+  # Use Kernel#exec to replace the ruby process with a command.
+  def run_and_exit(command)
+    log.debug "Running command \"#{command}\" and exiting afterwards"
+    exec command
+  end
+
+  # Use Kernel#fork and Kernel#exec to run a command as a background process.
+  def run_and_fork(command)
+    log.debug "Running command \"#{command}\" as a background process"
+    job = fork do
+      exec command
+    end
+    Process.detach(job)
+  end
+
+  # Run a command and return the result.
+  # @return [Boolean] success of command run
+  def try(command)
+    log.debug "Running command \"#{command}\""
+    stdout_str, stderr_str, status = Open3.capture3 command
+    log.debug "Command \"#{command}\" has stdout:\n\"\"\"\n#{stdout_str}\"\"\""
+    log.debug "Command \"#{command}\" has stderr:\n\"\"\"\n#{stderr_str}\"\"\""
+    log.debug "Command \"#{command}\" has exit status: \"#{status.exitstatus}\""
+    status
+  end
+
+  private
+
+  # Check if command is available
+  def _command_available?(command)
+    return true if instance_variable_get("@command_available_#{command}")
+
+    log.debug "Check if the command \"#{command}\" is available"
+    status = try "which #{command}"
+    return false unless status.exitstatus.zero?
+
+    true
+  end
+
+  # Command is available
+  def command_available(command)
+    log.debug "The command \"#{command}\" is available"
+    instance_variable_set("@command_available_#{command}", true)
+  end
+
+  # Check if file exists.
+  def _file_exists?(file)
+    unless File.exist? File.expand_path(file)
+      log.debug "File \"#{file}\" doesn't exist"
+      return false
+    end
+    true
+  end
+
+  # Read yaml file.
+  def _file_read(file)
+    begin
+      @content_file = File.read File.expand_path(file)
+    rescue SystemCallError
+      log.debug "Unable to read file \"#{file}\""
+      return false
+    end
+    true
+  end
+
+  # Parse erb file.
+  def _parse_erb(file, content_erb)
+    begin
+      @content_yaml = ERB.new(content_erb).result
+    rescue StandardError => e
+      log.debug e.class
+      log.debug "Invalid ERB in YAML file \"#{file}\". " \
+        "#{e.class}: \"#{e.message}\""
+      return false
+    end
+    true
+  end
+
+  # Parse yaml file.
+  def _parse_yaml(file, content_yaml)
+    begin
+      @content = YAML.safe_load content_yaml
+    rescue Psych::SyntaxError
+      log.debug "Invalid YAML file \"#{file}\""
+      log.debug "Try: yamllint #{file}"
+      return false
+    end
+    true
+  end
+
+  # Pluralize a verb in relation to a number
+  def pluralize(number, singular, plural)
+    return singular if number == 1
+
+    plural
+  end
+end
+# rubocop:enable Metrics/ModuleLength