ruby-shell 0.9 → 0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2eb807ee53179bcbc57da83b9bdbf7d46d524ad01d384c450df00c0036e636f1
-  data.tar.gz: '0595692866bfd1acf9afda02e157232d7e86701063cf7e5deff2654fe9a1c0d0'
+  metadata.gz: 37f126a017a54cab294467b035635ce6992f4ae1d67befcd7d4a33882929be5a
+  data.tar.gz: 7210fde457362b3a08e793e62ecf27059e244f514bd77f7aaf8f980c47974826
 SHA512:
-  metadata.gz: 7e9349dee0b04e6f9e0d91afcb4f60d90111249b80d3820b75a4efa16fdcea26e702ba64c895f84c0e903ec018748f8a9258a369015097e9e55f81a9ee1d7d40
-  data.tar.gz: d0ba07abb7b5490609691cafa88fc4c4299823ae91990daab7d5616c69535b2a9e69269141bf93e45721369eaaa93defd496b94101641d2c143b4631134af02f
+  metadata.gz: 5690e8bed0c4efbcf3194e8a2d5e1cdfa5e339c26cee90281818e6c7d35a4b0ce3c64dbe769b67fc86ff89220304598a15a8f56844c179376ca4813b2baafa71
+  data.tar.gz: 4f0c21b28d1ae2f19cd28d7727e2dce0e8097479188b122092649b49080e60f9210f489155ec2e81b2d7551f3b226f7ee78229abe3814cfc3093140a0c757d38

data/.rshrc

@@ -1,12 +1,24 @@
-@prompt = "#{@user}@#{@node}".c(46) + ":".c(255) + " #{Dir.pwd}/".c(196) + " ".c(7)
-@nick = {"ls"=>"ls --color -F", "la"=>"ls -a --color -F", "ll"=>"ls -l --color -F", "l"=>"less"}
-@gnick = {}
-@history = []
+# vim: set ft=ruby sw=2 sts=2 et :
+
+# PROMPT
+# The numbers in parenthesis are 256 color codes (the '.c()' is a String extention
+# to color text in the terminal. Add '.b' for bold and '.i' for italics.
+if @user == "root"
+  @prompt = "#{@user}@#{@node}".c(160) + ":".c(255) + " #{Dir.pwd}/".c(196) + " ".c(7)
+else
+  @prompt = "#{@user}@#{@node}".c(46) + ":".c(255) + " #{Dir.pwd}/".c(196) + " ".c(7)
+end
+
+# THEME
 @c_prompt    = 196  # Color for basic prompt
 @c_cmd       = 48   # Color for valid command
 @c_nick      = 51   # Color for matching nick
 @c_gnick     = 87   # Color for matching gnick
 @c_path      = 208  # Color for valid path
+@c_switch    = 148  # Color for switches/options
 @c_tabselect = 207  # Color for selected tabcompleted item
 @c_taboption = 244  # Color for unselected tabcompleted item
+@c_stamp     = 244  # Color for time stamp/command
 
+# UPDATED ON CTRL-D EXIT
+@nick = {"ls"=>"ls --color -F"}

data/README.md

@@ -15,18 +15,28 @@ Clone this repo and drop `rsh` into your preferred bin directory. Drop `.rshrc`
 Or simply `gem install ruby-shell`.
 
 # Features
-* Aliases (called `nicks`in rsh) - both for commands and general nicks
+* Aliases (called nicks in rsh) - both for commands and general nicks
 * Syntax highlighting, matching nicks, system commands and valid dirs/files
 * Tab completions for nicks, system commands, command switches and dirs/files
 * Tab completion presents matches in a list to pick from
