shell_shock 0.0.1 → 0.0.2

data/README.rdoc

@@ -14,10 +14,70 @@ A library for creating command line shell application.
 
 == Usage
 
-Here's a sample shell application using shell shock:
+The basic idea is that you create classes with the ShellShock::Context mixin.  Start a shell by instantiating the class and executing the push method.  Any number of nested shells may be pushed and exit falls back to the previous shell.
 
-require '
+These classes represent a shell context with a number of commands registered.  These commands are matched with tab completion.  In addition to registered commands, 'exit', 'quit', 'help' and '?' are always available.
 
-class RootContext
-  
-end
+Each command must have an execute method that accepts a string (the remaining content after the command name).  Commands may also implement usage and help methods.  They may also implement a completion method so may have arbitrarily complex completion rules per parameter.
+
+Here's a sample shell application using shell shock.  It has 'cd' and 'cat' commands.  'cd' performs tab completion for directories and execution enters a nested context.  'cat' performs tab completion for files and execution dumps the file content.
+
+  require 'shell_shock/context'
+
+  class CatFileCommand
+    def initialize path
+      @path = path
+    end
+
+    def usage
+      '<file name>'
+    end
+
+    def help
+      'displays the content of a file'
+    end
+
+    def completion text
+      Dir.glob("#{@path}/#{text}*").select {|f| File.file?(f) }
+    end
+
+    def execute path
+      File.open(path) {|f| f.each_with_index {|l,i| puts "#{i+1}: #{l}" } }
+    end
+  end
+
+  class ChangeDirectoryCommand
+    def initialize path
+      @path = path
+    end
+
+    def usage
+      '<directory name>'
+    end
+
+    def help
+      'switches to a new shell context in the specified directory'
+    end
+
+    def completion text
+      Dir.glob("#{@path}/#{text}*").select {|f| File.directory?(f) }
+    end
+
+    def execute text
+      DirectoryContext.new(text).push
+    end
+  end
+
+  class DirectoryContext
+    include ShellShock::Context
+
+    def initialize path
+      @prompt_text = "#{path} > "
+      @commands = {
+        'cd' => ChangeDirectoryCommand.new(path),
+        'cat' => CatFileCommand.new(path)
+      }
+    end
+  end
+
+  DirectoryContext.new('.').push

data/lib/shell_shock/context.rb

@@ -1,15 +1,28 @@
-require 'readline'
 require 'rubygems'
-require 'active_support/inflector'
+require 'readline'
 
 module ShellShock
   module Context
     def refresh
-      commands = respond_to?(:refresh_commands) ? refresh_commands : []
-      Readline.completion_proc = lambda do |text|
-        (commands + @commands.keys + ['quit', 'exit']).grep( /^#{Regexp.escape(text)}/ ).sort
-      end
+      refresh_commands if respond_to?(:refresh_commands)
       Readline.completer_word_break_characters = ''
+      Readline.completion_proc = lambda do |word|
+        name, *words = word.scan(/[\w?]+/)
+        if name
+          command = @commands[name]
+          if command
+            if command.respond_to?(:completion)
+              rest = words || []
+              completions = command.completion(rest.join(' ')).map {|c| "#{name} #{c}" }
+              return completions
+            else
+              return []
+            end
+          end
+        end
+
+        @commands.keys.grep( /^#{Regexp.escape(word)}/ ).sort
+      end
     end
 
     def push
@@ -18,14 +31,14 @@ module ShellShock
         while line = Readline.readline(@prompt_text, true)
           line.strip!
           case line
-            when 'quit','exit'
-              return
-            when /(\w+) (.*)/
+            when /^([\w?]+) (.*)/
+              return if ['quit', 'exit'].include?($1)
               process_command $1, $2
-            when /(\w+)/
+            when /^([\w?]+)/
+              return if ['quit', 'exit'].include?($1)
               process_command $1
             else
-              puts 'unknown command'
+              puts "can not process line \"#{line}\""
           end
           puts
           refresh
@@ -36,16 +49,36 @@ module ShellShock
       puts
     end
 
+    def display_help_for_command command_name
+      command = @commands[command_name]
+      if command
+        @io.say "Command \"#{command_name}\""
+        @io.say "Usage: #{command_name} #{command.usage}" if command.respond_to?(:usage)
+        @io.say "Help:\n #{command.help}" if command.respond_to?(:help)      
+      else
+        puts "no help available for command \"#{command_name}\""
+      end
+    end
+
+    def process_help command=nil
+      if command
+        display_help_for_command command
+      else
+        @io.say "Available commands:"
+        @commands.keys.sort.each { |command| @io.say command }
+        @io.say
+      end      
+    end
+
     def process_command name, parameter=nil
-      m = "#{name}_command".to_sym
-      if respond_to?(m)
-        send(m, parameter)
+      if ['?', 'help'].include?(name)
+        process_help parameter
         return
-      end 
+      end
       if @commands[name]
         @commands[name].execute parameter
       else
-        @io.say 'unknown command'
+        @io.say "unknown command \"#{name}\""
       end
     end
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Mark Ryall
@@ -14,23 +14,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-11 00:00:00 +10:00
+date: 2010-04-13 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 2
-        - 3
-        - 5
-        version: 2.3.5
-  type: :runtime
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: gemesis
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 3
+        version: 0.0.3
+  type: :development
+  version_requirements: *id002
 description: |
   This is just some code extracted from a few command line gems i've created (shh and cardigan).