escort 0.0.1 → 0.1.0

data/examples/3_validations.rb

@@ -0,0 +1,31 @@
+#!/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/4_1_config_file.rb

@@ -0,0 +1,42 @@
+#!/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

data/examples/argument_handling/basic.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "..", "lib", "escort"))
+
+Escort::App.create do |app|
+  app.options do
+    opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
+  end
+
+  app.action do |global_options, arguments|
+    puts "Action for my_command\nglobal options: #{global_options} \narguments: #{arguments}"
+  end
+end

data/examples/argument_handling/basic_command.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "..", "lib", "escort"))
+
+Escort::App.create do |app|
+  app.options do
+    opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
+  end
+
+  app.command :my_command do |command|
+    command.options do
+      opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
+    end
+
+    command.action do |global_options, command_options, arguments|
+      puts "Action for my_command\nglobal options: #{global_options} \ncommand options: #{command_options}\narguments: #{arguments}"
+    end
+  end
+end

data/examples/argument_handling/no_arguments.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "..", "lib", "escort"))
+
+Escort::App.create do |app|
+  app.valid_with_no_arguments
+
+  app.options do
+    opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
+  end
+
+  app.action do |global_options, arguments|
+    puts "Action for my_command\nglobal options: #{global_options} \narguments: #{arguments}"
+  end
+end

data/examples/argument_handling/no_arguments_command.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "..", "lib", "escort"))
+
+Escort::App.create do |app|
+  app.valid_with_no_arguments
+
+  app.options do
+    opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
+  end
+
+  app.command :my_command do |command|
+    command.options do
+      opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
+    end
+
+    command.action do |global_options, command_options, arguments|
+      puts "Action for my_command\nglobal options: #{global_options} \ncommand options: #{command_options}\narguments: #{arguments}"
+    end
+  end
+end

data/examples/basic/app.rb

@@ -0,0 +1,16 @@
+#!/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/examples/command_aliases/app.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "..", "lib", "escort"))
+
+Escort::App.create do |app|
+  #app.summary "An app that does crazy things"
+  #app.description "An app that asdfk df;adf a;df a;dfj a;df a;ldfkj a;lksdjf a;ldjf a;lfdj a;lsdfkj a;ldsfjk a;lksdfj a;lskdfj a;lkdfj a;ldfkj a;ldfjk a;ldfkj adf"
+
+  app.options do
+    opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
+  end
+
+  app.command :my_command, :description => "Command that does stuff", :aliases => [:mc, :mooc] do |command|
+    command.options do
+      opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
+    end
+
+    command.action do |global_options, command_options, arguments|
+      puts "Action for my_command\nglobal options: #{global_options} \ncommand options: #{command_options}\narguments: #{arguments}"
+    end
+  end
+
+  app.command :blah, :description => "Command that does stuff adlkfjal;sdf alsdkjfa;ldkfj a;lsdfjk a;lsdfj a;ldkfj a;ldfkj a;lsdfj a;lfdjk" do |command|
+    command.options do
+      opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
+    end
+
+    command.action do |global_options, command_options, arguments|
+      puts "Action for my_command\nglobal options: #{global_options} \ncommand options: #{command_options}\narguments: #{arguments}"
+    end
+  end
+end

data/examples/config_file/.apprc2

@@ -0,0 +1,16 @@
+{
+  "global_options": {
+    "global_option": "local",
+    "another_option": "world",
+    "blah": true
+  },
+  "command_options": {
+    "my_command": {
+      "command_option": "foo"
+    }
+  },
+  "user_data": {
+    "hello": "world",
+    "foo": null
+  }
+}

