command-set 0.10.0 → 0.10.1

data/lib/command-set/command-set.rb

@@ -155,8 +155,8 @@ module Command
     def initialize(name="")
       @name = name
       @command_list = { nil => RootCommand.setup(self, nil) {} }
+      @mode_commands = {}
       @included_sets = []
-      @subject_template = nil
       @documentation = ""
       @prompt = nil
       @arguments = []
@@ -220,12 +220,18 @@ module Command
       @command_list.each_pair do |term, command|
         command.each_command(path + [term], visitor)
       end
+      return unless path.empty?
+      @mode_commands.each_pair do |term, command|
+        command.each_command([term], visitor)
+      end
     end
 
     def root_visit(terms, visitor)
       next_hop = if(terms.empty?)
                    visitor.set_out_of_terms(self)
                    @command_list[nil]
+                 elsif(visitor.command_path.empty?)
+                   @mode_commands[terms.first] || @command_list[terms.first]
                  else
                    @command_list[terms.first]
                  end
@@ -307,10 +313,35 @@ module Command
 
     alias short_docs documentation
 
+    def build_command(home, name_or_class, name_or_nil, block)
+      if Class === name_or_class && Command > name_or_class
+        if block.nil?
+          command = name_or_class.dup
+          name = command.name
+        else
+          name = name_or_nil.to_s
+          command = name_or_class.setup(self, name, &block)
+        end
+      else
+        if String === name_or_class or Symbol === name_or_class
+          name = name_or_class.to_s
+        else
+          raise RuntimeError, "#{name_or_class} is neither a Command class nor a name!"
+        end
+        command = Command.setup(name, &block)
+      end
+
+      home[name] = command
+    end
+
     def command_list
       return @command_list.dup
     end
 
+    def mode_commands
+      return @mode_commands.dup
+    end
+
     def command_names
       return @command_list.keys.compact
     end

data/lib/command-set/command.rb

@@ -33,51 +33,6 @@ module Command
     end
   end
 
-=begin
-  #An abstraction of the lifecycle of a command.  Allows invocations to be
-  #postponed temporarily, or for the command to be instantiated and still
-  #passed around.  Client code should almost never need to see this class,
-  #so the methods aren't individually documented.
-  class CommandSetup
-    def initialize(cmd = [], args = {})
-      @task_id = nil
-      @args_hash = args
-      @terms = []
-      @command = cmd
-      @execution_context = nil
-    end
-
-    attr_accessor :task_id, :command, :args_hash, :terms
-
-    def class_resolution(command_set, path, subject)
-      return command_set.process_terms(path, subject)
-    end
-
-    def resolve_command_class(command_set, subject)
-      if @execution_context.nil? && Class === @command && Command > @command
-        @execution_context = TermProcessor.new(subject)
-      else
-        command_path = @command
-        @execution_context = class_resolution(command_set, 
-                                              command_path, 
-                                              subject)
-        @command = @execution_context.command_class
-        @args_hash = @execution_context.arg_hash.merge(@args_hash)
-        @terms = command_path
-      end
-
-      return @command
-    end
-
-    def command_instance(command_set, subject)
-      command_class = resolve_command_class(command_set, subject)
-      command = command_class.new(@execution_context, task_id)
-      command.consume_hash(@args_hash)
-      return command
-    end
-  end
-=end
-
   class AnchoredCommandSetup < CommandSetup
     def initialize(command_set, cmd = [], args = {})
       super(cmd, args)

data/lib/command-set/dsl.rb

@@ -21,6 +21,7 @@ Action:: utility functions within the command action block
       #the new commands.
       def include_commands(set, *commands)
         new_commands = set.command_list
+        new_mode_commands = set.mode_commands
         options = Hash === commands.first ? commands.shift : {}
 
         commands.map!{|c| c.to_s}
@@ -28,9 +29,12 @@ Action:: utility functions within the command action block
           new_commands.delete_if do |name,command|
             not commands.include? name
           end
+          new_mode_commands.delete_if do |name, command|
+            not commands.include? name
+          end
         end
 
-        unless new_commands.empty?
+        unless new_commands.empty? and new_mode_commands.empty?
           @included_sets << [set, options]
         end
 
@@ -44,13 +48,17 @@ Action:: utility functions within the command action block
             next unless CommandSet === command
             @command_list[name].include_commands(command)
           else
-            @command_list[name] = command.clone
+            @command_list[name] = command
           end
           unless(options[:context].nil?)
             @command_list[name] = ContextBoundary.new(@command_list[name], 
                                                      options[:context])
           end
         end
+
+        new_mode_commands.each_pair do |name, command|
+          @mode_commands[name] = command
+        end
       end
 
       #If you've got a file dedicated to a set of commands, (and you really
@@ -96,32 +104,28 @@ Action:: utility functions within the command action block
       #  be a subclass of the class you passed in, which is great for a
       #  series of related commands.
       def command(name_or_command_class, name_or_nil=nil, &block)
-        @subject_template = nil
-
-        if Class === name_or_command_class && Command > name_or_command_class
-          if block.nil?
-            command = name_or_command_class.dup
-            name = command.name
-          else
-            name = name_or_nil.to_s
-            command = name_or_command_class.setup(self, name, &block)
-          end
-        elsif name_or_command_class.nil?
+        if name_or_command_class.nil?
           command = @command_list[nil]
           command.instance_eval(&block)
           return
         else
-          if String === name_or_command_class or Symbol === name_or_command_class
-            name = name_or_command_class.to_s
-          else
-            raise RuntimeError, "#{name_or_command_class} is neither a Command class nor a name!"
-          end
-          command = Command.setup(name, &block)
+          build_command(@command_list, name_or_command_class, 
+                        name_or_nil, block)
+        end
+      end
+
+      def command_alias(name, command)
+        if Array === command
+          command = find_command(command)
         end
 
         @command_list[name] = command
       end
 
