mysh 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5357ad0b3384cce27b2e53bf392dde640f5b21ec
-  data.tar.gz: a84115ea89d9d586dae27bdbcaaffcff3060dbe0
+  metadata.gz: 456fdf1833320032c9452e13eeb0c140d84f69e6
+  data.tar.gz: 0590da7cd17f06fe1b428b47026b054f30fce371
 SHA512:
-  metadata.gz: a9336ae69aaf60132e7af4eaea1e09e3d98e1aded2daa1239508a843069f9729f539b80244bd5d59aa455bd9847f54f199968acb5bbe68b6a5c260e61dab1f0e
-  data.tar.gz: 52a3ceecf702aeb6c135f93c99249e2a3c8bd78c2f46a1a6a286bb438ad4e0223e2c0d23b8c920f2011d653d411809a7a04a5c1f60daa6b00da84cc7c5dd1725
+  metadata.gz: d72558e9e315c03ba978cda6ef40cbbfe113bcc995933b2e76ad5744bc22aa5fa50dfa9958d82e65e333293c03f2ff0a1dba5100e5ed1c8edb047a3a0949ee14
+  data.tar.gz: 18d160168fd6aec07cb6b6064f1a0adad97018214ab14dd24592e7c95bc629039a7460889f9c46217fc57c7eafa28b323832df9439c9fe20784356e4dd95b75e

data/README.md

@@ -137,6 +137,18 @@ history   Display the mysh command history.
 pwd       Display the current working directory.
 quit      Exit mysh.
 ```
+Of note is the command "help help" which provides a list of available 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.
 
 #### External commands:
 
@@ -164,13 +176,12 @@ Mysh.run
 #### Adding New Commands
 
 It is possible to add new internal commands to the mysh CLI. This may done
-manually by depositing the appropriate ruby file in the commands folder located
-at:
+manually by depositing the appropriate ruby file in the actions folder
+located at:
 
-    <gem_root>/mysh/lib/mysh/commands
+    <gem_root>/mysh/lib/mysh/internal/actions
 
-A survey of the contents of that folder will reveal the nature of these
-command files.
+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
@@ -178,7 +189,7 @@ something like this:
 
 ```ruby
 module Mysh
-  class InternalCommand
+  class Action
 
     add(command_name, command_description) do |args|
       # Action block goes here
@@ -190,17 +201,37 @@ end
 
 Where:
 * command_name is the name of the command with optional argument descriptions
-separated with spaces. The command is the first word of this string.
+separated with spaces. The command is the first word of this string. For
+example a command_name of:
+
+```
+"cd <dst>"
+```
+
+will create a command called "cd" with a title of "cd &#60;dst&#62;"
+
 * 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.
+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.
+
+So if a command is given
+
+    command abc "this is a string" 23 --launch --all
+
+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 InternalCommand
+  class Action
 
     add_alias(new_name, old_name)
 

data/lib/mysh/expression.rb

@@ -6,8 +6,6 @@ require 'mathn'
 require_relative 'expression/lineage'
 
 #* expression.rb -- mysh ruby expression processor.
-#<br>Endemic Code Smells
-#* :reek:Attribute
 module Mysh
 
   #The mysh ruby expression processor.

data/lib/mysh/internal/action.rb

@@ -26,7 +26,7 @@ module Mysh
 
     #Get information about the command.
     def action_info
-      [@name, @description]
+      [@name].concat(@description)
     end
 
   end

data/lib/mysh/internal/action_pool.rb

@@ -1,12 +1,12 @@
 # coding: utf-8
 
-#* internal/action_pool.rb -- A managed hash of mysh commands.
+#* internal/action_pool.rb -- A managed hash of mysh actions.
 module Mysh
 
-  #* A managed hash of mysh commands.
+  #* A managed hash of mysh actions.
   class ActionPool
 
-    #Create a new command pool
+    #Create a new action pool
     def initialize(&default_action)
       @pool = {}
 
