mysh 0.6.13 → 0.6.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da3781a854769fe73c280fd78399ddb6d26cdd64
-  data.tar.gz: 8e70d3df6a194b26e639deefdff63f9cc871fe1a
+  metadata.gz: fe9b45ccfc710b2113e95390238826cae35710df
+  data.tar.gz: 14d43ffdab4f053ee59e20b09a635b35ffb5864b
 SHA512:
-  metadata.gz: '099048a82d4c3f4e4f1f6951ec5d3bc90ad8229f22158308b2bcf1fc6a90d0f365c42a31c5fe9fa1f9c32ad609fb9c12d3a9a8d3d594128f10fbb7615902addd'
-  data.tar.gz: bdda1b66bfa676b915be21f8a6c4b1cf20212ec8ad0e4209ac1119a2e02a5b39c6539dc2f1b8c90342a707d24be5303fc34dbea17d31e8cde7567bea8012c321
+  metadata.gz: 28b1ea21b39bf38530eb7a0ca8950e2b047064402f03eb23243a1e69bc1b9321f682ba9bb705d9a3096e8cebc493a819cfcf8973539c730ee9f9c86cfbf746be
+  data.tar.gz: a8f42fe904833ed0069ffdd20cc64e16b34877fde38eec1924b2d55ad049b99343e9e508d37a4297398589f664f141877c0e10152128483487ad024a65691f95

data/README.md

@@ -984,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,6 +5,7 @@
 require 'pp'
 require 'English'
 require 'in_array'
+require 'insouciant'
 require 'pause_output'
 require 'format_output'
 require 'mini_readline'

data/lib/mysh/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/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/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/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/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))

data/lib/mysh/command_line/pre_prompt.rb

@@ -1,43 +1,41 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line/prompt.rb -- The mysh pre_prompt command.
+# The mysh pre_prompt command.
 module Mysh
 
-  #* mysh/internal/actions/command_line/pre_prompt.rb -- The mysh pre_prompt command.
+  # The mysh pre_prompt command.
   class PrepromptOption < 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[:pre_prompt] = get_arg(read_point)
     end
 
   end
 
-  #Add the pre prompt command line option to the library.
+  # Add the pre prompt command line option to the library.
   desc = 'Set the mysh pre prompt to "str".'
   COMMAND_LINE.add_action(PrepromptOption.new('--pre-prompt "str"', desc))
   COMMAND_LINE.add_action(PrepromptOption.new('-pr "str"', desc))
 
-  #* mysh/internal/actions/command_line/pre_prompt.rb -- The mysh command no pre_prompt.
+  # The mysh command no pre_prompt.
   class NoPrepromptOption < CommandOption
 
