a9n 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6fafa85c44eb1e47cfc4a8c8c75d1d5ad46c982
-  data.tar.gz: 3e014475898cc21ec793573cae9873b35539fddd
+  metadata.gz: e369363c79fb9a656521140c1579f784a7e9dc4a
+  data.tar.gz: cfc947874a96b1884b65200baf180c7f85b5c30d
 SHA512:
-  metadata.gz: 0ad1197d5321b3c868ff02c4d1265538d2fee85a9a24bf12a801dbac3e94f8f6705a5059315d5fec3472c2f2388b25c32d56006ed002cecea2adb30b6c98125a
-  data.tar.gz: e2e61a41f5b9b53bc86f6640f7d8160acdfae31d04d4a81c847eab5d883ff92095d475b623a80f475a71318e0376c328002880d45b37c7498a66012b15a84729
+  metadata.gz: 87fe223271b1188c7df2322279456879bf47a6abfb5c97b9d7ca95faf81d13a9fdae9bce28d2fa6df47ad86f5a361660ccc55153ed4904f7bd099408bc819093
+  data.tar.gz: 4c452ad39305bc59df2c81ab207ee98424e8a80967055caebc6fc035b88432f510a49caaa7621053be67ea62faa40859be50cedf8bdeb48a7d5fce11ac31e1c9

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
-  - "1.9.3"
-  - "2.0.0"
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
   - jruby-19mode
-  - rbx-19mode
+  - rbx-2.0.0
+  - rbx-2.1.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 knapo
+Copyright (c) 2013 Krzysztof Knapik @knapo
 
 MIT License
 

data/README.md

@@ -37,8 +37,6 @@ after budler requires:
     A9n.root = File.expand_path('../..', __FILE__)
     A9n.load
 
-This step is not required, but recommended, as it configuration is loaded and
-verified on evironment load.
 
 It works with `Rails` by default. If you want to use `A9n` with non-rails app
 you may need to tell it A9n:
@@ -50,13 +48,30 @@ you may need to tell it A9n:
 You can access any variable defined in configuration files but delegating it to 
 `A9n`. E.g:
 
+    defaults:
+      email_from: 'no-reply@knapo.net'
     production:
-      app_host: 'http://knapo.net'
+      app_host: 'knapo.net'
+    development:
+      app_host: 'localhost:3000'
 
 is accessible by:
 
-    A9n.app_host
+    A9n.app_host   # => `knapo.net` in production and `localhost:3000` in development
+    A9n.email_from # => `no-reply@knapo.net` in all envs
 
+## Custom and multiple configuration files
+
+If you need to load config from custom files (e.g `config/mongo.yml` and `config/other.yml`), add:
+    
+    A9n.load('mongo.yml', 'other.yml')
+    
+and the configuration is availble under `mongo` and `other` scopes:
+
+    A9n.mongo.varname
+    
+    A9n.other.varname
+    
 ## Contributing
 
 1. Fork it
@@ -68,3 +83,4 @@ is accessible by:
 ### Contributors
 
 * [Grzegorz Świrski](https://github.com/sognat)
+* [Jakub Łopusiński](https://github.com/siemakuba)

data/a9n.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Simple tool for managing extra configuration in ruby/rails apps}
   gem.summary       = %q{a9n is a simple tool for managing extra configuration in ruby/rails apps}
   gem.homepage      = "https://github.com/knapo/a9n"
-
+  gem.license       = 'MIT'
   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)/})

data/lib/a9n.rb

@@ -1,8 +1,8 @@
-require 'a9n/version'
-require 'a9n/struct'
-require 'a9n/core_ext/hash'
-require 'yaml'
-require 'erb'
+require "a9n/version"
+require "a9n/struct"
+require "a9n/core_ext/hash"
+require "yaml"
+require "erb"
 
 module A9n
   class ConfigurationNotLoaded < StandardError; end
@@ -10,15 +10,13 @@ module A9n
   class MissingConfigurationData < StandardError; end
   class MissingConfigurationVariables < StandardError; end
   class NoSuchConfigurationVariable < StandardError; end
-  
-  class << self
 
-    def config
-      @@configuration ||= load
-    end
+  DEFAULT_FILE = 'configuration.yml'
+  DEFAULT_SCOPE = :configuration
 
+  class << self
     def env
-      @env ||= local_app_env || get_env_var('RAILS_ENV') || get_env_var('RACK_ENV') || get_env_var('APP_ENV')
+      @env ||= local_app_env || get_env_var("RAILS_ENV") || get_env_var("RACK_ENV") || get_env_var("APP_ENV")
     end
 
     def local_app_env
@@ -42,21 +40,28 @@ module A9n
       @root = path.empty? ? nil : Pathname.new(path.to_s)
     end
 
-    def load
-      env_config     = load_env_config
-      default_config = load_default_config
+    def scope(name)
+      instance_variable_get(var_name_for(name)) || (name == DEFAULT_SCOPE && load.first)
+    end
+
+    def load(*files)
+      files = [DEFAULT_FILE] if files.empty?
+      files.map do |file|
+        env_config     = load_env_config(file)
+        default_config = load_default_config(file)
 
-      whole_config   = default_config.merge(env_config)
+        whole_config   = default_config.merge(env_config)
 
-      @@configuration = Struct.new(whole_config)
+        instance_variable_set(var_name_for(file), A9n::Struct.new(whole_config))
+      end
     end
 
-    def load_env_config
-      base     = load_yml('config/configuration.yml.example', env)
-      local    = load_yml('config/configuration.yml', env)
+    def load_env_config(file)
+      base     = load_yml("config/#{file}.example", env)
+      local    = load_yml("config/#{file}", env)
 
       if base.nil? && local.nil?
-        raise MissingConfigurationFile.new("Neither config/configuration.yml.example nor config/configuration.yml was found")
+        raise MissingConfigurationFile.new("Neither config/#{file}.example nor config/#{file} was found")
       end
 
       if !base.nil? && !local.nil?
@@ -66,9 +71,9 @@ module A9n
       local || base
     end
 
-    def load_default_config
-      data   = load_yml('config/configuration.yml.example', 'defaults', false)
-      data ||= load_yml('config/configuration.yml', 'defaults', false)
+    def load_default_config(file = "configuration.yml")
+      data   = load_yml("config/#{file}.example", "defaults", false)
+      data ||= load_yml("config/#{file}", "defaults", false)
       data ||= {}
       return data
     end
@@ -77,7 +82,7 @@ module A9n
       path = File.join(self.root, file)
       return nil unless File.exists?(path)
       yml = YAML.load(ERB.new(File.read(path)).result)
-      
+
       if yml[env].is_a?(Hash)
         return yml[env].deep_symbolize_keys
       elsif raise_when_not_found
@@ -93,11 +98,15 @@ module A9n
     end
 
     def fetch(*args)
-      config.fetch(*args)
+      scope(DEFAULT_SCOPE).fetch(*args)
     end
 
     def method_missing(name, *args)
-      config.send(name, *args)
+      if scope(name).is_a?(A9n::Struct)
+        scope(name)
+      else
+        scope(DEFAULT_SCOPE).send(name, *args)
+      end
     end
 
     def get_rails
@@ -105,16 +114,20 @@ module A9n
     end
 
     def get_env_var(name)
-      ENV[name] 
+      ENV[name]
     end
-    
+
     private
 
     def verify!(base, local)
       missing_keys = base.keys - local.keys
       if missing_keys.any?
-        raise MissingConfigurationVariables.new("Following variables are missing in your configuration file: #{missing_keys.join(',')}")
+        raise MissingConfigurationVariables.new("Following variables are missing in your configuration file: #{missing_keys.join(",")}")
       end
     end
+
+    def var_name_for(file)
+      :"@#{file.to_s.split('.').first}"
+    end
   end
 end

data/lib/a9n/version.rb

@@ -1,3 +1,3 @@
 module A9n
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/spec/a9n_spec.rb

@@ -10,7 +10,7 @@ describe A9n do
         described_class.local_app.should be_nil
       }
     end
-    
+
     context 'when custom non-rails app is being used' do
       let(:local_app) { double(env: 'test', root: '/apps/a9n') }
       before { described_class.local_app = local_app }
@@ -42,11 +42,13 @@ describe A9n do
 
     after {
       described_class.root = nil
-      described_class.local_app = nil 
+      described_class.local_app = nil
     }
   end
-    
+
   describe '.load' do
+    let(:base_file) { described_class::DEFAULT_FILE }
+    let(:extra_file) { 'mongo.yml' }
     let(:base_sample_config){
       { app_url: 'http://127.0.0.1:3000', api_key: 'base1234' }
     }
@@ -54,16 +56,16 @@ describe A9n do
       { app_host: '127.0.0.1:3000', api_key: 'local1234' }
     }
     let(:base_default_config){
-      { page_title: 'Base Kiełbasa', api_key: 'base1234default'  }
+      { page_title: 'Base Kielbasa', api_key: 'base1234default'  }
     }
     let(:local_default_config){
-      { page_title: 'Local Kiełbasa', api_key: 'local1234default' }
+      { page_title: 'Local Kielbasa', api_key: 'local1234default' }
     }
     let(:env){
       'tropical'
     }
