mysh 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cffedfff55f5d5d4d26d6dc3f9b9871b2af5b9e6
-  data.tar.gz: 15dd0fe9b7a5b885144f6b635494755e03979f35
+  metadata.gz: 36d1e9cb65e8e404c9e85ab77e29e1201a2df5f6
+  data.tar.gz: 3e5f058a9f2a8ebbe313fff8983aa328b016652f
 SHA512:
-  metadata.gz: 88e80a96bab121558084c7052140ce3eb66a48158c0e6f8daf565dc50293f320176c80f90278e1b0e12526a6dcbfb3d1644290503ceb70ee486f2fff29d4f921
-  data.tar.gz: 0d659db5efd3333f227311636712f87dd989a350c3dc2594085c91c021016e0a59ee917b77e4ef190d6d3d0286e2d2a554ca44927e117c6ea0f8566de41c54e1
+  metadata.gz: 5d9ba17eb0a81ebc7b291767f03f9d56b077b8b82e89593b090fd689eae5acfdce02554b7b8ab0eff9a0359506328bb7a28f49101ac0b9847980d5dec10b075c
+  data.tar.gz: fbb691b11d8daf992f152412bd4dae5b3ebe958c73abfc1f2c759ba0c757443c8bacf19174914057cb95639dcac5c8a417973ff0e02e5bd87ee2ff495b8e872a

data/README.md

@@ -130,6 +130,8 @@ Option               | Short Form(s)| Description             | Default
 --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.
+--pause              |              | Enable page pauses for long output.
+--no-pause           |              | Disable page pauses for long output.
 --post-prompt "str"  | -pp "str"    | Set the mysh line continuation prompt to "str". | $prompt
 --no-post-prompt     | -npp         | Turn off mysh line continuation prompting.
 --pre-prompt "str"   | -pr "str"    | Set the mysh pre prompt to "str". | $w
