convoy 1.0.0

data/lib/convoy/formatter/command.rb

@@ -0,0 +1,87 @@
+module Convoy
+    module Formatter
+        class Command
+            attr_reader :setup, :context, :name
+
+            def initialize(command_name, setup, context)
+                @setup = setup
+                @context = context
+                @name = command_name.to_sym
+            end
+
+            def name_with_aliases
+                [aliases, name].flatten.join(', ')
+            end
+
+            def outline
+                summary.empty? ? description : summary
+            end
+
+            def description
+                @description ||= setup.command_description_for(name, context) || ""
+            end
+
+            def summary
+                @summary ||= setup.command_summary_for(name, context) || ""
+            end
+
+            def aliases
+                @aliases ||= setup.command_aliases_for(name, context)
+            end
+
+            def has_aliases?
+                aliases && aliases.size > 0 ? true : false
+            end
+
+            def script_name
+                [canonical_script_name, context].flatten.join(" ")
+            end
+
+            def child_commands
+                @child_commands ||= setup.canonical_command_names_for(context) || []
+            end
+
+            def has_child_commands?
+                child_commands.length > 0
+            end
+
+            def requires_arguments?
+                @requires_arguments ||= setup.arguments_required_for(context)
+            end
+
+            def usage
+                [script_name_usage_string, parent_commands_usage_string, child_command_usage_string, arguments_usage_string].flatten.reject(&:empty?).join(" ")
+            end
+
+            private
+
+            def script_name_usage_string
+                "#{canonical_script_name} [options]"
+            end
+
+            def parent_commands_usage_string
+                context.map { |command_name| command_with_options(command_name) }.join(" ")
+            end
+
+            def child_command_usage_string
+                has_child_commands? ? "command [command_options]" : ""
+            end
+
+            def arguments_usage_string
+                requires_arguments? ? "arguments" : "[arguments]"
+            end
+
+            def command_with_options(command_name)
+                "#{command_name} [#{command_name}_options]"
+            end
+
+            def canonical_script_name
+                File.basename($0)
+            end
+
+            def alias_string
+                @alias_string ||= aliases.join(", ") if has_aliases?
+            end
+        end
+    end
+end

data/lib/convoy/formatter/commands.rb

@@ -0,0 +1,37 @@
+module Convoy
+    module Formatter
+        class Commands
+            include Enumerable
+
+            class << self
+                def command_for(setup, context)
+                    if context.empty?
+                        GlobalCommand.new(setup)
+                    else
+                        Command.new(context.last, setup, context)
+                    end
+                end
+            end
+
+            attr_reader :setup, :context
+
+            def initialize(setup, context)
+                @setup = setup
+                @context = context
+            end
+
+            def each(&block)
+                setup.canonical_command_names_for(context).each do |command_name|
+                    command = Command.new(command_name, setup, context)
+                    block.call(command)
+                end
+            end
+
+            def count
+                setup.canonical_command_names_for(context).size
+            end
+
+            alias_method :size, :count
+        end
+    end
+end

data/lib/convoy/formatter/cursor_position.rb

@@ -0,0 +1,29 @@
+module Convoy
+    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 Convoy::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/convoy/formatter/default_help_formatter.rb

@@ -0,0 +1,117 @@
+module Convoy
+    module Formatter
+        class DefaultHelpFormatter
+            attr_reader :setup, :context
+
+            def initialize(setup, context)
+                @setup = setup
+                @context = context
+            end
+
+            def print(parser)
+                options = Options.new(parser, setup, context)
+                commands = Commands.new(setup, context)
+                current_command = Commands.command_for(setup, context)
+                system('clear')
+                puts
+                StreamOutputFormatter.new($stdout, :max_output_width => Terminal.width) do |f|
+                    if setup.summary_for != '' && !setup.summary_for.nil?
+                        f.puts setup.summary_for, :newlines => 2
+                    end
+                    if (setup.description_for != '' && !setup.description_for.nil?) && current_command.summary == setup.summary_for
+                        f.indent(4) do |f_inner|
+                            f_inner.puts setup.description_for, :newlines => 2
+                        end
+                    end
+                    # name_help(current_command, f)
+                    usage_help(current_command, f)
+                    version_help(current_command, f)
+                    commands_help(commands, f)
+                    options_help(options, f)
+                end
+            end
+
+            private
+
+            def name_help(current_command, f)
+                f.puts "\x1B[38;5;84mNAME\x1B[0m"
+                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) if setup.description_for(context)
+                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
+                    end
+                end
+            end
+
+            def options_help(options, f)
+                if options.count > 0
+                    f.puts "\x1B[38;5;84mFLAGS\x1B[0m"
+                    f.indent(4) do |f|
+                        f.grid(:columns => 3) do |t|
+                            options.each do |option|
+                                unless option.usage == '--verbosity, <s>' || option.usage == '--error-output-format, <s>' || option.usage == '-v, --version'
+                                    t.row option.usage.ljust(10, ' '), " \xe2\x86\x92 ", option.description
+                                    option_conflicts_help(option, t)
+                                    option_dependencies_help(option, t)
+                                    option_validations_help(option, t)
+                                end
+                            end
+                        end
+                        f.newline
+                    end
+                end
+            end
+
+            def option_conflicts_help(option, t)
+                if option.has_conflicts?
+                    t.row '', '', "- #{option.conflicts}"
+                end
+            end
+
+            def option_dependencies_help(option, t)
+                if option.has_dependencies?
+                    t.row '', '', "- #{option.dependencies}"
+                end
+            end
+
+            def option_validations_help(option, t)
+                if option.has_validations?
+                    option.validations.each do |validation|
+                        t.row '', '', "- #{validation}"
+                    end
+                end
+            end
+
+            def commands_help(commands, f)
+                if commands.count > 0
+                    f.puts "\x1B[38;5;84mCOMMANDS\x1B[0m"
+                    f.indent(4) do |f|
+                        f.grid(:columns => 3) do |t|
+                            commands.each do |command|
+                                t.row command.name_with_aliases.ljust(10, ' '), " \xe2\x86\x92 ", command.outline
+                            end
+                        end
+                        f.newline
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/convoy/formatter/global_command.rb

