mysh 0.1.17 → 0.2.0

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

@@ -1,4 +1,4 @@
-mysh version: {{ Mysh::VERSION }}
+Help: mysh version: {{ Mysh::VERSION }}
 
 The mysh is a shell program inspired by the Ruby programming language in the
 same way the csh was inspired by the "C" programming language.
@@ -6,12 +6,12 @@ same way the csh was inspired by the "C" programming language.
 In mysh, commands fall into one of three broad categories. There are:
 
 1) "=" expressions: Any line beginning with an "=" will be evaluated as a Ruby
-   language expression. For more see the '? =' or '? math' commands.
+   language expression. For more see the '?=' or '?math' commands.
 
 2) Internal mysh commands are processed within mysh itself. The following set
    of commands are supported:
 
-{{ Mysh::COMMANDS.actions_info.mysh_bulletize.join("\n") }}
+{{ Mysh::COMMANDS.actions_info.mysh_bulletize }}
 
 3) All other commands are executed by the system using the standard shell or
    the appropriate ruby interpreter. If the command has a '.rb' extension, it
@@ -23,5 +23,5 @@ In mysh, commands fall into one of three broad categories. There are:
 Note: If an internal command has the same name as an external command, adding a
       leading space will force the use of the external command.
 
-Help on help: For a list of all help topics see the '? ?' command.
+Help on help: For a list of all help topics see the '??' command.
 

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

@@ -0,0 +1,14 @@
+Help: mysh show env command summary:
+
+The show env (or @env) command is used to display useful information about the
+current execution environment. This includes:
+
+user  - The current user name.
+home  - The current home directory.
+name  - The path/name of the mysh program currently executing.
+shell - The path/name of the system command shell.
+host  - The name of the host computer.
+os    - The current operating system.
+
+path  - An easy-to-read, formatted version of the current search path.
+

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

@@ -1,6 +1,7 @@
-mysh Ruby expression support summary:
+Help: mysh Ruby expression support summary:
 
-All command lines that begin with = are evaluated as Ruby expressions.
+All command lines that begin with = are evaluated as Ruby expressions. The
+results of this evaluation are displayed.
 
 Notes:
 

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

@@ -0,0 +1,41 @@
+Help: mysh gls command summary:
+
+The gls command is used to display information about the loaded ruby gems. The
+usage template for this command is:
+
+mysh>gls <options> <mask>
+
+Where:
+
+ <options> is one of:
+   "-l" -- display detailed information on the selected gems.
+   none -- display only the names of the selected gems.
+
+ <mask> is an optional, case-sensitive pattern for filtering out the gems
+        displayed. If omitted, all gems are displayed.
+
+Examples:
+
+mysh>gls
+actionpack    erubis        mini_readline rails-deprecated_sanitizer tzinfo
+actionview    i18n          minitest      rails-dom-testing          vls
+activesupport in_array      nokogiri      rails-html-sanitizer
+bigdecimal    json          psych         railties
+builder       loofah        rack          thor
+crass         mini_portile2 rack-test     thread_safe
+
+mysh>gls -l vls
+name        vls
+version     0.4.0
+date        2016-10-08 00:00:00 UTC
+summary     A version listing utility.
+description A CLI and Rails console utility that lists the versions of modules
+            used by the specified gems/ruby files or Rails project.
+executables vls
+authors     Peter Camilleri
+email       peter.c.camilleri@gmail.com
+homepage    http://teuthida-technologies.com/
+
+A complete guide to the gem specification's properties may be found at:
+http://guides.rubygems.org/specification-reference/
+

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

@@ -1,9 +1,12 @@
-mysh Help command summary:
+Help: mysh help command summary:
 
-The help (or ?) command is used to get either general help about mysh
-or an optional specified topic.
+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:
 
-{{ HELP.actions_info.mysh_bulletize.join("\n") }}
+{{ HELP.actions_info.mysh_bulletize }}
 

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

@@ -1,4 +1,4 @@
-mysh Math support summary:
+Help: mysh math support summary:
 
 The Ruby expression execution environment has direct access to many advanced
 mathematical functions and values.

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

@@ -0,0 +1,21 @@
+Help: mysh show ruby command summary:
+
+The show ruby (or @ruby) command is used to display useful information about
+the current ruby environment. This includes:
+
+location    - The path/name of the current ruby interpreter.
+description - A comprehensive summary of the version and other such data.
+version     - The version of ruby.
+patch       - Its patch level.
+revision    - Its revision level.
+date        - The date of its release.
+platform    - The target platform.
+copyright   - The legal ownership of the software.
+engine      - The internal engine in the software.
+host        - A summary of the host operating environment.
+host cpu    - A (crude) approximation of the installed cpu.
+host os     - The current operating system.
+host vendor - The current environment vendor/genre.
+
+$:          - An easy-to-read, formatted version of $: or the ruby search path.
+

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