@@ -15,31 +15,31 @@ module Mysh
       end
     end
 
-    #Get a command.
+    #Get a action.
     def [](index)
       @pool[index]
     end
 
-    #Add a command.
+    #Add a action.
     def add(name, description, &action)
       split_name = name.split[0] || ""
 
       @pool[split_name] = Action.new(name, description, &action)
     end
 
-    #Add an alias for an existing command.
+    #Add an alias for an existing action.
     def add_alias(new_name, old_name)
-      unless (command = @pool[old_name])
+      unless (action = @pool[old_name])
         fail "Error adding alias #{new_name} for #{old_name}"
       end
 
       split_name = new_name.split[0]
 
       @pool[split_name] =
-        Action.new(new_name, command.description, &command.action)
+        Action.new(new_name, action.description, &action.action)
     end
 
-    #Get information on all commands.
+    #Get information on all actions.
     def actions_info
       @pool
         .values

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

@@ -6,8 +6,8 @@ module Mysh
   #* cd.rb -- The mysh internal cd command.
   class Action
     #Add the cd command to the library.
-    desc = ['Change directory to the optional <dir> parameter',
-            'and then display the current working directory.']
+    desc = 'Change directory to the optional <dir> parameter ' +
+           'and then display the current working directory.'
 
     COMMANDS.add('cd <dir>', desc) do |args|
       begin

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

@@ -1,42 +1,27 @@
 mysh (MY ruby SHell) 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. The name rsh
-was already widely in use so it was mysh for some extra ego.
+same way the csh was inspired by the "C" programming language.
 
 In mysh, commands fall into one of three broad categories. There are:
 
-1) Ruby expressions:
+1) "=" expressions: Any line beginning with an "=" will be evaluated as a Ruby
+   language expression. For more see the '? =' or '? math' commands.
 
-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 information on ruby expressions use the 'help =' command.
-
-Note: This environment includes support for advanced mathematical operations.
-      For more information on this feature, use the 'help math' command.
-
-2) Internal mysh commands:
-
-Internal commands are processed within mysh itself. Any command that matches
-the name of an internal command is processed internally by mysh.
-
-The following set of commands are supported:
+2) Internal mysh commands are processed within mysh itself. The following set
+   of commands are supported:
 
 {{ format_items(Mysh::COMMANDS.actions_info).join("\n") }}
 
-3) External commands:
-
-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 is executed by the appropriate ruby
-interpreter. So the command "myfile.rb" is executed as
+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
+   is executed by the appropriate ruby interpreter. So the command "myfile.rb"
+   is executed as:
 
-  {{ RbConfig.ruby }} myfile.rb"
+   "{{ RbConfig.ruby }} myfile.rb"
 
 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.
 

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

@@ -1,17 +1,20 @@
 mysh Ruby expression support summary:
 
-All command lines that begin with an equals ("=") sign are evaluated as Ruby
-expressions. Lines ending with a backslash character ("\") are continued on the
-next line. The prompt changes to "mysh\" to indicate that this is going on. The
-command is NOT actually processed until a line with NO trailing backslash is
-entered.
+All command lines that begin with = are evaluated as Ruby expressions.
 
-The results of the expression are displayed using the pretty-print facility.
+Notes:
 
-Note: Auto-complete always places any file names in quotes so they can be used
-      as string parameters.
+Lines ending with a \\ are continued on the next line. The prompt changes to
+mysh\\ to indicate that this is going on. The command is NOT actually processed
+until a line with NO trailing \\ is entered.
 
-A few noteworthy special methods exist:
+The results of the expression are displayed using the pretty-print facility
+except for nil (shows as blank).
+
+Auto-complete always places any file names in quotes so they can be used as
+string parameters.
+
+A few special methods exist:
 
 =reset      Reset the execution environment to the default state.
 =result     Returns the result of the previous expression.
@@ -19,3 +22,5 @@ A few noteworthy special methods exist:
 =vls "mask" List modules with version info. The optional mask string value is
             used to filter for modules containing that string.
 
+Also included are a number of math methods. See '? math' for more on these.
+

data/lib/mysh/internal/format.rb

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require_relative 'format/bullets'
+
 #The mysh internal command class level report formatting.
 class Object
 
@@ -7,41 +9,15 @@ class Object
 
   #Display an array of items.
   def display_items(items)
-    puts format_items(items)
+    items.puts_mysh_bullets
     puts
   end
 
   #Format an array of items.
   #<br>Endemic Code Smells
-  #* :reek:FeatureEnvy
-  def format_items(items, buffer=[])
-    #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| format_item(item, buffer, tag_width) }
-
-    buffer
-  end
-
-  #Display one item.
-  def display_item(item, tag_width=nil)
-    puts format_item(item, [], tag_width)
-    puts
-  end
-
-  #Format one item.
-  #<br>Endemic Code Smells
-  #* :reek:UtilityFunction
-  def format_item(item, buffer=[], tag_width)
-    tag = item[0]
-
-    item[1].each do |detail|
-      buffer << "#{tag.ljust(tag_width)} #{detail}"
-      tag = ""
-    end
-
-    buffer
+  #* :reek:FeatureEnvy :reek:UtilityFunction
+  def format_items(items)
+    items.mysh_bulletize
   end
 
 end

data/lib/mysh/internal/format/bullets.rb

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+#* internal/format/bullets.rb - Print out bullet points.
+module Mysh
+
+  #A class to display data in bullet points.
+  class BulletPoints
+
+    #Assume an 80 column working area.
+    PAGE_WIDTH = 80
+
+    #Prepare a blank slate.
+    def initialize
+      @bullet_data = []
+    end
+
+    #Add an item to this page.
+    #<br>Endemic Code Smells
+    #* :reek:FeatureEnvy  :reek:TooManyStatements
+    def add(raw_bullet = "*", *raw_item)
+
+      if raw_item.empty?
+        bullet = ["*"]
+        items = raw_bullet.in_array
+      else
+        bullet = [raw_bullet]
+        items = raw_item.in_array
+      end
+
+      items.each_index do |index|
+        @bullet_data << [(bullet[index] || "").to_s, items[index].to_s]
+      end
+    end
+
+    #Render the page as an array of strings.
+    def render
+      @key_length, results = get_key_length, []
+
+      @bullet_data.each do |key, item|
+        results.concat(render_bullet(key, item))
+      end
+
+      @bullet_data = []
+      results
+    end
+
+    private
+
+    #How large is the largest bullet?
+    def get_key_length
+      (@bullet_data.max_by {|line| line[0].length})[0].length
+    end
+
+    #Render one bullet point.
+    #<br>Endemic Code Smells
+    #* :reek:DuplicateMethodCall :reek:TooManyStatements
+    def render_bullet(key, item)
+      result, pass_one = [], true
+      input  = item.split(' ').each
+      temp   = key.ljust(len = @key_length)
+
+      loop do
+        word = ' ' + input.next
+
+        while len >= PAGE_WIDTH
+          result << temp.slice!(0, PAGE_WIDTH - 1)
+          temp = blank_key + ' ' + temp
+          len  = temp.length
+        end
+
+        if ((len += word.length) >= PAGE_WIDTH) && !pass_one
+          result << temp
+          temp = blank_key + word
+          len  = temp.length
+        else
+          temp << word
+          pass_one = false
+        end
+      end
+
+      result << temp
+    end
+
+    #Generate a blank bullet key
+    def blank_key
+      ' ' * @key_length
+    end
+
+  end
+
+end
+
+#Bullet point support in the Array class.
+class Array
+  #Print out the array as bullet points.
+  def puts_mysh_bullets
+    puts mysh_bulletize
+  end
+
+  #Convert the array to strings with bullet points.
+  #<br>
+  #* An array of arrays of strings
+  def mysh_bulletize
+    builder = Mysh::BulletPoints.new
+
+    self.each do |pair|
+      builder.add(*pair)
+    end
+
+    builder.render
+  end
+end
+

data/lib/mysh/user_input/handlebars.rb

@@ -3,29 +3,42 @@
 #* user_input/handlebars.rb -- Handlebar embedded ruby support.
 class Object
 
-  #Process a string with embedded Ruby code.
-  def eval_handlebars(str)
-    loop do
-      pre_match, match, post_match = str.partition(/{{.*?}}/m)
-
-      return pre_match if match.empty?
-
-      result = instance_eval(code = match[2...-2])
-
-      str = pre_match + (result unless code.end_with?("#")).to_s + post_match
-    end
+  #Show a file with embedded ruby handlebars.
+  #<br>Note:
+  #The message receiver is the evaluation host for the handlebar code.
+  def show_handlebar_file(name)
+    puts eval_handlebar_file(name)
+  rescue Interrupt, StandardError, ScriptError => err
+    puts "Error in file: #{name}\n#{err.class}: #{err}"
   end
 
   #Expand a file with embedded ruby handlebars.
+  #<br>Note:
+  #The message receiver is the evaluation host for the handlebar code.
   def eval_handlebar_file(name)
     eval_handlebars(IO.read(name))
   end
 
-  #Show a file with embedded ruby handlebars.
-  def show_handlebar_file(name)
-    puts eval_handlebar_file(name)
-  rescue Interrupt, StandardError, ScriptError => err
-    puts "Error in file: #{name}\n#{err.class}: #{err}"
+  #Process a string with backslash quotes and code embedded in handlebars.
+  #<br>Note:
+  #The message receiver is the evaluation host for the handlebar code.
+  def eval_handlebars(str)
+    do_process_handlebars(str).gsub(/\\\S/) {|found| found[1]}
+  end
+
+  private
+
+  #Process a string with code embedded in handlebars.
+  #<br>Note:
+  #The message receiver is the evaluation host for the handlebar code.
+  def do_process_handlebars(str)
+    str.gsub(/{{.*?}}/m) do |match|
+      code   = match[2...-2]
+      silent = code.end_with?("#")
+      result = instance_eval(code)
+
+      (result unless silent).to_s
+    end
   end
 
 end

data/lib/mysh/version.rb

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

data/rakefile.rb

@@ -12,6 +12,9 @@ RDoc::Task.new do |rdoc|
   #List out all the files to be documented.
   rdoc.rdoc_files.include("lib/**/*.rb", "license.txt")
 
+  #Make all access levels visible.
+  rdoc.options << '--visibility' << 'private'
+
   #Set a title.
   rdoc.options << '--title' << 'My Shell Gem Internals'
 end

data/tests/my_shell_tests.rb

@@ -39,6 +39,9 @@ class MyShellTester < Minitest::Test
 
     assert_equal("ABC", eval_handlebars("{{ 'ABC'  }}"))
     assert_equal("",    eval_handlebars("{{ 'ABC' #}}"))
+
+    assert_equal("{{ 'ABC' }}", eval_handlebars("\\{\\{ 'ABC' \\}\\}"))
+    assert_equal("{{A}}", eval_handlebars("{{ '{'+'{A}'+'}' }}"))
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysh
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-05 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -168,6 +168,7 @@ files:
 - lib/mysh/internal/actions/history.rb
 - lib/mysh/internal/decorate.rb
 - lib/mysh/internal/format.rb
+- lib/mysh/internal/format/bullets.rb
 - lib/mysh/internal/manage.rb
 - lib/mysh/user_input.rb
 - lib/mysh/user_input/handlebars.rb
@@ -200,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: mysh -- a Ruby inspired command shell.