omniconf 0.0.1.pre → 0.0.1

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

@@ -1,8 +1,7 @@
-development:
-  api:
-    username: user
-    password: pass
 test:
-  api:
-    username: test_user
-    password: test_password
+  yaml_key: yaml_value
+  nested:
+    yaml_key: nested_yaml_value
+    overridden: by_yaml
+development:
+  yaml_key: yaml_value_dev

data/spec/omniconf/adapters/active_record_spec.rb

@@ -2,36 +2,72 @@ require 'spec_helper'
 require 'omniconf/adapters/active_record'
 
 describe Omniconf::Adapter::ActiveRecord do
-  before do
-    @database = Omniconf::Adapter::ActiveRecord.new({
+  def load_configuration
+    @adapter = Omniconf::Adapter::ActiveRecord.new(:active_record, {
       :model_name => :ConfigValue,
       :environment => 'test',
-      :config_file => File.join(File.dirname(__FILE__),
-        '../../fixtures/omniconf/adapters/active_record/config/database.yml'
+      :config_file => File.expand_path(
+        '../../../fixtures/omniconf/adapters/active_record/config/database.yml',
+        __FILE__
       )
     })
-    @database.setup
+    @adapter.setup
 
-    require File.join(File.dirname(__FILE__),
-      '../../fixtures/omniconf/adapters/active_record/db/schema.rb'
+    load File.expand_path(
+      '../../../fixtures/omniconf/adapters/active_record/db/schema.rb', __FILE__
     )
 
-    @database.load_configuration!
+    @adapter.load_configuration!
   end
 
-  describe "#[]" do
-    it "returns configuration values from database" do
-      @database.configuration.foo.should == 'bar'
-      @database.configuration.foo2.should == 'bar2'
+  describe "#configuration" do
+    before do
+      Omniconf.stub(:merge_configuration!)
+      load_configuration
     end
 
-    pending "it doesn't cast values to String" # TODO serialize them and keep type
-  end
+    let(:configuration) { @adapter.configuration }
+
+    describe "getting values" do
+      it "returns a value" do
+        configuration.ar_key.should == 'ar_value'
+      end
+
+      it "returns a nested value" do
+        configuration.nested.ar_key.should == 'nested_ar_value'
+      end
+    end
+
+    describe "setting values" do
+      it "updates configuration values into database" do
+        configuration.ar_key.should == 'ar_value'
+        configuration.ar_key = 'new_ar_value'
+        configuration.ar_key.should == 'new_ar_value'
+      end
+
+      it "creates configuration values into database" do
+        configuration.new_ar_key.should be_nil
+        configuration.new_ar_key = 'new_ar_value'
+        configuration.new_ar_key.should == 'new_ar_value'
+      end
+
+      it "it doesn't cast values to String" # TODO serialize them and keep type
+    end
+
+    describe "#get_or_default" do
+      it "creates a new default value" do
+        configuration.newValue.should be_nil
+        @adapter.should_receive(:set_value).with(['newValue'], 'a')
+        configuration.get_or_default('newValue', 'a').should == 'a'
+        configuration.get_or_default('newValue', 'b').should == 'a'
+      end
 
-  describe "#get_or_default" do
-    it "sets default value if new" do
-      @database.model.get_or_default('newValue', 'a').should == 'a'
-      @database.model.get_or_default('newValue', 'b').should == 'a'
+      it "creates a new default nested value" do
+        configuration.nested.newValue.should be_nil
+        @adapter.should_receive(:set_value).with(['nested', 'newValue'], 'a')
+        configuration.nested.get_or_default('newValue', 'a').should == 'a'
+        configuration.nested.get_or_default('newValue', 'b').should == 'a'
+      end
     end
   end
 end

data/spec/omniconf/adapters/yaml_spec.rb

@@ -2,26 +2,86 @@ require 'spec_helper'
 require 'omniconf/adapters/yaml'
 
 describe Omniconf::Adapter::Yaml do
-  def load_environment env
-    @yaml = Omniconf::Adapter::Yaml.new({
+  def load_configuration env
+    @adapter = Omniconf::Adapter::Yaml.new(:yaml_conf, {
       :environment => env,
       :file => File.join(File.dirname(__FILE__),
         '../../fixtures/omniconf/adapters/yaml/config/settings.yml'
       )
     })
-    @yaml.load_configuration!
+    @adapter.load_configuration!
   end
 
-  it "allows to get nested attributes" do
-    load_environment 'test'
-    @yaml.configuration.api.username.should == 'test_user'
-    @yaml.configuration.api.password.should == 'test_password'
-  end
+  describe "#configuration" do
+    before do
+      Omniconf.stub(:merge_configuration!)
+      load_configuration('test')
+    end
+
+    let(:configuration) { @adapter.configuration }
+
+    describe "getting values" do
+      it "returns a value" do
+        configuration.yaml_key.should == 'yaml_value'
+      end
+
+      it "returns a nested value" do
+        configuration.nested.yaml_key.should == 'nested_yaml_value'
+      end
+    end
+
+    describe "setting values" do
+      it "fails to update a value" do
+        configuration.yaml_key.should_not be_nil
+        expect {
+          configuration.yaml_key = 'whatever'
+        }.to raise_error Omniconf::ReadOnlyConfigurationValue
+      end
+
+      it "fails to update a nested value" do
+        configuration.nested.yaml_key.should_not be_nil
+        expect {
+          configuration.nested.yaml_key = 'whatever'
+        }.to raise_error Omniconf::ReadOnlyConfigurationValue
+      end
+
+      it "fails to create a value" do
+        configuration.new_yaml_key.should be_nil
+        expect {
+          configuration.new_yaml_key = 'whatever'
+        }.to raise_error Omniconf::ReadOnlyConfigurationValue
+      end
+
+      it "fails to create a nested value" do
+        configuration.nested.new_yaml_key.should be_nil
+        expect {
+          configuration.nested.new_yaml_key = 'whatever'
+        }.to raise_error Omniconf::ReadOnlyConfigurationValue
+      end
+    end
+
+    describe "#get_or_default" do
+      it "fails to create a new default value" do
+        configuration.newValue.should be_nil
+        expect {
+          configuration.get_or_default('newValue', 'a').should == 'a'
+        }.to raise_error Omniconf::ReadOnlyConfigurationValue
+        configuration.newValue.should be_nil
+      end
+
+      it "fails to create a new nested default value" do
+        configuration.nested.newValue.should be_nil
+        expect {
+          configuration.nested.get_or_default('newValue', 'a').should == 'a'
+        }.to raise_error Omniconf::ReadOnlyConfigurationValue
+        configuration.nested.newValue.should be_nil
+      end
+    end
 
-  it "loads the right environment" do
-    load_environment 'development'
-    @yaml.configuration.api.username.should == 'user'
-    @yaml.configuration.api.password.should == 'pass'
+    it "loads the right environment" do
+      load_configuration 'development'
+      configuration.yaml_key.should == 'yaml_value_dev'
+    end
   end
 end
 

data/spec/omniconf/configuration_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'omniconf/configuration'
+
+describe Omniconf::Configuration do
+  let(:hash) do
+    {
+      'key' => 'level0',
+      'nested0' => {
+        'key' => 'level1',
+        'nested1' => {
+          'key' => 'level2',
+          'nested2' => {
+            'answer' => 42
+          }
+        }
+      }
+    }
+  end
+
+  describe "#initialize" do
+    it "takes a hash as argument" do
+      expect { Omniconf::Configuration.new nil, hash }.to_not raise_error
+    end
+  end
+
+  context "with a configuration" do
+    before do
+      @config = Omniconf::Configuration.new nil, hash
+    end
+
+    describe "getting values" do
+      it "returns a value" do
+        @config.key.should == 'level0'
+      end
+
+      it "returns a nested value" do
+        @config.nested0.key.should == 'level1'
+        @config.nested0.nested1.nested2.answer.should == 42
+      end
+
+      it "#nil? returns true for non-existant values" do
+        @config.nope_404.should be_nil
+      end
+
+      it "is false when a non-existant value is coerced to a boolean" do
+        (!!(@config.nope_404)).should == false
+        (@config.nope_404 ? true : false).should == false
+      end
+    end
+
+    describe "setting values" do
+      it "updates a value" do
+        @config.key.should_not == 'new_level0'
+        @config.key = 'new_level0'
+        @config.key.should == 'new_level0'
+      end
+
+      it "creates a new value" do
+        @config.key2.should be_nil
+        @config.key2 = 'new_value'
+        @config.key2.should == 'new_value'
+      end
+
+      it "updates a nested value" do
+        @config.to_hash.should == hash
+        @config.nested0.nested1.key.should_not == :new
+        @config.nested0.nested1.key = :new
+        @config.nested0.nested1.key.should == :new
+        expected = hash
+        expected['nested0']['nested1']['key'] = :new
+        @config.to_hash.should == expected
+      end
+
+      it "creates a new nested value" do
+        @config.to_hash.should == hash
+        @config.nested0.new.should be_nil
+        @config.nested0.new = 'new_value'
+        @config.nested0.new.should == 'new_value'
+        expected = hash
+        expected['nested0']['new'] = 'new_value'
+        @config.to_hash.should == expected
+      end
+    end
+  end
+end
+

data/spec/omniconf/helpers_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'omniconf/helpers'
+
+describe Hash do
+  describe "#recursive_stringify_keys!" do
+    it "stringify hash's 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}}}
+    end
+  end
+end
+

data/spec/omniconf_spec.rb

@@ -16,47 +16,93 @@ describe Omniconf do
     end
   end
 
-  describe "#load_configuration!" do
-    def setup
+  context "with some fixtures" do
+    before do
       Omniconf.setup do |config|
-        config.load_configuration = false
+        config.load_configuration = true
         config.sources = {
           :yaml => {
             :type => :yaml,
             :environment => 'test',
-            :file => File.join(File.dirname(__FILE__),
-              'fixtures/omniconf/adapters/yaml/config/settings.yml'
+            :file => File.expand_path(
+              '../fixtures/omniconf/adapters/yaml/config/settings.yml', __FILE__
             )
           },
           :database => {
             :type => :active_record,
             :model_name => :ConfigValue,
             :environment => 'test',
-            :config_file => File.join(File.dirname(__FILE__),
-              'fixtures/omniconf/adapters/active_record/config/database.yml'
+            :config_file => File.expand_path(
+              '../fixtures/omniconf/adapters/active_record/config/database.yml',
+              __FILE__
             )
           }
         }
       end
-    end
 
-    def insert_db_fixtures
-      @database = Omniconf.settings.sources[:database][:adapter]
-      @database.setup
-
-      require File.join(File.dirname(__FILE__),
-        'fixtures/omniconf/adapters/active_record/db/schema.rb'
+      # insert some fixtures into DB
+      load File.expand_path(
+        '../fixtures/omniconf/adapters/active_record/db/schema.rb', __FILE__
       )
+
+      Omniconf.reload_configuration!
     end
 
-    it "loads and merges all configurations" do
-      setup
-      insert_db_fixtures
+    describe "#configuration" do
+      let(:config) { Omniconf.configuration }
+
+      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'
+          config.nested.yaml_key.should == 'nested_yaml_value'
+          config.ar_key.should == 'ar_value'
+          config.nested.ar_key.should == 'nested_ar_value'
+        end
+      end
+
+      describe "setting values" do
+        it "updates a value on its original source" do
+          db_adapter = Omniconf.settings.sources[:database][:adapter]
+          db_adapter.should_receive(:set_value).with(['ar_key'], 'new_ar_value')
+
+          config.ar_key = 'new_ar_value'
+
+          config.ar_key.should == 'new_ar_value'
+          Omniconf.sources[:database].ar_key.should == 'new_ar_value'
+        end
+
+        it "creates a new value on the given source" do
+          config.new_value.should be_nil
+          db_adapter = Omniconf.settings.sources[:database][:adapter]
+          db_adapter.should_receive(:set_value).with(['new_value'], 'new_ar_value')
 
-      Omniconf.load_configuration!
+          Omniconf.sources[:database].new_value = 'new_ar_value'
 
-      Omniconf.configuration.api.password.should == 'test_password'
-      Omniconf.configuration.foo.should == 'bar'
+          Omniconf.sources[:database].new_value.should == 'new_ar_value'
+          config.new_value.should == 'new_ar_value'
+        end
+
+        it "fails to create a new value with no sources" do
+          # How the hell would I know where to store it?!
+          config.no.should be_nil
+          expect {
+            config.no = 'whatever'
+          }.to raise_error Omniconf::UnknownConfigurationValue
+        end
+
+        it "fails to create a new value with no parents" do
+          db_adapter = Omniconf.settings.sources[:database][:adapter]
+          Omniconf.sources[:database].no.should be_nil
+
+          expect {
+            Omniconf.sources[:database].no.no = 'new_ar_value'
+          }.to raise_error Omniconf::UnknownConfigurationValue
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,7 @@
-require 'lib/omniconf/adapters/base'
-require 'spec/support/mock'
+require 'omniconf'
+
+Omniconf.setup do |config|
+  config.load_configuration = false
+  config.logger_level = Logger::ERROR # don't pollute specs output
+end
 

metadata

@@ -1,167 +1,128 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: omniconf
-version: !ruby/object:Gem::Version 
-  hash: 961915968
-  prerelease: 6
-  segments: 
-  - 0
-  - 0
-  - 1
-  - pre
-  version: 0.0.1.pre
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
 platform: ruby
-authors: 
-- "C\xC3\xA9dric Felizard"
+authors:
+- Cedric Felizard
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-01 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: recursive-open-struct
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+date: 2012-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &2156203800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2156203800
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156201760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2156201760
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2156200400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2156200400
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2156199340 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
   type: :development
-  version_requirements: *id005
-description: Merge configurations from multiple backends for easy use in a Rails application.
-email: 
+  prerelease: false
+  version_requirements: *2156199340
+description: Merge configurations from multiple back-ends for easy use in a complex
+  application.
+email:
 - cedric@picklive.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/omniconf.rb
 - lib/omniconf/adapters/active_record.rb
 - lib/omniconf/adapters/base.rb
+- lib/omniconf/adapters/read_only.rb
 - lib/omniconf/adapters/yaml.rb
+- lib/omniconf/blank_state.rb
+- lib/omniconf/configuration.rb
+- lib/omniconf/errors.rb
+- lib/omniconf/helpers.rb
 - lib/omniconf/settings.rb
 - lib/omniconf/version.rb
 - omniconf.gemspec
-- spec/data.sqlite3
 - spec/fixtures/omniconf/adapters/active_record/config/database.yml
 - spec/fixtures/omniconf/adapters/active_record/db/schema.rb
 - spec/fixtures/omniconf/adapters/yaml/config/settings.yml
 - spec/omniconf/adapters/active_record_spec.rb
 - spec/omniconf/adapters/yaml_spec.rb
+- spec/omniconf/configuration_spec.rb
+- spec/omniconf/helpers_spec.rb
 - spec/omniconf_spec.rb
 - spec/spec_helper.rb
-- spec/support/mock.rb
 homepage: https://github.com/Picklive/omniconf
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      hash: 25
-      segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: omniconf
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Merge multiple configuration sources into one.
-test_files: 
-- spec/data.sqlite3
+test_files:
 - spec/fixtures/omniconf/adapters/active_record/config/database.yml
 - spec/fixtures/omniconf/adapters/active_record/db/schema.rb
 - spec/fixtures/omniconf/adapters/yaml/config/settings.yml
 - spec/omniconf/adapters/active_record_spec.rb
 - spec/omniconf/adapters/yaml_spec.rb
+- spec/omniconf/configuration_spec.rb
+- spec/omniconf/helpers_spec.rb
 - spec/omniconf_spec.rb
 - spec/spec_helper.rb
-- spec/support/mock.rb