mysh 0.2.7 → 0.3.0

data/lib/mysh/pre_processor.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+
+#* mysh/pre_processor.rb -- The mysh macro/handlebar preprocessor.
+class String
+
+  #The mysh string pre-processor stack.
+  def preprocess(evaluator=$mysh_exec_host)
+    self.eval_variables.eval_handlebars(evaluator).eval_quoted_braces
+  end
+
+end

data/lib/mysh/quick.rb

@@ -10,6 +10,7 @@ module Mysh
   QUICK['='] = lambda {|str| $mysh_exec_host.execute(str) }
   QUICK['?'] = lambda {|str| HELP_COMMAND.quick_parse_and_call(str) }
   QUICK['@'] = lambda {|str| SHOW_COMMAND.quick_parse_and_call(str) }
+  QUICK['$'] = lambda {|str| VARS_COMMAND.call(str) }
 
   #Try to execute the string as a quick command.
   def self.try_execute_quick_command(str)

data/lib/mysh/shell_variables.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+require_relative 'shell_variables/shell_variable_store'
+require_relative 'shell_variables/shell_variable_keeper'
+require_relative 'shell_variables/globalize'
+require_relative 'shell_variables/evaluate'
+
+#* mysh/shell_variables.rb -- Adds support for mysh scripting variables.
+module Mysh
+
+  #Set up some essential entries.
+  MNV['$'.to_sym] = "$"
+
+  #Set up some default values.
+  MNV[:debug]       = "false"
+  MNV[:prompt]      = "mysh"
+  MNV[:post_prompt] = "$prompt"
+  MNV[:pre_prompt]  = "$w"
+
+  MNV[:d] = "{{ Time.now.strftime(MNV[:date_fmt]) }}"
+  MNV[:h] = "{{ ENV['HOME'].decorate }}"
+  MNV[:t] = "{{ Time.now.strftime(MNV[:time_fmt]) }}"
+  MNV[:u] = "{{ ENV['USER'] }}"
+  MNV[:w] = "{{ Dir.pwd.decorate }}"
+
+  MNV[:date_fmt] = "%Y-%m-%d"
+  MNV[:time_fmt] = "%H:%M"
+
+end

data/lib/mysh/shell_variables/evaluate.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+#Monkey patches for Mysh variables
+class String
+
+  #Extract common mysh data from this string.
+  def extract_mysh_types
+    if self =~ /false|no|off/i
+      false
+    else
+      self
+    end
+  end
+
+  #Evaluate any variable substitutions in the input.
+  def eval_variables
+    self.gsub(/(\$\$)|(\$[a-z][a-z0-9_]*)/) do |str|
+      sym = str[1..-1].to_sym
+      MNV.key?(sym) ? MNV[sym].to_s : str
+    end
+  end
+
+end

data/lib/mysh/shell_variables/globalize.rb

@@ -0,0 +1,9 @@
+# coding: utf-8
+
+#Monkey patches for Mysh variables
+class Object
+
+  #Make the environment variable store accessible everywhere.
+  MNV = Mysh::MNV
+
+end

data/lib/mysh/shell_variables/shell_variable_keeper.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+#* mysh/shell_variables/shell_variable_keeper.rb -- The keeper of mysh values.
+module Mysh
+
+  #The keeper of mysh variable values.
+  class Keeper
+
+    #Set up this variable
+    def initialize(value="")
+      @value = value
+    end
+
+    #Get the value of this variable.
+    def get_value(loop_check={})
+      my_id = self.object_id
+      fail "Mysh variable looping error." if loop_check[my_id]
+      loop_check[my_id] = self
+
+      @value.preprocess
+    end
+
+    #Get the source code of this variable.
+    def get_source
+      @value
+    end
+
+    #Set the value of this variable.
+    def set_value(value)
+      @value = value
+    end
+
+  end
+
+end
+

data/lib/mysh/shell_variables/shell_variable_store.rb

@@ -0,0 +1,76 @@
+# coding: utf-8
+
+#* mysh/shell_variables/shell_variable_store.rb -- Storage for mysh variables.
+module Mysh
+
+  #The holder of mysh variables.
+  module MNV
+    #Set up the storage hash.
+    @store = Hash.new { |_hash, _key| Keeper.new }
+
+    #The shared loop checker for programmatic access.
+    @loop_check = nil
+
+    #Get the value of a variable.
+    #<br>Endemic Code Smells
+    #* :reek:TooManyStatements
+    def self.[](index)
+      keeper = get_keeper(index)
+
+      if @loop_check
+        keeper.get_value(@loop_check)
+      else
+        begin
+          keeper.get_value(@loop_check = {})
+        ensure
+          @loop_check = nil
+        end
+      end.extract_mysh_types
+    end
+
+    #Set the value of a variable.
+    def self.[]=(index, value)
+      unless value.empty?
+        keeper = get_keeper(index)
+        keeper.set_value(value)
+        set_keeper(index, keeper)
+      else
+        delete_keeper(index)
+      end
+
+      value
+    end
+
+    #Get the value keeper of a variable.
+    def self.get_keeper(index)
+      @store[index]
+    end
+
+    #Set the value keeper of a variable.
+    def self.set_keeper(index, keeper)
+      @store[index] = keeper
+    end
+
+    #Delete the value keeper of a variable.
+    def self.delete_keeper(index)
+      @store.delete(index)
+    end
+
+    #Get the source code of a variable.
+    def self.get_source(index)
+      @store[index].get_source
+    end
+
+    #Does this entry exist?
+    def self.key?(index)
+      @store.key?(index)
+    end
+
+    #Get all the keys
+    def self.keys
+      @store.keys
+    end
+
+  end
+
+end

