takelage 0.13.2 → 0.13.3

data/lib/takelage/lib/config.rb

@@ -1,80 +1,97 @@
+# 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 = Hash.new
-      @default = Hash.new
-      @home = Hash.new
-      @project = Hash.new
+      @active = {}
+      @default = {}
+      @home = {}
+      @project = {}
     end
   end
 
-  # Global singleton config
-  @@config = TakelageConfig.new
-
   # Initialze config
   def initialize_config
     log.debug "takelage version: #{Takelage::VERSION}"
     log.debug "Current working directory: #{Dir.pwd}"
 
-    # read default config file in lib
-    default_file = "#{File.dirname(__FILE__)}/../default.yml"
-    default_file = File.expand_path default_file
-    if File.exist? default_file
-      @@config.default = read_yaml_file(default_file) || Hash.new
-      @@config.default = @@config.default.sort.to_h
-    end
-
-    # read custom config file in $HOME
-    home_file = "#{Dir.home}/.takelage.yml"
-    if File.exist? home_file
-      @@config.home = read_yaml_file(home_file) || Hash.new
-      @@config.home = @@config.home.sort.to_h
-    end
-
-    # read custom config file next to Rakefile
-    file, path = Rake.application.find_rakefile_location
-    if path
-      project_file = "#{path}/takelage.yml"
-      @@config.project = read_yaml_file(project_file) || Hash.new
-      @@config.project = @@config.project.sort.to_h
-    end
-
-    # make a clone or else we'll change the original hash
-    default = @@config.default.clone
-    home = @@config.home.clone
-    project = @@config.project.clone
-
-    # merge default and home and project to active
-    # project wins against home wins against default
-    project_over_home = home.merge!(project)
-
-    @@config.active = default.merge!(project_over_home)
-    @@config.active = @@config.active.sort.to_h
+    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
-    @@config
+    TakelageConfig.instance
   end
 
   # @return [Boolean] check if config keys are configured
   def configured?(config_keys)
     @configured = true
     config_keys.each do |config_key|
-      unless @@config.active.key? config_key
+      unless TakelageConfig.instance.active.key? config_key
         log.error "Please configure \"#{config_key}\""
         @configured = false
       end
     end
     @configured
   end
+
+  private
+
+  # 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

@@ -1,30 +1,47 @@
+# frozen_string_literal: true
+
 # takelage logging module
 module LoggingModule
+  # takelage logger
+  class TakelageLogger
+    include Singleton
+
+    attr_accessor :logger
 
-  # Global singleton logger
-  @@log = Logger.new(STDOUT)
+    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
 
-    # logger: format
-    log.formatter = proc do |severity, datetime, progname, msg|
+  # @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
 
-    # logger: level
-    if %w(FATAL ERROR WARN INFO DEBUG).include? loglevel
-      log.level = loglevel
-      log.debug "Using loglevel #{loglevel}"
+  def _logging_get_log_level(loglevel)
+    if %w[FATAL ERROR WARN INFO DEBUG].include? loglevel
+      loglevel
     else
-      log.level = Logger::INFO
-      log.error 'The parameter "loglevel" must be one of FATAL, ERROR, WARN, INFO, DEBUG'
-      log.info 'Using loglevel INFO'
+      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
-
-  # @return [Object] global singleton logger
-  def log
-    @@log
-  end
 end

data/lib/takelage/lib/project.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 # takelage project module
 module ProjectModule
   # takelage config class.
   class TakelageProject
+    include Singleton
     include LoggingModule
     include SystemModule
     include ConfigModule
@@ -9,46 +12,58 @@ module ProjectModule
     attr_accessor :active, :private, :main
 
     def initialize
-      @active = Hash.new
-      @private = Hash.new
-      @main = Hash.new
+      @active = {}
+      @private = {}
+      @main = {}
     end
   end
 
-  # Global singleton config
-  @@project = TakelageProject.new
-
   # Initialze project
   def initialize_project
-    _rakefile, path = Rake.application.find_rakefile_location
+    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
 
-    main_file = "#{path}/#{@@project.config.active['info_project_main']}"
-    private_file = "#{path}/#{@@project.config.active['info_project_private']}"
+  private
 
-    # read main project info
-    if File.exist? main_file
-      @@project.main = read_yaml_file(main_file) || {}
-      @@project.main = @@project.main.sort.to_h
-    end
+  # 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']}"
 
