mysh 0.1.17 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3c002087bb9289b3a21c696dbec4cf5eb0c2aad
-  data.tar.gz: 89e63a29c1c26f4f84372cfa34995e820c3cf726
+  metadata.gz: 1d9ec79fde72cd177c9caf7f32dbb49170f27fee
+  data.tar.gz: c43e22e6ffdda76face828eeba719536c1b4c719
 SHA512:
-  metadata.gz: eab8e85ede1899c6d87a457141a7664421fb9171e5175b5b3c82ac9181d4ce6838db03fe3c9f4334bbf61c9ca190524cfeddf859edefdd70c8171d65d296822a
-  data.tar.gz: 0a8e2f49879875648bf8435e9011c4188f4f05802b95a20a6045e95b6f5583b33b9cf1f526579f91c90d33871c387ff6796eccf154635710d3a3ad26a04b5130
+  metadata.gz: 23a55b9b455a96f51aa0d76d8d9da88f57d7f835bc8efc03ee9f1bb8c562ecd2b669122805acc41284020cd7701df9d6aca72c60afd4ff2aa880fdce8aac385f
+  data.tar.gz: e5cd9f361f5c822ff5c97af5946fc6e48091b214e0727733dbced95110f788c15af63dd319baf14567c6dd4a25dee83c61f5f2d1c61e9c885847ca1797fd3d7b

data/lib/mysh.rb

@@ -3,52 +3,55 @@
 # mysh -- MY SHell -- a Ruby/Rails inspired command line shell.
 
 require 'English'
-require 'mini_readline'
-require 'vls'
 require 'in_array'
 
 require_relative 'mysh/user_input'
+require_relative 'mysh/quick'
 require_relative 'mysh/expression'
 require_relative 'mysh/internal'
 require_relative 'mysh/external_ruby'
 require_relative 'mysh/version'
 
-#The MY SHell module. A container for its functionality.
+#The Mysh (MY SHell) module. A container for mysh and its functionality.
 module Mysh
 
-  class << self
-    #The input text source.
-    attr_reader :input
-  end
-
   #The actual shell method.
-  #<br>Endemic Code Smells
-  #* :reek:TooManyStatements
   def self.run
+    setup
+
+    while @mysh_running do
+      execute_a_command
+    end
+  end
+
+  #Common initialization tasks.
+  def self.setup
     reset_host
     init_input
+    @mysh_running = true
+  end
 
-    loop do
-      begin
-        input = @exec_host.eval_handlebars(get_command)
+  #Execute a single line of input.
+  def self.execute_a_command
+    try_execute_command(@exec_host.eval_handlebars(get_command))
 
-        try_execute_ruby_expression(input)  ||
-        try_execute_internal_command(input) ||
-        try_execute_external_ruby(input)    ||
-        system(input)
+  rescue MiniReadlineEOI
+    @mysh_running = false
 
-      rescue MiniReadlineEOI
-        break
+  rescue Interrupt, StandardError, ScriptError => err
+    puts err, err.backtrace
+  end
 
-      rescue Interrupt, StandardError, ScriptError => err
-        puts err, err.backtrace
-      end
-    end
+  #Try to execute a single line of input.
+  def self.try_execute_command(input)
+    try_execute_quick_command(input)    ||
+    try_execute_internal_command(input) ||
+    try_execute_external_ruby(input)    ||
+    system(input)
   end
 
 end
 
-#Some test code to run a shell if this file is run directly.
 if __FILE__ == $0
-  Mysh.run
+  Mysh.run  #Run a shell if this file is run directly.
 end

data/lib/mysh/expression.rb

@@ -5,7 +5,7 @@ require 'mathn'
 
 require_relative 'expression/lineage'
 
-#* expression.rb -- mysh ruby expression processor.
+#* mysh/expression.rb -- The mysh ruby expression processor.
 module Mysh
 
   #The mysh ruby expression processor.
@@ -71,14 +71,6 @@ module Mysh
     end
   end
 
-  #Try to execute the string as a ruby expression.
-  def self.try_execute_ruby_expression(str)
-    if str.start_with?('=')
-      @exec_host.execute(str)
-      :expression
-    end
-  end
-
   #Reset the state of the execution hosting environment.
   def self.reset_host
     @exec_host = ExecHost.new(self)

data/lib/mysh/external_ruby.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-#* external_ruby.rb -- Support for executing Ruby files with the ruby interpreter.
+#* mysh/external_ruby.rb -- Support for executing Ruby files with the ruby interpreter.
 module Mysh
 
   #Try to execute as a Ruby program.

data/lib/mysh/internal/action.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-#* internal/action.rb -- The framework of mysh internal actions.
+#* mysh/internal/action.rb -- The framework of mysh internal actions.
 module Mysh
 
   #The mysh internal action class.
@@ -11,20 +11,12 @@ module Mysh
     #The description of the action.
     attr_reader :description
 
