takelage 0.13.2 → 0.13.3

data/lib/takelage/bit/scope/module.rb

@@ -1,83 +1,58 @@
+# frozen_string_literal: true
+
 # takelage bit scope module
 module BitScopeModule
-
   # Backend method for bit scope add.
   def bit_scope_add(scope)
     log.debug "Adding bit remote scope \"#{scope}\" to local workspace"
 
-    return false unless configured? %w(bit_ssh bit_remote)
+    return false unless configured? %w[bit_ssh bit_remote]
 
-    unless bit_check_workspace
-      log.error 'No bit workspace'
-      return false
-    end
-
-    if git_check_workspace
-      unless git_check_master
-        log.error 'Not on git master branch'
-        return false
-      end
-    end
+    return false unless _bit_scope_add_workspace_ready?
 
     # check if bit remote scope exists
-    scope_list = bit_scope_list
-    log.debug scope_list
-    unless scope_list.include? scope
+    unless bit_scope_list.include? scope
       log.error "The bit remote bit scope \"#{scope}\" doesn't exist"
       return false
     end
 
-    # get bit remote from active config
-    bit_remote =
-        config.active['bit_remote']
-
-    # prepare scope add command
-    cmd_bit_scope_add = "bit remote add #{bit_remote}/#{scope}"
-    run cmd_bit_scope_add
+    run "bit remote add #{config.active['bit_remote']}/#{scope}"
 
     log.info "Added bit remote scope \"#{scope}\" to local bit workspace"
   end
 
   # Backend method for bit scope inbit.
   def bit_scope_inbit
-    log.debug "Logging in to bit remote server"
-
-    return false unless configured? %w(bit_ssh)
+    log.debug 'Logging in to bit remote server'
 
-    cmd_bit_scope_login =
-        config.active['bit_ssh']
+    return false unless configured? %w[bit_ssh]
 
-    run_and_exit cmd_bit_scope_login
+    run_and_exit config.active['bit_ssh']
   end
 
   # Backend method for bit scope list.
   # @return [String] list of bit scopes
   def bit_scope_list
-    log.debug "Listing bit remote scopes"
+    log.debug 'Listing bit remote scopes'
 
-    return false unless configured? %w(bit_ssh bit_remote)
+    return false unless configured? %w[bit_ssh bit_remote]
 
     # get ssh command from active config
     cmd_bit_ssh =
-        config.active['bit_ssh']
+      config.active['bit_ssh']
 
-    # prepare scope list command
-    root =
-        config.active['bit_root']
+    root = config.active['bit_root']
 
-    cmd_bit_scope_list =
-        config.active['cmd_bit_scope_list_find_scopes'] % {
-            root: root
-        }
+    cmd_bit_scope_list = _bit_scope_list_cmd root
 
     # run ssh command with scope list command
     scope_list = run "#{cmd_bit_ssh} '#{cmd_bit_scope_list}'"
 
     # remove bit remote root directory from results
