a9n 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c01e44cda9bcf5236abb9f3e48b210770559debc113dd329eb9be58be5e6ffb
-  data.tar.gz: 19cc16d440842053dd4deaf3534fa4367d4be03d72f672249d42bfd133e24fd5
+  metadata.gz: 64635e48744929de570a088a20cbd25dfd0f0d8e436f315bafda97fe5ede1201
+  data.tar.gz: 797e01d61523df13ec756aeb118554736436dc65bcb96e89862bdcae558efb63
 SHA512:
-  metadata.gz: a5258bfce395c5b2af491824036833601979f1f0b7fbb7bd22d999549698e0240de74911c92bf83acc7e5db61a1ad34015799783ae1dffc4877b03d02ce0bf09
-  data.tar.gz: 185d114b3f8db2aefefe5e4a8a4b434b19be429d6c28b1d840c45e7d91e1537fb47c11410097192ac3d6c8141ea73a2afeda083c6985c96051ca3e47837d8d52
+  metadata.gz: ef3c1cf8cdc5b46b9a97ce6cea4527cd24bb069790dcf06359cab9d371484da55d397b38b0ec87653fc76cf51f92c567ba2daf4dcd1c5253f1e000c4d1148a6e
+  data.tar.gz: 4fe030566efa78a7845657c95dda4e2c0eddc8799b449343cb00995227f9a5183da5340bb37100ebc7835b51a70450b4310512e133b4ebdbee31687ebd31d12d

data/README.md

@@ -24,10 +24,10 @@ And then execute:
 
     $ bundle
 
-Add `configuration.yml.example` and/or `configuration.yml` file into the config
+Add `a9n.yml.example` and/or `a9n.yml` file into the config
 directory. When none fo these files exists, `A9n::MissingConfigurationFile`
-exception is thrown. You can also use `a9n.yml`, which is loaded by default.
-If both file exist, content of `configuration.yml` is validated. It means that
+exception is thrown. You can also use `configuration.yml(.example)`.
+If both file exist, content of `a9n.yml` is validated. It means that
 all keys existing in example file must exist in local file - in case of missing
 keys `A9n::MissingConfigurationVariablesError` is thrown with the explanation what is missing.
 
@@ -62,7 +62,7 @@ is accessible by:
 
 ## Custom and multiple configuration files
 
-If you want to split configuration, you can use multiple files. All files from `config/a9n` are loaded by default, but you may pass custom paths as an argument to `A9n.load` e.g. `A9n.load('config/facebook.yml', 'config/mongoid.yml')`. In such cases config items are accessible through the scope consistent with the file name.
+If you want to split configuration, you can use multiple files. All files from `config/a9n` are loaded by default, but you may pass custom paths as an argument to `A9n.load` e.g. `A9n.load('config/aws.yml', 'config/mail.yml')`. In such cases config items are accessible through the scope consistent with the file name.
 
 E.g. if you have `config/a9n/mail.yml`:
 
