escort 0.1.0 → 0.2.0

data/spec/spec_helper.rb

@@ -1,8 +1,12 @@
 require 'escort'
+
+
+Dir[File.join(File.dirname(__FILE__), 'support', '**', "*.rb").to_s].each {|file| require file }
+
 #helpers
-require 'helpers/exit_with_code_matcher'
-require 'helpers/execute_action_matcher'
-require 'helpers/give_option_to_action_with_value_matcher'
+#require 'helpers/exit_with_code_matcher'
+#require 'helpers/execute_action_matcher'
+#require 'helpers/give_option_to_action_with_value_matcher'
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # Require this file using `require "spec_helper"` to ensure that it is only
@@ -14,6 +18,8 @@ RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 
+  config.include IntegrationHelpers, :integration => true
+
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.

data/spec/support/integration_helpers.rb

@@ -0,0 +1,2 @@
+module IntegrationHelpers
+end

data/spec/{helpers/execute_action_matcher.rb → support/matchers/execute_action_for_command_matcher.rb}

@@ -1,14 +1,14 @@
-RSpec::Matchers.define :execute_action do |command_name, result|
+RSpec::Matchers.define :execute_action_for_command do |result, command_name|
   match do |block|
     begin
       block.call
     rescue SystemExit => e
     end
-    result.first == command_name
+    result[:command_name] == command_name
   end
 
   failure_message_for_should do |block|
-    "'#{command_name}' action should have been executed as a result of block, but instead '#{result.first}' was executed"
+    "'#{command_name}' action should have been executed as a result of block, but instead '#{result[:command_name]}' was executed"
   end
 
   failure_message_for_should_not do |block|

data/spec/support/matchers/execute_action_with_arguments_matcher.rb

@@ -0,0 +1,25 @@
+RSpec::Matchers.define :execute_action_with_arguments do |result, expected_arguments|
+  match do |block|
+    begin
+      block.call
+    rescue SystemExit => e
+    end
+    successful_match?(result, expected_arguments)
+  end
+
+  def successful_match?(result, expected_arguments)
+    result[:arguments] == expected_arguments
+  end
+
+  failure_message_for_should do |block|
+    "'#{expected_arguments}' should have been passed to action, but we got '#{result[:arguments]}'"
+  end
+
+  failure_message_for_should_not do |block|
+    "'#{expected_arguments}' should not have been passed to action"
+  end
+
+  description do
+    "'#{expected_arguments}' should have been passed to action"
+  end
+end

data/spec/support/matchers/execute_action_with_options_matcher.rb

@@ -0,0 +1,29 @@
+RSpec::Matchers.define :execute_action_with_options do |result, expected_options|
+  match do |block|
+    begin
+      block.call
+    rescue SystemExit => e
+    end
+    successful_match?(result, expected_options)
+  end
+
+  def successful_match?(result, expected_options)
+    options = result[:command_options]
+    expected_options.keys.each do |key|
+      return false unless options[key] == expected_options[key]
+    end
+    true
+  end
+
+  failure_message_for_should do |block|
+    "'#{expected_options}' should have been passed to action, but we got '#{result[:command_options]}'"
+  end
+
+  failure_message_for_should_not do |block|
+    "'#{expected_options}' should not have been passed to action"
+  end
+
+  description do
+    "'#{expected_options}' should have been passed to action"
+  end
+end

data/spec/support/matchers/exit_with_code_matcher.rb

@@ -0,0 +1,29 @@
+RSpec::Matchers.define :exit_with_code do |*expected_code|
+  actual = nil
+  match do |block|
+    begin
+      block.call
+    rescue SystemExit => e
+      actual = e.status
+    end
+    has_expected_exit_code?(actual, *expected_code)
+    #actual && actual == expected_code
+  end
+
+  def has_expected_exit_code?(actual, *expected_code)
+    expected_code.each do |code|
+      return true if actual && actual == code
+    end
+    false
+  end
+
+  failure_message_for_should do |block|
+    "expected block to call exit(#{expected_code}) but exit #{actual.nil? ? "not called" : "(#{actual}) was called"}"
+  end
+  failure_message_for_should_not do |block|
+    "expected block not to call exit(#{expected_code})"
+  end
+  description do
+    "expect block to call exit(#{expected_code})"
+  end
+end

data/spec/support/shared_contexts/integration_setup.rb

@@ -0,0 +1,34 @@
+shared_context "integration test setup", :integration => true do
+  let(:result) { {} }
+
+  before do
+    empty_argv
+    #$stderr = StringIO.new
+    #$stdout = StringIO.new
+    $stdin = StringIO.new
+  end
+
+  after do
+    $stderr = STDERR
+    $stdout = STDOUT
+    $stdin = STDIN
+  end
+
+  module Escort
+    class IntegrationTestCommand < ::Escort::ActionCommand::Base
+      def execute(result)
+        result[:command_name] = command_name
+        result[:command_options] = command_options
+        result[:options] = options
+        result[:arguments] = arguments
+        result[:config] = config if config
+      end
+    end
+  end
+
+  def empty_argv
+    while !ARGV.empty? do
+      ARGV.delete_at(0)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: escort
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alan Skorkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-28 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -52,6 +52,20 @@ dependencies:
     - - ! '>='
       - !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.
   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'
@@ -66,31 +80,42 @@ files:
 - .irbrc
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - TODO.md
 - escort.gemspec
-- examples/1_1_basic.rb
-- examples/1_2_basic_requires_arguments.rb
-- examples/2_2_command.rb
-- examples/2_2_command_requires_arguments.rb
-- examples/2_3_nested_commands.rb
-- examples/3_validations.rb
-- examples/4_1_config_file.rb
-- examples/argument_handling/basic.rb
-- examples/argument_handling/basic_command.rb
-- examples/argument_handling/no_arguments.rb
-- examples/argument_handling/no_arguments_command.rb
-- examples/basic/app.rb
-- examples/command_aliases/app.rb
-- examples/config_file/.apprc2
-- examples/config_file/app.rb
-- examples/config_file/sub_commands.rb
-- examples/default_command/app.rb
-- examples/sub_commands/app.rb
-- examples/validation_basic/app.rb
+- examples/attic/1_1_basic.rb
+- examples/attic/1_2_basic_requires_arguments.rb
+- examples/attic/2_2_command.rb
+- examples/attic/2_2_command_requires_arguments.rb
+- examples/attic/2_3_nested_commands.rb
+- examples/attic/3_validations.rb
+- examples/attic/4_1_config_file.rb
+- examples/attic/argument_handling/basic.rb
+- examples/attic/argument_handling/basic_command.rb
+- examples/attic/argument_handling/no_arguments.rb
+- examples/attic/argument_handling/no_arguments_command.rb
+- examples/attic/command_aliases/app.rb
+- examples/attic/config_file/.apprc2
+- examples/attic/config_file/app.rb
+- examples/attic/config_file/sub_commands.rb
+- examples/attic/default_command/app.rb
+- examples/attic/sub_commands/app.rb
+- examples/attic/validation_basic/app.rb
+- examples/basic
+- examples/basic_conflicts
+- examples/basic_depends_on
+- examples/basic_flags
+- examples/basic_options
+- examples/basic_options_multi
+- examples/basic_require_arguments
+- examples/basic_texts
+- examples/basic_validations
+- examples/command
+- examples/commands/example_command.rb
 - lib/escort.rb
 - lib/escort/action_command/base.rb
 - lib/escort/action_command/escort_utility_command.rb
@@ -99,14 +124,19 @@ files:
 - lib/escort/auto_options.rb
 - lib/escort/error/error.rb
 - lib/escort/formatter/borderless_table.rb
-- lib/escort/formatter/common.rb
+- lib/escort/formatter/command.rb
+- lib/escort/formatter/commands.rb
 - lib/escort/formatter/default_help_formatter.rb
+- lib/escort/formatter/global_command.rb
+- lib/escort/formatter/option.rb
 - lib/escort/formatter/options.rb
+- lib/escort/formatter/shell_command_executor.rb
 - lib/escort/formatter/string_splitter.rb
 - lib/escort/formatter/terminal.rb
 - lib/escort/formatter/terminal_formatter.rb
 - lib/escort/global_pre_parser.rb
 - lib/escort/logger.rb
+- lib/escort/option_dependency_validator.rb
 - lib/escort/option_parser.rb
 - lib/escort/setup/configuration/generator.rb
 - lib/escort/setup/configuration/instance.rb
@@ -127,15 +157,29 @@ files:
 - lib/escort/utils.rb
 - lib/escort/validator.rb
 - lib/escort/version.rb
-- spec/helpers/execute_action_matcher.rb
-- spec/helpers/exit_with_code_matcher.rb
-- spec/helpers/give_option_to_action_with_value_matcher.rb
+- spec/integration/basic_conflicts_spec.rb
+- spec/integration/basic_depends_on_spec.rb
 - spec/integration/basic_options_spec.rb
+- spec/integration/basic_options_with_multi_spec.rb
 - spec/integration/basic_spec.rb
+- spec/integration/basic_validations_spec.rb
+- spec/integration/basic_with_arguments_spec.rb
+- spec/integration/basic_with_text_fields_spec.rb
+- spec/lib/escort/formatter/command_spec.rb
+- spec/lib/escort/formatter/global_command_spec.rb
+- spec/lib/escort/formatter/option_spec.rb
+- spec/lib/escort/formatter/shell_command_executor_spec.rb
 - spec/lib/escort/formatter/string_splitter_spec.rb
+- spec/lib/escort/formatter/terminal_spec.rb
 - spec/lib/escort/setup_accessor_spec.rb
 - spec/lib/escort/utils_spec.rb
 - spec/spec_helper.rb
+- spec/support/integration_helpers.rb
+- spec/support/matchers/execute_action_for_command_matcher.rb
+- spec/support/matchers/execute_action_with_arguments_matcher.rb
+- spec/support/matchers/execute_action_with_options_matcher.rb
+- spec/support/matchers/exit_with_code_matcher.rb
+- spec/support/shared_contexts/integration_setup.rb
 homepage: https://github.com/skorks/escort
 licenses: []
 metadata: {}
@@ -161,12 +205,26 @@ specification_version: 4
 summary: A library that makes building command line apps in ruby so easy, you'll feel
   like an expert is guiding you through it
 test_files:
-- spec/helpers/execute_action_matcher.rb
-- spec/helpers/exit_with_code_matcher.rb
-- spec/helpers/give_option_to_action_with_value_matcher.rb
+- spec/integration/basic_conflicts_spec.rb
+- spec/integration/basic_depends_on_spec.rb
 - spec/integration/basic_options_spec.rb
+- spec/integration/basic_options_with_multi_spec.rb
 - spec/integration/basic_spec.rb
+- spec/integration/basic_validations_spec.rb
+- spec/integration/basic_with_arguments_spec.rb
+- spec/integration/basic_with_text_fields_spec.rb
+- spec/lib/escort/formatter/command_spec.rb
+- spec/lib/escort/formatter/global_command_spec.rb
+- spec/lib/escort/formatter/option_spec.rb
+- spec/lib/escort/formatter/shell_command_executor_spec.rb
 - spec/lib/escort/formatter/string_splitter_spec.rb
+- spec/lib/escort/formatter/terminal_spec.rb
 - spec/lib/escort/setup_accessor_spec.rb
 - spec/lib/escort/utils_spec.rb
 - spec/spec_helper.rb
+- spec/support/integration_helpers.rb
+- spec/support/matchers/execute_action_for_command_matcher.rb
+- spec/support/matchers/execute_action_with_arguments_matcher.rb
+- spec/support/matchers/execute_action_with_options_matcher.rb
+- spec/support/matchers/exit_with_code_matcher.rb
+- spec/support/shared_contexts/integration_setup.rb

data/examples/basic/app.rb

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "..", "lib", "escort"))
-
-Escort::App.create do |app|
-  #app.version "0.2.4"
-  #app.format_help_with(:default_formatter)
-
-  app.options do
-    opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
-    opt :multi_option, "Option that can be specified multiple times alksjdfh lakjdfh adf alksdfh alkdfjh alsdfjhaskdjfh alsdkfjh alksfdjh akdfjh alkdsjf alksdjfh alksdfjh asdfjklh aslkdfhj aslkdfjh adfjkhl", :short => '-m', :long => '--multi', :type => :string, :multi => true
-  end
-
-  app.action do |options, arguments|
-    puts "Action for my_command\nglobal options: #{options} \narguments: #{arguments}"
-  end
-end

