escort 0.0.1 → 0.1.0

data/spec/integration/basic_spec.rb

@@ -0,0 +1,24 @@
+describe "Escort basic app with no options defined" do
+  subject { Escort::App.create(option_string, &app_configuration) }
+  let(:result) { [] }
+
+  let(:app_configuration) do
+    ->(app) do
+      app.action do |options, arguments|
+        result << :global
+      end
+    end
+  end
+
+  context "when called with empty option string" do
+    let(:option_string) { "" }
+    it("should exit with code 0") { expect{ subject }.to exit_with_code(0) }
+    it("should execute the global action") { expect{subject}.to execute_action(:global, result) }
+  end
+
+  context "when called with non-empty option string" do
+    let(:option_string) { "hello" }
+    it("exit code should be 0") { expect{ subject }.to exit_with_code(0) }
+    it("should execute the global action") { expect{subject}.to execute_action(:global, result) }
+  end
+end

data/spec/lib/escort/formatter/string_splitter_spec.rb

@@ -0,0 +1,38 @@
+describe Escort::Formatter::StringSplitter do
+  let(:splitter) {Escort::Formatter::StringSplitter.new(max_segment_width)}
+
+  describe "#split" do
+    subject {splitter.split(string)}
+
+    context "when segment width is 10" do
+      let(:max_segment_width) { 10 }
+
+      context "and string is 'abc123'" do
+        let(:string) {'abc123'}
+        it("should produce 1 segment") { subject.size.should == 1 }
+        it("first segment should be 'abc123'") { subject[0].should == 'abc123' }
+      end
+
+      context "and string is 'abc1234567'" do
+        let(:string) {'abc1234567'}
+        it("should produce 1 segment") { subject.size.should == 1 }
+        it("first segment should be 'abc1234567'") { subject[0].should == 'abc1234567' }
+      end
+
+      context "and string is 'abc123abc456'" do
+        let(:string) {'abc123abc456'}
+        it("should produce 2 segments") { subject.size.should == 2 }
+        it("first segment should be 'abc123abc4'") { subject[0].should == 'abc123abc4' }
+        it("first segment should be '56'") { subject[1].should == '56' }
+      end
+
+      context "and string is 'abc123abc456bbbcccddd'" do
+        let(:string) {'abc123abc456bbbcccddd'}
+        it("should produce 3 segments") { subject.size.should == 3 }
+        it("first segment should be 'abc123abc4'") { subject[0].should == 'abc123abc4' }
+        it("first segment should be '56bbbcccdd'") { subject[1].should == '56bbbcccdd' }
+        it("first segment should be 'd'") { subject[2].should == 'd' }
+      end
+    end
+  end
+end

data/spec/lib/escort/setup_accessor_spec.rb

@@ -0,0 +1,42 @@
+describe Escort::SetupAccessor do
+  let(:setup) { Escort::SetupAccessor.new(app_configuration) }
+  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
+      end
+
+      app.action do |options, arguments|
+      end
+    end
+  end
+
+  let(:command_app_configuration) do
+  end
+
+  let(:sub_command_app_configuration) do
+  end
+
+  #context is nil
+  #no context supplied at all
+  #context is not an array
+  describe '#options_for' do
+    subject {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}
+      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 }
+      end
+    end
+  end
+end

data/spec/lib/escort/utils_spec.rb

@@ -0,0 +1,30 @@
+describe Escort::Utils do
+  describe '::symbolize_keys' do
+    subject {Escort::Utils.symbolize_keys(hash)}
+
+    context "when single level hash" do
+      let(:hash) { {'a' => 1, :b => 2} }
+      it("the :a key should be a symbol") {subject[:a].should == 1}
+      it("the :b key should be a symbol") {subject[:b].should == 2}
+    end
+
+    context "when hash has nested hashes" do
+      let(:hash) { {'a' => 1, :b => {'c' => {'d' => 2}}} }
+      it("the :a key should be a symbol") {subject[:a].should == 1}
+      it("the nested keys, :b, :c and :d should all be symbols") {subject[:b][:c][:d].should == 2}
+    end
+  end
+
+  describe '::tokenize_option_string' do
+    subject {Escort::Utils.tokenize_option_string(option_string)}
+
+    context "when option string has short option, long option and argument" do
+      let(:option_string) {"-a 1 --foo='bar blah' yadda"}
+      it("tokenized string should have 4 values") {subject.size.should == 4}
+      it("the short option should be a separate token") {subject[0].should == '-a'}
+      it("the short option value should be a separate token") {subject[1].should == '1'}
+      it("the long option and value should be one token") {subject[2].should == '--foo=bar blah'}
+      it("the argument should be a separate token") {subject[3].should == 'yadda'}
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'escort'
+#helpers
+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
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,19 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: escort
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Alan Skorkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-04 00:00:00.000000000 Z
-dependencies: []
-description: Basically we take the excellent Trollop command line options parser and
-  dress it up a little with some DSL to make writing CLI apps a bit nicer, but still
-  retain the full power of the awesome Trollop.
+date: 2013-02-28 00:00:00.000000000 Z
+dependencies:
+- !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'
+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'
+  is in order.
 email:
 - alan@skorks.com
 executables: []
