mysh 0.1.17 → 0.2.0

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

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+#* mysh/internal/actions/type.rb -- The mysh type command.
+module Mysh
+
+  #* mysh/internal/actions/type.rb -- The mysh type command.
+  class TypeCommand < Action
+
+    #Execute the type command.
+    def call(args)
+      file_name = args.shift
+
+      @exec_binding = binding
+
+      if file_name
+        show_handlebar_file(file_name)
+      else
+        puts "Error: A text file must be specified."
+      end
+    end
+
+  end
+
+  #Add the type command to the library.
+  desc = 'Display a text file with optional embedded handlebars.'
+  COMMANDS.add_action(TypeCommand.new('type', desc))
+end

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

@@ -1,22 +1,22 @@
 # coding: utf-8
 
-#* internal/actions/vls.rb -- The mysh module version ls command.
-module Mysh
-
-  #* internal/actions/vls.rb -- The mysh module version ls command.
-  class Action
+require 'vls'
 
-    desc = 'Display the loaded modules, matching the optional mask, ' +
-           'that have version info.'
+#* mysh/internal/actions/vls.rb -- The mysh module vls (Version LS) command.
+module Mysh
 
-    COMMANDS.add('vls <mask>', desc) do |args|
-      mask = args.shift || /./
+  #* mysh/internal/actions/vls.rb -- The mysh module vls (Version LS) command.
+  class VlsCommand < Action
 
-      puts VersionLS.vls(mask).mysh_bulletize.join("\n")
-      puts
+    #Execute the vls command.
+    def call(args)
+      puts VersionLS.vls(args[0] || /./).mysh_bulletize, ""
     end
 
   end
 
+  #Add the vls command to the library.
+  desc = 'Display the loaded modules, matching the optional mask, that ' +
+         'have version info.'
+  COMMANDS.add_action(VlsCommand.new('vls <mask>', desc))
 end
-

data/lib/mysh/internal/decorate.rb

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* internal/decorate.rb -- mysh internal file name beauty treatments.
+#* mysh/internal/decorate.rb -- mysh internal file name beauty treatments.
 module Mysh
 
-  #The mysh internal file name beauty treatments.
+  #* mysh/internal/decorate.rb -- The mysh internal file name beauty treatments.
   class Action
 
     #Make the file name fit the local system.

data/lib/mysh/internal/format.rb

@@ -1,14 +1,11 @@
 # coding: utf-8
 
-#* internal/format.rb - Some formatting facilities for mysh.
+#* mysh/internal/format.rb - Some formatting facilities for mysh.
 module Mysh
 
   #Assume an 80 column working area for formatting.
   PAGE_WIDTH = 80
 
-  #Assume an in infinite page length for formatting.
-  PAGE_LENGTH = false
-
 end
 
 require_relative 'format/bullets'
@@ -16,4 +13,5 @@ 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

@@ -7,28 +7,38 @@ class Array
 
   #Print out the array with efficient columns.
   def puts_mysh_columns(page_width  = Mysh::PAGE_WIDTH)
-
     puts format_mysh_columns(page_width)
   end
 
   #Convert the array to strings with efficient columns.
   #<br>Returns
-  #* An array of pages, that is, arrays of strings.
-  def format_mysh_columns(page_width = Mysh::PAGE_WIDTH)
-    builder = Mysh::ColumnizedPage.new(Mysh::PAGE_LENGTH, page_width)
+  #* An array of strings.
+  #<br>Endemic Code Smells
+  #* :reek:FeatureEnvy -- false positive.
+  def raw_mysh_columns(page_width)
+    builder = Mysh::ColumnizedPage.new(page_width)
 
-    self.each {|item| builder.add(item)}
+    each {|item| builder.add(item)}
 
     builder.render
   end
 
-  alias :format_description :format_mysh_columns
+  alias :format_description :raw_mysh_columns
+
+  #Convert the array to strings with efficient columns.
+  #<br>Returns
+  #* A string.
+  #<br>Endemic Code Smells
+  #* :reek:FeatureEnvy -- false positive.
+  def format_mysh_columns(page_width = Mysh::PAGE_WIDTH)
+    raw_mysh_columns(page_width).join("\n")
+  end
 
   #Get the widest element of an array.
   #<br>Returns
   #* The width of the widest string in the array.
   def mysh_column_width
