command-set 0.8.3 → 0.8.4

data/doc/GUIDED_TOUR

@@ -0,0 +1,24 @@
+The quickest way to get a handle on what CommandSet can do for you is to
+look at the various pieces and get a handle on how they work together.
+
+The rough sketch is that you enumerate a series of commands, which you then 
+feed to an interpreter.  The interpreter will set you up with a template for 
+your porgram's subject, which you fill in with some defaults.  Then, give 
+the filled in subject back to the interpreter and let it run.
+
+Here's the appropriate places to get started:
+
+0. DSL (Read thoroughly - especially the sub modules)
+0. BaseInterpreter#subject_template
+0. BaseInterpreter#subject=
+0. TextInterpreter#go
+
+A couple of handy tricks can be found at
+
+0. BaseInterpreter#process_input
+0. StandardCommands
+0. QuickInterpreter
+
+More advanced stuff that worth learning once your app is off the ground:
+
+0. Results

data/doc/Specifications

@@ -1,4 +1,9 @@
 
+CommandSet::require_commands
+- should absorb commands from a module
+- should absorb a single command from a module
+- should fail when module doesn't define commands
+
 Empty command set
 - should_not be nil
 - should be a CommandSet
@@ -23,6 +28,7 @@ Command::DSL::Argument
 - should raise a typeerror on an unhandled type
 - should raise ArgumentError with missing based_on
 - should decorate arguments as optional
+- should document it's own commands
 
 A NumberArgument
 - should complete arguments in range
@@ -32,20 +38,32 @@ A NumberArgument
 - should not validate non-numeric input
 - should consume arguments properly
 
-A FileArgument
+Command::FileArgument
 - should complete with me
+- should complete with relative path
+- should complete with relative dir
+- should complete at root dir
 - should complete with list if prefix empty
 - should validate me
 - should validate absolute paths
 - should not validate garbage
 - should not validate directory
 
+Command::FileArgument
+- should be able to create with a block
+
 A ArrayArgument
 - should consume legitimate values
 
+Command::RestOfLineArgument
+- should consume the rest of the line
+
 A MultiArgument
 - Should consume what it can, and put the rest back
 
+Command::Repeating
+- should eat many terms, but not all
+
 Command::AlternatingArgument
 - should consume to array
 - should consume to number
@@ -77,12 +95,22 @@ Command::TextInterpreter
 
 Command::TextInterpreter all set up
 - should complete words in the commmand-line
-- should process a command-line
+- should fail on missing commands on the commmand-line
+- should fail on ambiguous commands on the commmand-line
+- should complete words from user
+- should process a single command-line
+- should process commands from user
+- should prompt the user and return their answer
 
 Command::TextInterpreter with a command with a named argument
 - should complete words in the commmand-line
 - should process a command-line
 
+Command::TextInterpreter with serious problems
+- should ask the user to quit instead of Ctrl-C
+- should catch command errors and continue
+- should catch exceptions and quit
+
 A fresh Subject
 - should allow a field to be required
 - should allow multiple fields to be required
@@ -149,10 +177,6 @@ Command::Results::Formatter
 - should mark up items as directed by Command#format_advice
 
 Command::Results::StrategyFormatter
-1
-Two
-Whoa!
-missing
 - should
 
 A command set with the Set command
@@ -176,6 +200,12 @@ A CommandSet with Help
 - should gracefully recover if a command has nil documentation
 - should cope with nil command names in full help listing
 
+#<Command::CommandSet:0xb75fe940>
+- should enter and leave a mode
+
+Command::StandardCommand::Resume
+- should pause and resume
+
 Command::OutputStandin undispatched
 - should return the base IO from getobj
 - should pass puts unmolested
@@ -214,6 +244,18 @@ Command::Results::Presenter driving a Formatter
 Command::Results::Presenter driving a strict Formatter
 - should send notifications in correct order
 
-Finished in 0.24242 seconds
+Command::Results::XMLFormatter
+- should format two lists
+
+Command::Results::StrategyFormatter with indent strategy
+- should format two lists
+
+Command::Results::StrategyFormatter with chatty strategy
+- should format two lists
+
+Command::Results::StrategyFormatter with progress strategy
+- should format two lists
+
+Finished in 0.304894 seconds
 
-137 examples, 0 failures
+161 examples, 0 failures

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

@@ -94,7 +94,7 @@ Command::wrap_stdout
 #  automatically gets a command line version, for testing or administrator's
 #  convenience.
 #
-#:include: GUIDED_TOUR
+#:include: doc/GUIDED_TOUR
 module Command
   class CommandError < ScriptError; end
   class CommandException < StandardError

data/lib/command-set/command.rb

