convoy 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dce20ef0475a98ad8e3db17accdd52cf40df9402
-  data.tar.gz: f2cc919519e7b9ced080175d7630713536c5feac
+  metadata.gz: 59707815dce44c3eeb7596a097d6e363b25dd3bd
+  data.tar.gz: a53418545a1796617d42b6f554f920a9f4a16302
 SHA512:
-  metadata.gz: daa739a479de1c0685623e4686d6f4422a23ee1981de993d29bf5880f222ab70211d22bf80dba6ef1b5c865bf479eb577d06573433cd225b92facd9c7bb5dcc9
-  data.tar.gz: dcac8c553f276f5f623b3f68fc943c78a5a92b9a8118a29d78e2e8bdf28d748f739210a69216da78107acb826c0820961a0687726a5833a557c9dd7a653811ba
+  metadata.gz: 171f9831e51cb817a983833b55fbf6a865495067f35d5b56f06847ec4f7abb616cf8df8d6ab883c3c47fe3d40c486a85205436c6c19673ca4573f0f7af17504b
+  data.tar.gz: f723e0993a9b3710a94b1256152307de5cd8bda51db5c8563697e164389de50e65752b56603af439c3f256e21ec6bd299dbe4553537fdc1253d982296e91e51a

data/convoy.gemspec

@@ -2,20 +2,23 @@ $LOAD_PATH << File.expand_path(File.join('..', 'lib'), __FILE__)
 
 require 'date'
 
+require_relative 'version'
+
 Gem::Specification.new do |s|
-    s.name = 'convoy'
-    s.version = '1.1.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.name          = 'convoy'
+    s.version       = CONVOY_VERSION
+    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.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_runtime_dependency 'blufin-lib', '1.5.0', '>= 1.5.0'
     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'

data/examples/basic_depends_on

@@ -14,9 +14,9 @@ Convoy::App.create do |app|
 
         opts.dependency :option1, :on => :flag1
         opts.dependency :option2, :on => [:flag1, :option1]
-        opts.dependency :option3, :on => {:option1 => 'foo'}
+        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]
+        opts.dependency :option4, :on => [{ :flag2 => false }, :option1]
     end
 
     app.action do |options, arguments|

data/lib/convoy/action_command/base.rb

@@ -4,22 +4,22 @@ module Convoy
             attr_reader :options, :arguments, :config
 
             def initialize(options, arguments, config={})
-                @options = options
-                @arguments = arguments
-                @config = config
-                @command_context = nil
-                @command_options = nil
-                @parent_options = nil
+                @options             = options
+                @arguments           = arguments
+                @config              = config
+                @command_context     = nil
+                @command_options     = nil
+                @parent_options      = nil
                 @grandparent_options = nil
-                @global_options = nil
+                @global_options      = nil
             end
 
             protected
 
             def command_context
                 return @command_context if @command_context
-                @command_context = []
-                options[:global] ||= {}
+                @command_context     = []
+                options[:global]     ||= {}
                 current_command_hash = options[:global][:commands] || {}
                 until current_command_hash.keys.empty?
                     key = current_command_hash.keys.first

data/lib/convoy/app.rb

@@ -12,16 +12,16 @@ module Convoy
 
         def initialize(option_string, &block)
             @option_string = option_string
-            @setup = nil
-            @block = block
+            @setup         = nil
+            @block         = block
         end
 
         def setup_application
             old_error_sev_threshold = error_logger.sev_threshold
             begin
                 error_logger.sev_threshold = ::Logger::DEBUG
-                cli_app_configuration = Convoy::Setup::Dsl::Global.new(&@block)
-                @setup = Convoy::SetupAccessor.new(cli_app_configuration)
+                cli_app_configuration      = Convoy::Setup::Dsl::Global.new(&@block)
+                @setup                     = Convoy::SetupAccessor.new(cli_app_configuration)
                 self
             rescue => e
                 handle_convoy_error(e)
@@ -44,9 +44,9 @@ module Convoy
                 configuration = Convoy::Setup::Configuration::Loader.new(setup, auto_options).configuration
 
                 invoked_options, arguments = Convoy::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
