mysh 0.6.9 → 0.6.16

data/lib/mysh/handlebars/eval_handlebars.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+# Monkey patches for Mysh handlebars
+class String
+
+  # Evaluate any variable substitutions in the input.
+  def eval_handlebars(evaluator=$mysh_exec_binding)
+    string, text, buffer = self, "", []
+
+    # Translate the string with embedded code into Ruby code.
+    until string.empty?
+      text, code, string = string.partition(/{{.*?}}/m)
+
+      unless text.empty?
+        text = text.gsub(/\\[{}]/) {|found| found[1]}
+        buffer << "_m_<<#{text.inspect};"
+      else
+        buffer << "" if buffer.empty?
+      end
+
+      unless code.empty?
+        if code[-3] == "#"
+          buffer << "#{code[2...-3]};"
+        else
+          buffer << "_m_<<(#{code[2...-2]}).to_s;"
+        end
+      end
+    end
+
+    # Evaluate the result of the translation.
+    if buffer.length > 1
+      evaluator.eval("_m_ = '';" + buffer.join + "_m_")
+    else
+      text
+    end
+  end
+
+end

data/lib/mysh/{internal/actions/help → help}/h_o_h.txt

@@ -14,7 +14,7 @@ Brief summaries are also available on the following internal commands:
 
 {{ Mysh::COMMANDS.actions_info
                  .reject{|cmd| cmd[1]["See ?"]}
-                 .map{|cmd| cmd[0].split[0] }
+                 .map{|cmd| cmd[0].gsub(/<.*>/, "").strip }
                  .join(" ")
 }}
 

data/lib/mysh/{internal/actions/help → help}/hbar.txt