-    # read private project info
-    if File.exist? private_file
-      @@project.private = read_yaml_file(private_file) || {}
-      @@project.private = @@project.private.sort.to_h
-    end
+    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 = @@project.main.clone
-    private = @@project.private.clone
+    main = TakelageProject.instance.main.clone
+    private = TakelageProject.instance.private.clone
 
     # merge main and private to active
     # private wins against main
-    @@project.active = main.merge!(private)
-    @@project.active = @@project.active.sort.to_h
-  end
-
-  # @return [Object] global singleton project
-  def project
-    @@project
+    main.merge!(private).sort.to_h
   end
 end

data/lib/takelage/lib/subcmd.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Thor with subcommands that work correctly with help
 class SubCommandBase < Thor
   # Set the subcommand banner

data/lib/takelage/lib/system.rb

@@ -1,47 +1,29 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'open3'
 require 'yaml'
 
 # Interaction with the operating system
 module SystemModule
-  # Print hash as yaml.
+  # 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
-  # rubocop:disable Metrics/MethodLength
   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 @content_yaml
 
-    # Check file existence
-    unless File.exist? file
-      log.debug "File \"#{file}\" doesn't exist"
-      return nil
-    end
-
-    # Read file
-    begin
-      content_yaml = File.read file
-    rescue SystemCallError
-      log.debug "Unable to read file \"#{file}\""
-      return nil
-    end
-
-    # Parse YAML
-    begin
-      content = YAML.safe_load content_yaml
-    rescue Psych::SyntaxError
-      log.debug "Invalid YAML file \"#{file}\""
-      log.debug "Try: yamllint #{file}"
-      return nil
-    end
-
-    content
+    @content
   end
-  # rubocop:enable Metrics/MethodLength
 
   # Remove directory tree.
   def rm_fr(directory)
@@ -85,4 +67,38 @@ module SystemModule
     log.debug "Command \"#{command}\" has exit status \"#{status.exitstatus}\""
     status
   end
+
+  private
+
+  # Check if file exists.
+  def _file_exists?(file)
+    unless File.exist? file
+      log.debug "File \"#{file}\" doesn't exist"
+      return false
+    end
+    true
+  end
+
+  # Read yaml file.
+  def _file_read(file)
+    begin
+      @content_yaml = File.read file
+    rescue SystemCallError
+      log.debug "Unable to read file \"#{file}\""
+      return false
+    end
+    true
+  end
+
+  # Parse yaml file.
+  def _parse_yaml(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
 end

data/lib/takelage/self/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Takelage
   # semantic version number
   VERSION = (File.read "#{File.dirname(__FILE__)}/../version").chomp

data/lib/takelage/self/config/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Takelage
   # takelage bit
   class SelfConfig < SubCommandBase

data/lib/takelage/self/module.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # takelage self
 module SelfModule
   # Backend method for config self.

data/lib/takelage/version

@@ -1 +1 @@
-0.13.2
+0.13.3

data/lib/takelage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'docker_registry2'
 require 'etc'
 require 'fileutils'
@@ -5,6 +7,7 @@ require 'fylla'
 require 'json'
 require 'logger'
 require 'rake'
+require 'singleton'
 require 'socket'
 require 'thor'
 require 'timeout'
@@ -54,13 +57,10 @@ require_relative 'takelage/self/config/cli'
 require_relative 'takelage/self/module'
 require_relative 'takelage/self/cli'
 
-
 # Facilitate the takelage devops workflow.
 module Takelage
-
   # takelage
   class CLI < Thor
-
     include LoggingModule
     include SystemModule
     include ConfigModule
@@ -72,12 +72,11 @@ module Takelage
     attr_reader :bash_fylla
 
     option :loglevel,
-           :aliases => 'l',
-           :default => 'INFO',
-           :desc => 'One of: FATAL, ERROR, WARN, INFO, DEBUG'
+           aliases: 'l',
+           default: 'INFO',
+           desc: 'One of: FATAL, ERROR, WARN, INFO, DEBUG'
     # Initialize takelage cli.
     def initialize(args = [], local_options = {}, configuration = {})
-
       # Initialize thor parent class
       super args, local_options, configuration
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: takelage
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.13.3
 platform: ruby
 authors:
 - Geospin