mysh 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0b4c496315c92dcfdb4b1c543d4e63364d13e75
-  data.tar.gz: f9885bc762c88e3411299a5c39375083054084c5
+  metadata.gz: 78a7e5a670f53f7cdfb9ede87c31216f1e596a20
+  data.tar.gz: 2c2a24ad4aebe2b5c430d647dacccd6cb1b046d7
 SHA512:
-  metadata.gz: 7ee6785a005d64073e5ec31bdfa831b6699960fea8b31a2ca6e6dbf3455a9ee3c0e9bc89f759588f0d81bad5c9a83fdfc83720ef1cb0217463fe0d669cc4d731
-  data.tar.gz: 9de8dbf54a0f6e0b6a239865a84ab729072028ffc6e247194fcbdea75f9da351b299e0157def64838fdc4ae128c618d6c7565a984d80eedee48f8fb6d305610e
+  metadata.gz: 3678b1a241def34b14cc123e19bba3ac080d7b0d95e2f7de3d92dacdda96106df6adae9b1b8fc73d0aea7b840638020f1e9a29225edb3d9833c6abfc70bdc010
+  data.tar.gz: 56666cd89ba7ea004e2ff507e29f8401c35704b80028eec2e199e074f836f5b225430f665f3d3d20f25ad1f7c075bfaf9518ab8761c9efc0caf722467d34bb3e

data/README.md

@@ -47,44 +47,83 @@ This prompt can be used to execute three sorts of commands:
 
 * Internal commands that are processed directly by mysh
 * Ruby expressions, which are preceded by the equal (=) sign.
-* External commands that are passed on to the standard command shell.
+* External commands that are passed on to the standard command shell or the
+Ruby interpreter.
 
 From the mysh help:
 
     mysh> ?
-    mysh (MY SHell) version: 0.1.0
+    mysh (MY ruby SHell) version: 0.1.11
 
-    Internal mysh commands:
+    1) Internal mysh commands:
      - executed by mysh directly.
-     - a leading space skips all internal commands.
-
-    !           Display the mysh command history.
-    =an_expr    Display the result of evaluating an expression in ruby.
-    =result     Display the result of the previous evaluation.
-    =stuff \    This expression is continued on the next line.
-    ?           Display help information for mysh.
-    cd <dir>    Change directory to <dir> and display the new working directory.
-    exit        Exit mysh.
-    help        Display help information for mysh.
-    history     Display the mysh command history.
-    pwd         Display the current working directory.
-    quit        Exit mysh.
-
-    Math support:
+     - supports the following set of commands.
+
+       Internal Commands
+      ===================
+
+    !         Display the mysh command history.
+    ?         Display help information for mysh.
+    cd <dir>  Change directory to the optional <dir> parameter.
+              Then display the current working directory.
+    exit      Exit mysh.
+    help      Display help information for mysh.
+    history   Display the mysh command history.
+    pwd       Display the current working directory.
+    quit      Exit mysh.
+
+    2) Ruby Expression support:
+     - any line beginning with an equals "=" sign will be evaluated as a Ruby
+       expression. This allows the mysh command line to serve as a programming,
+       debugging and super-calculator environment.
+     - for more info use the 'help ruby' command.
+
+    3) Math support:
      - the execution environment includes the Math module.
-     - for more info use the help math command.
+     - for more info use the 'help math' command.
 
-    External commands:
+    4) External commands:
      - executed by the system using the standard shell.
-     - use help - for more info on external commands.
+     - to force the use of the external shell, add a leading space to the command.
+
+    Note: If the command has a '.rb' extension it is executed by Ruby.
+          So the command "myfile.rb" is executed as "ruby myfile.rb"
+
+and
+
+    mysh> ? ruby
+    mysh (MY ruby SHell) version: 0.1.11
+
+    mysh Ruby expression support summary
+
+     - All command lines that begin with an equals "=" sign are evaluated as Ruby
+       expressions.
+     - Expressions ending with a backslash character "\" are continued on the next
+       line. The prompt changes to "mysh\" to indicate that this is going on.
+     - The results are displayed using the pretty-print facility.
+     - Auto-complete always places any file names in quotes so they can be used
+       as string parameters.
+
+    A few noteworthy methods exist that facilitate use of Ruby expressions:
+
+    reset      Reset the execution environment to the default state.
+    result     Returns the result of the previous expression.
+    vls <mask> List modules with version info. The optional mask string value
+               is used to filter for modules containing that string.
 
 and
 
     mysh> ? math
-    mysh (MY SHell) version: 0.1.0
+    mysh (MY ruby SHell) version: 0.1.11
 
     mysh Math support summary
 
+    The Ruby expression execution environment has direct access to many advanced
+    Math functions. For example, to compute the cosine of 3.141592653589793 use:
+
+      mysh> =cos(PI)
+      -1.0
+
     Method     Returns Description
     =======    ======= ================================================
     acos(x)    Float   Computes the arc cosine of x. Returns 0..PI.
@@ -110,8 +149,8 @@ and
     ldexp(f,e) Float   Returns the value of f*(2**e).
     lgamma(x)  Array   Returns a two-element array containing the log of the
                        gamma of x and the sign of gamma of x.
-    log(x)     Float   Computes the natural log of c.
-    log(x,B)   Float   Computes the base B log of c.
+    log(x)     Float   Computes the natural log of x.
+    log(x,B)   Float   Computes the base B log of x.
     log10(x)   Float   Returns the base 10 logarithm of x.
     log2(x)    Float   Returns the base 2 logarithm of x.
     sin(x)     Float   Computes the sine of x (expressed in radians).
@@ -121,6 +160,8 @@ and
     tan(x)     Float   Computes the tangent of x (expressed in radians).
     tanh(x)    Float   Computes the hyperbolic tangent of x (expressed in radians).
 
+    PI         Float   The value 3.141592653589793
+    E          Float   The value 2.718281828459045
 
 The mysh can also be used from within a Ruby application:
 
