takelage 0.20.2 → 0.22.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f755a130345b2343101f6ad38a711d11b8d15413506465534737b09ddd0459f
-  data.tar.gz: 75fd7eb711147a14896a635751e0d544fc57e490b11546d90cb82ce1858aec43
+  metadata.gz: 3b1bdbf2ad81fedd7484d2b6ce316bc5486be8e38a829fbf44e3f141f6d90eff
+  data.tar.gz: ce7345bf4f198b3b488dcb0d729b04c9464bfdd4a6367f8c8eaf208bfa178a07
 SHA512:
-  metadata.gz: a8e3e1a324bfeade0a331f89de454de9909b8ad564d16849d56e5dc624dacf69d7c79c46547bee630f6fef9ad89f3275b5811203c93288dcdf5548c975e26ab7
-  data.tar.gz: 5f4bcd4c8f6a688f78add975c78cfcb6995b0777ab73f38beae6f4f2760b70816a39fc9af56952c43c81ba691e9336a51745fe4ddb2745cafc999d084794cb38
+  metadata.gz: 8d02d2ba911590af68e157717de71903bf32726f8f7e6ca4548b662019d9c5e081d65c0d167eba3c3e04474df4a8d6745d46db89eb081d3b627dab78450e7ff6
+  data.tar.gz: 124474a3f2ed1db88b0e49bb02979a885c6db223a1b9105235daff4b945cef5558fd2496abb9f6ed78407cf37e8b3f57065a481e2a5307a0de3551f136f0a307

data/README.md

