rabbitt-configurator 1.2.4

data/lib/configurator/cast.rb

@@ -0,0 +1,165 @@
+=begin
+Copyright (C) 2013 Carl P. Corliss
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+=end
+
+require 'singleton'
+require 'monitor'
+
+module Configurator
+  module Cast
+    class Director
+      class << self
+        def __mutex__
+          @__mutex__ ||= ::Monitor.new
+        end
+
+        def casts
+          if @casts.nil?
+            __mutex__.synchronize { @casts ||= {} }
+          else
+            @casts
+          end
+        end
+
+        def type_to_key(type)
+          case type
+            when ::Array then "collection:%s" % type.first
+            when ::Proc then "proc:%d" % type.object_id
+            else type.to_s
+          end
+        end
+
+        def acquire(type)
+          type_key = type_to_key(type)
+          return casts[type_key] if casts.include?(type_key)
+
+          __mutex__.synchronize do
+            return casts[type_key] if casts.include?(type_key)
+
+            casts[type_key] = case type
+              when ::Array then
+                Cast::Collection.new(type.first)
+              when :uri, /uri/i then
+                Cast::URI.new
+              when :any, /any/i then
+                Cast::Generic.new
+              when ::Symbol, ::String then
+                begin
+                  Cast.const_get(type.to_s.capitalize).new
+                rescue NameError
+                  raise InvalidCastType, "Invalid cast type #{type}"
+                end
+              when ::Proc then
+                Cast::Callable.new(type)
+            else
+              raise InvalidCastType, "Invalid cast type #{type}"
+            end
+          end
+
+          casts[type_key]
+        end
+        alias :[] :acquire
+      end
+    end
+
+    class Generic
+      def _cast(value) value; end
+      private :_cast
+
+      def convert(value)
+        begin
+          _cast(value);
+        rescue StandardError => e
+          raise CastError.new(e.message).tap { |exc| exc.set_backtrace(e.backtrace) }
+        end
+      end
+    end
+
+    class Collection < Generic
+      def initialize(subtype)
+        @cast = Director.acquire(subtype)
+        raise ArgumentError, "Collection subtype cannot be another collection" if @cast.is_a? Collection
+      end
+
+      def _cast(value)
+        [*value].collect { |v| @cast.convert(v) }
+      end
+    end
+
+    class Scalar < Generic; end
+
+    class String < Generic
+      def _cast(value) value.to_s; end
+    end
+
+    class Integer < Generic
+      def _cast(value) value.to_i; end
+    end
+
+    class Float < Generic
+      def _cast(value) value.to_f; end
+    end
+
+    class Symbol < Generic
+      def _cast(value) value.to_s.to_sym; end
+    end
+
+    class URI < Generic
+      def _cast(value) ::URI.parse(value); end
+    end
+
+    class Path < Generic
+      def _cast(value) ::Pathname.new(value); end
+    end
+
+    class Hash < Generic
+      def _cast(value)
+        return value if value.is_a?(::Hash)
+        case value
+          when Array then
+            return Hash[*value] if value.size % 2 == 0
+            raise CastError, "input array value has odd number of elements - unable to convert to Hash"
+          else { value => value }
+        end
+      end
+    end
+
+    class Array < Generic
+      def _cast(value) [*value] rescue [value]; end
+    end
+
+    class Boolean < Generic
+      def _cast(value)
+        case value
+          when /(off|false|no|disabled?)/ then false
+          when /(on|true|enable|yes)/ then true
+          else !!value
+        end
+      end
+    end
+
+    class Callable < Generic
+      def initialize(proc)
+        @proc = proc
+      end
+
+      def _cast(value)
+        @proc.call(value)
+      end
+    end
+  end
+end

data/lib/configurator/delegated.rb

