takelage 0.18.1

data/lib/takelage/git/check/clean.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# takelage git check clean
+module GitCheckClean
+  # Backend method for git check clean.
+  # @return [Boolean] is git workspace clean?
+  def git_check_clean
+    log.debug 'Checking if git workspace is clean'
+
+    return false unless git_check_workspace
+
+    status_unstaged = _git_check_clean_get_status_unstaged
+    status_uncommitted = _git_check_clean_get_status_uncommitted
+    stdout_str_status = _git_check_clean_get_str_status
+
+    # only return true if neither unstaged nor uncommitted nor empty files
+    sum = status_unstaged.exitstatus +
+          status_uncommitted.exitstatus +
+          stdout_str_status.length
+
+    sum.zero?
+  end
+
+  private
+
+  # Get git status of unstaged changes.
+  def _git_check_clean_get_status_unstaged
+    cmd_git_unstaged =
+      config.active['cmd_git_check_clean_git_unstaged']
+    try cmd_git_unstaged
+  end
+
+  # Get git status of uncommitted changes.
+  def _git_check_clean_get_status_uncommitted
+    cmd_git_uncommitted =
+      config.active['cmd_git_check_clean_git_uncommitted']
+    try cmd_git_uncommitted
+  end
+
+  # Get git status result.
+  def _git_check_clean_get_str_status
+    cmd_git_status =
+      config.active['cmd_git_check_clean_git_status']
+    run cmd_git_status
+  end
+end

data/lib/takelage/git/check/cli.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage git check
+  class GitCheck < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include GitCheckClean
+    include GitCheckMaster
+    include GitCheckWorkspace
+
+    #
+    # git check clean
+    #
+    desc 'clean', 'Check if the git workspace is clean'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if the git workspace is clean
+    LONGDESC
+    # Check if the git workspace is clean.
+    def clean
+      exit git_check_clean
+    end
+
+    #
+    # git check master
+    #
+    desc 'master', 'Check if we are on the git master branch'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if we are on the git master branch
+    LONGDESC
+    # Check if we are on the git master branch.
+    def master
+      exit git_check_master
+    end
+
+    #
+    # git check workspace
+    #
+    desc 'workspace', 'Check if a git workspace exists'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if a git workspace exists
+    LONGDESC
+    # Check if a git workspace exists.
+    def workspace
+      exit git_check_workspace
+    end
+  end
+end

data/lib/takelage/git/check/master.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# takelage git check master
+module GitCheckMaster
+  # Backend method for git check master.
+  # @return [Boolean] are we on the git master branch?
+  def git_check_master
+    log.debug 'Check if we are on the git master branch'
+
+    return false unless git_check_workspace
+
+    branch = _git_check_master_get_branch
+    log.debug "We are on git branch \"#{branch}\""
+
+    branch == 'master'
+  end
+
+  private
+
+  # Get git branch.
+  def _git_check_master_get_branch
+    cmd_get_branch =
+      config.active['cmd_git_check_master_git_branch']
+    (run cmd_get_branch).strip.split('/')[-1]
+  end
+end

data/lib/takelage/git/check/workspace.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# takelage git check workspace
+module GitCheckWorkspace
+  # Backend method for git check workspace.
+  # @return [Boolean] is this a git workspace?
+  def git_check_workspace
+    log.debug 'Check if this is a git workspace'
+    status_repo = _git_check_workspace_get_status_repo
+    dir = _git_check_workspace_get_dir
+    unless status_repo.exitstatus.zero?
+      log.debug "No git workspace found in \"#{dir}\""
+      return false
+    end
+    true
+  end
+
+  private
+
+  # Get git repository status.
+  def _git_check_workspace_get_status_repo
+    cmd_git_repo =
+      config.active['cmd_git_check_workspace_git_repo']
+    try cmd_git_repo
+  end
+
+  # Get current working directory.
+  def _git_check_workspace_get_dir
+    cmd_pwd =
+      config.active['cmd_git_check_workspace_pwd']
+    (run cmd_pwd).strip
+  end
+end

data/lib/takelage/git/cli.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage git
+  class Git < SubCommandBase
+    desc 'check [COMMAND]', 'Check git state'
+    subcommand 'check', GitCheck
+  end
+end

data/lib/takelage/info/cli.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage info
+  class Info < SubCommandBase
+    desc 'project [COMMAND]', 'Get project info'
+    subcommand 'project', InfoProject
+  end
+end

