mysh 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e859f5e9fd3f2d6d4e88de719444088195e2d1e0
-  data.tar.gz: e2eb0dacb82603274b4511a7b6f72f366230649e
+  metadata.gz: 7927b9f18a9a450e85b27f329ef62a9cc4dc212b
+  data.tar.gz: d058babe1aadabcb1b63bb5eaa9af689f2674ab5
 SHA512:
-  metadata.gz: 09493f5a93d52dbe8812cbf01c7cf3418fb0f2c627935f258b86b4819ee874ce986453eb5a43c98b67da911fc95ee39062dde4795c1d2fe4db86b394702c21cf
-  data.tar.gz: abde27a389011b5175a46579c5878a4e514a6906d178893df5623f9df4cbbbecf1b496e3acf315ca0bf661d1299c6b89683075863437ad81d458ee84b174c7ef
+  metadata.gz: 40c991266f6c8b9185d2c635ba496cd3c6ba593744efa299cd088767f03f3be63400b05fafc1a6db31567e447a7fa21fddc9144476b564b85b0eaea7a6902398
+  data.tar.gz: 96f671dec8eaba3798c5bd807c54ae681c588f69c9b530cda545af70e3c9fff8f0f5481018d3d065cefa7ec9ef26ce89be26c0de9702ea94525baba8dd91fa37

data/README.md

@@ -47,29 +47,68 @@ The mysh gem includes a simple executable called mysh. The template for running
 the mysh is:
 
 ```
-mysh <args>
+mysh <options>
 ```
 
-Where args are currently a work in progress and not available at this time.
-
-When mysh is run, the user is presented with a command prompt:
+Where the available options are:
+
+Option               | Short Form  | Description
+---------------------|-------------|---------------------------
+--debug              | -d          | Turn on mysh debugging.
+--no-debug           | -nd         | Turn off mysh debugging.
+--help               | -? -h       | Display mysh usage info and exit.
+--init filename      | -i filename | Initialize mysh by loading the specified file.
+--no-init            | -ni         | Do not load a file to initialize mysh.
+--load filename      | -l filename | Load the specified file into the mysh.
+--post-prompt "str"  | -pp "str"   | Set the mysh line continuation prompt to "str".
+--no-post-prompt     | -npp        | Turn off mysh line continuation prompting.
+--pre-prompt "str"   | -pr "str"   | Set the mysh pre prompt to "str".
+--no-pre-prompt      | -npr        | Turn off mysh pre prompting.
+--prompt "str"       | -p "str"    | Set the mysh prompt to "str".
+--no-prompt          | -np         | Turn off mysh prompting.
+--quit               |             | Quit out of the mysh program.
+
+<br>When mysh is run, the user is presented with a command prompt:
 
 ```
 $ mysh
 /cygdrive/c/Sites/mysh
 mysh>
-
 ```
+
 Now the user (that's you) may enter commands that hopefully increase the level
 of awesome coolness in the known universe. Entropy does not take vacations so
 hop to it! :-)
 
+Now that we've launched mysh, what exactly does it do? This can be summarized
+with just two words: Boot and REPL.
+
+###Boot
+
+When mysh starts up, it, like most programs must first get itself initialized
+and acclimated to its environment. The boot/initialization  process of mysh is
+somewhat modeled after (well if I'm honest, more like inspired by) that of the
+famous bash shell. On startup:
+
+1. Process pre-boot options. Some command line options are processed early.
+These are --help, -h, -?, --init, -i, --no-init, -ni, and --quit. See above
+for details on these.
+2. Try to load and execute the mysh init file. There are two possible files
+for this role. They are the ~/mysh_init.mysh and ~/mysh_init.rb files. If
+both files should be present, the .mysh file is processed and the .rb is
+ignored. NOTE: If an init file should be specified with the --init (-i)
+option, or disabled with the --no-init (-ni) option, this step is skipped.
+3. The rest of the command line options are processed at this time. Again,
+see above for details.
+
+
 ###REPL
 
-Now for a little more detail. The mysh program is built around a design pattern
-called REPL. This stands for Read Eval Print and Loop and is used in may
-utilities like irb, pry and the rails console. To better use mysh, it is good
-to understand each of these four operating steps.
+Now for a little more detail about what happens after booting up. The mysh
+program is built around a design pattern called REPL. This stands for Read Eval
+Print and Loop and is used in may utilities like irb, pry and the rails
+console. To better use mysh, it is good to understand each of these four
+operating steps.
 
 ####READ
 
@@ -126,8 +165,10 @@ be taken for the input. The four types are:
 character in the input. These signature characters are:
   * ! to access the mysh command history buffer. For more information see
   Command History below.
+  * \# a comment. Performs no operation.
   * $ to access or update mysh variables. For more information see Shell
   Variables below.
+  * % to execute a command and then display the elapsed execution time.
   * = to evaluate an expression of Ruby code. For more information see Ruby
   Expressions below.
   * ? to access the mysh help subsystem. For more information see Shell Help
@@ -137,10 +178,11 @@ character in the input. These signature characters are:
 
 2. Internal Commands - These commands are recognized by having the first word
 in the input match a word stored in an internal hash of command actions. For
-more information see Interanl Commands below.
-3. External Ruby Commands - These commands are recognized by having the first
-word in the input have the extension (*.rb) of a ruby source file. For more
-information see External Ruby Commands below.
+more information see Internal Commands below.
+3. External mysh files - These commands are recognized by having the first
+word in the input have a recognized extension. That is (*.rb) of a ruby source
+file, (*.mysh) for a mysh script file and (*.txt) for a text file. For more
+information see External Mysh Commands below.
 4. External Commands - Any command not matching any of the above is sent to the
 system shell for execution. For more information see External Commands below.
 
@@ -222,14 +264,11 @@ baz yes
 
 The processing of input continues (looping) until it doesn't. This occurs when
 a command to stop looping is entered or the mini_readline gem signals
-end-of-input condition. The commands that do this are:
+end-of-input condition. The (internal) commands that do this are:
 
 * exit - exit the current mysh level.
 * quit - terminate the mysh program.
 
-Work-in-progress - mysh only has one level at this time so these two commands
-do exactly the same thing... for now!
-
 An end-of-input condition is signaled by the user by entering Ctrl-z (in
 windows) or Alt-z (in Linux/Mac). See the mini_readline gem (link above) for
 more information on the keyboard mappings used by mysh.
@@ -268,7 +307,7 @@ those cases, simply end the expression with a '#' character. For example:
 
 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 \}
+like: \\{  or \\}
 
 ### Command History
 
@@ -305,9 +344,7 @@ To display the name/value of a variable, use:
 
     $name
 
-To display all variable names/values use:
-
-    $
+To display all variable names/values use just enter a single $ sign.
 
 As an escapement, the string $$ maps to a single $.
 
@@ -319,7 +356,7 @@ $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.
+$post_prompt| The prompt used when a line is continued with a trailing \\ character. By default this is the same as the normal prompt.
 $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.
@@ -434,6 +471,7 @@ math       | Help on math functions.
 quick      | Help on quick commands.
 ruby       | Help on the show ruby command.
 show       | Help on the show command.
+usage      | Help on mysh usage options.
 {{         | Help on mysh handlebars.
 
 
@@ -500,17 +538,42 @@ Command        | Description
 cd {dir}       | Change directory to the optional dir parameter and then display the current working directory.
 exit           | Exit mysh.
 gls {-l} {mask}| Display the loaded ruby gems. Use optional -l for a more details and a mask to limit output.
-history {index}| Display the mysh command history, or if an index is specified, retrieve the command with that index value.
+history {index}| The mysh command history. If an index is specified, get the command with that index value.
+load file      | Load a ruby program, mysh script, or text file into the mysh environment.
 pwd            | Display the current working directory.
 quit           | Exit mysh.
-type           | Display a text file with optional embedded handlebars.
+say <stuff>    | Display the text in the command arguments.
+type file      | Display a text file with support for optional embedded handlebars and mysh variables.
 vls {mask}     | Display the loaded modules, matching the optional mask, that have version info.
 
-### External Ruby Commands
+Note that the load command applied to a mysh script file acts exactly the same
+as if the script file were executed directly from the command line. As a
+result of this:
 
-Any command that ends with a ".rb" extension will be sent as the target of the
-ruby interpreter. So for example, let's run the test.rb file located in the
-samples folder:
+```
+myfile.mysh
+load myfile.mysh
+```
+do the same thing. In addition:
+```
+myfile.txt
+load myfile.txt
+type myfile.txt
+```
+are also all equivalent. See External Mysh Commands below for more info.
+
+### External Mysh Commands
+
+These commands are recognized by having the first word in the input have a
+recognized extension. These are:
+
+Extension      | Description
+---------------|----------------------------------------------------
+.rb            | A ruby source file executed via a new instance of the compiler.
+.mysh          | A mysh script file. Commands in this file are executed as if the user typed them in at the console.
+.txt           | A text file. The file (with any embedded code and veriables) is displayed on the console.
+
+Here is a sample session with an external Ruby program.
 
 ```
 mysh>$debug = on
@@ -544,6 +607,10 @@ require "mysh"
 Mysh.run
 ```
 
+The run command takes an optional array of command line style options similar
+in nature to the ARGV ruby constant. If omitted, mysh is run with no optional
+parameters. These parameters are documented in the Usage section above.
+
 #### Adding New Commands
 
 It is possible to add new internal commands to the mysh CLI. This may done

data/lib/mysh.rb

@@ -5,6 +5,8 @@
 require 'English'
 require 'in_array'
 
+require_relative 'mysh/exceptions'
+require_relative 'mysh/binding_wrapper'
 require_relative 'mysh/user_input'
 require_relative 'mysh/quick'
 require_relative 'mysh/expression'
@@ -13,55 +15,27 @@ require_relative 'mysh/external_ruby'
 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/version'
 
 #The Mysh (MY SHell) module. A container for mysh and its functionality.
 module Mysh
 
   #The actual shell method.
-  def self.run
-    setup
-
-    while @mysh_running do
-      execute_a_command(get_command)
-    end
-  end
-
-  #Common initialization tasks.
-  def self.setup
-    reset_host
-    init_input
-    @mysh_running = true
-  end
-
-  #Execute a single line of input and handle exceptions.
-  def self.execute_a_command(str)
-    try_execute_command(str)
-
-  rescue MiniReadlineEOI
-    @mysh_running = false
-
-  rescue Interrupt, StandardError, ScriptError => err
-    puts "Error #{err.class}: #{err}"
-    puts err.backtrace if MNV[:debug]
-  end
-
-  #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]
+  def self.run(args=[])
+    process_command_args(args, :pre_boot)
+    mysh_load_init
+    process_command_args(args, :post_boot)
 
-    try_execute_quick_command(input)    ||
-    try_execute_internal_command(input) ||
-    try_execute_external_ruby(input)    ||
-    system(input)
+    process_console
   end
 
+  reset_host
 end
 
 if __FILE__ == $0
-  Mysh.run  #Run a shell if this file is run directly.
+  Mysh.run(ARGV)  #Run a shell if this file is run directly.
 end

data/lib/mysh/binding_wrapper.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+#* mysh/internal/binding_wrapper.rb -- An action compatible wrapper for a binding.
+module Mysh
+
+  #* mysh/internal/binding_wrapper.rb -- An action compatible wrapper for a binding.
+  class BindingWrapper
+
+    #Setup a binding wrapper
+    def initialize(binding)
+      @exec_binding = binding
+    end
+
+    #Evaluate the string in the wrapped context.
+    def mysh_eval(str)
+      @exec_binding.eval(str)
+    end
+
+  end
+
+end

data/lib/mysh/exceptions.rb

@@ -0,0 +1,4 @@
+# coding: utf-8
+
+#Exit the current mysh processing loop.
+class MyshExit < Exception; end

data/lib/mysh/expression.rb

@@ -20,7 +20,7 @@ module Mysh
       #Set up a new execution environment
       def initialize
         $mysh_exec_result  = nil
-        $mysh_exec_binding = binding
+        $mysh_exec_binding = mysh_binding
       end
 
       #Do the actual work of executing an expression.
@@ -36,6 +36,13 @@ module Mysh
         "exec_host"
       end
 
+      #Evaluate the string in the my shell context.
+      def mysh_eval(str)
+        $mysh_exec_binding.eval(str)
+      end
+
+      private
+
       #Get the previous result
       def result
          $mysh_exec_result
@@ -47,9 +54,9 @@ module Mysh
         nil
       end
 
-      #Evaluate the string in the my shell context.
-      def mysh_eval(str)
-        $mysh_exec_binding.eval(str)
+      #Create a binding for mysh to execute expressions in.
+      def mysh_binding
+        binding
       end
     end
 

data/lib/mysh/external_ruby.rb

@@ -4,16 +4,29 @@
 module Mysh
 
   #Try to execute as a Ruby program.
+  #<br>Endemic Code Smells
+  #* :reek:TooManyStatements
   def self.try_execute_external_ruby(str)
-    cmd = str.split[0]
+    args = parse_args(str.chomp)
+    file_name = args.shift
 
-    if cmd && File.extname(cmd) == '.rb'
-      new_command = "#{RbConfig.ruby} #{str}"
-      puts "=> #{new_command}"  if MNV[:debug]
-      system(new_command)
-      :ruby_exec
-    end
+    if (file_name)
+      ext = File.extname(file_name)
 
+      if ext == '.rb'
+        new_command = "#{RbConfig.ruby} #{str}"
+        puts "=> #{new_command}"  if MNV[:debug]
+        system(new_command)
+        :ruby_exec
+      elsif ext == '.mysh'
+        Mysh.process_file(file_name)
+        :mysh_script
+      elsif ext == '.txt'
+        exec_host = BindingWrapper.new(binding)
+        show_handlebar_file(file_name, exec_host)
+        :internal
+      end
+    end
   end
 
 end

data/lib/mysh/globalize.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+#Monkey patches for mysh global entities.
+class Object
+
+  #Make the environment variable store accessible everywhere.
+  MNV = Mysh::MNV
+
+  private
+
+  #The mysh equivalent of the system method.
+  #<br>Endemic Code Smells
+  #* :reek:UtilityFunction
+  def mysh(str)
+    Mysh.try_execute_command(str)
+  end
+
+end

data/lib/mysh/handlebars.rb

@@ -10,9 +10,6 @@ class Object
   #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.

data/lib/mysh/init.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+#* mysh/init.rb -- The mysh init file loader.
+module Mysh
+
+  #Set the init file used to startup mysh to none so far.
+  $mysh_init_file = nil
+
+  #Perform init phase processing.
+  def self.mysh_load_init
+
+    unless $mysh_init_file || !(home = ENV['HOME'])
+      name_mysh = home + '/mysh_init.mysh'
+      name_rb = home + '/mysh_init.rb'
+
+      if File.file?(name_mysh)
+        process_file($mysh_init_file = name_mysh)
+      elsif File.file?(name_rb)
+        load ($mysh_init_file = name_rb)
+      end
+    end
+
+    $mysh_init_file = '<none found>' unless $mysh_init_file
+  end
+
+end