@@ -30,6 +30,17 @@ those cases, simply end the expression with a '#' character. For example:
     mysh>echo \{\{ "not embedded" #\}\} \{\{ "embedded" \}\}
       embedded
 
+A common use for not embedded code snippets is to act as the control
+structures. For example:
+
+    \{\{ 3.times do |i| #\}\} The count is: \{\{ i+1 \}\}
+    \{\{ end #\}\}
+
+Yields the following output:
+
+    {{ 3.times do |i| #}} The count is: {{ i+1 }}
+    {{ end #}}
+
 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 backslash character
 like: \\{  or \\}

data/lib/mysh/{internal/actions/help → help}/history.txt

@@ -21,3 +21,10 @@ Form     Form            Description
                          regex pattern. Note: This pattern cannot be 'clear'
                          so use 'clea[r]' instead.
 
+The history buffer is controlled by two variables:
+
+$$history  Is the history buffer enabled?
+$$no_move  Are history entries kept in place or shifted up the buffer?
+
+These are also controlled by command line options. See ?usage for more info.
+

data/lib/mysh/help/type.txt

@@ -0,0 +1,28 @@
+Help: mysh type command summary:
+
+The type command is used to display one or more text files. The names of these
+files are the arguments to this command as are options that control how those
+files are processed before being displayed.
+
+Files can be handled in one of two modes:
+
+    raw    Files are displayed with no pre-processing
+    cooked Files are displayed after handlebars and shell variables have been
+           processed and the results inserted into the text.
+
+The default behavior of the type command is set by the \$type variable. This
+may take the values:
+
+    raw, off, false, no   = raw mode (the default value)
+    cooked, on, true, yes = cooked mode
+
+Within the type command, options can be used to override the defaults:
+
+    +c  Force cooked mode.
+    -c  Force raw mode.
+
+Note: This command contrasts with the load command which can also be used to
+      display text files. The difference is the the load command always expands
+      handlebars and shell variables.
+
+

data/lib/mysh/{internal/actions/help → help}/vars.txt

@@ -4,7 +4,7 @@ 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:
 
-    set $name=value
+    set \$name=value
 
 Where:
 * name is a word matching the regex: /[a-z][a-z0-9_]*/. Lower case only.
@@ -14,7 +14,7 @@ To erase the value of a variable, use:         set $$name=
 To display the name/value of a variable, use:  set $$name
 To display all variable names/values use:      set
 
-As an escapement, the string $$$$ maps to a single $$.
+As an escapement, the strings $$$$ or \\$ map to a single $$.
 
 Some variables that are used in mysh are:
 
@@ -23,8 +23,8 @@ $$date_fmt    The format for the date: "%Y-%m-%d". ie: 2017-01-09
 $$debug       Does the shell display additional debugging info (true/false)
 $$h           The home folder's path
 $$name        The name given to this mysh session.
-$$post_prompt The prompt used when a line is continued with a trailing \\
-             character.
+$$post_prompt The prompt used when a line is continued with a trailing \
+             character. By default this just a single \
 $$pre_prompt  A prompt string displayed before the actual command prompt.
              Delete the pre_prompt variable to disable pre-prompting.
 $$prompt      The user prompt.

data/lib/mysh/input_wrapper.rb

@@ -1,62 +1,62 @@
 # coding: utf-8
 
-#* mysh/internal/input_wrapper.rb -- An action compatible wrapper for a input.
+# An action compatible wrapper for a input.
 module Mysh
 
-  #* mysh/internal/input_wrapper.rb -- An action compatible wrapper for a input.
+  # An action compatible wrapper for a input.
   class InputWrapper
 
-    #Build an input wrapper.
+    # Build an input wrapper.
     def initialize(raw)
       @raw = raw.chomp
       @raw_command = @raw_body = nil
     end
 
-    #Access the raw text.
+    # Access the raw text.
     attr_reader :raw
 
-    #Get the first raw character.
+    # Get the first raw character.
     def quick_command
       @raw[0] || ""
     end
 
-    #Get the balance of the raw string.
+    # Get the balance of the raw string.
     def quick_body
       @raw[1..-1] || ""
     end
 
-    #Get the command word if it exists.
+    # Get the command word if it exists.
     def raw_command
       @raw_command ||= @raw.split[0] || ""
     end
 
-    #Get the parameter text.
+    # Get the parameter text.
     def raw_body
       @raw_body ||= @raw[(raw_command.length + 1)..-1] || ""
     end
 
-    #Get the preprocessed argument text.
+    # Get the preprocessed argument text.
     def cooked_body
       raw_body.preprocess
     end
 
-    #Access the massaged text.
+    # Access the massaged text.
     def cooked
       body = cooked_body
       raw_command + (body.empty? ? "" : " " + body)
     end
 
-    #Get the parsed arguments
+    # Get the parsed arguments
     def args
       Mysh.parse_args(cooked_body)
     end
 
-    #Get the parsed command line.
+    # Get the parsed command line.
     def parsed
       [raw_command] + args
     end
 
-    #Set up input for a quick style command.
+    # Set up input for a quick style command.
     def quick
       @raw_command = quick_command
       @raw_body    = quick_body

data/lib/mysh/internal.rb

@@ -1,10 +1,22 @@
 # coding: utf-8
 
-require_relative 'internal/actions/actions_path'
-require_relative 'internal/action'
-require_relative 'internal/action_pool'
-require_relative 'internal/manage'
-require_relative 'internal/to_file_spec'
-
-#Load up the internal actions!
-Dir[Mysh::Action::ACTIONS_PATH + '*.rb'].each {|file| require file }
+module Mysh
+
+  # Set up the command action pool.
+  COMMANDS = ActionPool.new("COMMANDS")
+
+  # Try to execute the string as an internal action.
+  def self.try_execute_internal(input)
+    unless input.quick_command == ' '
+      if (action = COMMANDS[input.raw_command])
+        action.process_command(input)
+        :internal
+      end
+    end
+  end
+
+end
+
+# Load up the internal actions!
+load_spec = MYSH_LIB + "mysh/internal/*.rb"
+Dir[load_spec].each {|file| require file }

data/lib/mysh/internal/{actions/cd.rb → cd.rb}

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* mysh/internal/actions/cd.rb -- The mysh internal cd command.
+# The mysh internal cd command.
 module Mysh
 
-  #Add the cd command to the library.
+  # Add the cd command to the library.
   desc = 'Change directory to the optional <dir> parameter ' +
          'or display the current working directory.'
 

data/lib/mysh/internal/{actions/comment.rb → comment.rb}

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* mysh/internal/actions/comment.rb -- A mysh internal comment.
+# A mysh internal comment.
 module Mysh
 
-  #Add comments to the library.
+  # Add comments to the library.
   desc = 'A mysh comment. No action taken'
   action = lambda {|_input| :internal}
 

data/lib/mysh/internal/{actions/elapsed.rb → elapsed.rb}

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* mysh/internal/actions/elapsed.rb -- The mysh internal elapsed command.
+# The mysh internal elapsed command.
 module Mysh
 
-  #Add the elapsed commands to the library.
+  # Add the elapsed commands to the library.
   desc = 'Execute a command and then display the elapsed time. See ?% for more.'
 
   action = lambda do |input|

data/lib/mysh/internal/{actions/gls.rb → gls.rb}

@@ -1,18 +1,18 @@
 # coding: utf-8
 
-#* mysh/internal/actions/gls.rb -- The mysh gls (gem ls) command.
+# The mysh gls (gem ls) command.
 module Mysh
 
-  #* mysh/internal/actions/gls.rb -- The mysh gls (gem ls) command.
+  # The mysh gls (gem ls) command.
   class GlsCommand < Action
 
-    #Set up this command.
+    # Set up this command.
     def initialize(*args)
       super
       @report = @mask = @specs = nil
     end
 
-    #Execute the gls command.
+    # Execute the gls command.
     def process_command(input)
       process_args(input.args)
       gather_gems
@@ -57,9 +57,8 @@ module Mysh
       report.puts_format_output_bullets
     end
 
-    #Get detailed information on a gem specification.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Get detailed information on a gem specification.
+    # Endemic Code Smells   :reek:UtilityFunction
     def info(spec)
       [["name",        spec.name],
        ["version",     spec.version],

data/lib/mysh/internal/{actions/help.rb → help.rb}

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-#* mysh/internal/actions/help.rb -- The mysh internal help command.
+# The mysh internal help command.
 module Mysh
 
   # Help action pool of topics.
@@ -21,12 +21,11 @@ module Mysh
 
   HELP = ActionPool.new("HELP", default)
 
-  #* mysh/internal/actions/help.rb -- The mysh internal help command.
+  # The mysh internal help command.
   class HelpCommand < Action
 
-    #Execute a help command by routing it to a sub-command.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute a help command by routing it to a sub-command.
+    # Endemic Code Smells  :reek:UtilityFunction
     def process_command(input)
       args = input.args
       HELP[args[0] || ""].process_command(args)
@@ -37,12 +36,11 @@ module Mysh
   # The base help command.
   desc = 'Display help information for mysh with an optional topic. See ?? for more.'
   COMMANDS.add_action(HelpCommand.new('help <topic>', desc))
+
   #The help command action object.
   HELP_COMMAND = HelpCommand.new('?<topic>', desc)
   COMMANDS.add_action(HELP_COMMAND)
 end
 
-require_relative 'help/sub_help'
-
-#Load up the extra help actions!
-Dir[Mysh::Action::ACTIONS_PATH + 'help/*.rb'].each {|file| require file }
+# Load in support for help sub-topics
+require_relative 'support/sub_help'

data/lib/mysh/internal/{actions/history.rb → history.rb}

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* mysh/internal/actions/history.rb -- The mysh internal history command.
+# The mysh internal history command.
 module Mysh
 
-  #* mysh/internal/actions/history.rb -- The mysh internal history command.
+  # The mysh internal history command.
   class HistoryCommand < Action
 
     #Set up this command.
@@ -12,11 +12,11 @@ module Mysh
       @args = @history = nil
     end
 
-    #Execute the history command.
+    # Execute the history command.
     def process_command(input)
       @args, @history = input.args, Mysh.input.history
 
-      #The history command should not be part of the history.
+      # The history command should not be part of the history.
       @history.pop
 
       pull_index || clear_history || show_history
@@ -24,7 +24,7 @@ module Mysh
 
     private
 
-    #Deal with history index arguments
+    # Deal with history index arguments
     def pull_index
       index = @args[0].to_i
 
@@ -35,7 +35,7 @@ module Mysh
       end
     end
 
-    #Clear the history buffer.
+    # Clear the history buffer.
     def clear_history
       if @args[0] == 'clear'
         @history.clear
@@ -44,7 +44,7 @@ module Mysh
       end
     end
 
-    #Just show the history.
+    # Just show the history.
     def show_history
       pattern = Regexp.new(@args[0] || /./)
 
@@ -55,10 +55,11 @@ module Mysh
 
   end
 
-  #Add the history commands to the library.
+  # Add the history commands to the library.
   desc = 'Display the mysh command history. See ?! for more.'
   COMMANDS.add_action(HistoryCommand.new('history <arg>', desc))
-  #The history command action object.
+
+  # The history command action object.
   HISTORY_COMMAND = HistoryCommand.new('!<arg>', desc)
   COMMANDS.add_action(HISTORY_COMMAND)
 end