mysh 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78a7e5a670f53f7cdfb9ede87c31216f1e596a20
-  data.tar.gz: 2c2a24ad4aebe2b5c430d647dacccd6cb1b046d7
+  metadata.gz: 1658b8c71d6ab5674a8cd4576cc552c8b3fa6904
+  data.tar.gz: 7f8ce8c574a5c959a59bf5b90d64c72fa91776b2
 SHA512:
-  metadata.gz: 3678b1a241def34b14cc123e19bba3ac080d7b0d95e2f7de3d92dacdda96106df6adae9b1b8fc73d0aea7b840638020f1e9a29225edb3d9833c6abfc70bdc010
-  data.tar.gz: 56666cd89ba7ea004e2ff507e29f8401c35704b80028eec2e199e074f836f5b225430f665f3d3d20f25ad1f7c075bfaf9518ab8761c9efc0caf722467d34bb3e
+  metadata.gz: 1f4cb448b3a8f3b7e145efdaa4ce7de0550de04cef55009e03a3cd932f2c9dea29a2bf88fb177f0e1476d82790595aaf56affbb62d4c0bdfc4eb6adaa5a1941f
+  data.tar.gz: 675d36eaead283f5d899e7da6949fd09d894496eec25170983db5df34a7b41e0e7cef7f6edfc79775682e88881e60e7211561a82454f0370776e7b0c97d11988

data/README.md

@@ -41,14 +41,17 @@ Or install it yourself as:
 The mysh gem includes a simple executable called mysh. When run, the user is
 presented with a command prompt:
 
-  mysh>
+    Peter Camilleri@NCC1701G ~
+    $ mysh
+    mysh>
 
-This prompt can be used to execute three sorts of commands:
+
+This prompt can be used to execute four 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 or the
-Ruby interpreter.
+* External ruby source files that are passed on to the Ruby interpreter.
+* External commands that are passed on to the standard command shell.
 
 From the mysh help:
 

data/lib/mysh.rb

@@ -10,7 +10,7 @@ require 'in_array'
 require_relative 'mysh/smart_source'
 require_relative 'mysh/expression'
 require_relative 'mysh/internal'
-require_relative 'mysh/ruby'
+require_relative 'mysh/external_ruby'
 require_relative 'mysh/version'
 
 #The MY SHell module. A container for its functionality.

data/lib/mysh/commands/help.rb

@@ -5,23 +5,25 @@ module Mysh
 
   #* exit.rb -- The mysh internal exit command.
   class InternalCommand
+    #Show a help file
+    def show_help(name)
+      full_name = File.dirname(__FILE__) + name
+      str = IO.read(full_name)
+      puts process_erb_string(str)
+    rescue StandardError, ScriptError => err
+      puts "Error processing file #{full_name}"
+      puts "#{err.class.to_s}: #{err}"
+    end
+
+    HELP = Hash.new(lambda {|args| puts "No help found for #{args[0]}." })
+
+    HELP[nil]    = lambda {|_args| show_help('/help.txt') }
+    HELP['math'] = lambda {|_args| show_help('/help_math.txt') }
+    HELP['ruby'] = lambda {|_args| show_help('/help_ruby.txt') }
+
     #Add the exit command to the library.
     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_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'
-        puts IO.read(File.dirname(__FILE__) + '/help_ruby.txt')
-      else
-        puts "help #{args[0]} ???"
-      end
-
+      instance_exec(args, &HELP[args[0]])
     end
 
     add_alias('?', 'help')

data/lib/mysh/commands/help.txt

@@ -0,0 +1,35 @@
+mysh (MY ruby SHell) version: {{ Mysh::VERSION }}
+
+In mysh, commands fall into one of three broad categories. There are:
+
+1) Ruby expressions:
+
+- 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 ruby' command.
+
+- 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 recognized by name and are executed by mysh directly.
+- These commands are found in the ".../mysh/lib/mysh/commands" folder.
+- The following set of commands are supported:
+
+{{ format_items(InternalCommand.command_info).join("\n") }}
+
+3) External commands:
+
+- All other commands are executed by the system using the standard shell or
+  the appropriate ruby interpreter.
+- If an internal command has the same name as an external command, adding a
+  leading space will force the use of the external command.
+- 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"
+
+  for this particular system.
+

data/lib/mysh/expression.rb

@@ -4,6 +4,8 @@ require 'pp'
 require 'mathn'
 
 #* expression.rb -- mysh ruby expression processor.
+#<br>Endemic Code Smells
+#* :reek:Attribute
 module Mysh
 
   #The mysh ruby expression processor.
@@ -11,8 +13,37 @@ module Mysh
 
     include Math
 
-    #The result of the previous expression.
-    attr_reader :result
+    #These variables live here so that they are not part of the mysh
+    #execution environment. This provides a little isolation.
+    class << self
+      attr_accessor :result
+      attr_accessor :exec_fiber
+      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
+
+    end
 
     #Process an expression.
     def execute(str)
@@ -49,12 +80,15 @@ module Mysh
 
     #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
+      ExecHost.exec_fiber.resume("ExecHost.result #{str}")
+      result = ExecHost.exec_result
+      send(result ? :pp : :puts, result)
+      :expression
+    end
+
+    #Get the previous result
+    def result
+      self.class.result
     end
   end
 

data/lib/mysh/external_ruby.rb

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+#* external_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)
+    cmd = str.split[0]
+
+    if cmd && File.extname(cmd) == '.rb'
+      new_command = "#{RbConfig.ruby} #{str}"
+      puts "=> #{new_command}"
+      system(new_command)
+      :ruby_exec
+    end
+
+  end
+
+end

