takelage 0.18.1

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage bit check
+  class BitCheck < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include BitCheckWorkspace
+
+    #
+    # bit check workspace
+    #
+    desc 'workspace', 'Check if a bit workspace exists'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if a bit workspace exists
+    LONGDESC
+    # Check if a bit workspace exists.
+    def workspace
+      exit bit_check_workspace
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# takelage bit check workspace
+module BitCheckWorkspace
+  # Backend method for bit check workspace.
+  # @return [Boolean] is this a bit workspace?
+  def bit_check_workspace
+    log.debug 'Check if this is a bit workspace'
+
+    status_repo = _bit_check_workspace_bit_repo
+    return true if status_repo.exitstatus.zero?
+
+    dir = _bit_check_workspace_dir
+    log.debug "No bit workspace found in \"#{dir}\""
+    false
+  end
+
+  private
+
+  # Check bit repo.
+  def _bit_check_workspace_bit_repo
+    cmd_bit_repo =
+      config.active['cmd_bit_check_workspace_bit_list']
+
+    try cmd_bit_repo
+  end
+
+  # Get current working directory.
+  def _bit_check_workspace_dir
+    cmd_pwd =
+      config.active['cmd_bit_check_workspace_pwd']
+
+    stdout_str_dir = run cmd_pwd
+
+    stdout_str_dir.strip
+  end
+end