@@ -128,6 +169,73 @@ The mysh can also be used from within a Ruby application:
 Mysh.run
 ```
 
+## Adding New Commands
+
+It is possible to add new internal commands to the mysh CLI. This is done by
+depositing the appropriate ruby file in the commands folder located at:
+
+  /mysh/lib/mysh/commands
+
+As an example, the file cd.rb is shown to illustrate the responsibilities of
+a typical command plug-in:
+
+```ruby
+# coding: utf-8
+
+#* commands/cd.rb -- The mysh internal cd command.
+module Mysh
+
+  #* cd.rb -- The mysh internal cd command.
+  class InternalCommand
+    #Add the cd command to the library.
+    desc = ['Change directory to the optional <dir> parameter.',
+            'Then display the current working directory.']
+
+    add('cd <dir>', desc) do |args|
+      begin
+        Dir.chdir(args[0]) unless args.empty?
+        puts decorate(Dir.pwd)
+      rescue => err
+        puts "Error: #{err}"
+      end
+    end
+
+    #Add the pwd command to the library.
+    add('pwd', 'Display the current working directory.') do |args|
+      begin
+        puts decorate(Dir.pwd)
+      rescue => err
+        puts "Error: #{err}"
+      end
+    end
+
+  end
+end
+```
+
+Note that the plug in code is contained within the InternalCommand class under
+the Mysh module umbrella. The principle method used to create internal commands
+is the add method:
+
+```ruby
+add(command_name, command_description) do |args|
+  # Action block goes here
+end
+```
+Where:
+* command_name is the name of the command with optional argument descriptions
+seperated with spaces. The command is the first word of this string.
+* command_description is a string or an array of strings that describe the
+command.
+* args is an array of zero or more arguments that were entered with the command.
+
+Commands sometimes have more than one possible name. This is supported with:
+
+```ruby
+add_alias(new_name, old_name)
+```
+
+
 ## Contributing
 
 #### Plan A

data/lib/mysh.rb

@@ -5,6 +5,7 @@
 require 'English'
 require 'mini_readline'
 require 'vls'
+require 'in_array'
 
 require_relative 'mysh/smart_source'
 require_relative 'mysh/expression'
@@ -27,7 +28,7 @@ module Mysh
     init_run
 
     loop do
-      input = @input.readline(prompt: 'mysh> ')
+      input = @input.readline(prompt: 'mysh>')
 
       begin
         @exec_host.execute(input)      ||

data/lib/mysh/commands/cd.rb

@@ -6,24 +6,26 @@ module Mysh
   #* cd.rb -- The mysh internal cd command.
   class InternalCommand
     #Add the cd command to the library.
-    desc = 'Change directory to <dir> and display the new working directory.'
-    add(self.new('cd <dir>', desc) do |args|
+    desc = ['Change directory to the optional <dir> parameter.',
+            'Then display the current working directory.']
+
+    add('cd <dir>', desc) do |args|
       begin
         Dir.chdir(args[0]) unless args.empty?
         puts decorate(Dir.pwd)
       rescue => err
         puts "Error: #{err}"
       end
-    end)
+    end
 
     #Add the pwd command to the library.
-    add(self.new('pwd', 'Display the current working directory.') do |args|
+    add('pwd', 'Display the current working directory.') do |args|
       begin
         puts decorate(Dir.pwd)
       rescue => err
         puts "Error: #{err}"
       end
-    end)
+    end
 
   end
 end

data/lib/mysh/commands/exit.rb

@@ -6,9 +6,9 @@ module Mysh
   #* exit.rb -- The mysh internal exit command.
   class InternalCommand
     #Add the exit command to the library.
-    add(self.new('exit', 'Exit mysh.') do |args|
+    add('exit', 'Exit mysh.') do |args|
       raise MiniReadlineEOI
-    end)
+    end
 
     add_alias('quit', 'exit')
   end

data/lib/mysh/commands/help.rb

@@ -6,19 +6,14 @@ module Mysh
   #* exit.rb -- The mysh internal exit command.
   class InternalCommand
     #Add the exit command to the library.
-    add(self.new('help', 'Display help information for mysh.') do |args|
+    add('help', 'Display help information for mysh.') do |args|
       puts "mysh (MY ruby SHell) version: #{Mysh::VERSION}"
       puts
 
       if args.empty?
-        puts IO.read(File.dirname(__FILE__) + '/help_internal.txt')
-
-        InternalCommand
-          .info
-          .sort {|first, second | first[0] <=> second[0] }
-          .each {|info| puts "#{info[0].ljust(10)} #{info[1]}" }
-        puts
-        puts IO.read(File.dirname(__FILE__) + '/help.txt')
+        puts IO.read(File.dirname(__FILE__) + '/help_head.txt')
+        InternalCommand.display_items(info)
+        puts IO.read(File.dirname(__FILE__) + '/help_tail.txt')
       elsif args[0] == 'math'
         puts IO.read(File.dirname(__FILE__) + '/help_math.txt')
       elsif args[0] == 'ruby'
@@ -27,9 +22,11 @@ module Mysh
         puts "help #{args[0]} ???"
       end
 
-    end)
+    end
 
     add_alias('?', 'help')
+
   end
+
 end
 

data/lib/mysh/commands/help_head.txt

@@ -0,0 +1,8 @@
+1) Internal mysh commands:
+
+- Are executed by mysh directly.
+- Support the following set of commands.
+
+   Internal Commands
+  ===================
+

data/lib/mysh/commands/help_math.txt

@@ -1,8 +1,10 @@
 mysh Math support summary
 
- - The Ruby expression execution environment includes the Math module. Thus
-   the following advanced math functions are directly available without having
-   to explicitly reference that module.
+The Ruby expression execution environment has direct access to many advanced
+Math functions. For example, to compute the cosine of 3.141592653589793 use:
+
+  mysh> =cos(PI)
+  -1.0
 
 Method     Returns Description
 =======    ======= ================================================
@@ -40,3 +42,6 @@ sqrt(x)    Float   Returns the non-negative square root of x.
 tan(x)     Float   Computes the tangent of x (expressed in radians).
 tanh(x)    Float   Computes the hyperbolic tangent of x (expressed in radians).
 
+PI         Float   The value 3.141592653589793
+E          Float   The value 2.718281828459045
+

data/lib/mysh/commands/help_ruby.txt

@@ -1,16 +1,17 @@
 mysh Ruby expression support summary
 
- - All command lines that begin with an equals "=" sign are evaluated as Ruby
-   expressions.
- - Expressions ending with a backslash character "\" are continued on the next
-   line. The prompt changes to "mysh\" to indicate that this is going on.
- - The results are displayed using the pretty-print facility.
- - Auto-complete always places any file names in quotes so they can be used
-   as string parameters.
+- All command lines that begin with an equals "=" sign are evaluated as Ruby
+  expressions.
+- Expressions ending with a backslash character "\" are continued on the next
+  line. The prompt changes to "mysh\" to indicate that this is going on.
+- The results are displayed using the pretty-print facility.
+- Auto-complete always places any file names in quotes so they can be used
+  as string parameters.
 
 A few noteworthy methods exist that facilitate use of Ruby expressions:
 
 reset      Reset the execution environment to the default state.
 result     Returns the result of the previous expression.
-vls <mask> List modules with version info. The optional mask string value
-           is used to filter for modules containing that string.
+vls "mask" List modules with version info. The optional mask string value is
+           used to filter for modules containing that string.
+

data/lib/mysh/commands/help_tail.txt

@@ -0,0 +1,20 @@
+2) Ruby Expression support:
+
+- Any line beginning with an equals "=" sign will be evaluated as a Ruby
+  expression. This allows the mysh command line to serve as a programming,
+  debugging and super-calculator environment.
+- For more info use the 'help ruby' command.
+
+3) Math support:
+
+- The execution environment includes the Math module.
+- For more info use the 'help math' command.
+
+4) External commands:
+
+- Executed by the system using the standard shell.
+- To force the use of the external shell, add a leading space to the command.
+
+Note: If the command has a '.rb' extension it is executed by Ruby.
+      So the command "myfile.rb" is executed as "ruby myfile.rb"
+

data/lib/mysh/commands/history.rb

@@ -6,14 +6,14 @@ module Mysh
   #* exit.rb -- The mysh internal history command.
   class InternalCommand
     #Add the exit command to the library.
-    add(self.new('history', 'Display the mysh command history.') do |args|
+    add('history', 'Display the mysh command history.') do |args|
       history = Mysh.input.history
 
       #The history command should not be part of the history.
       history.pop
 
       puts history
-    end)
+    end
 
     add_alias('!', 'history')
   end

data/lib/mysh/expression.rb

@@ -17,7 +17,7 @@ module Mysh
     #Process an expression.
     def execute(str)
       if str.start_with?('=')
-        do_execute(str)
+        do_execute(do_build(str))
       else
         false
       end
@@ -32,33 +32,30 @@ module Mysh
     end
 
     private
-    #Do the actual work of executing an expression.
+
+    #Gather up the full string of the expression to evaluate.
     #<br>Endemic Code Smells
     #* :reek:TooManyStatements
-    def do_execute(str)
+    def do_build(str)
       if /\\\s*$/ =~ str
-        parms = {
-                 prompt: 'mysh\\ ',
-                 auto_source: MiniReadline::QuotedFileFolderSource
-                }
+        parms = {prompt: 'mysh\\',
+                 auto_source: MiniReadline::QuotedFileFolderSource}
 
-        do_execute($PREMATCH + "\n" + Mysh.input.readline(parms))
+        do_build($PREMATCH + "\n" + Mysh.input.readline(parms))
       else
-        begin
-          eval("@result" + str)
-
-          if @result
-            pp @result
-          else
-            puts @result
-          end
-
-        rescue StandardError, ScriptError => err
-          puts "Error: #{err}"
-        end
-
-        :expression
+        str
       end
     end
+
+    #Execute the string
+    def do_execute(str)
+      instance_eval("@result" + str)
+      send(@result ? :pp : :puts, @result)
+    rescue StandardError, ScriptError => err
+      puts "Error: #{err}"
+    ensure
+      return :expression
+    end
   end
+
 end

data/lib/mysh/internal.rb

@@ -1,9 +1,10 @@
 # coding: utf-8
 
-require_relative 'internal/klass'
-require_relative 'internal/parse'
-require_relative 'internal/instance'
-require_relative 'internal/decorate'
+require_relative 'support/manage'
+require_relative 'support/parse'
+require_relative 'support/format'
+require_relative 'support/frame'
+require_relative 'support/decorate'
 
-#Load up the commands!
+#Load up the internal commands!
 Dir[File.dirname(__FILE__) + '/commands/*.rb'].each {|file| require file }

data/lib/mysh/ruby.rb

@@ -1,19 +1,16 @@
 # coding: utf-8
 
+#* ruby.rb -- Support for executing Ruby files with the ruby interpreter.
 module Mysh
 
   #Try to execute as a Ruby program.
   def self.ruby_execute(str)
-    if File.extname(str.split[0]) == '.rb'
-      new_command = "ruby #{str}"
-
-      puts "=> #{new_command}"
-      puts
-
+    if (command = str.split[0]) && File.extname(command) == '.rb'
+      puts "=> #{new_command = "ruby #{str}"}\n\n"
       system(new_command)
       :ruby_exec
     end
 
   end
 
-end
+end

data/lib/mysh/{internal → support}/decorate.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-#* decorate.rb -- mysh internal file name beauty treatments.
+#* support/decorate.rb -- mysh internal file name beauty treatments.
 module Mysh
 
   #The mysh internal file name beauty treatments.

data/lib/mysh/support/format.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+#* support/format.rb -- Format mysh internal reports.
+module Mysh
+
+  #The mysh internal command class level report formatting.
+  class InternalCommand
+
+    #Get information on all commands.
+    def self.info
+      @commands
+        .values
+        .map  {|command| command.info }
+        .sort {|first, second| first[0] <=> second[0] }
+    end
+
+    #Display an array of items.
+    def self.display_items(items)
+      #Determine the width of the tag area.
+      tag_width = items.max_by {|item| item[0].length}[0].length + 1
+
+      #Display the information.
+      items.each {|item| display_item(item, tag_width) }
+
+      puts
+    end
+
+    #Display one item.
+    def self.display_item(item, tag_width=nil)
+      tag = item[0]
+      tag_width ||= tag.length + 1
+
+      item[1].each do |detail|
+        puts "#{tag.ljust(tag_width)} #{detail}"
+        tag = ""
+      end
+    end
+
+  end
+end
+

data/lib/mysh/{internal/instance.rb → support/frame.rb}

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-#* internal.rb -- mysh internal command instance data and methods.
+#* support/frame.rb -- The abstract frame of mysh internal commands.
 module Mysh
 
   #The mysh internal command instance data and methods.
@@ -16,9 +16,7 @@ module Mysh
 
     #Setup an internal command
     def initialize(name, description, &action)
-      @name        = name
-      @description = description
-      @action      = action
+      @name, @description, @action = name, description.in_array, action
     end
 
     #Execute the command.

data/lib/mysh/{internal/klass.rb → support/manage.rb}

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-#* internal/klass.rb -- mysh internal command class level data and methods.
+#* support/manage.rb -- Manage mysh internal commands.
 module Mysh
 
   #The mysh internal command class level data and methods.
@@ -15,8 +15,8 @@ module Mysh
     end
 
     #Add a command to the command library.
-    def self.add(command)
-      @commands[command.name.split[0]] = command
+    def self.add(name, description, &action)
+      @commands[name.split[0]] = new(name, description, &action)
     end
 
     #Add an alias for an existing command.
@@ -42,11 +42,6 @@ module Mysh
       end
     end
 
-    #Get information on all commands.
-    def self.info
-      @commands.values.map { |command| command.info }
-    end
-
   end
 end
 

data/lib/mysh/{internal → support}/parse.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-#* parse.rb -- mysh internal command parser.
+#* support/parse.rb -- mysh internal command parser.
 module Mysh
 
   #The mysh internal command instance data and methods.

data/lib/mysh/version.rb

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

data/mysh.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency     'mini_readline',    ">= 0.6.0"
   spec.add_runtime_dependency     'vls',              ">= 0.3.9"
+  spec.add_runtime_dependency     'in_array'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysh
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-23 00:00:00.000000000 Z
+date: 2016-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.9
+- !ruby/object:Gem::Dependency
+  name: in_array
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: mysh -- a Ruby inspired command shell for CLI and application use.
 email:
 - peter.c.camilleri@gmail.com
@@ -140,19 +154,20 @@ files:
 - lib/mysh/commands/cd.rb
 - lib/mysh/commands/exit.rb
 - lib/mysh/commands/help.rb
-- lib/mysh/commands/help.txt
-- lib/mysh/commands/help_internal.txt
+- lib/mysh/commands/help_head.txt
 - lib/mysh/commands/help_math.txt
 - lib/mysh/commands/help_ruby.txt
+- lib/mysh/commands/help_tail.txt
 - lib/mysh/commands/history.rb
 - lib/mysh/expression.rb
 - lib/mysh/internal.rb
-- lib/mysh/internal/decorate.rb
-- lib/mysh/internal/instance.rb
-- lib/mysh/internal/klass.rb
-- lib/mysh/internal/parse.rb
 - lib/mysh/ruby.rb
 - lib/mysh/smart_source.rb
+- lib/mysh/support/decorate.rb
+- lib/mysh/support/format.rb
+- lib/mysh/support/frame.rb
+- lib/mysh/support/manage.rb
+- lib/mysh/support/parse.rb
 - lib/mysh/version.rb
 - mysh.gemspec
 - rakefile.rb

data/lib/mysh/commands/help.txt

@@ -1,17 +0,0 @@
-2) Ruby Expression support:
- - any line beginning with an equals "=" sign will be evaluated as a Ruby
-   expression. This allows the mysh command line to serve as a programming,
-   debugging and super-calculator environment.
- - for more info use the 'help ruby' command.
-
-3) Math support:
- - the execution environment includes the Math module.
- - for more info use the 'help math' command.
-
-4) External commands:"
- - executed by the system using the standard shell.
- - to force the use of the external shell, add a leading space to the command.
-
-Note: If the command has a '.rb' extension it is executed by Ruby.
-      So the command "myfile.rb" is executed as "ruby myfile.rb"
-

data/lib/mysh/commands/help_internal.txt

@@ -1,6 +0,0 @@
-1) Internal mysh commands:
- - executed by mysh directly.
- - supports the following set of commands.
-
-Command    Description
-=======    ===========