-    #Execute the no pre_prompt command line option.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute the no pre_prompt command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
     def post_boot(_args)
       MNV[:pre_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 pre prompting.'
   COMMAND_LINE.add_action(NoPrepromptOption.new('--no-pre-prompt', desc))
   COMMAND_LINE.add_action(NoPrepromptOption.new('-npr', desc))

data/lib/mysh/command_line/prompt.rb

@@ -1,41 +1,40 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line/prompt.rb -- The mysh prompt command.
+# The mysh prompt command.
 module Mysh
 
-  #* mysh/internal/actions/command_line/prompt.rb -- The mysh prompt command.
+  # The mysh prompt command.
   class PromptOption < 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.
+    # Execute the prompt command line option.
     def post_boot(read_point)
       MNV[:prompt] = get_arg(read_point)
     end
 
   end
 
-  #Add the prompt command line option to the library.
+  # Add the prompt command line option to the library.
   desc = 'Set the mysh prompt to "str".'
   COMMAND_LINE.add_action(PromptOption.new('--prompt "str"', desc))
   COMMAND_LINE.add_action(PromptOption.new('-p "str"', desc))
 
-  #* mysh/internal/actions/command_line/prompt.rb -- The mysh prompt command no prompt.
+  # The mysh prompt command no prompt.
   class NoPromptOption < CommandOption
 
-    #Execute the no prompt command line option.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Execute the no prompt command line option.
+    # Endemic Code Smells   :reek:UtilityFunction
     def post_boot(_args)
       MNV[: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 prompting.'
   COMMAND_LINE.add_action(NoPromptOption.new('--no-prompt', desc))
   COMMAND_LINE.add_action(NoPromptOption.new('-np', desc))

data/lib/mysh/command_line/quit.rb

@@ -1,19 +1,19 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line/quit.rb -- The mysh quit command.
+# The mysh quit command.
 module Mysh
 
-  #* mysh/internal/actions/command_line/quit.rb -- The mysh quit command.
+  # The mysh quit command.
   class QuitOption < CommandOption
 
-    #Execute the quit command line option.
+    # Execute the quit command line option.
     def post_boot(_args)
       exit
     end
 
   end
 
-  #Add the quit command line option to the library.
+  # Add the quit command line option to the library.
   desc = "Exit a nested mysh file or command."
   COMMAND_LINE.add_action(QuitOption.new('--quit', desc))
 end

data/lib/mysh/command_line/usage.rb

@@ -1,19 +1,19 @@
 # coding: utf-8
 
-#* mysh/internal/actions/command_line/usage.rb -- The mysh help command usage.
+# The mysh help command usage.
 module Mysh
 
-  #* mysh/internal/actions/command_line/usage.rb -- The mysh help command usage.
+  # The mysh help command usage.
   class UsageOption < CommandOption
 
-    #Execute the help command line option. (Punt to error handler with no msg)
+    # Execute the help command line option. (Punt to error handler with no msg)
     def pre_boot(_args)
       raise MyshUsage
     end
 
   end
 
-  #Add the usage command line option to the library.
+  # Add the usage command line option to the library.
   desc = 'Display mysh usage info and exit.'
 
   USAGE = UsageOption.new('--help', desc)

data/lib/mysh/globalize.rb

@@ -19,13 +19,6 @@ class Object
     raise MyshExit
   end
 
-  # Run some code with no wuccas.
-  def insouciant
-    yield
-  rescue => err
-    err.to_s
-  end
-
   # Get the latest version for the named gem. Patched code.
   def latest_version_for(name, fetcher=nil)
     dependency = Gem::Dependency.new(name)

data/lib/mysh/help/vars.txt

@@ -4,7 +4,7 @@ In mysh, variables are kept that control the behavior of the shell. This simple
 command is used to set, delete, and display these variables. The basic method
 for setting a variable is:
 
-    set $name=value
+    set \$name=value
 
 Where:
 * name is a word matching the regex: /[a-z][a-z0-9_]*/. Lower case only.
@@ -14,7 +14,7 @@ To erase the value of a variable, use:         set $$name=
 To display the name/value of a variable, use:  set $$name
 To display all variable names/values use:      set
 
-As an escapement, the string $$$$ maps to a single $$.
+As an escapement, the strings $$$$ or \\$ map to a single $$.
 
 Some variables that are used in mysh are:
 
@@ -23,8 +23,8 @@ $$date_fmt    The format for the date: "%Y-%m-%d". ie: 2017-01-09
 $$debug       Does the shell display additional debugging info (true/false)
 $$h           The home folder's path
 $$name        The name given to this mysh session.
-$$post_prompt The prompt used when a line is continued with a trailing \\
-             character.
+$$post_prompt The prompt used when a line is continued with a trailing \
+             character. By default this just a single \
 $$pre_prompt  A prompt string displayed before the actual command prompt.
              Delete the pre_prompt variable to disable pre-prompting.
 $$prompt      The user prompt.

data/lib/mysh/internal/cd.rb

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* mysh/internal/actions/cd.rb -- The mysh internal cd command.
+# The mysh internal cd command.
 module Mysh
 
-  #Add the cd command to the library.
+  # Add the cd command to the library.
   desc = 'Change directory to the optional <dir> parameter ' +
          'or display the current working directory.'
 

data/lib/mysh/internal/comment.rb

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* mysh/internal/actions/comment.rb -- A mysh internal comment.
+# A mysh internal comment.
 module Mysh
 
-  #Add comments to the library.
+  # Add comments to the library.
   desc = 'A mysh comment. No action taken'
   action = lambda {|_input| :internal}
 

data/lib/mysh/internal/elapsed.rb

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* mysh/internal/actions/elapsed.rb -- The mysh internal elapsed command.
+# The mysh internal elapsed command.
 module Mysh
 
-  #Add the elapsed commands to the library.
+  # Add the elapsed commands to the library.
   desc = 'Execute a command and then display the elapsed time. See ?% for more.'
 
   action = lambda do |input|

data/lib/mysh/internal/gls.rb

@@ -1,18 +1,18 @@
 # coding: utf-8
 
-#* mysh/internal/actions/gls.rb -- The mysh gls (gem ls) command.
+# The mysh gls (gem ls) command.
 module Mysh
 
-  #* mysh/internal/actions/gls.rb -- The mysh gls (gem ls) command.
+  # The mysh gls (gem ls) command.
   class GlsCommand < Action
 
-    #Set up this command.
+    # Set up this command.
     def initialize(*args)
       super
       @report = @mask = @specs = nil
     end
 
-    #Execute the gls command.
+    # Execute the gls command.
     def process_command(input)
       process_args(input.args)
       gather_gems
@@ -57,9 +57,8 @@ module Mysh
       report.puts_format_output_bullets
     end
 
-    #Get detailed information on a gem specification.
-    #<br>Endemic Code Smells
-    #* :reek:UtilityFunction
+    # Get detailed information on a gem specification.
+    # Endemic Code Smells   :reek:UtilityFunction
     def info(spec)
       [["name",        spec.name],
        ["version",     spec.version],

data/lib/mysh/internal/history.rb

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* mysh/internal/actions/history.rb -- The mysh internal history command.
+# The mysh internal history command.
 module Mysh
 
-  #* mysh/internal/actions/history.rb -- The mysh internal history command.
+  # The mysh internal history command.
   class HistoryCommand < Action
 
     #Set up this command.
@@ -12,11 +12,11 @@ module Mysh
       @args = @history = nil
     end
 
-    #Execute the history command.
+    # Execute the history command.
     def process_command(input)
       @args, @history = input.args, Mysh.input.history
 
-      #The history command should not be part of the history.
+      # The history command should not be part of the history.
       @history.pop
 
       pull_index || clear_history || show_history
@@ -24,7 +24,7 @@ module Mysh
 
     private
 
-    #Deal with history index arguments
+    # Deal with history index arguments
     def pull_index
       index = @args[0].to_i
 
@@ -35,7 +35,7 @@ module Mysh
       end
     end
 
-    #Clear the history buffer.
+    # Clear the history buffer.
     def clear_history
       if @args[0] == 'clear'
         @history.clear
@@ -44,7 +44,7 @@ module Mysh
       end
     end
 
-    #Just show the history.
+    # Just show the history.
     def show_history
       pattern = Regexp.new(@args[0] || /./)
 
@@ -55,10 +55,11 @@ module Mysh
 
   end
 
-  #Add the history commands to the library.
+  # Add the history commands to the library.
   desc = 'Display the mysh command history. See ?! for more.'
   COMMANDS.add_action(HistoryCommand.new('history <arg>', desc))
-  #The history command action object.
+
+  # The history command action object.
   HISTORY_COMMAND = HistoryCommand.new('!<arg>', desc)
   COMMANDS.add_action(HISTORY_COMMAND)
 end

data/lib/mysh/internal/load.rb

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* mysh/internal/actions/load.rb -- The mysh load command.
+# The mysh load command.
 module Mysh
 
-  #Add the load command to the library.
+  # Add the load command to the library.
   desc = "Load ruby programs, mysh scripts, " +
          "or text files into the mysh environment."
 

data/lib/mysh/internal/mls.rb

@@ -2,10 +2,10 @@
 
 require 'vls'
 
-#* mysh/internal/actions/mls.rb -- The mysh module ls command.
+# The mysh module ls command.
 module Mysh
 
-  #Add the mls command to the library.
+  # Add the mls command to the library.
   desc = 'Display modules with version info. See ?mls for more.'
 
   action = lambda do |input|

data/lib/mysh/internal/pwd.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-#* mysh/internal/actions/pwd.rb -- The mysh internal pwd command.
+# The mysh internal pwd command.
 module Mysh
 
   desc = 'Display the current working directory.'

data/lib/mysh/internal/say.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-#* mysh/internal/actions/say.rb -- A mysh internal say command.
+# The mysh internal say command.
 module Mysh
 
   #Add says to the library.

data/lib/mysh/internal/type.rb

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* mysh/internal/actions/type.rb -- The mysh type command.
+# The mysh type command.
 module Mysh
 
-  #Add the type command to the library.
+  # Add the type command to the library.
   desc = 'Display one or more text files with optional support for ' +
          'embedded handlebars and shell variables. See ?type for more.'
 

data/lib/mysh/internal/vars.rb

@@ -1,24 +1,24 @@
 # coding: utf-8
 
-#* mysh/internal/actions/vars.rb -- The mysh internal variables commands.
+# The mysh internal variables commands.
 module Mysh
 
-  #* mysh/internal/actions/vars.rb -- The mysh internal variable commands.
+  # The mysh internal variable commands.
   class VarsCommand < Action
 
-    #The mysh variable parsing regex.
+    # The mysh variable parsing regex.
     VAR_EXP = %r{(?<name>   [a-z][a-z0-9_]*){0}
                  (?<equals> =){0}
                  (?<value>  \S.*){0}
                  \$ (\g<name> \s* (\g<equals> \s* \g<value>?)?)?}x
 
-    #Setup an internal action.
+    # Setup an internal action.
     def initialize(name, description)
       @var_name = @equals = @value = nil
       super(name, description)
     end
 
-    #Execute a command against the internal mysh variables.
+    # Execute a command against the internal mysh variables.
     def process_command(input)
       if (match = VAR_EXP.match(input.raw_body))
         @var_name, @equals, @value = match[:name], match[:equals], match[:value]
@@ -30,7 +30,7 @@ module Mysh
       :internal
     end
 
-    #Do the actual work here.
+    # Do the actual work here.
     def do_command
       sym = @var_name.to_sym if @var_name
 
@@ -45,7 +45,7 @@ module Mysh
       end
     end
 
-    #Display all variables neatly.
+    # Display all variables neatly.
     def show_all_values
       puts (MNV.keys - ['$'.to_sym])
              .sort
@@ -55,7 +55,7 @@ module Mysh
 
   end
 
-  #The show command action object.
+  # The set command action object.
   desc = 'Set/query mysh variables. See ?set for more.'
   COMMANDS.add_action(VarsCommand.new('set <$name>=value', desc))
 end

data/lib/mysh/shell_variables.rb

@@ -19,7 +19,6 @@ module Mysh
   MNV[:page_width]  = "{{ MiniTerm.width }}"
   MNV[:page_height] = "{{ MiniTerm.height }}"
   MNV[:page_pause]  = "on"
-  MNV[:page_msg]    = "Press a key, a space, or q:"
 
   MNV[:history]     = "on"
   MNV[:no_dups]     = "on"

data/lib/mysh/shell_variables/shell_variable_keeper.rb

@@ -1,17 +1,17 @@
 # coding: utf-8
 
-#* mysh/shell_variables/shell_variable_keeper.rb -- The keeper of mysh values.
+# The keeper of mysh values.
 module Mysh
 
-  #The keeper of mysh variable values.
+  # The keeper of mysh variable values.
   class Keeper
 
-    #Set up this variable
+    # Set up this variable
     def initialize(value="")
       @value = value
     end
 
-    #Get the value of this variable.
+    # 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]
@@ -21,12 +21,12 @@ module Mysh
       loop_check.delete(my_id)
     end
 
-    #Get the source code of this variable.
+    # Get the source code of this variable.
     def get_source
       @value
     end
 
-    #Set the value of this variable.
+    # Set the value of this variable.
     def set_value(value)
       @value = value
     end
@@ -34,4 +34,3 @@ module Mysh
   end
 
 end
-

data/lib/mysh/shell_variables/shell_variable_store.rb

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

data/lib/mysh/sources/parse.rb

@@ -1,11 +1,10 @@
 # coding: utf-8
 
-#* mysh/sources/parse.rb -- mysh general parser.
+# mysh general parser.
 module Mysh
 
-  #Parse a string into components.
-  #<br>Endemic Code Smells
-  #* :reek:TooManyStatements
+  # Parse a string into components.
+  # Endemic Code Smells   :reek:TooManyStatements
   def self.parse_args(input)
     result, read_point = [], input.chars.each
 
@@ -24,9 +23,8 @@ module Mysh
 
   private
 
-  #Get a string parameter.
-  #<br>Endemic Code Smells
-  #* :reek:TooManyStatements
+  # Get a string parameter.
+  # Endemic Code Smells   :reek:TooManyStatements
   def self.get_string(read_point)
     result = ""
 
@@ -41,9 +39,8 @@ module Mysh
     [result]
   end
 
-  #Get a parameter.
-  #<br>Endemic Code Smells
-  #* :reek:TooManyStatements
+  # Get a parameter.
+  # Endemic Code Smells   :reek:TooManyStatements
   def self.get_parameter(first_char, read_point)
     result = first_char
 

data/lib/mysh/sources/smart_auto_complete.rb

@@ -1,12 +1,12 @@
 # coding: utf-8
 
-#* mysh/sources/smart_auto_complete.rb - An adaptive source for auto-complete.
+# An adaptive source for auto-complete.
 module Mysh
 
-  #* array_source.rb - An array as the source for auto-complete.
+  # An array as the source for auto-complete.
   class SmartSource
 
-    #Create a new file/folder auto-data source. NOP
+    # Create a new file/folder auto-data source. NOP
     def initialize(options)
       @prefix        = options[:prefix]
       @auto_source   = MiniReadline::AutoFileSource.new(options)
@@ -14,7 +14,7 @@ module Mysh
       @active_source = nil
     end
 
-    #Construct a new data list for auto-complete
+    # Construct a new data list for auto-complete
     def rebuild(str)
       if /(?<=\s|^)\$[a-z][a-z0-9_]*\z/ =~ str
         sym = $MATCH[1..-1].to_sym
@@ -26,7 +26,7 @@ module Mysh
       @active_source.rebuild(str)
     end
 
-    #Get the next string for auto-complete
+    # Get the next string for auto-complete
     def next
       @active_source ? @active_source.next : @str
     end

data/lib/mysh/sources/string.rb

@@ -1,18 +1,18 @@
 # coding: utf-8
 
-#* mysh/sources/string.rb -- The mysh string command source.
+# The mysh string command source.
 module Mysh
 
-  #A wrapper for a string with mysh commands.
+  # A wrapper for a string with mysh commands.
   class StringSource
 
-    #Setup the string source.
+    # Setup the string source.
     def initialize(str)
       @eoi = false
       @read_pt = str.lines.each
     end
 
-    #Get the initial line of command input.
+    # Get the initial line of command input.
     def get_command(_str="")
       @read_pt.next
     rescue StopIteration
@@ -20,10 +20,10 @@ module Mysh
       "\n"
     end
 
-    #Set up an alias as these two are identical.
+    # Set up an alias as these two are identical.
     alias :get_command_extra :get_command
 
-    #Have we reached the end of input?
+    # Have we reached the end of input?
     def eoi?
       @eoi
     end

data/lib/mysh/version.rb

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

data/mysh.gemspec

@@ -23,17 +23,17 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.3'
 
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency 'minitest', "~> 5.7"
-  spec.add_development_dependency 'minitest_visible', "~> 0.1"
   spec.add_development_dependency 'rdoc', "~> 5.0"
   spec.add_development_dependency 'reek', "~> 5.0.2"
 
   spec.add_runtime_dependency     'mini_readline', "~> 0.9.1"
   spec.add_runtime_dependency     'mini_term', "~> 0.1.0"
-  spec.add_runtime_dependency     'pause_output', "~> 0.1.0"
+  spec.add_runtime_dependency     'pause_output', "~> 0.2.0"
   spec.add_runtime_dependency     'format_output', "~> 0.1.0"
   spec.add_runtime_dependency     'vls', "~> 0.4.1"
-  spec.add_runtime_dependency     'in_array', "~> 0.1.8"
+  spec.add_runtime_dependency     'in_array', ">= 1.0"
+  spec.add_runtime_dependency     'insouciant', "~> 0.1.0"
 end

data/tests/my_shell_tests.rb

@@ -3,14 +3,10 @@
 require_relative '../lib/mysh'
 gem              'minitest'
 require          'minitest/autorun'
-require          'minitest_visible'
 
 #Test the monkey patches applied to the Object class.
 class MyShellTester < Minitest::Test
 
-  #Track mini-test progress.
-  include MinitestVisible
-
   def test_that_it_has_a_version_number
     refute_nil(::Mysh::VERSION)
     assert(::Mysh::VERSION.frozen?)

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mysh
 version: !ruby/object:Gem::Version
-  version: 0.6.13
+  version: 0.6.19
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-30 00:00:00.000000000 Z
+date: 2020-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.7'
-- !ruby/object:Gem::Dependency
-  name: minitest_visible
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: format_output
   requirement: !ruby/object:Gem::Requirement
@@ -166,18 +152,32 @@ dependencies:
         version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: in_array
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: insouciant
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.1.0
 description: mysh -- a Ruby inspired command shell for CLI and application use.
 email:
 - peter.c.camilleri@gmail.com