data/lib/takelage/bit/cli.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage bit
+  class Bit < SubCommandBase
+    desc 'check [COMMAND]', 'Check bit state'
+    subcommand 'check', BitCheck
+
+    desc 'clipboard [COMMAND]', 'Manage bit clipboard'
+    subcommand 'clipboard', BitClipboard
+
+    desc 'scope [COMMAND]', 'Manage bit scopes'
+    subcommand 'scope', BitScope
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage bit
+  class BitClipboard < SubCommandBase
+    include LoggingModule
+    include ConfigModule
+    include SystemModule
+    include GitCheckClean
+    include GitCheckMaster
+    include GitCheckWorkspace
+    include BitCheckWorkspace
+    include BitClipboardLib
+    include BitClipboardCopy
+    include BitClipboardPaste
+    include BitClipboardPull
+    include BitClipboardPush
+
+    #
+    # bit copy
+    #
+    desc 'copy [DIR] [SCOPE]', 'Copy new [DIR] to [SCOPE]'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Copy a directory as a bit component to a bit remote scope
+    This command will add a directory as a bit component and tag it.
+    The id of the component will be created from the directory name.
+    The directory needs to contain a README.bit file
+    or else a new README.bit file will be created.
+    The README.bit will be the main file of the component which must not be deleted.
+    The tagged bit component will be exported to a bit remote scope.
+    LONGDESC
+    # Copy a file or directory as a bit component to a bit remote scope.
+    def copy(dir_or_file, scope)
+      exit bit_clipboard_copy dir_or_file, scope
+    end
+
+    #
+    # bit paste
+    #
+    desc 'paste [COMPONENT] [DIR]', 'Paste bit [COMPONENT] into [DIR]'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Paste a bit component into a directory
+    LONGDESC
+    # Paste a bit component into a directory.
+    def paste(cid, dir)
+      exit bit_clipboard_paste cid, dir
+    end
+
+    #
+    # bit pull
+    #
+    desc 'pull', 'Pull all updates for bit components from bit remote scopes'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Pull all updates for bit components from bit remote scopes
+    LONGDESC
+    # Pull all updates for bit components from bit remote scopes.
+    def pull
+      exit bit_clipboard_pull
+    end
+
+    #
+    # bit push
+    #
+    desc 'push', 'Push all updates of bit components to bit remote scopes'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Push all updates of bit components to bit remote scopes
+    LONGDESC
+    # Push all updates of bit components to bit remote scopes.
+    def push
+      exit bit_clipboard_push
+    end
+  end
+end

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

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+# takelage bit clipboard copy
+module BitClipboardCopy
+  # Backend method for bit copy.
+  def bit_clipboard_copy(dir, scope)
+    # remove trailing slash
+    dir = dir.chomp('/')
+
+    log.debug "Running bit copy \"#{dir}\" to \"#{scope}\""
+
+    return false unless _bit_clipboard_lib_prepare_workspace
+
+    unless File.directory? dir
+      log.error "The directory \"#{dir}\" does not exist"
+      return false
+    end
+
+    _bit_clipboard_copy_dir dir, scope
+  end
+
+  private
+
+  # rubocop:disable Metrics/MethodLength
+  def _bit_clipboard_copy_dir(dir, scope)
+    log.debug "Adding the directory \"#{dir}\" as a tagged bit component"
+
+    return false unless _bit_clipboard_copy_dir_scope_exists? scope
+
+    return false if _bit_clipboard_copy_readme_bit_exists_in_subdir? dir
+
+    id = _bit_clipboard_lib_id(dir)
+
+    _bit_clipboard_copy_touch_readme_bit dir
+    _bit_clipboard_copy_add_dir id, dir
+    _bit_clipboard_copy_tag_dir id
+    _bit_clipboard_copy_export_to_scope scope
+    _bit_clipbpard_lib_remove_bit_artifacts
+    _bit_clipboard_lib_sync_workspace
+
+    log.info "Copied directory \"#{dir}\" as bit component \"#{id}\" " \
+             "to bit remote scope \"#{scope}\""
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  # touch README.bit if necessary
+  def _bit_clipboard_copy_touch_readme_bit(dir)
+    readme_bit = "#{dir}/README.bit"
+    return if File.file? readme_bit
+
+    log.info "Creating \"README.bit\" in \"#{dir}\""
+    File.open(readme_bit, 'w') {}
+  end
+
+  # 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"
+        log.error 'Nested README.bit file detected'
+        return true
+      end
+    end
+
+    false
+  end
+
+  # Check if bit scope exists
+  def _bit_clipboard_copy_dir_scope_exists?(scope)
+    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 + '.'
+      return false unless _bit_clipboard_bit_dev_scope_exists scope
+    else
+      return false unless _bit_clipboard_custom_scope_exists scope
+    end
+
+    true
+  end
+
+  # 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'],
+      scope: scope
+    )
+
+    status = try cmd_bit_list_scope
+
+    return true if status.exitstatus.zero?
+
+    log.error "No bit.dev remote scope \"#{scope}\" found"
+    false
+  end
+
+  # 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']
+
+    stdout_str = run cmd_bit_list_remotes
+
+    return true if /.*\s+#{scope}\s+.*/m.match? stdout_str
+
+    log.error "No bit remote scope \"#{scope}\" " \
+                    'found in local bit workspace'
+    false
+  end
+
+  # 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'],
+      id: id,
+      dir: dir
+    )
+
+    run cmd_bit_add_dir
+  end
+
+  # bit tag dir
+  def _bit_clipboard_copy_tag_dir(id)
+    cmd_bit_tag_id = format(
+      config.active['cmd_bit_clipboard_copy_bit_tag_id'],
+      id: id
+    )
+
+    run cmd_bit_tag_id
+  end
+
+  # 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'],
+      scope: scope
+    )
+
+    run cmd_bit_export_to_scope
+  end
+end

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

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+# takelage bit clipboard lib
+module BitClipboardLib
+  private
+
+  # Prepare workspace for bit clipboard.
+  def _bit_clipboard_lib_prepare_workspace
+    unless bit_check_workspace
+      log.error 'No bit workspace'
+      return false
+    end
+
+    return true unless git_check_workspace
+
+    _bit_clipboard_lib_prepare_git_workspace
+  end
+
+  # Prepare git workspace for bit clipboard.
+  def _bit_clipboard_lib_prepare_git_workspace
+    unless git_check_master
+      log.error 'Not on git master branch'
+      return false
+    end
+
+    unless git_check_clean
+      log.error 'No clean git workspace'
+      return false
+    end
+
+    _bit_clipboard_lib_git_pull
+  end
+
+  # Remove bit artifacts.
+  def _bit_clipbpard_lib_remove_bit_artifacts
+    log.debug 'Removing bit artifacts'
+
+    # Remove node_modules directory.
+    FileUtils.remove_entry_secure('node_modules', force: true)
+
+    # Remove index.bit files recursively.
+    Dir.glob('./**/index.bit').each do |file|
+      FileUtils.remove_entry_secure(file, force: true)
+    end
+
+    # Remove package.json file.
+    FileUtils.remove_entry_secure('package.json', force: true)
+  end
+
+  # Sync workspace with upstream.
+  def _bit_clipboard_lib_sync_workspace
+    log.debug 'Syncing git workspace'
+
+    _rakefile, path = Rake.application.find_rakefile_location
+    bitmap = "#{path}/.bitmap"
+
+    _bit_clipboard_lib_git_add bitmap
+    _bit_clipboard_lib_git_commit bitmap
+    _bit_clipboard_lib_git_push
+  end
+
+  # git add .bitmap
+  def _bit_clipboard_lib_git_add(bitmap)
+    log.debug "Adding \"#{bitmap}\" to git"
+
+    cmd_bit_clipboard_git_add = format(
+      config.active['cmd_bit_clipboard_git_add'],
+      file: bitmap
+    )
+    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"
+
+    cmd_bit_clipboard_git_commit = format(
+      config.active['cmd_bit_clipboard_git_commit'],
+      message: message
+    )
+
+    run cmd_bit_clipboard_git_commit
+  end
+
+  # git push origin master
+  def _bit_clipboard_lib_git_push
+    log.debug 'Pushing master branch to origin'
+
+    cmd_bit_clipboard_git_push =
+      config.active['cmd_bit_clipboard_git_push']
+
+    run cmd_bit_clipboard_git_push
+  end
+
+  # 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']
+
+    return true if try cmd_bit_clipboard_git_pull
+
+    log.error 'Unable to update git workspace'
+    false
+  end
+
+  # Generate bit component ID.
+  def _bit_clipboard_lib_id(name)
+    id = ''
+
+    # bit restrictions:
+    # component names can only contain alphanumeric,
+    # lowercase characters, and the following ["-", "_", "$", "!", "/"]
+
+    # convert directory name to lowercase characters
+    dir_downcase = name.downcase
+
+    # construct array of allowed characters
+    allowed_chars = [*('a'..'z'), *('0'..'9'), '-', '_', '$', '!', '/']
+
+    # iterate over directory or file name
+    # and replace invalid characters with underscore
+    dir_downcase.split('').each do |char|
+      id += allowed_chars.include?(char) ? char : '_'
+    end
+
+    log.debug "Generated bit id \"#{id}\" from \"#{name}\""
+    id
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# takelage bit clipboard paste
+module BitClipboardPaste
+  # Backend method for bit paste.
+  def bit_clipboard_paste(cid, dir)
+    log.debug "Running bit paste \"#{cid}\" to \"#{dir}\""
+
+    return false unless _bit_clipboard_lib_prepare_workspace
+
+    return false unless _bit_clipboard_paste_cid_exists? cid
+
+    _bit_clipboard_paste_import_cid cid, dir
+    _bit_clipbpard_lib_remove_bit_artifacts
+    _bit_clipboard_lib_sync_workspace
+
+    log.info "Pasted bit component \"#{cid}\" to directory \"#{dir}\""
+    true
+  end
+
+  private
+
+  # 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'],
+      cid: cid,
+      dir: dir
+    )
+
+    run cmd_bit_import_cid
+  end
+
+  def _bit_clipboard_paste_cid_exists?(cid)
+    scope = cid.scan(%r{([^/]*).*}).first.first
+
+    log.debug "Checking if scope \"#{scope}\" " \
+              "contains component id \"#{cid}\""
+
+    bit_list_scope = _bit_clipboard_paste_cid_exists_list_scope scope
+
+    return true if bit_list_scope.include? '"id": "' + cid + '",'
+
+    log.error "No remote component \"#{cid}\""
+    false
+  end
+
+  # 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'],
+      scope: scope
+    )
+
+    run cmd_bit_list_scope
+  end
+end