econfig 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bundler_stubs

data/.rspec

@@ -0,0 +1 @@
+-r spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in econfig.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jonas Nicklas, Elabs AB
+
+MIT License
+
+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

@@ -0,0 +1,132 @@
+# Econfig
+
+Econfig is a gem which allows you to easily configure your Rails applications
+in a multitude of ways.
+
+## Installation
+
+Add this to your gemfile:
+
+``` ruby
+gem "econfig", :require => "econfig/rails"
+```
+
+## Accessing config options
+
+Econfig extends the Rails configuration, you can use it like this:
+
+``` ruby
+MyApp::Application.config.app.aws_access_key
+```
+
+Where `MyApp` is the name of your application and `aws_access_key` is whatever
+property you want to access. We recommend you add the shortcut module so you
+can access config options directly:
+
+``` ruby
+module MyApp
+  extend Econfig::Shortcut
+
+  …
+end
+```
+
+In `config/application.rb`. This will give you:
+
+``` ruby
+MyApp.aws_access_key_id
+```
+
+which is obviously way more convenient. The rest of this README is going to
+assume that you added this shortcut.
+
+## Forcing an option to exist
+
+Sometimes you want the application to crash early when a given config option is
+not set. Just add a bang (!) after the option name, and an error will be thrown
+if it is not set to a value which is present.
+
+``` ruby
+MyApp.aws_access_key_id!
+```
+
+## Configuring options.
+
+You can specify configuration through:
+
+1. ENV variables
+2. Redis
+3. Relational database
+4. YAML files
+
+This allows you to set up econfig on most kinds of hosting solutions
+(EngineYard, Heroku, etc) without any additional effort, and to switch between
+them easily. The options are listed in descending order of preference.
+
+### ENV variables
+
+Just set an environment variable whose name is the name of the option being accessed uppercased.
+
+For example:
+
+``` sh
+AWS_ACCESS_KEY_ID=xyz rails server
+```
+
+This is especially convenient for Heroku.
+
+### Relational database
+
+This needs to be explicitly enabled. In `config/application.rb` add this line:
+
+``` ruby
+Econfig.use_database
+```
+
+You will also need to create a migration to create the necessary database tables:
+
+``` sh
+rails generate econfig:migration
+rake db:migrate
+```
+
+You can now set options by assigning them:
+
+``` ruby
+MyApp.aws_access_key_id = "xyz"
+```
+
+You may not use both Redis and relational database storage at the same time.
+
+### Redis
+
+This needs to be explicitly enabled. In `config/application.rb` add this line:
+
+``` ruby
+Econfig.use_redis Redis.new(:host => "myredis.com")
+```
+
+You can now set options by assigning them:
+
+``` ruby
+MyApp.aws_access_key_id = "xyz"
+```
+
+You may not use both Redis and relational database storage at the same time.
+
+### YAML
+
+Add a yaml file to `config/app.yml`. This should have a similar layout to `config/database.yml`:
+
+``` yaml
+development:
+  aws_access_key_id: "xyz"
+  aws_secret_access_key: "xyz"
+production:
+  aws_access_key_id: "xyz"
+  aws_secret_access_key: "xyz"
+```
+
+## License
+
+MIT, see separate LICENSE.txt file

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/econfig.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'econfig/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "econfig"
+  gem.version       = Econfig::VERSION
+  gem.authors       = ["Jonas Nicklas", "Elabs AB"]
+  gem.email         = ["jonas.nicklas@gmail.com", "dev@elabs.se"]
+  gem.description   = %q{Flexible configuration for Ruby/Rails applications with a variety of backends}
+  gem.summary       = %q{Congifure Ruby apps}
+  gem.homepage      = "https://github.com/elabs/econfig"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "activerecord"
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "redis"
+end

data/lib/econfig.rb

@@ -0,0 +1,28 @@
+require "econfig/version"
+require "econfig/memory"
+require "econfig/yaml"
+require "econfig/env"
+require "econfig/configuration"
+require "econfig/shortcut"
+
+module Econfig
+  class NotFound < StandardError; end
+
+  class << self
+    attr_accessor :root, :env, :instance
+
+    def use_database
+      require "econfig/active_record"
+      Econfig.instance.backends << Econfig::ActiveRecord.new
+    end
+
+    def use_redis(redis)
+      require "econfig/redis"
+      Econfig.instance.backends << Econfig::Redis.new(redis)
+    end
+  end
+end
+
+Econfig.instance = Econfig::Configuration.new
+Econfig.instance.backends << Econfig::ENV.new
+Econfig.instance.backends << Econfig::YAML.new

