mysh 0.6.9 → 0.6.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc2ce1a31750c110022b543778cb28e70b4f2456
-  data.tar.gz: e5f15032fa38956e7f06be1f8cc92ce5de7feba9
+  metadata.gz: 934758602fb71789f5fa61aef2d82bcb1643fd96
+  data.tar.gz: cd18110024b6cf77c004da3cd5374228e096cd27
 SHA512:
-  metadata.gz: 4484f3c07c6ac22a7ccba4b29dd87116926f0731d4b9c54bd54ecefcefcea8676c8fe111d7f7c98be1331ed7ea17798af7d3566ef064d94d879fae89619001fa
-  data.tar.gz: 7c4a82903c595abd907bd02285051bbb0805481fa54b65f3993359fea6c24376d6f58646f3400ddc9aab36c636fde249d9265c94960339c365954bdad01f9f42
+  metadata.gz: 9c9cca6285afcad01d54fcf85576596942673ea0f579df1edf1506580f4dfb4fdba16ed9f87bc252d14e38dfb630e396ea85dac19ee2278951ae663c8c9200c2
+  data.tar.gz: 21aa9ed6bc0b02981a0e982423ffd6d0235865479b2c015837083696e892c83846434a1e202b8cbf3330cb70782c3bec0d5b8c6b7974d0b8b58738d47b268eb7

data/README.md