-* When you start to write a command, rsh will suggest the first match in the
-  history and present that in "toned down" letters - press the arrow right key
-  to accept the suggestion.
-* History with simple editing
-* Config file (`.rshrc`) updates on exit
-* Set of simple rsh specific commands like `nick`, `nick?`, `history` and `rmhistory`
-* rsh specific commands and full set of Ruby commands available via `:command`
-* All colors are themeable in `.rshrc`
+* When you start to write a command, rsh will suggest the first match in the history and present that in "toned down" letters - press the arrow right key to accept the suggestion.
+* History with editing, search
+* Config file (.rshrc) updates on exit (with Ctrl-d) or not (with Ctrl-c)
+* Set of simple rsh specific commands like nick, nick?, history and rmhistory
+* rsh specific commands and full set of Ruby commands available via :<command>
+* All colors are themeable in .rshrc (see github link for possibilities)
+  
+Special functions/integrations:
+* Use `r` to launch rtfm (https://github.com/isene/RTFM) - if you have it installed
+* Use `f` to launch fzf (https://github.com/junegunn/fzf) - if you have it installed
+* Use `=` followed by xrpn commands separated by commas (https://github.com/isene/xrpn)
+* Use `:` followed by a Ruby expression to access the whole world of Ruby
+
+Special commands:
+* `:nick 'll = ls -l'` to make a command alias (ll) point to a command (ls -l)
+* `:gnick 'h = /home/me'` to make a general alias (h) point to something (/home/me)
+* `:nick?` will list all command nicks and general nicks (you can edit your nicks in .rshrc)
+* `:history` will list the command history, while `:rmhistory` will delete the history
 
 ## Nicks
 Add command nicks (aliases) with `:nick "some_nick = some_command"`, e.g. `:nick "ls = ls --color"`. Add general nicks that will substitute anything on a command line (not just commands) like this `:gnick "some_gnick = some_command"`, e.g. `:gnick "x = /home/user/somewhere"`. List (g)nicks with `:nick?`. Remove a nick with `:nick "-some_command"`, e.g. `:nick "-ls"` to remove an `ls` nick. Same for gnicks.

data/bin/rsh

@@ -14,7 +14,7 @@
 #             for any damages resulting from its use. Further, I am under no
 #             obligation to maintain or extend this software. It is provided 
 #             on an 'as is' basis without any expressed or implied warranty.
-@version    = "0.9"
+@version    = "0.10"
 
 # MODULES, CLASSES AND EXTENSIONS
 class String # Add coloring to strings (with escaping for Readline)
@@ -130,6 +130,68 @@ begin # Initialization
 end
 
 # GENERIC FUNCTIONS
+def firstrun
+  @firstrun = <<~FIRSTRUN
+  Hello #{@user}, welcome to rsh - the Ruby SHell. 
+  
+  rsh does not attempt to compete with the grand old shells like bash and zsh. 
+  It serves the specific needs and wants of its author. If you like it, then feel free 
+  to ask for more or different features here: https://github.com/isene/rsh. Features:
+
+  * Aliases (called nicks in rsh) - both for commands and general nicks
+  * Syntax highlighting, matching nicks, system commands and valid dirs/files
+  * Tab completions for nicks, system commands, command switches and dirs/files
+  * Tab completion presents matches in a list to pick from
+  * When you start to write a command, rsh will suggest the first match in the history and
+    present that in "toned down" letters - press the arrow right key to accept the suggestion.
+  * History with editing, search
+  * Config file (.rshrc) updates on exit (with Ctrl-d) or not (with Ctrl-c)
+  * Set of simple rsh specific commands like nick, nick?, history and rmhistory
+  * rsh specific commands and full set of Ruby commands available via :<command>
+  * All colors are themeable in .rshrc (see github link for possibilities)
+  
+  Special functions/integrations:
+  * Use `r` to launch rtfm (https://github.com/isene/RTFM) - if you have it installed
+  * Use `f` to launch fzf (https://github.com/junegunn/fzf) - if you have it installed
+  * Use `=` followed by xrpn commands separated by commas (https://github.com/isene/xrpn)
+  * Use `:` followed by a Ruby expression to access the whole world of Ruby
+  Special commands:
+  * `:nick 'll = ls -l'` to make a command alias (ll) point to a command (ls -l)
+  * `:gnick 'h = /home/me'` to make a general alias (h) point to something (/home/me)
+  * `:nick?` will list all command nicks and general nicks (you can edit your nicks in .rshrc)
+  * `:history` will list the command history, while `:rmhistory` will delete the history
+  
+  Since there is no rsh configuration file (.rshrc), I will help you set it up to suit your needs.
+FIRSTRUN
+
+  puts @firstrun
+  puts "The prompt you see now is the very basic rsh prompt: "
+  print "#{@prompt} (press ENTER)"
+  STDIN.gets
+  puts "I will now change the prompt into something more useful."
+  puts "Feel free to amend the prompt in your .rshrc."
+  rc = <<~RSHRC
+  # PROMPT
+  # The numbers in parenthesis are 256 color codes (the '.c()' is a String extention
+  # to color text in the terminal. Add '.b' for bold and '.i' for italics.
+  @prompt = "\#{@user}@\#{@node}".c(46) + ":".c(255) + " \#{Dir.pwd}/".c(196) + " ".c(7)
+
+  # THEME
+  @c_prompt    = 196  # Color for basic prompt
+  @c_cmd       = 48   # Color for valid command
+  @c_nick      = 51   # Color for matching nick
+  @c_gnick     = 87   # Color for matching gnick
+  @c_path      = 208  # Color for valid path
+  @c_switch    = 148  # Color for switches/options
+  @c_tabselect = 207  # Color for selected tabcompleted item
+  @c_taboption = 244  # Color for unselected tabcompleted item
+  @c_stamp     = 244  # Color for time stamp/command
+
+  @nick = {"ls"=>"ls --color -F"}
+RSHRC
+  File.write(Dir.home+'/.rshrc', rc)
+
+end
 def getchr # Process key presses
   c = STDIN.getch
   case c
@@ -487,7 +549,8 @@ end
 # INITIAL SETUP
 begin # Load .rshrc and populate @history
   trap "SIGINT" do print "\n"; exit end
-  load(Dir.home+'/.rshrc') if File.exist?(Dir.home+'/.rshrc') # Initial loading - to get history
+  firstrun unless File.exist?(Dir.home+'/.rshrc') # Initial loading - to get history
+  load(Dir.home+'/.rshrc') 
   @c = Cursor               # Initiate @c as Cursor
   @c.save                   # Get max row & col
   @c.row(8000)
@@ -510,9 +573,13 @@ loop do
     @cmd = "ls" if @cmd == "" # Default to ls when no command is given
     print "\n"; @c.clear_screen_down
     if @cmd == "r" # Integration with rtfm (https://github.com/isene/RTFM)
-      File.write("/tmp/.rshpwd", Dir.pwd)
-      system("rtfm /tmp/.rshpwd")
-      Dir.chdir(File.read("/tmp/.rshpwd"))
+      t  = Time.now
+      t0 = t.nsec.to_s
+      tf = "/tmp/.rshpwd" + t0
+      File.write(tf, Dir.pwd)
+      system("rtfm #{tf}")
+      Dir.chdir(File.read(tf))
+      File.delete(tf)
       next
     end
     @cmd = "echo \"#{@cmd[1...]},prx,off\" | xrpn" if @cmd =~ /^\=/ # Integration with xrpn (https://github.com/isene/xrpn)

metadata

@@ -1,19 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: ruby-shell
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '0.10'
 platform: ruby
 authors:
 - Geir Isene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-02 00:00:00.000000000 Z
+date: 2023-06-03 00:00:00.000000000 Z
 dependencies: []
 description: 'A shell written in Ruby with extensive tab completions, aliases/nicks,
   history, syntax highlighting, theming and more. In continual development. New in
-  0.9: Added the feature to suggdest the first match in history when you start writing
-  a command - press the right arrow key to accept.'
+  0.10: Added introduction and creation of .rshrc on first run. Improved rtfm integration.'
 email: g@isene.com
 executables:
 - rsh