data/lib/econfig/active_record.rb

@@ -0,0 +1,25 @@
+module Econfig
+  class ActiveRecord
+    class Option < ::ActiveRecord::Base
+      attr_accessible :key, :value
+      self.table_name = "econfig_options"
+      validates_uniqueness_of :key
+      validates_presence_of :key
+    end
+
+    def get(key)
+      Option.find_by_key(key).try(:value)
+    end
+
+    def set(key, value)
+      option = Option.where(:key => key).first_or_initialize
+      option.update_attributes!(:value => value)
+    end
+
+  private
+
+    def options
+      @options ||= {}
+    end
+  end
+end

data/lib/econfig/configuration.rb

@@ -0,0 +1,35 @@
+module Econfig
+  class Configuration
+    def backends
+      @backends ||= []
+    end
+
+    def get(key)
+      backend = backends.find { |backend| backend.get(key) }
+      backend.get(key) if backend
+    end
+
+    def get!(key)
+      get(key) or raise Econfig::NotFound, "configuration key '#{key}' is not set"
+    end
+
+    def set(key, value)
+      backend = backends.find { |backend| backend.respond_to?(:set) }
+      backend.set(key, value) if backend
+    end
+
+    def method_missing(name, *args)
+      if name.to_s.end_with?("=")
+        set(name.to_s.sub(/=$/, ""), args.first)
+      elsif name.to_s.end_with?("!")
+        get!(name.to_s.sub(/!$/, ""))
+      else
+        get(name.to_s)
+      end
+    end
+
+    def respond_to?(*)
+      true
+    end
+  end
+end

data/lib/econfig/env.rb

@@ -0,0 +1,7 @@
+module Econfig
+  class ENV
+    def get(key)
+      ::ENV[key.upcase]
+    end
+  end
+end

data/lib/econfig/memory.rb

@@ -0,0 +1,17 @@
+module Econfig
+  class Memory
+    def get(key)
+      options[key]
+    end
+
+    def set(key, value)
+      options[key] = value
+    end
+
+  private
+
+    def options
+      @options ||= {}
+    end
+  end
+end

data/lib/econfig/rails.rb

@@ -0,0 +1,12 @@
+require "rails"
+require "econfig"
+
+module Econfig
+  class Railtie < Rails::Railtie
+    initializer "econfig.setup" do
+      Econfig.root = Rails.root
+      Econfig.env = Rails.env
+      Rails.application.config.app = Econfig.instance
+    end
+  end
+end

data/lib/econfig/redis.rb

@@ -0,0 +1,15 @@
+module Econfig
+  class Redis
+    def initialize(redis)
+      @redis = redis
+    end
+
+    def get(key)
+      @redis.get("econfig_#{key}")
+    end
+
+    def set(key, value)
+      @redis.set("econfig_#{key}", value)
+    end
+  end
+end

data/lib/econfig/shortcut.rb

@@ -0,0 +1,11 @@
+module Econfig
+  module Shortcut
+    def method_missing(name, *args)
+      Econfig.instance.send(name, *args)
+    end
+
+    def respond_to?(*)
+      true
+    end
+  end
+end

data/lib/econfig/version.rb

@@ -0,0 +1,3 @@
+module Econfig
+  VERSION = "0.1.0"
+end

data/lib/econfig/yaml.rb

@@ -0,0 +1,21 @@
+module Econfig
+  class YAML
+    def initialize(path="config/app.yml")
+      @path = path
+    end
+
+    def get(key)
+      options[key] if options
+    end
+
+  private
+
+    def path
+      File.expand_path(@path, Econfig.root)
+    end
+
+    def options
+      @options ||= ::YAML.load_file(path)[Econfig.env] if File.exist?(path)
+    end
+  end
+end

data/lib/generators/econfig/migration/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate a migration for config options in ActiveRecord
+
+Example:
+    rails generate econfig:migration
+
+    This will create:
+        db/migrate/20130107205126_create_econfig.rb

data/lib/generators/econfig/migration/migration_generator.rb

@@ -0,0 +1,16 @@
+class Econfig::MigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.new.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template "migration.rb", "db/migrate/create_econfig.rb"
+  end
+end