@@ -26,7 +26,7 @@ See the original article at:
 (http://www.blackbytes.info/2016/07/writing-a-shell-in-ruby/)
 
 Oh, and one other little thing. A survey of the mysh reveals that it currently
-contains 2291 lines of code. It seems that there has been some growth beyond
+contains 2188 lines of code. It seems that there has been some growth beyond
 the 25 lines in the original article.
 
 ## Installation
@@ -125,8 +125,12 @@ Where the available options are:
 Option               | Short Form(s)| Description             | Default
 ---------------------|--------------|-------------------------|-----------
 --debug              | -d           | Turn on mysh debugging. | false
+--do-move            |              | Turn on mysh command history shifting.
+--no-move            |              | Turn off mysh command history shifting. | true
 --no-debug           | -nd          | Turn off mysh debugging.
 --help               | -? -h        | Display mysh usage info and exit.
+--history            |              | Turn on mysh command history. | true
+--no-history         |              | Turn off mysh command history.
 --init filename      | -i filename  | Initialize mysh by loading the specified file. | ~/mysh_init.mysh
 --no-init            | -ni          | Do not load a file to initialize mysh.
 --load filename      | -l filename  | Load the specified file into the mysh.
@@ -417,7 +421,10 @@ $d          | The current date.
 $date_fmt   | The format for the date: "%Y-%m-%d"
 $debug      | Does the shell display additional debugging info (true/false)
 $h          | The home folder's path
+$history    | Is command line history enabled?
 $name       | The name given to this mysh session.
+$no_dups    | Suppress duplicate entries in the history buffer.
+$no_move    | Entries are not moved up when pulled from the command history.
 $page_height| The page height.
 $page_msg   | The paging message. Default is "Press a key, a space, or q:"
 $page_pause | Is page pausing enabled?
@@ -429,6 +436,7 @@ $r          | The location of the Ruby compiler.
 $s          | The location of the host command interpreter.
 $t          | The current time.
 $time_fmt   | The format for the time: "%H:%M"
+$type       | Does the type command operate in cooked or raw mode. Default is raw mode.
 $u          | The current user.
 $w          | The current working directory's path.
 
@@ -552,18 +560,19 @@ none       | General help on mysh.
 @          | Help on the show command.
 env        | Help on the show env command.
 gem        | Help on the show gem command.
-gls        | Help on gls internal mysh command.
+gls        | Help on the gls command.
 help       | This help on the help command.
 history    | Help on the history command.
 init       | Help on mysh initialization.
 kbd        | Help on mysh keyboard mapping.
 math       | Help on math functions.
-mls        | Help on mls internal mysh command.
+mls        | Help on the mls command.
 quick      | Help on quick commands.
 ruby       | Help on the show ruby command.
 set        | Help on mysh variables.
 show       | Help on the show command.
 term       | Help on the show term command.
+type       | Help on the type command.
 types      | Help on mysh file types.
 usage      | Help on mysh usage options.
 {{         | Help on mysh handlebars.
@@ -708,7 +717,7 @@ pwd              | Display the current working directory.
 say <stuff>      | Display the text in the command arguments.
 set <$name>=value| Set/query mysh variables.
 show <item>      | Display information about a part of mysh.
-type <file>      | Display a text file with support for optional embedded handlebars and mysh variables.
+type <file>      | Display one or more text files with optional support for embedded handlebars and shell variables.
 
 Notes:
 1. The notation {x} means that x is optional.
@@ -907,7 +916,7 @@ on the optional parms.
 ###### "string".preprocess(context=mysh_default_context)
 Process the string for embedded variables and handlebars. By default,
 any embedded ruby  is evaluated in the mysh global expression binding. However,
-another BindingWrapper instance may be passed to access an alternative binding.
+another binding may be passed to access an alternative execution environment.
 
 ###### "string".to_host_spec
 Given a string with a file spec, to_host_spec adjusts that string so that it is
@@ -975,3 +984,14 @@ calling attention to some aspect that could use some TLC or a suggestion or an
 idea or a comment.
 
 This is a low pressure environment. All are welcome!
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](./LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the fully_freeze project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](./CODE_OF_CONDUCT.md).

data/lib/mysh.rb

@@ -1,34 +1,41 @@
 # coding: utf-8
 
-# mysh -- MY SHell -- a Ruby/Rails inspired command line shell.
+# mysh -- MY SHell -- a Ruby inspired command line shell.
 
+require 'pp'
 require 'English'
 require 'in_array'
+require 'insouciant'
 require 'pause_output'
 require 'format_output'
+require 'mini_readline'
+
+# The path to the gem lib folder.
+MYSH_LIB = (File.expand_path(File.dirname(__FILE__)) + "/").freeze
 
 require_relative 'mysh/exceptions'
-require_relative 'mysh/binding_wrapper'
+require_relative 'mysh/string_helpers'
 require_relative 'mysh/input_wrapper'
 require_relative 'mysh/user_input'
-require_relative 'mysh/expression'
+require_relative 'mysh/action'
+require_relative 'mysh/action_pool'
 require_relative 'mysh/internal'
 require_relative 'mysh/quick'
 require_relative 'mysh/external'
+require_relative 'mysh/command_line'
 require_relative 'mysh/system'
 require_relative 'mysh/handlebars'
 require_relative 'mysh/shell_variables'
-require_relative 'mysh/pre_processor'
 require_relative 'mysh/process'
 require_relative 'mysh/globalize'
-require_relative 'mysh/init'
-
+require_relative 'mysh/load_init_file'
+require_relative 'mysh/expression'
 require_relative 'mysh/version'
 
-#The Mysh (MY SHell) module. A container for mysh and its functionality.
+# The Mysh (MY SHell) module.
 module Mysh
 
-  #The actual shell method.
+  # The actual shell method.
   def self.run(args=[])
     process_command_args(args, :pre_boot)
     mysh_load_init
@@ -41,5 +48,8 @@ module Mysh
 end
 
 if __FILE__ == $0
-  Mysh.run(ARGV)  #Run a shell if this file is run directly.
+  Mysh.run(ARGV)  # Run a shell if this file is run directly.
 end
+
+# Suppress an annoying warning during tests.
+$VERBOSE = nil if defined?(Rake)

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

@@ -1,35 +1,35 @@
 # coding: utf-8
 
-#* mysh/internal/action.rb -- The framework of mysh internal actions.
+# The framework of mysh internal actions.
 module Mysh
 
-  #The mysh internal action class.
+  # The mysh internal action class.
   class Action
-    #The name of the action.
+    # The name of the action.
     attr_reader :name
 
-    #The description of the action.
+    # The description of the action.
     attr_reader :description
 
-    #Setup an internal action.
+    # Setup an internal action.
     def initialize(name = "", description = "", &action)
       @name, @description = name, description.in_array
 
       define_singleton_method(:process_command, &action) if block_given?
     end
 
-    #Parse the string and call the action.
+    # Parse the string and call the action.
     def process_quick_command(input)
       process_command(input.quick)
       :internal
     end
 
-    #Get information about the action.
+    # Get information about the action.
     def action_info
       [@name].concat(@description)
     end
 
-    #Get the name without any argument descriptions.
+    # Get the name without any argument descriptions.
     def short_name
       name.split[0] || ""
     end

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

@@ -1,31 +1,31 @@
 # coding: utf-8
 
-#* mysh/internal/action_pool.rb -- A managed hash of mysh actions.
+# A managed hash of mysh actions.
 module Mysh
 
-  #* A managed hash of mysh actions.
+  # A managed hash of mysh actions.
   class ActionPool
 
-    #The name of this action pool.
+    # The name of this action pool.
     attr_reader :pool_name
 
-    #Create a new action pool
+    # Create a new action pool
     def initialize(pool_name, default_action = nil)
       @pool_name, @pool = pool_name, {}
       @pool.default = default_action
     end
 
-    #Get a action.
+    # Get a action.
     def [](index)
       @pool[index]
     end
 
-    #Does this action exist?
+    # Does this action exist?
     def exists?(index)
       @pool.key?(index)
     end
 
-    #Add an action to the pool.
+    # Add an action to the pool.
     def add_action(action)
       short_name = action.short_name
 
@@ -36,7 +36,7 @@ module Mysh
       @pool[short_name] = action
     end
 
-    #Get information on all actions.
+    # Get information on all actions.
     def actions_info
       @pool
         .values

data/lib/mysh/{internal/actions/command_line.rb → command_line.rb}

@@ -1,23 +1,23 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line.rb -- The mysh internal command line option.
+# The command line options of mysh.
 module Mysh
 
   # Action pool of command line options.
   COMMAND_LINE = ActionPool.new("COMMAND_LINE")
 
-  #* mysh/internal/actions/command_line.rb -- The mysh internal command line option.
+  # A mysh command line option.
   class CommandOption < Action
 
-    #Execute a pre-boot command line option.
+    # Execute a pre-boot command line option.
     def pre_boot(_args); end
 
-    #Execute a post-boot command line option.
+    # Execute a post-boot command line option.
     def post_boot(_args); end
 
     alias :process_command :pre_boot
 
-    #Get an argument for an option.
+    # Get an argument for an option.
     def get_arg(read_point)
       result = read_point.next
       fail if COMMAND_LINE.exists?(result) #An arg should not be a command!
@@ -28,9 +28,8 @@ module Mysh
 
   end
 
-  #Execute command line options.
-  #<br>Endemic Code Smells
-  #* :reek:TooManyStatements
+  # Execute command line options.
+  # Endemic Code Smells   :reek:TooManyStatements
   def self.process_command_args(args, phase)
     read_point = args.each
 
@@ -56,5 +55,6 @@ module Mysh
 
 end
 
-#Load up the extra help actions!
-Dir[Mysh::Action::ACTIONS_PATH + 'command_line/*.rb'].each {|file| require file }
+# Load up the extra help actions!
+path = MYSH_LIB + "mysh/command_line/*.rb"
+Dir[path].each {|file| require file }

data/lib/mysh/{internal/actions/command_line → command_line}/debug.rb

@@ -1,38 +1,36 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line/debug.rb -- The mysh help command debug.
+# The mysh help command debug.
 module Mysh
 
-  #* mysh/internal/actions/command_line/debug.rb -- The mysh help command debug.
+  # The mysh help command debug.
   class DebugOption < CommandOption
 
-    #Execute the help command line option.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute the help command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
     def post_boot(_args)
       MNV[:debug] = "on"
     end
 
   end
 
-  #Add the debug command line option to the library.
+  # Add the debug command line option to the library.
   desc = 'Turn on mysh debugging.'
   COMMAND_LINE.add_action(DebugOption.new('--debug', desc))
   COMMAND_LINE.add_action(DebugOption.new('-d', desc))
 
-  #* mysh/internal/actions/command_line/debug.rb -- The mysh help command no debug.
+  # The mysh help command no debug.
   class NoDebugOption < CommandOption
 
-    #Execute the help command line option.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute the help command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
     def post_boot(_args)
       MNV[:debug] = "off"
     end
 
   end
 
-  #Add the debug command line option to the library.
+  # Add the debug command line option to the library.
   desc = 'Turn off mysh debugging.'
   COMMAND_LINE.add_action(NoDebugOption.new('--no-debug', desc))
   COMMAND_LINE.add_action(NoDebugOption.new('-nd', desc))

data/lib/mysh/command_line/history.rb

@@ -0,0 +1,61 @@
+# coding: utf-8
+
+# The mysh command line options for history and no_move.
+module Mysh
+
+  # The mysh command line options for history.
+  class HistoryOption < CommandOption
+    # Execute the history command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
+    def post_boot(_args)
+      MNV[:history] = "on"
+    end
+  end
+
+  # Add the command line option to the library.
+  desc = 'Turn on mysh command history.'
+  COMMAND_LINE.add_action(HistoryOption.new('--history', desc))
+
+
+  # The mysh command line options for no history.
+  class NoHistoryOption < CommandOption
+    # Execute the no history command line option.
+    # Endemic Code Smells  :reek:UtilityFunction
+    def post_boot(_args)
+      MNV[:history] = "off"
+    end
+  end
+
+  # Add the no history command line options to the library.
+  desc = 'Turn off mysh command history.'
+  COMMAND_LINE.add_action(NoHistoryOption.new('--no-history', desc))
+
+
+  # The mysh command line no move option for history.
+  class NoMoveHistoryOption < CommandOption
+    # Execute the no move command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
+    def post_boot(_args)
+      MNV[:no_move] = "on"
+    end
+  end
+
+  # Add the command line no move option to the library.
+  desc = 'Turn off mysh command history shifting.'
+  COMMAND_LINE.add_action(NoMoveHistoryOption.new('--no-move', desc))
+
+
+  # The mysh command line do move option for history.
+  class DoMoveHistoryOption < CommandOption
+    # Execute the do move command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
+    def post_boot(_args)
+      MNV[:no_move] = "off"
+    end
+  end
+
+  # Add the command line do move option to the library.
+  desc = 'Turn on mysh command history shifting.'
+  COMMAND_LINE.add_action(DoMoveHistoryOption.new('--do-move', desc))
+
+end

data/lib/mysh/{internal/actions/command_line → command_line}/init.rb

@@ -1,12 +1,12 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line/init.rb -- The mysh init and no-init commands.
+# The mysh init and no-init commands.
 module Mysh
 
-  #* mysh/internal/actions/command_line/init.rb -- The mysh init command.
+  # The mysh init command.
   class InitOption < CommandOption
 
-    #Skip over the argument for pre_boot.
+    # Skip over the argument for pre_boot.
     def pre_boot(read_point)
       file_name = get_arg(read_point).to_host_spec
 
@@ -19,23 +19,23 @@ module Mysh
       mysh "load #{file_name}"
     end
 
-    #Execute the init command line option.
+    # Execute the init command line option.
     def post_boot(read_point)
       get_arg(read_point)
     end
 
   end
 
-  #Add the init command line option to the library.
+  # Add the init command line option to the library.
   desc = 'Initialize mysh by loading the specified file.'
   COMMAND_LINE.add_action(InitOption.new('--init filename', desc))
   COMMAND_LINE.add_action(InitOption.new('-i filename', desc))
 
 
-  #* mysh/internal/actions/command_line/init.rb -- The mysh no init command.
+  # The mysh no init command.
   class NoInitOption < CommandOption
 
-    #Skip over the argument for pre_boot.
+    # Skip over the argument for pre_boot.
     def pre_boot(_args)
       fail "The mysh is already initialized." if $mysh_init_file
       $mysh_init_file = "<none>"
@@ -43,7 +43,7 @@ module Mysh
 
   end
 
-  #Add the no init command line option to the library.
+  # Add the no init command line option to the library.
   desc = 'Do not load a file to initialize mysh.'
   COMMAND_LINE.add_action(NoInitOption.new('--no-init', desc))
   COMMAND_LINE.add_action(NoInitOption.new('-ni', desc))