escort 0.2.1 → 0.3.0

data/examples/.my_apprc

@@ -0,0 +1,24 @@
+{
+  "global": {
+    "options": {
+      "option1": "option from file",
+      "config": null,
+      "verbosity": "WARN",
+      "error_output_format": "basic"
+    },
+    "commands": {
+      "escort": {
+        "options": {
+          "create_config": null,
+          "create_default_config": null,
+          "update_config": null,
+          "update_default_config": null
+        },
+        "commands": {
+        }
+      }
+    }
+  },
+  "user": {
+  }
+}

data/examples/basic_config_file

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "escort"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Escort::App.create do |app|
+  app.config_file ".my_apprc", :autocreate => true
+
+  app.options do |opts|
+    opts.opt :option1, "Option1", :short => '-o', :long => '--option1', :type => :string, :default => "option 1"
+  end
+
+  app.action do |options, arguments|
+    Escort::ExampleCommand.new(options, arguments).execute
+  end
+end

data/examples/basic_conflicts

@@ -8,7 +8,7 @@ Escort::App.create do |app|
     opts.opt :flag1, "Flag 1", :short => '-f', :long => '--flag1', :type => :boolean
     opts.opt :flag2, "Flag 2", :short => :none, :long => '--flag2', :type => :boolean
 
-    opts.conflict :flag1, :flag2, :flag3
+    opts.conflict :flag1, :flag2
   end
 
   app.action do |options, arguments|

data/examples/basic_with_everything

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "escort"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Escort::App.create do |app|
+  app.version "0.1.1"
+  app.summary "Summary 1"
+  app.description "Description 1"
+
+  app.config_file ".my_apprc", :autocreate => false
+
+  app.requires_arguments
+
+  app.options do |opts|
+    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|
+    Escort::ExampleCommand.new(options, arguments).execute
+  end
+end

data/examples/suite_complex

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "escort"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Escort::App.create do |app|
+  app.version "0.1.1"
+  app.summary "Summary 1"
+  app.description "Description 1"
+
+  app.config_file ".my_apprc", :autocreate => false
+
+  app.requires_arguments
+
+  app.options do |opts|
+    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.command :command1  do |command|
+    command.summary "Command summary 1"
+    command.description "Command description 1"
+
+    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|
+      Escort::ExampleCommand.new(options, arguments).execute
+    end
+  end
+
+  app.command :command2, :aliases => :c2  do |command|
+    command.summary "Command summary 2"
+    command.description "Command description 2"
+
+    command.requires_arguments false
+
+    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|
+      Escort::ExampleCommand.new(options, arguments).execute
+    end
+  end
+
+  app.action do |options, arguments|
+    Escort::ExampleCommand.new(options, arguments).execute
+  end
+end

data/examples/suite_with_sub_commands

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "escort"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Escort::App.create do |app|
+  app.version "0.1.1"
+  app.summary "Summary 1"
+  app.description "Description 1"
+
+  app.config_file ".my_apprc", :autocreate => false
+
+  app.requires_arguments
+
+  app.options do |opts|
+    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.command :command1  do |command|
+    command.summary "Command summary 1"
+    command.description "Command description 1"
+
+    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|
+      Escort::ExampleCommand.new(options, arguments).execute
+    end
+  end
+
+  app.command :command2, :aliases => :c2  do |command|
+    command.summary "Command summary 2"
+    command.description "Command description 2"
+
+    command.requires_arguments false
+
+    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.summary "Sub command summary 1"
+      command.description "Sub command description 1"
+
+      command.requires_arguments
+
+      command.options do |opts|
+        opts.opt :flag2, "Flag 2", :short => :none, :long => '--flag2', :type => :boolean
+      end
+
+      command.action do |options, arguments|
+        Escort::ExampleCommand.new(options, arguments).execute
+      end
+    end
+
+    command.command :sub_command2  do |command|
+      command.summary "Sub command summary 2"
+      command.description "Sub command description 2"
+
+      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|
+        Escort::ExampleCommand.new(options, arguments).execute
+      end
+    end
+
+    command.action do |options, arguments|
+      Escort::ExampleCommand.new(options, arguments).execute
+    end
+  end
+
+  app.action do |options, arguments|
+    Escort::ExampleCommand.new(options, arguments).execute
+  end
+end

