mysh 0.6.11 → 0.6.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1aaea546a90b6d110dd8910757083c385a7e72d5
-  data.tar.gz: 4f82d70adf3479acf12ee7a670c6d3a247326777
+  metadata.gz: 1181f7c07f14be213795e5af840e9364e838ada9
+  data.tar.gz: 0005e8503ddd7a6905d834c85e01519f920ca65f
 SHA512:
-  metadata.gz: 5b6d81b4a6cce7307a7b1262ad4125afb1cc1c0083a2c128543ff43211bd3be70bf4c3372f43a01b1225b4668d077b3b29cac51c29741313c0ae757510398e3a
-  data.tar.gz: 1aff82db1052b83caf85b0e09f006eebebf80a0b0782da66660b09586fabe1527bdd72f4760c47eaa2a4387a5f16447acc6ce588f364101d3a692736c628bad1
+  metadata.gz: 536851ba0c923a4e2491d5abd50c417f8f3c6992cc61c885920d1c4654219c95efd40fbfcaf3a1574e94687a602248914b40a13a4a938f55993911d9903b3006
+  data.tar.gz: 5ccbc4d1709a355aa9d3a8b065aacee3dbe9c6620bcfb26f70fd27b8fedd89cffdeb03d88314dd747a7d0b3d64977c7f6f303673791e26127ce81569b511f852

data/README.md

@@ -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,9 @@ $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_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?

data/lib/mysh.rb

@@ -24,10 +24,10 @@ require_relative 'mysh/init'
 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. A container for mysh and its functionality.
 module Mysh
 
-  #The actual shell method.
+  # The actual shell method.
   def self.run(args=[])
     process_command_args(args, :pre_boot)
     mysh_load_init
@@ -40,7 +40,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
 
-$VERBOSE = nil
+# Suppress an annoying warning during tests.
+$VERBOSE = nil if defined?(Rake)

data/lib/mysh/init.rb

@@ -1,12 +1,12 @@
 # coding: utf-8
 
-#* mysh/init.rb -- The mysh init file loader.
+# The mysh initial file loader.
 module Mysh
 
-  #Set the init file used to startup mysh to none so far.
+  # Set the initial file used to startup mysh to none so far.
   $mysh_init_file = nil
 
-  #Perform init phase processing.
+  # Perform initial phase processing.
   def self.mysh_load_init
 
     unless $mysh_init_file

data/lib/mysh/internal/actions/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/help/history.txt

@@ -21,3 +21,10 @@ Form     Form            Description
                          regex pattern. Note: This pattern cannot be 'clear'
                          so use 'clea[r]' instead.
 
+The history buffer is controlled by two variables:
+
+$$history  Is the history buffer enabled?
+$$no_move  Are history entries kept in place or shifted up the buffer?
+
+These are also controlled by command line options. See ?usage for more info.
+

data/lib/mysh/shell_variables.rb

@@ -21,6 +21,9 @@ module Mysh
   MNV[:page_pause]  = "on"
   MNV[:page_msg]    = "Press a key, a space, or q:"
 
+  MNV[:history]     = "on"
+  MNV[:no_move]     = "on"
+
   MNV[:d] = "{{ Time.now.strftime(MNV[:date_fmt]) }}"
   MNV[:h] = "{{ ENV['HOME'].to_host_spec }}"
   MNV[:r] = "{{ RbConfig.ruby.to_host_spec }}"

data/lib/mysh/sources/console.rb

@@ -1,17 +1,17 @@
 # coding: utf-8
 
-#* mysh/sources/console.rb -- The mysh console command source.
+# The mysh console command source.
 module Mysh
 
-  #A wrapper for the mysh console terminal.
+  # A wrapper for the mysh console terminal.
   class Console
 
-    #Setup the console wrapper.
+    # Setup the console wrapper.
     def initialize
       @eoi = false
     end
 
-    #Get the initial line of command input.
+    # Get the initial line of command input.
     def get_command
       puts MNV[:pre_prompt] if MNV.key?(:pre_prompt)
       get(prompt: MNV[:prompt])
@@ -20,7 +20,7 @@ module Mysh
       exit
     end
 
-    #Get additional lines of continued commands.
+    # Get additional lines of continued commands.
     def get_command_extra(str)
       get(prompt: MNV[:post_prompt] + '\\', prefix: str[0])
     rescue MiniReadlinePLE => err
@@ -38,15 +38,18 @@ module Mysh
       MNV[selector] = ""
     end
 
-    #Have we reached the end of input?
+    # Have we reached the end of input?
     def eoi?
       @eoi
     end
 
     private
 
-    #Get some actual user input!
+    # Get some actual user input!
     def get(parms={})
+      parms[:history] = MNV[:history].extract_boolean
+      parms[:no_move] = MNV[:no_move].extract_boolean
+
       result = (input = Mysh.input).readline(parms)
       input.instance_options[:initial] = ""
       result

data/lib/mysh/user_input.rb

@@ -27,8 +27,7 @@ module Mysh
 
   #Get the user input ready.
   def self.input
-    @input ||= MiniReadline::Readline.new(history:       true,
-                                          eoi_detect:    true,
+    @input ||= MiniReadline::Readline.new(eoi_detect:    true,
                                           auto_complete: true,
                                           auto_source:   SmartSource)
   end

data/lib/mysh/version.rb

@@ -2,7 +2,7 @@
 
 module Mysh
   #The version string of MY SHell.
-  VERSION = "0.6.11"
+  VERSION = "0.6.12"
 
   #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 'rdoc', "~> 5.0"
   spec.add_development_dependency 'reek', "~> 5.0.2"
 
-  spec.add_runtime_dependency     'mini_readline', "~> 0.9.0"
+  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     'format_output', "~> 0.1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysh
 version: !ruby/object:Gem::Version
-  version: 0.6.11
+  version: 0.6.12
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-30 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: mini_term
   requirement: !ruby/object:Gem::Requirement
@@ -210,6 +210,7 @@ files:
 - 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/history.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