-    (self.max_by {|item| item.length}).length
+    max_by {|item| item.length}.length
   end
 
 
@@ -40,16 +50,16 @@ class Array
   end
 
   #Convert the array to strings with bullet points.
-  #<br>
-  #* An array of strings
+  #<br>Returns
+  #* A string.
+  #<br>Endemic Code Smells
+  #* :reek:FeatureEnvy -- false positive.
   def mysh_bulletize(page_width = Mysh::PAGE_WIDTH)
     builder = Mysh::BulletPoints.new(page_width)
 
-    self.each do |pair|
-      builder.add(*pair)
-    end
+    each {|pair| builder.add(*pair)}
 
-    builder.render
+    builder.render.join("\n")
   end
 
 end

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

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* internal/format/bullets.rb - Print out bullet points.
+#* mysh/internal/format/bullets.rb - Print out bullet points.
 module Mysh
 
-  #A class to display data in bullet points.
+  #* mysh/internal/format/bullets.rb - A class to display data in bullet points.
   class BulletPoints
 
     #Prepare a blank slate.

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

@@ -1,13 +1,13 @@
 # coding: utf-8
 
-#* internal/format/bullets.rb - Print out data in neat columns.
+#* mysh/internal/format/columns.rb - Print out data in neat columns.
 module Mysh
 
-  #A class to display data in columns.
+  #* mysh/internal/format/columns.rb - A class to display data in columns.
   class ColumnizedPage
     #Prepare a blank page.
-    def initialize(page_length, page_width)
-      @page_length, @page_width = page_length, page_width
+    def initialize(page_width)
+      @page_width = page_width
       @page_data = []
     end
 
@@ -52,24 +52,19 @@ module Mysh
     end
 
     #Make sure the page fits within its boundaries.
-    #<br>Returns
-    #* The number if items that did not fit in the page.
     def adjust_configuration
       while total_width >= @page_width
-        return @page_data.pop.length if rows == @page_length
         add_a_row
       end
-
-      0
     end
 
     #Add a row to the page, moving items as needed.
     def add_a_row
-      target = rows + 1
+      new_rows = rows + 1
       pool, @page_data = @page_data.flatten, []
 
       until pool.empty?
-        @page_data << pool.shift(target)
+        @page_data << pool.shift(new_rows)
       end
     end
 

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

@@ -0,0 +1,13 @@
+# coding: utf-8
+
+#* internal/format/nil.rb - Support for displaying nothing formatted neatly.
+class NilClass
+
+  #Create a bullet point description from nothing.
+  def format_description(_max_width)
+    []
+  end
+
+end
+
+

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

@@ -4,38 +4,52 @@
 class String
 
   #Create a bullet point description from this string.
+  #<br>Returns
+  #* An array of strings.
   def format_description(max_width)
     do_format_description(split(' ').each, max_width)
   end
 
   #Do the formatting legwork.
+  #<br>Returns
+  #* An array of strings.
   def do_format_description(input, max_width)
-    result, build = [], ""
+    buffer, build, empty = [], "", false
 
-    loop do
-      build = build.split_if_over(input.next, max_width, result)
-                   .split_if_huge(max_width, result)
+    loop do  #Grab "words" of input, splitting off lines as needed.
+      empty = (build = build.split_if_over(input.next, max_width, buffer)
+                            .split_if_huge(max_width, buffer)).empty?
     end
 
-    result << build
+    unless empty
+      buffer << build
+    end
+
+    buffer
   end
 
   #Split if adding a word goes over a little.
+  #<br>Returns
+  #* A string.
   def split_if_over(word, max_width, buffer)
-    word.prepend(" ") unless self.empty?
+    word.prepend(" ") unless empty? #Add a space except for the first word.
+
     word_len = word.length
 
     if (length + word_len) >= max_width && word_len < max_width
-      buffer << self
-      word.lstrip
+      buffer << self  #Line done, add to buffer.
+      word.lstrip     #Start of a new line, remove the leading space.
     else
       self + word
     end
-
   end
 
   #Split up a overlong blob of text.
+  #<br>Returns
+  #* A string.
   def split_if_huge(max_width, buffer)