data/lib/escort.rb

@@ -14,20 +14,22 @@ require 'escort/formatter/global_command'
 require 'escort/formatter/shell_command_executor'
 require 'escort/formatter/terminal'
 require 'escort/formatter/string_splitter'
-require 'escort/formatter/terminal_formatter'
-require 'escort/formatter/borderless_table'
-#require 'escort/formatter/common'
+require 'escort/formatter/cursor_position'
+require 'escort/formatter/stream_output_formatter'
+require 'escort/formatter/string_grid'
 require 'escort/formatter/default_help_formatter'
 
 require 'escort/setup/dsl/options'
 require 'escort/setup/dsl/action'
-require 'escort/setup/dsl/validations'
 require 'escort/setup/dsl/command'
 require 'escort/setup/dsl/config_file'
 require 'escort/setup/dsl/global'
 
 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'

data/lib/escort/action_command/base.rb

@@ -19,17 +19,18 @@ module Escort
       def command_context
         return @command_context if @command_context
         @command_context = []
-        current_command_hash = options[:global][:commands]
+        options[:global] ||= {}
+        current_command_hash = options[:global][:commands] || {}
         until current_command_hash.keys.empty?
           key = current_command_hash.keys.first
           @command_context << key
-          current_command_hash = current_command_hash[key][:commands]
+          current_command_hash = current_command_hash[key][:commands] || {}
         end
         @command_context
       end
 
       def command_name
-        command_context.first || :global
+        command_context.last || :global
       end
 
       def command_options
@@ -73,8 +74,9 @@ module Escort
       end
 
       def ensure_ancestor(generation_number, &block)
-        return {} if generation_number < 1
-        return {} unless command_context.size > generation_number
+        return {} if generation_number < 0
+        #return {} if generation_number == 0
+        return {} unless command_context.size >= generation_number
         ancestor_context = command_context.dup.slice(0, command_context.size - generation_number)
         block.call(ancestor_context)
       end

data/lib/escort/app.rb

@@ -2,14 +2,6 @@ module Escort
   class App
     #TODO ensure that every command must have an action
     class << self
-      #def create(option_string = '', &block)
-        #cli_app_configuration = Escort::Setup::Dsl::Global.new(&block)
-        #setup = Escort::SetupAccessor.new(cli_app_configuration)
-        #app = self.new(option_string, setup)
-        #app.execute
-        #exit(0)
-      #end
-
       def create(option_string = '', &block)
         self.new(option_string, &block).setup_application.execute
         exit(0)
@@ -54,6 +46,8 @@ module Escort
         invoked_options, arguments = Escort::OptionParser.new(configuration, setup).parse(cli_options)
         context = context_from_options(invoked_options[:global])
         action = setup.action_for(context)
+        current_command = context.empty? ? :global : context.last
+        raise Escort::ClientError.new("No action defined for command '#{current_command}'") unless action
         actual_arguments = Escort::Arguments.read(arguments, setup.arguments_required_for(context))
       rescue => e
         handle_escort_error(e)

data/lib/escort/auto_options.rb

@@ -5,7 +5,9 @@ module Escort
         if setup.has_config_file?
           setup.add_global_option :config, "Configuration file to use for this execution", :short => :none, :long => '--config', :type => :string
 
-          setup.add_global_command :escort, :description => "Auto created utility command", :aliases => [] do |command|
+          setup.add_global_command :escort, :aliases => [] do |command|
+            command.summary "Auto created utility command"
+            command.description "Auto created utility command"
             command.requires_arguments false
 
             command.options do |opts|
@@ -13,9 +15,9 @@ module Escort
               opts.opt :create_default_config, "Create a default configuration file", :short => :none, :long => '--create-default-config', :type => :boolean, :default => false
               opts.opt :update_config, "Update configuration file at specified location", :short => :none, :long => '--update-config', :type => :string
               opts.opt :update_default_config, "Update the default configuration file", :short => :none, :long => '--update-default-config', :type => :boolean, :default => false
-            end
 
-            command.conflicting_options :create_config, :create_default_config, :update_config, :update_default_config
+              opts.conflict :create_config, :create_default_config, :update_config, :update_default_config
+            end
 
             command.action do |options, arguments|
               ActionCommand::EscortUtilityCommand.new(setup, options, arguments).execute

data/lib/escort/formatter/cursor_position.rb

@@ -0,0 +1,29 @@
+module Escort
+  module Formatter
+    class CursorPosition
+      attr_reader :max_line_width, :position
+
+      def initialize(max_line_width)
+        @max_line_width = max_line_width
+        reset
+      end
+
+      def update_for(string)
+        @position += string.length
+        raise Escort::InternalError.new("Cursor position for help output is out of bounds") if position > max_line_width
+      end
+
+      def newline?
+        @position == 0
+      end
+
+      def reset
+        @position = 0
+      end
+
+      def chars_to_end_of_line
+        max_line_width - position
+      end
+    end
+  end
+end

data/lib/escort/formatter/default_help_formatter.rb

@@ -13,48 +13,49 @@ module Escort
         commands = Commands.new(setup, context)
         current_command = Commands.command_for(setup, context)
 
-        TerminalFormatter.display($stdout, Terminal.width) do |d|
-          name_help(current_command, d)
-          usage_help(current_command, d)
-          version_help(current_command, d)
-          options_help(options, d)
-          commands_help(commands, d)
+        StreamOutputFormatter.new($stdout, :max_output_width => Terminal.width) do |f|
+          name_help(current_command, f)
+          usage_help(current_command, f)
+          version_help(current_command, f)
+          options_help(options, f)
+          commands_help(commands, f)
         end
       end
 
       private
 
-      def name_help(current_command, d)
-        d.puts "NAME"
-        d.indent(4) do
-          d.table(:columns => 3, :newlines => 1) do |t|
-            t.row current_command.script_name, '-', current_command.summary
+      def name_help(current_command, f)
+        f.puts "NAME"
+        f.indent(4) do |f|
+          f.grid(:columns => 3) do |t|
+            t.row current_command.script_name, '-', setup.summary_for(context)
           end
-          d.put(setup.description_for(context), :newlines => 2) if setup.description_for(context)
+          f.newline
+          f.puts(setup.description_for(context), :newlines => 2) if setup.description_for(context)
         end
       end
 
-      def usage_help(current_command, d)
-        d.puts "USAGE"
-        d.indent(4) do
-          d.put current_command.usage, :newlines => 2
+      def usage_help(current_command, f)
+        f.puts "USAGE"
+        f.indent(4) do |f|
+          f.puts current_command.usage, :newlines => 2
         end
       end
 
-      def version_help(current_command, d)
+      def version_help(current_command, f)
         if setup.version
-          d.puts "VERSION"
-          d.indent(4) {
-            d.put setup.version, :newlines => 2
-          }
+          f.puts "VERSION"
+          f.indent(4) do |f|
+            f.puts setup.version, :newlines => 2
+          end
         end
       end
 
-      def options_help(options, d)
+      def options_help(options, f)
         if options.count > 0
-          d.puts "OPTIONS"
-          d.indent(4) {
-            d.table(:columns => 3, :newlines => 1) do |t|
+          f.puts "OPTIONS"
+          f.indent(4) do |f|
+            f.grid(:columns => 3) do |t|
               options.each do |option|
                 t.row option.usage, '-', option.description
                 option_conflicts_help(option, t)
@@ -62,7 +63,8 @@ module Escort
                 option_validations_help(option, t)
               end
             end
-          }
+            f.newline
+          end
         end
       end
 
@@ -80,20 +82,23 @@ module Escort
 
       def option_validations_help(option, t)
         if option.has_validations?
-          t.row '', '', "- #{option.validations}"
+          option.validations.each do |validation|
+            t.row '', '', "- #{validation}"
+          end
         end
       end
 
-      def commands_help(commands, d)
+      def commands_help(commands, f)
         if commands.count > 0
-          d.puts "COMMANDS"
-          d.indent(4) {
-            d.table(:columns => 3, :newlines => 1) do |t|
+          f.puts "COMMANDS"
+          f.indent(4) do |f|
+            f.grid(:columns => 3) do |t|
               commands.each do |command|
                 t.row command.name_with_aliases, '-', command.outline
               end
             end
-          }
+            f.newline
+          end
         end
       end
     end