-    #The action of the action.
-    attr_reader :action
-
     #Setup an internal action.
-    def initialize(name, description, &action)
-      @name, @description, @action = name, description.in_array, action
+    def initialize(name, description)
+      @name, @description = name, description.in_array
       @exec_binding = mysh_binding
     end
 
-    #Execute the action.
-    def execute(args)
-      instance_exec(args, &@action)
-    end
-
     #Get information about the action.
     def action_info
       [@name].concat(@description)

data/lib/mysh/internal/action_pool.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-#* internal/action_pool.rb -- A managed hash of mysh actions.
+#* mysh/internal/action_pool.rb -- A managed hash of mysh actions.
 module Mysh
 
   #* A managed hash of mysh actions.
@@ -12,10 +12,7 @@ module Mysh
     #Create a new action pool
     def initialize(pool_name, &default_action)
       @pool_name, @pool = pool_name, {}
-
-      if default_action
-        @pool.default = Action.new("", "", &default_action)
-      end
+      @pool.default = default_action
     end
 
     #Get a action.
@@ -23,24 +20,15 @@ module Mysh
       @pool[index]
     end
 
-    #Add a action.
-    def add(name, description, &action)
-      split_name = name.split[0] || ""
+    #Add an action to the pool.
+    def add_action(action)
+      split_name = action.name.split[0] || ""
 
       if @pool.has_key?(split_name)
         fail "Add error: Action #{split_name.inspect} already exists in #{pool_name}."
       end
 
-      @pool[split_name] = Action.new(name, description, &action)
-    end
-
-    #Add an alias for an existing action.
-    def add_alias(new_name, old_name)
-      unless (action = @pool[old_name.split[0]])
-        fail "Alias error: Action #{old_name.inspect} not found in #{pool_name}"
-      end
-
-      add(new_name, action.description, &action.action)
+      @pool[split_name] = action
     end
 
     #Get information on all actions.
@@ -53,6 +41,4 @@ module Mysh
 
   end
 
-
 end
-

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

@@ -1,9 +1,9 @@
 # coding: utf-8
 
-#* internal/actions/actions_path.rb -- A convenient hook to the actions folder.
+#* mysh/internal/actions/actions_path.rb -- A convenient hook to the actions folder.
 module Mysh
 
-  #* internal/actions/actions_path.rb -- A convenient hook to the actions folder.
+  #* mysh/internal/actions/actions_path.rb -- A convenient hook to the actions folder.
   class Action
 
     #Capture this folder's name.

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

@@ -1,32 +1,23 @@
 # coding: utf-8
 
-#* internal/actions/cd.rb -- The mysh internal cd command.
+#* mysh/internal/actions/cd.rb -- The mysh internal cd command.
 module Mysh
 
-  #* cd.rb -- The mysh internal cd command.
-  class Action
-    #Add the cd command to the library.
-    desc = 'Change directory to the optional <dir> parameter ' +
-           'and then display the current working directory.'
+  #* mysh/internal/actions/cd.rb -- The mysh internal cd command.
+  class CdCommand < Action
 
-    COMMANDS.add('cd <dir>', desc) do |args|
-      begin
-        Dir.chdir(args[0]) unless args.empty?
-        puts decorate(Dir.pwd)
-      rescue => err
-        puts "Error: #{err}"
-      end
-    end
-
-    #Add the pwd command to the library.
-    COMMANDS.add('pwd', 'Display the current working directory.') do |args|
-      begin
-        puts decorate(Dir.pwd)
-      rescue => err
-        puts "Error: #{err}"
-      end
+    #Execute the cd command.
+    def call(args)
+      Dir.chdir(args[0]) unless args.empty?
+      puts decorate(Dir.pwd)
+    rescue => err
+      puts "Error: #{err}"
     end
 
   end
-end
 
+  #Add the cd command to the library.
+  desc = 'Change directory to the optional <dir> parameter ' +
+         'and then display the current working directory.'
+  COMMANDS.add_action(CdCommand.new('cd <dir>', desc))
+end

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

@@ -1,16 +1,19 @@
 # coding: utf-8
 
-#* internal/actions/exit.rb -- The mysh internal exit command.
+#* mysh/internal/actions/exit.rb -- The mysh internal exit command.
 module Mysh
 
-  #* exit.rb -- The mysh internal exit command.
-  class Action
-    #Add the exit command to the library.
-    COMMANDS.add('exit', 'Exit mysh.') do |args|
+  #* mysh/internal/actions/exit.rb -- The mysh internal exit command.
+  class ExitCommand < Action
+
+    #Execute the exit command.
+    def call(_args)
       raise MiniReadlineEOI
     end
 
-    COMMANDS.add_alias('quit', 'exit')
   end
-end
 
+  #Add the exit command to the library.
+  COMMANDS.add_action(ExitCommand.new('exit', 'Exit mysh.'))
+  COMMANDS.add_action(ExitCommand.new('quit', 'Exit mysh.'))
+end

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

