mysh 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db73fad7b11e3e399b5fce1390213a5e5aba485f
-  data.tar.gz: 38dff27207d3d2bb068f126c67fadd6e36caa653
+  metadata.gz: dcab3e7234b02634d2b6d35c021a6e74d1e500e9
+  data.tar.gz: 9bc8b2270e6a4616d5c9f01802383992be7d010d
 SHA512:
-  metadata.gz: 655af01e192a8a526bcd14d6237a9c63890f3c19a3eda6f13ca3cbc0bb312bb0249e34d39eebbd16211455865dde162d79372d23ffe4a440ae4e68bb9ecd2e4c
-  data.tar.gz: af77111bf507908117c3c800d8d76893bc67d9781acc41cda1e8ffca50fd0386916d30e8d20ada80c0bf2e4ec2fefabc6780b3e6ca87b2c860c6bbff5c193081
+  metadata.gz: 79c6c862dd727aa571b5d465a0cd61509615b08ee016bb6b9b981f7aa1f305fc9627014ff80a63332ed2e933a300e875cd1efff4b02dd37c1ac7731f6aa76957
+  data.tar.gz: c6cfd30e004d5e2e12120c3aa0876cc485b6b8aae49d64fc432e968daf3d93b1d73d5f2c85fbae4d58e37544bb6c25d6e948d067720906fe2375598c9011f859

data/README.md

@@ -203,16 +203,18 @@ Normally an input is one line entered by the user. Like this:
 ```
 mysh> ls *.rb
 ```
-In mysh, the user is able to chain together multiple lines and have them
-treated as a single input. So for the following scenario:
+In mysh, the user is able enter Ruby code directly at the command line. Since
+these commands can be rather long, there is a need to to chain together
+multiple lines and have them treated as a single input. So for the following
+scenario:
 ```
-mysh>line one\
-mysh\line two\
-mysh\line three
+mysh>= "line one" +\
+mysh\"line two" +\
+mysh\"line three"
 ```
 The input string will be:
 ```
-"line one\nline two\nline three\n"
+"="line one" +\n"line two" +\n"line three"\n"
 ```
 Note that while the prompt is user configurable, it will always end with '>'
 for the initial line and '\\' for subsequent lines.