@@ -0,0 +1,112 @@
+=begin
+Copyright (C) 2013 Carl P. Corliss
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+=end
+
+module Configurator
+  class OptionValue < SimpleDelegator
+    def initialize(option)
+      @option = option
+
+      case @option.type
+        when :string then
+          self.class.send(:define_method, :to_str) { self.to_s } unless defined? :to_str
+        when :integer then
+          self.class.send(:define_method, :to_int) { self.to_i } unless defined? :to_int
+      end
+
+      super(option.value)
+    end
+
+    def method_missing(method, *args, &block)
+      begin
+        super
+      rescue NoMethodError
+        begin
+          raise NoMethodError, "undefined method '#{method}' for #{@option.type} option #{path_name}."
+        rescue NoMethodError => e
+          # hack to remove trace information for this file
+          e.backtrace.collect!{ |line| line.include?(__FILE__) ? nil : line}.compact!
+          raise
+        end
+      end
+    end
+
+    def name; @option.name; end
+    def parent; @option.parent; end
+    def cast; @option.caster.class.name.split('::').last.downcase.to_sym; end
+    def type; @option.type; end
+    def default; @option.default; end
+    def value; self; end
+
+    def root; parent ? parent.root : nil; end
+    def path_name; @option.path_name; end
+
+    def empty?; !option.value.nil? && @option.value.empty?; end
+    def nil?; @option.value.nil?; end
+    def valid?; @option.valid?; end
+    def required?; @option.required?; end
+    def optional?; @option.optional?; end
+  end
+
+  class DelegatedOption < SimpleDelegator
+    attr_accessor :name, :parent
+    private :name=, :parent=
+
+    def initialize(new_name, new_parent, object)
+      @name, @parent = new_name, new_parent
+      super(object)
+    end
+
+    def root() parent.nil? ? self : parent.root; end
+    def path_name()
+      parent.nil? ? name : [ parent.path_name, name ].join('.')
+    end
+
+    def renamed?; self.is_a? RenamedOption; end
+    def deprecated?; self.is_a? DeprecatedOption; end
+    def emit_warning(); end
+    def value() emit_warning; super; end
+    def value=(v) emit_warning; super; end
+  end
+
+  class AliasedOption < DelegatedOption; end
+
+  class RenamedOption < AliasedOption
+    def emit_warning
+      warn "Configuration option #{path_name} was renamed to #{__getobj__.path_name} - please update your configuration"
+    end
+  end
+
+  class DeprecatedOption < DelegatedOption
+    def initialize(name, parent, object, end_of_life = nil)
+      @eol = end_of_life
+      super(name, parent, object)
+    end
+
+    def emit_warning
+      if @eol && !@eol.is_a?(TrueClass)
+        @eol = case @eol
+          when Date, DateTime, Time then @eol.strftime('%F')
+          else @eol
+        end
+        warn "Configuration option #{path_name} is deprecated and will no longer be available on or after #{@eol}."
+      else
+        warn "Configuration option #{path_name} is deprecated and will be removed soon."
+      end
+    end
+  end
+end

data/lib/configurator/dsl.rb

@@ -0,0 +1,139 @@
+=begin
+Copyright (C) 2013 Carl P. Corliss
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+=end
+
+require 'singleton'
+
+module Configurator
+  module DSL
+    extend self
+
+    def self.included(base)
+      base.send :include, Singleton
+      base.send :include, InstanceMethods
+      base.extend self
+
+      # allow for reloading of target class
+      base.class_eval { remove_instance_variable(:@config) if defined? @config }
+
+      base.class_eval(<<-EOF, __FILE__, __LINE__ + 1)
+        def self.method_missing(method, *args, &block)
+          return super unless instance.respond_to? method
+          instance.public_send(method, *args, &block)
+        end
+      EOF
+    end
+
+    def config(&block)
+      @config ||= Configurator::Section.new(:root)
+      @config.instance_exec(@config, &block) if block_given?
+      @config
+    end
+    alias :configuration :config
+    alias :root :config
+
+    def to_yaml
+      instance.to_yaml
+    end
+
+    alias :_inspect :inspect
+    def inspect
+      s = ''
+      s << "#<#{self.class.name}:0x%x " % (self.__id__ * 2)
+      s << {:config_path => config_path, :config => config}.inject([]) { |a,(k,v)| a << "@#{k}=#{v.inspect}" }.join(', ')
+      s << '>'
+    end
+
+    module InstanceMethods
+      attr_reader :config_path
+
+      def config
+        @config ||= self.class.config
+      end
+      alias :root :config
+
+      def respond_to?(method)
+        return true if config.respond_to? method
+        super
+      end
+
+      def method_missing(method, *args, &block)
+        if config.include? method
+          config[method]
+        elsif config.public_methods.include? method
+          config.public_send(method, *args, &block)
+        else
+          super
+        end
+      end
+
+      def reload!
+        return false unless config_path
+        return false unless @env
+        config.load loader.reload!(@env)
+
+        unless config.requirements_fullfilled?
+          raise ConfigurationInvalid, "Missing one or more required options."
+        end
+        self
+      end
+
+      def load(config_path, env)
+        self.tap {
+          @env         = env
+          @config_path = config_path
+          config.load loader.load(@env)
+
+          unless config.requirements_fullfilled?
+            raise ConfigurationInvalid, "Missing one or more required options."
+          end
+        }
+      end
+
+      def alias!(orig_path, new_path)
+        config.alias!(orig_path, new_path)
+      end
+
+      def deprecate!(path, end_of_life = nil)
+        config.deprecate!(path, end_of_life)
+      end
+
+      def rename!(old_path, target_path)
+        config.rename!(old_path, target_path)
+      end
+
+      def load_from_hash(hash)
+        config.load hash
+      end
+
+      def loader
+        @loader ||= Configurator::Loader.new(config_path, Kernel.binding)
+      end
+      private :loader
+
+      def to_h
+        @config.to_h
+      end
+
+      def to_yaml
+        @config.to_yaml
+      end
+    end
+  end
+
+  Bindings = DSL
+end

