escort 0.2.1 → 0.3.0

data/lib/escort/formatter/option.rb

@@ -39,7 +39,7 @@ module Escort
       end
 
       def validations
-        has_validations? ? "#{validation_messages.join("\n- ")}" : ''
+        has_validations? ? validation_messages : []
       end
 
       private

data/lib/escort/formatter/stream_output_formatter.rb

@@ -0,0 +1,88 @@
+module Escort
+  module Formatter
+    class StreamOutputFormatter
+      DEFAULT_OUTPUT_WIDTH = 80
+      DEFAULT_INDENT_STRING = ' '
+      DEFAULT_INDENT = 0
+
+      attr_reader :stream, :indent_string, :current_indent, :max_output_width, :cursor_position
+
+      def initialize(stream = $stdout, options = {}, &block)
+        @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)
+        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.each do |segment|
+          output_string = "#{current_indent_string}#{segment}"
+          output_string = segment unless cursor_position.newline?
+          stream.print output_string
+          cursor_position.update_for(segment)
+          newline if segments.last != segment
+        end
+      end
+
+      def puts(string, options = {:newlines => 1})
+        print(string)
+        newline(options[:newlines])
+      end
+
+      def newline(newline_count = 1)
+        stream.print("\n" * newline_count)
+        cursor_position.reset if newline_count > 0
+      end
+
+      def indent(count, &block)
+        newline unless cursor_position.newline?
+        new_indent = current_indent + count
+        self.class.new(stream, :max_output_width => max_output_width - count, :indent_string => indent_string, :current_indent => new_indent, &block)
+      end
+
+      def grid(options = {}, &block)
+        if block_given?
+          options[:width] ||= max_output_width
+          grid = StringGrid.new(options, &block)
+          puts grid.to_s
+        end
+      end
+
+      private
+
+      def pad_string_to_account_for_cursor_position(string)
+        "#{padding_string}#{string}"
+      end
+
+      def remove_padding_that_account_for_cursor_position(segments)
+        first_string = segments.first
+        if first_string
+          segments[0] = first_string.sub(/#{padding_string}/, '')
+        end
+        segments
+      end
+
+      def padding_string
+        "." * cursor_position.position
+      end
+
+      def current_indent_width
+        current_indent_string.length
+      end
+
+      def current_indent_string
+        indent_string * current_indent
+      end
+
+      #def table(options = {}, &block)
+        #BorderlessTable.new(self, options).output(&block)
+        #newline(options[:newlines] || 1)
+      #end
+    end
+  end
+end

data/lib/escort/formatter/{borderless_table.rb → string_grid.rb}

@@ -1,34 +1,35 @@
-#TODO needs some serious testing stuffs
-#split out into many classes VirtuaRow, PhysicalRow, FormatterRow
-#needs method each_formatted_row
-#the printing out should only happen in the outputter class not in the table intself
 module Escort
   module Formatter
-    class BorderlessTable
-      attr_reader :column_count, :formatter
+    class StringGrid
+      DEFAULT_WIDTH = 80
+
+      attr_reader :column_count, :width
       attr_accessor :rows
 
-      def initialize(formatter, options = {})
-        @formatter = formatter
+      def initialize(options = {}, &block)
+        @width = options[:width] || DEFAULT_WIDTH
         @column_count = options[:columns] || 3
         @rows = []
+        block.call(self) if block_given?
       end
 
       def row(*column_values)
+        while column_values.size < @column_count
+          column_values << ''
+        end
         rows << column_values.map(&:to_s)
-        #TODO raise error if column values size doesn't match columns
       end
 
-      def output(&block)
-        block.call(self)
-
+      def to_s
+        buffer = []
         rows.each do |cells|
           virtual_row = normalize_virtual_row(virtual_row_for(cells))
           physical_row_count_for(virtual_row).times do |physical_count|
             physical_row = format_physical_row_values(physical_row_for(virtual_row, physical_count))
-            formatter.put physical_row.join("").chomp, :newlines => 1
+            buffer << physical_row.join("").chomp
           end
         end
+        buffer.join("\n")
       end
 
       private
@@ -65,7 +66,6 @@ module Escort
       end
 
       def column_width(column_index)
-        #TODO raise error if index out of bounds
         width = fair_column_width(column_index)
         if column_index == column_count - 1
           width = last_column_width
@@ -74,14 +74,13 @@ module Escort
       end
 
       def fair_column_width(index)
-        #TODO raise error if index out of bounds
         width = values_in_column(index).map(&:length).max
         width = width + 1
         width > max_column_width ? max_column_width : width
       end
 
       def last_column_width
-        full_fair_column_width = max_column_width * column_count
+        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)
@@ -90,16 +89,19 @@ module Escort
       end
 
       def values_in_column(column_index)
-        #TODO raise error if index out of bounds
         rows.map{|cells| cells[column_index]}
       end
 
       def max_column_width
-        (formatter.terminal_columns - 1 - formatter.current_indent_string.length)/column_count
+        width/column_count
+      end
+
+      def max_column_width_remainder
+        width%column_count
       end
 
       def cell_value(value, column_index)
-        sprintf("%-#{column_width(column_index)}s", value.strip)
+        sprintf("%-#{column_width(column_index)}s", value)
       end
     end
   end

data/lib/escort/formatter/string_splitter.rb

@@ -1,18 +1,38 @@
 module Escort
   module Formatter
     class StringSplitter
-      attr_reader :max_segment_width
+      attr_reader :max_segment_width  #, :first_segment_max_length
 
-      def initialize(max_segment_width)
+      def initialize(max_segment_width, options = {})
         @max_segment_width = max_segment_width
+        #@first_segment_max_length = options[:first_segment_max_length] || max_segment_width
       end
 
-      def split(string)
-        string.split("\n").map { |s| split_string(s) }.flatten
+      def split(input_string)
+        input_strings = input_string.split("\n")
+        [split_strings(input_strings)].flatten
+        #first_string = strings.shift
+        #other_strings = strings
+        #result = [split_first_string(first_string) + split_strings(other_strings)].flatten
+        #result
       end
 
       private
 
+      #def split_first_string(string)
+        #if first_segment_max_length >= string.length
+          #split_string(string)
+        #else
+          #first = string.slice(0, first_segment_max_length)
+          #last = string.slice(first_segment_max_length..-1)
+          #split_strings([first, last])
+        #end
+      #end
+
+      def split_strings(strings)
+        strings.map { |s| split_string(s) }
+      end
+
       def split_string(string)
         result = []
         if string.length > max_segment_width

data/lib/escort/setup/configuration/loader.rb

@@ -19,7 +19,7 @@ module Escort
         end
 
         def default_config_path
-          @default_config_path ||= File.join(File.expand_path(ENV["HOME"]), config_filename)
+          @default_config_path ||= (config_filename ? File.join(File.expand_path(ENV["HOME"]), config_filename) : nil)
         end
 
         private
@@ -29,7 +29,13 @@ module Escort
         end
 
         def config_path
-          @config_path ||= (auto_options.non_default_config_path || Locator::DescendingToHome.new(config_filename).locate || default_config_path)
+          @config_path ||= (auto_options.non_default_config_path || locator.locate || default_config_path)
+        end
+
+        def locator
+          Locator::Chaining.new(config_filename).
+            add_locator(Locator::ExecutingScriptDirectory.new(config_filename)).
+            add_locator(Locator::DescendingToHome.new(config_filename))
         end
       end
     end

data/lib/escort/setup/configuration/locator/chaining.rb

@@ -0,0 +1,29 @@
+module Escort
+  module Setup
+    module Configuration
+      module Locator
+        class Chaining < Base
+          attr_reader :locators
+
+          def initialize(filename, locators = [])
+            super(filename)
+            @locators = locators || []
+          end
+
+          def locate
+            locators.each do |locator|
+              filepath = locator.locate
+              return filepath if filepath
+            end
+            nil
+          end
+
+          def add_locator(locator)
+            @locators << locator
+            self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/escort/setup/configuration/locator/executing_script_directory.rb

@@ -0,0 +1,15 @@
+module Escort
+  module Setup
+    module Configuration
+      module Locator
+        class ExecutingScriptDirectory < Base
+          def locate
+            location_directory = File.dirname($0)
+            filepath = File.expand_path(File.join(location_directory, filename))
+            File.exists?(filepath) ? filepath : nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/escort/setup/configuration/locator/specified_directory.rb

@@ -0,0 +1,21 @@
+module Escort
+  module Setup
+    module Configuration
+      module Locator
+        class SpecifiedDirectory < Base
+          attr_reader :location_directory
+
+          def initialize(filename, location_directory)
+            super(filename)
+            @location_directory = location_directory
+          end
+
+          def locate
+            filepath = File.expand_path(File.join(location_directory, filename))
+            File.exists?(filepath) ? filepath : nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/escort/setup/configuration/reader.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Escort
   module Setup
     module Configuration
@@ -20,11 +22,11 @@ module Escort
           data = {}
           begin
             json = File.read(path)
-            hash = JSON.parse(json)
+            hash = ::JSON.parse(json)
             data = Escort::Utils.symbolize_keys(hash)
           rescue => e
             error_logger.warn { "Found config at #{path}, but failed to load it, perhaps your JSON syntax is invalid. Attempting to continue without..." }
-            error_logger.error(e)
+            error_logger.debug(e)
           end
           data
         end

data/lib/escort/setup/configuration/writer.rb

@@ -1,3 +1,6 @@
+require 'json'
+require 'fileutils'
+
 module Escort
   module Setup
     module Configuration
@@ -32,8 +35,9 @@ module Escort
 
         def save_to_file
           current_path = File.expand_path(path)
-          File.open(current_path,"w") do |f|
-            f.puts JSON.pretty_generate(data)
+          FileUtils.mkdir_p(File.dirname(current_path))
+          File.open(current_path, "w") do |f|
+            f.puts ::JSON.pretty_generate(data)
           end
         end
       end

data/lib/escort/setup/dsl/command.rb

@@ -4,7 +4,6 @@ module Escort
       class Command
         def initialize(name, options = {}, &block)
           reset(name)
-          @name = name
           @description = options[:description] || options[:desc] || ""
           @aliases = [options[:aliases] || []].flatten
           @requires_arguments ||= options[:requires_arguments]
@@ -38,10 +37,6 @@ module Escort
           end
         end
 
-        def conflicting_options(*command_names)
-          raise Escort::ClientError.new("This interface for specifying conflicting options is no longer supported, please use 'opts.conflict' in the options block")
-        end
-
         def summary(summary)
           @summary = summary
         end
@@ -53,14 +48,18 @@ module Escort
         private
 
         def reset(name)
+          @name = name
+          @summary = nil
+          @description = nil
           @requires_arguments = false
           @commands = {}
           @options = Options.new(name)
           @action = Action.new(name)
-          @name = nil
-          @description = nil
+          custom_reset
+        end
+
+        def custom_reset
           @aliases = []
-          @summary = nil
         end
       end
     end

data/lib/escort/setup/dsl/global.rb

@@ -1,39 +1,14 @@
 module Escort
   module Setup
     module Dsl
-      class Global
+      class Global < Command
         def initialize(&block)
-          reset
+          reset(:global)
           block.call(self)
         rescue => e
           raise Escort::ClientError.new("Problem with syntax of global configuration", e)
         end
 
-        def options(&block)
-          Options.options(:global, @options, &block)
-        end
-
-        def action(&block)
-          Action.action(:global, @action, &block)
-        end
-
-        def command(name, options = {}, &block)
-          options[:requires_arguments] = @requires_arguments
-          command = Command.new(name.to_sym, options, &block)
-          aliases = [options[:aliases] || []].flatten + [name]
-          aliases.each do |name|
-            @commands[name.to_sym] = command
-          end
-        end
-
-        def requires_arguments(boolean = true)
-          raise Escort::ClientError.new("Parameter to 'requires_arguments' must be a boolean") unless [true, false].include?(boolean)
-          @requires_arguments = boolean
-          @commands.each do |command|
-            command.requires_arguments(boolean)
-          end
-        end
-
         def config_file(name, options = {})
           @config_file = ConfigFile.new(name, options)
         end
@@ -42,35 +17,12 @@ module Escort
           @version = version
         end
 
-        def summary(summary)
-          @summary = summary
-        end
-
-        def description(description)
-          @description = description
-        end
-
-        def conflicting_options(*command_names)
-          raise Escort::ClientError.new("This interface for specifying conflicting options is no longer supported, please use 'opts.conflict' in the options block")
-        end
-
         private
 
-        def reset
+        def custom_reset
           @version = nil
-          @summary = nil
-          @description = nil
-          @commands = {}
-          @requires_arguments = false
-          @options = Options.new
-          @action = Action.new
           @config_file  = nil
         end
-
-        def set_instance_variable_on(instance, instance_variable, value)
-          instance_variable_symbol = :"@#{instance_variable.to_s}"
-          instance.instance_variable_set(instance_variable_symbol, value)
-        end
       end
     end
   end