-    subject { 
-      described_class 
+    subject {
+      described_class
     }
     before do
       allow(described_class).to receive(:env).and_return(env)
@@ -71,10 +73,10 @@ describe A9n do
 
     context 'when no configuration file exists' do
       before do
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml.example', env).and_return(nil)
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml', env).and_return(nil)
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml.example', 'defaults', false).never
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml', 'defaults', false).never
+        expect(described_class).to receive(:load_yml).with("config/#{base_file}.example", env).and_return(nil)
+        expect(described_class).to receive(:load_yml).with("config/#{base_file}", env).and_return(nil)
+        expect(described_class).to receive(:load_yml).with("config/#{base_file}.example", 'defaults', false).never
+        expect(described_class).to receive(:load_yml).with("config/#{base_file}", 'defaults', false).never
         expect(described_class).to receive(:verify!).never
       end
       it 'raises expection'  do
@@ -83,22 +85,25 @@ describe A9n do
         }.should raise_error(described_class::MissingConfigurationFile)
       end
     end
-    
+
     context 'when base configuration file exists with defaults' do
       before do
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml.example', env).and_return(base_sample_config)
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml', env).and_return(nil)
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml.example', 'defaults', false).and_return(base_default_config)
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml', 'defaults', false).never
-        
+        expect(described_class).to receive(:load_yml).with("config/#{base_file}.example", env).and_return(base_sample_config)
+        expect(described_class).to receive(:load_yml).with("config/#{base_file}", env).and_return(nil)
+        expect(described_class).to receive(:load_yml).with("config/#{base_file}.example", 'defaults', false).and_return(base_default_config)
+        expect(described_class).to receive(:load_yml).with("config/#{base_file}", 'defaults', false).never
+
         expect(described_class).to receive(:verify!).never
         described_class.load
       end
-      
+
       its(:app_url) { should_not be_nil }
       its(:app_url) { should == subject.fetch(:app_url) }
-      its(:page_title) { should == 'Base Kiełbasa' }
+      its(:page_title) { should == 'Base Kielbasa' }
       its(:api_key) { should == 'base1234' }
+      specify {
+        expect(subject.instance_variable_get("@configuration")).to be_kind_of(A9n::Struct)
+      }
       specify {
         expect { subject.app_host }.to raise_error(described_class::NoSuchConfigurationVariable)
       }
@@ -106,16 +111,16 @@ describe A9n do
 
     context 'when local configuration file exists with defaults' do
       before do
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml.example', env).and_return(nil)
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml', env).and_return(local_sample_config)
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml.example', 'defaults', false).and_return(nil)
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml', 'defaults', false).and_return(local_default_config)
+        expect(described_class).to receive(:load_yml).with("config/#{base_file}.example", env).and_return(nil)
+        expect(described_class).to receive(:load_yml).with("config/#{base_file}", env).and_return(local_sample_config)
+        expect(described_class).to receive(:load_yml).with("config/#{base_file}.example", 'defaults', false).and_return(nil)
+        expect(described_class).to receive(:load_yml).with("config/#{base_file}", 'defaults', false).and_return(local_default_config)
         expect(described_class).to receive(:verify!).never
         described_class.load
       end
-      
+
       its(:app_host) { should_not be_nil }