@@ -1,19 +1,74 @@
 # coding: utf-8
 
-#* internal/actions/gls.rb -- The mysh gem ls command.
+#* mysh/internal/actions/gls.rb -- The mysh gls (gem ls) command.
 module Mysh
 
-  #* internal/actions/gls.rb -- The mysh gem ls command.
-  class Action
+  #* mysh/internal/actions/gls.rb -- The mysh gls (gem ls) command.
+  class GlsCommand < Action
 
-    desc = 'Display the loaded ruby gems.'
+    #Execute the gls command.
+    def call(args)
+      process_args(args)
+      gather_gems
+      send(@report)
+    end
+
+    private
+
+    #Process the gls command's arguments.
+    def process_args (args)
+      @report, @mask = :short_report, /./
+
+      args.each do |arg|
+        if arg == '-l'
+          @report = :long_report
+        else
+          @mask = arg
+        end
+      end
+
+    end
+
+    #Determine which of the loaded gem specs are of interest.
+    def gather_gems
+      @specs = Gem.loaded_specs
+                  .values
+                  .select {|spec| !(spec.name.partition(@mask)[1]).empty?}
+                  .sort   {|first, second| first.name <=> second.name}
+    end
+
+    #The brief gem list report.
+    def short_report
+      puts @specs.map {|spec| spec.name}.format_mysh_columns, ""
+    end
+
+    #The long-winded gem list report.
+    def long_report
+      report = @specs.inject([]) do |buffer, spec|
+        buffer.concat(info(spec))
+      end
 
-    COMMANDS.add('gls <mask>', desc) do |args|
-      puts Gem.loaded_specs.keys.sort.join(" ")
-      puts
+      puts report.mysh_bulletize
+    end
+
+    #Get detailed information on a gem specification.
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
+    def info(spec)
+      [["name",        spec.name],
+       ["version",     spec.version],
+       ["date",        spec.date],
+       ["summary",     spec.summary],
+       ["description", spec.description],
+       ["executables", spec.executables],
+       ["authors",     spec.authors],
+       ["email",       spec.email],
+       ["homepage",    spec.homepage],
+       ["", ""]]
     end
 
   end
 
+  desc = 'Display the loaded ruby gems. See ?gls for more.'
+  COMMANDS.add_action(GlsCommand.new('gls <-l> <mask>', desc))
 end
-

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

@@ -1,47 +1,34 @@
 # coding: utf-8
 
-#* internal/actions/help.rb -- The mysh internal help command.
+#* mysh/internal/actions/help.rb -- The mysh internal help command.
 module Mysh
 
-  #* help.rb -- The mysh internal help command.
-  class Action
-
-    # Help topics
-    HELP = ActionPool.new("HELP") do |args|
-      puts "No help found for #{args[0].inspect}."
-    end
-
-    HELP.add("", "General help on mysh.") do |args|
-      show_handlebar_file(ACTIONS_PATH + 'help/help.txt')
-    end
-
-    HELP.add("math", "Help on mysh math functions.") do |args|
-      show_handlebar_file(ACTIONS_PATH + 'help/help_math.txt')
-    end
-
-    HELP.add("=", "Help on mysh ruby expressions.") do |args|
-      show_handlebar_file(ACTIONS_PATH + 'help/help_expr.txt')
-    end
-
-    HELP.add("help", "Help on mysh help.") do |args|
-      show_handlebar_file(ACTIONS_PATH + 'help/help_help.txt')
-    end
-
-    HELP.add_alias('?', 'help')
+  # Help action pool of topics.
+  HELP = ActionPool.new("HELP") do |args|
+    puts "No help found for #{args[0].inspect}."
+  end
 
-    # The base help command.
-    desc = 'Display help information for mysh with an optional topic.'
+  #* mysh/internal/actions/help.rb -- The mysh internal help command.
+  class HelpCommand < Action
 
-    COMMANDS.add('help <topic>', desc) do |args|
-      HELP[args[0] || ""].execute(args)
+    #Execute a help command by routing it to a sub-command.
+    #<br>Endemic Code Smells
+    #* :reek:UtilityFunction
+    def call(args)
+      HELP[args[0] || ""].call(args)
     end
 
-    COMMANDS.add_alias('? <topic>', 'help')
-
   end
 
+  # The base help command.
+  desc = 'Display help information for mysh with an optional topic.'
+  COMMANDS.add_action(HelpCommand.new('help <topic>', desc))
+  #The help command action object.
+  HELP_COMMAND = HelpCommand.new('?<topic>', desc)
+  COMMANDS.add_action(HELP_COMMAND)
 end
 
+require_relative 'help/sub_help'
+
 #Load up the extra help actions!
 Dir[Mysh::Action::ACTIONS_PATH + 'help/*.rb'].each {|file| require file }
-