omniconf 0.0.1.pre → 0.0.1

data/.rspec

@@ -1,3 +1,2 @@
 --color
---format progress
---drb
+--format d

data/.rvmrc

@@ -1 +1 @@
-rvm --create ree@omniconf
+rvm --create 1.9.3@omniconf

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - ruby-head
+  - ree

data/Gemfile

@@ -2,7 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in omniconf.gemspec
 gemspec
-
-# FIXME: remove this as soon as the official Gem works with Ruby 1.8
-# (see https://github.com/Offirmo/recursive-open-struct/pull/1)
-gem "recursive-open-struct", :git => "git://github.com/Picklive/recursive-open-struct.git"

data/LICENSE

@@ -0,0 +1,5 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,42 +1,67 @@
-*THIS STUFF IS STILL ALPHA!*
+# Omniconf [![Build Status](https://secure.travis-ci.org/Picklive/omniconf.png)](http://travis-ci.org/#!/Picklive/omniconf)
+
+A _RubyGem_ that provides an application-agnostic configuration merger.
 
 # Setup
 
 Configure and load desired backends by creating a new initializer `config/initializers/omniconf.rb`:
 
-    Omniconf.setup do |config|
-      config.sources = {
-        :yaml_config => {
-          :type => :yaml,
-          :file => "config/settings.yml"
-        },
-        :database_config => {
-          :type => :active_record,
-          :model_name => :ConfigValue
-        }
-      }
-    end
+```ruby
+Omniconf.setup do |config|
+  config.sources = {
+    :yaml_config => {
+      :type => :yaml,
+      :file => "config/settings.yml"
+    },
+    :database_config => {
+      :type => :active_record,
+      :model_name => :ConfigValue
+    }
+  }
+end
+```
 
 # Usage
 
-    $ rails c
-    > Omniconf.configuration.some_config_from_database # value from ConfigValue model
-    "abc"
-    > Omniconf.configuration_hash["some_config_from_database"] # if you prefer the hash way
-    "abc"
-    > Omniconf.configuration.some_config_from_yaml # value from config/settings.yml
-    123
-    > Omniconf.configuration.api.username # it works with nested values too
-    "root"
-
-## Backend sources
+## Getting values
+
+```ruby
+$ rails c
+> Omniconf.configuration.some_config_from_database # value from ConfigValue model
+ => "abc"
+> Omniconf.configuration.some_config_from_yaml # value from config/settings.yml
+ => 123
+> Omniconf.configuration.api.username # it works with nested values too
+ => "root"
+> Omniconf.configuration.api # outputs a hash if nested
+ => {"username"=>"root"}
+> Omniconf.configuration.non_existant.config_value # raises an exception
+ => Omniconf::UnknownConfigurationValue: cannot get a configuration value with no parent
+```
+
+## Setting values
+
+```ruby
+> Omniconf.configuration.some_config_from_database = "def" # updates value in DB using ConfigValue model
+ => "def"
+> Omniconf.configuration.some_config_from_yaml = 456 # raises an exception because the value comes from YAML - who would want to update a YAML file?!
+ => Omniconf::ReadOnlyConfigurationValue: cannot set 'some_config_from_yaml' because it belongs to a read-only back-end source (id: :yaml_config, type: Yaml)
+> Omniconf.configuration.api.username = "admin" # it works with nested values too
+ => "admin"
+> Omniconf.configuration.brand_new_value = "whatever" # raises an exception because you've got to tell which back-end will store the new value
+ => Omniconf::UnknownConfigurationValue: cannot set a configuration value with no parent
+> Omniconf.sources[:database_config].brand_new_value = "whatever" # adds a new row in ConfigValue model
+ => "whatever"
+```
+
+## Back-end sources
 
 `:type` is the only required parameter.
 Other parameters default to standard values for Rails.
 
 ### Yaml
 
-Nothing to configure apart from a YAML file.
+Nothing to configure apart from having a YAML file.
 
 _Note: read-only._
 
@@ -46,15 +71,17 @@ Add `gem 'activerecord'` in your `Gemfile`.
 
 Create a new migration to add the config table: _(FIXME: add a rake task for this)_
 
