escort 0.2.1 → 0.3.0

data/spec/lib/escort/setup/configuration/reader_spec.rb

@@ -0,0 +1,41 @@
+describe Escort::Setup::Configuration::Reader do
+  include FakeFS::SpecHelpers
+
+  let(:reader) {Escort::Setup::Configuration::Reader.new(path)}
+  let(:path) {'/usr/alan/blah.json'}
+  let(:data) { {:hello => :world} }
+
+  describe "#read" do
+    subject {reader.read}
+
+    context "when path not given" do
+      let(:path) {nil}
+      it{subject.should be_empty}
+    end
+
+    context "when configuration file not present" do
+      before do
+        FileUtils.mkdir_p(File.dirname path)
+      end
+      it{subject.should be_empty}
+    end
+
+    context "when configuration file not JSON" do
+      before do
+        FileUtils.mkdir_p(File.dirname path)
+        File.open(path, 'w') {|f| f.write("hello") }
+      end
+      it{subject.should be_empty}
+    end
+
+    context "when configuration file present" do
+      let(:config_data) { {:hello => :blah} }
+
+      before do
+        FileUtils.mkdir_p(File.dirname path)
+        File.open(path, 'w') {|f| f.write(JSON.pretty_generate(config_data)) }
+      end
+      it {subject.data.should == {:hello => "blah"}}
+    end
+  end
+end

data/spec/lib/escort/setup/configuration/writer_spec.rb

@@ -0,0 +1,75 @@
+describe Escort::Setup::Configuration::Writer do
+  include FakeFS::SpecHelpers
+  let(:writer) {Escort::Setup::Configuration::Writer.new(path, data)}
+  let(:path) {'/usr/alan/blah.json'}
+  let(:data) { {:hello => :world} }
+
+  describe "#write" do
+    subject {writer.write}
+
+    context "when path is nil" do
+      let(:path) {nil}
+      it {subject.should be_empty}
+    end
+
+    context "when path is not nil" do
+      context "and the file does not exist" do
+        it {subject.should_not be_empty}
+        it {subject.path.should == path}
+        it {subject.data.should == data}
+        it("file should have the right contents") do
+          subject
+          json = File.read(path)
+          hash = ::JSON.parse(json)
+          actual_data = Escort::Utils.symbolize_keys(hash)
+          actual_data.should == {:hello => "world"}
+        end
+      end
+
+      context "and the file already exists" do
+        before do
+          FileUtils.mkdir_p(File.dirname path)
+          FileUtils.touch(path)
+        end
+        it {subject.should be_empty}
+      end
+    end
+  end
+
+  describe "#update" do
+    subject {writer.update}
+
+    context "when file does not exist" do
+      it {subject.should_not be_empty}
+      it {subject.path.should == path}
+      it {subject.data.should == data}
+      it("file should have the right contents") do
+        subject
+        json = File.read(path)
+        hash = ::JSON.parse(json)
+        actual_data = Escort::Utils.symbolize_keys(hash)
+        actual_data.should == {:hello => "world"}
+      end
+    end
+
+    context "when file does exit" do
+      let(:previous_data) { {:hello => :blah} }
+      let(:data) { {:hello => :world, :foo => :bar} }
+      before do
+        FileUtils.mkdir_p(File.dirname path)
+        File.open(path, 'w') {|f| f.write(JSON.pretty_generate(previous_data)) }
+      end
+
+      it {subject.should_not be_empty}
+      it {subject.path.should == path}
+      it {subject.data.should == data}
+      it("file should have the right contents") do
+        subject
+        json = File.read(path)
+        hash = ::JSON.parse(json)
+        actual_data = Escort::Utils.symbolize_keys(hash)
+        actual_data.should == {:hello=>"blah", :foo=>"bar"}
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'escort'
-
+require 'fakefs/safe'
+require 'fakefs/spec_helpers'
 
 Dir[File.join(File.dirname(__FILE__), 'support', '**', "*.rb").to_s].each {|file| require file }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: escort
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Alan Skorkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-06 00:00:00.000000000 Z
+date: 2013-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -87,25 +87,9 @@ files:
 - Rakefile
 - TODO.md
 - escort.gemspec
-- 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/.my_apprc
 - examples/basic
+- examples/basic_config_file
 - examples/basic_conflicts
 - examples/basic_depends_on
 - examples/basic_flags
@@ -114,8 +98,11 @@ files:
 - examples/basic_require_arguments
 - examples/basic_texts
 - examples/basic_validations
-- examples/command
+- examples/basic_with_everything
 - examples/commands/example_command.rb
+- examples/suite_complex
+- examples/suite_simple
+- examples/suite_with_sub_commands
 - lib/escort.rb
 - lib/escort/action_command/base.rb
 - lib/escort/action_command/escort_utility_command.rb
@@ -123,17 +110,18 @@ files:
 - lib/escort/arguments.rb
 - lib/escort/auto_options.rb
 - lib/escort/error/error.rb