@@ -100,7 +100,7 @@ Just add an instance configuration file e.g. `configuration.yml.staging`, `confi
 
     require 'a9n/capistrano'
 
-to your Capfile. This way `configuration.yml.<stage>` overrides `configuration.yml` on each deploy.
+to your Capfile. This way `a9n.yml.<stage>` overrides `a9n.yml` on each deploy.
 
 ## Contributing
 

data/lib/a9n.rb

@@ -27,7 +27,7 @@ module A9n
     end
 
     def app_env
-      app&.env
+      app.env if app.respond_to?(:env)
     end
 
     def app
@@ -43,7 +43,7 @@ module A9n
     end
 
     def app_root
-      app&.root
+      app.root if app.respond_to?(:root)
     end
 
     def root=(path)

data/lib/a9n/version.rb

@@ -1,3 +1,3 @@
 module A9n
-  VERSION = '0.8.0'.freeze
+  VERSION = '0.8.2'.freeze
 end

data/spec/integration/a9n_spec.rb

@@ -5,8 +5,9 @@ RSpec.describe A9n do
 
   before do
     clean_singleton(subject)
-    ENV['ERB_DWARF'] = 'erbized dwarf'
-    ENV['DWARF_PASSWORD'] = 'dwarf123'
+    ENV['ERB_FOO'] = 'erbized foo'
+    ENV['FOO_PASSWORD'] = 'foo123'
+    ENV['FOO_KEY'] = 'key123'
     ENV['AWS_API_KEY'] = 'ASDF1234'
     ENV['API_KEY'] = 'XYZ999'
     subject.app = double(env: env)
@@ -16,7 +17,10 @@ RSpec.describe A9n do
 
   after do
     clean_singleton(subject)
-    ENV.delete('GOOGLE_API_KEY')
+    ENV.delete('ERB_FOO')
+    ENV.delete('FOO_PASSWORD')
+    ENV.delete('FOO_KEY')
+    ENV.delete('AWS_API_KEY')
     ENV.delete('API_KEY')
   end
 
@@ -26,20 +30,20 @@ RSpec.describe A9n do
     end
 
     it do
-      expect(subject.default_dwarf).to eq('default dwarf')
-      expect(subject.overriden_dwarf).to eq('already overriden dwarf')
-      subject.set(:default_dwarf, 'lazy dwarf')
-      subject.set(:overriden_dwarf, 'hard working dwarf')
-      expect(subject.default_dwarf).to eq('lazy dwarf')
-      expect(subject.overriden_dwarf).to eq('hard working dwarf')
+      expect(subject.default_foo).to eq('default foo')
+      expect(subject.overriden_foo).to eq('already overriden foo')
+      subject.set(:default_foo, 'lazy foo')
+      subject.set(:overriden_foo, 'hard working foo')
+      expect(subject.default_foo).to eq('lazy foo')
+      expect(subject.overriden_foo).to eq('hard working foo')
       subject.load
-      expect(subject.default_dwarf).to eq('default dwarf')
-      expect(subject.overriden_dwarf).to eq('already overriden dwarf')
+      expect(subject.default_foo).to eq('default foo')
+      expect(subject.overriden_foo).to eq('already overriden foo')
     end
 
     it do
-      expect(subject.fetch(:default_dwarf)).to eq('default dwarf')
-      expect(subject.fetch(:overriden_dwarf)).to eq('already overriden dwarf')
+      expect(subject.fetch(:default_foo)).to eq('default foo')
+      expect(subject.fetch(:overriden_foo)).to eq('already overriden foo')
     end
 
     it do
@@ -59,13 +63,13 @@ RSpec.describe A9n do
     let(:env) { 'tropical' }
 
     it do
-      expect(subject.default_dwarf).to eq('default dwarf')
-      expect(subject.overriden_dwarf).to eq('not yet overriden dwarf')
+      expect(subject.default_foo).to eq('default foo')
+      expect(subject.overriden_foo).to eq('not yet overriden foo')
     end
 
     it do
-      expect(subject.fetch(:default_dwarf)).to eq('default dwarf')
-      expect(subject.fetch(:overriden_dwarf)).to eq('not yet overriden dwarf')
+      expect(subject.fetch(:default_foo)).to eq('default foo')
+      expect(subject.fetch(:overriden_foo)).to eq('not yet overriden foo')
     end
   end
 

data/spec/unit/a9n_spec.rb

@@ -9,14 +9,16 @@ RSpec.describe A9n do
     end
 
     context 'app_env is set' do
+      let(:app) { OpenStruct.new(env: ::A9n::StringInquirer.new('foo_env')) }
+
       before do
-        expect(subject).to receive(:app).and_return(double(env: ::A9n::StringInquirer.new('dwarf_env')))
+        allow(subject).to receive(:app).and_return(app)
         expect(subject).to receive(:env_var).never
       end
 
       it do
-        expect(subject.env).to eq('dwarf_env')
-        expect(subject.env.dwarf_env?).to eq(true)
+        expect(subject.env).to eq('foo_env')
+        expect(subject.env.foo_env?).to eq(true)
         expect(subject.env.production?).to eq(false)
       end
     end
@@ -26,12 +28,12 @@ RSpec.describe A9n do
         expect(subject).to receive(:app_env).and_return(nil)
         expect(subject).to receive(:env_var).with('RAILS_ENV').and_return(nil)
         expect(subject).to receive(:env_var).with('RACK_ENV').and_return(nil)
-        expect(subject).to receive(:env_var).with('APP_ENV').and_return('dwarf_env')
+        expect(subject).to receive(:env_var).with('APP_ENV').and_return('foo_env')
       end
 
       it do
-        expect(subject.env).to eq('dwarf_env')
-        expect(subject.env.dwarf_env?).to eq(true)
+        expect(subject.env).to eq('foo_env')
+        expect(subject.env.foo_env?).to eq(true)
         expect(subject.env.production?).to eq(false)
       end
     end
@@ -75,7 +77,7 @@ RSpec.describe A9n do
 
   describe '.root' do
     context 'when app is set' do
-      let(:app) { double(env: 'test', root: '/apps/a9n') }
+      let(:app) { OpenStruct.new(env: 'test', root: '/apps/a9n') }
 
       before do
         subject.app = app
@@ -149,15 +151,15 @@ RSpec.describe A9n do
 
   describe '.env_var' do
     before do
-      ENV['DWARF'] = 'little dwarf'
+      ENV['FOO'] = 'little foo'
     end
 
     it do
-      expect(subject.env_var('DWARF')).to eq('little dwarf')
+      expect(subject.env_var('FOO')).to eq('little foo')
     end
 
     it do
-      expect(subject.env_var('IS_DWARF')).to be_nil
+      expect(subject.env_var('IS_FOO')).to be_nil
     end
   end
 

data/spec/unit/loader_spec.rb

@@ -119,13 +119,15 @@ RSpec.describe A9n::Loader do
       end
 
       before do
-        ENV['ERB_DWARF'] = 'erbized dwarf'
-        ENV['DWARF_PASSWORD'] = 'dwarf123'
+        ENV['ERB_FOO'] = 'erbized foo'
+        ENV['FOO_PASSWORD'] = 'foo123'
+        ENV['FOO_KEY'] = 'key123'
       end
 
       after do
-        ENV.delete('ERB_DWARF')
-        ENV.delete('DWARF_PASSWORD')
+        ENV.delete('ERB_FOO')
+        ENV.delete('FOO_PASSWORD')
+        ENV.delete('FOO_KEY')
       end
 
       context 'when file has erb extension' do
@@ -140,32 +142,33 @@ RSpec.describe A9n::Loader do
         it_behaves_like 'non-empty config file'
 
         it 'contains keys from defaults scope' do
-          expect(subject[:default_dwarf]).to eq('default dwarf')
-          expect(subject[:overriden_dwarf]).to eq('already overriden dwarf')
+          expect(subject[:default_foo]).to eq('default foo')
+          expect(subject[:overriden_foo]).to eq('already overriden foo')
         end
 
         it 'has symbolized keys' do
           expect(subject.keys.first).to be_kind_of(Symbol)
-          expect(subject[:hash_dwarf]).to be_kind_of(Hash)
-          expect(subject[:hash_dwarf].keys.first).to be_kind_of(Symbol)
+          expect(subject[:hash_foo]).to be_kind_of(Hash)
+          expect(subject[:hash_foo].keys.first).to be_kind_of(Symbol)
+          expect(subject[:hash_foo]).to eq(foo_1: 'hello 1', foo_2: 'hello 2', foo_key: 'key123')
         end
 
         it 'parses erb' do
-          expect(subject[:erb_dwarf]).to eq('erbized dwarf')
+          expect(subject[:erb_foo]).to eq('erbized foo')
         end
 
         it 'gets valus from ENV' do
-          expect(subject[:dwarf_password]).to eq('dwarf123')
+          expect(subject[:foo_password]).to eq('foo123')
         end
 
         it 'raises exception when ENV var is not set' do
-          ENV.delete('DWARF_PASSWORD')
-          expect { subject[:dwarf_password] }.to raise_error(A9n::MissingEnvVariableError)
+          ENV.delete('FOO_PASSWORD')
+          expect { subject[:foo_password] }.to raise_error(A9n::MissingEnvVariableError)
         end
 
         it 'raises exception when ENV var is set to nil' do
-          ENV['DWARF_PASSWORD'] = nil
-          expect { subject[:dwarf_password] }.to raise_error(A9n::MissingEnvVariableError)
+          ENV['FOO_PASSWORD'] = nil
+          expect { subject[:foo_password] }.to raise_error(A9n::MissingEnvVariableError)
         end
       end
 
@@ -176,8 +179,8 @@ RSpec.describe A9n::Loader do
         it_behaves_like 'non-empty config file'
 
         it 'contains keys from defaults scope' do
-          expect(subject[:default_dwarf]).to eq('default dwarf')
-          expect(subject[:overriden_dwarf]).to eq('not yet overriden dwarf')
+          expect(subject[:default_foo]).to eq('default foo')
+          expect(subject[:overriden_foo]).to eq('not yet overriden foo')
         end
       end
 

data/spec/unit/struct_spec.rb

@@ -11,38 +11,38 @@ RSpec.describe A9n::Struct do
     end
 
     describe '#key?' do
-      it { expect(subject.key?(:dwarf)).to eq(false) }
+      it { expect(subject.key?(:foo)).to eq(false) }
     end
 
     describe '#[]' do
-      it { expect(subject[:dwarf]).to eq(nil) }
+      it { expect(subject[:foo]).to eq(nil) }
     end
 
     describe '#fetch' do
       it do
-        expect { subject.fetch(:dwarf) }.to raise_error(KeyError)
+        expect { subject.fetch(:foo) }.to raise_error(KeyError)
       end
 
       it do
-        expect(subject.fetch(:dwarf, 'hello')).to eq('hello')
+        expect(subject.fetch(:foo, 'hello')).to eq('hello')
       end
     end
 
     it 'raises error on accessin invalid attribute' do
       expect {
-        subject.dwarf
-      }.to raise_error(A9n::NoSuchConfigurationVariableError, 'dwarf')
+        subject.foo
+      }.to raise_error(A9n::NoSuchConfigurationVariableError, 'foo')
     end
   end
 
   context 'with values' do
     let(:data) do
       {
-        non_empty_dwarf: 'dwarf',
-        nil_dwarf: nil,
-        false_dwarf: false,
-        true_dwarf: true,
-        hash_dwarf: { dwarf: 'hello' }
+        non_empty_foo: 'foo',
+        nil_foo: nil,
+        false_foo: false,
+        true_foo: true,
+        hash_foo: { foo: 'hello' }
       }
     end
 
@@ -50,7 +50,7 @@ RSpec.describe A9n::Struct do
 
     describe '#keys' do
       it do
-        expect(subject.keys).to eq [:non_empty_dwarf, :nil_dwarf, :false_dwarf, :true_dwarf, :hash_dwarf]
+        expect(subject.keys).to eq [:non_empty_foo, :nil_foo, :false_foo, :true_foo, :hash_foo]
       end
     end
 
@@ -69,7 +69,7 @@ RSpec.describe A9n::Struct do
     end
 
     describe '#key?' do
-      it { expect(subject.key?(:nil_dwarf)).to eq(true) }
+      it { expect(subject.key?(:nil_foo)).to eq(true) }
       it { expect(subject.key?(:unknown)).to eq(false) }
     end
 
@@ -77,18 +77,18 @@ RSpec.describe A9n::Struct do
       before { subject.merge(argument) }
 
       context 'hash' do
-        let(:argument) { { non_empty_dwarf: 'hello dwarf' } }
+        let(:argument) { { non_empty_foo: 'hello foo' } }
 
         it do
-          expect(subject.non_empty_dwarf).to eq('hello dwarf')
+          expect(subject.non_empty_foo).to eq('hello foo')
         end
       end
 
       context 'struct' do
-        let(:argument) { described_class.new(non_empty_dwarf: 'hello dwarf') }
+        let(:argument) { described_class.new(non_empty_foo: 'hello foo') }
 
         it do
-          expect(subject.non_empty_dwarf).to eq('hello dwarf')
+          expect(subject.non_empty_foo).to eq('hello foo')
         end
       end
     end
@@ -98,69 +98,69 @@ RSpec.describe A9n::Struct do
     end
 
     it 'gets non-empty value' do
-      expect(subject.non_empty_dwarf).to eq('dwarf')
+      expect(subject.non_empty_foo).to eq('foo')
     end
 
     it 'gets nil value' do
-      expect(subject.nil_dwarf).to eq(nil)
+      expect(subject.nil_foo).to eq(nil)
     end
 
     it 'gets true value' do
-      expect(subject.true_dwarf).to eq(true)
+      expect(subject.true_foo).to eq(true)
     end
 
     it 'gets false value' do
-      expect(subject.false_dwarf).to eq(false)
+      expect(subject.false_foo).to eq(false)
     end
 
     it 'gets hash value' do
-      expect(subject.hash_dwarf).to be_kind_of(Hash)
+      expect(subject.hash_foo).to be_kind_of(Hash)
     end
 
     it 'raises exception when value not exists' do
       expect {
-        subject.non_existing_dwarf
+        subject.non_existing_foo
       }.to raise_error(A9n::NoSuchConfigurationVariableError)
     end
 
     describe '#[]' do
       it 'returns non empty value' do
-        expect(subject[:non_empty_dwarf]).to eq('dwarf')
+        expect(subject[:non_empty_foo]).to eq('foo')
       end
 
       it 'returns false value' do
-        expect(subject[:false_dwarf]).to eq(false)
+        expect(subject[:false_foo]).to eq(false)
       end
 
       it 'returns nil value' do
-        expect(subject[:nil_dwarf]).to eq(nil)
+        expect(subject[:nil_foo]).to eq(nil)
       end
 
       it 'returns nil for non existing key' do
-        expect(subject[:non_existing_dwarf]).to eq(nil)
+        expect(subject[:non_existing_foo]).to eq(nil)
       end
     end
 
     describe '#fetch' do
       it 'returns non empty value' do
-        expect(subject.fetch(:non_empty_dwarf)).to eq('dwarf')
+        expect(subject.fetch(:non_empty_foo)).to eq('foo')
       end
 
       it 'returns false value' do
-        expect(subject.fetch(:false_dwarf)).to eq(false)
+        expect(subject.fetch(:false_foo)).to eq(false)
       end
 
       it 'returns nil value' do
-        expect(subject.fetch(:nil_dwarf)).to eq(nil)
+        expect(subject.fetch(:nil_foo)).to eq(nil)
       end
 
       it 'returns default for non existing value' do
-        expect(subject.fetch(:non_existing_dwarf, 'hello')).to eq('hello')
+        expect(subject.fetch(:non_existing_foo, 'hello')).to eq('hello')
       end
 
       it 'raises error for non existing key' do
         expect {
-          subject.fetch(:non_existing_dwarf)
+          subject.fetch(:non_existing_foo)
         }.to raise_error(KeyError)
       end
     end

data/test_app/benchmark.rb

@@ -6,7 +6,7 @@ require 'a9n'
 class SampleBenchmarkApp
   def run
     0.upto(1_000).map do |index|
-      "#{index} #{::A9n.string_dwarf} #{::A9n.overriden_dwarf}"
+      "#{index} #{::A9n.string_foo} #{::A9n.overriden_foo}"
     end
   end
 

data/test_app/config/a9n.yml

@@ -1,23 +1,25 @@
 defaults:
-  default_dwarf: "default dwarf"
-  overriden_dwarf: "not yet overriden dwarf"
-  erb_dwarf: "<%= ENV['ERB_DWARF'] %>"
-  dwarf_password: :env
+  default_foo: "default foo"
+  overriden_foo: "not yet overriden foo"
+  erb_foo: "<%= ENV['ERB_FOO'] %>"
+  foo_password: :env
 development:
-  nil_dwarf: ~
-  false_dwarf: false
-  true_dwarf: true
-  string_dwarf: "dwarf"
-  overriden_dwarf: "already overriden dwarf"
-  hash_dwarf:
-    dwarf_1: "hello 1"
-    dwarf_2: "hello 2"
+  nil_foo: ~
+  false_foo: false
+  true_foo: true
+  string_foo: "foo"
+  overriden_foo: "already overriden foo"
+  hash_foo:
+    foo_1: "hello 1"
+    foo_2: "hello 2"
+    foo_key: :env
 test:
-  nil_dwarf: ~
-  false_dwarf: false
-  true_dwarf: true
-  string_dwarf: "dwarf"
-  overriden_dwarf: "already overriden dwarf"
-  hash_dwarf:
-    dwarf_1: "hello 1"
-    dwarf_2: "hello 2"
+  nil_foo: ~
+  false_foo: false
+  true_foo: true
+  string_foo: "foo"
+  overriden_foo: "already overriden foo"
+  hash_foo:
+    foo_1: "hello 1"
+    foo_2: "hello 2"
+    foo_key: :env

data/test_app/config/a9n.yml.example

@@ -1,23 +1,23 @@
 defaults:
-  default_dwarf: "example default dwarf"
-  overriden_dwarf: "example not yet overriden dwarf"
-  erb_dwarf: "<%= ENV['ERB_DWARF'] %>"
-  dwarf_password: :env
+  default_foo: "example default foo"
+  overriden_foo: "example not yet overriden foo"
+  erb_foo: "<%= ENV['ERB_FOO'] %>"
+  foo_password: :env
 development:
-  nil_dwarf: ~
-  false_dwarf: false
-  true_dwarf: true
-  string_dwarf: "dwarf"
-  overriden_dwarf: "example already overriden dwarf"
-  hash_dwarf:
-    dwarf_1: "hello 1"
-    dwarf_2: "hello 2"
+  nil_foo: ~
+  false_foo: false
+  true_foo: true
+  string_foo: "foo"
+  overriden_foo: "example already overriden foo"
+  hash_foo:
+    foo_1: "hello 1"
+    foo_2: "hello 2"
 test:
-  nil_dwarf: ~
-  false_dwarf: false
-  true_dwarf: true
-  string_dwarf: "dwarf"
-  overriden_dwarf: "example already overriden dwarf"
-  hash_dwarf:
-    dwarf_1: "hello 1"
-    dwarf_2: "hello 2"
+  nil_foo: ~
+  false_foo: false
+  true_foo: true
+  string_foo: "foo"
+  overriden_foo: "example already overriden foo"
+  hash_foo:
+    foo_1: "hello 1"
+    foo_2: "hello 2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: a9n
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Krzysztof Knapik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter