mysh 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d1ba8a1e0f44a3d96f072108abe9bba55aefebf
-  data.tar.gz: f5811e7f8aeba916be0b9dccd4864282314cb0f0
+  metadata.gz: 5357ad0b3384cce27b2e53bf392dde640f5b21ec
+  data.tar.gz: a84115ea89d9d586dae27bdbcaaffcff3060dbe0
 SHA512:
-  metadata.gz: a81089b6f2bf37d034eb8d1860774999e531ac34042d371dc9348090639f232c4d177cbfaee70220e24f68bd7a4e63420d39ba5fa983d14a1d3034a92d0bf432
-  data.tar.gz: 57a32385f635325c19ea131c79c1e8463ec7f405ff11a4e35934a64bae57baf54b07c8069c7050ce9f4b7f353b492d289f66fc854d97399437ce8c8c1439bef3
+  metadata.gz: a9336ae69aaf60132e7af4eaea1e09e3d98e1aded2daa1239508a843069f9729f539b80244bd5d59aa455bd9847f54f199968acb5bbe68b6a5c260e61dab1f0e
+  data.tar.gz: 52a3ceecf702aeb6c135f93c99249e2a3c8bd78c2f46a1a6a286bb438ad4e0223e2c0d23b8c920f2011d653d411809a7a04a5c1f60daa6b00da84cc7c5dd1725

data/README.md

@@ -1,5 +1,9 @@
 # Mysh
 
+mysh -- A ruby based command line shell program.
+
+## Background
+
 Inspired by the excellent article "Writing a Shell in 25 Lines of Ruby Code"
 I thought it would be fun to experiment with that concept and see if it could
 be taken further.
@@ -47,8 +51,8 @@ presented with a command prompt:
     $ mysh
     mysh>
 
-
-This prompt can be used to execute four sorts of commands:
+Then start entering some commands! This prompt can be used to execute four
+sorts of commands:
 
 * Ruby expressions, which are preceded by the equal (=) sign.
 * Internal commands that are processed directly by mysh
