mysh 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fd9998d94e082db9a7e41d4338322d5031cee1e
-  data.tar.gz: 6c4c031b70519d71edabfc1220c8a1a3112072e7
+  metadata.gz: db73fad7b11e3e399b5fce1390213a5e5aba485f
+  data.tar.gz: 38dff27207d3d2bb068f126c67fadd6e36caa653
 SHA512:
-  metadata.gz: a08248ea5f888156d068a0fd123a9ac41033384c231bb9024da51570db8c68cff459b2642ef8703bb7b817254e345151fd527f5caf695bb895cf9c2fc7aaf4e2
-  data.tar.gz: 77922cf33ed6fa0d26f03ea44c649fdb4c8488fca4049300b3a65ad34792d8227bd7d477517b18380c734262f917665d4d2f668f8a3fc66a674f6769771d104c
+  metadata.gz: 655af01e192a8a526bcd14d6237a9c63890f3c19a3eda6f13ca3cbc0bb312bb0249e34d39eebbd16211455865dde162d79372d23ffe4a440ae4e68bb9ecd2e4c
+  data.tar.gz: af77111bf507908117c3c800d8d76893bc67d9781acc41cda1e8ffca50fd0386916d30e8d20ada80c0bf2e4ec2fefabc6780b3e6ca87b2c860c6bbff5c193081

data/README.md

@@ -45,6 +45,72 @@ Or install it yourself as:
 
     $ gem install mysh
 
+
+#### Advanced Options
+
+As a gem, when mysh is installed, the mysh file in the bin directory gets
+"hooked in" to the system as an executable file. In Mac/Linux systems this is
+done natively. In Windows systems this is done via an intermediary mysh.bat
+file. This works, but leaves a great deal to be desired especially in its
+handling of signals like control-C. Since Windows users are treated as hated
+step-sisters, here are two alternative options to using mysh as your shell
+once the Ruby language and the mysh gem have been installed.
+
+---
+
+**Option 1 - Against a standard Ruby install**
+
+This option applies if Ruby is installed so that it is generally available in
+any command window. You can test this by opening a regular command line window
+and typing:
+
+    ruby -v
+
+You should see the ruby's version info. If instead you see:
+
+    C:\Users\Hilda>ruby -v
+    'ruby' is not recognized as an internal or external command,
+    operable program or batch file.
+
+Then there are either installation issues with Ruby or you need to see option 2.
+
+Once Ruby operation is confirmed, all that is needed is to get a copy of the
+Command Window Icon and update the target field in its properties as:
+
+OLD
+
+    %windir%\system32\cmd.exe
+
+NEW
+
+    %windir%\system32\cmd.exe /C ruby -e"require %q{mysh}; Mysh.run"
+
+---
+
+**Option 2 - Against a RailsInstaller install**
+
+With RailsInstaller (RI) things are a teensy bit more involved. RI creates a
+special Command Prompt with Ruby and Rails icon. To start you need to make a
+copy of that icon. Then the target field in properties needs to be updated:
+
+OLD
+
+    C:\Windows\System32\cmd.exe /E:ON /K C:\RailsInstaller\Ruby2.3.3\setup_environment.bat C:\RailsInstaller
+
+NEW
+
+    C:\Windows\System32\cmd.exe /E:ON /C C:\RailsInstaller\Ruby2.3.3\setup_environment.bat C:\RailsInstaller & ruby -e"require %q{mysh}; Mysh.run"
+
+Note: The change from /K to /C.
+
+---
+
+**Also** For both options, renaming the icon to something like
+"Mysh with Ruby and Rails" or some such is also a good idea. Then make sure you
+place your icon where you can find it. I pinned mine to the Windows Task Bar.
+
+---
+
 ## Usage
 
 The mysh gem includes a simple executable called mysh. The template for running
@@ -370,6 +436,7 @@ $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
+$name       | The name given to this mysh session.
 $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.
@@ -387,7 +454,7 @@ in the Mysh ini file.
 
     set $prompt = {{ cmd_cter||=0; cmd_cter+=1 }} mysh>
 
