mysh 0.6.12 → 0.6.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1181f7c07f14be213795e5af840e9364e838ada9
-  data.tar.gz: 0005e8503ddd7a6905d834c85e01519f920ca65f
+  metadata.gz: 000475c46e41bf8fdeec692ac1dc789474800de0
+  data.tar.gz: '08c5c40b4a6b0c37a36735148f663a3cb56b3025'
 SHA512:
-  metadata.gz: 536851ba0c923a4e2491d5abd50c417f8f3c6992cc61c885920d1c4654219c95efd40fbfcaf3a1574e94687a602248914b40a13a4a938f55993911d9903b3006
-  data.tar.gz: 5ccbc4d1709a355aa9d3a8b065aacee3dbe9c6620bcfb26f70fd27b8fedd89cffdeb03d88314dd747a7d0b3d64977c7f6f303673791e26127ce81569b511f852
+  metadata.gz: 46bdcf6f4550ced7212ec3a3cc03293809dc3d423089e0b7b507e1417fd2ac6b13bfb431466d93b276299cf5802d0fff3194a2b529305e57ec958443bf17886b
+  data.tar.gz: 4fb03e994a8b1ce10a6347b0938e296a011ff40406a9479775e54ba514cc421d62a1f39345812d2a9df428cc46ed5340f3dd97fcf7e9c29a3f049b8b0bc9d68e

data/README.md

@@ -423,6 +423,7 @@ $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:"
@@ -435,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.
 
@@ -558,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.
@@ -714,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.
@@ -981,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

@@ -5,26 +5,34 @@
 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/string_helpers'
 require_relative 'mysh/input_wrapper'
 require_relative 'mysh/user_input'
+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.

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/{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))

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

@@ -1,24 +1,24 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line/load.rb -- The mysh load command.
+# The mysh load command.
 module Mysh
 
-  #* mysh/internal/actions/command_line/load.rb -- The mysh load command.
+  # The mysh load command.
   class LoadOption < CommandOption
 
-    #Skip over the argument for pre_boot.
+    # Skip over the argument for pre_boot.
     def pre_boot(read_point)
       get_arg(read_point)
     end
 
-    #Execute the load command line option.
+    # Execute the load command line option.
     def post_boot(read_point)
       mysh "load #{get_arg(read_point).to_host_spec}"
     end
 
   end
 
-  #Add the load command line option to the library.
+  # Add the load command line option to the library.
   desc = 'Load the specified file into the mysh.'
   COMMAND_LINE.add_action(LoadOption.new('--load filename', desc))
   COMMAND_LINE.add_action(LoadOption.new('-l filename', desc))

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

@@ -5,9 +5,8 @@ module Mysh
   # The page pause option.
   class PauseOption < 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[:page_pause] = "on"
     end
@@ -18,16 +17,15 @@ module Mysh
 
   end
 
-  #Add the pause command line option to the library.
+  # Add the pause command line option to the library.
   desc = 'Turn on page pauses.'
   COMMAND_LINE.add_action(PauseOption.new('--pause', desc))
 
   # The no page pause option.
   class NoPauseOption < 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[:page_pause] = "off"
     end
@@ -38,7 +36,7 @@ module Mysh
 
   end
 
-  #Add the no pause command line option to the library.
+  # Add the no pause command line option to the library.
   desc = 'Turn off page pauses.'
   COMMAND_LINE.add_action(NoPauseOption.new('--no-pause', desc))
 end

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

@@ -1,43 +1,41 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line/prompt.rb -- The mysh post prompt command.
+# The mysh post prompt command.
 module Mysh
 
-  #* mysh/internal/actions/command_line/post_prompt.rb -- The mysh post prompt command.
+  # The mysh post prompt command.
   class PostpromptOption < CommandOption
 
-    #Skip over the argument for pre_boot.
+    # Skip over the argument for pre_boot.
     def pre_boot(read_point)
       get_arg(read_point)
     end
 
-    #Execute the prompt command line option.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute the prompt command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
     def post_boot(read_point)
       MNV[:post_prompt] = get_arg(read_point)
     end
 
   end
 
-  #Add the post prompt command line option to the library.
+  # Add the post prompt command line option to the library.
   desc = 'Set the mysh line continuation prompt to "str".'
   COMMAND_LINE.add_action(PostpromptOption.new('--post-prompt "str"', desc))
   COMMAND_LINE.add_action(PostpromptOption.new('-pp "str"', desc))
 
-  #* mysh/internal/actions/command_line/post_prompt.rb -- The mysh command no post prompt.
+  # The mysh command no post prompt.
   class NoPostpromptOption < CommandOption
 
-    #Execute the no post prompt command line option.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute the no post prompt command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
     def post_boot(_args)
       MNV[:post_prompt] = ""
     end
 
   end
 
-  #Add the prompt command line option to the library.
+  # Add the prompt command line option to the library.
   desc = 'Turn off mysh post prompting.'
   COMMAND_LINE.add_action(NoPostpromptOption.new('--no-post-prompt', desc))
   COMMAND_LINE.add_action(NoPostpromptOption.new('-npp', desc))