takelage 0.1.0

data/lib/takelage/lib/system.rb

@@ -0,0 +1,107 @@
+require 'pathname'
+require 'open3'
+require 'yaml'
+
+
+# Interaction with the operating system
+module SystemModule
+
+  # Run a command and return the result.
+  # @return [Boolean] success of command run
+  def run_and_check(command)
+    log.debug "Running command '#{command}'"
+    stdout_str, stderr_str, status = Open3.capture3 command
+    return stdout_str, stderr_str, status
+  end
+
+  # Print hash as yaml.
+  def hash_to_yaml(hash)
+    if hash == {}
+      return nil.to_yaml
+    end
+    return hash.to_yaml
+  end
+
+  # @return [Hash] content of yaml file
+  def read_yaml_file(file)
+    log.debug "Reading YAML file \"#{file}\""
+
+    # Check file existenc
+    unless File.exists? file
+      log.debug "File \"#{file}\" doesn't exist"
+      return nil
+    end
+
+    # Read file
+    begin
+      content_yaml =  File.read file
+    rescue
+      log.debug "Unable to read file \"#{file}\""
+      return nil
+    end
+
+    # Parse YAML
+    begin
+      content = YAML.load content_yaml
+    rescue
+      log.debug "Invalid YAML file \"#{file}\""
+      log.debug "Try: yamllint #{file}"
+      return nil
+    end
+
+    content
+  end
+
+  # Remove directory tree.
+  def rm_fr(directory)
+    unless File.directory? directory
+      log.error "Cannot remove non-existing directory \"#{directory}\""
+      return
+    end
+    log.debug "Removing directory \"#{directory}\" recursively"
+    Pathname.new(directory).rmtree
+  end
+
+  # Run a command.
+  # @return [String] stdout of command
+  def run(command, realtime=false)
+    log.debug "Running command '#{command}'"
+    stdout_str = ''
+    stderr_str = ''
+    status = ''
+    exitstatus = -1
+    Open3.popen3 command do |stdin, stdout, stderr, thread|
+      stdout.each do |line|
+        say line if realtime
+        stdout_str += line
+      end
+      stderr_str = stderr
+      status = thread.value
+      exitstatus = thread.value.exitstatus
+    end
+    unless status.success?
+      log.error "Command \"#{command}\" failed!"
+      log.debug "status: #{status}"
+      log.debug "stdout: #{stdout_str}"
+      log.debug "stderr: #{stderr_str}"
+      exit exitstatus
+    end
+    stdout_str
+  end
+
+  # Use Kernel#exec to replace the ruby process with a command.
+  def run_and_exit(command)
+    log.debug "Running command '#{command}' and exiting afterwards"
+    exec command
+  end
+
+  # Use Kernel#fork and Kernel#exec to run a command as a background process.
+  def run_and_fork(command)
+    log.debug "Running command '#{command}' as a background process"
+    job = fork do
+      exec command
+    end
+    Process.detach(job)
+  end
+
+end

data/lib/takelage/self/cli.rb

@@ -0,0 +1,40 @@
+module Takelage
+
+  # semantic version number
+  VERSION = (File.read "#{File.dirname(__FILE__)}/../version").chomp
+
+  # takelage self
+  class Self < SubCommandBase
+
+    include LoggingModule
+    include SelfModule
+
+    desc 'config [COMMAND]', 'Manage takelage configuration'
+    subcommand 'config', SelfConfig
+
+    #
+    # self list
+    #
+    desc 'list', 'List all commands'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    List all commands
+    LONGDESC
+    # List all commands.
+    def list
+      self_list
+    end
+
+    #
+    # self version
+    #
+    desc 'version', 'Print takelage semantic version number'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print takelage semantic version number
+    LONGDESC
+    #Print takelage semantic version number.
+    # @return [String] semantic version number
+    def version
+      say VERSION
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module Takelage
+
+  # takelage bit
+  class SelfConfig < SubCommandBase
+
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+
+    #
+    # config defaults
+    #
+    desc 'default', 'Print takelage default configuration'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print takelage default configuration
+    This command will print the takelage default configuration in YAML format.
+    You can use it as a starting point for your own configuration by
+    redirecting the output to your local takelage configuration file
+    (which is by default ~/.takelage.yml):
+
+    takelage self config defaults > ~/.takelage.yml
+    LONGDESC
+    # Print takelage default configuration.
+    def default
+      say hash_to_yaml(config.default)
+    end
+
+    #
+    # config home
+    #
+    desc 'home', 'Print takelage home config file configuration'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print takelage home config file configuration
+    This command will print the configuration read from the takelage 
+    configuration file in your home directory ~/.takelage.yml).
+    LONGDESC
+    # Print takelage home config file configuration.
+    def home
+      say hash_to_yaml(config.home)
+    end
+
+    #
+    # config project
+    #
+    desc 'project', 'Print takelage project config file configuration'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print takelage project config file configuration
+    This command will print the configuration read from the takelage 
+    configuration file .takelage.yml in your home directory).
+    LONGDESC
+    # Print takelage home config file configuration.
+    def project
+      say hash_to_yaml(config.project)
+    end
+
+    #
+    # config active
+    #
+    desc 'active', 'Print active takelage configuration'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print active takelage configuration
+    This command will print the configuration read from the takelage 
+    configuration file (which is by default ~/.takelage.yml).
+    LONGDESC
+    # Print active takelage configuration.
+    def active
+      say hash_to_yaml(config.active)
+    end
+  end
+end

