convoy 1.0.0

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/convoy.gemspec

@@ -0,0 +1,24 @@
+$LOAD_PATH << File.expand_path(File.join('..', 'lib'), __FILE__)
+
+require 'date'
+
+Gem::Specification.new do |s|
+    s.name = 'convoy'
+    s.version = '1.0.0'
+    s.date = Date.today.to_s
+    s.summary = %q{A library that makes building command line apps in ruby so easy, you'll feel like an expert is guiding you through it}
+    s.description = %q{Writing even complex command-line apps should be quick, easy and fun. Convoy 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.}
+    s.authors = ['Albert Rannetsperger']
+    s.email = 'alb3rtuk@hotmail.com'
+    s.homepage = 'http://github.com/alb3rtuk/convoy'
+    s.license = 'MIT'
+    s.require_paths = ['lib']
+    s.files = `git ls-files`.split($/)
+    s.test_files = s.files.grep(%r{^(test|spec|features)/})
+    s.add_runtime_dependency 'nesty', '~> 1.0', '>= 1.0.2'
+    s.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
+    s.add_development_dependency 'fakefs', '~> 0.5', '>= 0.5.3'
+    s.add_development_dependency 'rake', '~> 10.3', '>= 10.3.2'
+    s.add_development_dependency 'travis-lint', '~> 2.0', '>= 2.0.0'
+    s.executables = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+end

data/examples/.my_apprc

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

data/examples/basic

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "convoy"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Convoy::App.create do |app|
+    app.action do |options, arguments|
+        Convoy::ExampleCommand.new(options, arguments).execute
+    end
+end

data/examples/basic_config_file

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "convoy"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Convoy::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|
+        Convoy::ExampleCommand.new(options, arguments).execute
+    end
+end

data/examples/basic_conflicts

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "convoy"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Convoy::App.create do |app|
+    app.options do |opts|
+        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
+    end
+
+    app.action do |options, arguments|
+        Convoy::ExampleCommand.new(options, arguments).execute
+    end
+end

data/examples/basic_depends_on

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "convoy"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Convoy::App.create do |app|
+    app.options do |opts|
+        opts.opt :flag1, "Flag 1", :short => '-f', :long => '--flag1', :type => :boolean
+        opts.opt :flag2, "Flag 2", :short => :none, :long => '--flag2', :type => :boolean, :default => true
+        opts.opt :option1, "Option1", :short => '-o', :long => '--option1', :type => :string
+        opts.opt :option2, "Option2", :short => :none, :long => '--option2', :type => :string, :multi => true
+        opts.opt :option3, "Option3", :short => :none, :long => '--option3', :type => :string
+        opts.opt :option4, "Option4", :short => :none, :long => '--option4', :type => :string
+
+        opts.dependency :option1, :on => :flag1
+        opts.dependency :option2, :on => [:flag1, :option1]
+        opts.dependency :option3, :on => {:option1 => 'foo'}
+        #opts.dependency :option4, :on => [{:flag1 => false}, :option1] #This will get you into big trouble as it can never be fulfilled
+        opts.dependency :option4, :on => [{:flag2 => false}, :option1]
+    end
+
+    app.action do |options, arguments|
+        Convoy::ExampleCommand.new(options, arguments).execute
+    end
+end

data/examples/basic_flags

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "convoy"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Convoy::App.create do |app|
+    app.options do |opts|
+        opts.opt :flag1, "Flag 1", :short => '-f', :long => '--flag1', :type => :boolean, :default => true
+        opts.opt :flag2, "Flag 2", :short => :none, :long => '--flag2', :type => :boolean
+    end
+
+    app.action do |options, arguments|
+        Convoy::ExampleCommand.new(options, arguments).execute
+    end
+end

data/examples/basic_options

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

data/examples/basic_options_multi

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "convoy"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Convoy::App.create do |app|
+    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
+    end
+
+    app.action do |options, arguments|
+        Convoy::ExampleCommand.new(options, arguments).execute
+    end
+end

data/examples/basic_require_arguments

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "convoy"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Convoy::App.create do |app|
+    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
+    end
+
+    app.action do |options, arguments|
+        Convoy::ExampleCommand.new(options, arguments).execute
+    end
+end

data/examples/basic_texts

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "convoy"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Convoy::App.create do |app|
+    app.version "0.1.1"
+    app.summary "Summary 1"
+    app.description "Description 1"
+
+    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
+    end
+
+    app.action do |options, arguments|
+        Convoy::ExampleCommand.new(options, arguments).execute
+    end
+end

data/examples/basic_validations

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "convoy"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Convoy::App.create do |app|
+    app.options do |opts|
+        opts.opt :option1, "Option 1", :short => '-o', :long => '--option1', :type => :string
+        opts.opt :int1, "Int 1", :short => '-i', :long => '--int1', :type => :int
+        opts.opt :option2, "Option 2", :short => :none, :long => '--option2', :type => :string
+
+        opts.validate(:option1, "must be either 'foo' or 'bar'") { |option| ["foo", "bar"].include?(option) }
+        opts.validate(:int1, "must be between 10 and 20 exclusive") { |option| option > 10 && option < 20 }
+        opts.validate(:option2, "must be two words") { |option| option =~ /\w\s\w/ }
+        opts.validate(:option2, "must be at least 20 characters long") { |option| option.length >= 20 }
+    end
+
+    app.action do |options, arguments|
+        Convoy::ExampleCommand.new(options, arguments).execute
+    end
+end

data/examples/basic_with_everything

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "convoy"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Convoy::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|
+        Convoy::ExampleCommand.new(options, arguments).execute
+    end
+end

data/examples/commands/example_command.rb

@@ -0,0 +1,13 @@
+module Convoy
+    class ExampleCommand < ::Convoy::ActionCommand::Base
+        def execute
+            Convoy::Logger.output.puts "Command: #{command_name}"
+            Convoy::Logger.output.puts "Options: #{options}"
+            Convoy::Logger.output.puts "Command options: #{command_options}"
+            Convoy::Logger.output.puts "Arguments: #{arguments}"
+            if config
+                Convoy::Logger.output.puts "User config: #{config}"
+            end
+        end
+    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", "convoy"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Convoy::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|
+            Convoy::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|
+            Convoy::ExampleCommand.new(options, arguments).execute
+        end
+    end
+
+    app.action do |options, arguments|
+        Convoy::ExampleCommand.new(options, arguments).execute
+    end
+end

data/examples/suite_simple

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.expand_path(__FILE__), "..", "..", "lib", "convoy"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Convoy::App.create do |app|
+    app.command :command1, :aliases => [:c1, :com1] do |command|
+        command.summary "Command summary 1"
+        command.description "Command description 1"
+
+        command.action do |options, arguments|
+            Convoy::ExampleCommand.new(options, arguments).execute
+        end
+    end
+
+    app.action do |options, arguments|
+        Convoy::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", "convoy"))
+require File.join(File.expand_path(__FILE__), "..", "commands", "example_command")
+
+Convoy::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|
+            Convoy::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|
+                Convoy::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|
+                Convoy::ExampleCommand.new(options, arguments).execute
+            end
+        end
+
+        command.action do |options, arguments|
+            Convoy::ExampleCommand.new(options, arguments).execute
+        end
+    end
+
+    app.action do |options, arguments|
+        Convoy::ExampleCommand.new(options, arguments).execute
+    end
+end