omniconf 0.0.1 → 0.0.2

data/.travis.yml

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

data/README.md

@@ -4,18 +4,21 @@ A _RubyGem_ that provides an application-agnostic configuration merger.
 
 # Setup
 
-Configure and load desired backends by creating a new initializer `config/initializers/omniconf.rb`:
+Configure and load desired back-ends by creating a new initializer:
+
+- With a Rails application, just run `rails g omniconf:install`.
+- Without a Rails application, you need to create a file along these lines (see below):
 
 ```ruby
 Omniconf.setup do |config|
   config.sources = {
-    :yaml_config => {
+    :yaml => {
       :type => :yaml,
       :file => "config/settings.yml"
     },
-    :database_config => {
+    :database => {
       :type => :active_record,
-      :model_name => :ConfigValue
+      :model => "ConfigValue"
     }
   }
 end
@@ -44,13 +47,13 @@ $ rails c
 ```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.some_config_from_yaml = 456 # raises an exception because the value comes from YAML
+ => Omniconf::ReadOnlyConfigurationValue: cannot set 'some_config_from_yaml' because it belongs to a read-only back-end source (id: :yaml, 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
+> Omniconf.sources[:database].brand_new_value = "whatever" # adds a new record in ConfigValue model
  => "whatever"
 ```
 
@@ -61,15 +64,21 @@ Other parameters default to standard values for Rails.
 
 ### Yaml
 
-Nothing to configure apart from having a YAML file.
-
 _Note: read-only._
 
+#### Parameters
+
+- `:type => :yaml`
+- `:file`: path to the YAML file to load (default: `config/settings.yml`)
+- `:environment`: the root node to load from your YAML file (typically `development`, `production`, etc.)
+
 ### ActiveRecord
 
-Add `gem 'activerecord'` in your `Gemfile`.
+#### Setup
 
-Create a new migration to add the config table: _(FIXME: add a rake task for this)_
+- Add `gem 'activerecord'` in your `Gemfile`.
+- With a Rails application, `rails g omniconf:install` has already created a migration for you.
+- Without a Rails application, create a new migration to add the config table:
 
 ```ruby
 class CreateConfigValues < ActiveRecord::Migration
@@ -83,19 +92,20 @@ class CreateConfigValues < ActiveRecord::Migration
 end
 ```
 
-### Redis
-
-Add `gem 'redis'` in your `Gemfile`.
+#### Parameters
 
-Not yet implemented.
+- `:type => :active_record`
+- `:model`: name of the ActiveRecord model (default: `ConfigValue`)
+- `:config_file`: path to the database settings (default: `config/database.yml`)
+- `:environment`: environment to load (typically `development`, `production`, etc.)
 
 ## Reserved words
 
 /!\ You should not use these names as configuration keys:
 
-- `to_hash`: it's a helper which returns the configuration as a hash
+- `to_hash`: 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)`)
+- `get_or_default`: 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
 
@@ -103,7 +113,7 @@ Not yet implemented.
 
 `rake`
 