@@ -21,40 +63,110 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .irbrc
+- .rspec
+- .rvmrc
 - 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
 - lib/escort.rb
+- lib/escort/action_command/base.rb
+- lib/escort/action_command/escort_utility_command.rb
 - lib/escort/app.rb
-- lib/escort/command.rb
-- lib/escort/dsl.rb
-- lib/escort/global_dsl.rb
+- lib/escort/arguments.rb
+- lib/escort/auto_options.rb
+- lib/escort/error/error.rb
+- lib/escort/formatter/borderless_table.rb
+- lib/escort/formatter/common.rb
+- lib/escort/formatter/default_help_formatter.rb
+- lib/escort/formatter/options.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_parser.rb
+- lib/escort/setup/configuration/generator.rb
+- lib/escort/setup/configuration/instance.rb
+- lib/escort/setup/configuration/loader.rb
+- lib/escort/setup/configuration/locator/base.rb
+- lib/escort/setup/configuration/locator/descending_to_home.rb
+- lib/escort/setup/configuration/merge_tool.rb
+- lib/escort/setup/configuration/reader.rb
+- lib/escort/setup/configuration/writer.rb
+- lib/escort/setup/dsl/action.rb
+- lib/escort/setup/dsl/command.rb
+- lib/escort/setup/dsl/config_file.rb
+- lib/escort/setup/dsl/global.rb
+- lib/escort/setup/dsl/options.rb
+- lib/escort/setup/dsl/validations.rb
+- lib/escort/setup_accessor.rb
 - lib/escort/trollop.rb
+- 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_options_spec.rb
+- spec/integration/basic_spec.rb
+- spec/lib/escort/formatter/string_splitter_spec.rb
+- spec/lib/escort/setup_accessor_spec.rb
+- spec/lib/escort/utils_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/skorks/escort
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
-summary: An escort is still a trollop just dressed up
-test_files: []
+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_options_spec.rb
+- spec/integration/basic_spec.rb
+- spec/lib/escort/formatter/string_splitter_spec.rb
+- spec/lib/escort/setup_accessor_spec.rb
+- spec/lib/escort/utils_spec.rb
+- spec/spec_helper.rb

data/lib/escort/command.rb

@@ -1,23 +0,0 @@
-module Escort
-  class Command
-    include Dsl
-
-    attr_reader :current_options, :name
-
-    def initialize(name, options_string)
-      @name = name
-      @options_string = options_string
-    end
-
-    def parse_options
-      parser = Trollop::Parser.new(&@options_block)
-      @current_options = Trollop::with_standard_exception_handling(parser) do
-        parser.parse @options_string
-      end
-    end
-
-    def perform_action(parent_command_options, remaining_arguments)
-      @action_block.call(parent_command_options, @current_options, remaining_arguments)
-    end
-  end
-end

data/lib/escort/dsl.rb

@@ -1,20 +0,0 @@
-module Escort
-  module Dsl
-    attr_reader :command_names
-
-    def options(&block)
-      @options_block = block
-    end
-
-    def command(name, &block)
-      @command_names ||= []
-      @command_names << name.to_s
-      @command_blocks ||= {}
-      @command_blocks[name.to_s] = block
-    end
-
-    def action(&block)
-      @action_block = block
-    end
-  end
-end

data/lib/escort/global_dsl.rb

@@ -1,11 +0,0 @@
-module Escort
-  module GlobalDsl
-    def before(&block)
-      @before_block = block
-    end
-
-    def on_error(&block)
-      @error_block = block
-    end
-  end
-end