data/lib/takelage/self/module.rb

@@ -0,0 +1,26 @@
+# takelage self
+module SelfModule
+
+  # Backend method for config self.
+  def self_list
+
+    # use Thorfile which requires relative takelage.rb
+    thorfile_dir = "#{File.dirname(__FILE__)}/../"
+
+    # use thor list to get the list of commands and subcommands
+    cmd_thor_list = "bash -c '" +
+        "cd #{thorfile_dir} && " +
+        "thor list" +
+        "'"
+    thor_list = `#{cmd_thor_list}`
+
+    # manipulate thor list output
+    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/, ''
+
+    say thor_list
+  end
+end

data/lib/takelage/version

@@ -0,0 +1 @@
+0.1.0

data/lib/takelage.rb

@@ -0,0 +1,198 @@
+require 'etc'
+require 'fileutils'
+require 'fylla'
+require 'json'
+require 'logger'
+require 'net/http'
+require 'rake'
+require 'socket'
+require 'thor'
+require 'timeout'
+require 'yaml'
+
+require_relative 'takelage/lib/logging'
+require_relative 'takelage/lib/subcmd'
+require_relative 'takelage/lib/system'
+require_relative 'takelage/lib/config'
+require_relative 'takelage/lib/project'
+
+require_relative 'takelage/git/check/module'
+require_relative 'takelage/git/check/cli'
+require_relative 'takelage/git/cli'
+require_relative 'takelage/bit/scope/module'
+require_relative 'takelage/bit/scope/cli'
+require_relative 'takelage/bit/clipboard/module'
+require_relative 'takelage/bit/clipboard/cli'
+require_relative 'takelage/bit/cli'
+require_relative 'takelage/completion/cli'
+require_relative 'takelage/docker/socket/module'
+require_relative 'takelage/docker/socket/cli'
+require_relative 'takelage/docker/image/tag/list/module'
+require_relative 'takelage/docker/image/tag/list/cli'
+require_relative 'takelage/docker/image/tag/latest/module'
+require_relative 'takelage/docker/image/tag/latest/cli'
+require_relative 'takelage/docker/image/tag/check/module'
+require_relative 'takelage/docker/image/tag/check/cli'
+require_relative 'takelage/docker/image/tag/cli'
+require_relative 'takelage/docker/image/module'
+require_relative 'takelage/docker/image/cli'
+require_relative 'takelage/docker/container/check/module'
+require_relative 'takelage/docker/container/check/cli'
+require_relative 'takelage/docker/container/module'
+require_relative 'takelage/docker/container/cli'
+require_relative 'takelage/docker/cli'
+require_relative 'takelage/info/project/cli'
+require_relative 'takelage/info/cli'
+require_relative 'takelage/self/config/cli'
+require_relative 'takelage/self/module'
+require_relative 'takelage/self/cli'
+
+
+# Facilitate the takelage devops workflow.
+module Takelage
+
+  # takelage
+  class CLI < Thor
+
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include ProjectModule
+
+    check_unknown_options!
+
+    # @return [String] bash completion code
+    attr_reader :bash_fylla
+
+    option :loglevel,
+           :aliases => 'l',
+           :default => 'INFO',
+           :desc => 'One of: FATAL, ERROR, WARN, INFO, DEBUG'
+    # Initialize takelage cli.
+    def initialize(args = [], local_options = {}, configuration = {})
+
+      # Initialize thor parent class
+      super args, local_options, configuration
+
+      # Initialize global singleton log
+      initialize_logging options[:loglevel].to_s.upcase
+
+      # Initialize global singleton config
+      initialize_config
+
+      # Initialize global singleton project
+      initialize_project
+
+      # fylla bash completion code
+      @bash_fylla = Fylla.bash_completion self
+    end
+
+    #
+    # Subcommands
+    #
+
+    desc 'bit [COMMAND] ', 'Manage bit'
+    subcommand 'bit', Bit
+
+    desc 'completion [COMMAND] ', 'Print shell completion code'
+    subcommand 'completion', Completion
+
+    desc 'docker [COMMAND] ', 'Manage docker containers'
+    subcommand 'docker', Docker
+
+    desc 'git [COMMAND] ', 'Manage git'
+    subcommand 'git', Git
+
+    desc 'info [COMMAND] ', 'Get information'
+    subcommand 'info', Info
+
+    desc 'self [COMMAND] ', 'Manage takelage tools'
+    subcommand 'self', Self
+
+    #
+    # Top-level commands
+    #
+
+    desc 'config', 'Alias for tau self config active'
+    # takelage config: {takelage::SelfConfig#active}
+    def config
+      Takelage::SelfConfig.new.active
+    end
+
+    desc 'copy [DIR] [SCOPE]', 'Alias for tau bit clipboard copy'
+    # takelage copy: {takelage::BitClipboard#copy}
+    def copy(dir_or_file, scope)
+      Takelage::BitClipboard.new.copy dir_or_file, scope
+    end
+
+    desc 'project', 'Alias for tau info project active'
+    # takelage project: {takelage::InfoProject#active}
+    def project
+      Takelage::InfoProject.new.active
+    end
+
+    desc 'login', 'Alias for tau docker container login'
+    # takelage login: {takelage::DockerContainer#login}
+    def login
+      Takelage::DockerContainer.new.login
+    end
+
+    desc 'list', 'Alias for tau self list'
+    # takelage version: {takelage::Self#list}
+    def list
+      Takelage::Self.new.list
+    end
+
+    desc 'nuke', 'Alias for tau docker container nuke'
+    # takelage nuke: {takelage::DockerContainer#nuke}
+    def nuke
+      Takelage::DockerContainer.new.nuke
+    end
+
+    desc 'paste [COMPONENT] [DIR]', 'Alias for tau bit clipboard paste'
+    # takelage paste: {takelage::BitClipboard#paste}
+    def paste(cid, dir)
+      Takelage::BitClipboard.new.paste cid, dir
+    end
+
+    desc 'pull', 'Alias for tau bit clipboard pull'
+    # takelage pull: {takelage::BitClipboard#pull}
+    def pull
+      Takelage::BitClipboard.new.pull
+    end
+
+    desc 'purge', 'Alias for tau docker container purge'
+    # takelage purge: {takelage::DockerContainer#purge}
+    def purge
+      Takelage::DockerContainer.new.purge
+    end
+
+    desc 'push', 'Alias for tau bit clipboard push'
+    # takelage push: {takelage::BitClipboard#push}
+    def push
+      Takelage::BitClipboard.new.push
+    end
+
+    desc 'update', 'Alias for tau docker image update'
+    # takelage update: {takelage::DockerImage#update}
+    def update
+      Takelage::DockerImage.new.update
+    end
+
+    desc 'version', 'Alias for tau self version'
+    # takelage version: {takelage::Self#version}
+    def version
+      Takelage::Self.new.version
+    end
+
+    #
+    # Administrative functions
+    #
+
+    # Behave as expected by correctly reporting failure in exit status.
+    # See https://github.com/erikhuda/thor/wiki/Making-An-Executable
+    def self.exit_on_failure?
+      true
+    end
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: takelage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Geospin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: tau-cli is a thor command line script to tame the takelage devops workflow
+email:
+- takelage@geospin.de
+executables:
+- tau
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/tau
+- lib/Thorfile
+- lib/takelage.rb
+- lib/takelage/bit/cli.rb
+- lib/takelage/bit/clipboard/cli.rb
+- lib/takelage/bit/clipboard/module.rb
+- lib/takelage/bit/scope/cli.rb
+- lib/takelage/bit/scope/module.rb
+- lib/takelage/completion/cli.rb
+- lib/takelage/default.yml
+- lib/takelage/docker/cli.rb
+- lib/takelage/docker/container/check/cli.rb
+- lib/takelage/docker/container/check/module.rb
+- lib/takelage/docker/container/cli.rb
+- lib/takelage/docker/container/module.rb
+- lib/takelage/docker/image/cli.rb
+- lib/takelage/docker/image/module.rb
+- lib/takelage/docker/image/tag/check/cli.rb
+- lib/takelage/docker/image/tag/check/module.rb
+- lib/takelage/docker/image/tag/cli.rb
+- lib/takelage/docker/image/tag/latest/cli.rb
+- lib/takelage/docker/image/tag/latest/module.rb
+- lib/takelage/docker/image/tag/list/cli.rb
+- lib/takelage/docker/image/tag/list/module.rb
+- lib/takelage/docker/socket/cli.rb
+- lib/takelage/docker/socket/module.rb
+- lib/takelage/git/check/cli.rb
+- lib/takelage/git/check/module.rb
+- lib/takelage/git/cli.rb
+- lib/takelage/info/cli.rb
+- lib/takelage/info/project/cli.rb
+- lib/takelage/lib/config.rb
+- lib/takelage/lib/logging.rb
+- lib/takelage/lib/project.rb
+- lib/takelage/lib/subcmd.rb
+- lib/takelage/lib/system.rb
+- lib/takelage/self/cli.rb
+- lib/takelage/self/config/cli.rb
+- lib/takelage/self/module.rb
+- lib/takelage/version
+homepage: https://geospin.de
+licenses:
+- GPL-3.0
+metadata:
+  yard.run: yard
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: takelage devops workflow cli
+test_files: []