data/lib/mysh/user_input.rb

@@ -4,7 +4,6 @@ require 'mini_readline'
 
 require_relative 'user_input/smart_source'
 require_relative 'user_input/parse'
-require_relative 'user_input/handlebars'
 
 #* mysh/user_input.rb -- Get some text from the user.
 module Mysh
@@ -15,10 +14,14 @@ module Mysh
   end
 
   #Get one command from the user.
-  def self.get_command(root="")
-    initial_input = @input.readline(prompt: root + '>')
+  #<br>Endemic Code Smells
+  #* :reek:TooManyStatements
+  def self.get_command
+    puts MNV[:pre_prompt] if MNV.key?(:pre_prompt)
+
+    initial_input = @input.readline(prompt: MNV[:prompt] + '>')
     @input.instance_options[:initial] = ""
-    get_command_extra(initial_input, root)
+    get_command_extra(initial_input)
 
   rescue MiniReadlineEOI
     @mysh_running = false
@@ -28,10 +31,10 @@ module Mysh
   private
 
   #Get any continuations of the inputs
-  def self.get_command_extra(str, root)
+  def self.get_command_extra(str)
     if /\\\s*$/ =~ str
-      parms = {prompt: root + '\\', prefix: str[0] }
-      get_command_extra($PREMATCH + "\n" + @input.readline(parms), root)
+      parms = {prompt: MNV[:post_prompt] + '\\', prefix: str[0] }
+      get_command_extra($PREMATCH + "\n" + @input.readline(parms))
     else
       str
     end

data/lib/mysh/version.rb

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

data/mysh.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest_visible', ">= 0.1.2"
   spec.add_development_dependency 'rdoc',             "~> 4.0.1"
 
-  spec.add_runtime_dependency     'mini_readline',    ">= 0.6.11"
+  spec.add_runtime_dependency     'mini_readline',    ">= 0.7.2"
   spec.add_runtime_dependency     'vls',              ">= 0.4.1"
   spec.add_runtime_dependency     'in_array',         ">= 0.1.7"
 end

data/samples/show.txt

