command-set 0.8.0

data/doc/README

@@ -0,0 +1,2 @@
+== This is a Really Cool Ruby Thing
+=== ( That deserves better documentation than this. )

data/doc/Specifications

@@ -0,0 +1,219 @@
+
+Empty command set
+- should_not be nil
+- should be a CommandSet
+
+A CommandSet without a root command
+- should fail on missing commands
+
+An established command set
+- should add all properties to subject
+- should return Command class on configured classes
+- should find the root command with an argument
+- should return subcommands
+- should accept new commands in a subcommand
+- should add Command objects
+- should have Commands that know their own paths
+
+Command::DSL::Argument
+- should create an ArrayArgument from an array
+- should create a StringArgument from a string
+- should create a ProcArgument from a proc
+- should create a NumberArgument from a range
+- should raise a typeerror on an unhandled type
+- should raise ArgumentError with missing based_on
+- should decorate arguments as optional
+
+A NumberArgument
+- should complete arguments in range
+- should validate zero
+- should validate numbers
+- should not validate numbers out of range
+- should not validate non-numeric input
+- should consume arguments properly
+
+A FileArgument
+- should complete with me
+- should complete with list if prefix empty
+- should validate me
+- should validate absolute paths
+- should not validate garbage
+- should not validate directory
+
+A ArrayArgument
+- should consume legitimate values
+
+A MultiArgument
+- Should consume what it can, and put the rest back
+
+Command::AlternatingArgument
+- should consume to array
+- should consume to number
+- should raise with invalid arguments
+
+Command::AlternatingArgument with reused subargument names
+- should consume to array
+- should consume to number
+- should raise with invalid arguments
+
+Command::CommandSetup
+- should create Command from complete path
+- should create Command from command path and arg hash
+- should create Command from command path and arg hash (string keys)
+- should create Command from incomplete path and arg hash
+- should create Command from class and arg hash
+
+Command::TextInterpreter
+- should verify and return the subject that it's passed
+- should set up and verify an actual subject
+- should return the same command_set it's assigned
+- should raise Runtime Error if told to start without subject
+- should split line at spaces
+- should split around quoted strings
+- should not split escaped spaces
+- should safely absorb wrapping spaces
+- should ignore embedded quotes
+- should ignore escaped quotes
+
+Command::TextInterpreter all set up
+- should complete words in the commmand-line
+- should process a command-line
+
+Command::TextInterpreter with a command with a named argument
+- should complete words in the commmand-line
+- should process a command-line
+
+A fresh Subject
+- should allow a field to be required
+- should allow multiple fields to be required
+
+A Subject with required fields
+- should not verify if fields are not set
+- should not verify if some fields are not set
+- should verify if all fields are set
+- should not respond to field read methods
+- should spawn SubjectImage objects that do respond to readers
+
+Command::Results::ListIterator
+- should traverse list in tree order
+
+Command::Results::List
+- should compare to similar lists as similar
+- should compare to different lists as different
+- should filter lists by path
+- should raise NoMatch for unmatched path
+- should filter lists with wildcard list
+- should treat lonely double-star as an identity
+- should filter lists with double-star lists
+- should filter lists with wildcard item
+
+A fresh Command
+- should return name properly
+- should complete with empty arguments
+- should raise NoMethodError if a required argument is defined after optionals
+
+A Command with a required argument
+- should complain if it's run without having been given arguments
+- should complain if it's given fewer arguments than it requires
+- should silently not complete extra arguments
+
+A Command with a MultiArgument
+- should complete with empty string
+- should complete with Multi three times
+- should complete with Multi and then Proc
+- should complete with just Proc
+
+A Command with an alternating argument
+- should consume to array
+- should consume to number
+- should silently not complete extra arguments
+- should raise with invalid arguments
+- should successfully consume a hash of arguments
+
+Command::Command with tasks
+- should stop and return information for resuming
+- should resume after the designated task
+
+A chain of commands
+- should chain with a complete command path
+- should chain when an optional argument is omitted
+- should chain with a path to the command and hashed args
+- should chain with mixed and overlapping terms
+- should chain with a class and an arg hash
+
+Command::Results::Formatter
+- should process into the correct list
+- should allow explicit options to come through from command
+- should allow explicit list options through
+- should mark up items as directed by Command#format_advice
+- 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
+- should actually have the set command
+- should reply to empty arguments with first level keys
+- should reply to key with value
+- should reply to subkeys with key list
+- should silently modify values
+- should modify deep values
+
+A CommandSet with Set and Undo
+- should actually have the set and undo commands
+- should report an error on impossible undo
+- should return to original value following undo
+
+A CommandSet with Help
+- should actually have the help command
+- should return useful text in response to "help"
+- should return useful text in response to "help help"
+- should wrap to 78 characters on "help long_winded"
+- should gracefully recover if a command has nil documentation
+- should cope with nil command names in full help listing
+
+Command::OutputStandin undispatched
+- should return the base IO from getobj
+- should pass puts unmolested
+
+Command::OutputStandin dispatched to a collector
+- should return the base IO from getobj
+- should send #puts to the collector
+- should send #p to the collector
+- should go back to sending puts to IO if collector removed
+
+Command::OutputStandin dispatched via thread
+- should return the base IO from getobj
+- should send #puts to the collector
+- should send #p to the collector
+- should go back to sending puts to IO if collector removed
+
+Command::Results::Collector
+- should spawn dispatchers
+
+Command::Results::Collector sending messages
+- should send simple #item calls to its presenter
+- should send begin_list and end list calls to presenter
+- should prefix items with list nesting
+
+Command::Results::Presenter
+- should collect items
+- should nest lists
+- should complain about lists not begun
+- should complain about mis-nested item
+
+Command::Results::Presenter driving a Formatter
+- should emit #saw_item before #closed_item
+- should emit #closed_item within known tree order
+- should emit #closed_item only once per item
+
+Command::Results::Presenter driving a strict Formatter
+- should send notifications in correct order
+
+Finished in 0.174402 seconds
+
+137 examples, 0 failures

data/doc/argumentDSL

@@ -0,0 +1,36 @@
+There are two kinds of methods available for Command::DSL::Argument.  
+First there are decorators.  They mark up arguments with extra
+meaning, like being optional.  The second are actual argument
+creation calls, which are shorthand for something like 
+  argument FiddlyArgument {}
+
+In general, you'll use these something like
+
+  decorator.decorator.shorthand_argument "name"
+
+For instance
+
+  named.optional.file_argument "config"
+
+Decorator methods, and the classes they add:
+
++multi+:: AlternatingArgument
++named+:: Named
++optional+:: Optional
++alternating+:: AlternatingArgument
+
+The shorthand argument methods are:
+
++regexp_argument+:: RegexpArgument
++multiword_argument+:: MultiArgument
++array_argument+:: ArrayArgument
++string_argument+:: StringArgument
++file_argument+:: FileArgument
++any_argument+:: StringArgument
++nonvalidating_proc_argument+:: NoValidateProcArgument
++number_argument+:: NumberArgument
++choose_argument+:: ArrayArgument
++proc_argument+:: ProcArgument
++regex_argument+:: RegexpArgument
+
+Don't forget about #alternating_argument and #argument itself!