-    scope_list.gsub!(/#{root}\/*/, '')
+    scope_list.gsub!(%r{#{root}/*}, '')
 
     # remove /scope.json from results
-    scope_list.gsub!(/\/scope.json/, '')
+    scope_list.gsub!(%r{/scope.json}, '')
 
     scope_list
   end
@@ -87,31 +62,61 @@ module BitScopeModule
   def bit_scope_new(scope)
     log.debug "Creating new bit remote scope \"#{scope}\""
 
-    return false unless configured? %w(bit_ssh bit_remote)
+    return false unless configured? %w[bit_ssh bit_remote]
 
-    # check if bit remote scope already exists
-    scope_list = bit_scope_list
-    if scope_list.include? scope
-      log.error "The remote bit scope \"#{scope}\" already exists"
+    return false if _bit_scope_exists? scope
+
+    cmd_bit_ssh = config.active['bit_ssh']
+
+    cmd_bit_scope_new = _bit_scope_new_cmd scope
+
+    run "#{cmd_bit_ssh} '#{cmd_bit_scope_new}'"
+
+    log.info "Created new bit remote scope \"#{scope}\""
+  end
+
+  private
+
+  # Check if workspace ready for bit scope add.
+  def _bit_scope_add_workspace_ready?
+    unless bit_check_workspace
+      log.error 'No bit workspace'
       return false
     end
 
-    # get ssh command from active config
-    cmd_bit_ssh =
-        config.active['bit_ssh']
+    return true unless git_check_workspace
 
-    # prepare scope list command
-    root =
-        config.active['bit_root']
+    return true if git_check_master
 
-    cmd_bit_scope_new =
-        config.active['cmd_bit_scope_new_bit_init'] % {
-            scope: scope, root: root
-        }
+    log.error 'Not on git master branch'
+    false
+  end
 
-    # run ssh command with scope new command
-    run "#{cmd_bit_ssh} '#{cmd_bit_scope_new}'"
+  # Prepare bit scope list command.
+  def _bit_scope_list_cmd(root)
+    format(
+      config.active['cmd_bit_scope_list_find_scopes'],
+      root: root
+    )
+  end
 
-    log.info "Created new bit remote scope \"#{scope}\""
+  # Check if bit scope already exists.
+  def _bit_scope_exists?(scope)
+    scope_list = bit_scope_list
+    return false unless scope_list.include? scope
+
+    log.error "The remote bit scope \"#{scope}\" already exists"
+    false
+  end
+
+  # Prepare bit scope new command.
+  def _bit_scope_new_cmd(scope)
+    root = config.active['bit_root']
+
+    format(
+      config.active['cmd_bit_scope_new_bit_init'],
+      scope: scope,
+      root: root
+    )
   end
 end

data/lib/takelage/completion/cli.rb

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage completion
   class Completion < SubCommandBase
-
     include LoggingModule
 
     desc 'bash', 'Print bash completion code'

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

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage docker check
   class DockerCheck < SubCommandBase
-
     include LoggingModule
     include SystemModule
     include ConfigModule

data/lib/takelage/docker/check/module.rb

@@ -1,24 +1,22 @@
+# frozen_string_literal: true
+
 # takelage docker check module
 module DockerCheckModule
-
   # Backend method for docker check running.
   # @return [Boolean] is the docker daemon running?
   def docker_check_running
     return true if @docker_daemon_running
 
-    log.debug "Check if the docker daemon is running"
-
-    cmd_docker_info =
-        config.active['cmd_docker_check_running_docker_info']
+    log.debug 'Check if the docker daemon is running'
 
-    status = try cmd_docker_info
+    status = try config.active['cmd_docker_check_running_docker_info']
 
     unless status.exitstatus.zero?
-      log.error "The docker daemon is not running"
+      log.error 'The docker daemon is not running'
       return false
     end
 
-    log.debug "The docker daemon is running"
+    log.debug 'The docker daemon is running'
     @docker_daemon_running = true
     true
   end

data/lib/takelage/docker/cli.rb

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage docker
   class Docker < SubCommandBase
-
     desc 'check [COMMAND]', 'Check docker'
     subcommand 'check', DockerCheck
 
@@ -14,6 +14,5 @@ module Takelage
 
     desc 'socket [COMMAND]', 'Handle sockets for docker containers'
     subcommand 'socket', DockerSocket
-
   end
 end

data/lib/takelage/docker/container/check/cli.rb

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage docker container check
   class DockerContainerCheck < SubCommandBase
-
     include LoggingModule
     include SystemModule
     include ConfigModule

data/lib/takelage/docker/container/check/module.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 # takelage docker container check module
 module DockerContainerCheckModule
-
   # Backend method for docker container check existing.
   # @return [Boolean] is container existing?
   def docker_container_check_existing(container)
@@ -8,12 +9,7 @@ module DockerContainerCheckModule
 
     return false unless docker_check_running
 
-    cmd_docker_existing =
-        config.active['cmd_docker_container_check_existing_docker_ps'] % {
-            container: container
-        }
-
-    stdout_str = run cmd_docker_existing
+    stdout_str = run _docker_container_cmd_check_existing container
 
     if stdout_str.to_s.strip.empty?
       log.debug "Container \"#{container}\" is not existing"
@@ -31,12 +27,7 @@ module DockerContainerCheckModule
 
     return false unless docker_check_running
 
-    cmd_docker_network =
-        config.active['cmd_docker_container_check_network_docker_network'] % {
-            network: network
-        }
-
-    stdout_str = run cmd_docker_network
+    stdout_str = run _docker_container_cmd_check_network network
 
     if stdout_str.to_s.strip.empty?
       log.debug "Network \"#{network}\" is not existing"
@@ -54,12 +45,7 @@ module DockerContainerCheckModule
 
     return false unless docker_check_running
 
-    cmd_docker_orphaned =
-        config.active['cmd_docker_container_check_orphaned_docker_exec'] % {
-            container: container
-        }
-
-    stdout_str = run cmd_docker_orphaned
+    stdout_str = run _docker_container_cmd_check_orphaned container
 
     if stdout_str.include? '/loginpoint.py'
       log.debug "Container \"#{container}\" isn't orphaned"
@@ -69,4 +55,27 @@ module DockerContainerCheckModule
     log.debug "Container \"#{container}\" is orphaned"
     true
   end
+
+  private
+
+  def _docker_container_cmd_check_existing(container)
+    format(
+      config.active['cmd_docker_container_check_existing_docker_ps'],
+      container: container
+    )
+  end
+
+  def _docker_container_cmd_check_network(network)
+    format(
+      config.active['cmd_docker_container_check_network_docker_network'],
+      network: network
+    )
+  end
+
+  def _docker_container_cmd_check_orphaned(container)
+    format(
+      config.active['cmd_docker_container_check_orphaned_docker_exec'],
+      container: container
+    )
+  end
 end

data/lib/takelage/docker/container/cli.rb

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage docker container
   class DockerContainer < SubCommandBase
-
     include LoggingModule
     include SystemModule
     include ConfigModule
@@ -16,8 +16,9 @@ module Takelage
     include DockerSocketModule
 
     # Initialize docker container
-    def initialize(args=[], local_options={}, configuration={})
-
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    def initialize(args = [], local_options = {}, configuration = {})
       # initialize thor parent class
       super args, local_options, configuration
 
@@ -38,11 +39,11 @@ module Takelage
       @gpg_agent_port = config.active['docker_socket_gpg_agent_port']
       @gpg_ssh_agent_port = config.active['docker_socket_gpg_ssh_agent_port']
 
-      @username = ENV['USER'] ? ENV['USER'] : 'username'
+      @username = ENV['USER'] || 'username'
       @gid = Etc.getpwnam(@username).gid
       @uid = Etc.getpwnam(@username).uid
 
-      @homedir = ENV['HOME'] ? ENV['HOME'] : '/tmp'
+      @homedir = ENV['HOME'] || '/tmp'
       @workdir = Dir.getwd
       @hostname = "#{@docker_repo}_#{File.basename(@workdir)}"
 
@@ -51,6 +52,8 @@ module Takelage
       @socket_host = docker_socket_host
       @sockets = docker_socket_scheme
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
     desc 'check [COMMAND]', 'Check docker container'
     subcommand 'check', DockerContainerCheck
@@ -71,10 +74,10 @@ module Takelage
     # docker container login
     #
     option :development,
-           :aliases => 'd',
-           :type => :boolean,
-           :default => false,
-           :desc => 'Log in to docker container in debug mode'
+           aliases: 'd',
+           type: :boolean,
+           default: false,
+           desc: 'Log in to docker container in debug mode'
     desc 'login', 'Log in to latest local docker container'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
     Log in to latest local docker container