data/examples/config_file/app.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "..", "lib", "escort"))
+
+Escort::App.create do |app|
+  app.summary "An app that does crazy things"
+  app.description "An app that asdfk df;adf a;df a;dfj a;df a;ldfkj a;lksdjf a;ldjf a;lfdj a;lsdfkj a;ldsfjk a;lksdfj a;lskdfj a;lkdfj a;ldfkj a;ldfjk a;ldfkj adf"
+
+  #app.config_file ".apprc", :autocreate => true
+
+  app.options do
+    opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
+    opt :another_option, "Another option", :short => '-a', :long => '--another', :type => :string, :default => "hello"
+    opt :blah, "Blah options", :short => '-b', :long => '--blah', :type => :flag
+  end
+
+  app.validations do |opts|
+    opts.validate(:global_option, "must be either 'global' or 'local'") { |option| ["global", "local"].include?(option) }
+  end
+
+  app.action do |global_options, arguments, config|
+    puts "Action for my_command\nglobal options: #{global_options} \narguments: #{arguments}\nuser config data: #{config}"
+    #puts "Action for my_command\nglobal options: #{global_options} \narguments: #{arguments}"
+  end
+end
+
+#config file is loaded automatically if it exists by walking up the directory tree when config file is specified DONE
+#values from config file are merged into the parser correctly for global DONE
+#values from config file are correctly overriden by those provided on the command line DONE
+#values from config file get validated correctly DONE
+#values from config file are merged into the parser correctly for commands DONE
+#user config data can be passed through to action handling code DONE
+#
+#config file automatically gets created in user home directory when autocreate is true
+#when config file is automatically created all the global and command options get put in there with default values
+#when option --config get specified the provided config file is loaded as the default config file then execution continues
+#when option --create-default-config is specified and autocreate is false a default config file is created, if it doesn't exist yet, before being read and execution continues
+#when option --create-config is specified a config file with that name and default values is created, if it doesn't exit yet, before being read and execution continues
+#another global option needs to be created to allow user to set it to be notified which config file if any is being used for this session
+
+#app.rb --create-config = './yaddarc'
+#app.rb --config = './yaddarc'
+
+  #- ability to switch on and off default creation of config file X
+  #- an option to read specific config file instead of the default X
+  #- a flag to create a default config in a specific directory X
+  #- the ability to by default read a config file by walking up the directory tree X
+  #- config file options should be validated just like the command line options ??
+  #- ability to configure global options and command specific options (through the file) ??
+  #- ability to configure extra user data that may be needed (through the file) ??
+#how will we pass the user level configuration up to handling code???
+
+#by default no configuration file at all DONE
+#if config_file was configured on the app DONE
+  # the app gets a global --config options which takes a path of file to use as configuration file
+  # the app gets a global --create-config which can have a path passed to it which will mean it creates a file with that name
+  # the app gets a global --create-default-config option which is a flag meaning it will create a file in home director with default name
+#if config_file specified and auto_create false DONE
+  #program will attempt to look for file by walking up the directory tree on every invocation DONE
+  #but file never gets automatically created DONE
+#if config_file specified and auto_create true
+  #program will attempt to look for file by walking up the directory tree on every invocation
+  #if it doesn't exist when app is run then file gets created with some default values in the user home directory
+#autoloading only works with files that are default named if custom named config file is created either manually or through --create-config then you can only used it via the --config global option, this is obvious
+#creating a default named config file via --create-config without passing in a path will allow you to run the script from that directory and have that file picked up in preference to anyother config file lower down in the directory tree (e.g. in the home directory), this way you can have the script installed globally and run it from different directories with different default options
+#config file format will be json:
+#{
+  #:global_options => {
+  #},
+  #:command_options => {
+    #:my_command => {
+    #},
+    #:blah_command => {
+    #}
+  #},
+  #:user_data => {
+  #}
+#}
+#need to validate the options parts of the config file to make sure there is no rubbish in there

