takelage 0.19.1 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58c7e30c19e8a11de8ad95a88ed10b273a0266205de6eef10601331b5f6f2e99
-  data.tar.gz: 3b45502b409d12f35aabbbb0cae6cdbd33ff108f245fa9a01c1c6c5acd3e04cd
+  metadata.gz: eb34019e556b714fcd893cf3141e23a1fbf63aad8bb695e2b205cfffb657a2ee
+  data.tar.gz: a0a2b8c6b6987f52057042ef410b2a94fb5628d519aa9f3c7ede9d4831d04a0d
 SHA512:
-  metadata.gz: 7c23d454347c4983a240601f744198709cb7368edaa5baccddcc0f483ef1cd9aef1f9e04f338420764f5337fba84b181cfb95cccc222e6190fa50ae87789e7a4
-  data.tar.gz: 4a44ee37503a14484500b84bedf50597e966d084f9925886ba3af8eb0577c4d1313f939f54fb07feb89468e604c696fb65a0ea534f2d35e9f05aff82f867ffcd
+  metadata.gz: 0ef2f83567050eaf5578f793417ca4f65de20ce9d1409bef4503793a58b0ba0b8ad9fac6e889c19f33ebb3d20617519714a93e7db92b6e06283520281690ccab
+  data.tar.gz: ba45ccafbddeeda014a74eed0fcad687ad6d2287773cadb7d0aafde9854bc381d8003aea47965196f7faf5f7b3c8205daef0c03696eb0b0328d18838093f030f

data/README.md

@@ -42,66 +42,68 @@ You are encouraged to read the cucumber feature files
 for the *tau* commands
 to get an idea of how the commands work.
 You can list the *tau* commands by running
-*tau [self list](features/takelage/self/self.list.feature)*
+*tau [self list](features/cucumber/features/self/self.list.feature)*
 or *tau list*:
 
 Command	| Description
 ------- | -----------