-    class CreateConfigValues < ActiveRecord::Migration
-      def change
-        create_table :config_values do |t|
-          t.string :key, :null => false
-          t.string :value, :null => false
-        end
-        add_index :config_values, :key, :unique => true
-      end
+```ruby
+class CreateConfigValues < ActiveRecord::Migration
+  def change
+    create_table :config_values do |t|
+      t.string :key, :null => false
+      t.string :value, :null => false
     end
+    add_index :config_values, :key, :unique => true
+  end
+end
+```
 
 ### Redis
 
@@ -62,9 +89,23 @@ Add `gem 'redis'` in your `Gemfile`.
 
 Not yet implemented.
 
+## Reserved words
+
+/!\ You should not use these names as configuration keys:
+
+- `to_hash`: it's a helper which returns the configuration as a hash
+- `inspect`: outputs sub-values as a hash
+- `get_or_default`: it's a helper which returns the value if it exists or creates it otherwise (usage: `get_or_default(key, default_value)`)
+- `method_missing`: used internally
+- everything which starts with `__` (double underscore): used internally
+
 # Testing
 
 `rake`
 
-Tested on _ree-1.8.7_ and _ruby-1.9.3_.
+Tested against _ree_, _ruby-1.9.3_ and _ruby-head_.
+
+# License
+
+MIT
 

data/lib/omniconf/adapters/active_record.rb

@@ -3,28 +3,57 @@ require 'active_record'
 module Omniconf
   module Adapter
     class ActiveRecord < Base
-      attr_reader :model
-
-      def initialize params
+      def initialize id, params
+        @source_id = id
         defaults = {
-          :model_name => :ConfigValue,
+          :model_name => :ConfigValue
+        }
+        defaults.merge!({
           :environment => Rails.env,
           :config_file => File.join(Rails.root, 'config/database.yml')
-        }
+        }) if defined? Rails
         @params = defaults.merge params
       end
 
       def load_configuration!
         setup
 
-        @configuration_hash = {}
-        @model.all.map do |record|
-          @configuration_hash[record.key] = record.value
+        # create an empty config in case ActiveRecord raises
+        @configuration = Configuration.new self
+
+        begin
+          records = @model.all
+        rescue ::ActiveRecord::StatementInvalid => e
+          Omniconf.logger.warn "Could not load #{@params[:model_name]} model, ignoring this configuration source."
+          return
+        end
+
+        # build the configuration hash from DB (nesting on dots)
+        hash = {}
+        records.map do |record|
+          key, value = record.key.split('.'), record.value
+          el = key[0..-2].inject(hash) {|r,e| r[e] ||= {} }
+          raise unless el[key.last].nil?
+          el[key.last] = value
+        end
+        @configuration = Configuration.new self, hash
+
+        Omniconf.merge_configuration! @source_id
+      end
+
+      def set_value(key, value)
+        key = key.join('.')
+        if item = @model.find_by_key(key)
+          item.value = value
+        else
+          item = @model.new(:key => key, :value => value)
         end
-        merge_configuration! @configuration_hash
+        item.save!
+        item.value
       end
 
       def setup
+        # define the ActiveRecord model if missing
         unless Object.const_defined? @params[:model_name]
           unless ::ActiveRecord::Base.connected?
             ::ActiveRecord::Base.configurations = YAML::load(IO.read(@params[:config_file]))
@@ -33,32 +62,6 @@ module Omniconf
 
           klass = Class.new ::ActiveRecord::Base do
             validates_uniqueness_of :key
-
-            def self.[]=(key, value)
-              if item = self.find_by_key(key.to_s)
-                item.value = value.to_s
-              else
-                item = self.new(:key => key.to_s, :value => value.to_s)
-              end
-              item.save!
-              item.value
-            end
-
-            def self.[](key)
-              if item = find_by_key(key.to_s)
-                return item.value
-              end
-            end
-
-            def self.get_or_default(key, default)
-              if item = find_by_key(key.to_s)
-                return item.value
-              else
-                self[key] = default
-                return default
-              end
-            end
-
           end
 
           Object.const_set @params[:model_name], klass

data/lib/omniconf/adapters/base.rb

@@ -1,27 +1,10 @@
-require 'recursive_open_struct'
+require 'omniconf/configuration'
 
 module Omniconf
   module Adapter
     class Base