+
+    #Slice away any excess text into lines in the buffer.
     while length >= max_width
       buffer << slice!(0, max_width)
     end

data/lib/mysh/internal/manage.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-#* internal/manage.rb -- Manage mysh internal commands.
+#* mysh/internal/manage.rb -- Manage mysh internal commands.
 module Mysh
 
   #Set up the command action pool.
@@ -19,7 +19,7 @@ module Mysh
       action, args = parse_command(str.chomp)
 
       if (action)
-        action.execute(args)
+        action.call(args)
         :internal
       end
     end

data/lib/mysh/quick.rb

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+#* mysh/internal/quick.rb -- The mysh internal quick commands.
+module Mysh
+
+  #Try to execute the string as a quick command.
+  def self.try_execute_quick_command(str)
+    case str[0]
+    when '!'
+      HISTORY_COMMAND.call(parse_args(str[1...-1]))
+      :history
+
+    when '='
+      @exec_host.execute(str)
+      :expression
+
+    when '?'
+      HELP_COMMAND.call(parse_args(str[1...-1]))
+      :help
+
+    when '@'
+      SHOW_COMMAND.call(parse_args(str[1...-1]))
+      :show
+
+    else
+      false
+    end
+  end
+
+
+end
+

data/lib/mysh/user_input.rb

@@ -1,16 +1,24 @@
 # coding: utf-8
 
+require 'mini_readline'
+
 require_relative 'user_input/smart_source'
 require_relative 'user_input/parse'
 require_relative 'user_input/handlebars'
 
-#* user_input.rb -- Get a command from the user.
+#* mysh/user_input.rb -- Get some text from the user.
 module Mysh
 
+  class << self
+    #The input text source.
+    attr_reader :input
+  end
+
   #Get one command from the user.
   def self.get_command
-    input = @input.readline(prompt: 'mysh>')
-    get_command_extra(input)
+    initial_input = @input.readline(prompt: 'mysh>')
+    @input.instance_options[:initial] = ""
+    get_command_extra(initial_input)
   end
 
   private
@@ -36,4 +44,3 @@ module Mysh
 
 end
 
-

data/lib/mysh/user_input/parse.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-#* user_input/parse.rb -- mysh general parser.
+#* mysh/user_input/parse.rb -- mysh general parser.
 module Mysh
 
   #Parse a string into components.

data/lib/mysh/user_input/smart_source.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-#* array_source.rb - An array as the source for auto-complete.
+#* mysh/user_input/smart_source.rb - An adaptive source for auto-complete.
 module Mysh
 
   #* array_source.rb - An array as the source for auto-complete.

data/lib/mysh/version.rb

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

data/mysh.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = Mysh::SUMMARY
   spec.description   = "mysh -- a Ruby inspired command shell " +
                        "for CLI and application use."
-  spec.homepage      = "http://teuthida-technologies.com/"
+  spec.homepage      = "https://github.com/PeterCamilleri/mysh"
 
   spec.license       = "MIT"
 

data/samples/show.txt

@@ -7,5 +7,5 @@ Args = {{ args.inspect }}
 
 {{ [["Numbers", Array.new(count){|i| (i+1)} ],
     ["Squares", Array.new(count){|i| (i+1)*(i+1)} ],
-    ["Cubes",   Array.new(count){|i| (i+1)*(i+1)*(i+1)} ]].mysh_bulletize.join("\n") }}
+    ["Cubes",   Array.new(count){|i| (i+1)*(i+1)*(i+1)} ]].mysh_bulletize }}
 

data/tests/my_shell_tests.rb

@@ -27,18 +27,18 @@ class MyShellTester < Minitest::Test
     assert_equal(Class,  Mysh::ExecHost.class)
 
     assert_equal(Mysh::ActionPool, Mysh::COMMANDS.class)
-    assert_equal(Mysh::ActionPool, Mysh::Action::HELP.class)
+    assert_equal(Mysh::ActionPool, Mysh::HELP.class)
   end
 
   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['history'], "The history command is missing.")
-    assert(Mysh::COMMANDS['!'], "The ! command is missing.")
+    assert(Mysh::COMMANDS['history'],  "The history command is missing.")
+    assert(Mysh::COMMANDS['!<index>'], "The ! command is missing.")
 
     assert(Mysh::COMMANDS['help'], "The help command is missing.")