data/lib/generators/econfig/migration/templates/migration.rb

@@ -0,0 +1,13 @@
+class CreateEconfig < ActiveRecord::Migration
+  def up
+    create_table :econfig_options do |t|
+      t.string :key, :null => false
+      t.string :value
+    end
+    add_index :econfig_options, :key, :unique => true
+  end
+
+  def down
+    drop_table :econfig_options
+  end
+end

data/spec/active_record_spec.rb

@@ -0,0 +1,42 @@
+require "active_record"
+
+ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+
+ActiveRecord::Base.connection.create_table :econfig_options do |t|
+  t.string :key, :null => false
+  t.string :value
+end
+
+require "econfig/active_record"
+
+describe Econfig::ActiveRecord do
+  let(:backend) { Econfig::ActiveRecord.new }
+  around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+  describe "#get" do
+    it "fetches a previously set option" do
+      backend.set("foo", "bar")
+      backend.get("foo").should == "bar"
+    end
+
+    it "fetches a previously persisted option" do
+      Econfig::ActiveRecord::Option.create!(:key => "foo", :value => "bar")
+      backend.get("foo").should == "bar"
+    end
+
+    it "returns nil if option is not set" do
+      backend.get("foo").should be_nil
+    end
+  end
+
+  describe "#set" do
+    it "persists keys to database" do
+      backend.set("foo", "bar")
+      Econfig::ActiveRecord::Option.find_by_key!("foo").value.should == "bar"
+    end
+  end
+end

data/spec/config/app.yml

@@ -0,0 +1,2 @@
+test:
+  quox: baz

data/spec/configuration_spec.rb

@@ -0,0 +1,78 @@
+describe Econfig::Configuration do
+  let(:backend) { stub }
+  let(:other_backend) { stub }
+  let(:config) { Econfig::Configuration.new }
+
+  before { config.backends.push(backend, other_backend) }
+
+  describe "#get" do
+    it "returns response from first backend" do
+      backend.stub(:get).with("foobar").and_return("elephant")
+      config.get("foobar").should == "elephant"
+    end
+
+    it "tries multiple backends until it finds a response" do
+      backend.stub(:get).with("foobar").and_return(nil)
+      other_backend.stub(:get).with("foobar").and_return("elephant")
+      config.get("foobar").should == "elephant"
+    end
+
+    it "returns nil if the key can't be found in any backend" do
+      backend.stub(:get).with("foobar").and_return(nil)
+      other_backend.stub(:get).with("foobar").and_return(nil)
+      config.get("foobar").should == nil
+    end
+  end
+
+  describe "#get!" do
+    it "returns response from first backend" do
+      backend.stub(:get).with("foobar").and_return("elephant")
+      config.get!("foobar").should == "elephant"
+    end
+
+    it "tries multiple backends until it finds a response" do
+      backend.stub(:get).with("foobar").and_return(nil)
+      other_backend.stub(:get).with("foobar").and_return("elephant")
+      config.get!("foobar").should == "elephant"
+    end
+
+    it "raises error if the key can't be found in any backend" do
+      backend.stub(:get).with("foobar").and_return(nil)
+      other_backend.stub(:get).with("foobar").and_return(nil)
+      expect { config.get!("foobar") }.to raise_error(Econfig::NotFound)
+    end
+  end
+
+  describe "#set" do
+    it "sets response on first backend" do
+      backend.should_receive(:set).with("foobar", "elephant")
+      config.set("foobar", "elephant")
+    end
+
+    it "skips backends which don't have a set method" do
+      other_backend.should_receive(:set).with("foobar", "elephant")
+      config.set("foobar", "elephant")
+    end
+
+    it "does nothing when no backend has a setter method" do
+      config.set("foobar", "elephant")
+    end
+  end
+
+  describe "#method_missing" do
+    it "calls get for normal methods" do
+      config.should_receive(:get).with("foobar").and_return("elephant")
+      config.foobar.should == "elephant"
+    end
+
+    it "calls get! for bang methods" do
+      config.should_receive(:get!).with("foobar").and_return("elephant")
+      config.foobar!.should == "elephant"
+    end
+
+    it "calls set for assignment methods" do
+      config.should_receive(:set).with("foobar", "elephant")
+      config.foobar = "elephant"
+    end
+  end
+end

data/spec/env_spec.rb

