a9n 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14a5336e3c89478cdefd0df4a7c71dd78e809b10
-  data.tar.gz: 5ddb8cbb02e172e3bd26e43c2397ae0d49581a9a
+  metadata.gz: c6fafa85c44eb1e47cfc4a8c8c75d1d5ad46c982
+  data.tar.gz: 3e014475898cc21ec793573cae9873b35539fddd
 SHA512:
-  metadata.gz: 84e86886b37e5c7f785f6c9e9b0221aa05c9b0feced8f7992328d9bc475ff4842272d6011ef98cedb7153b289a40f63390e278d8a17ebde5647e71eccf3614b2
-  data.tar.gz: 4995758ee232692f671f8f944865712ff169bdb4ac0c166a0fe6ce0eebd95295f35909a6d35189dca44b5913c139565f58531309c8cf7ca37633a61f3c98a097
+  metadata.gz: 0ad1197d5321b3c868ff02c4d1265538d2fee85a9a24bf12a801dbac3e94f8f6705a5059315d5fec3472c2f2388b25c32d56006ed002cecea2adb30b6c98125a
+  data.tar.gz: e2e61a41f5b9b53bc86f6640f7d8160acdfae31d04d4a81c847eab5d883ff92095d475b623a80f475a71318e0376c328002880d45b37c7498a66012b15a84729

data/Gemfile

@@ -2,5 +2,5 @@ source 'https://rubygems.org'
 
 gemspec
 gem 'rake'
-gem 'rspec', '~> 2.14.0.rc1'
+gem 'rspec', '~> 2.14.0'
 gem 'coveralls', require: false

data/README.md

@@ -10,7 +10,8 @@
 [codeclimate]: https://codeclimate.com/github/knapo/a9n
 [coveralls]: https://coveralls.io/r/knapo/a9n
 
-Simple tool for managing extra configuration in ruby/rails apps. Supports Rails 2.x, 3.x, 4.x and Ruby 1.9, 2.0. For Ruby 1.8 use version < 1.0
+Simple tool for managing extra configuration in ruby/rails apps. Supports Rails 2.x, 3.x, 4.x and Ruby 1.9, 2.0. 
+Ruby 1.8 is not supported in version 0.1.2 and higher.
 
 ## Installation
 

data/lib/a9n.rb

@@ -43,8 +43,17 @@ module A9n
     end
 
     def load
-      base  = load_yml('config/configuration.yml.example')
-      local = load_yml('config/configuration.yml')
+      env_config     = load_env_config
+      default_config = load_default_config
+
+      whole_config   = default_config.merge(env_config)
+
+      @@configuration = Struct.new(whole_config)
+    end
+
+    def load_env_config
+      base     = load_yml('config/configuration.yml.example', env)
+      local    = load_yml('config/configuration.yml', env)
 
       if base.nil? && local.nil?
         raise MissingConfigurationFile.new("Neither config/configuration.yml.example nor config/configuration.yml was found")
@@ -54,18 +63,27 @@ module A9n
         verify!(base, local)
       end
 
-      @@configuration = Struct.new(local || base)
+      local || base
+    end
+
+    def load_default_config
+      data   = load_yml('config/configuration.yml.example', 'defaults', false)
+      data ||= load_yml('config/configuration.yml', 'defaults', false)
+      data ||= {}
+      return data
     end
 
-    def load_yml(file)
+    def load_yml(file, env, raise_when_not_found = true)
       path = File.join(self.root, file)
-      return unless File.exists?(path)
+      return nil unless File.exists?(path)
       yml = YAML.load(ERB.new(File.read(path)).result)
       
-      if yml[self.env].is_a?(Hash)
-        return yml[self.env].deep_symbolize_keys
+      if yml[env].is_a?(Hash)
+        return yml[env].deep_symbolize_keys
+      elsif raise_when_not_found
+        raise MissingConfigurationData.new("Configuration data for #{env} was not found in #{file}")
       else
-        raise MissingConfigurationData.new("Configuration data for #{self.env} was not found in #{file}")
+        return nil
       end
     end
 

data/lib/a9n/version.rb

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

data/spec/a9n_spec.rb

@@ -12,7 +12,7 @@ describe A9n do
     end
     
     context 'when custom non-rails app is being used' do
-      let(:local_app) { double(:env => 'test', :root => '/apps/a9n') }
+      let(:local_app) { double(env: 'test', root: '/apps/a9n') }
       before { described_class.local_app = local_app }
 
       specify { described_class.local_app.should == local_app }
@@ -22,7 +22,7 @@ describe A9n do
   end
 
   describe '.root' do
-    let(:local_app) { double(:env => 'test', :root => '/apps/a9n') }
+    let(:local_app) { double(env: 'test', root: '/apps/a9n') }
     before { described_class.local_app = local_app }
 
     context 'with custom path' do
@@ -48,17 +48,33 @@ describe A9n do
     
   describe '.load' do
     let(:base_sample_config){
-      { :app_url => 'http://127.0.0.1:3000' }
+      { app_url: 'http://127.0.0.1:3000', api_key: 'base1234' }
     }
     let(:local_sample_config){
-      { :app_host => '127.0.0.1:3000' }
+      { app_host: '127.0.0.1:3000', api_key: 'local1234' }
     }
-    subject { described_class }
+    let(:base_default_config){
+      { page_title: 'Base Kiełbasa', api_key: 'base1234default'  }
+    }
+    let(:local_default_config){
+      { page_title: 'Local Kiełbasa', api_key: 'local1234default' }
+    }
+    let(:env){
+      'tropical'
+    }
+    subject { 
+      described_class 
+    }
+    before do
+      allow(described_class).to receive(:env).and_return(env)
+    end
 
     context 'when no configuration file exists' do
       before do
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml.example').and_return(nil)
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml').and_return(nil)
+        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(:verify!).never
       end
       it 'raises expection'  do
@@ -68,44 +84,59 @@ describe A9n do
       end
     end
     
-    context 'when base configuration file exists' do
+    context 'when base configuration file exists with defaults' do
       before do
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml.example').and_return(base_sample_config)
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml').and_return(nil)
+        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(: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(:api_key) { should == 'base1234' }
       specify {
         expect { subject.app_host }.to raise_error(described_class::NoSuchConfigurationVariable)
       }
     end
 
-    context 'when local configuration file exists' do
+    context 'when local configuration file exists with defaults' do
       before do
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml.example').and_return(nil)
-        expect(described_class).to receive(:load_yml).with('config/configuration.yml').and_return(local_sample_config)
+        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(:verify!).never
         described_class.load
       end
       
       its(:app_host) { should_not be_nil }
+      its(:page_title) { should == 'Local Kiełbasa' }
+      its(:api_key) { should == 'local1234' }
       specify {
         expect { subject.app_url }.to raise_error(described_class::NoSuchConfigurationVariable)
       }
     end
 
-    context 'when both local and base configuration file exists' 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').and_return(base_sample_config)
-          expect(described_class).to receive(:load_yml).with('config/configuration.yml').and_return(base_sample_config)
+          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)
           described_class.load
         end
         
-        its(:app_url) { should_not be_nil }
+        its(:app_url) { should_not be_nil }  
+        its(:api_key) { should == 'base1234' }      
+        specify {
+          expect { subject.page_title }.to raise_error(described_class::NoSuchConfigurationVariable)
+        }
         specify {
           expect { subject.app_host }.to raise_error(described_class::NoSuchConfigurationVariable)
         }
@@ -113,8 +144,10 @@ describe A9n do
 
       context 'with different data' do
         before do
-          expect(described_class).to receive(:load_yml).with('config/configuration.yml.example').and_return(base_sample_config)
-          expect(described_class).to receive(:load_yml).with('config/configuration.yml').and_return(local_sample_config)
+          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
         end
         it 'raises expection'  do
           expect {
@@ -127,14 +160,15 @@ describe A9n do
 
   describe '.load_yml' do
     let(:root) { File.dirname(__FILE__) }
-    subject {  described_class.load_yml(file_path) }
+    let(:env) { 'test' }
+    subject {  described_class.load_yml(file_path, env) }
 
     before do
       expect(described_class).to receive(:root).at_least(:once).and_return(root)
+      expect(described_class).to receive(:env).never
     end
 
     context 'when file not exists' do
-      before { expect(described_class).to receive(:env).never }
       let(:file_path) { 'file_not_existing_in_universe.yml' }
       
       it 'returns nil' do
@@ -146,12 +180,9 @@ describe A9n do
       let(:file_path) { 'fixtures/configuration.yml'}
       before { 
         ENV['DWARF'] = 'erbized dwarf'
-        expect(described_class).to receive(:env).twice.and_return(env) 
       }
 
       context 'and has data' do
-        let(:env) { 'test' }
-
         it 'returns non-empty hash' do
           subject.should be_kind_of(Hash)
           subject.keys.should_not be_empty
@@ -187,7 +218,7 @@ describe A9n do
 
     context 'local_app_env is set' do
       before { 
-        expect(described_class).to receive(:local_app).and_return(double(:env => 'dwarf_env')).exactly(3).times
+        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' }

data/spec/fixtures/configuration.yml

@@ -1,9 +1,13 @@
+defaults:
+  default_dwarf: "default dwarf"
+  overriden_dwarf: "not yet overriden dwarf"
 development:
   nil_dwarf: ~
   false_dwarf: false
   true_dwarf: true
   string_dwarf: "dwarf"
   erb_dwarf: "<%= ENV['DWARF'] %>"
+  overriden_dwarf: "already overriden dwarf"
   hash_dwarf:
     dwarf_1: "hello 1"
     dwarf_2: "hello 2"
@@ -13,6 +17,7 @@ test:
   true_dwarf: true
   string_dwarf: "dwarf"
   erb_dwarf: "<%= ENV['DWARF'] %>"
+  overriden_dwarf: "already overriden dwarf"
   hash_dwarf:
     dwarf_1: "hello 1"
     dwarf_2: "hello 2"

data/spec/struct_spec.rb

@@ -3,11 +3,11 @@ require 'spec_helper'
 describe A9n::Struct do
   subject {
     described_class.new({
-        :non_empty_dwarf => 'dwarf',
-        :nil_dwarf       => nil,
-        :false_dwarf     => false,
-        :true_dwarf      => true,
-        :hash_dwarf      => { :dwarf => 'hello' }
+        non_empty_dwarf: 'dwarf',
+        nil_dwarf:   nil,
+        false_dwarf: false,
+        true_dwarf:  true,
+        hash_dwarf:  { dwarf: 'hello' }
       })
   }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: a9n
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Krzysztof Knapik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-05 00:00:00.000000000 Z
+date: 2013-11-05 00:00:00.000000000 Z
 dependencies: []
 description: Simple tool for managing extra configuration in ruby/rails apps
 email: