mysh 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f48cf4dd1465e70ce3a405c1bfe36b4ec8d2f9e7
-  data.tar.gz: 4d2b8050dcb6d6b2bc7dc98c8cd46e3f5e3c94f0
+  metadata.gz: e474248b127024d5dc807794564924ba04f5f21c
+  data.tar.gz: 712489e71e81a7202a2a54c7d1b18fc67fc58628
 SHA512:
-  metadata.gz: 8aa9d57df88528886ef6784d8ff4c0ca974ebe807f8197e4c4f89133ce4ceae116e3cada4939b0a01d17855e8b9f378eabb8c33308302f4447a66cd8306ea43d
-  data.tar.gz: 4d8a2012d6abe99be8bfdb8929c25d780a6318e1474d7bafecd7cfd57fcad1cc9f50f2dec92bbd44d87b1d832d6a9ba272e60dcd970768dd35531979002b6b76
+  metadata.gz: 2d9b6f82a8a2bc3430f209753b7a07753aa74dfcda8a6233bc010ef7eb15a45490b214ffe63ff1edae3e1c18ebc24a1c6a11909711664f14be6c913139c9e8c0
+  data.tar.gz: 24073b1333985dae86d44167841b7ca41d91401606cf1a4ca702a1b205702f9da474d9b98e531ac213a8ddda79dddc0b3283417a46a1b9ff3f913d0b52f39bd3

data/README.md

@@ -45,11 +45,16 @@ Or install it yourself as:
 
 ## Usage
 
-The mysh gem includes a simple executable called mysh. When run, the user is
-presented with a command prompt:
+The mysh gem includes a simple executable called mysh. Command entry is a
+typical cli. For more information, see the mini_readline gem at
+( https://github.com/PeterCamilleri/mini_readline )
 
-    $ mysh
-    mysh>
+When running mysh, the user is presented with a command prompt:
+
+```
+$ mysh
+mysh>
+```
 
 Then start entering some commands! This prompt can be used to execute four
 sorts of commands:
@@ -76,6 +81,26 @@ reset      Reset the execution environment to the default state.
 result     Returns the result of the previous expression.
 x.lineage  Get the class lineage of the object x.
 ```
+For example:
+```
+mysh>=a=42
+42
+mysh>=a
+42
+mysh>=result
+42
+mysh>=a.lineage
+"Fixnum instance < Fixnum < Integer < Numeric < Object < BasicObject"
+mysh>=reset
+
+mysh>=a
+NameError: undefined local variable or method `a' for #<Mysh::ExecHost:0x1d71e18 @owner=Mysh>
+mysh>=result
+
+mysh>
+```
+
+
 
 The Ruby expression execution environment has direct access to many advanced
 Math functions. For example, to compute the cosine of 3.141592653589793 use:
@@ -125,31 +150,54 @@ Internal commands are recognized by name and are executed by mysh directly.
 The following set of commands are supported:
 
 ```
-!            Display the mysh command history.
-? <topic>    Display help information for mysh with an optional topic.
-cd <dir>     Change directory to the optional <dir> parameter and then display
-             the current working directory.
-exit         Exit mysh.
-help <topic> Display help information for mysh with an optional topic.
-history      Display the mysh command history.
-pwd          Display the current working directory.
-quit         Exit mysh.
-show <file>  Display a text file with optional embedded handlebars.
-vls <mask>   Display the loaded modules, matching the optional mask, that have
-             version info.
+!<index>        Display the mysh command history, or if an index is specified,
+                retrieve the command with that index value.
+?<topic>        Display help information for mysh with an optional topic.
+@<item>         Display information about a part of mysh. See ?@ for more.
+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. See ?gls for more.
+help <topic>    Display help information for mysh with an optional topic.
+history <index> Display the mysh command history, or if an index is specified,
+                retrieve the command with that index value.
+pwd             Display the current working directory.
+quit            Exit mysh.
+show <item>     Display information about a part of mysh. See ?@ for more.
+type            Display a text file with optional embedded handlebars.
+vls <mask>      Display the loaded modules, matching the optional mask, that
+                have version info.
 ```
-Of note is the command "help help" which provides a list of available topics.
+Of note is the command "help help" or "??" which provides a list of all
+available help topics.
 
-    The help (or ?) command is used to get either general help about mysh
-    or an optional specified topic.
-
-    The available help topics are:
-
-         General help on mysh.
-    =    Help on mysh ruby expressions.
-    ?    Help on mysh help.
-    help Help on mysh help.
-    math Help on mysh math functions.
+```
+Help: mysh help command summary:
+
+The help (or ?) command is used to get either general help about mysh or an
+optional specified topic.
+
+If the longer form, help is used, a space is required before the topic. If the
+quick form, ? is used, the space is optional.
+
+The available help topics are:
+
+        General help on mysh.
+!       This help on the history command.
+=       Help on ruby expressions.
+?       This help on the help command.
+@       Help on the show command.
+env     Help on the show env command.
+gls     Help on gls internal mysh command.
+help    This help on the help command.
+history This help on the history command.
+kbd     Help on mysh keyboard mapping.
+math    Help on math functions.
+quick   Help on quick commands.
+ruby    Help on the show ruby command.
+show    Help on the show command.
+{{      Help on mysh handlebars.
+```
 
 #### External commands:
 
@@ -184,19 +232,25 @@ located at:
 
 A survey of the contents of that folder will reveal the nature of these files.
 
-New internal commands may also be added in code via the the add method of the
-InternalCommand class of the Mysh module. The code to do this would look
+New internal commands may also be added in code via the the add_action method
+of the InternalCommand class of the Mysh module. The code to do this would look
 something like this:
 
 ```ruby
 module Mysh
-  class Action
+  class NewCommand < Action
 
-    add(command_name, command_description) do |args|
-      # Action block goes here
+    #This method is called when the command is executed.
+    def call(args)
     end
 
+
   end
+
+  desc = "A succinct description of what this command does."
+  command_name = 'new <item>'
+  COMMANDS.add_action(NewCommand.new(command_name, desc))
+
 end
 ```
 
@@ -206,16 +260,19 @@ separated with spaces. The command is the first word of this string. For
 example a command_name of:
 
 ```
-"cd <dst>"
+"new <item>"
 ```
 
-will create a command called "cd" with a title of "cd &#60;dst&#62;"
+will create a command called "new" with a title of "new &#60;item&#62;"
 
 * command_description is a string or an array of strings that describe the
 command. This serves as the descriptive help for the command. The help display
 code handles matters like word wrap automatically.
-* The args parameter to the action block is an array of zero or more arguments
-that were entered with the command.
+
+#### About command args
+
+The call method take one parameter called args. The args parameter is an array
+of zero or more arguments that were entered with the command.
 
 So if a command is given
 
@@ -225,28 +282,6 @@ the args array will contain:
 
     ["abc", "this is a string", "23", "--launch", "--all"]
 
-#### Adding Command Aliases
-
-Commands sometimes have more than one possible name. This is supported with
-the add_alias method:
-
-```ruby
-module Mysh
-  class Action
-
-    add_alias(new_name, old_name)
-
-  end
-end
-```
-#### Add Method Return Values
-Both the add and add_alias methods return the newly created action instance.
-This may be useful, for example, if it is desired to add singleton methods to
-the action in order to extend functionality.
-
-Note that when an action is aliased, none of the singleton methods are copied
-across and these will have to be regenerated in the new action object.
-
 ## Contributing
 
 #### Plan A

data/lib/mysh.rb

@@ -20,7 +20,7 @@ module Mysh
     setup
 
     while @mysh_running do
-      execute_a_command
+      execute_a_command(@exec_host.eval_handlebars(get_command("mysh")))
     end
   end
 
@@ -32,8 +32,8 @@ module Mysh
   end
 
   #Execute a single line of input.
-  def self.execute_a_command
-    try_execute_command(@exec_host.eval_handlebars(get_command))
+  def self.execute_a_command(str)
+    try_execute_command(str)
 
   rescue MiniReadlineEOI
     @mysh_running = false

data/lib/mysh/internal/action.rb

@@ -17,6 +17,12 @@ module Mysh
       @exec_binding = mysh_binding
     end
 
+    #Parse the string and call the action.
+    def quick_parse_and_call(str)
+      call(Mysh.parse_args(str[1...-1]))
+      :action
+    end
+
     #Get information about the action.
     def action_info
       [@name].concat(@description)

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

@@ -0,0 +1,35 @@
+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:
+
+    \{\{ 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
+
+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!
+
+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
+
+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
+like: \\{  or \\}
+

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

@@ -0,0 +1,31 @@
+Help: mysh keyboard mappings:
+
+The mysh shell uses the mini_readline gem to supports an interactive command
+line experience. The user interface is mapped through the keyboard, based on
+the current operating platform.
+
+The keyboard (and alias) mappings are listed below:
+
+Editor Action    | Windows Key       Alias  | Mac/Linux Key      Alias
+-----------------+--------------------------+---------------------------
+Enter            | Enter                    | Enter
+Left             | Left Arrow               | Left Arrow,        Ctrl-b
+Word Left        | Ctrl Left Arrow          | Ctrl Left Arrow     Alt-b
+Right            | Right Arrow              | Right Arrow        Ctrl-f
+Word Right       | Ctrl Right Arrow         | Ctrl Right Arrow    Alt-f
+Go to start      | Home                     | Home               Ctrl-a
+Go to end        | End                      | End                Ctrl-E
+Previous History | Up Arrow                 | Up Arrow           Ctrl-r
+Next History     | Down Arrow               | Down Arrow
+Erase Left       | Backspace         Ctrl-h | Backspace          Ctrl-h
+Erase All Left   |                          | Ctrl-u
+Erase Right      | Delete    Ctrl-Backspace | Delete     Ctrl-Backspace
+Erase All Right  |                          | Ctrl-k
+Erase All        | Escape                   | Ctrl-l
+Auto-complete    | Tab               Ctrl-i | Tab                Ctrl-i
+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.
+

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

@@ -19,19 +19,23 @@ module Mysh
 
   end
 
-  help = [['',        'General help on mysh.',               'help.txt'     ],
-          ['show',    'Help on the show command.',           'help_show.txt'],
-          ['@',       'Help on the show command.',           'help_show.txt'],
-          ['env',     'Help on the show env command.',       'help_env.txt' ],
-          ['ruby',    'Help on the show ruby command.',      'help_ruby.txt'],
-          ['math',    'Help on math functions.',             'help_math.txt'],
-          ['=',       'Help on ruby expressions.',           'help_expr.txt'],
-          ['quick',   'Help on quick commands.',             'quick.txt'    ],
-          ['gls',     'Help on gls internal mysh command.',  'help_gls.txt' ],
-          ['!',       'This help on the history command.',   'history.txt'  ],
-          ['history', 'This help on the history command.',   'history.txt'  ],
-          ['help',    'This help on the help command.',      'help_help.txt'],
-          ['?',       'This help on the help command.',      'help_help.txt']
+  #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'   ],
+          ['show',    'Help on the show command.',           'show.txt'   ],
+          ['@',       'Help on the show command.',           'show.txt'   ],
+          ['env',     'Help on the show env command.',       'env.txt'    ],
+          ['ruby',    'Help on the show ruby command.',      'ruby.txt'   ],
+          ['math',    'Help on math functions.',             'math.txt'   ],
+          ['=',       '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'],
+          ['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'  ],
+          ['?',       'This help on the help command.',      'h_o_h.txt'  ]
          ]
 
   help.each do |parms|

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

@@ -13,7 +13,7 @@ module Mysh
 
     #Execute a help command by routing it to a sub-command.
     #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    #* :reek:UtilityFunction :reek:FeatureEnvy
     def call(args)
       if args.empty?
         puts "An item is needed for the show command."

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

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

data/lib/mysh/quick.rb

@@ -3,30 +3,18 @@
 #* mysh/internal/quick.rb -- The mysh internal quick commands.
 module Mysh
 
-  #Try to execute the string as a quick command.
-  def self.try_execute_quick_command(str)
-    case str[0]
-    when '!'
-      HISTORY_COMMAND.call(parse_args(str[1...-1]))
-      :history
-
-    when '='
-      @exec_host.execute(str)
-      :expression
-
-    when '?'
-      HELP_COMMAND.call(parse_args(str[1...-1]))
-      :help
+  #A hash of quick command short cuts and their actions.
+  QUICK = Hash.new(lambda {|_str| false})
 
-    when '@'
-      SHOW_COMMAND.call(parse_args(str[1...-1]))
-      :show
+  QUICK['!'] = lambda {|str| HISTORY_COMMAND.quick_parse_and_call(str) }
+  QUICK['='] = lambda {|str| @exec_host.execute(str); :expression }
+  QUICK['?'] = lambda {|str| HELP_COMMAND.quick_parse_and_call(str) }
+  QUICK['@'] = lambda {|str| SHOW_COMMAND.quick_parse_and_call(str) }
 
-    else
-      false
-    end
+  #Try to execute the string as a quick command.
+  def self.try_execute_quick_command(str)
+    QUICK[str[0]].call(str)
   end
 
-
 end
 

data/lib/mysh/user_input.rb

@@ -15,18 +15,22 @@ module Mysh
   end
 
   #Get one command from the user.
-  def self.get_command
-    initial_input = @input.readline(prompt: 'mysh>')
+  def self.get_command(root="")
+    initial_input = @input.readline(prompt: root + '>')
     @input.instance_options[:initial] = ""
-    get_command_extra(initial_input)
+    get_command_extra(initial_input, root)
+
+  rescue MiniReadlineEOI
+    @mysh_running = false
+    "\n"
   end
 
   private
 
   #Get any continuations of the inputs
-  def self.get_command_extra(str)
+  def self.get_command_extra(str, root)
     if /\\\s*$/ =~ str
-      parms = {prompt: 'mysh\\', prefix: str[0] }
+      parms = {prompt: root + '\\', prefix: str[0] }
       get_command_extra($PREMATCH + "\n" + @input.readline(parms))
     else
       str

data/lib/mysh/version.rb

@@ -2,7 +2,7 @@
 
 module Mysh
   #The version string of MY SHell.
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 
   #A brief summary of this gem.
   SUMMARY = "mysh -- a Ruby inspired command line shell."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysh
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-20 00:00:00.000000000 Z
+date: 2016-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,16 +162,18 @@ files:
 - lib/mysh/internal/actions/exit.rb
 - lib/mysh/internal/actions/gls.rb
 - lib/mysh/internal/actions/help.rb
+- lib/mysh/internal/actions/help/env.txt
+- lib/mysh/internal/actions/help/expr.txt
+- lib/mysh/internal/actions/help/gls.txt
+- lib/mysh/internal/actions/help/h_o_h.txt
+- lib/mysh/internal/actions/help/hbar.txt
 - lib/mysh/internal/actions/help/help.txt
-- lib/mysh/internal/actions/help/help_env.txt
-- lib/mysh/internal/actions/help/help_expr.txt
-- lib/mysh/internal/actions/help/help_gls.txt
-- lib/mysh/internal/actions/help/help_help.txt
-- lib/mysh/internal/actions/help/help_math.txt
-- lib/mysh/internal/actions/help/help_ruby.txt
-- lib/mysh/internal/actions/help/help_show.txt
 - lib/mysh/internal/actions/help/history.txt
+- lib/mysh/internal/actions/help/kbd.txt
+- lib/mysh/internal/actions/help/math.txt
 - lib/mysh/internal/actions/help/quick.txt
+- lib/mysh/internal/actions/help/ruby.txt
+- lib/mysh/internal/actions/help/show.txt
 - lib/mysh/internal/actions/help/sub_help.rb
 - lib/mysh/internal/actions/history.rb
 - lib/mysh/internal/actions/pwd.rb