data/lib/mysh/internal.rb

@@ -5,6 +5,7 @@ require_relative 'support/parse'
 require_relative 'support/format'
 require_relative 'support/frame'
 require_relative 'support/decorate'
+require_relative 'support/text_erb'
 
 #Load up the internal commands!
 Dir[File.dirname(__FILE__) + '/commands/*.rb'].each {|file| require file }

data/lib/mysh/support/decorate.rb

@@ -7,22 +7,28 @@ module Mysh
   class InternalCommand
 
     #Make the file name fit the local system.
-    def self.decorate(name)
+    def decorate(name)
       dress_up_quotes(dress_up_slashes(name))
     end
 
+    private
+
     #Dress up slashes and backslashes.
-    def self.dress_up_slashes(name)
+    def dress_up_slashes(name)
       backslash? ? name.gsub("/", "\\") : name
     end
 
     #Dress up in quotes if needed.
-    def self.dress_up_quotes(name)
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
+    def dress_up_quotes(name)
       name[' '] ? "\"#{name}\"" : name
     end
 
     #Does this file name use backslashes?
-    def self.backslash?
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
+    def backslash?
       MiniReadline::PLATFORM == :windows
     end
 

data/lib/mysh/support/format.rb

@@ -7,33 +7,50 @@ module Mysh
   class InternalCommand
 
     #Get information on all commands.
-    def self.info
+    def self.command_info
       @commands
         .values
-        .map  {|command| command.info }
+        .map  {|command| command.command_info }
         .sort {|first, second| first[0] <=> second[0] }
     end
 
     #Display an array of items.
-    def self.display_items(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| display_item(item, tag_width) }
+      items.each {|item| format_item(item, buffer, tag_width) }
 
-      puts
+      buffer
     end
 
     #Display one item.
-    def self.display_item(item, tag_width=nil)
+    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]
-      tag_width ||= tag.length + 1
 
       item[1].each do |detail|
-        puts "#{tag.ljust(tag_width)} #{detail}"
+        buffer << "#{tag.ljust(tag_width)} #{detail}"
         tag = ""
       end
+
+      buffer
     end
 
   end

data/lib/mysh/support/frame.rb

@@ -21,11 +21,11 @@ module Mysh
 
     #Execute the command.
     def execute(args)
-      @action.call(args)
+      instance_exec(args, &@action)
     end
 
     #Get information about the command.
-    def info
+    def command_info
       [@name, @description]
     end
 

data/lib/mysh/support/parse.rb

@@ -13,11 +13,7 @@ module Mysh
       result, read_point = [], input.chars.each
 
       loop do
-        begin
-          next_parse_char = read_point.next
-        rescue StopIteration
-          break
-        end
+        next_parse_char = read_point.next
 
         if next_parse_char == '"'
           result.concat(get_string(read_point))
@@ -38,11 +34,7 @@ module Mysh
       result = ""
 
       loop do
-        begin
-          next_str_char = read_point.next
-        rescue StopIteration
-          break
-        end
+        next_str_char = read_point.next
 
         break if next_str_char == '"'
 
@@ -59,11 +51,7 @@ module Mysh
       result = first_char
 
       loop do
-        begin
-          next_parm_char = read_point.next
-        rescue StopIteration
-          break
-        end
+        next_parm_char = read_point.next
 
         if next_parm_char == '"'
           return [result].concat(get_string(read_point))

data/lib/mysh/support/text_erb.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+#* support/text_erb.rb -- Allow text files to embed ruby code.
+module Mysh
+
+  #The mysh embedded ruby report formatting.
+  class InternalCommand
+
+    #Process a string with embedded Ruby code.
+    def process_erb_string(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
+
+  end
+
+end
+

data/lib/mysh/version.rb

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

data/test.rb

@@ -0,0 +1,4 @@
+#A sample test file to be run.
+
+puts "Running sample file."
+puts "args = #{ARGV.inspect}"

data/tests/my_shell_tests.rb

@@ -32,4 +32,15 @@ class MyShellTester < Minitest::Test
 
     assert_raises { Mysh::InternalCommand.add_alias('blam', 'shazzam') }
   end
+
+  def test_handlebars
+    cmd = Mysh::InternalCommand.commands['help']
+
+    assert_equal("ABC 123 DEF",
+                 cmd.process_erb_string("ABC {{ (1..3).to_a.join }} DEF"))
+
+  end
+
+
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysh
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-25 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -154,24 +154,25 @@ files:
 - lib/mysh/commands/cd.rb
 - lib/mysh/commands/exit.rb
 - lib/mysh/commands/help.rb
-- lib/mysh/commands/help_head.txt
+- lib/mysh/commands/help.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/external_ruby.rb
 - lib/mysh/internal.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/support/text_erb.rb
 - lib/mysh/version.rb
 - mysh.gemspec
 - rakefile.rb
 - reek.txt
+- test.rb
 - tests/my_shell_tests.rb
 homepage: http://teuthida-technologies.com/
 licenses:

data/lib/mysh/commands/help_head.txt

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

data/lib/mysh/commands/help_tail.txt

@@ -1,20 +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/ruby.rb

@@ -1,16 +0,0 @@
-# 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 (command = str.split[0]) && File.extname(command) == '.rb'
-      puts "=> #{new_command = "ruby #{str}"}\n\n"
-      system(new_command)
-      :ruby_exec
-    end
-
-  end
-
-end