mysh 0.6.11 → 0.6.17

data/lib/mysh/{internal/actions/command_line → command_line}/pause.rb

@@ -5,9 +5,8 @@ module Mysh
   # The page pause option.
   class PauseOption < CommandOption
 
-    #Execute the help command line option.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute the help command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
     def post_boot(_args)
       MNV[:page_pause] = "on"
     end
@@ -18,16 +17,15 @@ module Mysh
 
   end
 
-  #Add the pause command line option to the library.
+  # Add the pause command line option to the library.
   desc = 'Turn on page pauses.'
   COMMAND_LINE.add_action(PauseOption.new('--pause', desc))
 
   # The no page pause option.
   class NoPauseOption < CommandOption
 
-    #Execute the help command line option.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute the help command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
     def post_boot(_args)
       MNV[:page_pause] = "off"
     end
@@ -38,7 +36,7 @@ module Mysh
 
   end
 
-  #Add the no pause command line option to the library.
+  # Add the no pause command line option to the library.
   desc = 'Turn off page pauses.'
   COMMAND_LINE.add_action(NoPauseOption.new('--no-pause', desc))
 end

data/lib/mysh/{internal/actions/command_line → command_line}/post_prompt.rb

@@ -1,43 +1,41 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line/prompt.rb -- The mysh post prompt command.
+# The mysh post prompt command.
 module Mysh
 
-  #* mysh/internal/actions/command_line/post_prompt.rb -- The mysh post prompt command.
+  # The mysh post prompt command.
   class PostpromptOption < CommandOption
 
-    #Skip over the argument for pre_boot.
+    # Skip over the argument for pre_boot.
     def pre_boot(read_point)
       get_arg(read_point)
     end
 
-    #Execute the prompt command line option.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute the prompt command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
     def post_boot(read_point)
       MNV[:post_prompt] = get_arg(read_point)
     end
 
   end
 
-  #Add the post prompt command line option to the library.
+  # Add the post prompt command line option to the library.
   desc = 'Set the mysh line continuation prompt to "str".'
   COMMAND_LINE.add_action(PostpromptOption.new('--post-prompt "str"', desc))
   COMMAND_LINE.add_action(PostpromptOption.new('-pp "str"', desc))
 
-  #* mysh/internal/actions/command_line/post_prompt.rb -- The mysh command no post prompt.
+  # The mysh command no post prompt.
   class NoPostpromptOption < CommandOption
 
-    #Execute the no post prompt command line option.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute the no post prompt command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
     def post_boot(_args)
       MNV[:post_prompt] = ""
     end
 
   end
 
-  #Add the prompt command line option to the library.
+  # Add the prompt command line option to the library.
   desc = 'Turn off mysh post prompting.'
   COMMAND_LINE.add_action(NoPostpromptOption.new('--no-post-prompt', desc))
   COMMAND_LINE.add_action(NoPostpromptOption.new('-npp', desc))

data/lib/mysh/{internal/actions/command_line → command_line}/pre_prompt.rb

@@ -1,43 +1,41 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line/prompt.rb -- The mysh pre_prompt command.
+# The mysh pre_prompt command.
 module Mysh
 
-  #* mysh/internal/actions/command_line/pre_prompt.rb -- The mysh pre_prompt command.
+  # The mysh pre_prompt command.
   class PrepromptOption < CommandOption
 
-    #Skip over the argument for pre_boot.
+    # Skip over the argument for pre_boot.
     def pre_boot(read_point)
       get_arg(read_point)
     end
 
-    #Execute the prompt command line option.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute the prompt command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
     def post_boot(read_point)
       MNV[:pre_prompt] = get_arg(read_point)
     end
 
   end
 
-  #Add the pre prompt command line option to the library.
+  # Add the pre prompt command line option to the library.
   desc = 'Set the mysh pre prompt to "str".'
   COMMAND_LINE.add_action(PrepromptOption.new('--pre-prompt "str"', desc))
   COMMAND_LINE.add_action(PrepromptOption.new('-pr "str"', desc))
 
-  #* mysh/internal/actions/command_line/pre_prompt.rb -- The mysh command no pre_prompt.
+  # The mysh command no pre_prompt.
   class NoPrepromptOption < CommandOption
 
-    #Execute the no pre_prompt command line option.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute the no pre_prompt command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
     def post_boot(_args)
       MNV[:pre_prompt] = ""
     end
 
   end
 
-  #Add the prompt command line option to the library.
+  # Add the prompt command line option to the library.
   desc = 'Turn off mysh pre prompting.'
   COMMAND_LINE.add_action(NoPrepromptOption.new('--no-pre-prompt', desc))
   COMMAND_LINE.add_action(NoPrepromptOption.new('-npr', desc))

data/lib/mysh/{internal/actions/command_line → command_line}/prompt.rb

@@ -1,41 +1,40 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line/prompt.rb -- The mysh prompt command.
+# The mysh prompt command.
 module Mysh
 
-  #* mysh/internal/actions/command_line/prompt.rb -- The mysh prompt command.
+  # The mysh prompt command.
   class PromptOption < CommandOption
 
-    #Skip over the argument for pre_boot.
+    # Skip over the argument for pre_boot.
     def pre_boot(read_point)
       get_arg(read_point)
     end
 
