shell_shock 0.0.4 → 0.0.5

data/README.rdoc

@@ -14,70 +14,10 @@ A library for creating command line shell application.
 
 == Usage
 
-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.
+The basic idea is that you create classes and include 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.
 
 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.
 
 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
+Refer to the examples directory for some sample shells.

data/example/adventure.rb

@@ -0,0 +1,79 @@
+$: << File.dirname(__FILE__)+'/../lib'
+
+require 'shell_shock/context'
+
+class MoveCommand
+  attr_reader :usage, :help
+
+  def initialize room
+    @room = room
+    @usage = '<direction>'
+    @help = 'moves to the adjoining room in the specified direction'
+  end
+
+  def completion text
+    @room.connections.keys.grep(/^#{text}/).sort
+  end
+
+  def execute direction
+    room = @room.connections[direction]
+    if room
+      AdventureContext.new(room).push
+    else
+      puts "there is no adjoining room to the #{direction}"
+    end
+  end
+end
+
+class AdventureContext
+  include ShellShock::Context
+
+  def initialize room
+    puts room.description
+    @prompt = "#{room.name} > "
+    add_command MoveCommand.new(room), 'go'
+  end
+end
+
+class Room
+  attr_reader :name, :description, :connections
+  def initialize name, description
+    @name, @description = name, description
+    @connections = {}
+  end
+
+  def add direction, room
+    @connections[direction] = room
+  end
+end
+
+START = Room.new 'clearing', <<EOF
+You have entered a clearing.
+
+A dead goat lies on the ground in front of you
+EOF
+
+CAVE_ENTRANCE = Room.new 'cave entrance', <<EOF
+You have arrived at the entrance to a cave.
+
+A foul smell is emitting from the cave. Some smoke
+can be seen off off to the east.
+EOF
+
+CAMP_SITE = Room.new 'camp site', <<EOF
+You have arrived in a camp site.
+
+There is a fire that has been recently put out.
+EOF
+
+CAVE = Room.new 'cave', <<EOF
+You have entered a dark cave.
+
+A faint growling sound can be heard.
+EOF
+
+START.add 'north', CAVE_ENTRANCE
+CAVE_ENTRANCE.add 'east', CAMP_SITE
+CAVE_ENTRANCE.add 'north', CAVE
+
+AdventureContext.new(START).push

data/example/cat.rb

@@ -0,0 +1,66 @@
+require 'shell_shock/context'
+
+class Prompt
+  def say text=nil
+    puts text ? text : ''
+  end
+end
+
+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
+    @io = Prompt.new
+    @prompt_text = "#{path} > "
+    @commands = {
+      'cd' => ChangeDirectoryCommand.new(path),
+      'cat' => CatFileCommand.new(path)
+    }
+  end
+end
+
+DirectoryContext.new('.').push

data/example/file_system.rb

@@ -0,0 +1,95 @@
+$: << File.dirname(__FILE__)+'/../lib'
+
+require 'shell_shock/context'
+require 'find'
+require 'pathname'
+
+class Finder
+  attr_reader :files
+
+  def initialize path
+    @path = path
+  end
+
+  def refresh pattern
+    files = []
+    here = Pathname.new(File.expand_path(@path))
+    Find.find(File.expand_path(@path)) do |p|
+      if File.basename(p).start_with?('.')
+        Find.prune
+      else
+        path = Pathname.new(p).relative_path_from(here).to_s
+        files << path if path.start_with?(pattern) and yield(p)
+      end
+    end
+    files
+  end
+end
+
+class CatFileCommand
+  include ShellShock::Logger
+
+  def initialize path
+    @finder = Finder.new path
+  end
+
+  def usage
+    '<file name>'
+  end
+
+  def help
+    'displays the content of a file'
+  end
+
+  def completion text
+    log { "cat command completing \"#{text}\"" }
+    @finder.refresh(text) {|path| File.file? path }
+  end
+
+  def execute path=nil
+    return unless path
+    File.open(path) {|f| f.each_with_index {|l,i| puts "#{i+1}: #{l}" } }
+  end
+end
+
+class ChangeDirectoryCommand
+  include ShellShock::Logger
+
+  def initialize path
+    @path = path
+    @finder = Finder.new path
+  end
+
+  def usage
+    '<directory name>'
+  end
+
+  def help
+    'switches to a new shell context in the specified directory'
+  end
+
+  def completion text
+    log { "cd command completing \"#{text}\"" }
+    @finder.refresh(text) {|path| path != '.' and File.directory? path }
+  end
+
+  def execute text=nil
+    return unless text 
+    log { "pushing new shell in \"#{text}\"" }
+    DirectoryContext.new(@path+'/'+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

@@ -20,24 +20,24 @@ module ShellShock
       refresh_commands if respond_to?(:refresh_commands)
       Readline.completer_word_break_characters = ''
       Readline.completion_proc = lambda do |string|
-        log "trying completion for \"#{string}\""
+        log { "trying completion for \"#{string}\"" }
         first, rest = head_tail(string)
-        log "split \"#{first}\" from \"#{rest}\""
+        log { "split \"#{first}\" from \"#{rest}\"" }
         if first
           command = @commands[first]
           if command
-            log "matched #{first} command"
+            log { "matched #{first} command" }
             if command.respond_to?(:completion)
               completions = command.completion(rest).map {|c| "#{first} #{c}" }
             else
-              log "#{first} has no completion proc"
+              log { "#{first} has no completion proc" }
               completions = []
             end
           end
         end
 
         completions ||= @commands.keys.grep( /^#{Regexp.escape(first)}/ ).sort
-        log "returning #{completions.inspect} completions"
+        log { "returning #{completions.inspect} completions" }
         completions
       end
     end
@@ -65,7 +65,7 @@ module ShellShock
           line = Readline.readline(@prompt, true)
           if line
             first, rest = head_tail(line)
-            log "looking for command \"#{first}\" with parameter \"#{rest}\""
+            log { "looking for command \"#{first}\" with parameter \"#{rest}\"" }
             if @commands[first]
               @commands[first].execute rest
             else

data/lib/shell_shock/logger.rb

@@ -1,9 +1,10 @@
 module ShellShock
     module Logger
-    def log message
+    def log message=nil
       return unless ENV['LOG_PATH']
       File.open(ENV['LOG_PATH'], 'a') do |file|
-        file.puts message
+        file.puts message if message
+        file.puts yield if block_given?
       end
     end
   end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: shell_shock
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Mark Ryall
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-24 00:00:00 +10:00
+date: 2011-01-10 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 49
         segments: 
         - 0
         - 8
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 0
         - 0
@@ -58,12 +55,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
         segments: 
         - 2
+        - 4
         - 0
-        - 1
-        version: 2.0.1
+        version: 2.4.0
   type: :development
   version_requirements: *id003
 description: |
@@ -79,11 +75,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/shell_shock/logger.rb
+- example/adventure.rb
+- example/cat.rb
+- example/file_system.rb
+- lib/shell_shock/command_spec.rb
+- lib/shell_shock/context.rb
 - lib/shell_shock/exit_command.rb
 - lib/shell_shock/help_command.rb
-- lib/shell_shock/context.rb
-- lib/shell_shock/command_spec.rb
+- lib/shell_shock/logger.rb
 - README.rdoc
 - MIT-LICENSE
 has_rdoc: true
@@ -100,7 +99,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -109,7 +107,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"