@@ -246,23 +246,6 @@ module Command
         optional.argument(arg, values, &get_values)
       end
 
-      def optional_arguments(name, &block)
-        optional.multiword_argument(name, block)
-      end
-
-      def no_more_required_arguments(*args) #:nodoc:
-        raise NoMethodError, "Can't define required arguments after optionals"
-      end
-      private :no_more_required_arguments
-
-      def stop_requireds #:nodoc:
-        class << self
-          alias_method :argument, :no_more_required_arguments
-          def stop_requireds
-          end
-        end
-      end
-      private :stop_requireds
     end
 
     extend DSL::CommandDefinition
@@ -282,7 +265,7 @@ module Command
       @validation_problem = CommandException.new("No arguments provided!")
       @last_completed_task = DontResume
       @resume_from = resume
-      @main_collector = collector
+      @main_collector = nil
     end
 
     attr_reader :arg_hash
@@ -443,9 +426,6 @@ module Command
       return nil
     end
 
-    def collector
-    end
-
     def validate_arguments
       raise @validation_problem if Exception === @validation_problem
       required_arguments.each do |argument|

data/lib/command-set/dsl.rb

@@ -418,6 +418,15 @@ Action:: utility functions within the command action block
       def item(name, options={})
         @main_collector.item(name, options)
       end
+
+      #This returns a new Results::Collector, which can allow for some very
+      #sophisticated command output.  Specifically, it can allow a command
+      #to loop over a large amount of data once, depositing output in
+      #multiple lists at once, for instance a status list (with hashmarks)
+      #and results(with useful data) list.
+      def sub_collector
+        @main_collector.dup
+      end
     end
 
     #The methods available within the DSL::CommandDefinition#action method
@@ -514,15 +523,6 @@ Action:: utility functions within the command action block
         raise CommandException, "#{@name} cannot be undone"
       end   
 
-      #This returns a new Results::Collector, which can allow for some very
-      #sophisticated command output.  Specifically, it can allow a command
-      #to loop over a large amount of data once, depositing output in
-      #multiple lists at once, for instance a status list (with hashmarks)
-      #and results(with useful data) list.
-      def sub_collector
-        @main_collector.dup
-      end
-
       #This method is deprecated but remains as a nicety.  As it stands, any
       #command can be interrupted at the command line with Ctrl-C, and
       #return to the prompt.

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

@@ -248,9 +248,9 @@ module StdCmd
     @@set = nil
     def self.define_commands
       return @@set ||= Command::CommandSet.define_commands do
-        include_commands Quit
-        include_commands Undo
-        include_commands Help
+        require_commands Quit
+        require_commands Undo
+        require_commands Help
       end
     end
   end

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

@@ -79,6 +79,10 @@ module Command
          end
 
          line = readline(get_prompt, true)
+         if line.nil?
+           puts
+           break
+         end
          next if line.empty?
          process_line(line)
        rescue Interrupt
@@ -89,7 +93,9 @@ module Command
          output_exception("Exception", e)
          pause_before_dying
        ensure
-         set_readline_completion(&old_proc)
+         unless old_proc.nil?
+           set_readline_completion(&old_proc)
+         end
        end until @stop
      end
 
@@ -204,7 +210,7 @@ module Command
      protected
      def set_readline_completion(&block)
        old_proc = Readline.completion_proc
-       Readline.completion_proc = block
+       Readline.completion_proc = proc &block
        return old_proc
      end
 

metadata

@@ -3,12 +3,12 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: command-set
 version: !ruby/object:Gem::Version 
-  version: 0.8.3
-date: 2007-12-19 00:00:00 -08:00
+  version: 0.8.4
+date: 2007-12-20 00:00:00 -08:00
 summary: Framework for interactive programs focused around a DSL for commands
 require_paths: 
 - lib
-email: judson@redfivellc.com
+email: nyarly@gmail.com
 homepage: 
 rubyforge_project: 
 description: CommandSet is a interactive program framework.  Its focus is a DSL for defining commands, much like Rake or RSpec.  The actual interpreter is left as an open question, although a default readline based terminal interpreter is included, it could very well be adapted to interact with CGI or a GUI.
@@ -45,6 +45,7 @@ files:
 - lib/command-set/quick-interpreter.rb
 - lib/command-set/batch-interpreter.rb
 - doc/README
+- doc/GUIDED_TOUR
 - doc/Specifications
 - doc/argumentDSL
 test_files: []
@@ -55,8 +56,11 @@ rdoc_options:
 - --main
 - Command
 - --title
-- command-set-0.8.3 RDoc
+- command-set-0.8.4 RDoc
 extra_rdoc_files: 
+- doc/README
+- doc/GUIDED_TOUR
+- doc/Specifications
 - doc/argumentDSL
 executables: []