universal_pipe_handler 0.0.10

data/lib/universal_pipe_handler/shell/shell.rb

@@ -0,0 +1,256 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === UniversalPipeHandler::Shell
+#
+# Usage example:
+#
+#   UniversalPipeHandler::Shell.new(ARGV)
+#
+# =========================================================================== #
+# require 'universal_pipe_handler/shell/shell.rb'
+# =========================================================================== #
+require 'universal_pipe_handler/base/base.rb'
+
+module UniversalPipeHandler
+
+class Shell < Base # === UniversalPipeHandler::Shell
+
+  require 'universal_pipe_handler/cmdlets_handler/cmdlets_handler.rb'
+
+  begin
+    require 'readline'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    register_sigint
+    consider_enabling_readline_support
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @last_result
+    # ======================================================================= #
+    @last_result = nil
+  end
+
+  # ========================================================================= #
+  # === is_readline_available?
+  # ========================================================================= #
+  def is_readline_available?
+    return Object.const_defined? :Readline
+  end; alias readline_is_available? is_readline_available? # === readline_is_available?
+
+  # ========================================================================= #
+  # === consider_enabling_readline_support
+  #
+  # We will enable readline support, if it is available.
+  #
+  # The registered actions are part of the sanitize_pipe project.
+  # ========================================================================= #
+  def consider_enabling_readline_support
+    if readline_is_available?
+      Readline.completion_append_character = ' '
+      completion_proc = proc { |input|
+        input = input.to_s.strip
+        aliases = all_aliases
+        # input = Regexp.escape(input)
+        aliases.grep(/^#{input}/)
+      }
+      Readline.completion_proc = completion_proc
+    else
+      e 'No support for Readline is available.'
+    end
+  end
+
+  # ========================================================================= #
+  # === show_all_aliases
+  # ========================================================================= #
+  def show_all_aliases
+    pp UniversalPipeHandler.pipe_aliases?.keys.sort
+  end
+
+  # ========================================================================= #
+  # === show_last_return_value
+  # ========================================================================= #
+  def show_last_return_value
+    e @last_result
+  end
+
+  # ========================================================================= #
+  # === enter_the_main_loop                                        (loop tag)
+  # ========================================================================= #
+  def enter_the_main_loop
+    loop {
+      _ = fetch_user_input
+      case _ # (case tag)
+      # ===================================================================== #
+      # === aliases?
+      # ===================================================================== #
+      when 'aliases?'
+        show_all_aliases
+      # ===================================================================== #
+      # === value?
+      # ===================================================================== #
+      when 'value?',
+           'result?'
+        show_last_return_value
+      # ===================================================================== #
+      # === test1
+      #
+      # This entry point can be used to quickly test the pipe.
+      # ===================================================================== #
+      when 'test1'
+        _ = 'all images | resize 25%'
+        set_user_input(_)
+      # ===================================================================== #
+      # === test2
+      #
+      # Similar to test1.
+      # ===================================================================== #
+      when 'test2'
+        _ = 'ls | camelCase'
+        set_user_input(_)
+      # ===================================================================== #
+      # === quit
+      # ===================================================================== #
+      when 'quit',
+           'q',
+           'exit',
+           'd',
+           'x'
+        verbose_exit
+      end
+      if _.include? '|' # This is also an implicit "if not empty" check.
+        # ================================================================= #
+        # All input that contains '|' will be evaluated as a
+        # pipe-instruction.
+        # ================================================================= #
+        evaluate_this_pipe_instruction(_)
+      else # Else, by default, evaluate it. (else tag)
+        if _.empty?
+          e
+        else
+          e rev+'The instruction '+
+            ::Colours.steelblue(_)+
+            ' is not registered or understood.'
+        end
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === fetch_user_input
+  # ========================================================================= #
+  def fetch_user_input
+    if readline_is_available?
+      set_user_input(Readline.readline('', true))
+    else
+      set_user_input($stdin.gets.chomp)
+    end
+    return @user_input
+  end
+
+  # ========================================================================= #
+  # === set_user_input
+  # ========================================================================= #
+  def set_user_input(i)
+    @user_input = i
+  end
+
+  # ========================================================================= #
+  # === user_input?
+  # ========================================================================= #
+  def user_input?
+    @user_input.to_s.strip
+  end
+
+  # ========================================================================= #
+  # === verbose_exit
+  # ========================================================================= #
+  def verbose_exit
+    e 'Bye.'
+    exit
+  end
+
+  # ========================================================================= #
+  # === silver
+  # ========================================================================= #
+  def silver(i)
+    ::Colours.silver(i)
+  end
+
+  # ========================================================================= #
+  # === show_startup_message
+  # ========================================================================= #
+  def show_startup_message
+    e ::Colours.rev+
+      'Welcome to the interactive Shell for the '+
+      ::Colours.steelblue('UniversalPipeHandler')+
+      ' project.'
+    e
+    e silver('Input your pipe-instruction next to see it be evaluated:')
+    e
+  end
+
+  # ========================================================================= #
+  # === evaluate_this_pipe_instruction
+  #
+  # Usage example:
+  #
+  #   ls | camelCase
+  #
+  # ========================================================================= #
+  def evaluate_this_pipe_instruction(i)
+    i = i.to_s.dup
+e tomato("Debug: `#{i}` in evaluate_this_pipe_instruction")
+    # opn; e 'Next testing `'+sfancy(i)+'`.' unless i.empty?
+    result = UniversalPipeHandler::CmdletsHandler.new(i)
+    @last_result = result.result?
+  end; alias test evaluate_this_pipe_instruction # test tag
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    show_startup_message
+    enter_the_main_loop
+  end
+
+  # ========================================================================= #
+  # === UniversalPipeHandler::Shell[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  UniversalPipeHandler::Shell.new(ARGV)
+end # pipeshell

data/lib/universal_pipe_handler/toplevel_methods/all_actions.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/toplevel_methods/all_actions.rb'
+# UniversalPipeHandler.all_actions?
+# =========================================================================== #
+module UniversalPipeHandler
+
+  require 'universal_pipe_handler/toplevel_methods/cmdlet_directory.rb'
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.array_all_actions
+  # ========================================================================= #
+  def self.array_all_actions
+    Dir[action_directory?+'*.rb']
+  end
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.all_actions?
+  #
+  # This method will return which actions are registered, and thus,
+  # allowed. For this to work all .rb files that are relevant
+  # will be loaded.
+  # ========================================================================= #
+  def self.all_actions?
+    array_all_actions.map {|entry|
+      File.basename(
+        entry.delete_suffix('.rb')
+      )
+    }
+  end; self.instance_eval { alias all_cmdlets?            all_actions? } # === UniversalPipeHandler.all_cmdlets?
+       self.instance_eval { alias allowed_actions?        all_actions? } # === UniversalPipeHandler.allowed_actions?
+       self.instance_eval { alias allowed_actions         all_actions? } # === UniversalPipeHandler.allowed_actions
+       self.instance_eval { alias return_allowed_actions? all_actions? } # === UniversalPipeHandler.return_allowed_actions?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  e
+  pp UniversalPipeHandler.array_all_actions
+  e
+  e 'All actions are:'
+  e
+  pp UniversalPipeHandler.all_actions?
+  e
+end

data/lib/universal_pipe_handler/toplevel_methods/cmdlet_directory.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/toplevel_methods/cmdlet_directory.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  require 'universal_pipe_handler/constants/constants.rb'
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlets_directory?
+  # ========================================================================= #
+  def self.cmdlets_directory?
+    UniversalPipeHandler::CMDLETS_DIRECTORY
+  end; self.instance_eval { alias action_directory? cmdlets_directory? } # === UniversalPipeHandler.action_directory?
+       self.instance_eval { alias cmdlet_directory? cmdlets_directory? } # === UniversalPipeHandler.cmdlet_directory?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts UniversalPipeHandler.cmdlet_directory?  
+end

data/lib/universal_pipe_handler/toplevel_methods/e.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/toplevel_methods/e.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+end

data/lib/universal_pipe_handler/toplevel_methods/misc.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/toplevel_methods/misc.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === @result
+  # ========================================================================= #
+  @result = nil
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.result?
+  # ========================================================================= #
+  def self.result?
+    @result
+  end
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.result=
+  # ========================================================================= #
+  def self.result=(i)
+    @result = i
+  end; self.instance_eval { alias set_result result= } # === UniversalPipeHandler.set_result
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.return_pwd
+  # ========================================================================= #
+  def self.return_pwd
+    "#{Dir.pwd}/".squeezu('/')
+  end
+
+  # ========================================================================= #
+  # === @working_directory
+  # ========================================================================= #
+  @working_directory = nil
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.set_working_directory
+  # ========================================================================= #
+  def self.set_working_directory(i)
+    @working_directory = i
+  end
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.working_directory?
+  # ========================================================================= #
+  def self.working_directory?
+    @working_directory
+  end
+
+end

data/lib/universal_pipe_handler/toplevel_methods/rds.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/toplevel_methods/rds.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.rds
+  # ========================================================================= #
+  def self.rds(
+      i = Dir.pwd
+    )
+    return "#{i}/".squeeze('/')
+  end
+  
+end

data/lib/universal_pipe_handler/toplevel_methods/token.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/toplevel_methods/token.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  require 'universal_pipe_handler/constants/constants.rb'
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.token?
+  # ========================================================================= #
+  def self.token?
+    return UniversalPipeHandler::PIPE_TOKEN
+  end
+
+end

data/lib/universal_pipe_handler/version/version.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/version/version.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '0.0.10'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '03.07.2022'
+
+end