@@ -0,0 +1,17 @@
+module Convoy
+    module Formatter
+        class GlobalCommand < Command
+            def initialize(setup)
+                super(:global, setup, [])
+            end
+
+            def summary
+                @summary ||= setup.summary_for(context) || ""
+            end
+
+            def description
+                @description ||= setup.description_for(context) || ""
+            end
+        end
+    end
+end

data/lib/convoy/formatter/option.rb

@@ -0,0 +1,152 @@
+module Convoy
+    module Formatter
+        class Option
+            attr_reader :name, :details, :setup, :context
+
+            def initialize(name, details, setup, context)
+                @name = name.to_sym
+                @details = details
+                @setup = setup
+                @context = context
+            end
+
+            def usage
+                [short_string, long_string, type_string].select { |item| !item.empty? }.join(', ')
+            end
+
+            def description
+                [base_description_string, description_default_string].select { |item| !item.empty? }.join(" ")
+            end
+
+            def has_conflicts?
+                !conflicts_list.empty?
+            end
+
+            def conflicts
+                has_conflicts? ? "conflicts with: #{conflicts_list.map { |option| "--#{option}" }.join(', ')}" : ''
+            end
+
+            def has_dependencies?
+                !dependencies_list.empty?
+            end
+
+            def dependencies
+                has_dependencies? ? "depends on: #{format_dependency_list(dependencies_list).join(', ')}" : ''
+            end
+
+            def has_validations?
+                !validations_list.empty?
+            end
+
+            def validations
+                has_validations? ? validation_messages : []
+            end
+
+            private
+            def validation_messages
+                validations_list.map { |validation| validation[:desc] }
+            end
+
+            def validations_list
+                setup.validations_for(context)[name] || []
+            end
+
+            def format_dependency_list(dependency_list)
+                dependencies_list.map do |option|
+                    case option
+                        when Hash
+                            option.inject([]) { |acc, (key, value)| acc << "--#{key}=#{value}" }.join(', ')
+                        else
+                            "--#{option}"
+                    end
+                end
+            end
+
+            def dependencies_list
+                setup.dependencies_for(context)[name] || []
+            end
+
+            def conflicts_list
+                setup.conflicting_options_for(context)[name] || []
+            end
+
+            def base_description_string
+                details[:desc] || details[:description] || ''
+            end
+
+            def description_default_string
+                if details[:default]
+                    base_description_string =~ /\.$/ ? "(Default: #{default_string})" : "(default: #{default_string})"
+                else
+                    ""
+                end
+            end
+
+            def default_string
+                case details[:default]
+                    when $stdout;
+                        "<stdout>"
+                    when $stdin;
+                        "<stdin>"
+                    when $stderr;
+                        "<stderr>"
+                    when Array
+                        details[:default].join(", ")
+                    else
+                        details[:default].to_s
+                end
+            end
+
+            def short_string
+                details[:short] && details[:short] != :none ? "-#{details[:short]}" : ""
+            end
+
+            def long_string
+                if flag_with_default_true?
+                    "#{base_long_string}, --no-#{details[:long]}"
+                else
+                    base_long_string
+                end
+            end
+
+            def base_long_string
+                "--#{details[:long]}"
+            end
+
+            def type_string
+                case details[:type]
+                    when :flag;
+                        ""
+                    when :int;
+                        "<i>"
+                    when :ints;
+                        "<i+>"
+                    when :string;
+                        "<s>"
+                    when :strings;
+                        "<s+>"
+                    when :float;
+                        "<f>"
+                    when :floats;
+                        "<f+>"
+                    when :io;
+                        "<filename/uri>"
+                    when :ios;
+                        "<filename/uri+>"
+                    when :date;
+                        "<date>"
+                    when :dates;
+                        "<date+>"
+                end
+            end
+
+            def flag_with_default_true?
+                flag? && details[:default]
+            end
+
+            def flag?
+                details[:type] == :flag
+            end
+        end
+    end
+end

data/lib/convoy/formatter/options.rb

@@ -0,0 +1,28 @@
+module Convoy
+    module Formatter
+        class Options
+            include Enumerable
+
+            attr_reader :parser, :setup, :context
+
+            def initialize(parser, setup, context)
+                @parser = parser
+                @setup = setup
+                @context = context
+            end
+
+            def each(&block)
+                parser.specs.each do |option_name, details|
+                    option = Option.new(option_name, details, setup, context)
+                    block.call(option)
+                end
+            end
+
+            def count
+                parser.specs.keys.size
+            end
+
+            alias_method :size, :count
+        end
+    end
+end