-- lib/escort/formatter/borderless_table.rb
 - lib/escort/formatter/command.rb
 - lib/escort/formatter/commands.rb
+- lib/escort/formatter/cursor_position.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/stream_output_formatter.rb
+- lib/escort/formatter/string_grid.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
@@ -142,7 +130,10 @@ files:
 - lib/escort/setup/configuration/instance.rb
 - lib/escort/setup/configuration/loader.rb
 - lib/escort/setup/configuration/locator/base.rb
+- lib/escort/setup/configuration/locator/chaining.rb
 - lib/escort/setup/configuration/locator/descending_to_home.rb
+- lib/escort/setup/configuration/locator/executing_script_directory.rb
+- lib/escort/setup/configuration/locator/specified_directory.rb
 - lib/escort/setup/configuration/merge_tool.rb
 - lib/escort/setup/configuration/reader.rb
 - lib/escort/setup/configuration/writer.rb
@@ -151,12 +142,12 @@ files:
 - 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/integration/basic_config_file_spec.rb
 - spec/integration/basic_conflicts_spec.rb
 - spec/integration/basic_depends_on_spec.rb
 - spec/integration/basic_options_spec.rb
@@ -165,12 +156,26 @@ files:
 - spec/integration/basic_validations_spec.rb
 - spec/integration/basic_with_arguments_spec.rb
 - spec/integration/basic_with_text_fields_spec.rb
+- spec/integration/suite_simple_spec.rb
+- spec/integration/suite_sub_command_spec.rb
+- spec/lib/escort/action_command/base_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/stream_output_formatter_spec.rb
+- spec/lib/escort/formatter/string_grid_spec.rb
 - spec/lib/escort/formatter/string_splitter_spec.rb
 - spec/lib/escort/formatter/terminal_spec.rb
+- spec/lib/escort/setup/configuration/generator_spec.rb
+- spec/lib/escort/setup/configuration/loader_spec.rb
+- spec/lib/escort/setup/configuration/locator/chaining_spec.rb
+- spec/lib/escort/setup/configuration/locator/descending_to_home_spec.rb
+- spec/lib/escort/setup/configuration/locator/executing_script_directory_spec.rb
+- spec/lib/escort/setup/configuration/locator/specified_directory_spec.rb
+- spec/lib/escort/setup/configuration/merge_tool_spec.rb
+- spec/lib/escort/setup/configuration/reader_spec.rb
+- spec/lib/escort/setup/configuration/writer_spec.rb
 - spec/lib/escort/setup_accessor_spec.rb
 - spec/lib/escort/utils_spec.rb
 - spec/spec_helper.rb
@@ -205,6 +210,7 @@ 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/integration/basic_config_file_spec.rb
 - spec/integration/basic_conflicts_spec.rb
 - spec/integration/basic_depends_on_spec.rb
 - spec/integration/basic_options_spec.rb
@@ -213,12 +219,26 @@ test_files:
 - spec/integration/basic_validations_spec.rb
 - spec/integration/basic_with_arguments_spec.rb
 - spec/integration/basic_with_text_fields_spec.rb
+- spec/integration/suite_simple_spec.rb
+- spec/integration/suite_sub_command_spec.rb
+- spec/lib/escort/action_command/base_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/stream_output_formatter_spec.rb
+- spec/lib/escort/formatter/string_grid_spec.rb
 - spec/lib/escort/formatter/string_splitter_spec.rb
 - spec/lib/escort/formatter/terminal_spec.rb
+- spec/lib/escort/setup/configuration/generator_spec.rb
+- spec/lib/escort/setup/configuration/loader_spec.rb
+- spec/lib/escort/setup/configuration/locator/chaining_spec.rb
+- spec/lib/escort/setup/configuration/locator/descending_to_home_spec.rb
+- spec/lib/escort/setup/configuration/locator/executing_script_directory_spec.rb
+- spec/lib/escort/setup/configuration/locator/specified_directory_spec.rb
+- spec/lib/escort/setup/configuration/merge_tool_spec.rb
+- spec/lib/escort/setup/configuration/reader_spec.rb
+- spec/lib/escort/setup/configuration/writer_spec.rb
 - spec/lib/escort/setup_accessor_spec.rb
 - spec/lib/escort/utils_spec.rb
 - spec/spec_helper.rb

data/examples/attic/1_1_basic.rb

@@ -1,15 +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.5"
-
-  app.options do |opts|
-    opts.opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
-    opts.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 \nglobal options: #{options} \narguments: #{arguments}"
-  end
-end

data/examples/attic/1_2_basic_requires_arguments.rb

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "escort"))
-
-Escort::App.create do |app|
-  app.requires_arguments
-
-  app.options do |opts|
-    opts.opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
-    opts.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 \nglobal options: #{options} \narguments: #{arguments}"
-  end
-end

data/examples/attic/2_2_command.rb

@@ -1,18 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "escort"))
-
-Escort::App.create do |app|
-  app.options do |opts|
-    opts.opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
-  end
-
-  app.command :my_command, :description => "KJHLKJH askj aldkjfhakldfjh akdjfh alkdfhj alkdjhf alkjsdhf alkjsdhf aklsjdhf aklsjdhf akljdhf alkdjfh" do |command|
-    command.options do |opts|
-      opts.opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
-    end
-
-    command.action do |options, arguments|
-      puts "Action for my_command\noptions: #{options} \narguments: #{arguments}"
-    end
-  end
-end

data/examples/attic/2_2_command_requires_arguments.rb

@@ -1,20 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "escort"))
-
-Escort::App.create do |app|
-  app.options do |opts|
-    opts.opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
-  end
-
-  app.command :my_command, :description => "KJHLKJH askj aldkjfhakldfjh akdjfh alkdfhj alkdjhf alkjsdhf alkjsdhf aklsjdhf aklsjdhf akljdhf alkdjfh" do |command|
-    command.requires_arguments
-
-    command.options do |opts|
-      opts.opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
-    end
-
-    command.action do |options, arguments|
-      puts "Action for my_command\noptions: #{options} \narguments: #{arguments}"
-    end
-  end
-end

data/examples/attic/2_3_nested_commands.rb

@@ -1,26 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "escort"))
-
-Escort::App.create do |app|
-  app.options do |opts|
-    opts.opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
-  end
-
-  app.command :my_command, :description => "KJHLKJH askj aldkjfhakldfjh akdjfh alkdfhj alkdjhf alkjsdhf alkjsdhf aklsjdhf aklsjdhf akljdhf alkdjfh" do |command|
-    command.requires_arguments
-
-    command.options do |opts|
-      opts.opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
-    end
-
-    command.action do |options, arguments|
-      puts "Action for my_command\noptions: #{options} \narguments: #{arguments}"
-    end
-
-    command.command :nested_command, :description => "A nested sub command" do |command|
-      command.action do |options, arguments|
-        puts "Action for my_command nested_command\noptions: #{options} \narguments: #{arguments}"
-      end
-    end
-  end
-end

data/examples/attic/3_validations.rb

@@ -1,31 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "escort"))
-
-Escort::App.create do |app|
-  app.options do |opts|
-    opts.opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
-    opts.opt :multi_option, "Option that can be specified multiple times", :short => '-m', :long => '--multi', :type => :string, :multi => true
-    opts.opt :a_number, "Do stuff", :short => "-n", :long => '--number', :type => :int
-  end
-
-  app.validations do |opts|
-    opts.validate(:global_option, "must be either 'global' or 'local'") { |option| ["global", "local"].include?(option) }
-    opts.validate(:a_number, "must be between 10 and 20 exclusive") { |option| option > 10 && option < 20 }
-  end
-
-  app.command :my_command do |command|
-    command.options do |opts|
-      opts.opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
-      opts.opt :string_with_format, "String with format", :short => "-f", :long => '--format', :type => :string, :default => "blah yadda11111111111"
-    end
-
-    command.validations do |opts|
-      opts.validate(:string_with_format, "should be at least two words") {|option| option =~ /\w\s\w/}
-      opts.validate(:string_with_format, "should be at least 20 characters long") {|option| option.length >= 20}
-    end
-
-    command.action do |options, arguments|
-      puts "Action for my_command\noptions: #{options} \narguments: #{arguments}"
-    end
-  end
-end

data/examples/attic/4_1_config_file.rb

@@ -1,42 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "escort"))
-
-Escort::App.create do |app|
-  app.options do |opts|
-    opts.opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
-    opts.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.config_file ".apprc", :autocreate => true
-
-  app.summary "Sum1"
-  app.description "Desc1"
-
-  app.command :my_command, :description => "KJHLKJH askj aldkjfhakldfjh akdjfh alkdfhj alkdjhf alkjsdhf alkjsdhf aklsjdhf aklsjdhf akljdhf alkdjfh", :aliases => [:my1, :my2] do |command|
-    #command.requires_arguments
-    command.summary "Sum2"
-    command.description "Desc2"
-
-    command.options do |opts|
-      opts.opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
-    end
-
-    command.action do |options, arguments|
-      puts "Action for my_command\noptions: #{options} \narguments: #{arguments}"
-    end
-
-    command.command :nested_command, :description => "A nested sub command" do |command|
-      command.options do |opts|
-        opts.opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
-      end
-
-      command.action do |options, arguments|
-        puts "Action for my_command nested_command\noptions: #{options} \narguments: #{arguments}"
-      end
-    end
-  end
-
-  app.action do |options, arguments, config|
-    puts "Action \nglobal options: #{options} \narguments: #{arguments}\nconfig: #{config}"
-  end
-end