omniconf 0.0.2 → 0.1.0

data/README.md

@@ -36,10 +36,12 @@ $ rails c
  => 123
 > Omniconf.configuration.api.username # it works with nested values too
  => "root"
-> Omniconf.configuration.api # outputs a hash if nested
+> Omniconf.configuration.api # returns a hash if nested
  => {"username"=>"root"}
+> Omniconf.configuration.non_existant # returns nil
+ => nil
 > Omniconf.configuration.non_existant.config_value # raises an exception
- => Omniconf::UnknownConfigurationValue: cannot get a configuration value with no parent
+ => NoMethodError: undefined method `config_value' for nil:NilClass
 ```
 
 ## Setting values
@@ -52,7 +54,7 @@ $ rails c
 > 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::UnknownConfigurationValue: cannot set a configuration value with no parents
 > Omniconf.sources[:database].brand_new_value = "whatever" # adds a new record in ConfigValue model
  => "whatever"
 ```

data/lib/omniconf.rb

@@ -43,13 +43,14 @@ module Omniconf
         params[:adapter].load_configuration!
         Omniconf.logger.info "Loaded configuration from #{source_id.inspect} source"
       end
+      Omniconf.logger.info "Global configuration: #{configuration.inspect}"
     end
 
     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
+      Omniconf.logger.debug "Merging #{source_config.inspect} from #{source_id.inspect} source"
       global_config = Omniconf.configuration.to_hash
       global_config.recursive_merge!(source_config) do |key, old_val, new_val|
         Omniconf.logger.warn \
@@ -74,7 +75,7 @@ module Omniconf
         end
       end
       raise UnknownConfigurationValue,
-            "cannot set a configuration value with no parent" unless found
+            "cannot set a configuration value with no parents" unless found
     end
 
     private
@@ -82,12 +83,16 @@ module Omniconf
       return unless @settings.sources
       @settings.sources.each do |source_id, params|
         adapter_file = params[:type].to_s
+
         require "omniconf/adapters/#{adapter_file}"
+
         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(source_id, params)
         end
+
         Omniconf.logger.debug "Registered #{adapter_class}::#{source_id} source"
       end
     end

data/lib/omniconf/blank_state.rb

@@ -1,8 +1,10 @@
 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
+    # do not undef these methods
+    WHITELIST = %w(inspect object_id)
+
+    instance_methods.map(&:to_s).each do |method|
+      undef_method method unless method.start_with?('__') || WHITELIST.include?(method)
     end
   end
 end

data/lib/omniconf/configuration.rb

@@ -27,13 +27,11 @@ module Omniconf
 
     def method_missing(method, *args)
       raise NoMethodError, "undefined method `#{method}' for #{self}" \
-        if method.to_s[0..1] == '__' # will save hours tracking down heisenbugs
+        if method.to_s.start_with? '__' # 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
+      if key = method.to_s.chomp!('=') # write
+        unless len == 1 # args[0] is the value
           raise ArgumentError, "wrong number of arguments (#{len} for 1)"
         end
 
@@ -45,12 +43,12 @@ module Omniconf
             parent = parent[:object].__parent
           end
 
-          @__adapter.set_value(full_key, value) # notify the adapter
+          @__adapter.set_value(full_key, args[0]) # notify the adapter
         else
           Omniconf.logger.warn "No adapter to notify"
         end
 
-        @__table[key] = value # update our internal config hash
+        @__table[key] = args[0] # update our internal config hash
 
         if @__adapter.is_a? Omniconf::Adapter::Base
           # we need to merge the global config
@@ -63,21 +61,6 @@ module Omniconf
         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 method, *args
-                if method == :to_str
-                  # need to raise NoMethodError here for Ruby 1.9.2 compatibility
-                  raise NoMethodError, "undefined method `#{method}' for #{self}"
-                else
-                  raise UnknownConfigurationValue,
-                        "cannot get a configuration value with no parent"
-                end
-              end
-            end
-          end
           value
         end
 

data/lib/omniconf/version.rb

@@ -1,3 +1,3 @@
 module Omniconf
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/omniconf.gemspec

@@ -5,9 +5,9 @@ require "omniconf/version"
 Gem::Specification.new do |s|
   s.name        = "omniconf"
   s.version     = Omniconf::VERSION
-  s.authors     = ["Cedric Felizard"]
-  s.email       = ["cedric@picklive.com"]
-  s.homepage    = "https://github.com/Picklive/omniconf"
+  s.authors     = ["Cédric Félizard"]
+  s.email       = ["cedric@felizard.fr"]
+  s.homepage    = "https://github.com/infertux/omniconf"
   s.summary     = %q{Merge multiple configuration sources into one.}
   s.description = %q{Merge configurations from multiple back-ends for easy use in a complex application.}
 
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency 'rake', '~> 0.9'
-  s.add_development_dependency 'rspec', '~> 2.8'
+  s.add_development_dependency 'rspec', '~> 2.10'
   s.add_development_dependency 'sqlite3', '~> 1.3'
   s.add_development_dependency 'activerecord', '~> 3.2'
 end

data/spec/fixtures/omniconf/adapters/yaml/config/settings.yml

@@ -1,10 +1,18 @@
+common: &common
+  common_key: common_value
+  override_key: override_me
+
 test:
+  <<: *common
   yaml_key: yaml_value
-  nested:
-    yaml_key: nested_yaml_value
-    overridden: by_yaml
+  override_key: override_value
   some_integer: 1337
   some_float: 3.14
   some_array: [1, 2, 3]
+  nested:
+    yaml_key: nested_yaml_value
+
 development:
+  <<: *common
   yaml_key: yaml_value_dev
+

data/spec/omniconf/adapters/yaml_spec.rb

@@ -86,6 +86,17 @@ describe Omniconf::Adapter::Yaml do
       config.yaml_key.should == 'yaml_value_dev'
     end
 
+    it "merges common values" do
+      %w(test development).each do |env|
+        load_configuration env
+        config.common_key.should == 'common_value'
+      end
+    end
+
+    it "overrides common values" do
+      config.override_key.should == 'override_value'
+    end
+
     it "keeps value types" do
       config.some_integer.should == 1337
       config.some_float.should == 3.14

data/spec/omniconf/configuration_spec.rb

@@ -17,6 +17,11 @@ describe Omniconf::Configuration do
     }
   end
 
+  it "is blank slated" do
+    # check we don't have the 40-ish methods inherited from the Object class
+    Omniconf::Configuration.new(nil).hash.should be_nil
+  end
+
   describe "#initialize" do
     it "takes a hash as argument" do
       expect { Omniconf::Configuration.new nil, hash }.to_not raise_error

data/spec/omniconf/helpers_spec.rb

@@ -3,7 +3,7 @@ require 'omniconf/helpers'
 
 describe Hash do
   describe "#recursive_stringify_keys!" do
-    it "stringify hash's keys recursively" do
+    it "stringify hash keys recursively" do
       hash = {:a => 1, :b => {:aa => {:aaa => 'AAA', 'bbb' => nil}}}
       hash.recursive_stringify_keys!
       hash.should == {'a' => 1, 'b' => {'aa' => {'aaa' => 'AAA', 'bbb' => nil}}}

data/spec/omniconf_spec.rb

@@ -53,10 +53,6 @@ describe Omniconf do
         Omniconf.configuration
       end
 
-      it "returns an instance of Omniconf::Configuration" do
-        config.should be_an_instance_of Omniconf::Configuration
-      end
-
       describe "getting values" do
         it "loads and merges all configurations" do
           config.yaml_key.should == 'yaml_value'
@@ -89,7 +85,7 @@ describe Omniconf do
         end
 
         it "fails to create a new value with no sources" do
-          # How the hell would I know where to store it?!
+          # since we cannot know in which source to save it
           config.no.should be_nil
           expect {
             config.no = 'whatever'
@@ -102,7 +98,7 @@ describe Omniconf do
 
           expect {
             Omniconf.sources[:database].no.no = 'new_ar_value'
-          }.to raise_error Omniconf::UnknownConfigurationValue
+          }.to raise_error NoMethodError
         end
       end
     end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: omniconf
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
-- Cedric Felizard
+- Cédric Félizard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-12 00:00:00.000000000 Z
+date: 2012-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152356800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,31 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *2152356800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152342400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.10'
   type: :development
   prerelease: false
-  version_requirements: *2152342400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2152340720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *2152340720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2152339860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,11 +69,16 @@ dependencies:
         version: '3.2'
   type: :development
   prerelease: false
-  version_requirements: *2152339860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: Merge configurations from multiple back-ends for easy use in a complex
   application.
 email:
-- cedric@picklive.com
+- cedric@felizard.fr
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -95,7 +115,7 @@ files:
 - spec/omniconf/helpers_spec.rb
 - spec/omniconf_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/Picklive/omniconf
+homepage: https://github.com/infertux/omniconf
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -115,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: omniconf
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Merge multiple configuration sources into one.