+      def mode_command(name_or_class, name_or_nil=nil, &block)
+        build_command(@mode_commands, name_or_class, name_or_nil, block)
+      end
+
       #Defines a nested CommandSet.  Commands within the nested set will be
       #referenced by preceding them with the name of the set.
       #DSL::CommandSetDefinition will be available within the block to be
@@ -606,6 +610,14 @@ Action:: utility functions within the command action block
         subject.chain_of_command.unshift(setup)
       end
 
+      def up(levels = 1)
+        return @nesting[-(levels+1)]
+      end
+
+      def root
+        return @nesting[0]
+      end
+
       #:section: Miscellany 
 
       #Not normally called from within an #action block, this provides the

data/lib/command-set/interpreter/base.rb

@@ -14,7 +14,7 @@ module Command
   # #get_formatter, and #prompt_user
   class BaseInterpreter
     attr_accessor :out_io, :logger
-    attr_reader :subject, :command_set
+    attr_reader :subject, :command_set, :sub_modes
 
     def initialize
       @command_set=nil
@@ -51,7 +51,6 @@ module Command
       @subject = subject
     end
 
-
     def command_set=(set)
       @command_set = set
       @subject = prep_subject(get_subject)
@@ -79,13 +78,13 @@ module Command
         raise RuntimeError, "Sub-modes must be CommandSets!" 
       end
 
-      @sub_modes.push([mode, mode.most_recent_args, nesting])
+      sub_modes.push([mode, mode.most_recent_args, nesting])
       return nil
     end
 
     #  The compliment to #push_mode.  Removes the most recent command set.
     def pop_mode
-      @sub_modes.pop
+      sub_modes.pop
       return nil
     end
 
@@ -94,8 +93,8 @@ module Command
     #If your interpreter needs extra fields in the subject, alter
     #subject_requirements to return an array of those fields.
     def subject_requirements
-      return [:undo_stack, :interpreter_behavior, 
-        :chain_of_command, :pause_decks]
+      return [:undo_stack, :interpreter, :interpreter_behavior, 
+        :chain_of_command, :pause_decks, :mode_stack]
     end
 
     def get_subject
@@ -109,9 +108,11 @@ module Command
       @command_set.add_defaults(subject)
       subject.required_fields(subject_requirements())
       subject.undo_stack = @undo_stack
+      subject.interpreter = self
       subject.interpreter_behavior = @behavior
       subject.chain_of_command = @commands_pending
       subject.pause_decks = @pause_decks
+      subject.mode_stack = @sub_modes
       return subject
     end
 

data/lib/command-set/interpreter/text.rb

@@ -2,6 +2,7 @@ require 'readline'
 require 'command-set'
 require 'dl/import'
 require 'command-set/interpreter/base'
+require 'command-set/formatter/strategy'
 
 #This really locks text-interpreter down to Linux, maybe Unix-like
 #platforms, I'm thinking.  A more flexible way of doing this would rock,

data/lib/command-set/results.rb

@@ -394,7 +394,3 @@ module Command
   end
 end
 
-#TODO migrate these requires to only where they're needed
-require 'command-set/formatter/base'
-require 'command-set/formatter/strategy'
-require 'command-set/formatter/xml'

data/lib/command-set/standard-commands.rb

@@ -84,7 +84,7 @@ module StdCmd
     @@set = nil
     def self.define_commands
       return @@set ||= Command::CommandSet.define_commands do
-        command Command::StandardCommand::Quit
+        mode_command Command::StandardCommand::Quit
       end  
     end
 
@@ -94,7 +94,7 @@ module StdCmd
     @@set = nil
     def self.define_commands
       return @@set ||= Command::CommandSet.define_commands do
-        command("undo") do
+        mode_command("undo") do
           doesnt_undo
           action do
             command=subject.undo_stack.get_undo
@@ -108,7 +108,7 @@ module StdCmd
         EOH
         end
 
-        command("redo") do
+        mode_command("redo") do
           doesnt_undo
           action do
             command=subject.undo_stack.get_redo
@@ -137,7 +137,7 @@ module StdCmd
           end
         end
 
-        command(:exit) do
+        mode_command(:exit) do
           subject_methods :interpreter
           doesnt_undo
 

data/lib/command-set/structural.rb

@@ -66,7 +66,7 @@ module Command
     end
 
     def term_without_hop(terms, node)
-      raise CommandException, "No such command #{terms.first}"
+      raise CommandException, "#{@command_path.join(" ")}: No such command #{terms.first}"
     end
   end
 
@@ -81,7 +81,6 @@ module Command
       @set_nesting = []
     end
 
-    
     attr_accessor :arg_hash, :terms, :subject, 
       :task_id, :command_class, :set_nesting
 
@@ -100,7 +99,7 @@ module Command
 
     def term_without_hop(terms, node)
       if CommandSet === node
-        raise CommandException, "No such command: #{terms.first}"
+        raise CommandException, "#{@command_path.join(" ")}: No such command: #{terms.first}"
       end
     end
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: command-set
 version: !ruby/object:Gem::Version 
-  version: 0.10.0
-date: 2008-02-06 00:00:00 -08:00
+  version: 0.10.1
+date: 2008-02-12 00:00:00 -08:00
 summary: Framework for interactive programs focused around a DSL for commands
 require_paths: 
 - lib
@@ -61,7 +61,7 @@ rdoc_options:
 - --main
 - Command
 - --title
-- command-set-0.10.0 RDoc
+- command-set-0.10.1 RDoc
 extra_rdoc_files: 
 - doc/README
 - doc/GUIDED_TOUR