mysh 0.6.12 → 0.6.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1181f7c07f14be213795e5af840e9364e838ada9
-  data.tar.gz: 0005e8503ddd7a6905d834c85e01519f920ca65f
+  metadata.gz: da3781a854769fe73c280fd78399ddb6d26cdd64
+  data.tar.gz: 8e70d3df6a194b26e639deefdff63f9cc871fe1a
 SHA512:
-  metadata.gz: 536851ba0c923a4e2491d5abd50c417f8f3c6992cc61c885920d1c4654219c95efd40fbfcaf3a1574e94687a602248914b40a13a4a938f55993911d9903b3006
-  data.tar.gz: 5ccbc4d1709a355aa9d3a8b065aacee3dbe9c6620bcfb26f70fd27b8fedd89cffdeb03d88314dd747a7d0b3d64977c7f6f303673791e26127ce81569b511f852
+  metadata.gz: '099048a82d4c3f4e4f1f6951ec5d3bc90ad8229f22158308b2bcf1fc6a90d0f365c42a31c5fe9fa1f9c32ad609fb9c12d3a9a8d3d594128f10fbb7615902addd'
+  data.tar.gz: bdda1b66bfa676b915be21f8a6c4b1cf20212ec8ad0e4209ac1119a2e02a5b39c6539dc2f1b8c90342a707d24be5303fc34dbea17d31e8cde7567bea8012c321

data/README.md

@@ -423,6 +423,7 @@ $debug      | Does the shell display additional debugging info (true/false)
 $h          | The home folder's path
 $history    | Is command line history enabled?
 $name       | The name given to this mysh session.
+$no_dups    | Suppress duplicate entries in the history buffer.
 $no_move    | Entries are not moved up when pulled from the command history.
 $page_height| The page height.
 $page_msg   | The paging message. Default is "Press a key, a space, or q:"
@@ -435,6 +436,7 @@ $r          | The location of the Ruby compiler.
 $s          | The location of the host command interpreter.
 $t          | The current time.
 $time_fmt   | The format for the time: "%H:%M"
+$type       | Does the type command operate in cooked or raw mode. Default is raw mode.
 $u          | The current user.
 $w          | The current working directory's path.
 
@@ -558,18 +560,19 @@ none       | General help on mysh.
 @          | Help on the show command.
 env        | Help on the show env command.
 gem        | Help on the show gem command.
-gls        | Help on gls internal mysh command.
+gls        | Help on the gls command.
 help       | This help on the help command.
 history    | Help on the history command.
 init       | Help on mysh initialization.
 kbd        | Help on mysh keyboard mapping.
 math       | Help on math functions.
-mls        | Help on mls internal mysh command.
+mls        | Help on the mls command.
 quick      | Help on quick commands.
 ruby       | Help on the show ruby command.
 set        | Help on mysh variables.
 show       | Help on the show command.
 term       | Help on the show term command.