data/examples/config_file/sub_commands.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "..", "lib", "escort"))
+
+Escort::App.create do |app|
+  app.summary "An app that does crazy things"
+  app.description "An app that asdfk df;adf a;df a;dfj a;df a;ldfkj a;lksdjf a;ldjf a;lfdj a;lsdfkj a;ldsfjk a;lksdfj a;lskdfj a;lkdfj a;ldfkj a;ldfjk a;ldfkj adf"
+
+  app.config_file ".apprc"#, :autocreate => true
+
+  app.options do
+    opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
+    opt :another_option, "Another option", :short => '-a', :long => '--another', :type => :string, :default => "hello"
+    opt :blah, "Blah options", :short => '-b', :long => '--blah', :type => :flag
+  end
+
+  app.validations do |opts|
+    opts.validate(:global_option, "must be either 'global' or 'local'") { |option| ["global", "local"].include?(option) }
+  end
+
+  app.command :my_command, :description => "KJHLKJH askj aldkjfhakldfjh akdjfh alkdfhj alkdjhf alkjsdhf alkjsdhf aklsjdhf aklsjdhf akljdhf alkdjfh" do |command|
+    command.options do
+      opt :command_option, "Command option", :short => '-c', :long => '--command', :type => :string, :default => "blah"
+      opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
+    end
+
+    command.action do |global_options, command_options, arguments, config|
+      puts "Action for my_command\nglobal options: #{global_options} \ncommand options: #{command_options}\narguments: #{arguments}\nuser config data: #{config}"
+    end
+  end
+
+  #app.action do |global_options, arguments, config|
+    #puts "Action for my_command\nglobal options: #{global_options} \narguments: #{arguments}\nuser config data: #{config}"
+    ##puts "Action for my_command\nglobal options: #{global_options} \narguments: #{arguments}"
+  #end
+end

data/examples/default_command/app.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "..", "lib", "escort"))
+
+Escort::App.create do |app|
+  app.default "-g 'local' my_command --no-do-stuff foobar"
+
+  app.options do
+    opt :global_option, "Global option", :short => '-g', :long => '--global', :type => :string, :default => "global"
+  end
+
+  app.command :my_command do |command|
+    command.options do
+      opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
+    end
+
+    command.action do |global_options, command_options, arguments|
+      puts "Action for my_command\nglobal options: #{global_options} \ncommand options: #{command_options}\narguments: #{arguments}"
+    end
+  end
+end

data/examples/sub_commands/app.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "..", "lib", "escort"))
+
+Escort::App.create do |app|
+  app.options do
+    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
+      opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
+    end
+
+    command.action do |global_options, command_options, arguments|
+      puts "Action for my_command\nglobal options: #{global_options} \ncommand options: #{command_options}\narguments: #{arguments}"
+    end
+  end
+end

data/examples/validation_basic/app.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "..", "lib", "escort"))
+
+Escort::App.create do |app|
+  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", :short => '-m', :long => '--multi', :type => :string, :multi => true
+    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
+      opt :do_stuff, "Do stuff", :short => :none, :long => '--do-stuff', :type => :boolean, :default => true
+      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 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 |global_options, command_options, arguments|
+      puts "Action for my_command\nglobal options: #{global_options} \ncommand options: #{command_options}\narguments: #{arguments}"
+    end
+  end
+end

data/lib/escort.rb

@@ -1,9 +1,56 @@
 require 'escort/version'
-
 require 'escort/trollop'
+require 'escort/utils'
+require 'escort/arguments'
+require 'escort/logger'
+
+require 'escort/error/error'
+
+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/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/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'
+
+require 'escort/setup_accessor'
 
-require 'escort/global_dsl'
-require 'escort/dsl'
+require 'escort/validator'
+require 'escort/auto_options'
+require 'escort/global_pre_parser'
+require 'escort/option_parser'
+
+require 'escort/action_command/base'
+require 'escort/action_command/escort_utility_command'
 
-require 'escort/command'
 require 'escort/app'
+
+at_exit do
+  Escort::Logger.close
+end
+
+def error_logger
+  Escort::Logger.error
+end
+
+def output_logger
+  Escort::Logger.output
+end
+
+