@@ -343,6 +345,25 @@ baz yes
 
 ```
 
+###### Page Pause
+
+Some commands can generate very lengthy output that can scroll off the top of
+the screen. to handle this, mysh automatically inserts pauses once per screen.
+At this point, it displays a prompt and waits for the users to press a key that
+will determine the action to take. The default message is:
+
+    Press a key, a space, or q:
+
+The available actions are:
+
+Key        | Action
+-----------|-----------------------------------------------
+'q' or "Q" | Stop the long winded command.
+Space      | Add a single line of additional output.
+Other      | Add up to a whole page of additional output.
+
+This feature is controlled by the $page_pause variable that can be either
+on or off as well as the --pause and --no-pause command line options.
 
 #### LOOP
 
@@ -439,6 +460,10 @@ $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
 $name       | The name given to this mysh session.
+$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?
+$page_width | The page width.
 $post_prompt| The prompt used when a line is continued with a trailing \\ character. By default this is the same as the normal prompt.
 $pre_prompt | A prompt string displayed before the actual command prompt. Delete the pre_prompt variable to disable pre-prompting.
 $prompt     | The user prompt.
@@ -649,18 +674,21 @@ Internal commands are recognized by name and are executed by mysh directly. The
 complete list of internal commands is given in the default help command ("?").
 Some commands, not already covered in other sections include:
 
-Command        | Description
----------------|----------------------------------------------------
-cd {dir}       | Change directory to the optional dir parameter and then display the current working directory.
-exit           | Exit mysh.
-gls {-l} {mask}| Display the loaded ruby gems. See ?gls for more.
-history {index}| The mysh command history. If an index is specified, get the command with that index value.
-load file      | Load a ruby program, mysh script, or text file into the mysh environment.
-mls {mask}     | Display modules with version info. See ?mls for more.
-pwd            | Display the current working directory.
-quit           | Exit mysh.
-say <stuff>    | Display the text in the command arguments.
-type file      | Display a text file with support for optional embedded handlebars and mysh variables.
+Command          | Description
+-----------------|----------------------------------------------------
+cancel           | Cancel the current mysh execution level.
+cd <dir>         | Change directory to the optional <dir> parameter or display the current working directory.
+exit             | Exit out of the mysh.
+gls <-l> <mask>  | Display the loaded ruby gems.
+help <topic>     | Display help information for mysh with an optional topic.
+history <arg>    | Display the mysh command history.
+load <file>      | Load a ruby program, mysh script, or text file into the mysh
+mls <mask>       | Display modules with version info.
+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.
 
 Notes:
 1. The notation {x} means that x is optional.
@@ -904,6 +932,7 @@ application gem uses the following exception classes:
         MyshException      # The abstract base exception for mysh.
           MyshExit         # Exit the current mysh processing loop.
           MyshStopOutput   # Stop further output from a verbose command.
+          MyshUsage        # Internal: Used by the --help options.
 
 
 ## Contributing

data/lib/mysh/exceptions.rb

@@ -8,3 +8,6 @@ class MyshExit < MyshException; end
 
 # Stop further output from a verbose command.
 class MyshStopOutput < MyshException; end
+
+# Display usage info and exit.
+class MyshUsage < MyshException; end

data/lib/mysh/external.rb

@@ -15,7 +15,7 @@ module Mysh
 
       if ext == '.rb'
         new_command = "#{RbConfig.ruby} #{input.cooked}"
-        puts "=> #{new_command}"  if MNV[:debug].extract_mysh_types
+        puts "=> #{new_command}"  if MNV[:debug].extract_boolean
         system(new_command)
         :ruby_exec
       elsif ext == '.mysh'

data/lib/mysh/globalize.rb

@@ -19,16 +19,23 @@ class Object
   def more
     saved = $stdout
 
-    if MNV[:page_pause].extract_mysh_types
+    if MNV[:page_pause].extract_boolean
       $stdout = OutputPager.new if (outer = $stdout.equal?($mysh_out))
     end
 
     yield
+
   rescue MyshStopOutput
     raise unless outer
     return
+
   ensure
     $stdout = saved
   end
 
+  #Unwrap one mysh layer.
+  def cancel
+    raise MyshExit
+  end
+
 end

data/lib/mysh/internal/actions/cancel.rb

@@ -0,0 +1,10 @@
+# coding: utf-8
+
+# The mysh internal cancel command.
+module Mysh
+
+  # Add the cancel command to the library.
+  desc = 'Cancel the current mysh level.'
+
+  COMMANDS.add_action(Action.new('cancel', desc) {|_input| cancel})
+end

data/lib/mysh/internal/actions/command_line/pause.rb

@@ -0,0 +1,44 @@
+# coding: utf-8
+
+module Mysh
+
+  # The page pause option.
+  class PauseOption < CommandOption
+
+    #Execute the help command line option.
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
+    def post_boot(_args)
+      MNV[:page_pause] = "on"
+    end
+
+    def pre_boot(_args)
+      MNV[:page_pause] = "on"
+    end
+
+  end
+
+  #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
+    def post_boot(_args)
+      MNV[:page_pause] = "off"
+    end
+
+    def pre_boot(_args)
+      MNV[:page_pause] = "off"
+    end
+
+  end
+
+  #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/quit.rb

@@ -14,6 +14,6 @@ module Mysh
   end
 
   #Add the quit command line option to the library.
-  desc = 'Quit out of the mysh program.'
+  desc = "Exit a nested mysh file or command."
   COMMAND_LINE.add_action(QuitOption.new('--quit', desc))
 end

data/lib/mysh/internal/actions/command_line/usage.rb

@@ -8,7 +8,7 @@ module Mysh
 
     #Execute the help command line option. (Punt to error handler with no msg)
     def pre_boot(_args)
-      raise ""
+      raise MyshUsage
     end
 
   end

data/lib/mysh/internal/actions/command_line.rb

@@ -41,12 +41,16 @@ module Mysh
       next_command.send(phase, read_point)
     end
 
+  rescue MyshUsage
+    HELP["usage"].process_command(nil)
+    exit
+
   rescue => err
-    unless (msg = err.to_s).empty?
-      puts "", msg, ""
+    more do
+      puts "", err.to_s, ""
+      HELP["usage"].process_command(nil)
     end
 
-    HELP["usage"].process_command(nil)
     exit
   end
 

data/lib/mysh/internal/actions/exit.rb

@@ -1,11 +1,10 @@
 # coding: utf-8
 
-#* mysh/internal/actions/exit.rb -- The mysh internal exit command.
+# The mysh internal exit command.
 module Mysh
 
-  #Add the exit command to the library.
-  desc = 'Exit the current mysh level.'
-  action = lambda {|_input| raise MyshExit}
+  # Add the exit command to the library.
+  desc = 'Exit out of the mysh.'
 
-  COMMANDS.add_action(Action.new('exit', desc, &action))
+  COMMANDS.add_action(Action.new('exit', desc) {|_input| exit })
 end

data/lib/mysh/internal/actions/help/sub_help.rb

@@ -39,7 +39,6 @@ module Mysh
           ['kbd',     'Help on mysh keyboard mapping.',      'kbd.txt'    ],
           ['{{',      'Help on mysh handlebars.',            'hbar.txt'   ],
           ['init',    'Help on mysh initialization.',        'init.txt'   ],
-          ['args',    'Help on mysh command arguments.',     'args.txt'   ],
           ['types',   'Help on mysh file types.',            'types.txt'  ],
           ['help',    'This help on the help command.',      'h_o_h.txt'  ],
           ['?',       'This help on the help command.',      'h_o_h.txt'  ]

data/lib/mysh/output_pager.rb

@@ -20,6 +20,11 @@ class OutputPager
     end
   end
 
+  # Write out an object as a string.
+  def <<(obj)
+    write(obj.to_s)
+  end
+
 private
 
   # Write out a simple string with no embedded new-lines.

data/lib/mysh/process.rb

@@ -30,9 +30,12 @@ module Mysh
   def self.execute_a_command(source)
     try_execute_command(get_command(source))
 
+  rescue MyshExit
+    raise
+
   rescue Interrupt, StandardError, ScriptError => err
     puts "Error #{err.class}: #{err}"
-    puts err.backtrace if MNV[:debug].extract_mysh_types || defined?(MiniTest)
+    puts err.backtrace if MNV[:debug].extract_boolean || defined?(MiniTest)
   end
 
   #Try to execute a single line of input. Does not handle exceptions.

data/lib/mysh/shell_variables/evaluate.rb

@@ -4,7 +4,7 @@
 class String
 
   #Extract common mysh data from this string.
-  def extract_mysh_types
+  def extract_boolean
     if self =~ /\A(false|no|off)\z/i
       false
     else

data/lib/mysh/version.rb

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

data/tests/my_shell_tests.rb

@@ -28,7 +28,7 @@ class MyShellTester < Minitest::Test
 
   def test_for_internal_commands
     assert(Mysh::COMMANDS['exit'], "The exit command is missing.")
-    assert(Mysh::COMMANDS['quit'], "The quit command is missing.")
+    assert(Mysh::COMMANDS['cancel'], "The cancel command is missing.")
 
     assert(Mysh::COMMANDS['history'],  "The history command is missing.")
     assert(Mysh::COMMANDS['!<arg>'], "The ! command is missing.")
@@ -150,7 +150,7 @@ class MyShellTester < Minitest::Test
     assert(MNV.key?(:test), "MNV[:test] should exist.")
 
     Mysh.try_execute_command("set $test = off")
-    assert_equal(false, MNV[:test].extract_mysh_types)
+    assert_equal(false, MNV[:test].extract_boolean)
     assert_equal("off", MNV[:test])
     assert(MNV.key?(:test), "MNV[:test] should exist.")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysh
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-01 00:00:00.000000000 Z
+date: 2018-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -165,11 +165,13 @@ files:
 - lib/mysh/internal/action.rb
 - lib/mysh/internal/action_pool.rb
 - lib/mysh/internal/actions/actions_path.rb
+- lib/mysh/internal/actions/cancel.rb
 - lib/mysh/internal/actions/cd.rb
 - lib/mysh/internal/actions/command_line.rb
 - lib/mysh/internal/actions/command_line/debug.rb
 - lib/mysh/internal/actions/command_line/init.rb
 - lib/mysh/internal/actions/command_line/load.rb
+- lib/mysh/internal/actions/command_line/pause.rb
 - lib/mysh/internal/actions/command_line/post_prompt.rb
 - lib/mysh/internal/actions/command_line/pre_prompt.rb
 - lib/mysh/internal/actions/command_line/prompt.rb
@@ -180,7 +182,6 @@ files:
 - lib/mysh/internal/actions/exit.rb
 - lib/mysh/internal/actions/gls.rb
 - lib/mysh/internal/actions/help.rb
-- lib/mysh/internal/actions/help/args.txt
 - lib/mysh/internal/actions/help/env.txt
 - lib/mysh/internal/actions/help/expr.txt
 - lib/mysh/internal/actions/help/gls.txt
@@ -204,7 +205,6 @@ files:
 - lib/mysh/internal/actions/load.rb
 - lib/mysh/internal/actions/mls.rb
 - lib/mysh/internal/actions/pwd.rb
-- lib/mysh/internal/actions/quit.rb
 - lib/mysh/internal/actions/say.rb
 - lib/mysh/internal/actions/show.rb
 - lib/mysh/internal/actions/show/env.rb

data/lib/mysh/internal/actions/help/args.txt

@@ -1,19 +0,0 @@
-Available mysh command line arguments are:
-
-Option+Short Forms      Description                                     Default
-==================      ===========                                     =======
---debug -d              Turn on mysh debugging.                         false
---no-debug -nd          Turn off mysh debugging.
---help -? -h            Display mysh usage info and exit.
---init -i <name>        Initialize mysh by loading the specified file.*
---no-init -ni           Do not load a file to initialize mysh.
---load -l <name>        Load the specified file into the mysh.
---post-prompt -pp "str" Set the mysh line continuation prompt to "str". $$prompt
---no-post-prompt -npp   Turn off mysh line continuation prompting.
---pre-prompt -pr"str"   Set the mysh pre prompt to "str".               \$w
---no-pre-prompt -npr    Turn off mysh pre prompting.
---prompt -p "str"       Set the mysh prompt to "str".                   "mysh"
---no-prompt -np         Turn off mysh prompting.
---quit                  Quit out of the mysh program.
-
-* See ?init for more details on the default file loaded.

data/lib/mysh/internal/actions/quit.rb

@@ -1,10 +0,0 @@
-# coding: utf-8
-
-#* mysh/internal/actions/quit.rb -- The mysh internal quit command.
-module Mysh
-
-  #Add the quit command to the library.
-  desc = 'Quit out of the mysh.'
-
-  COMMANDS.add_action(Action.new('quit', desc) {|_input| exit })
-end