-    #Execute the prompt command line option.
+    # Execute the prompt command line option.
     def post_boot(read_point)
       MNV[:prompt] = get_arg(read_point)
     end
 
   end
 
-  #Add the prompt command line option to the library.
+  # Add the prompt command line option to the library.
   desc = 'Set the mysh prompt to "str".'
   COMMAND_LINE.add_action(PromptOption.new('--prompt "str"', desc))
   COMMAND_LINE.add_action(PromptOption.new('-p "str"', desc))
 
-  #* mysh/internal/actions/command_line/prompt.rb -- The mysh prompt command no prompt.
+  # The mysh prompt command no prompt.
   class NoPromptOption < CommandOption
 
-    #Execute the no prompt command line option.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute the no prompt command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
     def post_boot(_args)
       MNV[:prompt] = ""
     end
 
   end
 
-  #Add the prompt command line option to the library.
+  # Add the prompt command line option to the library.
   desc = 'Turn off mysh prompting.'
   COMMAND_LINE.add_action(NoPromptOption.new('--no-prompt', desc))
   COMMAND_LINE.add_action(NoPromptOption.new('-np', desc))

data/lib/mysh/command_line/quit.rb

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+# The mysh quit command.
+module Mysh
+
+  # The mysh quit command.
+  class QuitOption < CommandOption
+
+    # Execute the quit command line option.
+    def post_boot(_args)
+      exit
+    end
+
+  end
+
+  # Add the quit command line option to the library.
+  desc = "Exit a nested mysh file or command."
+  COMMAND_LINE.add_action(QuitOption.new('--quit', desc))
+end

data/lib/mysh/{internal/actions/command_line → command_line}/usage.rb

@@ -1,19 +1,19 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line/usage.rb -- The mysh help command usage.
+# The mysh help command usage.
 module Mysh
 
-  #* mysh/internal/actions/command_line/usage.rb -- The mysh help command usage.
+  # The mysh help command usage.
   class UsageOption < CommandOption
 
-    #Execute the help command line option. (Punt to error handler with no msg)
+    # Execute the help command line option. (Punt to error handler with no msg)
     def pre_boot(_args)
       raise MyshUsage
     end
 
   end
 
-  #Add the usage command line option to the library.
+  # Add the usage command line option to the library.
   desc = 'Display mysh usage info and exit.'
 
   USAGE = UsageOption.new('--help', desc)

data/lib/mysh/external.rb

@@ -1,11 +1,10 @@
 # coding: utf-8
 
-#* mysh/external.rb -- Support for executing external files.
+# Support for executing external files.
 module Mysh
 
-  #Try to execute an external file.
-  #<br>Endemic Code Smells
-  #* :reek:TooManyStatements
+  # Try to execute an external file.
+  # Endemic Code Smells   :reek:TooManyStatements
   def self.try_execute_external(input)
     args = input.parsed
     file_name = args.shift

data/lib/mysh/globalize.rb

@@ -1,16 +1,15 @@
 # coding: utf-8
 
-#Monkey patches for mysh global entities.
+# Monkey patches for mysh global entities.
 class Object
 
-  #Make the environment variable store accessible everywhere.
+  # Make the environment variable store accessible everywhere.
   MNV = Mysh::MNV
 
   private
 
-  #The mysh equivalent of the system method.
-  #<br>Endemic Code Smells
-  #* :reek:UtilityFunction
+  # The mysh equivalent of the system method.
+  # Endemic Code Smells  :reek:UtilityFunction
   def mysh(str)
     Mysh.try_execute_command(str)
   end
@@ -20,21 +19,13 @@ class Object
     raise MyshExit
   end
 
-  # Run some code with no wuccas.
-  def insouciant
-    yield
-  rescue => err
-    err.to_s
-  end
-
   # Get the latest version for the named gem. Patched code.
   def latest_version_for(name, fetcher=nil)
     dependency = Gem::Dependency.new(name)
     fetcher  ||= Gem::SpecFetcher.new
 
     if specs = fetcher.spec_for_dependency(dependency)[0][-1]
-      spec = specs[0]
-      spec && spec.version
+      specs[0].version
     else
       "<Not found in repository>"
     end

data/lib/mysh/handlebars.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-require_relative 'handlebars/string'
+require_relative 'handlebars/eval_handlebars'
 
 # Handlebar embedded ruby support.
 class Object
@@ -21,5 +21,3 @@ private
   end
 
 end
-
-

data/lib/mysh/handlebars/{string.rb → eval_handlebars.rb}

@@ -7,14 +7,15 @@ class String
   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)
 
-      if not text.empty?
+      unless text.empty?
         text = text.gsub(/\\[{}]/) {|found| found[1]}
         buffer << "_m_<<#{text.inspect};"
-      elsif buffer.empty?
-        buffer << ""
+      else
+        buffer << "" if buffer.empty?
       end
 
       unless code.empty?
@@ -26,6 +27,7 @@ class String
       end
     end
 
+    # Evaluate the result of the translation.
     if buffer.length > 1
       evaluator.eval("_m_ = '';" + buffer.join + "_m_")
     else

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}/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.