+type       | Help on the type command.
 types      | Help on mysh file types.
 usage      | Help on mysh usage options.
 {{         | Help on mysh handlebars.
@@ -714,7 +717,7 @@ pwd              | Display the current working directory.
 say <stuff>      | Display the text in the command arguments.
 set <$name>=value| Set/query mysh variables.
 show <item>      | Display information about a part of mysh.
-type <file>      | Display a text file with support for optional embedded handlebars and mysh variables.
+type <file>      | Display one or more text files with optional support for embedded handlebars and shell variables.
 
 Notes:
 1. The notation {x} means that x is optional.

data/lib/mysh.rb

@@ -7,24 +7,31 @@ require 'English'
 require 'in_array'
 require 'pause_output'
 require 'format_output'
+require 'mini_readline'
+
+# The path to the gem lib folder.
+MYSH_LIB = (File.expand_path(File.dirname(__FILE__)) + "/").freeze
 
 require_relative 'mysh/exceptions'
+require_relative 'mysh/string_helpers'
 require_relative 'mysh/input_wrapper'
 require_relative 'mysh/user_input'
+require_relative 'mysh/action'
+require_relative 'mysh/action_pool'
 require_relative 'mysh/internal'
 require_relative 'mysh/quick'
 require_relative 'mysh/external'
+require_relative 'mysh/command_line'
 require_relative 'mysh/system'
 require_relative 'mysh/handlebars'
 require_relative 'mysh/shell_variables'
-require_relative 'mysh/pre_processor'
 require_relative 'mysh/process'
 require_relative 'mysh/globalize'
-require_relative 'mysh/init'
+require_relative 'mysh/load_init_file'
 require_relative 'mysh/expression'
 require_relative 'mysh/version'
 
-# The Mysh (MY SHell) module. A container for mysh and its functionality.
+# The Mysh (MY SHell) module.
 module Mysh
 
   # The actual shell method.

data/lib/mysh/{internal/action.rb → action.rb}

@@ -1,35 +1,35 @@
 # coding: utf-8
 
-#* mysh/internal/action.rb -- The framework of mysh internal actions.
+# The framework of mysh internal actions.
 module Mysh
 
-  #The mysh internal action class.
+  # The mysh internal action class.
   class Action
-    #The name of the action.
+    # The name of the action.
     attr_reader :name
 
-    #The description of the action.
+    # The description of the action.
     attr_reader :description
 
-    #Setup an internal action.
+    # Setup an internal action.
     def initialize(name = "", description = "", &action)
       @name, @description = name, description.in_array
 
       define_singleton_method(:process_command, &action) if block_given?
     end
 
-    #Parse the string and call the action.
+    # Parse the string and call the action.
     def process_quick_command(input)
       process_command(input.quick)
       :internal
     end
 
-    #Get information about the action.
+    # Get information about the action.
     def action_info
       [@name].concat(@description)
     end
 
-    #Get the name without any argument descriptions.
+    # Get the name without any argument descriptions.
     def short_name
       name.split[0] || ""
     end

data/lib/mysh/{internal/action_pool.rb → action_pool.rb}

@@ -1,31 +1,31 @@
 # coding: utf-8
 
-#* mysh/internal/action_pool.rb -- A managed hash of mysh actions.
+# A managed hash of mysh actions.
 module Mysh
 
-  #* A managed hash of mysh actions.
+  # A managed hash of mysh actions.
   class ActionPool
 
-    #The name of this action pool.
+    # The name of this action pool.
     attr_reader :pool_name
 
-    #Create a new action pool
+    # Create a new action pool
     def initialize(pool_name, default_action = nil)
       @pool_name, @pool = pool_name, {}
       @pool.default = default_action
     end
 
-    #Get a action.
+    # Get a action.
     def [](index)
       @pool[index]
     end
 
-    #Does this action exist?
+    # Does this action exist?
     def exists?(index)
       @pool.key?(index)
     end
 
-    #Add an action to the pool.
+    # Add an action to the pool.
     def add_action(action)
       short_name = action.short_name
 
@@ -36,7 +36,7 @@ module Mysh
       @pool[short_name] = action
     end
 
-    #Get information on all actions.
+    # Get information on all actions.
     def actions_info
       @pool
         .values

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

@@ -1,23 +1,23 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line.rb -- The mysh internal command line option.
+# The command line options of mysh.
 module Mysh
 
   # Action pool of command line options.
   COMMAND_LINE = ActionPool.new("COMMAND_LINE")
 
-  #* mysh/internal/actions/command_line.rb -- The mysh internal command line option.
+  # A mysh command line option.
   class CommandOption < Action
 
-    #Execute a pre-boot command line option.
+    # Execute a pre-boot command line option.
     def pre_boot(_args); end
 
-    #Execute a post-boot command line option.
+    # Execute a post-boot command line option.
     def post_boot(_args); end
 
     alias :process_command :pre_boot
 
-    #Get an argument for an option.
+    # Get an argument for an option.
     def get_arg(read_point)
       result = read_point.next
       fail if COMMAND_LINE.exists?(result) #An arg should not be a command!
@@ -28,9 +28,8 @@ module Mysh
 
   end
 
-  #Execute command line options.
-  #<br>Endemic Code Smells
-  #* :reek:TooManyStatements
+  # Execute command line options.
+  # Endemic Code Smells   :reek:TooManyStatements
   def self.process_command_args(args, phase)
     read_point = args.each
 
@@ -56,5 +55,6 @@ module Mysh
 
 end
 
-#Load up the extra help actions!
-Dir[Mysh::Action::ACTIONS_PATH + 'command_line/*.rb'].each {|file| require file }
+# Load up the extra help actions!
+path = MYSH_LIB + "mysh/command_line/*.rb"
+Dir[path].each {|file| require file }

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
@@ -33,8 +32,7 @@ class Object
     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/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/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