-tau [bit check workspace](features/takelage/bit/bit.check.workspace.feature) | Check if a bit workspace exists
-tau [bit clipboard copy](features/takelage/bit/bit.clipboard.copy.feature) [DIR] [SCOPE] | Copy new [DIR] to [SCOPE]
-tau [bit clipboard paste](features/takelage/bit/bit.clipboard.paste.feature) [COMPONENT] [DIR] | Paste bit [COMPONENT] into [DIR]
-tau [bit clipboard pull](features/takelage/bit/bit.clipboard.pull.feature) | Pull all updates for bit components from bit remote scopes
-tau [bit clipboard push](features/takelage/bit/bit.clipboard.push.feature) | Push all updates of bit components to bit remote scopes
-tau [bit scope add](features/takelage/bit/bit.scope.add.feature) [SCOPE] | Add a bit [SCOPE]
-tau [bit scope inbit](features/takelage/bit/bit.scope.inbit.feature) | Log in to bit remote server
-tau [bit scope list](features/takelage/bit/bit.scope.list.feature) | List bit remote scopes
-tau [bit scope new](features/takelage/bit/bit.scope.new.feature) [SCOPE] | Init a new bit [SCOPE]
-tau [completion bash](features/takelage/completion/completion.bash.feature) | Print bash completion code
-tau [docker check running](features/takelage/docker/docker.check.running.feature) | Check if docker daemon is running
-tau [docker container check existing](features/takelage/docker/docker.container.check.existing.feature) [CONTAINER] | Check if docker [CONTAINER] is existing
-tau [docker container check network](features/takelage/docker/docker.container.check.network.feature) [NETWORK] | Check if docker [NETWORK] is existing
-tau [docker container check orphaned](features/takelage/docker/docker.container.check.orphaned.feature) [CONTAINER] | Check if docker [CONTAINER] is orphaned
-tau [docker container command](features/takelage/docker/docker.container.command.feature) [CMD] | Run [CMD] in a docker container
-tau [docker container daemon](features/takelage/docker/docker.container.daemon.feature) | Run docker container in daemon mode
-tau [docker container login](features/takelage/docker/docker.container.login.feature) | Log in to latest local docker container
-tau [docker container clean](features/takelage/docker/docker.container.clean.feature) | Remove all docker containers
-tau [docker container prune](features/takelage/docker/docker.container.prune.feature) | Remove orphaned docker containers
-tau [docker image check outdated](features/takelage/docker/docker.image.check.outdated.feature) | Check if a docker image is outdated
-tau [docker image tag check local](features/takelage/docker/docker.image.tag.check.local.feature) [TAG] | Check if local docker image [TAG] exists
-tau [docker image tag check remote](features/takelage/docker/docker.image.tag.check.remote.feature) [TAG] | Check if remote docker image [TAG] exists
-tau [docker image tag latest local](features/takelage/docker/docker.image.tag.latest.local.feature) | Print latest local docker image tag
-tau [docker image tag latest remote](features/takelage/docker/docker.image.tag.latest.remote.feature) | Print latest remote docker image tag
-tau [docker image tag list local](features/takelage/docker/docker.image.tag.list.local.feature) | Print local docker image tags
-tau [docker image tag list remote](features/takelage/docker/docker.image.tag.list.remote.feature) | Print remote docker image tags
-tau [docker image update](features/takelage/docker/docker.image.update.feature) | Get latest remote docker container
-tau [docker socket host](features/takelage/docker/docker.socket.host.feature) | Print docker socket host ip address
-tau [docker socket scheme](features/takelage/docker/docker.socket.scheme.feature) | Print docker socket scheme
-tau [docker socket start](features/takelage/docker/docker.socket.start.feature) | Start sockets for docker container
-tau [docker socket stop](features/takelage/docker/docker.socket.stop.feature) | Stop sockets for docker container
-tau [git check clean](features/takelage/git/git.check.clean.feature) | Check if the git workspace is clean
-tau [git check master](features/takelage/git/git.check.master.feature) | Check if we are on the git master branch
-tau [git check workspace](features/takelage/git/git.check.workspace.feature) | Check if a git workspace exists
-tau [info project active](features/takelage/info/info.project.active.feature) | Print active project info
-tau [info project main](features/takelage/info/info.project.main.feature) | Print main project info
-tau [info project private](features/takelage/info/info.project.private.feature) | Print private project info
-tau [self config active](features/takelage/self/self.config.active.feature) | Print active takelage configuration
-tau [self config default](features/takelage/self/self.config.default.feature) | Print takelage default configuration
-tau [self config home](features/takelage/self/self.config.home.feature) | Print takelage home config file configuration
-tau [self config project](features/takelage/self/self.config.project.feature) | Print takelage project config file configuration
-tau [self list](features/takelage/self/self.list.feature) | List all commands
-tau [self version](features/takelage/self/self.version.feature) | Print tau semantic version number
-tau config | Alias for tau [self config active](features/takelage/self/self.config.active.feature)
-tau copy [DIR] [SCOPE] | Alias for tau [bit clipboard copy](features/takelage/bit/bit.clipboard.copy.feature)
-tau list | Alias for tau [self list](features/takelage/self/self.list.feature)
-tau login | Alias for tau [docker container login](features/takelage/docker/docker.container.login.feature)
-tau clean | Alias for tau [docker container clean](features/takelage/docker/docker.container.clean.feature)
-tau paste [COMPONENT] [DIR] | Alias for tau [bit clipboard paste](features/takelage/bit/bit.clipboard.paste.feature)
-tau project | Alias for tau [info project active](features/takelage/info/info.project.active.feature)
-tau pull | Alias for tau [bit clipboard pull](features/takelage/bit/bit.clipboard.pull.feature)
-tau prune | Alias for tau [docker container prune](features/takelage/docker/docker.container.prune.feature)
-tau push | Alias for tau [bit clipboard push](features/takelage/bit/bit.clipboard.push.feature)
-tau update | Alias for tau [docker image update](features/takelage/docker/docker.image.update.feature)
-tau version | Alias for tau [self version](features/takelage/self/self.version.feature)
+tau [bit check workspace](features/cucumber/features/bit/bit.check.workspace.feature) | Check if a bit workspace exists
+tau [bit clipboard copy](features/cucumber/features/bit/bit.clipboard.copy.feature) [DIR] [SCOPE] | Copy new [DIR] to [SCOPE]
+tau [bit clipboard paste](features/cucumber/features/bit/bit.clipboard.paste.feature) [COMPONENT] [DIR] | Paste bit [COMPONENT] into [DIR]
+tau [bit clipboard pull](features/cucumber/features/bit/bit.clipboard.pull.feature) | Pull all updates for bit components from bit remote scopes
+tau [bit clipboard push](features/cucumber/features/bit/bit.clipboard.push.feature) | Push all updates of bit components to bit remote scopes
+tau [bit require export](features/cucumber/features/bit/bit.require.export.feature) | Show requirements file of bit components
+tau [bit require import](features/cucumber/features/bit/bit.require.import.feature) | Import bit components from requirements file
+tau [bit scope add](features/cucumber/features/bit/bit.scope.add.feature) [SCOPE] | Add a bit [SCOPE]
+tau [bit scope inbit](features/cucumber/features/bit/bit.scope.inbit.feature) | Log in to bit remote server
+tau [bit scope list](features/cucumber/features/bit/bit.scope.list.feature) | List bit remote scopes
+tau [bit scope new](features/cucumber/features/bit/bit.scope.new.feature) [SCOPE] | Init a new bit [SCOPE]
+tau [completion bash](features/cucumber/features/completion/completion.bash.feature) | Print bash completion code
+tau [docker check running](features/cucumber/features/docker/docker.check.running.feature) | Check if docker daemon is running
+tau [docker container check existing](features/cucumber/features/docker/docker.container.check.existing.feature) [CONTAINER] | Check if docker [CONTAINER] is existing
+tau [docker container check network](features/cucumber/features/docker/docker.container.check.network.feature) [NETWORK] | Check if docker [NETWORK] is existing
+tau [docker container check orphaned](features/cucumber/features/docker/docker.container.check.orphaned.feature) [CONTAINER] | Check if docker [CONTAINER] is orphaned
+tau [docker container command](features/cucumber/features/docker/docker.container.command.feature) [CMD] | Run [CMD] in a docker container
+tau [docker container daemon](features/cucumber/features/docker/docker.container.daemon.feature) | Run docker container in daemon mode
+tau [docker container login](features/cucumber/features/docker/docker.container.login.feature) | Log in to latest local docker container
+tau [docker container clean](features/cucumber/features/docker/docker.container.clean.feature) | Remove all docker containers
+tau [docker container prune](features/cucumber/features/docker/docker.container.prune.feature) | Remove orphaned docker containers
+tau [docker image check outdated](features/cucumber/features/docker/docker.image.check.outdated.feature) | Check if a docker image is outdated
+tau [docker image tag check local](features/cucumber/features/docker/docker.image.tag.check.local.feature) [TAG] | Check if local docker image [TAG] exists
+tau [docker image tag check remote](features/cucumber/features/docker/docker.image.tag.check.remote.feature) [TAG] | Check if remote docker image [TAG] exists
+tau [docker image tag latest local](features/cucumber/features/docker/docker.image.tag.latest.local.feature) | Print latest local docker image tag
+tau [docker image tag latest remote](features/cucumber/features/docker/docker.image.tag.latest.remote.feature) | Print latest remote docker image tag
+tau [docker image tag list local](features/cucumber/features/docker/docker.image.tag.list.local.feature) | Print local docker image tags
+tau [docker image tag list remote](features/cucumber/features/docker/docker.image.tag.list.remote.feature) | Print remote docker image tags
+tau [docker image update](features/cucumber/features/docker/docker.image.update.feature) | Get latest remote docker container
+tau [docker socket host](features/cucumber/features/docker/docker.socket.host.feature) | Print docker socket host ip address
+tau [docker socket scheme](features/cucumber/features/docker/docker.socket.scheme.feature) | Print docker socket scheme
+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 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 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
+tau [self config default](features/cucumber/features/self/self.config.default.feature) | Print takelage default configuration
+tau [self config home](features/cucumber/features/self/self.config.home.feature) | Print takelage home config file configuration
+tau [self config project](features/cucumber/features/self/self.config.project.feature) | Print takelage project config file configuration
+tau [self list](features/cucumber/features/self/self.list.feature) | List all commands
+tau [self version](features/cucumber/features/self/self.version.feature) | Print tau semantic version number
+tau config | Alias for tau [self config active](features/cucumber/features/self/self.config.active.feature)
+tau copy [DIR] [SCOPE] | Alias for tau [bit clipboard copy](features/cucumber/features/bit/bit.clipboard.copy.feature)
+tau list | Alias for tau [self list](features/cucumber/features/self/self.list.feature)
+tau login | Alias for tau [docker container login](features/cucumber/features/docker/docker.container.login.feature)
+tau clean | Alias for tau [docker container clean](features/cucumber/features/docker/docker.container.clean.feature)
+tau paste [COMPONENT] [DIR] | Alias for tau [bit clipboard paste](features/cucumber/features/bit/bit.clipboard.paste.feature)
+tau project | Alias for tau [info project active](features/cucumber/features/info/info.project.active.feature)
+tau pull | Alias for tau [bit clipboard pull](features/cucumber/features/bit/bit.clipboard.pull.feature)
+tau prune | Alias for tau [docker container prune](features/cucumber/features/docker/docker.container.prune.feature)
+tau push | Alias for tau [bit clipboard push](features/cucumber/features/bit/bit.clipboard.push.feature)
+tau update | Alias for tau [docker image update](features/cucumber/features/docker/docker.image.update.feature)
+tau version | Alias for tau [self version](features/cucumber/features/self/self.version.feature)
 
 **Warning: *tau update* will call *docker image prune* and remove all dangling images!**
 