+                context                    = context_from_options(invoked_options[:global])
+                action                     = setup.action_for(context)
+                current_command            = context.empty? ? :global : context.last
                 raise Convoy::ClientError.new("No action defined for command '#{current_command}'") unless action
                 actual_arguments = Convoy::Arguments.read(arguments, setup.arguments_required_for(context))
             rescue => e
@@ -89,15 +89,15 @@ module Convoy
         def handle_convoy_error(e)
             if e.kind_of?(Convoy::UserError)
                 print_stacktrace(e)
-                error_logger.debug {'Convoy app failed to execute successfully, due to user error'}
+                error_logger.debug { 'Convoy app failed to execute successfully, due to user error' }
                 exit(Convoy::USER_ERROR_EXIT_CODE)
             elsif e.kind_of?(Convoy::ClientError)
                 print_stacktrace(e)
-                error_logger.debug {'Convoy app failed to execute successfully, due to client setup error'}
+                error_logger.debug { 'Convoy app failed to execute successfully, due to client setup error' }
                 exit(Convoy::CLIENT_ERROR_EXIT_CODE)
             else
                 print_convoy_error_message(e)
-                error_logger.debug {'Convoy app failed to execute successfully, due to internal error'}
+                error_logger.debug { 'Convoy app failed to execute successfully, due to internal error' }
                 exit(Convoy::INTERNAL_ERROR_EXIT_CODE)
             end
         end
@@ -105,11 +105,11 @@ module Convoy
         def handle_action_error(e)
             if e.kind_of?(Convoy::Error)
                 print_convoy_error_message(e)
-                error_logger.debug {'Convoy app failed to execute successfully, due to internal error'}
+                error_logger.debug { 'Convoy app failed to execute successfully, due to internal error' }
                 exit(Convoy::INTERNAL_ERROR_EXIT_CODE)
             else
                 print_stacktrace(e)
-                error_logger.debug {'Convoy app failed to execute successfully, due to unknown error'}
+                error_logger.debug { 'Convoy app failed to execute successfully, due to unknown error' }
                 exit(Convoy::EXTERNAL_ERROR_EXIT_CODE)
             end
         end
@@ -121,7 +121,7 @@ module Convoy
 
         def print_convoy_error_message(e)
             print_stacktrace(e)
-            error_logger.warn {"\n  \x1B[48;5;196m ERROR \x1B[0m An internal Convoy error occurred.\n\n    You should probably report it to \x1B[38;5;222mAlbert Rannetsperger\x1B[0m or create an issue on his \x1B[38;5;222mGitHub\x1B[0m page (https://github.com/alb3rtuk).\n    Make sure to include the stacktrace above (although the way Ruby works, it probably won't be very helpful).\n"}
+            error_logger.warn { "\n    \x1B[48;5;196m Error \x1B[0m \xe2\x86\x92 An internal Convoy error occurred.\n\n    You should probably report it to \x1B[38;5;222mAlbert Rannetsperger\x1B[0m or create an issue on his \x1B[38;5;222mGitHub\x1B[0m page (https://github.com/alb3rtuk).\n    Make sure to include the stacktrace above (although the way Ruby works, it probably won't be very helpful).\n" }
         end
     end
 end

data/lib/convoy/error/error.rb

@@ -1,7 +1,7 @@
 module Convoy
     INTERNAL_ERROR_EXIT_CODE = 1
-    CLIENT_ERROR_EXIT_CODE = 2
-    USER_ERROR_EXIT_CODE = 3
+    CLIENT_ERROR_EXIT_CODE   = 2
+    USER_ERROR_EXIT_CODE     = 3
     EXTERNAL_ERROR_EXIT_CODE = 10
 
     #module to tag all exceptions coming out of Convoy with

data/lib/convoy/formatter/command.rb

@@ -4,9 +4,9 @@ module Convoy
             attr_reader :setup, :context, :name
 
             def initialize(command_name, setup, context)
-                @setup = setup
+                @setup   = setup
                 @context = context
-                @name = command_name.to_sym
+                @name    = command_name.to_sym
             end
 
             def name_with_aliases

data/lib/convoy/formatter/commands.rb

@@ -16,7 +16,7 @@ module Convoy
             attr_reader :setup, :context
 
             def initialize(setup, context)
-                @setup = setup
+                @setup   = setup
                 @context = context
             end
 

data/lib/convoy/formatter/default_help_formatter.rb

@@ -4,13 +4,13 @@ module Convoy
             attr_reader :setup, :context
 
             def initialize(setup, context)
-                @setup = setup
+                @setup   = setup
                 @context = context
             end
 
             def print(parser)
-                options = Options.new(parser, setup, context)
-                commands = Commands.new(setup, context)
+                options         = Options.new(parser, setup, context)
+                commands        = Commands.new(setup, context)
                 current_command = Commands.command_for(setup, context)
                 # Uncomment the following line if you want the screen
                 # to be cleared before the --help messages show.
@@ -27,8 +27,8 @@ module Convoy
                     #     end
                     # end
                     name_help(current_command, f)
-                    usage_help(current_command, f)
                     version_help(current_command, f)
+                    usage_help(current_command, f)
                     commands_help(commands, f)
                     options_help(options, f)
                 end
@@ -37,37 +37,30 @@ module Convoy
             private
 
             def name_help(current_command, f)
-                # f.puts "\x1B[38;5;84mNAME\x1B[0m"
                 if setup.description_for(context) != ''
                     f.indent(4) do |f|
-                        # f.grid(:columns => 3) do |t|
-                        #     t.row current_command.script_name, '-', setup.summary_for(context)
-                        # end
-                        # f.newline
-                        f.puts(setup.description_for(context), :newlines => 2)
+                        f.puts("\x1B[38;5;250m#{setup.description_for(context)}\x1B[0m", :newlines => 2)
                     end
                 end
             end
 
-            def usage_help(current_command, f)
-                f.puts "\x1B[38;5;84mUSAGE\x1B[0m"
-                f.indent(4) do |f|
-                    f.puts current_command.usage, :newlines => 2
-                end
-            end
-
             def version_help(current_command, f)
                 if setup.version
-                    f.puts "\x1B[38;5;84mVERSION\x1B[0m"
                     f.indent(4) do |f|
-                        f.puts setup.version, :newlines => 2
+                        f.puts "\x1B[38;5;250mVersion: \x1B[38;5;46m#{setup.version}\x1B[0m", :newlines => 1
                     end
                 end
             end
 
+            def usage_help(current_command, f)
+                f.indent(4) do |f|
+                    f.puts "\x1B[38;5;250m  Usage: \x1B[38;5;46m#{current_command.usage}\x1B[0m", :newlines => 2
+                end
+            end
+
             def options_help(options, f)
                 if options.count > 0
-                    f.puts "\x1B[38;5;84mFLAGS\x1B[0m"
+                    f.puts "  \x1B[38;5;255mFLAGS\x1B[0m"
                     f.indent(4) do |f|
                         f.grid(:columns => 3) do |t|
                             options.each do |option|
@@ -106,7 +99,7 @@ module Convoy
 
             def commands_help(commands, f)
                 if commands.count > 0
-                    f.puts "\x1B[38;5;84mCOMMANDS\x1B[0m"
+                    f.puts "  \x1B[38;5;255mCOMMANDS\x1B[0m"
                     f.indent(4) do |f|
                         f.grid(:columns => 3) do |t|
                             commands.each do |command|

data/lib/convoy/formatter/option.rb

@@ -4,9 +4,9 @@ module Convoy
             attr_reader :name, :details, :setup, :context
 
             def initialize(name, details, setup, context)
-                @name = name.to_sym
+                @name    = name.to_sym
                 @details = details
-                @setup = setup
+                @setup   = setup
                 @context = context
             end
 

data/lib/convoy/formatter/options.rb

@@ -6,8 +6,8 @@ module Convoy
             attr_reader :parser, :setup, :context
 
             def initialize(parser, setup, context)
-                @parser = parser
-                @setup = setup
+                @parser  = parser
+                @setup   = setup
                 @context = context
             end
 

data/lib/convoy/formatter/shell_command_executor.rb

@@ -11,7 +11,7 @@ module Convoy
 
             def execute_in_current_shell(success_callback = nil, error_callback = nil)
                 begin