-      its(:page_title) { should == 'Local Kiełbasa' }
+      its(:page_title) { should == 'Local Kielbasa' }
       its(:api_key) { should == 'local1234' }
       specify {
         expect { subject.app_url }.to raise_error(described_class::NoSuchConfigurationVariable)
@@ -125,15 +130,15 @@ describe A9n do
     context 'when both local and base configuration file exists without defaults' do
       context 'with same data' do
         before do
-          expect(described_class).to receive(:load_yml).with('config/configuration.yml.example', env).and_return(base_sample_config)
-          expect(described_class).to receive(:load_yml).with('config/configuration.yml', env).and_return(base_sample_config)
-          expect(described_class).to receive(:load_yml).with('config/configuration.yml.example', 'defaults', false).and_return(nil)
-          expect(described_class).to receive(:load_yml).with('config/configuration.yml', 'defaults', false).and_return(nil)
+          expect(described_class).to receive(:load_yml).with("config/#{base_file}.example", env).and_return(base_sample_config)
+          expect(described_class).to receive(:load_yml).with("config/#{base_file}", env).and_return(base_sample_config)
+          expect(described_class).to receive(:load_yml).with("config/#{base_file}.example", 'defaults', false).and_return(nil)
+          expect(described_class).to receive(:load_yml).with("config/#{base_file}", 'defaults', false).and_return(nil)
           described_class.load
         end
-        
-        its(:app_url) { should_not be_nil }  
-        its(:api_key) { should == 'base1234' }      
+
+        its(:app_url) { should_not be_nil }
+        its(:api_key) { should == 'base1234' }
         specify {
           expect { subject.page_title }.to raise_error(described_class::NoSuchConfigurationVariable)
         }
@@ -144,10 +149,10 @@ describe A9n do
 
       context 'with different data' do
         before do
-          expect(described_class).to receive(:load_yml).with('config/configuration.yml.example', env).and_return(base_sample_config)
-          expect(described_class).to receive(:load_yml).with('config/configuration.yml', env).and_return(local_sample_config)
-          expect(described_class).to receive(:load_yml).with('config/configuration.yml.example', 'defaults', false).never
-          expect(described_class).to receive(:load_yml).with('config/configuration.yml', 'defaults', false).never
+          expect(described_class).to receive(:load_yml).with("config/#{base_file}.example", env).and_return(base_sample_config)
+          expect(described_class).to receive(:load_yml).with("config/#{base_file}", env).and_return(local_sample_config)
+          expect(described_class).to receive(:load_yml).with("config/#{base_file}.example", 'defaults', false).never
+          expect(described_class).to receive(:load_yml).with("config/#{base_file}", 'defaults', false).never
         end
         it 'raises expection'  do
           expect {
@@ -156,6 +161,27 @@ describe A9n do
         end
       end
     end
+
+    context 'when extra file is loaded' do
+      before do
+        expect(described_class).to receive(:load_yml).with("config/#{extra_file}.example", env).and_return(base_sample_config)
+        expect(described_class).to receive(:load_yml).with("config/#{extra_file}", env).and_return(nil)
+        expect(described_class).to receive(:load_yml).with("config/#{extra_file}.example", 'defaults', false).and_return(base_default_config)
+        expect(described_class).to receive(:load_yml).with("config/#{extra_file}", 'defaults', false).never
+
+        expect(described_class).to receive(:verify!).never
+        described_class.load('mongo.yml')
+      end
+
+      it { expect(subject.mongo).to be_kind_of(A9n::Struct) }
+      it { expect(subject.instance_variable_get("@mongo")).to be_kind_of(A9n::Struct) }
+      it { expect(subject.mongo.app_url).to eq("http://127.0.0.1:3000") }
+      it { expect(subject.mongo.page_title).to eq('Base Kielbasa') }
+      it { expect(subject.mongo.api_key).to eq('base1234') }
+      specify {
+        expect { subject.mongo.app_host }.to raise_error(described_class::NoSuchConfigurationVariable)
+      }
+    end
   end
 
   describe '.load_yml' do
@@ -170,22 +196,22 @@ describe A9n do
 
     context 'when file not exists' do
       let(:file_path) { 'file_not_existing_in_universe.yml' }
-      
+
       it 'returns nil' do
-        subject.should be_nil
+        expect(subject).to be_nil
       end
     end
 
     context 'when file exists' do
       let(:file_path) { 'fixtures/configuration.yml'}
-      before { 
+      before {
         ENV['DWARF'] = 'erbized dwarf'
       }
 
       context 'and has data' do
         it 'returns non-empty hash' do
-          subject.should be_kind_of(Hash)
-          subject.keys.should_not be_empty
+          expect(subject).to be_kind_of(Hash)
+          expect(subject.keys).to_not be_empty
         end
 
         it 'has symbolized keys' do
@@ -198,7 +224,7 @@ describe A9n do
           subject[:erb_dwarf].should == 'erbized dwarf'
         end
       end
-      
+
       context 'and has no data' do
         let(:env) { 'production' }
 
@@ -217,15 +243,15 @@ describe A9n do
     }
 
     context 'local_app_env is set' do
-      before { 
+      before {
         expect(described_class).to receive(:local_app).and_return(double(env: 'dwarf_env')).exactly(3).times
         expect(described_class).to receive(:get_env_var).never
       }
       its(:env) { should == 'dwarf_env' }
     end
 
-    context "when APP_ENV is set" do    
-      before { 
+    context "when APP_ENV is set" do
+      before {
         expect(described_class).to receive(:local_app_env).and_return(nil)
         expect(described_class).to receive(:get_env_var).with('RAILS_ENV').and_return(nil)
         expect(described_class).to receive(:get_env_var).with('RACK_ENV').and_return(nil)
@@ -250,11 +276,11 @@ describe A9n do
         Object.send(:remove_const, :Rails)
       }
       it {
-        described_class.get_rails.should be_kind_of(Module) 
+        described_class.get_rails.should be_kind_of(Module)
       }
     end
     context 'when not defined' do
       it { described_class.get_rails.should be_nil }
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: a9n
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Krzysztof Knapik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2014-03-12 00:00:00.000000000 Z
 dependencies: []
 description: Simple tool for managing extra configuration in ruby/rails apps
 email:
@@ -33,7 +33,8 @@ files:
 - spec/spec_helper.rb
 - spec/struct_spec.rb
 homepage: https://github.com/knapo/a9n
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -51,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: a9n is a simple tool for managing extra configuration in ruby/rails apps