-And the command line will not look like:
+And the command line will look like:
 
     1 mysh>ls
     CODE_OF_CONDUCT.md  LICENSE.txt  lib           rakefile.rb  tests
@@ -838,7 +905,8 @@ All participation is welcomed. There are two fabulous plans to choose from:
 #### Plan B
 
 Go to the GitHub repository at (https://github.com/PeterCamilleri/mysh) and
-raise an issue calling attention to some aspect that could use some TLC or a
-suggestion or an idea or a comment.
+raise an [issue](https://github.com/PeterCamilleri/mysh/issues)
+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!

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

@@ -1,7 +1,7 @@
 Help: mysh initialization summary:
 
-When mysh starts up, it must be initialized and acclimated to its environment. 
-The boot/initialization process of mysh is somewhat modeled after that of the 
+When mysh starts up, it must be initialized and acclimated to its environment.
+The boot/initialization process of mysh is somewhat modeled after that of the
 famous bash shell. On startup:
 
 1 Option values are initialized to their initial, default values.
@@ -13,18 +13,18 @@ famous bash shell. On startup:
 3 Try to load and execute the mysh_init file. There are three possible files
   for this role. In priority order they are
 
-    ~/mysh_init.mysh,
-    ~/mysh_init.rb,
-    ~/mysh_init.txt.
+    $$h/mysh_init.mysh,
+    $$h/mysh_init.rb,
+    $$h/mysh_init.txt.
 
   NOTE: If an init file is specified with the --init option, or disabled with
         the --no-init option, then this step is skipped.
 
-4 The rest of the command line options are processed at this time. 
+4 The rest of the command line options are processed at this time.
 
 It should be noted that in the event of a conflict in settings during the boot
 process, the last command/option encountered shall prevail. For example if
-the ~/mysh_init.mysh contains the line:
+the $$h/mysh_init.mysh contains the line:
 
 \$debug = true
 

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

@@ -22,6 +22,7 @@ $$d           The current date.
 $$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.
 $$pre_prompt  A prompt string displayed before the actual command prompt.

data/lib/mysh/internal/actions/show/env.rb

@@ -24,13 +24,13 @@ module Mysh
        ["init file", $mysh_init_file.to_host_spec],
        ["user",      ENV['USER']],
        ["home",      (ENV['HOME'] || "").to_host_spec],
-       ["name",      $PROGRAM_NAME.to_host_spec],
+       ["name",      (t = MNV[:name]).empty? ? $PROGRAM_NAME.to_host_spec : t],
        ["os shell",  (ENV['SHELL'] || ENV['ComSpec'] || "").to_host_spec],
        ["host",      ENV['HOSTNAME'] || ENV['COMPUTERNAME']],
        ["os",        ENV['OS']],
-       ["platform",  MiniReadline::TERM_PLATFORM],
-       ["java?",     MiniReadline::TERM_JAVA ? true : false],
-       ["code page", if MiniReadline::PLATFORM == :windows; (`chcp`); end],
+       ["platform",  MiniTerm::TERM_PLATFORM],
+       ["java?",     MiniTerm.java? ? true : false],
+       ["code page", if MiniTerm.windows?; (`chcp`); end],
        ["term",      ENV['TERM']],
        ["disp",      ENV['DISPLAY']],
        ["edit",      ENV['EDITOR']],

data/lib/mysh/internal/to_file_spec.rb

@@ -11,7 +11,7 @@ class String
 
   #Dress up slashes and backslashes.
   def dress_up_slashes
-    MiniReadline::PLATFORM == :windows ? self.gsub("/", "\\") : self
+    MiniTerm.windows? ? self.gsub("/", "\\") : self
   end
 
   #Dress up in quotes if needed.

data/lib/mysh/version.rb

@@ -2,7 +2,7 @@
 
 module Mysh
   #The version string of MY SHell.
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 
   #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.8.1"
+  spec.add_runtime_dependency     'mini_readline', "~> 0.9.0"
   spec.add_runtime_dependency     'vls', "~> 0.4.1"
   spec.add_runtime_dependency     'in_array', "~> 0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysh
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-04 00:00:00.000000000 Z
+date: 2018-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: vls
   requirement: !ruby/object:Gem::Requirement