@@ -113,7 +115,7 @@ tau version | Alias for tau [self version](features/takelage/self/self.version.f
 which have different precedences.
 They are merged to an active configuration during runtime
 which can be inspected with 
-*tau [self config active](features/takelage/self/self.config.active.feature)*
+*tau [self config active](features/cucumber/features/self/self.config.active.feature)*
 or *tau config*.
 
 | Filename | Precedence | Description |
@@ -166,7 +168,7 @@ Furthermore, every external command can be reconfigured.
 which have different precedences.
 They are merged to an active configuration during runtime
 which can be inspected with 
-*tau [info project active](features/takelage/info/info.project.active.feature)*
+*tau [info project active](features/cucumber/features/info/info.project.active.feature)*
 or *tau project*.
 
 | Default filename | Config key | Precedence | Description |
@@ -184,8 +186,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

@@ -38,6 +38,10 @@ require_relative 'takelage/bit/clipboard/paste'
 require_relative 'takelage/bit/clipboard/pull'
 require_relative 'takelage/bit/clipboard/push'
 require_relative 'takelage/bit/clipboard/cli'
+require_relative 'takelage/bit/require/lib'
+require_relative 'takelage/bit/require/export'
+require_relative 'takelage/bit/require/import'
+require_relative 'takelage/bit/require/cli'
 require_relative 'takelage/bit/cli'
 require_relative 'takelage/completion/cli'
 require_relative 'takelage/docker/check/running'
@@ -112,7 +116,7 @@ module Takelage
       # Initialize global singleton project
       initialize_project
 
-      # prepare for the worst
+      # Prepare for the worst
       @docker_daemon_running = false
 
       # fylla bash completion code

data/lib/takelage/bit/cli.rb

@@ -9,6 +9,9 @@ module Takelage
     desc 'clipboard [COMMAND]', 'Manage bit clipboard'
     subcommand 'clipboard', BitClipboard
 
+    desc 'require [COMMAND]', 'Manage bit requirements'
+    subcommand 'require', BitRequire
+
     desc 'scope [COMMAND]', 'Manage bit scopes'
     subcommand 'scope', BitScope
   end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Takelage
-  # takelage bit
+  # takelage bit clipboard
   class BitClipboard < SubCommandBase
     include LoggingModule
     include ConfigModule

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

@@ -9,6 +9,8 @@ module BitClipboardCopy
 
     log.debug "Running bit copy \"#{dir}\" to \"#{scope}\""
 
+    return false unless configured? %w[project_root_dir]
+
     return false unless _bit_clipboard_lib_prepare_workspace
 
     unless File.directory? dir
@@ -43,7 +45,7 @@ module BitClipboardCopy
   end
   # rubocop:enable Metrics/MethodLength
 
-  # touch README.bit if necessary
+  # Touch README.bit if necessary.
   def _bit_clipboard_copy_touch_readme_bit(dir)
     readme_bit = "#{dir}/README.bit"
     return if File.file? readme_bit
@@ -52,7 +54,7 @@ module BitClipboardCopy
     File.open(readme_bit, 'w') {}
   end
 
-  # check if a README.bit file exists in a subdirectory
+  # Check if a README.bit file exists in a subdirectory.
   def _bit_clipboard_copy_readme_bit_exists_in_subdir?(dir)
     Dir.glob("#{dir}/**/README.bit").each do |file|
       unless file == "#{dir}/README.bit"
@@ -64,7 +66,7 @@ module BitClipboardCopy
     false
   end
 
-  # Check if bit scope exists
+  # Check if bit scope exists.
   def _bit_clipboard_copy_dir_scope_exists?(scope)
     bit_dev = config.active['bit_dev_user']
 
@@ -78,7 +80,7 @@ module BitClipboardCopy
     true
   end
 
-  # check if bit.dev remote scope exists
+  # Check if bit.dev remote scope exists.
   def _bit_clipboard_bit_dev_scope_exists(scope)
     cmd_bit_list_scope = format(
       config.active['cmd_bit_clipboard_copy_bit_list_scope'],
@@ -93,7 +95,7 @@ module BitClipboardCopy
     false
   end
 
-  # check if bit remote scope is added to local workspace
+  # Check if bit remote scope is added to local workspace.
   def _bit_clipboard_custom_scope_exists(scope)
     cmd_bit_list_remotes =
       config.active['cmd_bit_clipboard_copy_bit_list_remotes']
@@ -107,7 +109,7 @@ module BitClipboardCopy
     false
   end
 
-  # bit tag dir
+  # bit tag dir.
   def _bit_clipboard_copy_add_dir(id, dir)
     cmd_bit_add_dir = format(
       config.active['cmd_bit_clipboard_copy_bit_add_dir'],
@@ -118,7 +120,7 @@ module BitClipboardCopy
     run cmd_bit_add_dir
   end
 
-  # bit tag dir
+  # bit tag dir.
   def _bit_clipboard_copy_tag_dir(id)
     cmd_bit_tag_id = format(
       config.active['cmd_bit_clipboard_copy_bit_tag_id'],
@@ -128,7 +130,7 @@ module BitClipboardCopy
     run cmd_bit_tag_id
   end
 
-  # bit export component to bit remote scope
+  # bit export component to bit remote scope.
   def _bit_clipboard_copy_export_to_scope(scope)
     cmd_bit_export_to_scope = format(
       config.active['cmd_bit_clipboard_copy_bit_export_to_scope'],

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

@@ -51,30 +51,29 @@ module BitClipboardLib
   def _bit_clipboard_lib_sync_workspace
     log.debug 'Syncing git workspace'
 
-    _rakefile, path = Rake.application.find_rakefile_location
-    bitmap = "#{path}/.bitmap"
+    path = config.active['project_root_dir']
+    file = "#{path}/.bitmap"
+    message = 'Update .bitmap'
 
-    _bit_clipboard_lib_git_add bitmap
-    _bit_clipboard_lib_git_commit bitmap
+    _bit_clipboard_lib_git_add file
+    _bit_clipboard_lib_git_commit message
     _bit_clipboard_lib_git_push
   end
 
-  # git add .bitmap
-  def _bit_clipboard_lib_git_add(bitmap)
-    log.debug "Adding \"#{bitmap}\" to git"
+  # git add .bitmap.
+  def _bit_clipboard_lib_git_add(file)
+    log.debug "Adding \"#{file}\" to git"
 
     cmd_bit_clipboard_git_add = format(
       config.active['cmd_bit_clipboard_git_add'],
-      file: bitmap
+      file: file
     )
     run cmd_bit_clipboard_git_add
   end
 
-  # git commit -m "Update .bitmap"
-  def _bit_clipboard_lib_git_commit(bitmap)
-    message = 'Update .bitmap'
-
-    log.debug "Committing \"#{bitmap}\" to git"
+  # git commit -m "Update .bitmap".
+  def _bit_clipboard_lib_git_commit(message)
+    log.debug "Committing to git with message \"#{message}\""
 
     cmd_bit_clipboard_git_commit = format(
       config.active['cmd_bit_clipboard_git_commit'],
@@ -84,7 +83,7 @@ module BitClipboardLib
     run cmd_bit_clipboard_git_commit
   end
 
-  # git push origin master
+  # git push origin master.
   def _bit_clipboard_lib_git_push
     log.debug 'Pushing master branch to origin'
 
@@ -94,7 +93,7 @@ module BitClipboardLib
     run cmd_bit_clipboard_git_push
   end
 
-  # git pull
+  # git pull.
   def _bit_clipboard_lib_git_pull
     log.debug 'Updating git workspace'
     cmd_bit_clipboard_git_pull =

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

@@ -6,6 +6,8 @@ module BitClipboardPaste
   def bit_clipboard_paste(cid, dir)
     log.debug "Running bit paste \"#{cid}\" to \"#{dir}\""
 
+    return false unless configured? %w[project_root_dir]
+
     return false unless _bit_clipboard_lib_prepare_workspace
 
     return false unless _bit_clipboard_paste_cid_exists? cid
@@ -20,7 +22,7 @@ module BitClipboardPaste
 
   private
 
-  # paste bit component into directory
+  # paste bit component into directory.
   def _bit_clipboard_paste_import_cid(cid, dir)
     cmd_bit_import_cid = format(
       config.active['cmd_bit_clipboard_paste_bit_import_cid'],
@@ -31,6 +33,7 @@ module BitClipboardPaste
     run cmd_bit_import_cid
   end
 
+  # Check if remote component exists.
   def _bit_clipboard_paste_cid_exists?(cid)
     scope = cid.scan(%r{([^/]*).*}).first.first
 
@@ -45,7 +48,7 @@ module BitClipboardPaste
     false
   end
 
-  # get components in remote scope
+  # Get components in remote scope.
   def _bit_clipboard_paste_cid_exists_list_scope(scope)
     cmd_bit_list_scope = format(
       config.active['cmd_bit_clipboard_paste_bit_list_scope'],

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

@@ -6,6 +6,8 @@ module BitClipboardPull
   def bit_clipboard_pull
     log.debug 'Running bit pull'
 
+    return false unless configured? %w[project_root_dir]
+
     return false unless _bit_clipboard_lib_prepare_workspace
 
     _bit_clipboard_pull_import_all
@@ -19,7 +21,7 @@ module BitClipboardPull
 
   private
 
-  # bit import components into workspace
+  # bit import components into workspace.
   def _bit_clipboard_pull_import_all
     cmd_bit_import_all =
       config.active['cmd_bit_clipboard_pull_bit_import_all']
@@ -27,7 +29,7 @@ module BitClipboardPull
     run cmd_bit_import_all
   end
 
-  # checkout components and merge them
+  # Checkout components and merge them.
   def _bit_clipboard_pull_checkout_all
     cmd_bit_checkout_all =
       config.active['cmd_bit_clipboard_pull_bit_checkout_all']

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

@@ -2,10 +2,12 @@
 
 # takelage bit clipboard push
 module BitClipboardPush
-  # Backend method for bit push
+  # Backend method for bit push.
   def bit_clipboard_push
     log.debug 'Running bit push'
 
+    return false unless configured? %w[project_root_dir]
+
     return false unless _bit_clipboard_lib_prepare_workspace
 
     _bit_clipboard_push_tag_all
@@ -19,7 +21,7 @@ module BitClipboardPush
 
   private
 
-  # bit tag all components
+  # bit tag all components.
   def _bit_clipboard_push_tag_all
     cmd_bit_tag_all =
       config.active['cmd_bit_clipboard_push_bit_tag_all']
@@ -27,7 +29,7 @@ module BitClipboardPush
     run cmd_bit_tag_all
   end
 
-  # bit export components
+  # bit export components.
   def _bit_clipboard_push_export_all
     cmd_bit_export_all =
       config.active['cmd_bit_clipboard_push_bit_export_all']

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage bit requiere
+  class BitRequire < SubCommandBase
+    include LoggingModule
+    include ConfigModule
+    include SystemModule
+    include GitCheckClean
+    include GitCheckMaster
+    include GitCheckWorkspace
+    include BitCheckWorkspace
+    include BitScopeList
+    include BitScopeAdd
+    include BitClipboardLib
+    include BitClipboardCopy
+    include BitClipboardPaste
+    include BitRequireLib
+    include BitRequireExport
+    include BitRequireImport
+
+    # Initialize bit require
+    def initialize(args = [], local_options = {}, configuration = {})
+      # initialize thor parent class
+      super args, local_options, configuration
+
+      @bit_require_file = config.active['bit_require_file']
+    end
+
+    #
+    # bit require export
+    #
+    desc 'export', 'Create requirements file with bit components.'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Create requirements file with bit components
+    LONGDESC
+    # Create requirements file with bit components.
+    def export
+      bit_require_yml = bit_require_export
+      exit false if bit_require_yml == false
+      say bit_require_yml
+      true
+    end
+
+    #
+    # bit require import
+    #
+    desc 'import', 'Import bit components from requirements file.'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Import bit components from requirements file
+    LONGDESC
+    # Import bit components from requirements file.
+    def import
+      exit bit_require_import
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# takelage bit require export
+module BitRequireExport
+  # Backend method for bit require export.
+  def bit_require_export
+    log.debug 'Running bit require export'
+
+    return false unless configured? %w[project_root_dir]
+
+    components = _bit_require_lib_get_components
+    bitrequire_yml = _bit_require_export_get_bitrequire_yml components
+
+    log.debug "bitrequire.yml of this project:\n#{bitrequire_yml}"
+    bitrequire_yml
+  end
+
+  private
+
+  # Create contents of bitrequire yaml file.
+  # rubocop:disable Metrics/AbcSize
+  def _bit_require_export_get_bitrequire_yml(components)
+    bitrequire = {}
+    components.each do |component|
+      scope = component['id'].clone.gsub!(%r{/.*}, '')
+      name = component['id'].clone.gsub!(%r{#{scope}/}, '')
+      bitrequire['scopes'] = { scope => [] } if bitrequire['scopes'].nil?
+      bitrequire['scopes'][scope] = [] unless bitrequire['scopes'].key? scope
+      bitrequire['scopes'][scope] << { 'name' => name }
+    end
+    hash_to_yaml bitrequire
+  end
+  # rubocop:enable Metrics/AbcSize
+end

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

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+# takelage bit require import
+module BitRequireImport
+  # Backend method for bit require import.
+  def bit_require_import
+    log.debug 'Running bit require import'
+
+    return false unless configured? %w[project_root_dir]
+
+    return false unless _bit_clipboard_lib_prepare_workspace
+
+    return false unless _bit_require_import_check_require_file_exists
+
+    scopes = _bit_require_import_get_scopes_and_components
+    return false unless scopes
+
+    components = _bit_require_import_get_components scopes
+    return false unless components
+
+    return false unless _bit_require_import_add_scopes scopes
+
+    _bit_require_import_paste_components components
+  end
+
+  private
+
+  # Check if a bit requirements file exists.
+  def _bit_require_import_check_require_file_exists
+    return true if File.exist? @bit_require_file
+
+    log.error "No #{@bit_require_file} file found"
+    false
+  end
+
+  # Get scopes and components from requirements file.
+  def _bit_require_import_get_scopes_and_components
+    bit_require = read_yaml_file(@bit_require_file)
+    return bit_require['scopes'] if bit_require.key?('scopes')
+
+    log.error "No scopes in #{@bit_require_file} file"
+    false
+  end
+
+  # Get flat components array.
+  def _bit_require_import_get_components(scopes)
+    components_all = []
+    scopes.each do |scope, components|
+      scope_components = _bit_require_import_get_scope_components scope, components
+      return false unless scope_components
+
+      components_all |= scope_components
+    end
+    components_all
+  end
+
+  # Get bit components of a scope.
+  def _bit_require_import_get_scope_components(scope, components)
+    scope_components = []
+    components.each do |component|
+      return false unless _bit_require_import_check_component_valid component, scope
+
+      name = component['name']
+      path = name
+      path = component['path'] if component.key?('path')
+      scope_components << { name: name, path: path, scope: scope }
+      log.debug "Identified bit component \"#{name}\" with path \"#{path}\" in scope \"#{scope}\""
+    end
+    scope_components
+  end
+
+  # Check if there are bit components
+  def _bit_require_import_check_component_valid(component, scope)
+    return true if (component.class == Hash) && component.key?('name')
+
+    log.error "No component in #{scope}"
+    false
+  end
+
+  # Add bit scopes to workspace.
+  def _bit_require_import_add_scopes(scopes)
+    scopes.each do |scope, _components|
+      bit_scope_add scope unless _bit_clipboard_bit_dev_scope_exists scope
+    end
+  end
+
+  # Paste bit components.
+  def _bit_require_import_paste_components(components)
+    path = config.active['project_root_dir']
+    return false if path.empty?
+
+    components.each do |component|
+      next if _bit_require_import_check_component_exists component, path
+
+      return false unless _bit_require_import_paste_component component
+
+      _bit_require_import_commit_component component, path
+    end
+    true
+  end
+
+  # Check if there are bit components
+  def _bit_require_import_check_component_exists(component, path)
+    scope = component[:scope]
+    cid = component[:name]
+    dir = component[:path]
+    dest = "#{path}/#{dir}"
+    cids = _bit_require_lib_get_components_ids
+    return false unless cids.include? "#{scope}/#{cid}"
+
+    log.warn "Skipping existing bit component \"#{scope}/#{cid}\" with path \"#{dest}\""
+    true
+  end
+
+  # Paste a bit component
+  def _bit_require_import_paste_component(component)
+    scope = component[:scope]
+    cid = component[:name]
+    dir = component[:path]
+    bit_clipboard_paste "#{scope}/#{cid}", dir
+  end
+
+  # Commit a bit component
+  def _bit_require_import_commit_component(component, path)
+    scope = component[:scope]
+    cid = component[:name]
+    dir = component[:path]
+    dest = "#{path}/#{dir}"
+    message = "Add bit component \"#{scope}/#{cid}\" to path \"#{dest}\""
+    _bit_clipboard_lib_git_add dest
+    _bit_clipboard_lib_git_commit message
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# takelage bit require lib
+module BitRequireLib
+  private
+
+  # Get bit components.
+  def _bit_require_lib_get_components
+    cmd_bit_list = config.active['cmd_bit_require_lib_bit_list']
+    bit_list = run cmd_bit_list
+    JSON.parse bit_list
+  end
+
+  # Get bit components ids.
+  def _bit_require_lib_get_components_ids
+    cmd_bit_list_ids = config.active['cmd_bit_require_lib_bit_list_ids']
+    run cmd_bit_list_ids
+  end
+end

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

@@ -9,7 +9,7 @@ module BitScopeList
 
     return false unless configured? %w[bit_ssh bit_remote]
 
-    # get ssh command from active config
+    # get ssh command from active config.
     cmd_bit_ssh =
       config.active['bit_ssh']
 
@@ -17,7 +17,7 @@ module BitScopeList
 
     cmd_bit_scope_list = _bit_scope_list_cmd root
 
-    # run ssh command with scope list command
+    # run ssh command with scope list command.
     scope_list = run "#{cmd_bit_ssh} '#{cmd_bit_scope_list}'"
 
     # remove bit remote root directory from results

data/lib/takelage/default.yml

@@ -1,6 +1,7 @@
 ---
 bit_dev_user: 'takelage'
 bit_remote: ''
+bit_require_file: 'bitrequire.yml'
 bit_root: '/bit'
 bit_ssh: ''
 cmd_bit_check_workspace_bit_list: 'bit list'
@@ -20,6 +21,9 @@ cmd_bit_clipboard_pull_bit_import_all: 'bit import --ignore-package-json --ignor
 cmd_bit_clipboard_pull_bit_checkout_all: 'bit checkout --ignore-package-json --ignore-dist --skip-update --skip-npm-install --all latest'
 cmd_bit_clipboard_push_bit_tag_all: 'bit tag --skip-update --skip-tests --all'
 cmd_bit_clipboard_push_bit_export_all: 'bit export --skip-update --all'
+cmd_bit_clipboard_export_bit_list: 'bit list --skip-update --json %{scope}'
+cmd_bit_require_lib_bit_list: 'bit list --skip-update --json'
+cmd_bit_require_lib_bit_list_ids: 'bit list --skip-update --json --ids'
 cmd_bit_scope_add_scope: 'bit remote add %{remote}/%{scope}'
 cmd_bit_scope_list_find_scopes: 'find -L %{root} -name scope.json'
 cmd_bit_scope_new_bit_init: 'mkdir -p %{root}/%{scope} && cd %{root}/%{scope} && bit init --bare'

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

@@ -22,6 +22,7 @@ module DockerContainerCheckExisting
 
   private
 
+  # Format command to check if docker container exists.
   def _docker_container_cmd_check_existing(container)
     format(
       config.active['cmd_docker_container_check_existing_docker_ps'],

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

@@ -22,6 +22,7 @@ module DockerContainerCheckNetwork
 
   private
 
+  # Prepare command to check if docker network exists.
   def _docker_container_cmd_check_network(network)
     format(
       config.active['cmd_docker_container_check_network_docker_network'],

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

@@ -22,6 +22,7 @@ module DockerContainerCheckOrphaned
 
   private
 
+  # Format command to check if docker container is orphaned.
   def _docker_container_cmd_check_orphaned(container)
     format(
       config.active['cmd_docker_container_check_orphaned_docker_exec'],

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

@@ -16,7 +16,7 @@ module DockerContainerClean
 
   private
 
-  # Check if we are running tau clean inside a takelage container
+  # Check if we are running tau clean inside a takelage container.
   def _docker_container_clean_harakiri?
     hostname = ENV['HOSTNAME'] || ''
     return false unless hostname.start_with? "#{@docker_repo}_"
@@ -26,7 +26,7 @@ module DockerContainerClean
     true
   end
 
-  # Kill all docker containers and return list of networks
+  # Kill all docker containers and return list of networks.
   def _docker_container_clean_kill_existing_containers
     networks = []
     _docker_container_lib_get_containers.each do |container|

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

@@ -8,6 +8,8 @@ module DockerContainerLib
 
   # Create docker container and network.
   def _docker_container_lib_create_net_and_ctr(name)
+    return false if _docker_container_lib_check_matrjoschka
+
     unless docker_container_check_network name
       _docker_container_lib_create_network name
     end
@@ -56,8 +58,6 @@ module DockerContainerLib
   def _docker_container_lib_create_container(container)
     log.debug "Creating container \"#{container}\""
 
-    return false if _docker_container_lib_check_matrjoschka
-
     image = "#{@docker_user}/#{@docker_repo}:#{@docker_tag}"
 
     return false unless _docker_container_lib_image_available? image
@@ -105,10 +105,12 @@ module DockerContainerLib
 
   # Check if we are already inside a takelage container
   def _docker_container_lib_check_matrjoschka
-    return false unless ENV['HOSTNAME'].start_with? @docker_repo
+    log.debug 'Checking if we are already inside a takelage container'
+
+    return false unless ENV.keys.include? 'TAKELAGE_PROJECT_BASE_DIR'
 
     log.error 'You cannot log in to takelage from within takelage'
-    false
+    true
   end
 
   # Check if docker image is available

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

@@ -14,7 +14,7 @@ module DockerContainerPrune
 
   private
 
-  # Kill orphaned docker containers and return list of networks
+  # Kill orphaned docker containers and return list of networks.
   def _docker_container_prune_kill_orphaned_containers
     networks = []
 

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

@@ -23,7 +23,7 @@ module DockerSocketLib
     cmds_start_socket
   end
 
-  # Get socket start command
+  # Get socket start command.
   def _docker_socket_lib_get_start_cmd(mode, socket, host, port, path)
     if mode == 'start'
       unless _docker_socket_lib_socket_up? socket, host, port, path
@@ -45,7 +45,7 @@ module DockerSocketLib
     )
   end
 
-  # Check if a socket is available by trying to connect to it via TCP
+  # Check if a socket is available by trying to connect to it via TCP.
   def _docker_socket_lib_socket_up?(socket, host, port, path)
     error_message = _docker_socket_lib_error_msg socket, host, port, path
     begin

data/lib/takelage/lib/config.rb

@@ -19,15 +19,20 @@ module ConfigModule
   end
 
   # Initialze config
+  # rubocop:disable Metrics/AbcSize
   def initialize_config
+    project_root_dir = _get_project_root_dir
+
     log.debug "takelage version: #{Takelage::VERSION}"
     log.debug "Current working directory: #{Dir.pwd}"
+    log.debug "Project root directory: #{project_root_dir}" unless project_root_dir.empty?
 
-    TakelageConfig.instance.default = _config_read_default
+    TakelageConfig.instance.default = _config_read_default project_root_dir
     TakelageConfig.instance.home = _config_read_home
-    TakelageConfig.instance.project = _config_read_project
+    TakelageConfig.instance.project = _config_read_project project_root_dir
     TakelageConfig.instance.active = _config_merge_active
   end
+  # rubocop:enable Metrics/AbcSize
 
   # @return [Object] global singleton config
   def config
@@ -55,24 +60,30 @@ module ConfigModule
     false
   end
 
-  # Check if config key is nil or empty
+  # 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}\""
+    if config_key == 'project_root_dir'
+      log.error 'Please create a "Rakefile" in the project root directory'
+    else
+      log.error "Unset config key. Please configure \"#{config_key}\""
+    end
     @configured = false
     false
   end
 
   # Read default config file in lib.
-  def _config_read_default
+  def _config_read_default(project_root_dir)
     default_file = File.expand_path("#{File.dirname(__FILE__)}/../default.yml")
 
-    return {} unless File.exist? default_file
+    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
 
@@ -82,24 +93,19 @@ 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 next to Rakefile.
-  def _config_read_project
-    _rakefile, path = Rake.application.find_rakefile_location
-    project_file = "#{path}/takelage.yml"
+  # 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
 
-    project_yaml = read_yaml_file(project_file) || {}
-
-    project_yaml.sort.to_h
+    (read_yaml_file(project_file) || {}).sort.to_h
   end
 
-  # Merge active config
+  # Merge active config.
   def _config_merge_active
     # make a clone or else we'll change the original hash
     default = TakelageConfig.instance.default.clone
@@ -111,4 +117,14 @@ module ConfigModule
     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/takelage/lib/logging.rb

@@ -28,12 +28,14 @@ module LoggingModule
 
   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

data/lib/takelage/lib/project.rb

@@ -34,24 +34,24 @@ module ProjectModule
 
   # Read main YAML file.
   def _project_read_main
-    _rakefile, @path = Rake.application.find_rakefile_location
-    main_file = "#{@path}/" \
+    path = TakelageProject.instance.config.active['project_root_dir']
+    main_file = "#{path}/" \
         "#{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
-    _rakefile, @path = Rake.application.find_rakefile_location
-    private_file = "#{@path}/" \
+    path = TakelageProject.instance.config.active['project_root_dir']
+    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 = read_yaml_erb_file(private_file) || {}
 
     private_yaml.sort.to_h
   end

data/lib/takelage/lib/subcmd.rb

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

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,19 +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.19.1
+0.21.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: takelage
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.21.0
 platform: ruby
 authors:
 - Geospin
@@ -214,6 +214,10 @@ files:
 - lib/takelage/bit/clipboard/paste.rb
 - lib/takelage/bit/clipboard/pull.rb
 - lib/takelage/bit/clipboard/push.rb
+- lib/takelage/bit/require/cli.rb
+- lib/takelage/bit/require/export.rb
+- lib/takelage/bit/require/import.rb
+- lib/takelage/bit/require/lib.rb
 - lib/takelage/bit/scope/add.rb
 - lib/takelage/bit/scope/cli.rb
 - lib/takelage/bit/scope/inbit.rb
@@ -284,7 +288,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="