easy_config 0.9.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9ca7bdb6f00286ec2c0e94b20f328657abff9e4
-  data.tar.gz: ac58aa314fb98c77a062f460ccc7f2d86108cf00
+  metadata.gz: 20fedbc0060ed810f28d626477c33302a3ad8e15
+  data.tar.gz: 7f6a686def31fb1829a7897c15239a2bdd635185
 SHA512:
-  metadata.gz: d7a4f8ba08123d2a683db72f435d4186c1929111dfafb4f057f5c97604513af2c8e64301a9ac36aad0b9096856361300bb71176c5d09f48a25f14bd68874e7c7
-  data.tar.gz: f5c1f454d1b52d14f4b01ecd4ac1a9b2b28c948d1ac054d2ef375c9b21d43d107f45c9639e1d4cc704e06c2f551b5d8d3fcd5b7d6c286512f16b6865242aa882
+  metadata.gz: e047d96892658d40ab68843acea9206e30aa75eb5628faefac11ea789eb0230ae9fa55696fd3a7ec9f5b50040e50da24217538c8f820a46d7b7822267d10aa37
+  data.tar.gz: 232e16c7e2ddfaa4c72c33ff115cc9345917068e9307ce0469eaa1ca9ce574ba4dfb3a3c70ae04f2466fd1ba71a67c4615ac44619b2c60974257eb278de02c1e

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.0.0 - 2014-10-27
+
+* Add support for env vars (#4).
+* Add easy support to multiple config paths
+
 ## 0.9.3 - 2014-10-26
 
 * Remove methodize dependency.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    easy_config (0.9.2)
+    easy_config (1.0.0)
       erubis
 
 GEM

data/README.md

@@ -1,14 +1,14 @@
 # Easy config
-Rails and Rack applications configuration made easy.
 
+[![Gem Version](https://badge.fury.io/rb/easy_config.svg)](http://badge.fury.io/rb/easy_config)
 [![Build Status](https://secure.travis-ci.org/felipecvo/easy_config.png?branch=master)](http://travis-ci.org/felipecvo/easy\_config)
 [![Code Climate](https://codeclimate.com/github/felipecvo/easy_config/badges/gpa.svg)](https://codeclimate.com/github/felipecvo/easy_config)
 [![Test Coverage](https://codeclimate.com/github/felipecvo/easy_config/badges/coverage.svg)](https://codeclimate.com/github/felipecvo/easy_config)
 [![Dependency Status](https://gemnasium.com/felipecvo/easy_config.svg)](https://gemnasium.com/felipecvo/easy_config)
 
-## Installation
+Rails and Rack applications configuration made easy.
 
-[![Gem Version](https://badge.fury.io/rb/easy_config.svg)](http://badge.fury.io/rb/easy_config)
+## Install
 
 `gem install easy_config`
 
@@ -16,7 +16,51 @@ or in your Gemfile
 
 `gem "easy_config"`
 
-See [Changelog](CHANGELOG.md).
+## Usage
+
+### Rails/Sinatra
+Inside config dir, create a file redis.yml:
+```
+development:
+  host: 127.0.0.1
+  port: 6379
+  password:
+production:
+  host: 172.0.0.1
+  port: 6379
+  password: "alpha"
+```
+
+In your ruby code, you do:
+```ruby
+  Redis.current = Redis.new({
+    host: EasyConfig.redis.host,
+    port: EasyConfig.redis.port,
+    password: EasyConfig.redis.password
+  })
+```
+
+### Custom config paths
+
+You can provide additional custom config paths.
+
+Config file at `vendor/config/sample.yml`:
+```
+development:
+  property: "value"
+```
+Code:
+```
+  EasyConfig.append_config_path Rails.root.join('vendor/config')
+  puts EasyConfig.sample.property
+```
+Output will be: "value"
+
+### Environment Variables
+```
+  # ENV['APP_API_KEY'] = '1234567890'
+  puts EasyConfig.app.api_key
+```
 
 ## How it works
 
@@ -26,22 +70,12 @@ to put your files in config dir and be a valid YAML file (with .yml as extension
 If you desire you can split your configurations by environment. Easy config treats it
 automatically.
 
-### Example
-
-We can access database.yml file as:
-
-`EasyConfig.database.adapter`
-
-And if you have your our custom config file named my\_customs.yml:
-
-`EasyConfig.my_customs.custom_var`
-
 ## Supported rubies
 
 * 2.1
 * 2.0
 * 1.9.3
-* ree
+* ree (will be dropped after 1.0)
 
 ## License
 

data/lib/easy_config/env_var.rb

@@ -0,0 +1,32 @@
+module EasyConfig::EnvVar
+  class << self
+    def extended(base)
+      setup(base)
+    end
+
+    def setup(base)
+      env_vars.each do |key, configs|
+        create_method(base, key, EasyConfig::Configuration.new(configs))
+      end
+    end
+
+    def env_vars
+      configs = {}
+      ENV.each do |key, value|
+        if key.downcase =~ /^([a-zA-Z][^_]+)_(\w+)/
+          configs[$1] = configs.fetch($1, {})
+          configs[$1][$2] = value
+        end
+      end
+      configs
+    end
+
+    def create_method(base, name, value)
+      base.class_eval do
+        (class << self; self; end).instance_eval do
+          define_method(name.to_sym) { value }
+        end
+      end
+    end
+  end
+end

data/lib/easy_config/setup.rb

@@ -30,9 +30,18 @@ module EasyConfig
       self.reset!
     end
 
-    def reset!
+    def append_config_path(path)
+      reset if @loaded
+      EasyConfig::PathResolver.config_paths << path
+    end
+
+    def reset
       EasyConfig::ConfigFile.reset!
       @loaded = false
+    end
+
+    def reset!
+      reset
       setup_config
     end
 

data/lib/easy_config/version.rb

@@ -1,3 +1,3 @@
 module EasyConfig
-  VERSION = "0.9.3"
+  VERSION = "1.0.0"
 end

data/lib/easy_config.rb

@@ -3,10 +3,12 @@ require 'easy_config/setup'
 require 'easy_config/config_file'
 require 'easy_config/configuration'
 require 'easy_config/env'
+require 'easy_config/env_var'
 require 'easy_config/path_resolver'
 
 module EasyConfig
   class ConfigurationNotFound < NoMethodError; end
 
+  extend EnvVar
   extend Setup
 end

data/spec/easy_config/config_file_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe EasyConfig::ConfigFile do
-  before { EasyConfig::PathResolver.config_paths << './spec/fixtures' }
+  before { EasyConfig::PathResolver.config_paths << './spec/fixtures/config' }
   after { EasyConfig::PathResolver.clear! }
 
   context "all files" do

data/spec/easy_config/env_var_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe EasyConfig::EnvVar do
+  class TestEnvVar
+  end
+
+  before do
+    ENV['CLOUDAMQP_URL'] = 'amqp://user:pass@ec2.clustername.cloudamqp.com/vhost'
+  end
+
+  it 'has methods to retrieve values' do
+    EasyConfig::EnvVar.setup(TestEnvVar)
+    TestEnvVar.cloudamqp.url.should eq 'amqp://user:pass@ec2.clustername.cloudamqp.com/vhost'
+  end
+end

data/spec/easy_config_spec.rb

@@ -1,7 +1,10 @@
 require 'spec_helper'
 
 describe EasyConfig do
-  before { EasyConfig.config_path = File.expand_path('./spec/fixtures') }
+  before do
+    EasyConfig.reset!
+    EasyConfig.append_config_path File.expand_path('./spec/fixtures/config')
+  end
 
   context "mising methods" do
     it 'should treat it' do
@@ -42,4 +45,22 @@ describe EasyConfig do
     subject { EasyConfig.environment }
     it { should eq "test" }
   end
+
+  context "multiple config paths" do
+    before do
+      EasyConfig.append_config_path File.expand_path('./spec/fixtures/vendor')
+    end
+
+    it "reads from default config path" do
+      EasyConfig.redis.host.should eq "localhost"
+    end
+
+    it "reads from additional config path" do
+      EasyConfig.twitter.consumer_key.should eq "YOUR_CONSUMER_KEY"
+    end
+  end
+
+  it "returns value from environment variables" do
+    EasyConfig.app.env.should eq 'dev'
+  end
 end

data/spec/fixtures/vendor/twitter.yml

@@ -0,0 +1,5 @@
+development:
+  consumer_key: "YOUR_CONSUMER_KEY"
+  consumer_secret: "YOUR_CONSUMER_SECRET"
+  oauth_token: "YOUR_OAUTH_TOKEN"
+  oauth_token_secret: "YOUR_OAUTH_TOKEN_SECRET"

data/spec/spec_helper.rb

@@ -4,6 +4,8 @@ if RUBY_VERSION > "1.8.7"
   CodeClimate::TestReporter.start
 end
 
+ENV['APP_ENV'] = 'dev'
+
 require 'easy_config'
 
 ENV['RACK_ENV'] = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_config
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Felipe Oliveira
@@ -86,17 +86,20 @@ files:
 - lib/easy_config/config_file.rb
 - lib/easy_config/configuration.rb
 - lib/easy_config/env.rb
+- lib/easy_config/env_var.rb
 - lib/easy_config/path_resolver.rb
 - lib/easy_config/setup.rb
 - lib/easy_config/version.rb
 - spec/easy_config/config_file_spec.rb
 - spec/easy_config/configuration_spec.rb
 - spec/easy_config/env_spec.rb
+- spec/easy_config/env_var_spec.rb
 - spec/easy_config/path_resolver_spec.rb
 - spec/easy_config_spec.rb
-- spec/fixtures/facebook.yml
-- spec/fixtures/github.yml
-- spec/fixtures/redis.yml
+- spec/fixtures/config/facebook.yml
+- spec/fixtures/config/github.yml
+- spec/fixtures/config/redis.yml
+- spec/fixtures/vendor/twitter.yml
 - spec/spec_helper.rb
 homepage: http://rubygems.org/gems/easy_config
 licenses: