mysh 0.2.7 → 0.3.0

data/lib/mysh.rb

@@ -10,6 +10,9 @@ require_relative 'mysh/quick'
 require_relative 'mysh/expression'
 require_relative 'mysh/internal'
 require_relative 'mysh/external_ruby'
+require_relative 'mysh/handlebars'
+require_relative 'mysh/shell_variables'
+require_relative 'mysh/pre_processor'
 require_relative 'mysh/version'
 
 #The Mysh (MY SHell) module. A container for mysh and its functionality.
@@ -20,7 +23,7 @@ module Mysh
     setup
 
     while @mysh_running do
-      execute_a_command($mysh_exec_host.eval_handlebars(get_command("mysh")))
+      execute_a_command(get_command)
     end
   end
 
@@ -31,7 +34,7 @@ module Mysh
     @mysh_running = true
   end
 
-  #Execute a single line of input.
+  #Execute a single line of input and handle exceptions.
   def self.execute_a_command(str)
     try_execute_command(str)
 
@@ -39,11 +42,18 @@ module Mysh
     @mysh_running = false
 
   rescue Interrupt, StandardError, ScriptError => err
-    puts err, err.backtrace
+    puts "Error #{err.class}: #{err}"
+    puts err.backtrace if MNV[:debug]
   end
 
-  #Try to execute a single line of input.
+  #Try to execute a single line of input. Does not handle exceptions.
   def self.try_execute_command(input)
+    unless input.start_with?("$")
+      input = input.preprocess
+    end
+
+    puts "=> #{input}" if MNV[:debug]
+
     try_execute_quick_command(input)    ||
     try_execute_internal_command(input) ||
     try_execute_external_ruby(input)    ||

data/lib/mysh/expression.rb

@@ -2,12 +2,11 @@
 
 require 'pp'
 require 'mathn'
-
 require_relative 'expression/lineage'
 
 #* mysh/expression.rb -- The mysh ruby expression processor.
 #<br>Endemic Code Smells
-#* :reek:ModuleInitialize
+#* :reek:ModuleInitialize -- False positive
 module Mysh
 
   #Reset the state of the execution hosting environment.
@@ -29,13 +28,13 @@ module Mysh
       #* The expression string always begins with an '=' character.
       def execute(expression)
         pp $mysh_exec_binding.eval("$mysh_exec_result" + expression)
-      rescue Interrupt, StandardError, ScriptError => err
-        puts "#{err.class.to_s}: #{err}"
-      ensure
-        return :expression
+        :expression
       end
 
-      private
+      #Return a simple message for less convoluted error messages.
+      def inspect
+        "exec_host"
+      end
 
       #Get the previous result
       def result
@@ -48,6 +47,10 @@ module Mysh
         nil
       end
 
+      #Evaluate the string in the my shell context.
+      def mysh_eval(str)
+        $mysh_exec_binding.eval(str)
+      end
     end
 
     $mysh_exec_host = exec_class.new

data/lib/mysh/external_ruby.rb

@@ -9,7 +9,7 @@ module Mysh
 
     if cmd && File.extname(cmd) == '.rb'
       new_command = "#{RbConfig.ruby} #{str}"
-      puts "=> #{new_command}"
+      puts "=> #{new_command}"  if MNV[:debug]
       system(new_command)
       :ruby_exec
     end

data/lib/mysh/handlebars.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+require_relative 'handlebars/string'
+
+#* user_input/handlebars.rb -- Handlebar embedded ruby support.
+class Object
+
+  #Show a file with embedded ruby handlebars.
+  #<br>Note:
+  #The message receiver is the evaluation host for the handlebar code.
+  def show_handlebar_file(name, evaluator)
+    puts eval_handlebar_file(name, evaluator)
+  rescue Interrupt, StandardError, ScriptError => err
+    puts "Error in file: #{name}\n#{err.class}: #{err}"
+    puts err.backtrace if MNV[:debug]
+  end
+
+  #Expand a file with embedded ruby handlebars.
+  #<br>Note:
+  #The message receiver is the evaluation host for the handlebar code.
+  #<br>Endemic Code Smells
+  #* :reek:UtilityFunction
+  def eval_handlebar_file(name, evaluator)
+    IO.read(name).preprocess(evaluator)
+  end
+
+end
+
+

