command-set 0.8.2 → 0.8.3

data/doc/argumentDSL

@@ -14,6 +14,8 @@ For instance
 
 Decorator methods, and the classes they add:
 
++repeating+:: Repeating
++many+:: Repeating
 +multi+:: AlternatingArgument
 +named+:: Named
 +optional+:: Optional

data/lib/command-set/arguments.rb

@@ -153,7 +153,7 @@ module Command
     register "regex"
 
     def initialize(name, regex)
-      @name = name
+      super(name)
       @regex = regex
     end
 
@@ -203,26 +203,30 @@ module Command
       end
     end
 
+    def fs
+      File::Separator
+    end
+
     def complete(prefix, subject)
       list = []
       search_path = @options[:dirs].dup
       match = %r{^#{Regexp.escape(prefix)}.*}
       infix = "" 
 
-      if( not (m = %r{^/([^/]*)$}.match(prefix)).nil? )
-	infix = "/"
-	search_path = ["/"]
-	match = /^#{m[1]}.*/
-      elsif( not (m = %r{^/(.*/)([^/]*)$}.match(prefix)).nil? )
+      if( not (m = %r{^#{fs}([^#{fs}]*)$}.match(prefix)).nil? )
+	infix = fs
+	search_path = [fs]
+	match = %r{^#{m[1]}.*}
+      elsif( not (m = %r{^#{fs}(.*#{fs})([^#{fs}]*)$}.match(prefix)).nil? )
 	infix = "/#{m[1]}"
 	match = /^#{m[2]}.*/
 	search_path = [infix]
-      elsif( %r{/$} =~ prefix )
+      elsif( %r{#{fs}$} =~ prefix )
 	infix = prefix
 	search_path.map! {|path| File.join(path, prefix)}
 	match = /.*/
-      elsif( %r{/} =~ prefix )
-	infix = File.dirname(prefix) + "/"
+      elsif( %r{#{fs}} =~ prefix )
+	infix = File.dirname(prefix) + "#{fs}"
 	search_path.map! {|path| File.join(path, infix)}
 	match = %r{^#{Regexp.escape(File.basename(prefix))}.*}
       end
@@ -245,7 +249,7 @@ module Command
 	      end
 
 	      if(File.directory?(candidate))
-		path += "/"
+		path += fs
 	      end
 
 	      list << infix + path
@@ -256,7 +260,7 @@ module Command
 	end
       end
 
-      if(list.length == 1 && list[0] =~ /\/$/)
+      if(list.length == 1 && list[0] =~ %r{#{fs}$})
 	list << list[0] + "."
       end
 
@@ -264,7 +268,7 @@ module Command
     end
 
     def validate(term, subject)
-      if(%r{^/} =~ term)
+      if(%r{^#{fs}} =~ term)
 	return @acceptor[term]
       end
 
@@ -493,6 +497,53 @@ module Command
     end
   end
 
+  #Consumes several positions of the decorated argument.
+  #  repeating.file_argument :some_files
+  #
+  #Will collect an array into +some_files+ of validated files.
+  class Repeating < ArgumentDecorator
+    register "repeating"
+    register "many"
+
+    decoration do
+      def consume_hash(subject, hash)
+        term = hash[@name]
+        return {} if term.nil?
+
+        term = [*term]
+        if term.find{|it| not validate(it, subject)}
+          raise ArgumentInvalidException, {@name => term}
+        else
+          return {@name => term.map{|it| parse(subject,it)}}
+        end
+      end
+
+      def consume(subject, arguments)
+        value = []
+        until arguments.empty? do
+          trying = arguments.shift
+          if(validate(trying, subject))
+            value << parse(subject,trying)
+          else
+            arguments.unshift(trying)
+            break
+          end
+        end
+        return {@name => value}
+      end
+
+      def match_terms(subject, terms, arguments)
+        validated = validate(terms.first, subject)
+        if(validated)
+          terms.shift
+        else
+          arguments.shift
+        end
+        return true
+      end
+    end
+  end
+
   #Allows several arguments to share a position.  Pass a block to the
   #"decorator" method with the argument declarations inside.  The first
   #argument that can parse the input will be assigned - others will get nil.

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

@@ -97,7 +97,7 @@ Command::wrap_stdout
 #:include: GUIDED_TOUR
 module Command
   class CommandError < ScriptError; end
-  class CommandException < RuntimeError
+  class CommandException < StandardError
     def initialize(msg=nil)
       super
       @raw_input = nil
@@ -165,7 +165,7 @@ module Command
       #creating the command set.  You can even call
       #DSL::CommandSetDefinition#define_commands on the set that's returned
       #in order to add one-off commands or fold in other command sets.
-      def require_commands(mod, file, cmd_path=[])
+      def require_commands(mod, file=nil, cmd_path=[])
         set = self.new
         set.require_commands(mod, file, cmd_path)
         return set
@@ -177,14 +177,6 @@ module Command
     #:section: Workhorse methods - not usually used by client code
     #
 
-    def paths_update(command, name)
-      command.add_path(self, [], name)
-
-      @paths.each do |set, path|
-        command.add_path(set, path, name)
-      end
-    end
-
     def get_root
       command = @command_list[nil]
     end
@@ -283,14 +275,6 @@ module Command
 
     alias short_docs documentation
 
-    def instance(subject)
-      if @command_list.has_key?(nil)
-	return @command_list[nil].new(subject)
-      else
-	raise CommandException, "incomplete command"
-      end
-    end
-
     def command_list
       return @command_list.dup
     end

data/lib/command-set/command.rb

@@ -88,7 +88,7 @@ module Command
   #An overworked exception class.  It captures details about the command
   #being interrupted as it propagates up the stack.
   class ResumeFrom < ::Exception; 
-    def initialize(pause_deck = nil, msg = "")
+    def initialize(pause_deck, msg = "")
       super(msg)
       @setup = CommandSetup.new
       @pause_deck = pause_deck
@@ -161,12 +161,9 @@ module Command
       end
 
       def inspect
-        arguments = []
-        [required_argument_list, optional_argument_list].each do |list|
-          next if list.nil?
-          list.each do |argument|
-            arguments << argument.name
-          end
+        arguments = argument_list.map{|arg| arg.name}
+        argument_list.each do |argument|
+          arguments << argument.name
         end
         return "#<Class:#{self.object_id} - Command:#{path().join(" ")}(#{arguments.join(", ")})>"
       end
@@ -272,6 +269,8 @@ module Command
     extend DSL::Argument
     include DSL::Action
 
+    class DontResume; end
+
     def initialize(subject, resume=nil)
       raise CommandException, "#{@name}: unrecognized command" unless self.class.defined?
       fields = subject_requirements || []
@@ -281,7 +280,7 @@ module Command
       @arg_hash = {}
       @should_undo = true
       @validation_problem = CommandException.new("No arguments provided!")
-      @last_completed_task = nil
+      @last_completed_task = DontResume
       @resume_from = resume
       @main_collector = collector
     end
@@ -314,7 +313,7 @@ module Command
 
     def inspect
       name = self.class.name
-      return "#<Command:#{name}>:#{self.object_id} #{@arg_hash.inspect}"
+      return "#<Command:#{name}>:#{self.object_id} #{@arg_hash.keys.inspect}"
     end
 
     def parent
@@ -322,6 +321,7 @@ module Command
     end
 
     def go(collector)
+      return if @resume_from == DontResume
       unless self.respond_to? :execute
         raise CommandException, "#{@name}: command declared but no action defined" 
       end
@@ -336,6 +336,8 @@ module Command
         puts "Command cancelled"
       rescue ResumeFrom => rf
         rf.setup.task_id = @last_completed_task
+        rf.setup.command = self.class
+        rf.setup.args_hash = arg_hash.dup
         raise rf
       end
     end

data/lib/command-set/dsl.rb

@@ -47,14 +47,23 @@ Action:: utility functions within the command action block
       #from it.
       def require_commands(module_name, file = nil, path = [], *commands)
         require file rescue nil
-        module_path = module_name.to_s.split("::")
-        mod = Object
-        module_path.each do |part|
-          mod = mod.const_get(part)
+
+        if Module === module_name
+          mod = module_name
+        else
+          module_path = module_name.to_s.split("::")
+          mod = Object
+          module_path.each do |part|
+            mod = mod.const_get(part)
+          end
         end
 
         set = mod.define_commands
-        set = set.find_command(*path)
+        unless CommandSet === set
+          raise RuntimeError,"#{set.inspect} isn't a CommandSet"
+        end
+
+        set = set.find_command(*path).first
 
         if CommandSet === set
           include_commands(set, *commands)
@@ -520,37 +529,6 @@ Action:: utility functions within the command action block
       def interruptable
         yield
       end
-
-      #These methods are nodoc'd because at present, they don't work.
-      #They'd be awesome for big jobs - splitting them into subthreads and
-      #such.  But they need to be debugged, and IIRC there's a deadlock
-      #condition
-      def action_thread(&block) #:nodoc:
-        return Thread.new do
-          collector = sub_collector
-          $stdout.set_thread_collector(collector)
-          block.call
-          $stdout.remove_thread_collector(collector)
-        end
-      end
-
-      require 'thwait'
-      def farm_out(array, thread_count, &block) #:nodoc:
-        first_batch = (array[0...thread_count]||[]).map do |item|
-          action_thread { block.call(item) }
-        end
-
-        rest = (array[thread_count..-1] || [])
-
-        waiter = ThreadsWait.new(*first_batch)
-
-        rest.each do |item|
-          waiter.next_wait
-          waiter.join_nowait(action_thread{block.call(item)})
-        end
-
-        waiter.join
-      end
     end
   end
 end

data/lib/command-set/interpreter.rb

@@ -11,7 +11,7 @@ module Command
   #instance, must implement #cook_input(raw) that converts raw input (of 
   #whatever form is appropriate to the interpreter) into CommandSetup
   #objects.  Other methods can be overridden - especially consider
-  # #get_formatter, #prompt_user, and #assign_terms
+  # #get_formatter, and #prompt_user
   class BaseInterpreter
     attr_accessor :command_set, :out_io, :logger
     attr_reader :subject
@@ -41,6 +41,12 @@ module Command
       @subject = subject
     end
 
+    def fill_subject
+      template = subject_template
+      yield template
+      self.subject=(template)
+    end
+
     #Any options that the interpreter might have can be set by passing a
     #hash to behavior to be merged with the defaults
     def behavior(hash)

data/lib/command-set/results.rb

@@ -622,8 +622,8 @@ module Command
         @strategy_stack = [@strategies[:default]]
       end
 
-      def_delegators :current_strategy, :saw_begin_list, :saw_item, :saw_end_list, 
-        :closed_begin_list, :closed_item, :closed_end_list
+      def_delegators :current_strategy, :saw_begin_list, :saw_item, 
+        :saw_end_list, :closed_begin_list, :closed_item, :closed_end_list
 
       def current_strategy
         @strategy_stack.last

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

@@ -71,46 +71,43 @@ module Command
          raise "command_set or subject unset!"
        end
 
-       Readline.completion_proc = lambda do |prefix|
-         parsed_input = Readline.line_buffer.split(" ")
-         unless prefix.empty?
-           parsed_input.pop
-         end
-
-         list = current_command_set.completion_list(parsed_input, 
-                                                    prefix, build_subject)
-         list
-       end
-
        @stop = false
 
        begin
-         line = Readline.readline(get_prompt, true)
+         old_proc = set_readline_completion do |prefix|
+           readline_complete(Readline.line_buffer, prefix)
+         end
+
+         line = readline(get_prompt, true)
          next if line.empty?
          process_line(line)
        rescue Interrupt
-         puts "Interrupt: please use \"quit\""
+         @out_io.puts "Interrupt: please use \"quit\""
        rescue CommandException => ce
-         @out_io.puts "Error: " + ce.message
-         @out_io.puts ce.backtrace if @behavior[:debug_commands]
-         logger.warn ce.message
-         ce.backtrace.each do |line|
-           logger.debug line
-         end
-
+         output_exception("Error", ce)
        rescue Exception => e
-         @out_io.puts "Exception: " + e.message
-         @out_io.puts e.backtrace.join("\n") if @behavior[:debug_commands]
-         logger.warn e.message
-         e.backtrace.each do |line|
-           logger.debug line
-         end
-         puts "Waiting for return"
-         $stdin.gets
-         @stop = true
+         output_exception("Exception", e)
+         pause_before_dying
+       ensure
+         set_readline_completion(&old_proc)
        end until @stop
      end
 
+     def output_exception(label, ex)
+       @out_io.puts label + ": " + ex.message
+       @out_io.puts ex.backtrace.join("\n") if @behavior[:debug_commands]
+       logger.warn ex.message
+       ex.backtrace.each do |line|
+         logger.debug line
+       end
+     end
+
+     def pause_before_dying
+       puts "Waiting for return"
+       $stdin.gets
+       stop
+     end
+
      def cook_input(line)
        line = split_line(line)
        if(@complete_line)
@@ -124,13 +121,6 @@ module Command
        return CommandSetup.new(line)
      end
 
-     def assign_terms(cmd)
-       terms = super
-       unless terms.empty?
-         puts "(Discarding extraneous: #{terms.join(" ")}"
-       end
-     end
-
      alias single_command process_input
      alias process_line process_input
 
@@ -150,6 +140,16 @@ module Command
        end
      end
 
+     def readline_complete(buffer, prefix)
+       parsed_input = split_line(buffer)
+       unless prefix.empty?
+         parsed_input.pop
+       end
+
+       return current_command_set.completion_list(parsed_input, 
+                                                  prefix, build_subject)
+     end
+
      def split_line(line)
        line_array = []
        scanner = StringScanner.new(line)
@@ -198,7 +198,18 @@ module Command
      end
 
      def prompt_user(message)
-       Readline.readline(message)
+       readline(message)
+     end
+
+     protected
+     def set_readline_completion(&block)
+       old_proc = Readline.completion_proc
+       Readline.completion_proc = block
+       return old_proc
+     end
+
+     def readline(prompt, something=false)
+       return Readline.readline(prompt, something)
      end
    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.8.2
-date: 2007-12-13 00:00:00 -08:00
+  version: 0.8.3
+date: 2007-12-19 00:00:00 -08:00
 summary: Framework for interactive programs focused around a DSL for commands
 require_paths: 
 - lib
@@ -55,7 +55,7 @@ rdoc_options:
 - --main
 - Command
 - --title
-- command-set-0.8.2 RDoc
+- command-set-0.8.3 RDoc
 extra_rdoc_files: 
 - doc/argumentDSL
 executables: []