escort 0.3.0 → 0.4.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MzQ3YWNjMzdhYWVmMjJiNThhYmFkNDlmYTdhZjRiOTk1MTE5MjU0OA==
-  data.tar.gz: !binary |-
-    MDA2MDVmNGQ5M2I2ODRlNGUzODU5YzgzYjI1ZTY3NjU2YzRjMmNiMg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZjBiNWM4N2MyMDQ3NDI2ZmQyZjI4NjBmZjg3YmZhZTRjNGU5ZDFlNjljYzYw
-    Y2Q0MThjMDQyYTg5YjAzZWE3ZDQ2NGFhZWIwZDE0MjU2MTZiZTk5MDdmZGVl
-    MWVmMTUzMTYzODc5NzcxYmEyZmE5MGI4NmNlNjI3MThkMWEyMDI=
-  data.tar.gz: !binary |-
-    ODkwMzNlN2Q0NTMwOGY2ZGQzYTA3YjA3ZTNiMjdkYTgzMjBmYmI1ZTVjNDQy
-    ZTM0ZGU2ZGZjNmVhYjhiMjdmZTVjY2NiNGY2ZGRmNmUzMTcyNmViMzNmYjQ4
-    NzQzN2MxMjlhOGFiN2UxZGE2ODc2MWZmY2IxODAzNjFkM2ViMmQ=
+SHA1:
+  metadata.gz: f31a0746ef3bb6c559b04f55e87fa8e48900f32c
+  data.tar.gz: 236d3d50f9e7ac297dbb444e44e6628329aacba1
+SHA512:
+  metadata.gz: 44545a6c19ecde7615c819c702744af2bd0810e5df6a755ce3fbc644b1c4a7154317da87a4c3c944cfbf3614799b3d76be0e6736fe58927c407961ae5532e83f
+  data.tar.gz: f8ffe0f3f296f16ca3f8d709a4101e746d505b321c5a42ec3280d48293e96f8414472184bfe546bab4e184a4adb9cd94119a5a1ab622e28a7279491859d90197

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p0

data/README.md

@@ -684,7 +684,10 @@ TODO
 
 ## Command-Line Tools Built With Escort
 
-TODO
+If you've used Escort to build a command-line tool that you have made publicly available, feel free to add a link to it here.
+
+* https://github.com/skorks/ppjson - pretty print your JSON on the command-line (works with JSON strings as well as files containing JSON, can uglify as well as pretty print)
+
 
 ## Alternatives
 

data/TODO.md

@@ -1,88 +1,24 @@
 ROADMAP
-
-v0.3.0
-- tag and release
-
-
-- up the version to 0.3.0 DONE
-- test the base command for actions well DONE
-- BUG parent_options when parent of command is global context doesn't seem to work??? DONE
-- integration test for commands   DONE
-- integration test for sub-commands DONE
-- readme a basic app with config file, integration test (don't worry about explaining all the helper stuff that gets created) DONE
-- test the configuration loader DONE
-- test the descend to home locator DONE
-- test the configuration merge tool DONE
-- test the configuration generator DONE
-- test all the locators (descend, specfic dir, current script dir, chaining) DONE
-- we should always be using the chaining locator, with more or less sub locators depending on setup DONE
-- create other locators (dir of currently executing script locator, i.e. not the working directory, specified dir locator) DONE
-- create a chaining locator so we can put all our locators together  DONE
-- test the configuration reader DONE
-- test the configuration writer  DONE
-- a basic app example with all the trimmings DONE
-- app with config file example     DONE
-- readme implementing and action for a basic app DONE
-- rejig for betterness the validations help outputs DONE
-- test the string grid      DONE
-- start using the new stream output formatter   DONE
-- refactor terminal formatter and test it     DONE
-- finish testing the output formatter        DONE
-- get rid of shell command executor new shell stuff (doesn't work in Jruby and not really needed anyway)  DONE
-- extract all the dsl command stuff into a helper module so that global and command can be handled by the same code DONE
-
-v0.4.0
-- test all the config file helper stuff
-- a few more tests (setup accessor, all the dsl classes)
-- fix ppjson so that dependency suport feature is actually used
-- up the version to 0.4.0
-- tag and release
-
-
-- delete the stuff from the attic once it is no longer needed DONE
-- readme a sub command app with options, validations, description, summary, require arguments and config file, integration tests, example DONE
-- readme for requires arguments overriding and inheritance DONE
-- readme explain all the helper stuff that automatically gets created with config file support DONE
-
-
 v1.0.0
-- have a think about how to make the integration tests a bit more robust, so that failures don't get swallowed (test for specific exit codes instead of non-zero exit code), fix the existing integration tests
-- a few more integration tests (test that basic app automatically gets help and other automatic options)
-- clean up all the extraneous branches
+- thoroughly test the setup accessor
+- refactor setup accessor to break it up into multiple objects so that it is easier to test and less monolithic
+- pull out the action execution into a separate class and test it
+- a way have helpers available when you don't want to have to create a command
+- readme about how to actually pass the user config through to action and the fact that regardless if you have a config file or not, you can have a config var or not as part of the block variables
 - up the version to 1.0.0
 - tag and release
-- get the blog updated with a new theme
-- put a new subscriber count widget on blog
-- blog Build Command-Line Apps Like a Pro Using Ruby and Escort
 
 
-- in trollop when errors are raised they should be wrapped as escort errors and propagate rather than being caught by trollop itself DONE
-- rework the examples again to show of some/most of the features (along the lines of the integration tests and readme)  DONE
-- errors coming straigh out of configuration should still be caught by error handlers to only display stack trace when needed (refactor app create method) DONE
-- readme for a basic app with conflicting options    DONE
-- readme for a basic app with dependent options      DONE
 
 v1.0.1
-- pull out the action execution into a separate class and test it
-- add a section to readme for command line tools built with escort (e.g. ppjson)
-- more specs (all the dsl classes possibly)
-- more integration specs (more specs for the different types of options)
-- a way have helpers available when you don't want to have to create a command
-- the config auto option should not be included in the config file, same with other auto options???
-- readme about how to actually pass the user config through to action and the fact that regardless if you have a config file or not, you can have a config var or not as part of the block variables
-
-
-- rework the integration specs and matchers so there are less moving parts (perhaps push some stuff down into a base class etc.) DONE
-- rewrite the help formatter to be a bit easier to understand (more like man output for output) DONE
-- add depends support to dsl   DONE
 
 v1.0.2
+- create a table of contents for the readme so that it is easier to navigate it
 - refactor the app class so it is a bit nicer etc
-- more specs
 - need a suite for escort itself using escort to bootstrap etc
-- scaffold for app with no sub commands
-- scaffold for app with one level of commands
-- scaffold for app with nested sub commands
+- scaffold for app with no sub commands (escort g -o blah -o yadda bin/app.rb)
+- scaffold for app with one level of commands (escort g -o blah -o yadda suite -o blah -o yadda -c foo -c bar bin/app.rb)
+- scaffold for app with nested sub commands (escort g -o blah -o yadda suite -o blah -o yadda -c foo -c bar --nested bin/app.rb) ???
 
 v1.0.3
 - an option for setup that indicates it is a project specific CLI app
@@ -90,8 +26,7 @@ v1.0.3
 - make the configuration environment aware
 - make escort environment aware (app.environment_aware)
 - json configuration should support defaults config
-- pull the terminal formatting stuff into separate gem
-- pull nested exception stuff into separate gem
+- if necessary, extra helpers to work with environment specific config sections (xxx -e production escort --create-config-environment-section)
 
 
 - much better documentation and usage patterns         DONE
@@ -101,9 +36,16 @@ v2.0.0
 - implement servants for dealing with clumps of functionality, and action commands have access to all servants that were executed before them
 - ability to break up a big config into chucks, e.g. per command etc. so that it is more modular and easier to read
 - whether or not action is specified things should not blow up
+- rework ppjson to take advantage of servants and non-block actions and release a new version
 
 v2.0.1
 - lots more logging at different levels for debug purposes
+- more integration specs (more specs for the different types of options)
+- more specs (dsl classes, validator, option_parser, dependency validator, global_pre_parser, auto_options, app)
+- perhaps verbosity should be at the highest level by default and allow toning it down via the setup
+- blog Build Command-Line Apps Like a Pro Using Ruby and Escort
+- pull the terminal formatting stuff into separate gem
+- pull nested exception stuff into separate gem
 
 
 
@@ -151,6 +93,7 @@ BUCKET
 - json configuration should support having environment configs in multiple files
 - blog the crap out of all aspects of how to use it, how it is constructed, some fancy things you can do with it etc.
 - ability to ask for user input for a command (e.g. for passwords, this can possibly be done via validations)
+- do a homebrew config for ppjson so that it can easily be installed using brew
 
 - blog about what makes a good command line app (this and the one below are possibly one post)
 - blog about how to use escort and why the other libraries possibly fall short
@@ -163,6 +106,7 @@ BUCKET
 - blog about nested exceptions and how to make them nice in your app, also metion exceptional ruby book as well as nestegg gem
 - blog about dependencies with bundler, the spermy operator and what version will be chosen
 - blog about ppjson and how to use it
+- reply to a bunch of stackoverflow posts about pretty printing json on the command-line
 
 - improve the terminal formatter, allowing wrapping text to anywhere, and tabular like output without an actual table, allowing configuring terminal of any size not just 80, spin it off a little separate project, with an example of how to possibly build a menu in it or something DONE
 - BUG the help formatting is still not quite right as far as respecting the char limits and wrapping properly when doing tabular output!!!! DONE
@@ -310,3 +254,55 @@ v0.2.0
   - integration test all the permutations of dependency specification with error and success cases etc  DONE
   - create a shortcut for dependency specification on the opt method options hash itself                DONE
   - fix up example for basic app with dependencies for options                                          DONE
+
+v0.3.0
+- tag and release DONE
+- up the version to 0.3.0 DONE
+- test the base command for actions well DONE
+- BUG parent_options when parent of command is global context doesn't seem to work??? DONE
+- integration test for commands   DONE
+- integration test for sub-commands DONE
+- readme a basic app with config file, integration test (don't worry about explaining all the helper stuff that gets created) DONE
+- test the configuration loader DONE
+- test the descend to home locator DONE
+- test the configuration merge tool DONE
+- test the configuration generator DONE
+- test all the locators (descend, specfic dir, current script dir, chaining) DONE
+- we should always be using the chaining locator, with more or less sub locators depending on setup DONE
+- create other locators (dir of currently executing script locator, i.e. not the working directory, specified dir locator) DONE
+- create a chaining locator so we can put all our locators together  DONE
+- test the configuration reader DONE
+- test the configuration writer  DONE
+- a basic app example with all the trimmings DONE
+- app with config file example     DONE
+- readme implementing and action for a basic app DONE
+- rejig for betterness the validations help outputs DONE
+- test the string grid      DONE
+- start using the new stream output formatter   DONE
+- refactor terminal formatter and test it     DONE
+- finish testing the output formatter        DONE
+- get rid of shell command executor new shell stuff (doesn't work in Jruby and not really needed anyway)  DONE
+- extract all the dsl command stuff into a helper module so that global and command can be handled by the same code DONE
+
+v0.4.0
+- a few more integration tests (test that basic app automatically gets help and version and that they are correct) DONE
+- have a think about how to make the integration tests a bit more robust, so that failures don't get swallowed (test for specific exit codes instead of non-zero exit code), fix the existing integration tests DONE
+- clean up all the extraneous branches DONE
+- in trollop when errors are raised they should be wrapped as escort errors and propagate rather than being caught by trollop itself DONE
+- rework the examples again to show of some/most of the features (along the lines of the integration tests and readme)  DONE
+- errors coming straigh out of configuration should still be caught by error handlers to only display stack trace when needed (refactor app create method) DONE
+- readme for a basic app with conflicting options    DONE
+- readme for a basic app with dependent options      DONE
+- integration test all the config file helper stuff  DONE
+- fix ppjson so that dependency suport feature is actually used DONE
+- delete the stuff from the attic once it is no longer needed DONE
+- readme a sub command app with options, validations, description, summary, require arguments and config file, integration tests, example DONE
+- readme for requires arguments overriding and inheritance DONE
+- readme explain all the helper stuff that automatically gets created with config file support DONE
+- get the blog updated with a new theme    DONE
+- put a new subscriber count widget on blog DONE
+- the config auto option should not be included in the config file, same with other auto options??? N/A
+- add a section to readme for command line tools built with escort (e.g. ppjson) DONE
+- rework the integration specs and matchers so there are less moving parts (perhaps push some stuff down into a base class etc.) DONE
+- rewrite the help formatter to be a bit easier to understand (more like man output for output) DONE
+- add depends support to dsl   DONE

data/escort.gemspec

@@ -12,6 +12,8 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Writing even complex command-line apps should be quick, easy and fun. Escort takes the excellent Trollop option parser and adds a whole bunch of awesome features to produce a library you will always want to turn to when a 'quick script' is in order.}
   gem.homepage      = "https://github.com/skorks/escort"
 
+  gem.add_runtime_dependency('nesty')
+
   gem.add_development_dependency('rspec')
   gem.add_development_dependency('fakefs')
   gem.add_development_dependency('rake')

data/lib/escort.rb

@@ -1,54 +1,73 @@
-require 'escort/version'
-require 'escort/trollop'
-require 'escort/utils'
-require 'escort/arguments'
-require 'escort/logger'
+autoload :Nesty,                            "nesty"
 
-require 'escort/error/error'
+module Escort
+  autoload :VERSION,                        "escort/version"
+  autoload :Trollop,                        "escort/trollop"
+  autoload :Utils,                          "escort/utils"
+  autoload :Arguments,                      "escort/arguments"
+  autoload :Logger,                         "escort/logger"
+  autoload :SetupAccessor,                  "escort/setup_accessor"
+  autoload :OptionDependencyValidator,      "escort/option_dependency_validator"
+  autoload :Validator,                      "escort/validator"
+  autoload :AutoOptions,                    "escort/auto_options"
+  autoload :GlobalPreParser,                "escort/global_pre_parser"
+  autoload :OptionParser,                   "escort/option_parser"
+  autoload :App,                            "escort/app"
 
-require 'escort/formatter/option'
-require 'escort/formatter/options'
-require 'escort/formatter/command'
-require 'escort/formatter/commands'
-require 'escort/formatter/global_command'
-require 'escort/formatter/shell_command_executor'
-require 'escort/formatter/terminal'
-require 'escort/formatter/string_splitter'
-require 'escort/formatter/cursor_position'
-require 'escort/formatter/stream_output_formatter'
-require 'escort/formatter/string_grid'
-require 'escort/formatter/default_help_formatter'
+  autoload :Error,                          "escort/error/error"
+  autoload :BaseError,                      "escort/error/error"
+  autoload :UserError,                      "escort/error/error"
+  autoload :InternalError,                  "escort/error/error"
+  autoload :ClientError,                    "escort/error/error"
+  autoload :TransientError,                 "escort/error/error"
 
-require 'escort/setup/dsl/options'
-require 'escort/setup/dsl/action'
-require 'escort/setup/dsl/command'
-require 'escort/setup/dsl/config_file'
-require 'escort/setup/dsl/global'
+  module Formatter
+    autoload :Option,                       "escort/formatter/option"
+    autoload :Options,                      "escort/formatter/options"
+    autoload :Command,                      "escort/formatter/command"
+    autoload :Commands,                     "escort/formatter/commands"
+    autoload :GlobalCommand,                "escort/formatter/global_command"
+    autoload :ShellCommandExecutor,         "escort/formatter/shell_command_executor"
+    autoload :Terminal,                     "escort/formatter/terminal"
+    autoload :StringSplitter,               "escort/formatter/string_splitter"
+    autoload :CursorPosition,               "escort/formatter/cursor_position"
+    autoload :StreamOutputFormatter,        "escort/formatter/stream_output_formatter"
+    autoload :StringGrid,                   "escort/formatter/string_grid"
+    autoload :DefaultHelpFormatter,         "escort/formatter/default_help_formatter"
+  end
 
-require 'escort/setup/configuration/locator/base'
-require 'escort/setup/configuration/locator/descending_to_home'
-require 'escort/setup/configuration/locator/executing_script_directory'
-require 'escort/setup/configuration/locator/specified_directory'
-require 'escort/setup/configuration/locator/chaining'
-require 'escort/setup/configuration/merge_tool'
-require 'escort/setup/configuration/instance'
-require 'escort/setup/configuration/reader'
-require 'escort/setup/configuration/writer'
-require 'escort/setup/configuration/generator'
-require 'escort/setup/configuration/loader'
+  module Setup
+    module Dsl
+      autoload :Options,                    "escort/setup/dsl/options"
+      autoload :Action,                     "escort/setup/dsl/action"
+      autoload :Command,                    "escort/setup/dsl/command"
+      autoload :ConfigFile,                 "escort/setup/dsl/config_file"
+      autoload :Global,                     "escort/setup/dsl/global"
+    end
 
-require 'escort/setup_accessor'
+    module Configuration
+      module Locator
+        autoload :Base,                     "escort/setup/configuration/locator/base"
+        autoload :DescendingToHome,         "escort/setup/configuration/locator/descending_to_home"
+        autoload :ExecutingScriptDirectory, "escort/setup/configuration/locator/executing_script_directory"
+        autoload :SpecifiedDirectory,       "escort/setup/configuration/locator/specified_directory"
+        autoload :Chaining,                 "escort/setup/configuration/locator/chaining"
+      end
 
-require 'escort/option_dependency_validator'
-require 'escort/validator'
-require 'escort/auto_options'
-require 'escort/global_pre_parser'
-require 'escort/option_parser'
+      autoload :MergeTool,                  "escort/setup/configuration/merge_tool"
+      autoload :Instance,                   "escort/setup/configuration/instance"
+      autoload :Reader,                     "escort/setup/configuration/reader"
+      autoload :Writer,                     "escort/setup/configuration/writer"
+      autoload :Generator,                  "escort/setup/configuration/generator"
+      autoload :Loader,                     "escort/setup/configuration/loader"
+    end
+  end
 
-require 'escort/action_command/base'
-require 'escort/action_command/escort_utility_command'
-
-require 'escort/app'
+  module ActionCommand
+    autoload :Base,                         "escort/action_command/base"
+    autoload :EscortUtilityCommand,         "escort/action_command/escort_utility_command"
+  end
+end
 
 at_exit do
   Escort::Logger.close

data/lib/escort/error/error.rb

@@ -11,25 +11,8 @@ module Escort
   #all our exceptions will supported nesting other exceptions
   #also all our exception will be a kind_of? Escort::Error
   class BaseError < StandardError
+    include Nesty::NestedError
     include Error
-    attr_reader :original
-
-    def initialize(msg, original=$!)
-      super(msg)
-      @original = original
-    end
-
-    def set_backtrace(bt)
-      if original
-        original.backtrace.reverse.each do |line|
-          bt.last == line ? bt.pop : break
-        end
-        original_first = original.backtrace.shift
-        bt.concat ["#{original_first}: #{original.message}"]
-        bt.concat original.backtrace
-      end
-      super(bt)
-    end
   end
 
   #user did something invalid

data/lib/escort/setup_accessor.rb

@@ -112,11 +112,6 @@ module Escort
 
     def add_global_command(name, options = {}, &block)
       global_instance.command(name, options, &block)
-
-      #with_context([]) do |current_context|
-        #commands = fetch_instance_variable_from(current_context, :commands)
-        #options_object.opt name, desc, options
-      #end
     end
 
     private

data/lib/escort/version.rb

@@ -1,3 +1,3 @@
 module Escort
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/spec/integration/basic_config_file_spec.rb

@@ -79,4 +79,48 @@ describe "Escort basic app with config file defined", :integration => true do
       it("should not have created a config file in default location") { File.should_not exist path  }
     end
   end
+
+  context "when config file specified" do
+    let(:autocreate) {false}
+
+    before do
+      FileUtils.mkdir_p(File.dirname path)
+      File.open(path, 'w') {|f| f.write(JSON.pretty_generate({:global => {:commands => {}, :options => {:option1 => 'hello'}}, :user => {}})) }
+
+      begin
+        subject
+      rescue SystemExit => e
+      end
+    end
+
+    context "--config global option should exist" do
+      let(:option_string) { "--config=#{path}" }
+      it("should exit with code 0") { expect{ subject }.to exit_with_code(0) }
+    end
+
+    context "escort command should exist" do
+      let(:option_string) { "escort -h" }
+      it("should exit with code 0") { expect{ subject }.to exit_with_code(0) }
+
+      context "--create-config option for escort command should exist" do
+        let(:option_string) { "escort --create-config=#{path}" }
+        it("should exit with code 0") { expect{ subject }.to exit_with_code(0) }
+      end
+
+      context "--create-default-config option for escort command should exist" do
+        let(:option_string) { "escort --create-default-config" }
+        it("should exit with code 0") { expect{ subject }.to exit_with_code(0) }
+      end
+
+      context "--update-config option for escort command should exist" do
+        let(:option_string) { "escort --update-config=#{path}" }
+        it("should exit with code 0") { expect{ subject }.to exit_with_code(0) }
+      end
+
+      context "--update-default-config option for escort command should exist" do
+        let(:option_string) { "escort --update-default-config" }
+        it("should exit with code 0") { expect{ subject }.to exit_with_code(0) }
+      end
+    end
+  end
 end

data/spec/integration/basic_spec.rb

@@ -20,4 +20,19 @@ describe "Escort basic app with no options defined", :integration => true do
     it("exit code should be 0") { expect{ subject }.to exit_with_code(0) }
     it("should execute the global action") { expect{subject}.to execute_action_for_command(result, :global) }
   end
+
+  context "gets --help option automatically" do
+    let(:option_string) { "--help" }
+    it("exit code should be 0") { expect{ subject }.to exit_with_code(0) }
+  end
+
+  context "gets --verbosity option automatically" do
+    let(:option_string) { "--verbosity=DEBUG" }
+    it("exit code should be 0") { expect{ subject }.to exit_with_code(0) }
+  end
+
+  context "gets --error-output-format option automatically" do
+    let(:option_string) { "--error-output-format=advanced" }
+    it("exit code should be 0") { expect{ subject }.to exit_with_code(0) }
+  end
 end

data/spec/integration/basic_with_arguments_spec.rb

@@ -1,3 +1,5 @@
+require 'readline'
+
 describe "Escort basic app that requires arguments", :integration => true do
   subject { Escort::App.create(option_string, &app_configuration) }
 

data/spec/lib/escort/setup_accessor_spec.rb

@@ -4,7 +4,15 @@ describe Escort::SetupAccessor do
   let(:global_app_configuration) do
     Escort::Setup::Dsl::Global.new do |app|
       app.options do |opts|
-        opts.opt :option1, "option1", :short => :none, :long => '--option1', :type => :string
+        opts.opt :option1, "Option1", :short => '-o', :long => '--option1', :type => :string, :default => "option 1"
+        opts.opt :option2, "Option2", :short => :none, :long => '--option2', :type => :string, :multi => true
+        opts.opt :int_option, "Int option", :short => '-i', :long => '--int-option', :type => :int
+        opts.opt :flag1, "Flag 1", :short => '-f', :long => '--flag1', :type => :boolean, :default => true
+        opts.opt :flag2, "Flag 2", :short => :none, :long => '--flag2', :type => :boolean
+
+        opts.conflict :flag1, :flag2
+        opts.dependency :option1, :on => :flag1
+        opts.validate(:int_option, "must be greater than 10") { |option| option > 10 }
       end
 
       app.action do |options, arguments|
@@ -13,31 +21,206 @@ describe Escort::SetupAccessor do
   end
 
   let(:command_app_configuration) do
+    Escort::Setup::Dsl::Global.new do |app|
+      app.options do |opts|
+        opts.opt :option1, "Option1", :short => '-o', :long => '--option1', :type => :string, :default => "option 1"
+      end
+
+      app.command :command1  do |command|
+        command.options do |opts|
+          opts.opt :option1, "Option1 for command1", :short => '-o', :long => '--option1', :type => :string, :default => "option 1 command 1"
+          opts.opt :flag_for_command1, "Flag for command 1", :short => :none, :long => '--flag-for-command1', :type => :boolean
+
+          opts.dependency :option1, :on => :flag_for_command1
+        end
+
+        command.action do |options, arguments|
+        end
+      end
+
+      app.command :command2, :aliases => :c2  do |command|
+        command.options do |opts|
+          opts.opt :optionb, "Optionb", :short => :none, :long => '--optionb', :type => :string, :multi => true
+          opts.opt :float_option, "Float option", :short => '-d', :long => '--float-option', :type => :float
+
+          opts.conflict :optionb, :float_option
+          opts.validate(:float_option, "must be less than 5") { |option| option < 5 }
+        end
+
+        command.action do |options, arguments|
+        end
+      end
+
+      app.action do |options, arguments|
+      end
+    end
   end
 
   let(:sub_command_app_configuration) do
+    Escort::Setup::Dsl::Global.new do |app|
+      app.options do |opts|
+        opts.opt :option1, "Option1", :short => '-o', :long => '--option1', :type => :string, :default => "option 1"
+      end
+
+      app.command :command2, :aliases => :c2  do |command|
+        command.options do |opts|
+          opts.opt :optionb, "Optionb", :short => :none, :long => '--optionb', :type => :string, :multi => true
+          opts.opt :float_option, "Float option", :short => '-d', :long => '--float-option', :type => :float
+
+          opts.conflict :optionb, :float_option
+          opts.validate(:float_option, "must be less than 5") { |option| option < 5 }
+        end
+
+        command.command :sub_command1  do |command|
+          command.options do |opts|
+            opts.opt :flag2, "Flag 2", :short => :none, :long => '--flag2', :type => :boolean
+          end
+
+          command.action do |options, arguments|
+          end
+        end
+
+        command.command :sub_command2  do |command|
+          command.options do |opts|
+            opts.opt :sub_option1, "Sub option1", :short => '-s', :long => '--sub-option1', :type => :string
+            opts.validate(:sub_option1, "must be 'x' or 'y'") { |option| ['x', 'y'].include? option }
+          end
+
+          command.action do |options, arguments|
+          end
+        end
+
+        command.action do |options, arguments|
+        end
+      end
+
+      app.action do |options, arguments|
+      end
+    end
   end
 
-  #context is nil
-  #no context supplied at all
-  #context is not an array
   describe '#options_for' do
-    subject {setup.options_for(context)}
+    let(:options) {setup.options_for(context)}
 
     context "when app has no sub commands" do
       let(:app_configuration) {global_app_configuration}
 
       context "and context is global" do
         let(:context) { [] }
-        it(":option1 should be present") {subject[:option1].should_not be_nil}
+        it(":option1 should be present") {options[:option1].should_not be_nil}
       end
 
       context "and context is an unknown command" do
         let(:context) { ['hello'] }
-        it("should not raise an exception") { expect{subject}.to_not raise_error }
-        it("result should be a hash") { subject.class.should == Hash }
-        it("result should be empty") { subject.should be_empty }
+        it("should not raise an exception") { expect{options}.to_not raise_error }
+        it("result should be a hash") { options.class.should == Hash }
+        it("result should be empty") { options.should be_empty }
+      end
+
+      context "and no context passed in at all" do
+        let(:options) {setup.options_for}
+        it(":option1 should be present") {options[:option1].should_not be_nil}
+      end
+
+      context "and context is nil" do
+        let(:context) { nil }
+        it(":option1 should be present") {options[:option1].should_not be_nil}
+      end
+
+      context "and context is not an array" do
+        let(:context) { 'hello' }
+        it("should not raise an exception") { expect{options}.to_not raise_error }
       end
     end
+
+    context "when app has one level of sub commands" do
+      let(:app_configuration) {command_app_configuration}
+
+      context "and context is a known command" do
+        let(:context) { ['command1'] }
+        it("result should be a hash") { options.class.should == Hash }
+        it("result should not be empty") { options.should_not be_empty }
+        it(":option1 should be present") {options[:option1].should_not be_nil}
+      end
+    end
+
+    context "when app has multiple levels of sub commands" do
+      let(:app_configuration) {sub_command_app_configuration}
+
+      context "and context is a known sub command" do
+        let(:context) { ['command2', 'sub_command2'] }
+        it("result should be a hash") { options.class.should == Hash }
+        it("result should not be empty") { options.should_not be_empty }
+        it(":sub_option1 should be present") {options[:sub_option1].should_not be_nil}
+      end
+    end
+  end
+
+  describe '#conflicting_options_for' do
+    #TODO implement
+  end
+
+  describe '#validations_for' do
+    #TODO implement
+  end
+
+  describe '#dependencies_for' do
+    #TODO implement
+  end
+
+  describe '#command_names_for' do
+    #TODO implement
+  end
+
+  describe '#canonical_command_names_for' do
+    #TODO implement
+  end
+
+  describe '#action_for' do
+    #TODO implement
+  end
+
+  describe '#arguments_required_for' do
+    #TODO implement
+  end
+
+  describe '#has_config_file?' do
+    #TODO implement
+  end
+
+  describe '#config_file_autocreatable?' do
+    #TODO implement
+  end
+
+  describe '#config_file' do
+    #TODO implement
+  end
+
+  describe '#summary_for' do
+    #TODO implement
+  end
+
+  describe '#description_for' do
+    #TODO implement
+  end
+
+  describe '#command_description_for' do
+    #TODO implement
+  end
+
+  describe '#command_summary_for' do
+    #TODO implement
+  end
+
+  describe '#command_aliases_for' do
+    #TODO implement
+  end
+
+  describe '#add_global_option' do
+    #TODO implement
+  end
+
+  describe '#add_global_command' do
+    #TODO implement
   end
 end

data/spec/support/shared_contexts/integration_setup.rb

@@ -5,7 +5,7 @@ shared_context "integration test setup", :integration => true do
     empty_argv
     #$stderr = StringIO.new
     #$stdout = StringIO.new
-    $stdin = StringIO.new
+    #$stdin = StringIO.new
   end
 
   after do

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: escort
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alan Skorkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-04-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nesty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: travis-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Writing even complex command-line apps should be quick, easy and fun.
@@ -79,7 +93,7 @@ files:
 - .gitignore
 - .irbrc
 - .rspec
-- .rvmrc
+- .ruby-version
 - .travis.yml
 - Gemfile
 - LICENSE.txt
@@ -194,12 +208,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []

data/.rvmrc

@@ -1,22 +0,0 @@
-#!/usr/bin/env bash
-
-failed=1
-gemset=escort
-rubies="ruby-1.9.3-p362 ruby-1.9.3-p194 ruby-1.9.2-p290 "
-
-for ruby in $rubies; do
-  rvm use $ruby@$gemset --create 1>/dev/null 2>&1
-  if [ $? == 0 ]; then
-    echo
-    echo ">>" rvm is using $ruby@$gemset
-    echo
-    failed=0
-    break
-  fi
-done
-
-if [ $failed == 1 ]; then
-  echo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-  echo cannot find a ruby runtime in the set: $rubies, please install one
-  echo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-fi