sct 0.1.18 → 0.1.19

data/sct_core/lib/sct_core/ui/implementations/shell.rb

@@ -0,0 +1,129 @@
+require_relative '../interface'
+
+module SctCore
+    # Shell is the terminal output of things
+    # For documentation for each of the methods open `interface.rb`
+    class Shell < Interface
+      require 'tty-screen'
+  
+      def log
+        $stdout.sync = true
+      end
+
+      def writeToUser(message) 
+        puts message
+      end
+  
+      def error(message)
+        writeToUser(message.to_s.red)
+      end
+  
+      def important(message)
+        writeToUser(message.to_s.yellow)
+      end
+  
+      def success(message)
+        writeToUser(message.to_s.green)
+      end
+  
+      def message(message)
+        writeToUser(message.to_s)
+      end
+  
+      def deprecated(message)
+        writeToUser(message.to_s.deprecated)
+      end
+  
+      def command(message)
+        writeToUser("$ #{message}".cyan)
+      end
+  
+      def command_output(message)
+        actual = (message.split("\r").last || "") # as clearing the line will remove the `>` and the time stamp
+        actual.split("\n").each do |msg|  
+            # prefix = msg.include?("▸") ? "" : "▸ "
+            prefix = ""
+            writeToUser(prefix + "" + msg.magenta)
+        end
+      end
+  
+      def verbose(message)
+        message.to_s if $verbose
+      end
+  
+      def header(message)
+        format = format_string
+        if message.length + 8 < TTY::Screen.width - format.length
+          message = "--- #{message} ---"
+          i = message.length
+        else
+          i = TTY::Screen.width - format.length
+        end
+        success("-" * i)
+        success(message)
+        success("-" * i)
+      end
+  
+      def content_error(content, error_line)
+        error_line = error_line.to_i
+        return unless error_line > 0
+  
+        contents = content.split(/\r?\n/).map(&:chomp)
+  
+        start_line = error_line - 2 < 1 ? 1 : error_line - 2
+        end_line = error_line + 2 < contents.length ? error_line + 2 : contents.length
+  
+        Range.new(start_line, end_line).each do |line|
+          str = line == error_line ? " => " : "    "
+          str << line.to_s.rjust(Math.log10(end_line) + 1)
+          str << ":\t#{contents[line - 1]}"
+          error(str)
+        end
+      end
+  
+      #####################################################
+      # @!group Errors: Inputs
+      #####################################################
+  
+      def interactive?
+        interactive = true
+        interactive = false if $stdout.isatty == false
+        return interactive
+      end
+  
+      def input(message)
+        verify_interactive!(message)
+        ask("#{format_string}#{message.to_s.yellow}").to_s.strip
+      end
+  
+      def confirm(message)
+        verify_interactive!(message)
+        agree("#{format_string}#{message.to_s.yellow} (y/n)", true)
+      end
+  
+      def select(message, options)
+        verify_interactive!(message)
+  
+        important(message)
+        choose(*options)
+      end
+  
+      def password(message)
+        verify_interactive!(message)
+  
+        ask("#{format_string}#{message.to_s.yellow}") { |q| q.echo = "*" }
+      end
+
+      def user_error!(error_message, options = {})
+        writeToUser(error_message.yellow)
+      end
+  
+      private
+  
+      def verify_interactive!(message)
+        return if interactive?
+        important(message)
+        crash!("Could not retrieve response as sct runs in non-interactive mode")
+      end
+    end
+  end

data/sct_core/lib/sct_core/ui/interface.rb

@@ -0,0 +1,120 @@
+module SctCore
+    # Abstract super class
+    class Interface
+      #####################################################
+      # @!group Messaging: show text to the user
+      #####################################################
+  
+      # Level Error: Can be used to show additional error
+      #   information before actually raising an exception
+      #   or can be used to just show an error from which
+      #
+      #   By default those messages are shown in red
+      def error(_message)
+        not_implemented(__method__)
+      end
+  
+      # Level Important: Can be used to show warnings to the user
+      #   not necessarily negative, but something the user should
+      #   be aware of.
+      #
+      #   By default those messages are shown in yellow
+      def important(_message)
+        not_implemented(__method__)
+      end
+  
+      # Level Success: Show that something was successful
+      #
+      #   By default those messages are shown in green
+      def success(_message)
+        not_implemented(__method__)
+      end
+  
+      # Level Message: Show a neutral message to the user
+      #
+      #   By default those messages shown in white/black
+      def message(_message)
+        not_implemented(__method__)
+      end
+  
+      # Level Deprecated: Show that a particular function is deprecated
+      #
+      #   By default those messages shown in strong blue
+      def deprecated(_message)
+        not_implemented(__method__)
+      end
+  
+      # Level Command: Print out a terminal command that is being
+      #   executed.
+      #
+      #   By default those messages shown in cyan
+      def command(_message)
+        not_implemented(__method__)
+      end
+  
+      # Level Command Output: Print the output of a command with
+      #   this method
+      #
+      #   By default those messages shown in magenta
+      def command_output(_message)
+        not_implemented(__method__)
+      end
+  
+      # Level Verbose: Print out additional information for the
+      #   users that are interested. Will only be printed when
+      #
+      #   By default those messages are shown in white
+      def verbose(_message)
+        not_implemented(__method__)
+      end
+  
+      # Print a header = a text in a box
+      #   use this if this message is really important
+      def header(_message)
+        not_implemented(__method__)
+      end
+  
+      # Print lines of content around specific line where
+      #   failed to parse.
+      #
+      #   This message will be shown as error
+      def content_error(content, error_line)
+        not_implemented(__method__)
+      end
+  
+      #####################################################
+      # @!group Errors: Inputs
+      #####################################################
+  
+      # Is is possible to ask the user questions?
+      def interactive?
+        not_implemented(__method__)
+      end
+  
+      # get a standard text input (single line)
+      def input(_message)
+        not_implemented(__method__)
+      end
+  
+      # A simple yes or no question
+      def confirm(_message)
+        not_implemented(__method__)
+      end
+  
+      # Let the user select one out of x items
+      # return value is the value of the option the user chose
+      def select(_message, _options)
+        not_implemented(__method__)
+      end
+  
+      # Password input for the user, text field shouldn't show
+      # plain text
+      def password(_message)
+        not_implemented(__method__)
+      end
+
+      def user_error!(error_message, options = {})
+        not_implemented(__method__)
+      end
+    end
+  end

data/sct_core/lib/sct_core/ui/ui.rb

@@ -0,0 +1,26 @@
+module SctCore
+    class UI
+      class << self
+        attr_accessor(:ui_object)
+  
+        def ui_object
+          require_relative 'implementations/shell'
+          @ui_object ||= Shell.new
+        end
+  
+        def method_missing(method_sym, *args, &_block)
+          # not using `responds` because we don't care about methods like .to_s and so on
+          require_relative 'interface'
+          interface_methods = SctCore::Interface.instance_methods - Object.instance_methods
+          UI.user_error!("Unknown method '#{method_sym}', supported #{interface_methods}") unless interface_methods.include?(method_sym)
+  
+          self.ui_object.send(method_sym, *args)
+        end
+      end
+    end
+  end
+  
+  # Import all available implementations
+  Dir[File.dirname(__FILE__) + '/implementations/*.rb'].each do |file|
+    require_relative file
+  end

data/shell/lib/shell.rb

@@ -0,0 +1,3 @@
+require_relative 'shell/tools'
+require_relative 'shell/runner'
+require_relative 'shell/module'

data/shell/lib/shell/commands_generator.rb

@@ -0,0 +1,14 @@
+require_relative 'runner'
+
+module Shell
+    class CommandsGenerator
+
+        def self.start
+            self.new.run
+        end
+
+        def run 
+            Shell::Runner.new.launch
+        end
+    end
+end

data/{lib/sct → shell/lib/shell}/docker/composer.rb

@@ -1,13 +1,14 @@
-require "sct/docker/docker"
+require "sct_core"
+require_relative "docker"
 
-module Sct
+module Shell
     class Composer < Docker
 
         # Configure the Yarn command
        def self.config
             self.setImage("eu.gcr.io/dev-pasc-vcdm/helpers-composer:latest", true)
             self.setPwdAsVolume("/app")
-            self.addVolume(Sct::Helpers.convertWSLToWindowsPath("#{Sct::Helpers.windowsHomePath || Sct::Helpers.homePath}/.composer") , "/tmp")
+            self.addVolume(SctCore::Helper.convertWSLToWindowsPath("#{SctCore::Helper.windowsHomePath || SctCore::Helper.homePath}/.composer") , "/tmp")
             self.setCurrentUserAndGroup()
             self.setEntrypoint("composer")
         end