@@ -0,0 +1,9 @@
+describe Econfig::ENV do
+  let(:backend) { Econfig::ENV.new }
+  describe "#get" do
+    it "fetches option from environment variables" do
+      ENV["FOO_BAR"] = "monkey"
+      backend.get("foo_bar").should == "monkey"
+    end
+  end
+end

data/spec/memory_spec.rb

@@ -0,0 +1,9 @@
+describe Econfig::Memory do
+  let(:backend) { Econfig::Memory.new }
+  describe "#get" do
+    it "fetches a previously set option" do
+      backend.set("foo", "bar")
+      backend.get("foo").should == "bar"
+    end
+  end
+end

data/spec/redis_spec.rb

@@ -0,0 +1,32 @@
+require "redis"
+require "econfig/redis"
+
+describe Econfig::Redis do
+  let(:redis) { Redis.new(:databse => "econfig_test") }
+  let(:backend) { Econfig::Redis.new(redis) }
+  after do |example|
+    redis.flushdb
+  end
+  describe "#get" do
+    it "fetches a previously set option" do
+      backend.set("foo", "bar")
+      backend.get("foo").should == "bar"
+    end
+
+    it "fetches a previously persisted option" do
+      redis.set("econfig_foo", "bar")
+      backend.get("foo").should == "bar"
+    end
+
+    it "returns nil if option is not set" do
+      backend.get("foo").should be_nil
+    end
+  end
+
+  describe "#set" do
+    it "persists keys to database" do
+      backend.set("foo", "bar")
+      redis.get("econfig_foo").should == "bar"
+    end
+  end
+end

data/spec/shortcut_spec.rb

@@ -0,0 +1,16 @@
+describe Econfig::Shortcut do
+  let(:mod) { Module.new }
+  before { mod.extend Econfig::Shortcut }
+
+  describe "#method_missing" do
+    it "proxies getters to the Econfig instance" do
+      Econfig.instance.should_receive(:get).with("foobar").and_return("elephant")
+      mod.foobar.should == "elephant"
+    end
+
+    it "proxies bang methods to the Econfig instance" do
+      Econfig.instance.should_receive(:get!).with("foobar").and_return("elephant")
+      mod.foobar!.should == "elephant"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "econfig"
+
+Econfig.root = File.dirname(__FILE__)
+Econfig.env = "test"

data/spec/yaml_spec.rb

@@ -0,0 +1,17 @@
+describe Econfig::YAML do
+  let(:backend) { Econfig::YAML.new }
+  describe "#get" do
+    it "fetches option from yaml config file" do
+      backend.get("quox").should == "baz"
+    end
+
+    it "returns nil when the option does not exist" do
+      backend.get("does_not_exist").should be_nil
+    end
+
+    it "returns nil when there is no config file" do
+      backend = Econfig::YAML.new("/does/not/exist")
+      backend.get("does_not_exist").should be_nil
+    end
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: econfig
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jonas Nicklas
+- Elabs AB
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Flexible configuration for Ruby/Rails applications with a variety of
+  backends
+email:
+- jonas.nicklas@gmail.com
+- dev@elabs.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- econfig.gemspec
+- lib/econfig.rb
+- lib/econfig/active_record.rb
+- lib/econfig/configuration.rb
+- lib/econfig/env.rb
+- lib/econfig/memory.rb
+- lib/econfig/rails.rb
+- lib/econfig/redis.rb
+- lib/econfig/shortcut.rb
+- lib/econfig/version.rb
+- lib/econfig/yaml.rb
+- lib/generators/econfig/migration/USAGE
+- lib/generators/econfig/migration/migration_generator.rb
+- lib/generators/econfig/migration/templates/migration.rb
+- spec/active_record_spec.rb
+- spec/config/app.yml
+- spec/configuration_spec.rb
+- spec/env_spec.rb
+- spec/memory_spec.rb
+- spec/redis_spec.rb
+- spec/shortcut_spec.rb
+- spec/spec_helper.rb
+- spec/yaml_spec.rb
+homepage: https://github.com/elabs/econfig
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Congifure Ruby apps
+test_files:
+- spec/active_record_spec.rb
+- spec/config/app.yml
+- spec/configuration_spec.rb
+- spec/env_spec.rb
+- spec/memory_spec.rb
+- spec/redis_spec.rb
+- spec/shortcut_spec.rb
+- spec/spec_helper.rb
+- spec/yaml_spec.rb
+has_rdoc: