omniconf 0.0.1.pre

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+*.swp
+*.sqlite3
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+--drb

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create ree@omniconf

data/Gemfile

@@ -0,0 +1,8 @@
+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/README.md

@@ -0,0 +1,70 @@
+*THIS STUFF IS STILL ALPHA!*
+
+# 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
+
+# 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
+
+`:type` is the only required parameter.
+Other parameters default to standard values for Rails.
+
+### Yaml
+
+Nothing to configure apart from a YAML file.
+
+_Note: read-only._
+
+### ActiveRecord
+
+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
+    end
+
+### Redis
+
+Add `gem 'redis'` in your `Gemfile`.
+
+Not yet implemented.
+
+# Testing
+
+`rake`
+
+Tested on _ree-1.8.7_ and _ruby-1.9.3_.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+

data/lib/omniconf/adapters/active_record.rb

@@ -0,0 +1,72 @@
+require 'active_record'
+
+module Omniconf
+  module Adapter
+    class ActiveRecord < Base
+      attr_reader :model
+
+      def initialize params
+        defaults = {
+          :model_name => :ConfigValue,
+          :environment => Rails.env,
+          :config_file => File.join(Rails.root, 'config/database.yml')
+        }
+        @params = defaults.merge params
+      end
+
+      def load_configuration!
+        setup
+
+        @configuration_hash = {}
+        @model.all.map do |record|
+          @configuration_hash[record.key] = record.value
+        end
+        merge_configuration! @configuration_hash
+      end
+
+      def setup
+        unless Object.const_defined? @params[:model_name]
+          unless ::ActiveRecord::Base.connected?
+            ::ActiveRecord::Base.configurations = YAML::load(IO.read(@params[:config_file]))
+            ::ActiveRecord::Base.establish_connection(@params[:environment])
+          end
+
+          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
+        end
+
+        @model ||= @params[:model_name].to_s.constantize
+      end
+    end
+  end
+end
+

data/lib/omniconf/adapters/base.rb

@@ -0,0 +1,28 @@
+require 'recursive_open_struct'
+
+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
+    end
+  end
+end
+

data/lib/omniconf/adapters/yaml.rb

@@ -0,0 +1,22 @@
+module Omniconf
+  module Adapter
+    class Yaml < Base
+
+      def initialize params
+        defaults = {
+          :environment => Rails.env,
+          :file => File.join(Rails.root, 'config/settings.yml')
+        }
+        @params = defaults.merge params
+      end
+
+      def load_configuration!
+        yaml = ::YAML.load_file(@params[:file])
+        @configuration_hash = yaml[@params[:environment]]
+        merge_configuration! @configuration_hash
+      end
+
+    end
+  end
+end
+

data/lib/omniconf/settings.rb

@@ -0,0 +1,7 @@
+module Omniconf
+  class Settings
+    attr_accessor :load_configuration
+    attr_accessor :sources
+    attr_accessor :logger_level
+  end
+end

data/lib/omniconf/version.rb

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

data/lib/omniconf.rb

@@ -0,0 +1,60 @@
+require 'logger'
+require "omniconf/version"
+require "omniconf/settings"
+
+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
+
+    def configuration_hash
+      @configuration_hash ||= {}
+    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?
+      end
+      @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
+    end
+
+    def load_configuration!
+      @settings.sources.each do |source_id, params|
+        params[:adapter].load_configuration!
+        Omniconf.logger.info "Loaded configuration from #{source_id} source"
+      end
+    end
+
+    private
+
+    def register_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
+        raise unless params[:adapter].nil?
+        params[:adapter] = Omniconf::Adapter.class_eval do
+          const_get(adapter_class).new(params)
+        end
+        Omniconf.logger.info "Registered #{adapter_class}::#{source_id} source"
+      end
+    end
+
+  end
+end
+

data/omniconf.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniconf/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniconf"
+  s.version     = Omniconf::VERSION
+  s.authors     = ["Cédric 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.rubyforge_project = "omniconf"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  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"
+end

data/spec/fixtures/omniconf/adapters/active_record/config/database.yml

@@ -0,0 +1,5 @@
+test:
+  adapter: sqlite3
+  database: data.sqlite3
+  pool: 5
+  timeout: 5000

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

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table :config_values, :force => true do |t|
+    t.string :key
+    t.string :value
+  end
+end
+
+ConfigValue.create!({:key => 'foo', :value => 'bar'})
+ConfigValue.create!({:key => 'foo2', :value => 'bar2'})
+

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

@@ -0,0 +1,8 @@
+development:
+  api:
+    username: user
+    password: pass
+test:
+  api:
+    username: test_user
+    password: test_password

data/spec/omniconf/adapters/active_record_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'omniconf/adapters/active_record'
+
+describe Omniconf::Adapter::ActiveRecord do
+  before do
+    @database = Omniconf::Adapter::ActiveRecord.new({
+      :model_name => :ConfigValue,
+      :environment => 'test',
+      :config_file => File.join(File.dirname(__FILE__),
+        '../../fixtures/omniconf/adapters/active_record/config/database.yml'
+      )
+    })
+    @database.setup
+
+    require File.join(File.dirname(__FILE__),
+      '../../fixtures/omniconf/adapters/active_record/db/schema.rb'
+    )
+
+    @database.load_configuration!
+  end
+
+  describe "#[]" do
+    it "returns configuration values from database" do
+      @database.configuration.foo.should == 'bar'
+      @database.configuration.foo2.should == 'bar2'
+    end
+
+    pending "it doesn't cast values to String" # TODO serialize them and keep type
+  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'
+    end
+  end
+end
+

data/spec/omniconf/adapters/yaml_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'omniconf/adapters/yaml'
+
+describe Omniconf::Adapter::Yaml do
+  def load_environment env
+    @yaml = Omniconf::Adapter::Yaml.new({
+      :environment => env,
+      :file => File.join(File.dirname(__FILE__),
+        '../../fixtures/omniconf/adapters/yaml/config/settings.yml'
+      )
+    })
+    @yaml.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
+
+  it "loads the right environment" do
+    load_environment 'development'
+    @yaml.configuration.api.username.should == 'user'
+    @yaml.configuration.api.password.should == 'pass'
+  end
+end
+

data/spec/omniconf_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'omniconf'
+
+describe Omniconf do
+
+  describe "#setup" do
+    it "reads the settings" do
+      Omniconf.setup do |config|
+        config.load_configuration = false
+        config.sources = {
+          :yaml_conf => {:type => :yaml, :file => "settings.yml"}
+        }
+      end
+
+      Omniconf.settings.sources[:yaml_conf][:file].should == "settings.yml"
+    end
+  end
+
+  describe "#load_configuration!" do
+    def setup
+      Omniconf.setup do |config|
+        config.load_configuration = false
+        config.sources = {
+          :yaml => {
+            :type => :yaml,
+            :environment => 'test',
+            :file => File.join(File.dirname(__FILE__),
+              'fixtures/omniconf/adapters/yaml/config/settings.yml'
+            )
+          },
+          :database => {
+            :type => :active_record,
+            :model_name => :ConfigValue,
+            :environment => 'test',
+            :config_file => File.join(File.dirname(__FILE__),
+              'fixtures/omniconf/adapters/active_record/config/database.yml'
+            )
+          }
+        }
+      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'
+      )
+    end
+
+    it "loads and merges all configurations" do
+      setup
+      insert_db_fixtures
+
+      Omniconf.load_configuration!
+
+      Omniconf.configuration.api.password.should == 'test_password'
+      Omniconf.configuration.foo.should == 'bar'
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'lib/omniconf/adapters/base'
+require 'spec/support/mock'
+

data/spec/support/mock.rb

@@ -0,0 +1,15 @@
+# Mock Rails.{env,root} to test defaults settings
+unless defined? Rails
+  class Rails
+    class << self
+      def env
+        'test'
+      end
+
+      def root
+        File.join(File.dirname(__FILE__), '..')
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,167 @@
+--- !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
+platform: ruby
+authors: 
+- "C\xC3\xA9dric 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 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Merge configurations from multiple backends for easy use in a Rails application.
+email: 
+- cedric@picklive.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniconf.rb
+- lib/omniconf/adapters/active_record.rb
+- lib/omniconf/adapters/base.rb
+- lib/omniconf/adapters/yaml.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_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock.rb
+homepage: https://github.com/Picklive/omniconf
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: omniconf
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Merge multiple configuration sources into one.
+test_files: 
+- 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_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock.rb