@@ -0,0 +1,12 @@
+Help: mysh show command summary:
+
+The show (or @) command is used to inspect various aspects of the mysh
+environment specified by the item parameter.
+
+If the longer form, show is used, a space is required before the topic. If the
+quick form, @ is used, the space is optional.
+
+The available show items are:
+
+{{ SHOW.actions_info.mysh_bulletize }}
+

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

@@ -0,0 +1,19 @@
+Help: mysh history command summary:
+
+The history (or !) command is used to allow the user greater control over the
+history of commands that have been entered. The action taken by the history
+command is controlled by an optional parameter.
+
+If the longer form, show is used, a space is required before the parameter. If
+the quick form, ! is used, the space is optional.
+
+Quick   Long           Command
+Form    Form           Description
+=====   =======        ===========
+!       history        Display the history buffer.
+
+!5      history 5      Retrieve history entry 5 and present this to the user
+                       as the next command.
+
+!clear  history clear  Clear the command history.
+

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

@@ -0,0 +1,25 @@
+Help: mysh quick commands summary:
+
+In mysh, some commands are identified by a single character, making them easy
+and quick to enter. Since these commands are always a single character long,
+it is not necessary (but still acceptable) to place a space between the command
+and any parameter.
+
+To be processed as quick, the character must be first in the line.
+
+The supported quick commands are:
+
+Quick Long     Command
+Form  Form     Description
+===== =======  ===========
+  !   history  Display the mysh command history, or if an index is specified,
+               retrieve the command with that index value.
+
+  =            All command lines that begin with = are evaluated as Ruby
+               expressions. The results of this evaluation are displayed.
+
+  ?   help     Display help information for mysh with an optional topic.
+
+  @   show     The show (or @) command is used to inspect various aspects of
+               the mysh environment specified by the item parameter.
+

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

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+#* mysh/internal/actions/help/sub_help.rb -- The mysh internal help sub commands.
+module Mysh
+
+  #* mysh/internal/actions/help/sub_help.rb -- The mysh internal help sub commands.
+  class HelpSubCommand < Action
+
+    #Setup a help command.
+    def initialize(name, description, file_name)
+      super(name, description)
+      @file_name = file_name
+    end
+
+    #Execute a help command.
+    def call(_args)
+      show_handlebar_file(ACTIONS_PATH + 'help/' + @file_name)
+    end
+
+  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']
+         ]
+
+  help.each do |parms|
+    HELP.add_action(HelpSubCommand.new(*parms))
+  end
+
+end

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

@@ -1,21 +1,57 @@
 # coding: utf-8
 
-#* internal/actions/history.rb -- The mysh internal history command.
+#* mysh/internal/actions/history.rb -- The mysh internal history command.
 module Mysh
 
-  #* history.rb -- The mysh internal history command.
-  class Action
-    #Add the exit command to the library.
-    COMMANDS.add('history', 'Display the mysh command history.') do |args|
-      history = Mysh.input.history
+  #* mysh/internal/actions/history.rb -- The mysh internal history command.
+  class HistoryCommand < Action
+
+    #Execute the history command.
+    def call(args)
+      @args, @history = args, Mysh.input.history
 
       #The history command should not be part of the history.
-      history.pop
+      @history.pop
+
+      pull_index || clear_history || show_history
+    end
 
-      puts history
+    private
+
+    #Deal with history index arguments
+    def pull_index
+      index = @args[0].to_i
+
+      if (1..@history.length) === index
+        Mysh.input.instance_options[:initial] = @history[index-1]
+      else
+        false
+      end
+    end
+
+    #Clear the history buffer.
+    def clear_history
+      if @args[0] == 'clear'
+        @history.clear
+      else
+        false
+      end
+    end
+
+    #Just show the history.
+    def show_history
+      @history.each_with_index do |item, index|
+        puts "#{index+1}: #{item}"
+      end
     end
 
-    COMMANDS.add_alias('!', 'history')
   end
-end
 
+  #Add the history commands to the library.
+  desc = 'Display the mysh command history, or if an index is specified, ' +
+         'retrieve the command with that index value.'
+  COMMANDS.add_action(HistoryCommand.new('history <index>', desc))
+  #The history command action object.
+  HISTORY_COMMAND = HistoryCommand.new('!<index>', desc)
+  COMMANDS.add_action(HISTORY_COMMAND)
+end

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

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+#* mysh/internal/actions/pwd.rb -- The mysh internal pwd command.
+module Mysh
+
+  #* mysh/internal/actions/pwd.rb -- The mysh internal pwd command.
+  class PwdCommand < Action
+
+    #Execute the cd command.
+    def call(_args)
+      puts decorate(Dir.pwd)
+    end
+
+  end
+
+  desc = 'Display the current working directory.'
+  COMMANDS.add_action(PwdCommand.new('pwd', desc))
+end

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