@@ -81,9 +81,10 @@ tau [docker socket scheme](features/cucumber/features/docker/docker.socket.schem
 tau [docker socket start](features/cucumber/features/docker/docker.socket.start.feature) | Start sockets for docker container
 tau [docker socket stop](features/cucumber/features/docker/docker.socket.stop.feature) | Stop sockets for docker container
 tau [git check clean](features/cucumber/features/git/git.check.clean.feature) | Check if the git workspace is clean
-tau [git check master](features/cucumber/features/git/git.check.master.feature) | Check if we are on the git master branch
+tau [git check main](features/cucumber/features/git/git.check.main.feature) | Check if we are on the git main branch
 tau [git check workspace](features/cucumber/features/git/git.check.workspace.feature) | Check if a git workspace exists
 tau [info project active](features/cucumber/features/info/info.project.active.feature) | Print active project info
+tau [info project dir](features/cucumber/features/info/info.project.dir.feature) | Print project root directory
 tau [info project main](features/cucumber/features/info/info.project.main.feature) | Print main project info
 tau [info project private](features/cucumber/features/info/info.project.private.feature) | Print private project info
 tau [self config active](features/cucumber/features/self/self.config.active.feature) | Print active takelage configuration
@@ -186,8 +187,11 @@ source <(tau completion bash)
 
 ### Software Tests
 
+*takelage-cli* uses
+[minitest](https://github.com/seattlerb/minitest) unit tests.
+
 *takelage-cli* ships with 
-[cucumber](https://github.com/cucumber/cucumber) ruby tests.
+[cucumber](https://github.com/cucumber/cucumber) ruby system tests.
 It uses cucumber's 
 [aruba](https://github.com/cucumber/aruba) extension and especially its
 [filesystem](https://relishapp.com/cucumber/aruba/v/0-11-0/docs/filesystem)

data/lib/takelage.rb

@@ -21,7 +21,7 @@ require_relative 'takelage/lib/config'
 require_relative 'takelage/lib/project'
 
 require_relative 'takelage/git/check/clean'
-require_relative 'takelage/git/check/master'
+require_relative 'takelage/git/check/main'
 require_relative 'takelage/git/check/workspace'
 require_relative 'takelage/git/check/cli'
 require_relative 'takelage/git/cli'

data/lib/takelage/bit/clipboard/cli.rb

@@ -7,7 +7,7 @@ module Takelage
     include ConfigModule
     include SystemModule
     include GitCheckClean
-    include GitCheckMaster
+    include GitCheckMain
     include GitCheckWorkspace
     include BitCheckWorkspace
     include BitClipboardLib

data/lib/takelage/bit/clipboard/copy.rb

@@ -71,7 +71,7 @@ module BitClipboardCopy
     bit_dev = config.active['bit_dev_user']
 
     # check if scope is a candidate for a bit.dev remote scope
-    if scope.start_with? bit_dev + '.'
+    if scope.start_with? "#{bit_dev}."
       return false unless _bit_clipboard_bit_dev_scope_exists scope
     else
       return false unless _bit_clipboard_custom_scope_exists scope

data/lib/takelage/bit/clipboard/lib.rb

@@ -4,6 +4,14 @@
 module BitClipboardLib
   private
 
+  # Run bit status.
+  def _bit_clipboard_lib_bit_status
+    log.debug 'Running bit status'
+
+    cmd_bit_status = config.active['cmd_bit_clipboard_lib_bit_status']
+    run_and_exit cmd_bit_status
+  end
+
   # Prepare workspace for bit clipboard.
   def _bit_clipboard_lib_prepare_workspace
     unless bit_check_workspace
@@ -18,8 +26,8 @@ module BitClipboardLib
 
   # Prepare git workspace for bit clipboard.
   def _bit_clipboard_lib_prepare_git_workspace
-    unless git_check_master
-      log.error 'Not on git master branch'
+    unless git_check_main
+      log.error 'Not on git main branch'
       return false
     end
 
@@ -83,12 +91,14 @@ module BitClipboardLib
     run cmd_bit_clipboard_git_commit
   end
 
-  # git push origin master.
+  # git push origin main.
   def _bit_clipboard_lib_git_push
-    log.debug 'Pushing master branch to origin'
+    log.debug 'Pushing main branch to origin'
 
-    cmd_bit_clipboard_git_push =
-      config.active['cmd_bit_clipboard_git_push']
+    cmd_bit_clipboard_git_push = format(
+      config.active['cmd_bit_clipboard_git_push'],
+      main: config.active['git_main_branch']
+    )
 
     run cmd_bit_clipboard_git_push
   end
@@ -96,8 +106,10 @@ module BitClipboardLib
   # git pull.
   def _bit_clipboard_lib_git_pull
     log.debug 'Updating git workspace'
-    cmd_bit_clipboard_git_pull =
-      config.active['cmd_bit_clipboard_git_pull']
+    cmd_bit_clipboard_git_pull = format(
+      config.active['cmd_bit_clipboard_git_pull'],
+      main: config.active['git_main_branch']
+    )
 
     return true if try cmd_bit_clipboard_git_pull
 

data/lib/takelage/bit/clipboard/paste.rb

@@ -42,7 +42,7 @@ module BitClipboardPaste
 
     bit_list_scope = _bit_clipboard_paste_cid_exists_list_scope scope
 
-    return true if bit_list_scope.include? '"id": "' + cid + '",'
+    return true if bit_list_scope.include? "\"id\": \"#{cid}\","
 
     log.error "No remote component \"#{cid}\""
     false

data/lib/takelage/bit/clipboard/pull.rb

@@ -14,9 +14,7 @@ module BitClipboardPull
     _bit_clipboard_pull_checkout_all
     _bit_clipbpard_lib_remove_bit_artifacts
     _bit_clipboard_lib_sync_workspace
-
-    log.info 'Pulled bit components'
-    true
+    _bit_clipboard_lib_bit_status
   end
 
   private

data/lib/takelage/bit/clipboard/push.rb

@@ -14,9 +14,7 @@ module BitClipboardPush
     _bit_clipboard_push_export_all
     _bit_clipbpard_lib_remove_bit_artifacts
     _bit_clipboard_lib_sync_workspace
-
-    log.info 'Pushed bit components'
-    true
+    _bit_clipboard_lib_bit_status
   end
 
   private

data/lib/takelage/bit/require/cli.rb

@@ -7,7 +7,7 @@ module Takelage
     include ConfigModule
     include SystemModule
     include GitCheckClean
-    include GitCheckMaster
+    include GitCheckMain
     include GitCheckWorkspace
     include BitCheckWorkspace
     include BitScopeList

data/lib/takelage/bit/require/import.rb

@@ -71,7 +71,7 @@ module BitRequireImport
 
   # Check if there are bit components
   def _bit_require_import_check_component_valid(component, scope)
-    return true if (component.class == Hash) && component.key?('name')
+    return true if component.instance_of?(Hash) && component.key?('name')
 
     log.error "No component in #{scope}"
     false

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

@@ -28,9 +28,9 @@ module BitScopeAdd
 
     return true unless git_check_workspace
 
-    return true if git_check_master
+    return true if git_check_main
 
-    log.error 'Not on git master branch'
+    log.error 'Not on git main branch'
     false
   end
 

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

@@ -6,7 +6,7 @@ module Takelage
     include LoggingModule
     include SystemModule
     include ConfigModule
-    include GitCheckMaster
+    include GitCheckMain
     include GitCheckWorkspace
     include BitCheckWorkspace
     include BitScopeAdd

data/lib/takelage/default.yml

@@ -6,6 +6,7 @@ bit_root: '/bit'
 bit_ssh: ''
 cmd_bit_check_workspace_bit_list: 'bit list'
 cmd_bit_check_workspace_pwd: 'pwd'
+cmd_bit_clipboard_lib_bit_status: 'bit status'
 cmd_bit_clipboard_copy_bit_list_scope: 'bit list --skip-update --json %{scope}'
 cmd_bit_clipboard_copy_bit_list_remotes: 'bit remote --skip-update'
 cmd_bit_clipboard_copy_bit_add_dir: 'bit add --skip-update --id %{id} --main %{dir}/README.bit %{dir}'
@@ -13,8 +14,8 @@ cmd_bit_clipboard_copy_bit_tag_id: 'bit tag --skip-update --skip-tests %{id}'
 cmd_bit_clipboard_copy_bit_export_to_scope: 'bit export --skip-update %{scope}'
 cmd_bit_clipboard_git_add: 'git add %{file}'
 cmd_bit_clipboard_git_commit: 'git commit --message="%{message}"'
-cmd_bit_clipboard_git_pull: 'git pull origin master'
-cmd_bit_clipboard_git_push: 'git push origin master'
+cmd_bit_clipboard_git_pull: 'git pull origin %{main}'
+cmd_bit_clipboard_git_push: 'git push origin %{main}'
 cmd_bit_clipboard_paste_bit_list_scope: 'bit list --skip-update --json %{scope}'
 cmd_bit_clipboard_paste_bit_import_cid: 'bit import --ignore-package-json --ignore-dist --skip-update --path %{dir} %{cid}'
 cmd_bit_clipboard_pull_bit_import_all: 'bit import --ignore-package-json --ignore-dist --skip-update'
@@ -53,7 +54,7 @@ cmd_docker_socket_stop_docker_socket_kill: 'sudo kill -SIGTERM %{pid}'
 cmd_git_check_clean_git_unstaged: 'git diff --exit-code'
 cmd_git_check_clean_git_uncommitted: 'git diff --cached --exit-code'
 cmd_git_check_clean_git_status: 'git status --porcelain'
-cmd_git_check_master_git_branch: 'git symbolic-ref HEAD'
+cmd_git_check_main_git_branch: 'git symbolic-ref HEAD'
 cmd_git_check_workspace_git_repo: 'git -C . rev-parse'
 cmd_git_check_workspace_pwd: 'pwd'
 docker_debug: 'ansible/roles/takel-takelage/files/takelscripts'
@@ -67,5 +68,6 @@ docker_socket_gpg_agent_port: 17874
 docker_socket_gpg_ssh_agent_port: 17875
 docker_tag: 'latest'
 docker_user: 'takelage'
+git_main_branch: 'main'
 info_project_main: 'project.yml'
 info_project_private: 'private/project.yml'

data/lib/takelage/docker/socket/host.rb

@@ -6,6 +6,17 @@ module DockerSocketHost
   def docker_socket_host
     log.debug 'Getting docker socket host ip address'
 
+    socket_host = _docker_socket_host_get_socket_host
+
+    log.debug "Docker socket host ip address is \"#{socket_host}\""
+
+    socket_host
+  end
+
+  private
+
+  # Get the socket host, i.e. the ip of the docker host.
+  def _docker_socket_host_get_socket_host
     socket_host = '127.0.0.1'
 
     addr_infos = Socket.getifaddrs
@@ -13,13 +24,12 @@ module DockerSocketHost
     # if interface docker0 exists (== linux host)
     # then return the ip address
     addr_infos.each do |addr_info|
-      if addr_info.name == 'docker0'
-        socket_host = addr_info.addr.ip_address if addr_info.addr.ipv4?
+      if (addr_info.name == 'docker0') && addr_info.addr.ipv4?
+        socket_host = addr_info.addr.ip_address
+        break
       end
     end
 
-    log.debug "Docker socket host ip address is \"#{socket_host}\""
-
     socket_host
   end
 end

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

@@ -7,7 +7,7 @@ module Takelage
     include SystemModule
     include ConfigModule
     include GitCheckClean
-    include GitCheckMaster
+    include GitCheckMain
     include GitCheckWorkspace
 
     #
@@ -23,15 +23,15 @@ module Takelage
     end
 
     #
-    # git check master
+    # git check main
     #
-    desc 'master', 'Check if we are on the git master branch'
+    desc 'main', 'Check if we are on the git main branch'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Check if we are on the git master branch
+    Check if we are on the git main branch
     LONGDESC
-    # Check if we are on the git master branch.
-    def master
-      exit git_check_master
+    # Check if we are on the git main branch.
+    def main
+      exit git_check_main
     end
 
     #

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

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

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

@@ -52,5 +52,18 @@ module Takelage
       say project_main_yaml
       true
     end
+
+    #
+    # info project dir
+    #
+    desc 'dir', 'Print project root directory'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print project root directory
+    LONGDESC
+    # Print project root directory.
+    def dir
+      say project.dir
+      true
+    end
   end
 end

data/lib/takelage/lib/config.rb

@@ -93,9 +93,7 @@ module ConfigModule
 
     return {} unless File.exist? home_file
 
-    home_yaml = read_yaml_file(home_file) || {}
-
-    home_yaml.sort.to_h
+    (read_yaml_file(home_file) || {}).sort.to_h
   end
 
   # Read custom config file in project root.
@@ -104,9 +102,7 @@ module ConfigModule
 
     return {} unless File.exist? project_file
 
-    project_yaml = read_yaml_file(project_file) || {}
-
-    project_yaml.sort.to_h
+    (read_yaml_file(project_file) || {}).sort.to_h
   end
 
   # Merge active config.

data/lib/takelage/lib/logging.rb

@@ -9,7 +9,7 @@ module LoggingModule
     attr_accessor :logger
 
     def initialize
-      @logger = Logger.new(STDOUT)
+      @logger = Logger.new($stdout)
     end
   end
 

data/lib/takelage/lib/project.rb

@@ -9,12 +9,13 @@ module ProjectModule
     include SystemModule
     include ConfigModule
 
-    attr_accessor :active, :private, :main
+    attr_accessor :active, :private, :main, :dir
 
     def initialize
       @active = {}
       @private = {}
       @main = {}
+      @dir = {}
     end
   end
 
@@ -23,6 +24,8 @@ module ProjectModule
     TakelageProject.instance.main = _project_read_main
     TakelageProject.instance.private = _project_read_private
     TakelageProject.instance.active = _project_merge_active
+    TakelageProject.instance.dir =
+      TakelageProject.instance.config.active['project_root_dir']
   end
 
   # @return [Object] global singleton project
@@ -34,24 +37,24 @@ module ProjectModule
 
   # Read main YAML file.
   def _project_read_main
-    @path = TakelageProject.instance.config.active['project_root_dir']
-    main_file = "#{@path}/" \
+    dir = TakelageProject.instance.config.active['project_root_dir']
+    main_file = "#{dir}/" \
         "#{TakelageProject.instance.config.active['info_project_main']}"
 
     return {} unless File.exist? main_file
 
-    read_yaml_file(main_file).sort.to_h || {}
+    (read_yaml_erb_file(main_file) || {}).sort.to_h
   end
 
   # Read private YAML file.
   def _project_read_private
-    @path = TakelageProject.instance.config.active['project_root_dir']
-    private_file = "#{@path}/" \
+    dir = TakelageProject.instance.config.active['project_root_dir']
+    private_file = "#{dir}/" \
         "#{TakelageProject.instance.config.active['info_project_private']}"
 
     return {} unless File.exist? private_file
 
-    private_yaml = read_yaml_file(private_file) || {}
+    private_yaml = read_yaml_erb_file(private_file) || {}
 
     private_yaml.sort.to_h
   end

data/lib/takelage/lib/subcmd.rb

@@ -3,9 +3,11 @@
 # 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

data/lib/takelage/lib/system.rb

@@ -20,7 +20,19 @@ module SystemModule
     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
+    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
@@ -82,7 +94,7 @@ module SystemModule
   # Read yaml file.
   def _file_read(file)
     begin
-      @content_yaml = File.read file
+      @content_file = File.read file
     rescue SystemCallError
       log.debug "Unable to read file \"#{file}\""
       return false
@@ -90,8 +102,21 @@ module SystemModule
     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(content_yaml)
+  def _parse_yaml(file, content_yaml)
     begin
       @content = YAML.safe_load content_yaml
     rescue Psych::SyntaxError

data/lib/takelage/self/list.rb

@@ -4,6 +4,13 @@
 module SelfList
   # Backend method for config self.
   def self_list
+    _manipulate_output_(_get_thor_list_)
+  end
+
+  private
+
+  # Get output of thor list command.
+  def _get_thor_list_
     # use Thorfile which requires relative takelage.rb
     thorfile_dir = "#{File.dirname(__FILE__)}/../"
 
@@ -12,20 +19,17 @@ module SelfList
         "cd #{thorfile_dir} && " \
         'thor list' \
         "'"
-    thor_list = `#{cmd_thor_list}`
 
-    # manipulate thor list output
-    _manipulate_output_(thor_list)
+    # call thor list command
+    `#{cmd_thor_list}`
   end
 
-  private
-
   # Manipulate output of thor list command.
   def _manipulate_output_(thor_list)
-    thor_list.gsub!("takelage\n", '')
-    thor_list.gsub!("------\n", '')
-    thor_list.gsub!('thor ', 'tau ')
-    thor_list.gsub!(/(.*)takelage:c_l_i:(.*)#(.*)/, '\1\2               #\3')
-    thor_list.gsub!(/.*COMMAND.*\n/, '')
+    tau_list = thor_list.gsub("takelage\n", '')
+    tau_list.gsub!("------\n", '')
+    tau_list.gsub!('thor ', 'tau ')
+    tau_list.gsub!(/(.*)takelage:c_l_i:(.*)#(.*)/, '\1\2               #\3')
+    tau_list.gsub!(/.*COMMAND.*\n/, '')
   end
 end

data/lib/takelage/version

@@ -1 +1 @@
-0.20.2
+0.22.2

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: takelage
 version: !ruby/object:Gem::Version
-  version: 0.20.2
+  version: 0.22.2
 platform: ruby
 authors:
 - Geospin
@@ -261,7 +261,7 @@ files:
 - lib/takelage/docker/socket/stop.rb
 - lib/takelage/git/check/clean.rb
 - lib/takelage/git/check/cli.rb
-- lib/takelage/git/check/master.rb
+- lib/takelage/git/check/main.rb
 - lib/takelage/git/check/workspace.rb
 - lib/takelage/git/cli.rb
 - lib/takelage/info/cli.rb

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

@@ -1,26 +0,0 @@
-# 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