@@ -1,4 +1,4 @@
-This is a sample show file.
+This is a sample show file. $d $t
 
 {{ a = 5 #}}a = {{ a.to_s }}
 Args = {{ args.inspect }}

data/tests/my_shell_tests.rb

@@ -24,6 +24,8 @@ class MyShellTester < Minitest::Test
     assert_equal(Module, Mysh.class)
     assert_equal(Class,  Mysh::Action.class)
     assert_equal(Class,  Mysh::ActionPool.class)
+    assert_equal(Module, Mysh::MNV.class)
+    assert_equal(Class,  Mysh::Keeper.class)
 
     assert_equal(Mysh::ActionPool, Mysh::COMMANDS.class)
     assert_equal(Mysh::ActionPool, Mysh::HELP.class)
@@ -46,14 +48,16 @@ class MyShellTester < Minitest::Test
   end
 
   def test_handlebars
+    Mysh.reset_host
+
     assert_equal("ABC 123 DEF",
-                 eval_handlebars("ABC {{ (1..3).to_a.join }} DEF"))
+                 "ABC {{ (1..3).to_a.join }} DEF".eval_handlebars)
 
-    assert_equal("ABC", eval_handlebars("{{ 'ABC'  }}"))
-    assert_equal("",    eval_handlebars("{{ 'ABC' #}}"))
+    assert_equal("ABC", "{{ 'ABC'  }}".eval_handlebars)
+    assert_equal("",    "{{ 'ABC' #}}".eval_handlebars)
 
-    assert_equal("{{ 'ABC' }}", eval_handlebars("\\{\\{ 'ABC' \\}\\}"))
-    assert_equal("{{A}}", eval_handlebars("{{ '{'+'{A}'+'}' }}"))
+    assert_equal("{{ 'ABC' }}", "\\{\\{ 'ABC' \\}\\}".eval_quoted_braces)
+    assert_equal("{{A}}", "{{ '{'+'{A}'+'}' }}".eval_handlebars.eval_quoted_braces)
   end
 
   def test_command_parsing
@@ -122,4 +126,73 @@ class MyShellTester < Minitest::Test
 
   end
 
+  def test_mysh_variables
+    Mysh.reset_host
+
+    assert_equal("", MNV[:test])
+    assert_equal("", MNV.get_source(:test))
+    refute(MNV.key?(:test), "MNV[:test] should not exist.")
+
+    MNV[:test] = "test 1 2 3"
+    assert_equal("test 1 2 3", MNV[:test])
+    assert_equal("test 1 2 3", MNV.get_source(:test))
+    assert(MNV.key?(:test), "MNV[:test] should exist.")
+
+    MNV[:test] = ""
+    assert_equal("", MNV[:test])
+    assert_equal("", MNV.get_source(:test))
+    refute(MNV.key?(:test), "MNV[:test] should not exist.")
+
+    Mysh.try_execute_command("$test = new value")
+    assert_equal("new value", MNV[:test])
+    assert_equal("new value", MNV.get_source(:test))
+    assert(MNV.key?(:test), "MNV[:test] should exist.")
+
+    Mysh.try_execute_command("$test =")
+    assert_equal("", MNV[:test])
+    assert_equal("", MNV.get_source(:test))
+    refute(MNV.key?(:test), "MNV[:test] should not exist.")
+
+    Mysh.try_execute_command("$test = true")
+    assert(MNV[:test])
+    assert_equal("true", MNV.get_source(:test))
+    assert(MNV.key?(:test), "MNV[:test] should exist.")
+
+    Mysh.try_execute_command("$test = off")
+    assert_equal(false, MNV[:test])
+    assert_equal("off", MNV.get_source(:test))
+    assert(MNV.key?(:test), "MNV[:test] should exist.")
+
+    Mysh.try_execute_command("$a = foo")
+    Mysh.try_execute_command("$b = bar")
+    Mysh.try_execute_command("$test = $a$b")
+    assert_equal("foobar", MNV[:test])
+    assert_equal("$a$b", MNV.get_source(:test))
+
+    Mysh.try_execute_command("$test = $$foo")
+    assert_equal("$foo", MNV[:test])
+    assert_equal("$$foo", MNV.get_source(:test))
+
+    Mysh.try_execute_command("$bad = $bad")
+    assert_raises { MNV[:bad] }
+
+    MNV[:test] = "{{(1..9).to_a.join}}"
+    assert_equal("123456789", MNV[:test])
+    assert_equal("{{(1..9).to_a.join}}", MNV.get_source(:test))
+
+    Mysh.try_execute_command("$test = $whats_all_this")
+    assert_equal("$whats_all_this", MNV[:test])
+    assert_equal("$whats_all_this", MNV.get_source(:test))
+
+    Mysh.try_execute_command("$bad = {{ MNV[:bad] }}")
+    assert_raises { MNV[:bad] }
+    assert_raises { MNV[:bad] } #Yes test this twice!
+    assert_raises { Mysh.try_execute_command("=$bad") }
+    assert_raises { Mysh.try_execute_command("=$bad") } #And this too!
+
+    Mysh.try_execute_command("$bad = OK")
+    assert_equal("OK", MNV[:bad])
+    assert_equal("OK", MNV[:bad]) #And this too!
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysh
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-11 00:00:00.000000000 Z
+date: 2016-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.11
+        version: 0.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.11
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: vls
   requirement: !ruby/object:Gem::Requirement
@@ -154,6 +154,8 @@ files:
 - lib/mysh/expression.rb
 - lib/mysh/expression/lineage.rb
 - lib/mysh/external_ruby.rb
+- lib/mysh/handlebars.rb
+- lib/mysh/handlebars/string.rb
 - lib/mysh/internal.rb
 - lib/mysh/internal/action.rb
 - lib/mysh/internal/action_pool.rb
@@ -175,12 +177,14 @@ files:
 - lib/mysh/internal/actions/help/ruby.txt
 - lib/mysh/internal/actions/help/show.txt
 - lib/mysh/internal/actions/help/sub_help.rb
+- lib/mysh/internal/actions/help/vars.txt
 - lib/mysh/internal/actions/history.rb
 - lib/mysh/internal/actions/pwd.rb
 - lib/mysh/internal/actions/show.rb
 - lib/mysh/internal/actions/show/env.rb
 - lib/mysh/internal/actions/show/ruby.rb
 - lib/mysh/internal/actions/type.rb
+- lib/mysh/internal/actions/vars.rb
 - lib/mysh/internal/actions/vls.rb
 - lib/mysh/internal/decorate.rb
 - lib/mysh/internal/format.rb
@@ -191,9 +195,14 @@ files:
 - lib/mysh/internal/format/object.rb
 - lib/mysh/internal/format/string.rb
 - lib/mysh/internal/manage.rb
+- lib/mysh/pre_processor.rb
 - lib/mysh/quick.rb
+- lib/mysh/shell_variables.rb
+- lib/mysh/shell_variables/evaluate.rb
+- lib/mysh/shell_variables/globalize.rb
+- lib/mysh/shell_variables/shell_variable_keeper.rb
+- lib/mysh/shell_variables/shell_variable_store.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