data/{lib/sct → shell/lib/shell}/docker/docker.rb

@@ -1,6 +1,7 @@
-require "sct/ClassLevelInheritableAttributes"
+require "sct_core"
+require "shell/ClassLevelInheritableAttributes"
 
-module Sct
+module Shell
     class Docker
         include ClassLevelInheritableAttributes
         inheritable_attributes :image, :is_private_registry, :entrypoint, :volumes, :ports, :extra_arguments
@@ -26,9 +27,7 @@ module Sct
         ###
         def self.exec(cli_arguments)
 
-            cli_arguments.each do | argument |
-                self.addExtraArgument(argument)
-            end
+            self.addExtraArgument(cli_arguments)
 
             self.config()
 
@@ -60,8 +59,8 @@ module Sct
         def self.setPwdAsVolume(volume_path)
             pwd = `pwd -P`
 
-            if Sct::Helpers.operatingSystem == Sct::Helpers::WINDOWS
-                pwd=Sct::Helpers.convertWSLToWindowsPath(pwd)
+            if SctCore::Helper.operatingSystem == SctCore::Helper::WINDOWS
+                pwd=SctCore::Helper.convertWSLToWindowsPath(pwd)
             end
 
             addVolume(pwd, volume_path)
@@ -141,9 +140,7 @@ module Sct
         def self.runCommand()
             command = self.compileCommand()
 
-            system(command)
-
-            return $?.success?
+            SctCore::CommandExecutor.execute(command: command, print_all: true, suppress_output: false)
         end
 
         ###

data/{lib/sct → shell/lib/shell}/docker/php.rb

@@ -1,6 +1,7 @@
-require "sct/docker/docker"
+require "sct_core"
+require_relative "docker"
 
-module Sct
+module Shell
     class Php < Docker
 
         # Configure the Yarn command

data/{lib/sct → shell/lib/shell}/docker/yarn.rb

@@ -1,13 +1,14 @@
-require "sct/docker/docker"
+require "sct_core"
+require_relative "docker"
 
-module Sct
+module Shell
     class Yarn < Docker
 
         # Configure the Yarn command
        def self.config
             self.setImage("eu.gcr.io/dev-pasc-vcdm/helpers-yarn:latest", true)
             self.setPwdAsVolume("/app")
-            self.addVolume(Sct::Helpers.convertWSLToWindowsPath("#{Sct::Helpers.windowsHomePath || Sct::Helpers.homePath}/.cache") , "/.cache")
+            self.addVolume(SctCore::Helper.convertWSLToWindowsPath("#{SctCore::Helper.windowsHomePath || SctCore::Helper.homePath}/.cache") , "/.cache")
             self.mapPort(8081, 8080)
             self.mapPort(9001)
             self.setCurrentUserAndGroup()

data/shell/lib/shell/module.rb

@@ -0,0 +1,9 @@
+require 'sct_core/helper'
+
+module Shell
+
+    # import the helper functionality from SCT
+    Helpers = Sct::Helper
+    UI = Sct::UI 
+
+end

data/shell/lib/shell/runner.rb

@@ -0,0 +1,34 @@
+module Shell
+    class Runner
+        # define launch work
+        def launch 
+
+            tool_name = ARGV.first ? ARGV.first.downcase : nil
+
+            if tool_name && Shell::TOOLS.include?(tool_name.to_sym)
+                
+                require_relative "docker/#{tool_name}"
+                command = "#{ARGV[1..(ARGV.length+1)].join(" ")}"
+
+                case ARGV.first
+                when 'php'
+                    Shell::Php.exec(command)
+                when 'composer'
+                    Shell::Composer.exec(command)
+                when 'yarn'
+                    Shell::Yarn.exec(command)
+                else
+                    show_error
+                end
+                
+            else
+                show_error
+            end
+        end
+
+        def show_error 
+            tools = Shell::TOOLS.map { |tool| tool.to_s }.join(", ")
+            UI.error("Tool not found. Try one of these: #{tools}")
+        end
+    end
+end

data/shell/lib/shell/tools.rb

@@ -0,0 +1,7 @@
+module Shell
+    TOOLS = [
+      :yarn,
+      :composer,
+      :php
+    ]
+end