-      attr_accessor :configuration_hash
-
-      def configuration
-        RecursiveOpenStruct.new @configuration_hash
-      end
-
-      def merge_configuration! with_config
-        Omniconf.logger.debug "Merged global configuration BEFORE: #{Omniconf.configuration_hash.inspect}"
-        adapter = self.class.ancestors.first.to_s.split(':').last
-        Omniconf.logger.debug "Merging from #{adapter} configuration: #{with_config.inspect}"
-        Omniconf.configuration_hash.merge!(with_config) do |key, old_val, new_val|
-          Omniconf.logger.warn \
-            "'#{key}' has been overriden with value from #{adapter} configuration " <<
-            "(old value: #{old_val.inspect}, new value: #{new_val.inspect})" if new_val != old_val
-          new_val
-        end
-        Omniconf.logger.debug "Merged global configuration AFTER: #{Omniconf.configuration_hash.inspect}"
-        Omniconf.configuration = RecursiveOpenStruct.new Omniconf.configuration_hash
-      end
+      attr_reader :source_id
+      attr_reader :configuration
     end
   end
 end

data/lib/omniconf/adapters/read_only.rb

@@ -0,0 +1,12 @@
+module Omniconf
+  module Adapter
+    module ReadOnly
+      def set_value(key, value)
+        raise ReadOnlyConfigurationValue, "cannot set '#{key.join('.')}' " <<
+          "because it belongs to a read-only back-end source " <<
+          "(id: #{@source_id.inspect}, type: #{self.class.to_s.demodulize})"
+      end
+    end
+  end
+end
+

data/lib/omniconf/adapters/yaml.rb

@@ -1,21 +1,26 @@
+require 'omniconf/adapters/read_only'
+
 module Omniconf
   module Adapter
     class Yaml < Base
+      include ReadOnly
 
-      def initialize params
-        defaults = {
+      def initialize id, params
+        @source_id = id
+        defaults = {}
+        defaults.merge!({
           :environment => Rails.env,
           :file => File.join(Rails.root, 'config/settings.yml')
-        }
+        }) if defined? Rails
         @params = defaults.merge params
       end
 
       def load_configuration!
-        yaml = ::YAML.load_file(@params[:file])
-        @configuration_hash = yaml[@params[:environment]]
-        merge_configuration! @configuration_hash
-      end
+        yaml = ::YAML.load_file(@params[:file])[@params[:environment]]
+        @configuration = Omniconf::Configuration.new(self, yaml)
 
+        Omniconf.merge_configuration! @source_id
+      end
     end
   end
 end

data/lib/omniconf/blank_state.rb

@@ -0,0 +1,9 @@
+module Omniconf
+  class BlankSlate
+    instance_methods.each do |method|
+      undef_method method unless method =~ /^__/ or
+        [:inspect, :instance_of?, :object_id, :should].include? method.to_sym
+    end
+  end
+end
+

data/lib/omniconf/configuration.rb

@@ -0,0 +1,91 @@
+require 'omniconf/blank_state'
+
+module Omniconf
+  class Configuration < Omniconf::BlankSlate
+    # XXX: Every method defined in this class overrides config value accessors,
+    # hence it inherits from BlankSlate (and the gross 'method_missing')
+
+    def initialize(adapter, table = {}, parent = nil)
+      @__adapter, @__parent = adapter, parent
+      @__table = table.recursive_stringify_keys!
+    end
+
+    # Helpful helper which returns the object as a hash
+    def to_hash
+      @__table
+    end
+
+    def inspect
+      @__table.inspect
+    end
+
+    def get_or_default(key, default)
+      raise "key cannot be nested" if key.include? '.'
+      __send__ :"#{key}=", default unless value = __send__(:"#{key}")
+      value || default
+    end
+
+    def method_missing(method, *args)
+      raise NoMethodError, "undefined method `#{method}' for #{self}" \
+        if method.to_s[0..1] == '__' # will save hours tracking down heisenbugs
+
+      len = args.length
+      if new_key = method.to_s.chomp!('=') # write
+        if len == 1
+          key, value = new_key, args[0]
+        else
+          raise ArgumentError, "wrong number of arguments (#{len} for 1)"
+        end
+
+        if @__adapter # should not be nil expect for testing purposes
+          # update the actual source data (e.g. does the SQL query)
+          full_key, parent = [key], @__parent
+          while parent # build the full nested key from parents
+            full_key = full_key.unshift parent[:root]
+            parent = parent[:object].__parent
+          end
+
+          @__adapter.set_value(full_key, value) # notify the adapter
+        else
+          Omniconf.logger.warn "No adapter to notify"
+        end
+
+        @__table[key] = value # update our internal config hash
+
+        if @__adapter.is_a? Omniconf::Adapter::Base
+          # we need to merge the global config
+          Omniconf.merge_configuration! @__adapter.source_id
+        end
+
+      elsif len == 0 # read
+        key = method.to_s
+        value = @__table[key]
+        if value.is_a?(Hash)
+          Configuration.new(@__adapter, value, {:root => key, :object => self})
+        else
+          unless value
+            # add a catch-all exception
+            # (more descriptive than "undefined method `xxx' for nil:NilClass")
+            class << value
+              def method_missing *args
+                raise UnknownConfigurationValue,
+                      "cannot get a configuration value with no parent"
+              end
+            end
+          end
+          value
+        end
+
+      else
+        raise NoMethodError, "undefined method `#{method}' for #{self}"
+      end
+    end
+
+    protected
+    attr_reader :__parent
+
+    private
+    attr_reader :__table
+  end
+end
+