data/lib/escort/formatter/common.rb

@@ -1,58 +0,0 @@
-module Escort
-  module Formatter
-    module Common
-      def option_output_strings(parser)
-        options = {}
-        parser.specs.each do |name, spec|
-          options[name] = "--#{spec[:long]}" +
-          (spec[:type] == :flag && spec[:default] ? ", --no-#{spec[:long]}" : "") +
-          (spec[:short] && spec[:short] != :none ? ", -#{spec[:short]}" : "") +
-          case spec[:type]
-          when :flag; ""
-          when :int; " <i>"
-          when :ints; " <i+>"
-          when :string; " <s>"
-          when :strings; " <s+>"
-          when :float; " <f>"
-          when :floats; " <f+>"
-          when :io; " <filename/uri>"
-          when :ios; " <filename/uri+>"
-          when :date; " <date>"
-          when :dates; " <date+>"
-          end
-        end
-
-        parser.order.each do |what, opt|
-          if what == :text
-            next
-          end
-          spec = parser.specs[opt]
-          desc = spec[:desc] + begin
-            default_s = case spec[:default]
-            when $stdout; "<stdout>"
-            when $stdin; "<stdin>"
-            when $stderr; "<stderr>"
-            when Array
-              spec[:default].join(", ")
-            else
-              spec[:default].to_s
-            end
-
-            if spec[:default]
-              if spec[:desc] =~ /\.$/
-                " (Default: #{default_s})"
-              else
-                " (default: #{default_s})"
-              end
-            else
-              ""
-            end
-          end
-          options[opt] = {:string => options[opt]}
-          options[opt][:desc] = desc
-        end
-        options
-      end
-    end
-  end
-end