-                    result = `#{command}`
+                    result         = `#{command}`
                     process_status = $?
                     raise Convoy::InternalError.new("Shell command exited with a non-zero (#{process_status.exitstatus}) exit code") if process_status.exitstatus != 0
                     success_callback.call(command, result) if success_callback

data/lib/convoy/formatter/stream_output_formatter.rb

@@ -1,25 +1,25 @@
 module Convoy
     module Formatter
         class StreamOutputFormatter
-            DEFAULT_OUTPUT_WIDTH = 80
+            DEFAULT_OUTPUT_WIDTH  = 80
             DEFAULT_INDENT_STRING = ' '
-            DEFAULT_INDENT = 0
+            DEFAULT_INDENT        = 0
 
             attr_reader :stream, :indent_string, :current_indent, :max_output_width, :cursor_position
 
             def initialize(stream = $stdout, options = {}, &block)
-                @stream = stream
+                @stream           = stream
                 @max_output_width = options[:max_output_width] || DEFAULT_OUTPUT_WIDTH
-                @indent_string = options[:indent_string] || DEFAULT_INDENT_STRING
-                @current_indent = options[:current_indent] || DEFAULT_INDENT
-                @cursor_position = CursorPosition.new(@max_output_width)
+                @indent_string    = options[:indent_string] || DEFAULT_INDENT_STRING
+                @current_indent   = options[:current_indent] || DEFAULT_INDENT
+                @cursor_position  = CursorPosition.new(@max_output_width)
                 block.call(self) if block_given?
             end
 
             def print(string)
                 splitter_input = pad_string_to_account_for_cursor_position(string.to_s)
-                segments = StringSplitter.new(max_output_width).split(splitter_input)
-                segments = remove_padding_that_account_for_cursor_position(segments)
+                segments       = StringSplitter.new(max_output_width).split(splitter_input)
+                segments       = remove_padding_that_account_for_cursor_position(segments)
                 segments.each do |segment|
                     output_string = "#{current_indent_string}#{segment}"
                     output_string = segment unless cursor_position.newline?
@@ -29,7 +29,7 @@ module Convoy
                 end
             end
 
-            def puts(string, options = {:newlines => 1})
+            def puts(string, options = { :newlines => 1 })
                 print(string)
                 newline(options[:newlines])
             end
@@ -48,7 +48,7 @@ module Convoy
             def grid(options = {}, &block)
                 if block_given?
                     options[:width] ||= max_output_width
-                    grid = StringGrid.new(options, &block)
+                    grid            = StringGrid.new(options, &block)
                     puts grid.to_s
                 end
             end

data/lib/convoy/formatter/string_grid.rb

@@ -7,9 +7,9 @@ module Convoy
             attr_accessor :rows
 
             def initialize(options = {}, &block)
-                @width = options[:width] || DEFAULT_WIDTH
+                @width        = options[:width] || DEFAULT_WIDTH
                 @column_count = options[:columns] || 3
-                @rows = []
+                @rows         = []
                 block.call(self) if block_given?
             end
 
@@ -80,7 +80,7 @@ module Convoy
             end
 
             def last_column_width
-                full_fair_column_width = max_column_width * column_count + max_column_width_remainder
+                full_fair_column_width         = max_column_width * column_count + max_column_width_remainder
                 all_but_last_fair_column_width = 0
                 (column_count - 1).times do |index|
                     all_but_last_fair_column_width += fair_column_width(index)

data/lib/convoy/formatter/string_splitter.rb

@@ -36,7 +36,7 @@ module Convoy
             def split_string(string)
                 result = []
                 if string.length > max_segment_width
-                    first_part = string.slice(0, max_segment_width)
+                    first_part  = string.slice(0, max_segment_width)
                     second_part = string.slice(max_segment_width..-1)
                     result << first_part
                     result << split_string(second_part)

data/lib/convoy/global_pre_parser.rb

@@ -14,8 +14,8 @@ module Convoy
 
         def parse_global_options(cli_options, context = [])
             stop_words = setup.command_names_for(context).map(&:to_s)