@@ -582,6 +584,8 @@ types      | Help on mysh file types.
 usage      | Help on mysh usage options.
 {{         | Help on mysh handlebars.
 
+Also, absent any detailed help information, the help command will show the
+summary of any internal command.
 
 ### Shell Info
 
@@ -889,6 +893,19 @@ information.
 To add a new help topic, simply add the new help file to the help folder and
 and a corresponding line entry to to the help variable.
 
+#### Exceptions:
+
+As an application, exception handling is largely an internal matter. However,
+since user code can be embedded in mysh, they should be documented. The mysh
+application gem uses the following exception classes:
+
+    Exception              # From Ruby.
+      StandardError        # From Ruby.
+        MyshException      # The abstract base exception for mysh.
+          MyshExit         # Exit the current mysh processing loop.
+          MyshStopOutput   # Stop further output from a verbose command.
+
+
 ## Contributing
 
 All participation is welcomed. There are two fabulous plans to choose from:

data/lib/mysh.rb

@@ -8,6 +8,7 @@ require 'in_array'
 require_relative 'mysh/exceptions'
 require_relative 'mysh/binding_wrapper'
 require_relative 'mysh/input_wrapper'
+require_relative 'mysh/output_pager'
 require_relative 'mysh/user_input'
 require_relative 'mysh/expression'
 require_relative 'mysh/internal'

data/lib/mysh/exceptions.rb

@@ -1,4 +1,10 @@
 # coding: utf-8
 
-#Exit the current mysh processing loop.
-class MyshExit < Exception; end
+# The abstract base exception of the mysh.
+class MyshException < StandardError; end
+
+# Exit the current mysh processing loop.
+class MyshExit < MyshException; end
+
+# Stop further output from a verbose command.
+class MyshStopOutput < MyshException; end

data/lib/mysh/globalize.rb

@@ -15,4 +15,20 @@ class Object
     Mysh.try_execute_command(str)
   end
 
+  # Execute a block with page paused output.
+  def more
+    saved = $stdout
+
+    if MNV[:page_pause].extract_mysh_types
+      $stdout = OutputPager.new if (outer = $stdout.equal?($mysh_out))
+    end
+
+    yield
+  rescue MyshStopOutput
+    raise unless outer
+    return
+  ensure
+    $stdout = saved
+  end
+
 end

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

@@ -11,7 +11,13 @@ module Mysh
     if (args = input.args).empty?
       puts Dir.pwd.to_host_spec
     else
-      Dir.chdir(args[0]) unless args.empty?
+      begin
+        Dir.chdir(args[0])
+      rescue Errno::ENOENT
+        puts "Cannot find \"#{args[0]}\""
+      rescue Errno::EINVAL
+        puts "The file \"#{args[0]}\" is not a directory."
+      end
     end
   end
 

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

@@ -4,7 +4,7 @@
 module Mysh
 
   #Add the elapsed commands to the library.
-  desc = 'Execute a command and then display the elapsed time.'
+  desc = 'Execute a command and then display the elapsed time. See ?% for more.'
 
   action = lambda do |input|
     start_time = Time.now

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

@@ -5,7 +5,18 @@ module Mysh
 
   # Help action pool of topics.
   default = Action.new do |args|
-    puts "No help found for #{args[0].inspect}."
+    topic = args[0]
+    help = []
+
+    COMMANDS.actions_info.each do |cmd|
+      help << cmd if cmd[0].start_with?(topic)
+    end
+
+    if help.empty?
+      puts "No help found for #{topic.inspect}."
+    else
+      puts help.format_mysh_bullets
+    end
   end
 
   HELP = ActionPool.new("HELP", default)
@@ -24,7 +35,7 @@ module Mysh
   end
 
   # The base help command.
-  desc = 'Display help information for mysh with an optional topic.'
+  desc = 'Display help information for mysh with an optional topic. See ?? for more.'
   COMMANDS.add_action(HelpCommand.new('help <topic>', desc))
   #The help command action object.
   HELP_COMMAND = HelpCommand.new('?<topic>', desc)

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

@@ -25,15 +25,15 @@ crass         mini_portile2 rack-test     thread_safe
 
 mysh>gls -l vls
 name        vls
-version     0.4.0
-date        2016-10-08 00:00:00 UTC
+version     0.4.1
+date        2016-10-27 00:00:00 UTC
 summary     A version listing utility.
 description A CLI and Rails console utility that lists the versions of modules
             used by the specified gems/ruby files or Rails project.
 executables vls
 authors     Peter Camilleri
 email       peter.c.camilleri@gmail.com
-homepage    http://teuthida-technologies.com/
+homepage    https://github.com/PeterCamilleri/vls
 
 A complete guide to the gem specification's properties may be found at:
 http://guides.rubygems.org/specification-reference/

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

@@ -10,3 +10,11 @@ The available help topics are:
 
 {{ HELP.actions_info.format_mysh_bullets }}
 
+Brief summaries are also available on the following internal commands:
+
+{{ Mysh::COMMANDS.actions_info
+                 .reject{|cmd| cmd[1]["See ?"]}
+                 .map{|cmd| cmd[0].split[0] }
+                 .join(" ")
+}}
+

data/lib/mysh/internal/format.rb

@@ -1,17 +1,9 @@
 # coding: utf-8
 
-#* mysh/internal/format.rb - Some formatting facilities for mysh.
-module Mysh
-
-  #Assume an 80 column working area for formatting.
-  PAGE_WIDTH = 80
-
-end
-
+# Grab the mysh formatters
 require_relative 'format/bullets'
 require_relative 'format/columns'
 require_relative 'format/array'
 require_relative 'format/string'
 require_relative 'format/object'
 require_relative 'format/nil'
-

data/lib/mysh/internal/format/array.rb

@@ -6,7 +6,7 @@ class Array
   # Columns ========================================================
 
   #Print out the array with efficient columns.
-  def puts_mysh_columns(page_width  = Mysh::PAGE_WIDTH)
+  def puts_mysh_columns(page_width  = MiniTerm.width)
     puts format_mysh_columns(page_width)
   end
 
@@ -30,7 +30,7 @@ class Array
   #* A string.
   #<br>Endemic Code Smells
   #* :reek:FeatureEnvy -- false positive.
-  def format_mysh_columns(page_width = Mysh::PAGE_WIDTH)
+  def format_mysh_columns(page_width = MiniTerm.width)
     raw_mysh_columns(page_width).join("\n")
   end
 
@@ -45,7 +45,7 @@ class Array
   # Bullets ========================================================
 
   #Print out the array as bullet points.
-  def puts_mysh_bullets(page_width = Mysh::PAGE_WIDTH)
+  def puts_mysh_bullets(page_width = MiniTerm.width)
     puts format_mysh_bullets(page_width)
   end
 
@@ -54,7 +54,7 @@ class Array
   #* A string.
   #<br>Endemic Code Smells
   #* :reek:FeatureEnvy -- false positive.
-  def format_mysh_bullets(page_width = Mysh::PAGE_WIDTH)
+  def format_mysh_bullets(page_width = MiniTerm.width)
     return "" if empty?
 
     builder = Mysh::BulletPoints.new(page_width)

data/lib/mysh/output_pager.rb

@@ -0,0 +1,101 @@
+# coding: utf-8
+
+$mysh_out = $stdout   # Keep a copy of the real $stdout.
+
+# A class to manage paged output.
+class OutputPager
+
+  # Set up the initial values.
+  def initialize
+    @lines = 0
+    @chars = 0
+  end
+
+  # Write out a general string with page pauses.
+  def write(str)
+    while !str.empty?
+      pre,mid,str = str.partition("\n")
+      write_str(pre) unless pre.empty?
+      writeln unless mid.empty?
+    end
+  end
+
+private
+
+  # Write out a simple string with no embedded new-lines.
+  def write_str(str)
+    loop do
+      len = str.length
+
+      if @chars + len < chars_per_line
+        $mysh_out.write(str)
+        @chars += len
+        return
+      else
+        tilt = chars_per_line - @chars
+        $mysh_out.write(str[0, tilt])
+        count_lines
+
+        str = (str[tilt..-1])
+      end
+    end
+  end
+
+  # Write out a new-line.
+  def writeln
+    $mysh_out.write("\n")
+    count_lines
+  end
+
+  # A new line is out, count it!
+  def count_lines
+    @chars = 0
+    @lines += 1
+
+    if @lines >= (lines_per_page - 1)
+      case pause.downcase
+      when " "
+        @lines -= 1
+      when "q"
+        raise MyshStopOutput
+      else
+        @lines = 0
+      end
+    end
+  end
+
+  # Pause waiting for the user.
+  def pause
+    msg = pause_message
+    $mysh_out.write(msg)
+
+    MiniTerm.raw do |term|
+      result = term.get_raw_char
+      term.flush
+      result
+    end
+
+  ensure
+    $mysh_out.write("\r" + " " * msg.length + "\r")
+  end
+
+  # How many lines fit on a page?
+  def lines_per_page
+    result = MNV[:page_height].to_i
+    result = MiniTerm.height if result < 2
+    result
+  end
+
+  # How many characters fit on a line?
+  def chars_per_line
+    result = MNV[:page_width].to_i
+    result = MiniTerm.width if result < 20
+    result
+  end
+
+  # Get the text of the pause message.
+  def pause_message
+    MNV.key?(:page_msg) ? MNV[:page_msg] : "Press enter, space or q:"
+  end
+
+end

data/lib/mysh/process.rb

@@ -39,10 +39,12 @@ module Mysh
   def self.try_execute_command(str)
     input = InputWrapper.new(str)
 
-    try_execute_quick(input)    ||
-    try_execute_internal(input) ||
-    try_execute_external(input) ||
-    try_execute_system(input)
+    more do
+      try_execute_quick(input)    ||
+      try_execute_internal(input) ||
+      try_execute_external(input) ||
+      try_execute_system(input)
+    end
   end
 
 end

data/lib/mysh/shell_variables.rb

@@ -16,6 +16,11 @@ module Mysh
   MNV[:post_prompt] = "$prompt"
   MNV[:pre_prompt]  = "$w"
 
+  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[: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/smart_auto_complete.rb

@@ -16,13 +16,19 @@ module Mysh
 
     #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
+        @active_source = nil
+        return @str = $PREMATCH + MNV[sym] if MNV.key?(sym)
+      end
+
       @active_source = (@prefix || str[0]) == '=' ? @quote_source : @auto_source
       @active_source.rebuild(str)
     end
 
     #Get the next string for auto-complete
     def next
-      @active_source.next
+      @active_source ? @active_source.next : @str
     end
 
   end

data/lib/mysh/user_input.rb

@@ -18,7 +18,7 @@ module Mysh
 
   #Get any continuations of the inputs
   def self.get_command_extra(source, str)
-    if /\\\s*$/ =~ str
+    if str.start_with?("=") && /\\\s*$/ =~ str
       get_command_extra(source, $PREMATCH + "\n" + source.get_command_extra(str))
     else
       str

data/lib/mysh/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysh
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-06 00:00:00.000000000 Z
+date: 2018-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -220,6 +220,7 @@ files:
 - lib/mysh/internal/format/string.rb
 - lib/mysh/internal/manage.rb
 - lib/mysh/internal/to_file_spec.rb
+- lib/mysh/output_pager.rb
 - lib/mysh/pre_processor.rb
 - lib/mysh/process.rb
 - lib/mysh/quick.rb