data/lib/takelage/info/project/cli.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage info project
+  class InfoProject < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include ProjectModule
+
+    #
+    # info project active
+    #
+    desc 'active', 'Print active project info'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print active project info
+    LONGDESC
+    # Print active project info.
+    def active
+      project_active_yaml = hash_to_yaml(project.active)
+      exit false if project_active_yaml == false
+      say project_active_yaml
+      true
+    end
+
+    #
+    # info project private
+    #
+    desc 'private', 'Print private project info'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print private project info
+    LONGDESC
+    # Print private project info.
+    def private
+      project_private_yaml = hash_to_yaml(project.private)
+      exit false if project_private_yaml == false
+      say project_private_yaml
+      true
+    end
+
+    #
+    # info project main
+    #
+    desc 'main', 'Print main project info'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print main project info
+    LONGDESC
+    # Print main project info.
+    def main
+      project_main_yaml = hash_to_yaml(project.main)
+      exit false if project_main_yaml == false
+      say project_main_yaml
+      true
+    end
+  end
+end

data/lib/takelage/lib/config.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+# takelage config module
+module ConfigModule
+  # takelage config class.
+  class TakelageConfig
+    include Singleton
+    include LoggingModule
+    include SystemModule
+
+    attr_accessor :active, :default, :home, :project
+
+    def initialize
+      @active = {}
+      @default = {}
+      @home = {}
+      @project = {}
+    end
+  end
+
+  # Initialze config
+  def initialize_config
+    log.debug "takelage version: #{Takelage::VERSION}"
+    log.debug "Current working directory: #{Dir.pwd}"
+
+    TakelageConfig.instance.default = _config_read_default
+    TakelageConfig.instance.home = _config_read_home
+    TakelageConfig.instance.project = _config_read_project
+    TakelageConfig.instance.active = _config_merge_active
+  end
+
+  # @return [Object] global singleton config
+  def config
+    TakelageConfig.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 TakelageConfig.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 = TakelageConfig.instance.active[config_key]
+    return true unless takel_config_key.nil? || takel_config_key.empty?
+
+    log.error "Unset config key. Please configure \"#{config_key}\""
+    @configured = false
+    false
+  end
+
+  # Read default config file in lib.
+  def _config_read_default
+    default_file = File.expand_path("#{File.dirname(__FILE__)}/../default.yml")
+
+    return {} unless File.exist? default_file
+
+    default_yaml = read_yaml_file(default_file) || {}
+
+    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
+
+    home_yaml = read_yaml_file(home_file) || {}
+
+    home_yaml.sort.to_h
+  end
+
+  # Read custom config file next to Rakefile.
+  def _config_read_project
+    _rakefile, path = Rake.application.find_rakefile_location
+    project_file = "#{path}/takelage.yml"
+
+    return {} unless File.exist? project_file
+
+    project_yaml = read_yaml_file(project_file) || {}
+
+    project_yaml.sort.to_h
+  end
+
+  # Merge active config
+  def _config_merge_active
+    # make a clone or else we'll change the original hash
+    default = TakelageConfig.instance.default.clone
+    home = TakelageConfig.instance.home.clone
+    project = TakelageConfig.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
+end

data/lib/takelage/lib/logging.rb

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

data/lib/takelage/lib/project.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# takelage project module
+module ProjectModule
+  # takelage config class.
+  class TakelageProject
+    include Singleton
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+
+    attr_accessor :active, :private, :main
+
+    def initialize
+      @active = {}
+      @private = {}
+      @main = {}
+    end
+  end
+
+  # Initialze project
+  def initialize_project
+    TakelageProject.instance.main = _project_read_main
+    TakelageProject.instance.private = _project_read_private
+    TakelageProject.instance.active = _project_merge_active
+  end
+
+  # @return [Object] global singleton project
+  def project
+    TakelageProject.instance
+  end
+
+  private
+
+  # Read main YAML file.
+  def _project_read_main
+    _rakefile, @path = Rake.application.find_rakefile_location
+    main_file = "#{@path}/" \
+        "#{TakelageProject.instance.config.active['info_project_main']}"
+
+    return {} unless File.exist? main_file
+
+    read_yaml_file(main_file).sort.to_h || {}
+  end
+
+  # Read private YAML file.
+  def _project_read_private
+    _rakefile, @path = Rake.application.find_rakefile_location
+    private_file = "#{@path}/" \
+        "#{TakelageProject.instance.config.active['info_project_private']}"
+
+    return {} unless File.exist? private_file
+
+    private_yaml = read_yaml_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 = TakelageProject.instance.main.clone
+    private = TakelageProject.instance.private.clone
+
+    # merge main and private to active
+    # private wins against main
+    main.merge!(private).sort.to_h
+  end
+end