data/lib/omniconf/errors.rb

@@ -0,0 +1,7 @@
+module Omniconf
+  # Raised when trying to get or set a non-existent configuration value
+  class UnknownConfigurationValue < StandardError; end
+
+  # Raised when trying to set a read-only configuration value
+  class ReadOnlyConfigurationValue < StandardError; end
+end

data/lib/omniconf/helpers.rb

@@ -0,0 +1,30 @@
+class Hash
+  # Recursive version of Rails' stringify_keys!
+  def recursive_stringify_keys!
+    self.keys.each do |key|
+      self[key.to_s] = self.delete(key) unless key.is_a? String
+      self[key.to_s].recursive_stringify_keys! if self[key.to_s].is_a? Hash
+    end
+    self
+  end
+
+  def recursive_merge! with_hash
+    self.merge!(with_hash) do |key, old_val, new_val|
+      if new_val.is_a?(Hash) and old_val.is_a?(Hash)
+        # merge sub-hashes together
+        new_val = old_val.recursive_merge! new_val
+      else
+        # yield block when overriding
+        yield key, old_val, new_val if block_given? and new_val != old_val
+      end
+      new_val
+    end
+  end
+end
+
+class String
+   def demodulize
+     self.gsub(/^.*::/, '')
+   end
+end
+

data/lib/omniconf/version.rb

@@ -1,3 +1,3 @@
 module Omniconf
-  VERSION = "0.0.1.pre"
+  VERSION = "0.0.1"
 end

data/lib/omniconf.rb

@@ -1,20 +1,28 @@
 require 'logger'
-require "omniconf/version"
-require "omniconf/settings"
+require 'omniconf/version'
+require 'omniconf/helpers'
+require 'omniconf/errors'
+require 'omniconf/settings'
+require 'omniconf/adapters/base'
 
 module Omniconf
   class << self
     attr_reader :settings # Omniconf settings
-    attr_accessor :configuration # Global configuration as a RecursiveOpenStruct
-    attr_writer :configuration_hash # Global configuration as an Hash
+    attr_reader :configuration # global merged configuration
+    alias_method :conf, :configuration # shortcut for the lazy people
 
-    def configuration_hash
-      @configuration_hash ||= {}
+    def setup
+      @settings ||= Settings.new
+      yield @settings
+
+      register_sources
+
+      @settings.load_configuration = true if @settings.load_configuration.nil?
+      load_configuration! if @settings.load_configuration
     end
 
     def logger
       unless @logger
-        # @logger ||= defined? Rails.logger ? Rails.logger : Logger.new(STDOUT)
         @logger = Logger.new(STDOUT)
         @logger.level = @settings.logger_level if @settings
         @logger.level = Logger::INFO if @logger.level.nil?
@@ -22,39 +30,68 @@ module Omniconf
       @logger
     end
 
-    def setup
-      @settings = Settings.new
-      yield @settings
-
-      register_sources
-
-      @settings.load_configuration = true if @settings.load_configuration.nil?
-      load_configuration! if @settings.load_configuration
+    # Returns a mapping on source adapters
+    def sources
+      @settings.sources.to_a.inject({}) do |result, (source_id, source)|
+        result[source_id] = source[:adapter].configuration
+        result
+      end
     end
 
     def load_configuration!