-Tested against _ree_, _ruby-1.9.3_ and _ruby-head_.
+Tested against _ree_, _ruby-1.9.2_ and _ruby-1.9.3_ thanks to [Travis CI](http://travis-ci.org/#!/Picklive/omniconf "It rocks!").
 
 # License
 

data/lib/omniconf/adapters/active_record.rb

@@ -6,7 +6,7 @@ module Omniconf
       def initialize id, params
         @source_id = id
         defaults = {
-          :model_name => :ConfigValue
+          :model => 'ConfigValue'
         }
         defaults.merge!({
           :environment => Rails.env,
@@ -24,7 +24,7 @@ module Omniconf
         begin
           records = @model.all
         rescue ::ActiveRecord::StatementInvalid => e
-          Omniconf.logger.warn "Could not load #{@params[:model_name]} model, ignoring this configuration source."
+          Omniconf.logger.warn "Could not load #{@params[:model]} model, ignoring this configuration source."
           return
         end
 
@@ -54,7 +54,7 @@ module Omniconf
 
       def setup
         # define the ActiveRecord model if missing
-        unless Object.const_defined? @params[:model_name]
+        unless Object.const_defined? @params[:model]
           unless ::ActiveRecord::Base.connected?
             ::ActiveRecord::Base.configurations = YAML::load(IO.read(@params[:config_file]))
             ::ActiveRecord::Base.establish_connection(@params[:environment])
@@ -62,12 +62,13 @@ module Omniconf
 
           klass = Class.new ::ActiveRecord::Base do
             validates_uniqueness_of :key
+            serialize :value
           end
 
-          Object.const_set @params[:model_name], klass
+          Object.const_set @params[:model], klass
         end
 
-        @model ||= @params[:model_name].to_s.constantize
+        @model ||= @params[:model].constantize
       end
     end
   end

data/lib/omniconf/adapters/base.rb

@@ -5,6 +5,7 @@ module Omniconf
     class Base
       attr_reader :source_id
       attr_reader :configuration
+      def reload_configuration!; load_configuration! end
     end
   end
 end

data/lib/omniconf/adapters/yaml.rb

@@ -1,3 +1,4 @@
+require 'yaml'
 require 'omniconf/adapters/read_only'
 
 module Omniconf

data/lib/omniconf/configuration.rb

@@ -67,9 +67,14 @@ module Omniconf
             # 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"
+              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

data/lib/omniconf/version.rb

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

data/lib/omniconf.rb

@@ -22,11 +22,10 @@ module Omniconf
     end
 
     def logger
-      unless @logger
-        @logger = Logger.new(STDOUT)
-        @logger.level = @settings.logger_level if @settings
-        @logger.level = Logger::INFO if @logger.level.nil?
-      end
+      return @logger ||= Rails.logger if defined? Rails
+
+      @logger ||= Logger.new(STDOUT)
+      @logger.level = @settings.logger_level || Logger::INFO
       @logger
     end
 

data/lib/rails/generators/omniconf/install/install_generator.rb

@@ -0,0 +1,29 @@
+module Omniconf
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Installs Omniconf and generates the necessary migration"
+
+      include Rails::Generators::Migration
+
+      def self.source_root
+        File.expand_path("../templates", __FILE__)
+      end
+
+      def self.next_migration_number(dirname)
+        Time.now.strftime("%Y%m%d%H%M%S")
+      end
+
+      def copy_initializer
+        template 'omniconf.rb.erb', 'config/initializers/omniconf.rb'
+      end
+
+      def create_migrations
+        Dir["#{self.class.source_root}/migrations/*.rb"].sort.each do |filepath|
+          name = File.basename(filepath)
+          migration_template "migrations/#{name}", "db/migrate/#{name.gsub(/^\d+_/,'')}"
+          sleep 1 # ensure next migration gets a new number
+        end
+      end
+    end
+  end
+end

data/lib/rails/generators/omniconf/install/templates/migrations/1_create_config_values.rb

@@ -0,0 +1,9 @@
+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

data/lib/rails/generators/omniconf/install/templates/omniconf.rb.erb

@@ -0,0 +1,13 @@
+Omniconf.setup do |config|
+  config.sources = {
+    :yaml => {
+      :type => :yaml,
+      :file => "config/settings.yml"
+    },
+    :database => {
+      :type => :active_record,
+      :model => "ConfigValue"
+    }
+  }
+end
+

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

@@ -3,5 +3,8 @@ test:
   nested:
     yaml_key: nested_yaml_value
     overridden: by_yaml
+  some_integer: 1337
+  some_float: 3.14
+  some_array: [1, 2, 3]
 development:
   yaml_key: yaml_value_dev

data/spec/omniconf/adapters/active_record_spec.rb

@@ -4,7 +4,7 @@ require 'omniconf/adapters/active_record'
 describe Omniconf::Adapter::ActiveRecord do
   def load_configuration
     @adapter = Omniconf::Adapter::ActiveRecord.new(:active_record, {
-      :model_name => :ConfigValue,
+      :model => 'ConfigValue',
       :environment => 'test',
       :config_file => File.expand_path(
         '../../../fixtures/omniconf/adapters/active_record/config/database.yml',
@@ -21,54 +21,67 @@ describe Omniconf::Adapter::ActiveRecord do
   end
 
   describe "#configuration" do
+    def config
+      @adapter.configuration
+    end
+
     before do
       Omniconf.stub(:merge_configuration!)
       load_configuration
     end
 
-    let(:configuration) { @adapter.configuration }
-
     describe "getting values" do
       it "returns a value" do
-        configuration.ar_key.should == 'ar_value'
+        config.ar_key.should == 'ar_value'
       end
 
       it "returns a nested value" do
-        configuration.nested.ar_key.should == 'nested_ar_value'
+        config.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'
+      it "updates config values into database" do
+        config.ar_key.should == 'ar_value'
+        config.ar_key = 'new_ar_value'
+        config.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'
+      it "creates config values into database" do
+        config.new_ar_key.should be_nil
+        config.new_ar_key = 'new_ar_value'
+        config.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
+        config.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'
+        config.get_or_default('newValue', 'a').should == 'a'
+        config.get_or_default('newValue', 'b').should == 'a'
       end
 
       it "creates a new default nested value" do
-        configuration.nested.newValue.should be_nil
+        config.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'
+        config.nested.get_or_default('newValue', 'a').should == 'a'
+        config.nested.get_or_default('newValue', 'b').should == 'a'
       end
     end
+
+    it "keeps value types" do
+      config.some_integer.should be_nil
+      config.some_float.should be_nil
+      config.some_array.should be_nil
+      config.some_integer = 1337
+      config.some_float = 3.14
+      config.some_array = [1, 2, 3]
+      @adapter.reload_configuration!
+      config.some_integer.should == 1337
+      config.some_float.should == 3.14
+      config.some_array.should == [1, 2, 3]
+    end
   end
 end
 

data/spec/omniconf/adapters/yaml_spec.rb

@@ -12,75 +12,84 @@ describe Omniconf::Adapter::Yaml do
     @adapter.load_configuration!
   end
 
+
   describe "#configuration" do
+    def config
+      @adapter.configuration
+    end
+
     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'
+        config.yaml_key.should == 'yaml_value'
       end
 
       it "returns a nested value" do
-        configuration.nested.yaml_key.should == 'nested_yaml_value'
+        config.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
+        config.yaml_key.should_not be_nil
         expect {
-          configuration.yaml_key = 'whatever'
+          config.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
+        config.nested.yaml_key.should_not be_nil
         expect {
-          configuration.nested.yaml_key = 'whatever'
+          config.nested.yaml_key = 'whatever'
         }.to raise_error Omniconf::ReadOnlyConfigurationValue
       end
 
       it "fails to create a value" do
-        configuration.new_yaml_key.should be_nil
+        config.new_yaml_key.should be_nil
         expect {
-          configuration.new_yaml_key = 'whatever'
+          config.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
+        config.nested.new_yaml_key.should be_nil
         expect {
-          configuration.nested.new_yaml_key = 'whatever'
+          config.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
+        config.newValue.should be_nil
         expect {
-          configuration.get_or_default('newValue', 'a').should == 'a'
+          config.get_or_default('newValue', 'a').should == 'a'
         }.to raise_error Omniconf::ReadOnlyConfigurationValue
-        configuration.newValue.should be_nil
+        config.newValue.should be_nil
       end
 
       it "fails to create a new nested default value" do
-        configuration.nested.newValue.should be_nil
+        config.nested.newValue.should be_nil
         expect {
-          configuration.nested.get_or_default('newValue', 'a').should == 'a'
+          config.nested.get_or_default('newValue', 'a').should == 'a'
         }.to raise_error Omniconf::ReadOnlyConfigurationValue
-        configuration.nested.newValue.should be_nil
+        config.nested.newValue.should be_nil
       end
     end
 
     it "loads the right environment" do
       load_configuration 'development'
-      configuration.yaml_key.should == 'yaml_value_dev'
+      config.yaml_key.should == 'yaml_value_dev'
+    end
+
+    it "keeps value types" do
+      config.some_integer.should == 1337
+      config.some_float.should == 3.14
+      config.some_array.should == [1, 2, 3]
     end
   end
 end

data/spec/omniconf_spec.rb

@@ -30,7 +30,7 @@ describe Omniconf do
           },
           :database => {
             :type => :active_record,
-            :model_name => :ConfigValue,
+            :model => 'ConfigValue',
             :environment => 'test',
             :config_file => File.expand_path(
               '../fixtures/omniconf/adapters/active_record/config/database.yml',
@@ -49,7 +49,9 @@ describe Omniconf do
     end
 
     describe "#configuration" do
-      let(:config) { Omniconf.configuration }
+      def config
+        Omniconf.configuration
+      end
 
       it "returns an instance of Omniconf::Configuration" do
         config.should be_an_instance_of Omniconf::Configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniconf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-08 00:00:00.000000000 Z
+date: 2012-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156203800 !ruby/object:Gem::Requirement
+  requirement: &2152356800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *2156203800
+  version_requirements: *2152356800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156201760 !ruby/object:Gem::Requirement
+  requirement: &2152342400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *2156201760
+  version_requirements: *2152342400
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2156200400 !ruby/object:Gem::Requirement
+  requirement: &2152340720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *2156200400
+  version_requirements: *2152340720
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2156199340 !ruby/object:Gem::Requirement
+  requirement: &2152339860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: '3.2'
   type: :development
   prerelease: false
-  version_requirements: *2156199340
+  version_requirements: *2152339860
 description: Merge configurations from multiple back-ends for easy use in a complex
   application.
 email:
@@ -82,6 +82,9 @@ files:
 - lib/omniconf/helpers.rb
 - lib/omniconf/settings.rb
 - lib/omniconf/version.rb
+- lib/rails/generators/omniconf/install/install_generator.rb
+- lib/rails/generators/omniconf/install/templates/migrations/1_create_config_values.rb
+- lib/rails/generators/omniconf/install/templates/omniconf.rb.erb
 - omniconf.gemspec
 - spec/fixtures/omniconf/adapters/active_record/config/database.yml
 - spec/fixtures/omniconf/adapters/active_record/db/schema.rb
@@ -112,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: omniconf
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Merge multiple configuration sources into one.