@@ -1,27 +1,36 @@
 # coding: utf-8
 
-#* internal/actions/show.rb -- The mysh show command.
+#* mysh/internal/actions/show.rb -- The mysh internal show command.
 module Mysh
 
-  #* internal/actions/show.rb -- The mysh show command.
-  class Action
-
-    # The base help command.
-    desc = 'Display a text file with optional embedded handlebars.'
-
-    COMMANDS.add('show <file>', desc) do |args|
-      file_name = args.shift
+  #Show items.
+  SHOW = ActionPool.new("SHOW") do |args|
+    puts "No show data found for #{args[0].inspect}. See ?@ for more."
+  end
 
-      @exec_binding = binding
+  #* mysh/internal/actions/show.rb -- The mysh internal show command.
+  class ShowCommand < Action
 
-      if file_name
-        show_handlebar_file(file_name)
+    #Execute a help command by routing it to a sub-command.
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
+    def call(args)
+      if args.empty?
+        puts "An item is needed for the show command."
       else
-        puts "Error: A text file must be specified."
+        SHOW[args[0]].call(args)
       end
     end
 
   end
 
+  # The base help command.
+  desc = 'Display information about a part of mysh. See ?@ for more.'
+  COMMANDS.add_action(ShowCommand.new('show <item>', desc))
+  #The show command action object.
+  SHOW_COMMAND = ShowCommand.new('@<item>', desc)
+  COMMANDS.add_action(SHOW_COMMAND)
 end
 
+#Load up the extra help actions!
+Dir[Mysh::Action::ACTIONS_PATH + 'show/*.rb'].each {|file| require file }

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

@@ -0,0 +1,43 @@
+# coding: utf-8
+
+#* mysh/internal/actions/show/env.rb -- Get help on the mysh environment.
+module Mysh
+
+  #* mysh/internal/actions/show/env.rb -- Get help on the mysh environment.
+  class EnvInfoCommand < Action
+
+    #Execute the ? shell command.
+    def call(_args)
+      puts "Key mysh environment information.", ""
+      puts info.mysh_bulletize, "",
+           path.mysh_bulletize, ""
+    end
+
+    private
+
+    #Get the info
+    def info
+      [["user",  ENV['USER']],
+       ["home",  ENV['HOME']],
+       ["name",  decorate($PROGRAM_NAME)],
+       ["shell", ENV['SHELL']    || ENV['ComSpec']],
+       ["host",  ENV['HOSTNAME'] || ENV['COMPUTERNAME']],
+       ["os",    ENV['OS']],
+       ["term",  ENV['TERM']],
+       ["disp",  ENV['DISPLAY']],
+       ["edit",  ENV['EDITOR']]]
+    end
+
+    #Get the path.
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
+    def path
+      [["path"].concat(ENV['PATH'].split(File::PATH_SEPARATOR))]
+    end
+
+  end
+
+  desc = 'Get information about the current shell environment. ' +
+         'See ?env for more.'
+  SHOW.add_action(EnvInfoCommand.new('env', desc))
+end

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

@@ -0,0 +1,50 @@
+# coding: utf-8
+
+#* mysh/internal/actions/show/ruby.rb -- Get help on the ruby environment.
+module Mysh
+
+  #* mysh/internal/actions/show/ruby.rb -- Get help on the ruby environment.
+  class RubyInfoCommand < Action
+
+    #Execute the ? shell command.
+    def call(_args)
+      puts "Key ruby environment information.", ""
+      puts info.mysh_bulletize, "",
+           path.mysh_bulletize, ""
+    end
+
+    private
+
+    #Get the info
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
+    def info
+      [["location",    RbConfig.ruby],
+       ["description", RUBY_DESCRIPTION],
+       ["version",     RUBY_VERSION],
+       ["patch",       RUBY_PATCHLEVEL],
+       ["revision",    RUBY_REVISION],
+       ["date",        RUBY_RELEASE_DATE],
+       ["platform",    RUBY_PLATFORM],
+       ["copyright",   RUBY_COPYRIGHT],
+       ["engine",      RUBY_ENGINE],
+       ["host",        RbConfig::CONFIG['host']],
+       ["host cpu",    RbConfig::CONFIG['host_cpu']],
+       ["host os",     RbConfig::CONFIG['host_os']],
+       ["host vendor", RbConfig::CONFIG['host_vendor']]
+      ]
+    end
+
+    #Get the path.
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
+    def path
+      [["$:"].concat($:)]
+    end
+
+  end
+
+  desc = 'Get information about the current ruby environment. ' +
+         'See ?ruby for more.'
+  SHOW.add_action(RubyInfoCommand.new('ruby', desc))
+end