@@ -70,6 +74,7 @@ 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.
+x.lineage  Get the class lineage of the object x.
 vls "mask" List modules with version info. The optional mask string value is
            used to filter for modules containing that string.
 ```

data/lib/mysh/expression/lineage.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+#Object monkey patch for the mysh lineage command.
+class Object
+
+  #Get the lineage of this object.
+  def lineage
+    klass = self.class
+    klass.name + " instance < " + klass.lineage
+  end
+
+end
+
+#Class monkey patch for the mysh lineage command.
+class Class
+
+  #Get the lineage of this class.
+  def lineage
+    klass = superclass
+    name + (klass ? " < " + klass.lineage : "")
+  end
+
+end
+

data/lib/mysh/expression.rb

@@ -3,6 +3,8 @@
 require 'pp'
 require 'mathn'
 
+require_relative 'expression/lineage'
+
 #* expression.rb -- mysh ruby expression processor.
 #<br>Endemic Code Smells
 #* :reek:Attribute
@@ -14,82 +16,82 @@ module Mysh
     include Math
 
     #These variables live here so that they are not part of the mysh
-    #execution environment. This provides a little isolation.
+    #execution environment. This provides a little bit of isolation.
     class << self
+      #The result of the last expression evaluated.
       attr_accessor :result
-      attr_accessor :exec_fiber
+
+      #The execution binding used for ruby expressions.
       attr_accessor :exec_binding
-      attr_accessor :exec_result
     end
 
     #Set up a new execution environment
-    #<br>Note
-    #* The exec_result variable is needed because Fiber.yield messes up the
-    #  return value on an exception, even if that exception is handled.
-    def initialize
-      ExecHost.result = nil
-
-      ExecHost.exec_fiber = Fiber.new do |cmd|
-        ExecHost.exec_binding = binding
-
-        while true
-          begin
-            ExecHost.exec_result = ExecHost.exec_binding.eval(cmd)
-          rescue StandardError, ScriptError => err
-            ExecHost.exec_result = "#{err.class.to_s}: #{err}"
-          end
-
-          cmd = Fiber.yield
-        end
-      end
+    def initialize(owner)
+      @owner = owner
+      mysh_binding
+    end
 
+    #Create a binding for mysh to execute expressions in.
+    def mysh_binding
+      ExecHost.exec_binding = binding
     end
 
     #Process an expression.
     def execute(str)
       if str.start_with?('=')
-        do_execute(do_build(str))
-      else
-        false
+        do_execute(str)
+        :expression
       end
     end
 
-    #Reset the state of the execution host.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
-    def reset
-      Mysh.reset_host
-      nil
-    end
-
     private
 
-    #Gather up the full string of the expression to evaluate.
-    #<br>Endemic Code Smells
-    #* :reek:TooManyStatements
-    def do_build(str)
-      if /\\\s*$/ =~ str
-        parms = {prompt: 'mysh\\',
-                 auto_source: MiniReadline::QuotedFileFolderSource}
-
-        do_build($PREMATCH + "\n" + Mysh.input.readline(parms))
-      else
-        str
-      end
-    end
-
-    #Execute the string
+    #Do the actual work of executing an expression.
     def do_execute(str)
-      ExecHost.exec_fiber.resume("ExecHost.result #{str}")
-      result = ExecHost.exec_result
+      self.result = exec_binding.eval(str[1..-1])
       send(result ? :pp : :puts, result)
-      :expression
+    rescue Interrupt, StandardError, ScriptError => err
+      puts "#{err.class.to_s}: #{err}"
+    end
+
+    #Get the execute binding.
+    def exec_binding
+      self.class.exec_binding
     end
 
     #Get the previous result
     def result
       self.class.result
     end
+
+    #Set the current result
+    def result=(value)
+      self.class.result=value
+    end
+
+    #Reset the state of the execution host.
+    def reset
+      @owner.reset_host
+      nil
+    end
+
+    #A proxy for instance_eval.
+    def instance_eval(str)
+      exec_binding.eval(str)
+    end
+  end
+
+  #Try to execute the string as a ruby expression.
+  def self.try_execute_ruby_expression(str)
+    if str.start_with?('=')
+      @exec_host.execute(str)
+      :expression
+    end
+  end
+
+  #Reset the state of the execution hosting environment.
+  def self.reset_host
+    @exec_host = ExecHost.new(self)
   end
 
 end

data/lib/mysh/external_ruby.rb

@@ -4,7 +4,7 @@
 module Mysh
 
   #Try to execute as a Ruby program.
-  def self.ruby_execute(str)
+  def self.try_execute_external_ruby(str)
     cmd = str.split[0]
 
     if cmd && File.extname(cmd) == '.rb'

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

@@ -1,10 +1,10 @@
 # coding: utf-8
 
-#* support/frame.rb -- The abstract frame of mysh internal commands.
+#* internal/action.rb -- The framework of mysh internal actions.
 module Mysh
 
-  #The mysh internal command instance data and methods.
-  class Command
+  #The mysh internal action class.
+  class Action
     #The name of the command.
     attr_reader :name
 
@@ -25,7 +25,7 @@ module Mysh
     end
 
     #Get information about the command.
-    def command_info
+    def action_info
       [@name, @description]
     end
 

data/lib/mysh/{support/command_pool.rb → internal/action_pool.rb}

@@ -1,17 +1,17 @@
 # coding: utf-8
 
-#* support/command_pool.rb -- A managed hash of mysh commands.
+#* internal/action_pool.rb -- A managed hash of mysh commands.
 module Mysh
 
-  #* support/command_pool.rb -- A managed hash of mysh commands.
-  class CommandPool
+  #* A managed hash of mysh commands.
+  class ActionPool
 
     #Create a new command pool
     def initialize(&default_action)
       @pool = {}
 
       if default_action
-        @pool.default = Command.new("", "", &default_action)
+        @pool.default = Action.new("", "", &default_action)
       end
     end
 
@@ -24,7 +24,7 @@ module Mysh
     def add(name, description, &action)
       split_name = name.split[0] || ""
 
-      @pool[split_name] = Command.new(name, description, &action)
+      @pool[split_name] = Action.new(name, description, &action)
     end
 
     #Add an alias for an existing command.
@@ -36,14 +36,14 @@ module Mysh
       split_name = new_name.split[0]
 
       @pool[split_name] =
-        Command.new(new_name, command.description, &command.action)
+        Action.new(new_name, command.description, &command.action)
     end
 
     #Get information on all commands.
-    def command_info
+    def actions_info
       @pool
         .values
-        .map  {|command| command.command_info }
+        .map  {|action| action.action_info }
         .sort {|first, second| first[0] <=> second[0] }
     end
 

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

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+#* internal/actions/actions_path.rb -- A convenient hook to the command folder.
+module Mysh
+
+  #* internal/actions/actions_path.rb -- A convenient hook to the command folder.
+  class Action
+
+    #Capture this folder's name.
+    ACTIONS_PATH = File.dirname(__FILE__) + "/"
+
+  end
+
+end
+

data/lib/mysh/{commands → internal/actions}/cd.rb

@@ -1,10 +1,10 @@
 # coding: utf-8
 
-#* commands/cd.rb -- The mysh internal cd command.
+#* internal/actions/cd.rb -- The mysh internal cd command.
 module Mysh
 
   #* cd.rb -- The mysh internal cd command.
-  class 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.']

data/lib/mysh/{commands → internal/actions}/exit.rb

@@ -1,10 +1,10 @@
 # coding: utf-8
 
-#* commands/exit.rb -- The mysh internal exit command.
+#* internal/actions/exit.rb -- The mysh internal exit command.
 module Mysh
 
   #* exit.rb -- The mysh internal exit command.
-  class Command
+  class Action
     #Add the exit command to the library.
     COMMANDS.add('exit', 'Exit mysh.') do |args|
       raise MiniReadlineEOI

data/lib/mysh/{commands → internal/actions}/help.rb

@@ -1,30 +1,30 @@
 # coding: utf-8
 
-#* commands/help.rb -- The mysh internal help command.
+#* internal/actions/help.rb -- The mysh internal help command.
 module Mysh
 
   #* help.rb -- The mysh internal help command.
-  class Command
+  class Action
 
     # Help topics
-    HELP = CommandPool.new do |args|
+    HELP = ActionPool.new do |args|
       puts "No help found for #{args[0].inspect}."
     end
 
     HELP.add("", "General help on mysh.") do |args|
-      show_file('help.txt')
+      show_handlebar_file(ACTIONS_PATH + 'help.txt')
     end
 
     HELP.add("math", "Help on mysh math functions.") do |args|
-      show_file('help_math.txt')
+      show_handlebar_file(ACTIONS_PATH + 'help_math.txt')
     end
 
     HELP.add("=", "Help on mysh ruby expressions.") do |args|
-      show_file('help_expr.txt')
+      show_handlebar_file(ACTIONS_PATH + 'help_expr.txt')
     end
 
     HELP.add("help", "Help on mysh help.") do |args|
-      show_file('help_help.txt')
+      show_handlebar_file(ACTIONS_PATH + 'help_help.txt')
     end
 
     HELP.add_alias('?', 'help')

data/lib/mysh/{commands → internal/actions}/help.txt

@@ -24,7 +24,7 @@ the name of an internal command is processed internally by mysh.
 
 The following set of commands are supported:
 
-{{ format_items(COMMANDS.command_info).join("\n") }}
+{{ format_items(Mysh::COMMANDS.actions_info).join("\n") }}
 
 3) External commands:
 

data/lib/mysh/{commands → internal/actions}/help_expr.txt

@@ -15,6 +15,7 @@ A few noteworthy special methods exist:
 
 =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.
 =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 → internal/actions}/help_help.txt

@@ -5,5 +5,5 @@ or an optional specified topic.
 
 The available help topics are:
 
-{{ format_items(HELP.command_info).join("\n") }}
+{{ format_items(HELP.actions_info).join("\n") }}
 

data/lib/mysh/{commands → internal/actions}/history.rb

@@ -1,10 +1,10 @@
 # coding: utf-8
 
-#* commands/history.rb -- The mysh internal history command.
+#* internal/actions/history.rb -- The mysh internal history command.
 module Mysh
 
   #* history.rb -- The mysh internal history command.
-  class Command
+  class Action
     #Add the exit command to the library.
     COMMANDS.add('history', 'Display the mysh command history.') do |args|
       history = Mysh.input.history

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

@@ -1,10 +1,10 @@
 # coding: utf-8
 
-#* support/decorate.rb -- mysh internal file name beauty treatments.
+#* internal/decorate.rb -- mysh internal file name beauty treatments.
 module Mysh
 
   #The mysh internal file name beauty treatments.
-  class Command
+  class Action
 
     #Make the file name fit the local system.
     def decorate(name)

data/lib/mysh/internal/format.rb

@@ -0,0 +1,48 @@
+# coding: utf-8
+
+#The mysh internal command class level report formatting.
+class Object
+
+  private
+
+  #Display an array of items.
+  def display_items(items)
+    puts format_items(items)
+    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
+  end
+
+end
+

data/lib/mysh/internal/manage.rb

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+#* internal/manage.rb -- Manage mysh internal commands.
+module Mysh
+
+  #Set up the command library hash.
+  COMMANDS = ActionPool.new
+
+  #Parse a command string for use by commands.
+  def self.parse_command(str)
+    result = Mysh.parse_args(str.chomp)
+
+    [COMMANDS[result.shift], result]
+  end
+
+  #Execute an internal command
+  def self.execute(str)
+    unless str[0] == ' '
+      command, args = parse_command(str.chomp)
+
+      if (command)
+        command.execute(args)
+        :internal
+      end
+    end
+  end
+
+  #Try to execute the string as an internal command.
+  def self.try_execute_internal_command(str)
+    execute(str)
+  end
+
+end
+

data/lib/mysh/internal.rb

@@ -1,13 +1,11 @@
 # coding: utf-8
 
-require_relative 'commands/command_path'
-require_relative 'support/frame'
-require_relative 'support/command_pool'
-require_relative 'support/manage'
-require_relative 'support/parse'
-require_relative 'support/format'
-require_relative 'support/decorate'
-require_relative 'support/handlebars'
+require_relative 'internal/actions/actions_path'
+require_relative 'internal/action'
+require_relative 'internal/action_pool'
+require_relative 'internal/manage'
+require_relative 'internal/format'
+require_relative 'internal/decorate'
 
 #Load up the internal commands!
-Dir[Mysh::Command::COMMAND_PATH + '*.rb'].each {|file| require file }
+Dir[Mysh::Action::ACTIONS_PATH + '*.rb'].each {|file| require file }

data/lib/mysh/user_input/handlebars.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+#* 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
+  end
+
+  #Expand a file with embedded ruby handlebars.
+  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}"
+  end
+
+end
+
+

data/lib/mysh/user_input/parse.rb

@@ -0,0 +1,65 @@
+# coding: utf-8
+
+#* user_input/parse.rb -- mysh general parser.
+module Mysh
+
+  #Parse a string into components.
+  #<br>Endemic Code Smells
+  #* :reek:TooManyStatements
+  def self.parse_args(input)
+    result, read_point = [], input.chars.each
+
+    loop do
+      next_parse_char = read_point.next
+
+      if next_parse_char == '"'
+        result.concat(get_string(read_point))
+      elsif next_parse_char != ' '
+        result.concat(get_parameter(next_parse_char, read_point))
+      end
+    end
+
+    result
+  end
+
+  private
+
+  #Get a string parameter.
+  #<br>Endemic Code Smells
+  #* :reek:TooManyStatements
+  def self.get_string(read_point)
+    result = ""
+
+    loop do
+      next_str_char = read_point.next
+
+      break if next_str_char == '"'
+
+      result << next_str_char
+    end
+
+    [result]
+  end
+
+  #Get a parameter.
+  #<br>Endemic Code Smells
+  #* :reek:TooManyStatements
+  def self.get_parameter(first_char, read_point)
+    result = first_char
+
+    loop do
+      next_parm_char = read_point.next
+
+      if next_parm_char == '"'
+        return [result].concat(get_string(read_point))
+      elsif next_parm_char == ' '
+        break
+      else
+        result << next_parm_char
+      end
+    end
+
+    [result]
+  end
+
+end

data/lib/mysh/{smart_source.rb → user_input/smart_source.rb}

@@ -8,13 +8,14 @@ module Mysh
 
     #Create a new file/folder auto-data source. NOP
     def initialize(options)
+      @prefix = options[:prefix]
       @auto_source = MiniReadline::AutoFileSource.new(options)
       @quote_source = MiniReadline::QuotedFileFolderSource.new(options)
     end
 
     #Construct a new data list for auto-complete
     def rebuild(str)
-      @active_source = str[0] == '=' ? @quote_source : @auto_source
+      @active_source = (@prefix || str[0]) == '=' ? @quote_source : @auto_source
       @active_source.rebuild(str)
     end
 

data/lib/mysh/user_input.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+require_relative 'user_input/smart_source'
+require_relative 'user_input/parse'
+require_relative 'user_input/handlebars'
+
+#* user_input.rb -- Get a command from the user.
+module Mysh
+
+  #Get one command from the user.
+  def self.get_command
+    input = @input.readline(prompt: 'mysh>')
+    get_command_extra(input)
+  end
+
+  private
+
+  #Get any continuations of the inputs
+  def self.get_command_extra(str)
+    if /\\\s*$/ =~ str
+      parms = {prompt: 'mysh\\', prefix: str[0] }
+      get_command_extra($PREMATCH + "\n" + @input.readline(parms))
+    else
+      str
+    end
+
+  end
+
+  #Get the user input ready.
+  def self.init_input
+    @input = MiniReadline::Readline.new(history:       true,
+                                        eoi_detect:    true,
+                                        auto_complete: true,
+                                        auto_source:   SmartSource)
+  end
+
+end
+
+

data/lib/mysh/version.rb

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

data/lib/mysh.rb

@@ -7,7 +7,7 @@ require 'mini_readline'
 require 'vls'
 require 'in_array'
 
-require_relative 'mysh/smart_source'
+require_relative 'mysh/user_input'
 require_relative 'mysh/expression'
 require_relative 'mysh/internal'
 require_relative 'mysh/external_ruby'
@@ -25,36 +25,25 @@ module Mysh
   #<br>Endemic Code Smells
   #* :reek:TooManyStatements
   def self.run
-    init_run
+    reset_host
+    init_input
 
     loop do
-      input = @input.readline(prompt: 'mysh>')
-
       begin
-        @exec_host.execute(input) ||
-        Command.execute(input)    ||
-        ruby_execute(input)       ||
-        system(input)
-      rescue Interrupt => err
-        puts err
-      end
-    end
+        input = @exec_host.eval_handlebars(get_command)
 
-    rescue Interrupt, MiniReadlineEOI
-  end
+        try_execute_ruby_expression(input)  ||
+        try_execute_internal_command(input) ||
+        try_execute_external_ruby(input)    ||
+        system(input)
 
-  #Set up for the run command.
-  def self.init_run
-    reset_host
-    @input = MiniReadline::Readline.new(history: true,
-                                        eoi_detect: true,
-                                        auto_complete: true,
-                                        auto_source: SmartSource)
-  end
+      rescue MiniReadlineEOI
+        break
 
-  #Reset the state of the execution hosting environment.
-  def self.reset_host
-    @exec_host = ExecHost.new
+      rescue Interrupt, StandardError, ScriptError => err
+        puts err, err.backtrace
+      end
+    end
   end
 
 end

data/mysh.reek

@@ -0,0 +1,112 @@
+---
+Attribute:
+  enabled: false
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 3
+  overrides:
+    initialize:
+      max_params: 5
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 3
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+PrimaDonnaMethod:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 2
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 9
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 25
+TooManyStatements:
+  enabled: true
+  exclude:
+  - initialize
+  max_statements: 5
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept:
+  - Inline::C
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  - !ruby/regexp /^_/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept:
+  - _
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  max_helper_calls: 1
+UnusedPrivateMethod:
+  enabled: false
+  exclude: []

data/rakefile.rb

@@ -10,7 +10,7 @@ RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = "rdoc"
 
   #List out all the files to be documented.
-  rdoc.rdoc_files.include("lib/**/*.rb", "license.txt", "README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb", "license.txt")
 
   #Set a title.
   rdoc.options << '--title' << 'My Shell Gem Internals'

data/tests/my_shell_tests.rb

@@ -13,32 +13,32 @@ class MyShellTester < Minitest::Test
 
   def test_that_module_entities_exists
     assert_equal(Module, Mysh.class)
-    assert_equal(Class,  Mysh::Command.class)
+    assert_equal(Class,  Mysh::Action.class)
     assert_equal(Class,  Mysh::ExecHost.class)
   end
 
   def test_for_internal_commands
-    assert(Mysh::Command::COMMANDS['exit'], "The exit command is missing.")
-    assert(Mysh::Command::COMMANDS['quit'], "The quit command is missing.")
+    assert(Mysh::COMMANDS['exit'], "The exit command is missing.")
+    assert(Mysh::COMMANDS['quit'], "The quit command is missing.")
 
-    assert(Mysh::Command::COMMANDS['history'], "The history command is missing.")
-    assert(Mysh::Command::COMMANDS['!'], "The ! command is missing.")
+    assert(Mysh::COMMANDS['history'], "The history command is missing.")
+    assert(Mysh::COMMANDS['!'], "The ! command is missing.")
 
-    assert(Mysh::Command::COMMANDS['help'], "The help command is missing.")
-    assert(Mysh::Command::COMMANDS['?'], "The ? command is missing.")
+    assert(Mysh::COMMANDS['help'], "The help command is missing.")
+    assert(Mysh::COMMANDS['?'], "The ? command is missing.")
 
-    assert(Mysh::Command::COMMANDS['cd'], "The cd command is missing.")
-    assert(Mysh::Command::COMMANDS['pwd'], "The pwd command is missing.")
+    assert(Mysh::COMMANDS['cd'], "The cd command is missing.")
+    assert(Mysh::COMMANDS['pwd'], "The pwd command is missing.")
 
-    assert_raises { Mysh::Command::COMMANDS.add_alias('blam', 'shazzam') }
+    assert_raises { Mysh::COMMANDS.add_alias('blam', 'shazzam') }
   end
 
   def test_handlebars
-    cmd = Mysh::Command::COMMANDS['help']
-
     assert_equal("ABC 123 DEF",
-                 cmd.expand_handlebars("ABC {{ (1..3).to_a.join }} DEF"))
+                 eval_handlebars("ABC {{ (1..3).to_a.join }} DEF"))
 
+    assert_equal("ABC", eval_handlebars("{{ 'ABC'  }}"))
+    assert_equal("",    eval_handlebars("{{ 'ABC' #}}"))
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysh
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,28 +151,31 @@ files:
 - README.md
 - bin/mysh
 - lib/mysh.rb
-- lib/mysh/commands/cd.rb
-- lib/mysh/commands/command_path.rb
-- lib/mysh/commands/exit.rb
-- lib/mysh/commands/help.rb
-- lib/mysh/commands/help.txt
-- lib/mysh/commands/help_expr.txt
-- lib/mysh/commands/help_help.txt
-- lib/mysh/commands/help_math.txt
-- lib/mysh/commands/history.rb
 - lib/mysh/expression.rb
+- lib/mysh/expression/lineage.rb
 - lib/mysh/external_ruby.rb
 - lib/mysh/internal.rb
-- lib/mysh/smart_source.rb
-- lib/mysh/support/command_pool.rb
-- lib/mysh/support/decorate.rb
-- lib/mysh/support/format.rb
-- lib/mysh/support/frame.rb
-- lib/mysh/support/handlebars.rb
-- lib/mysh/support/manage.rb
-- lib/mysh/support/parse.rb
+- lib/mysh/internal/action.rb
+- lib/mysh/internal/action_pool.rb
+- lib/mysh/internal/actions/actions_path.rb
+- lib/mysh/internal/actions/cd.rb
+- lib/mysh/internal/actions/exit.rb
+- lib/mysh/internal/actions/help.rb
+- lib/mysh/internal/actions/help.txt
+- lib/mysh/internal/actions/help_expr.txt
+- lib/mysh/internal/actions/help_help.txt
+- lib/mysh/internal/actions/help_math.txt
+- lib/mysh/internal/actions/history.rb
+- lib/mysh/internal/decorate.rb
+- lib/mysh/internal/format.rb
+- lib/mysh/internal/manage.rb
+- lib/mysh/user_input.rb
+- lib/mysh/user_input/handlebars.rb
+- lib/mysh/user_input/parse.rb
+- lib/mysh/user_input/smart_source.rb
 - lib/mysh/version.rb
 - mysh.gemspec
+- mysh.reek
 - rakefile.rb
 - reek.txt
 - test.rb

data/lib/mysh/commands/command_path.rb

@@ -1,15 +0,0 @@
-# coding: utf-8
-
-#* commands/command_path.rb -- A convenient hook to the command folder.
-module Mysh
-
-  #* commands/command_path.rb -- A convenient hook to the command folder.
-  class Command
-
-    #Capture this folder's name.
-    COMMAND_PATH = File.dirname(__FILE__) + "/"
-
-  end
-
-end
-

data/lib/mysh/support/format.rb

@@ -1,50 +0,0 @@
-# coding: utf-8
-
-#* support/format.rb -- Format mysh internal reports.
-module Mysh
-
-  #The mysh internal command class level report formatting.
-  class Command
-
-    #Display an array of items.
-    def display_items(items)
-      puts format_items(items)
-      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
-    end
-
-  end
-end
-

data/lib/mysh/support/handlebars.rb

@@ -1,30 +0,0 @@
-# coding: utf-8
-
-#* support/handlebars.rb -- Allow text files to embed ruby code.
-module Mysh
-
-  #The mysh embedded ruby text formatting.
-  class Command
-
-    #Process a string with embedded Ruby code.
-    def expand_handlebars(str)
-      loop do
-        pre_match, match, post_match = str.partition(/{{.*?}}/m)
-
-        return pre_match if match.empty?
-
-        str = pre_match + eval(match[2...-2]) + post_match
-      end
-    end
-
-    #Show a file with embedded ruby handlebars.
-    def show_file(name)
-      puts expand_handlebars(IO.read(full_name = COMMAND_PATH + name))
-    rescue StandardError, ScriptError => err
-      puts "Error in file: #{full_name}\n#{err.class}: #{err}"
-    end
-
-  end
-
-end
-

data/lib/mysh/support/manage.rb

@@ -1,26 +0,0 @@
-# coding: utf-8
-
-#* support/manage.rb -- Manage mysh internal commands.
-module Mysh
-
-  #The mysh internal command class level data and methods.
-  class Command
-
-    #Set up the command library hash.
-    COMMANDS = CommandPool.new
-
-    #Execute an internal command
-    def self.execute(str)
-      unless str[0] == ' '
-        command, args = parse(str.chomp)
-
-        if (command)
-          command.execute(args)
-          :internal
-        end
-      end
-    end
-
-  end
-end
-

data/lib/mysh/support/parse.rb

@@ -1,70 +0,0 @@
-# coding: utf-8
-
-#* support/parse.rb -- mysh internal command parser.
-module Mysh
-
-  #The mysh internal command instance data and methods.
-  class Command
-
-    #Parse a command string for use by commands.
-    #<br>Endemic Code Smells
-    #* :reek:TooManyStatements
-    def self.parse(input)
-      result, read_point = [], input.chars.each
-
-      loop do
-        next_parse_char = read_point.next
-
-        if next_parse_char == '"'
-          result.concat(get_string(read_point))
-        elsif next_parse_char != ' '
-          result.concat(get_parameter(next_parse_char, read_point))
-        end
-      end
-
-      [COMMANDS[result.shift], result]
-    end
-
-    private
-
-    #Get a string parameter.
-    #<br>Endemic Code Smells
-    #* :reek:TooManyStatements
-    def self.get_string(read_point)
-      result = ""
-
-      loop do
-        next_str_char = read_point.next
-
-        break if next_str_char == '"'
-
-        result << next_str_char
-      end
-
-      [result]
-    end
-
-    #Get a parameter.
-    #<br>Endemic Code Smells
-    #* :reek:TooManyStatements
-    def self.get_parameter(first_char, read_point)
-      result = first_char
-
-      loop do
-        next_parm_char = read_point.next
-
-        if next_parm_char == '"'
-          return [result].concat(get_string(read_point))
-        elsif next_parm_char == ' '
-          break
-        else
-          result << next_parm_char
-        end
-      end
-
-      [result]
-    end
-
-  end
-
-end