-    assert(Mysh::COMMANDS['?'], "The ? command is missing.")
+    assert(Mysh::COMMANDS['?<topic>'], "The ? command is missing.")
 
     assert(Mysh::COMMANDS['cd'], "The cd command is missing.")
     assert(Mysh::COMMANDS['pwd'], "The pwd command is missing.")
@@ -79,11 +79,19 @@ class MyShellTester < Minitest::Test
   end
 
   def test_some_formatting
+    assert_equal("1 4\n2 5\n3  ",       [1,2,3,4,5].format_mysh_columns(5))
+    assert_equal(["1 4", "2 5", "3  "], [1,2,3,4,5].format_description(5))
+
+    assert_equal(["1 2", "3 4", "5"],   "1 2 3 4 5".format_description(5))
+
+    assert_equal([], [].format_description(5))
+    assert_equal([], nil.format_description(5))
+
     result =
-      ["1 5 9  13 17 21 25 29 33 37 41 45 49 53 57 61 65 69 73 77 81 85 89 93 97 ",
-       "2 6 10 14 18 22 26 30 34 38 42 46 50 54 58 62 66 70 74 78 82 86 90 94 98 ",
-       "3 7 11 15 19 23 27 31 35 39 43 47 51 55 59 63 67 71 75 79 83 87 91 95 99 ",
-       "4 8 12 16 20 24 28 32 36 40 44 48 52 56 60 64 68 72 76 80 84 88 92 96 100"]
+       "1 5 9  13 17 21 25 29 33 37 41 45 49 53 57 61 65 69 73 77 81 85 89 93 97 \n" +
+       "2 6 10 14 18 22 26 30 34 38 42 46 50 54 58 62 66 70 74 78 82 86 90 94 98 \n" +
+       "3 7 11 15 19 23 27 31 35 39 43 47 51 55 59 63 67 71 75 79 83 87 91 95 99 \n" +
+       "4 8 12 16 20 24 28 32 36 40 44 48 52 56 60 64 68 72 76 80 84 88 92 96 100"
 
     assert_equal(result, (1..100).to_a.format_mysh_columns)
 
@@ -95,17 +103,16 @@ class MyShellTester < Minitest::Test
       ]
 
     result =
-      ["key_largo /long_folder_name_one/long_folder_name_two/long_folder_name_three/fin",
-       "          e_descriptive_name",
-       "key_west  Semper ubi sub ubi. Semper ubi sub ubi. Semper ubi sub ubi. Semper",
-       "          ubi sub ubi.",
-       "counting  0 5 10 15 20 25 30 35 40 45 50 55 60 65 70 75 80 85 90 95",
-       "          1 6 11 16 21 26 31 36 41 46 51 56 61 66 71 76 81 86 91 96",
-       "          2 7 12 17 22 27 32 37 42 47 52 57 62 67 72 77 82 87 92 97",
-       "          3 8 13 18 23 28 33 38 43 48 53 58 63 68 73 78 83 88 93 98",
-       "          4 9 14 19 24 29 34 39 44 49 54 59 64 69 74 79 84 89 94 99",
+       "key_largo /long_folder_name_one/long_folder_name_two/long_folder_name_three/fin\n" +
+       "          e_descriptive_name\n" +
+       "key_west  Semper ubi sub ubi. Semper ubi sub ubi. Semper ubi sub ubi. Semper\n" +
+       "          ubi sub ubi.\n" +
+       "counting  0 5 10 15 20 25 30 35 40 45 50 55 60 65 70 75 80 85 90 95\n" +
+       "          1 6 11 16 21 26 31 36 41 46 51 56 61 66 71 76 81 86 91 96\n" +
+       "          2 7 12 17 22 27 32 37 42 47 52 57 62 67 72 77 82 87 92 97\n" +
+       "          3 8 13 18 23 28 33 38 43 48 53 58 63 68 73 78 83 88 93 98\n" +
+       "          4 9 14 19 24 29 34 39 44 49 54 59 64 69 74 79 84 89 94 99\n" +
        "pie       3.141592653589793"
-      ]
 
     assert_equal(result, data.mysh_bulletize)
   end