data/lib/mysh/handlebars/string.rb

@@ -0,0 +1,22 @@
+# coding: utf-8
+
+#Monkey patches for Mysh handlebars
+class String
+
+  #Evaluate any variable substitutions in the input.
+  def eval_handlebars(evaluator=$mysh_exec_host)
+    gsub(/{{.*?}}/m) do |match|
+      code   = match[2...-2]
+      silent = code.end_with?("#")
+      result = evaluator.mysh_eval(code)
+
+      (result unless silent).to_s
+    end
+  end
+
+  #Process quoted brace characters
+  def eval_quoted_braces
+    gsub(/\\[\{\}]/) {|found| found[1]}
+  end
+
+end

data/lib/mysh/internal/action.rb

@@ -28,6 +28,11 @@ module Mysh
       [@name].concat(@description)
     end
 
+    #Evaluate the string in the my shell context.
+    def mysh_eval(str)
+      @exec_binding.eval(str)
+    end
+
     private
 
     #Create a binding for mysh to execute expressions in.
@@ -35,11 +40,6 @@ module Mysh
       binding
     end
 
-    #Evaluate the string in the my shell context.
-    def mysh_eval(str)
-      @exec_binding.eval(str)
-    end
-
   end
 
 end

data/lib/mysh/internal/action_pool.rb

@@ -24,7 +24,7 @@ module Mysh
     def add_action(action)
       split_name = action.name.split[0] || ""
 
-      if @pool.has_key?(split_name)
+      if @pool.key?(split_name)
         fail "Add error: Action #{split_name.inspect} already exists in #{pool_name}."
       end
 

data/lib/mysh/internal/actions/cd.rb

@@ -9,9 +9,10 @@ module Mysh
     #Execute the cd command.
     def call(args)
       Dir.chdir(args[0]) unless args.empty?
-      puts decorate(Dir.pwd)
+      puts Dir.pwd.decorate
     rescue => err
       puts "Error: #{err}"
+      puts err.backtrace if MNV[:debug]
     end
 
   end

data/lib/mysh/internal/actions/help/hbar.txt

@@ -1,35 +1,36 @@
 Help: About mysh handlebars:
 
-In mysh, it is possible to embed snippets of ruby into text files or on the
-command line through the use of handlebars. Handlebars look like this:
+In mysh, it is possible to embed snippets of ruby into text files, in shell
+variables or on the command line through the use of handlebars. Handlebars
+look like this:
 
     \{\{ code goes here  \}\}
 
 Lets see a simple example of putting the result of a calculation into the
 command line:
 
-  mysh>echo \{\{ (1..10).map {|i| i.to_s}.join(" ") \}\}  > foo.txt
-  mysh>type foo.txt
-  1 2 3 4 5 6 7 8 9 10
+    mysh>echo \{\{ (1..10).map {|i| i.to_s}.join(" ") \}\}  > foo.txt
+    mysh>type foo.txt
+    1 2 3 4 5 6 7 8 9 10
 
 Handlebars work by evaluating the ruby code within the \{\{  \}\} sequence in
 the appropriate execution environment. For the command line, this is the same
 environment used for the '=' quick execution command. For example:
 
-  mysh>=a="A very long string indeed!"
-  "A very long string indeed!"
-  mysh>echo \{\{ a \}\}
-  A very long string indeed!
+    mysh>=a="A very long string indeed!"
+    "A very long string indeed!"
+    mysh>echo \{\{ a \}\}
+    A very long string indeed!
 
 The value returned by expression is coverted to a string (if needed) and then
 inserted in place of the handlebar expression. There are, however, times when
 it is not desired to insert anything in the place of the code snippet. For
 those cases, simply end the expression with a '#' character. For example:
 
