escort 0.0.1 → 0.1.0

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

@@ -0,0 +1,75 @@
+module Escort
+  module Setup
+    module Configuration
+      class Generator
+        attr_reader :setup
+
+        def initialize(setup)
+          @setup = setup
+        end
+
+        def default_data
+          config_hash = init_config_hash
+          options([], config_hash[:global][:options]) #global options
+          options_for_commands(setup.canonical_command_names_for([]), [], config_hash[:global][:commands])
+          config_hash
+        end
+
+        private
+
+        def options_for_commands(commands, context, options = {})
+          commands.each do |command_name|
+            command_name = command_name.to_sym
+            #next if command_name == :escort
+            options[command_name] = {}
+            options[command_name][:options] = {}
+            options[command_name][:commands] = {}
+            current_context = context.dup
+            current_context << command_name
+            options(current_context, options[command_name][:options]) #command_options
+            options_for_commands(setup.canonical_command_names_for(current_context), current_context, options[command_name][:commands])
+          end
+        end
+
+        def init_config_hash
+          {
+            :global => {
+              :options => {},
+              :commands => {}
+            },
+            :user => {}
+          }
+        end
+
+        def options(context = [], options = {})
+          command_names = setup.command_names_for(context)
+          parser = init_parser(command_names)
+          parser = add_setup_options_to(parser, context)
+          options.merge!(default_option_values(parser))
+        end
+
+        def init_parser(stop_words)
+          Trollop::Parser.new.tap do |parser|
+            parser.stop_on(stop_words)  # make sure we halt parsing if we see a command
+          end
+        end
+
+        def add_setup_options_to(parser, context = [])
+          setup.options_for(context).each do |name, opts|
+            parser.opt name, opts[:desc] || "", opts.dup #have to make sure to dup here, otherwise opts might get stuff added to it and it
+                                                         #may cause problems later, e.g. adds default value and when parsed again trollop barfs
+          end
+          parser
+        end
+
+        def default_option_values(parser)
+          hash = {}
+          parser.specs.each_pair do |key, data|
+            hash[key] = data[:default] || nil
+          end
+          hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Escort
+  module Setup
+    module Configuration
+      class Instance
+        class << self
+          def blank
+            self.new(nil, {})
+          end
+        end
+
+        attr_reader :data, :path
+
+        def initialize(path, hash)
+          @data = hash
+          @path = path
+        end
+
+        def blank?
+          data.empty?
+        end
+        alias empty? blank?
+
+        def global
+          data[:global] || {}
+        end
+
+        def user
+          data[:user] || {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Escort
+  module Setup
+    module Configuration
+      class Loader
+        attr_reader :setup, :auto_options
+
+        def initialize(setup, auto_options)
+          @setup = setup
+          @auto_options = auto_options
+        end
+
+        def configuration
+          if setup.has_config_file?
+            Writer.new(config_path, Generator.new(setup).default_data).write if setup.config_file_autocreatable?
+            Reader.new(config_path).read
+          else
+            Instance.blank
+          end
+        end
+
+        def default_config_path
+          @default_config_path ||= File.join(File.expand_path(ENV["HOME"]), config_filename)
+        end
+
+        private
+
+        def config_filename
+          @config_filename ||= setup.config_file
+        end
+
+        def config_path
+          @config_path ||= (auto_options.non_default_config_path || Locator::DescendingToHome.new(config_filename).locate || default_config_path)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Escort
+  module Setup
+    module Configuration
+      module Locator
+        class Base
+          attr_reader :filename
+
+          def initialize(filename)
+            @filename = filename
+          end
+
+          def locate
+            raise "Must be defined in child class"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require 'pathname'
+
+module Escort
+  module Setup
+    module Configuration
+      module Locator
+        class DescendingToHome < Base
+          def locate
+            return nil unless filename
+            possible_configs = []
+            Pathname.new(Dir.pwd).descend do |path|
+              filepath = File.join(path, filename)
+              if File.exists?(filepath)
+                possible_configs << filepath
+              end
+            end
+            possible_configs.empty? ? nil : possible_configs.last
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Escort
+  module Setup
+    module Configuration
+      class MergeTool
+        def initialize(new_config_hash, old_config_hash)
+          @new_config_hash = new_config_hash
+          @old_config_hash = old_config_hash
+        end
+
+        def config_hash
+          merge_config(@new_config_hash, @old_config_hash)
+        end
+
+        private
+
+        def merge_config(new_hash, old_hash)
+          new_hash.keys.each do |key|
+            new_config_value = new_hash[key]
+            old_config_value = old_hash[key]
+
+            if new_config_value.kind_of?(Hash) && old_config_value.kind_of?(Hash)
+              new_hash[key] = merge_config(new_config_value, old_config_value)
+            elsif old_config_value.nil?
+              new_hash[key] = new_config_value
+            else
+              new_hash[key] = old_config_value
+            end
+
+            if key == :user
+              new_hash[key] = old_config_value
+            end
+          end
+          new_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require 'json'
+
+module Escort
+  module Setup
+    module Configuration
+      class Reader
+        attr_reader :path
+
+        def initialize(path)
+          @path = path
+        end
+
+        def read
+          data = {}
+          data = load_config_at_path if path
+          Instance.new(path, data)
+        end
+
+        private
+
+        def load_config_at_path
+          data = {}
+          begin
+            json = File.read(path)
+            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)
+          end
+          data
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+require 'json'
+
+module Escort
+  module Setup
+    module Configuration
+      class Writer
+        attr_reader :path, :data
+
+        def initialize(path, data)
+          @path = path
+          @data = data
+        end
+
+        def write
+          if path && !File.exists?(path)
+            save_to_file
+            Instance.new(path, data)
+          else
+            Instance.blank
+          end
+        end
+
+        def update
+          current_data = {}
+          if File.exists? path
+            current_data = Reader.new(path).read.data
+          end
+          @data = Escort::Setup::Configuration::MergeTool.new(data, current_data).config_hash
+          save_to_file
+          Instance.new(path, data)
+        end
+
+        private
+
+        def save_to_file
+          current_path = File.expand_path(path)
+          File.open(current_path,"w") do |f|
+            f.puts JSON.pretty_generate(data)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Escort
+  module Setup
+    module Dsl
+      class Action
+        class << self
+          def action(command_name, instance, &block)
+            instance.instance_variable_set(:"@block", block)
+          end
+        end
+
+        def initialize(command_name = :global)
+          @command_name = command_name
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+module Escort
+  module Setup
+    module Dsl
+      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]
+          block.call(self) if block_given?
+        rescue => e
+          raise Escort::ClientError.new("Problem with syntax of command '#{@name}' configuration", e)
+        end
+
+        def options(&block)
+          Options.options(@name, @options, &block)
+        end
+
+        def action(&block)
+          Action.action(@name, @action, &block)
+        end
+
+        def validations(&block)
+          Validations.validations(@name, @validations, &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)
+          #TODO raise a client error if the value is anything besides true or false
+          @requires_arguments = boolean
+          @commands.each do |command|
+            command.requires_arguments(boolean)
+          end
+        end
+
+        def conflicting_options(*command_names)
+          @conflicts << command_names
+        end
+
+        def summary(summary)
+          @summary = summary
+        end
+
+        def description(description)
+          @description = description
+        end
+
+        private
+
+        def reset(name)
+          @requires_arguments = false
+          @commands = {}
+          @options = Options.new(name)
+          @action = Action.new(name)
+          @validations = Validations.new(name)
+          @name = nil
+          @description = nil
+          @aliases = []
+          @conflicts = []
+          @summary = nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Escort
+  module Setup
+    module Dsl
+      class ConfigFile
+        def initialize(name, options = {})
+          @name = name
+          #TODO possibly raise error if autocreate is not a boolean
+          @autocreate = options[:autocreate] || false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+module Escort
+  module Setup
+    module Dsl
+      class Global
+        def initialize(&block)
+          reset
+          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 validations(&block)
+          Validations.validations(:global, @validations, &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)
+          #TODO raise a client error if the value is anything besides true or false
+          @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
+
+        def version(version)
+          @version = version
+        end
+
+        def summary(summary)
+          @summary = summary
+        end
+
+        def description(description)
+          @description = description
+        end
+
+
+        def conflicting_options(*command_names)
+          @conflicts << command_names
+        end
+
+        private
+
+        def reset
+          @version = nil
+          @summary = nil
+          @description = nil
+          @commands = {}
+          @requires_arguments = false
+          @options = Options.new
+          @action = Action.new
+          @validations = Validations.new
+          @config_file  = nil
+          @conflicts = []
+        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
+end