+      @configuration = Omniconf::Configuration.new self
       @settings.sources.each do |source_id, params|
         params[:adapter].load_configuration!
-        Omniconf.logger.info "Loaded configuration from #{source_id} source"
+        Omniconf.logger.info "Loaded configuration from #{source_id.inspect} source"
       end
     end
 
-    private
+    alias_method :reload_configuration!, :load_configuration!
+
+    def merge_configuration! source_id
+      Omniconf.logger.debug "Merging from #{source_id.inspect} source"
+      source_config = Omniconf.sources[source_id].to_hash
+      global_config = Omniconf.configuration.to_hash
+      global_config.recursive_merge!(source_config) do |key, old_val, new_val|
+        Omniconf.logger.warn \
+          "'#{key}' has been overriden with value from #{source_id.inspect} source " <<
+          "(old value: #{old_val.inspect}, new value: #{new_val.inspect})"
+      end
+    end
 
+    def set_value(key, value)
+      found = false
+      @settings.sources.to_a.reverse.each do |source_id, source|
+        # We try to find the original source overriding the last merged one,
+        # hence we scan sources backwards
+        adapter = source[:adapter]
+        config = adapter.configuration.to_hash
+        element = key[0..-2].inject(config) { |result, el| result[el] }
+        if element and element[key.last] # we've found it in the current source
+          element[key.last] = value
+          adapter.set_value(key, value)
+          found = true
+          break
+        end
+      end
+      raise UnknownConfigurationValue,
+            "cannot set a configuration value with no parent" unless found
+    end
+
+    private
     def register_sources
+      return unless @settings.sources
       @settings.sources.each do |source_id, params|
         adapter_file = params[:type].to_s
-        require "omniconf/adapters/base"
         require "omniconf/adapters/#{adapter_file}"
-        adapter_class = adapter_file.to_s.split('_').map {|w| w.capitalize}.join
+        adapter_class = adapter_file.split('_').map {|w| w.capitalize}.join
         raise unless params[:adapter].nil?
         params[:adapter] = Omniconf::Adapter.class_eval do
-          const_get(adapter_class).new(params)
+          const_get(adapter_class).new(source_id, params)
         end
-        Omniconf.logger.info "Registered #{adapter_class}::#{source_id} source"
+        Omniconf.logger.debug "Registered #{adapter_class}::#{source_id} source"
       end
     end
-
   end
 end
 

data/omniconf.gemspec

@@ -5,11 +5,11 @@ require "omniconf/version"
 Gem::Specification.new do |s|
   s.name        = "omniconf"
   s.version     = Omniconf::VERSION
-  s.authors     = ["Cédric Felizard"]
+  s.authors     = ["Cedric Felizard"]
   s.email       = ["cedric@picklive.com"]
   s.homepage    = "https://github.com/Picklive/omniconf"
   s.summary     = %q{Merge multiple configuration sources into one.}
-  s.description = %q{Merge configurations from multiple backends for easy use in a Rails application.}
+  s.description = %q{Merge configurations from multiple back-ends for easy use in a complex application.}
 
   s.rubyforge_project = "omniconf"
 
@@ -18,10 +18,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "recursive-open-struct"
-
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "sqlite3"
-  s.add_development_dependency "activerecord"
+  s.add_development_dependency 'rake', '~> 0.9'
+  s.add_development_dependency 'rspec', '~> 2.8'
+  s.add_development_dependency 'sqlite3', '~> 1.3'
+  s.add_development_dependency 'activerecord', '~> 3.2'
 end

data/spec/fixtures/omniconf/adapters/active_record/db/schema.rb

@@ -1,3 +1,5 @@
+ActiveRecord::Migration.verbose = false
+
 ActiveRecord::Schema.define :version => 0 do
   create_table :config_values, :force => true do |t|
     t.string :key
@@ -5,6 +7,7 @@ ActiveRecord::Schema.define :version => 0 do
   end
 end
 
-ConfigValue.create!({:key => 'foo', :value => 'bar'})
-ConfigValue.create!({:key => 'foo2', :value => 'bar2'})
+ConfigValue.create!({:key => 'ar_key', :value => 'ar_value'})
+ConfigValue.create!({:key => 'nested.ar_key', :value => 'nested_ar_value'})
+ConfigValue.create!({:key => 'nested.overridden', :value => 'by_ar'})