-            parser = init_parser(stop_words)
-            parser = add_setup_options_to(parser, context)
+            parser     = init_parser(stop_words)
+            parser     = add_setup_options_to(parser, context)
             parser.version(setup.version) #set the version if it was provided
             parser.help_formatter(Convoy::Formatter::DefaultHelpFormatter.new(setup, context))
             parsed_options = parse_options_string(parser, cli_options)

data/lib/convoy/logger.rb

@@ -11,14 +11,14 @@ module Convoy
             def error
                 @error_logger ||= ::Logger.new($stderr).tap do |l|
                     #l.formatter = advanced_error_formatter
-                    l.formatter = basic_error_formatter
+                    l.formatter     = basic_error_formatter
                     l.sev_threshold = ::Logger::WARN
                 end
             end
 
             def output
                 @output_logger ||= ::Logger.new($stdout).tap do |l|
-                    l.formatter = output_formatter
+                    l.formatter     = output_formatter
                     l.sev_threshold = ::Logger::DEBUG
                     l.instance_eval do
                         def puts(message = nil, &block)
@@ -33,7 +33,7 @@ module Convoy
             end
 
             def setup_error_logger(auto_options)
-                error.formatter = send(:"#{auto_options.error_formatter}_error_formatter")
+                error.formatter     = send(:"#{auto_options.error_formatter}_error_formatter")
                 error.sev_threshold = ::Logger.const_get(auto_options.verbosity)
             end
 

data/lib/convoy/option_parser.rb

@@ -4,7 +4,7 @@ module Convoy
 
         def initialize(configuration, setup)
             @configuration = configuration
-            @setup = setup
+            @setup         = setup
         end
 
         def parse(cli_options)
@@ -20,7 +20,7 @@ module Convoy
         def init_invoked_options_hash
             {
                 :global => {
-                    :options => {},
+                    :options  => {},
                     :commands => {}
                 }
             }
@@ -37,9 +37,9 @@ module Convoy
             else
                 command = command_name_from(cli_options)
                 context << command
-                current_options = parse_options(cli_options, context)
-                options[command] = {}
-                options[command][:options] = current_options
+                current_options             = parse_options(cli_options, context)
+                options[command]            = {}
+                options[command][:options]  = current_options
                 options[command][:commands] = {}
                 parse_command_options(cli_options, context, options[command][:commands])
             end
@@ -47,10 +47,10 @@ module Convoy
 
         def parse_options(cli_options, context = [])
             stop_words = setup.command_names_for(context).map(&:to_s)
-            parser = init_parser(stop_words)
-            parser = add_setup_options_to(parser, context)
-            parser = add_option_conflicts_to(parser, context)
-            parser = default_option_values_from_config_for(parser, context)
+            parser     = init_parser(stop_words)
+            parser     = add_setup_options_to(parser, context)
+            parser     = add_option_conflicts_to(parser, context)
+            parser     = default_option_values_from_config_for(parser, context)
             parser.version(setup.version) #set the version if it was provided
             parser.help_formatter(Convoy::Formatter::DefaultHelpFormatter.new(setup, context))
             parsed_options = parse_options_string(parser, cli_options)
@@ -86,7 +86,7 @@ module Convoy
             unless configuration.empty?
                 parser.specs.each do |sym, opts|
                     if config_has_value_for_context?(sym, context)
-                        default = config_value_for_context(sym, context)
+                        default        = config_value_for_context(sym, context)
                         opts[:default] = default
                         if opts[:multi] && default.nil?
                             opts[:default] = [] # multi arguments default to [], not nil
@@ -114,7 +114,7 @@ module Convoy
         def config_hash_for_context(context)
             relevant_config_hash = configuration.global
             context.each do |command_name|
-                command_name = command_name.to_sym
+                command_name         = command_name.to_sym
                 relevant_config_hash = relevant_config_hash[:commands][command_name]
                 relevant_config_hash = ensure_config_hash_has_options_and_commands(relevant_config_hash)
             end
@@ -122,9 +122,9 @@ module Convoy
         end
 
         def ensure_config_hash_has_options_and_commands(relevant_config_hash)
-            relevant_config_hash ||= {}
+            relevant_config_hash            ||= {}
             relevant_config_hash[:commands] ||= {}
-            relevant_config_hash[:options] ||= {}
+            relevant_config_hash[:options]  ||= {}
             relevant_config_hash
         end