data/spec/helpers/exit_with_code_matcher.rb

@@ -1,21 +0,0 @@
-RSpec::Matchers.define :exit_with_code do |exp_code|
-  actual = nil
-  match do |block|
-    begin
-      block.call
-    rescue SystemExit => e
-      actual = e.status
-    end
-    actual and actual == exp_code
-  end
-  failure_message_for_should do |block|
-    "expected block to call exit(#{exp_code}) but exit" +
-      (actual.nil? ? " not called" : "(#{actual}) was called")
-  end
-  failure_message_for_should_not do |block|
-    "expected block not to call exit(#{exp_code})"
-  end
-  description do
-    "expect block to call exit(#{exp_code})"
-  end
-end

data/spec/helpers/give_option_to_action_with_value_matcher.rb

@@ -1,22 +0,0 @@
-RSpec::Matchers.define :give_option_to_action_with_value do |option_name, expected_value, result|
-  match do |block|
-    begin
-      block.call
-    rescue SystemExit => e
-    end
-    options = result[1] || {}
-    options.keys.include?(option_name) && options[option_name] == expected_value
-  end
-
-  failure_message_for_should do |block|
-    "'#{option_name}' should have been passed to action with value '#{expected_value}', but instead we got '#{(result[1] || {})[option_name]}'"
-  end
-
-  failure_message_for_should_not do |block|
-    "'#{option_name}' should not have been passed to action with value '#{expected_value}'"
-  end
-
-  description do
-    "'#{option_name}' should have been passed to action with value '#{expected_value}'"
-  end
-end