-mysh>echo \{\{ "not embedded" #\}\} \{\{ "embedded" \}\}
- embedded
+    mysh>echo \{\{ "not embedded" #\}\} \{\{ "embedded" \}\}
+      embedded
 
 Finally, it may be that it is desired to embed braces into a text file or
-the command line. In that case precede the brace with a baclslash character
+the command line. In that case precede the brace with a backslash character
 like: \\{  or \\}
 

data/lib/mysh/internal/actions/help/history.txt

@@ -10,7 +10,7 @@ the quick form, ! is used, the space is optional.
 Quick   Long           Command
 Form    Form           Description
 =====   =======        ===========
-!       history        Display the history buffer.
+!       history        Display the entire history buffer.
 
 !5      history 5      Retrieve history entry 5 and present this to the user
                        as the next command.

data/lib/mysh/internal/actions/help/kbd.txt

@@ -28,4 +28,5 @@ Quick exit mysh  | Ctrl-z                   | Alt-z
 Notes:
   Windows keys are aliased through the numeric key pad unless NumLock is on.
   Mac/Linux mappings may use Escape letter if Alt-letter is unavailable.
+  Cygwin systems use the Mac/Linux mappings.
 

data/lib/mysh/internal/actions/help/sub_help.rb

@@ -14,7 +14,7 @@ module Mysh
 
     #Execute a help command.
     def call(_args)
-      show_handlebar_file(ACTIONS_PATH + 'help/' + @file_name)
+      show_handlebar_file(ACTIONS_PATH + 'help/' + @file_name, self)
     end
 
   end
@@ -22,6 +22,7 @@ module Mysh
   #Add help topics here. Don't sweat the order; they get sorted by name.
   #        Name        Description                            Help File
   help = [['',        'General help on mysh.',               'help.txt'   ],
+          ['$',       'Help on mysh variables.',             'vars.txt'   ],
           ['show',    'Help on the show command.',           'show.txt'   ],
           ['@',       'Help on the show command.',           'show.txt'   ],
           ['env',     'Help on the show env command.',       'env.txt'    ],
@@ -30,8 +31,8 @@ module Mysh
           ['=',       'Help on ruby expressions.',           'expr.txt'   ],
           ['quick',   'Help on quick commands.',             'quick.txt'  ],
           ['gls',     'Help on gls internal mysh command.',  'gls.txt'    ],
-          ['!',       'This help on the history command.',   'history.txt'],
-          ['history', 'This help on the history command.',   'history.txt'],
+          ['!',       'Help on the history command.',        'history.txt'],
+          ['history', 'Help on the history command.',        'history.txt'],
           ['kbd',     'Help on mysh keyboard mapping.',      'kbd.txt'    ],
           ['{{',      'Help on mysh handlebars.',            'hbar.txt'   ],
           ['help',    'This help on the help command.',      'h_o_h.txt'  ],

data/lib/mysh/internal/actions/help/vars.txt

@@ -0,0 +1,34 @@
+Help: mysh variables:
+
+In mysh, variables are kept that control the behavior of the shell. This simple
+command is used to set, delete, and display these variables. The basic method
+for setting a variable is:
+
+    $name=value
+
+Where:
+* name is a word matching the regex: /[a-z][a-z0-9_]*/. Lower case only.
+* value is a string, with embedded variables and handlebars.
+
+To erase the value of a variable, use:         $$name=
+To display the name/value of a variable, use:  $$name
+To display all variable names/values use:      $$
+
+As an escapement, the string $$$$ maps to a single $$.
+
+Some variables that are used in mysh are:
+
+$$d           The current date.
+$$date_fmt    The format for the date: "%Y-%m-%d"
+$$debug       Does the shell display additional debugging info (true/false)
+$$h           The home folder's path
+$$post_prompt The prompt used when a line is continued with a trailing \\
+             character.
+$$pre_prompt  A prompt string displayed before the actual command prompt.
+             Delete the pre_prompt variable to disable pre-prompting.
+$$prompt      The user prompt.
+$$t           The current time.
+$$time_fmt    The format for the time: "%H:%M"
+$$u           The current user.
+$$w           The current working directory's path.
+

data/lib/mysh/internal/actions/pwd.rb

@@ -8,7 +8,7 @@ module Mysh
 
     #Execute the cd command.
     def call(_args)
-      puts decorate(Dir.pwd)
+      puts Dir.pwd.decorate
     end
 
   end

data/lib/mysh/internal/actions/show/env.rb

@@ -16,10 +16,12 @@ module Mysh
     private
 
     #Get the info
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
     def info
       [["user",     ENV['USER']],
        ["home",     ENV['HOME']],
-       ["name",     decorate($PROGRAM_NAME)],
+       ["name",     $PROGRAM_NAME.decorate],
        ["shell",    ENV['SHELL']    || ENV['ComSpec']],
        ["host",     ENV['HOSTNAME'] || ENV['COMPUTERNAME']],
        ["os",       ENV['OS']],

data/lib/mysh/internal/actions/show/ruby.rb

@@ -19,7 +19,7 @@ module Mysh
     #<br>Endemic Code Smells
     #* :reek:UtilityFunction
     def info
-      [["location",    decorate(RbConfig.ruby)],
+      [["location",    RbConfig.ruby.decorate],
        ["description", RUBY_DESCRIPTION],
        ["version",     RUBY_VERSION],
        ["jversion",    (JRUBY_VERSION rescue nil)],

data/lib/mysh/internal/actions/type.rb

@@ -13,7 +13,7 @@ module Mysh
       @exec_binding = binding
 
       if file_name
-        show_handlebar_file(file_name)
+        show_handlebar_file(file_name, self)
       else
         puts "Error: A text file must be specified."
       end

data/lib/mysh/internal/actions/vars.rb

@@ -0,0 +1,58 @@
+# coding: utf-8
+
+#* mysh/internal/actions/vars.rb -- The mysh internal variables commands.
+module Mysh
+
+  #* mysh/internal/actions/vars.rb -- The mysh internal variable commands.
+  class VarsCommand < Action
+
+    #The mysh variable parsing regex.
+    VAR_EXP = %r{(?<name>   [a-z][a-z0-9_]*){0}
+                 (?<equals> =){0}
+                 (?<value>  \S.*){0}
+                 \$ (\g<name> \s* (\g<equals> \s* \g<value>?)?)?}x
+
+    #Setup an internal action.
+    def initialize(name, description)
+      @name = @equals = @value = nil
+      super(name, description)
+    end
+
+    #Execute a command against the internal mysh variables.
+    def call(str)
+      match = VAR_EXP.match(str.chomp)
+      @name, @equals, @value = match[:name], match[:equals], match[:value]
+      do_command
+      true
+    end
+
+    #Do the actual work here.
+    def do_command
+      sym = @name.to_sym if @name
+
+      if @value
+        MNV[sym] = @value
+      elsif @equals
+        MNV[sym] = ""
+      elsif @name
+        puts "#{@name} = #{MNV.get_source(sym)}"
+      else
+        show_all_values
+      end
+    end
+
+    #Display all variables neatly.
+    def show_all_values
+      puts MNV.keys
+              .sort
+              .map {|sym| ["$" + sym.to_s, MNV.get_source(sym)]}
+              .format_mysh_bullets
+    end
+
+  end
+
+  #The show command action object.
+  desc = 'Set/query mysh variables. See ?$ for more.'
+  VARS_COMMAND = VarsCommand.new('$<name>=value', desc)
+  COMMANDS.add_action(VARS_COMMAND)
+end

data/lib/mysh/internal/decorate.rb

@@ -1,37 +1,22 @@
 # coding: utf-8
 
 #* mysh/internal/decorate.rb -- mysh internal file name beauty treatments.
-module Mysh
+class String
 
-  #* mysh/internal/decorate.rb -- The mysh internal file name beauty treatments.
-  class Action
-
-    #Make the file name fit the local system.
-    def decorate(name)
-      dress_up_quotes(dress_up_slashes(name))
-    end
-
-    private
-
-    #Dress up slashes and backslashes.
-    def dress_up_slashes(name)
-      backslash? ? name.gsub("/", "\\") : name
-    end
-
-    #Dress up in quotes if needed.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
-    def dress_up_quotes(name)
-      name[' '] ? "\"#{name}\"" : name
-    end
+  #Make the file name fit the local system.
+  def decorate
+    self.dress_up_slashes
+        .dress_up_quotes
+  end
 
-    #Does this file name use backslashes?
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
-    def backslash?
-      MiniReadline::PLATFORM == :windows
-    end
+  #Dress up slashes and backslashes.
+  def dress_up_slashes
+    MiniReadline::PLATFORM == :windows ? self.gsub("/", "\\") : self
+  end
 
+  #Dress up in quotes if needed.
+  def dress_up_quotes
+    self[' '] ? "\"#{self}\"" : self
   end
 
 end