shell_shock 0.0.3 → 0.0.4

data/lib/shell_shock/command_spec.rb

@@ -0,0 +1,11 @@
+module ShellShock
+    module CommandSpec
+      def with_usage text
+        it('should display usage') { @command.usage.should == text }
+      end
+
+      def with_help text
+        it('should display help') { @command.help.should == text }
+      end
+    end
+end

data/lib/shell_shock/context.rb

@@ -1,84 +1,83 @@
 require 'rubygems'
 require 'readline'
+require 'shell_shock/exit_command'
+require 'shell_shock/help_command'
+require 'shell_shock/logger'
 
 module ShellShock
   module Context
+    include Logger
+
+    def head_tail string
+      if string
+        m = /[^ ]+/.match(string.strip)
+        return m[0], m.post_match.strip if m
+      end
+      return '', ''
+    end
+
     def refresh
       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]
+      Readline.completion_proc = lambda do |string|
+        log "trying completion for \"#{string}\""
+        first, rest = head_tail(string)
+        log "split \"#{first}\" from \"#{rest}\""
+        if first
+          command = @commands[first]
           if command
+            log "matched #{first} command"
             if command.respond_to?(:completion)
-              rest = words || []
-              completions = command.completion(rest.join(' ')).map {|c| "#{name} #{c}" }
-              return completions
+              completions = command.completion(rest).map {|c| "#{first} #{c}" }
             else
-              return []
+              log "#{first} has no completion proc"
+              completions = []
             end
           end
         end
 
-        @commands.keys.grep( /^#{Regexp.escape(word)}/ ).sort
+        completions ||= @commands.keys.grep( /^#{Regexp.escape(first)}/ ).sort
+        log "returning #{completions.inspect} completions"
+        completions
       end
     end
 
-    def push
-      refresh
-      begin
-        while line = Readline.readline(@prompt_text, true)
-          line.strip!
-          case line
-            when /^([\w?]+) (.*)/
-              return if ['quit', 'exit'].include?($1)
-              process_command $1, $2
-            when /^([\w?]+)/
-              return if ['quit', 'exit'].include?($1)
-              process_command $1
-            else
-              @io.say "can not process line \"#{line}\""
-          end
-          @io.say
-          refresh
-        end
-      rescue Interrupt => e
-        return
-      end
-      @io.say
+    def abort!
+      @abort = true
     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
-        @io.say "no help available for command \"#{command_name}\""
-      end
+    def abort?
+      @abort
     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      
+    def add_command command, *aliases
+      @commands ||= {}
+      aliases.each {|a| @commands[a] = command}
     end
 
-    def process_command name, parameter=nil
-      if ['?', 'help'].include?(name)
-        process_help parameter
-        return
-      end
-      if @commands[name]
-        @commands[name].execute parameter
-      else
-        @io.say "unknown command \"#{name}\""
+    def push
+      @prompt ||= ' > '
+      add_command HelpCommand.new(@commands), '?', 'help'
+      add_command ExitCommand.new(self), 'exit', 'quit'
+      begin
+        until abort?
+          refresh
+          line = Readline.readline(@prompt, true)
+          if line
+            first, rest = head_tail(line)
+            log "looking for command \"#{first}\" with parameter \"#{rest}\""
+            if @commands[first]
+              @commands[first].execute rest
+            else
+              puts "unknown command \"#{first}\""
+            end
+          else
+            abort!
+          end
+          puts
+        end
+      rescue Interrupt => e
+        puts
       end
     end
   end

data/lib/shell_shock/exit_command.rb

@@ -0,0 +1,15 @@
+module ShellShock
+  class ExitCommand
+    attr_reader :help, :usage
+
+    def initialize context
+      @context = context
+      @usage = ''
+      @help = 'exits the current context'
+    end
+
+    def execute ignore
+      @context.abort!
+    end
+  end  
+end

data/lib/shell_shock/help_command.rb

@@ -0,0 +1,36 @@
+module ShellShock
+  class HelpCommand
+    attr_reader :help, :usage
+
+    def initialize commands
+      @commands = commands
+      @usage = '<command name>'
+      @help = 'displays the help information for a command'
+    end
+
+    def completion text
+      @commands.keys.grep(/^#{Regexp.escape(text)}/).sort
+    end
+
+    def execute command
+      command.empty? ? display_help_for_commands : display_help_for_command(command)
+    end
+
+    def display_help_for_commands
+      return if @commands.keys.empty?
+      puts 'Available commands:'
+      @commands.keys.sort.each { |command| puts command }
+    end
+
+    def display_help_for_command command_name
+      command = @commands[command_name]
+      if command
+        puts "Command \"#{command_name}\""
+        puts "Usage: #{command_name} #{command.usage}" if command.respond_to?(:usage)
+        puts "Help:\n #{command.help}" if command.respond_to?(:help)
+      else
+        puts "unknown command \"#{command_name}\""
+      end
+    end
+  end
+end

data/lib/shell_shock/logger.rb

@@ -0,0 +1,10 @@
+module ShellShock
+    module Logger
+    def log message
+      return unless ENV['LOG_PATH']
+      File.open(ENV['LOG_PATH'], 'a') do |file|
+        file.puts message
+      end
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shell_shock
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Mark Ryall
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-15 00:00:00 +10:00
+date: 2010-10-24 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 49
         segments: 
         - 0
         - 8
@@ -35,16 +38,34 @@ dependencies:
   name: gemesis
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 0
         - 0
-        - 3
-        version: 0.0.3
+        - 4
+        version: 0.0.4
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :development
+  version_requirements: *id003
 description: |
   This is just some code extracted from a few command line gems i've created (shh and cardigan).
   
@@ -58,7 +79,11 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/shell_shock/logger.rb
+- lib/shell_shock/exit_command.rb
+- lib/shell_shock/help_command.rb
 - lib/shell_shock/context.rb
+- lib/shell_shock/command_spec.rb
 - README.rdoc
 - MIT-LICENSE
 has_rdoc: true
@@ -71,23 +96,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: library for creating simple shell applications using readline