data/lib/configurator/errors.rb

@@ -0,0 +1,56 @@
+=begin
+Copyright (C) 2013 Carl P. Corliss
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+=end
+
+module Configurator
+  class Error < StandardError; end
+
+  class ValidationError < Error; end
+  class ConfigurationInvalid < Error; end
+
+  class InvalidOptionPath < Error; end
+
+  class CastError < Error; end
+  class InvalidCastType < CastError; end
+  class CastFailure < CastError; end
+
+  class OptionError < Error; end
+
+  class RenameFailed < OptionError; end
+  class DeprecateFailed < OptionError; end
+  class AliasFailed < OptionError; end
+
+  class OptionExists < OptionError; end
+  class OptionNotExist < OptionError; end
+  class OptionInvalid < OptionError; end
+  class OptionInvalidArgument < OptionError; end
+  class OptionInvalidCallableDefault < OptionError; end
+
+  class OptionLoopError < SystemStackError
+    attr_accessor :stack
+
+    def initialize(*args)
+      @stack = []
+      super
+    end
+
+    def to_s
+      "Loop detected in #{stack.first}. Request Stack: #{stack.join(' -> ')}"
+    end
+  end
+
+end

data/lib/configurator/extensions.rb

@@ -0,0 +1,42 @@
+require 'yaml'
+
+class String
+  def option_path_split(sep = '.')
+    return self unless self.count(sep) > 0
+    [ (parts = self.split(sep))[0..-2].join(sep), parts.last ]
+  end
+end
+
+class Hash
+  def stringify_keys!
+    self.replace(inject({}) { |h,(k,v)|
+      h.tap { h[k.to_s] = v.stringify_keys! rescue v }
+    })
+  end
+
+  def stringify_keys
+    self.dup.stringify_keys!
+  end
+end
+
+module Psych
+  module Visitors
+    class YAMLTree < Psych::Visitors::Visitor
+      def visit_Configurator_DelegatedOption(target)
+        send(@dispatch_cache[target.value.class], target.value)
+      end
+
+      def visit_Configurator_Section(target)
+        send(@dispatch_cache[target.table.class], target.table.stringify_keys)
+      end
+
+      def visit_Configurator_Option(target)
+        send(@dispatch_cache[target.value.class], target.value)
+      end
+
+      def visit_Pathname(target)
+        send(@dispatch_cache[target.to_s.class], (target.realpath rescue taret).to_s)
+      end
+    end
+  end
+end

data/lib/configurator/loader.rb

@@ -0,0 +1,56 @@
+=begin
+Copyright (C) 2013 Carl P. Corliss
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+=end
+
+require 'pathname'
+require 'erb'
+require 'yaml'
+
+module Configurator
+  class Loader
+    attr_reader :data, :path
+    private :data
+
+    def initialize(path, _binding = nil)
+      @path    = Pathname.new(path).realpath
+      @binding = _binding
+      @data    = nil
+    end
+
+    def [](env)
+      data[env]
+    end
+
+    def data(reload = false)
+      @data = nil if reload
+
+      @data ||= unless @binding.nil?
+        YAML::load(ERB.new(IO.read(@path.to_s)).result(@binding))
+      else
+        YAML::load(ERB.new(IO.read(@path.to_s)).result)
+      end
+    end
+
+    def load(environment)
+      data[environment.to_s]
+    end
+
+    def reload!(environment)
+      data(true)[environment.to_s]
+    end
+  end
+end