app_konfig 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acc70f7bfa0cce596647ce885058b92dd7f213b9
-  data.tar.gz: c9dd25965b13dc90aacc2e9f1af645b6a8373e40
+  metadata.gz: 508ea468ebcc191b9230fccb19e2f78efafbbd66
+  data.tar.gz: 435157082976316f89fe77524c018e995289bdba
 SHA512:
-  metadata.gz: e095dd35cde544a0a8dbb1546b7ff02ed548940519c9c30e2ab466af512b2a4deccde90f84234e0293646e64a62295c174f18148ef074e5e787c2e6f6d9d0757
-  data.tar.gz: c8cce7af00dd510bcd93d33d042e862b5ab62c82032966ecf18c0f2964074f2ac2098fcc330e69cedf78f15e2f40fff58453b8b826036fcb6200025bb79b1cc2
+  metadata.gz: 8da018cdeba86d2686aa45094deeeb5c2308a4aa88f40a6bf35032d74ec87294fb88285653634d038d016799875e784a6223537677bef22ec84abe6c6e3db46d
+  data.tar.gz: 8f9901d4d54a94a53df8fd61392db82e53017972c5b4ed5718879d124d0c6cd878e22dad7b2a705b81f9ab018279401b3bca23fa0ccc454ead7dc1a220b35596

data/CHANGELOG.MD

@@ -1,3 +1,9 @@
+1.0.0
+
+- Add a getter method to solve some conflicts with configuration keys (@mtczerwinski)
+- Add test (@mtczerwinski)
+- Add information into readme (@mtczerwinski)
+
 0.1.0
 
 - Lessen rails dependency - minimal version is now 3.0 (@nekath)

data/README.md

@@ -52,6 +52,12 @@ AppConfig.value
 AppConfig.proxy.ip
 AppConfig.secret_key
 ```
+or
+```ruby
+AppConfig.get('value')
+AppConfig.get('proxy.ip')
+AppConfig.get('secret_key')
+```
 
 ## Contributing
 

data/config/secrets.yml

@@ -1,6 +1,15 @@
 production:
+  key: "key"
+  keys: 123456789
   hostname: 'production.example.com'
   array_key:
     - first_new
     - second_new
     - third_new
+  other:
+    values:
+      - first_old
+      - second_old
+      - third_old
+  values: 'James Bond'
+  value: ''

data/lib/app_konfig/config.rb

@@ -3,6 +3,8 @@ require 'yaml'
 require 'erb'
 
 module AppKonfig
+  class ConfigurationKeyNotFound < Exception ; end
+
   class Config < Hash
     DEFAULT_ENV = 'development'
     CONFIG_PATH = {
@@ -15,6 +17,12 @@ module AppKonfig
       deep_merge!(pub_config).deep_merge!(sec_config)
     end
 
+    def get(args)
+        args.split('.').inject(self) { |hash, arg| hash.fetch(arg) }
+      rescue KeyError
+        raise AppKonfig::ConfigurationKeyNotFound.new("configuration key not found")
+    end
+
     def method_missing(key)
       key = key.to_s
       return self[key] unless self[key].is_a?(Hash)

data/lib/app_konfig/version.rb

@@ -1,3 +1,3 @@
 module AppKonfig
-  VERSION = '0.1.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/spec/app_konfig_spec.rb

@@ -2,35 +2,83 @@ require 'spec_helper'
 require 'app_konfig/config'
 
 RSpec.describe AppKonfig::Config do
-  it 'is a Hash' do
-    expect(subject).to be_a(Hash)
-  end
+  context '#get' do
+    it 'loads config based on RAILS_ENV' do
+      allow(ENV).to receive(:fetch).and_return('test')
+      expect(subject.get('hostname')).to eq('test.example.com')
+    end
 
-  it 'loads config based on RAILS_ENV' do
-    allow(ENV).to receive(:fetch).and_return('test')
-    expect(subject.hostname).to eq('test.example.com')
-  end
+    it 'uses development config by default' do
+      expect(described_class::DEFAULT_ENV).to eq('development')
+      expect(subject.get('hostname')).to eq('example.com')
+    end
 
-  it 'uses development config by default' do
-    expect(described_class::DEFAULT_ENV).to eq('development')
-    expect(subject.hostname).to eq('example.com')
-  end
+    it 'handles nested keys' do
+      expect(subject.get('proxy.port')).to eq(3000)
+    end
 
-  it 'handles nested keys' do
-    expect(subject.proxy.port).to eq(3000)
-  end
+    it 'merges config from secrets file' do
+      allow(ENV).to receive(:fetch).and_return('production')
+      expect(subject.get('hostname')).to eq('production.example.com')
+      expect(subject.get('array_key')).to eq(['first_new', 'second_new', 'third_new'])
+    end
+
+    it 'allows to use a configuration names the same as methods from the Hash class' do
+      allow(ENV).to receive(:fetch).and_return('production')
+      expect(subject.get('keys')).to eq(123456789)
+      expect(subject.get('key')).to eq("key")
+      expect(subject.get('other.values')).to eq(["first_old", "second_old", "third_old"])
+      expect(subject.get('values')).to eq("James Bond")
+      expect(subject.get('value')).to eq("")
+    end
 
-  it 'merges config from secrets file' do
-    allow(ENV).to receive(:fetch).and_return('production')
-    expect(subject.hostname).to eq('production.example.com')
-    expect(subject.array_key).to eq(['first_new', 'second_new', 'third_new'])
+    it 'raises exception when a configuration key was not found' do
+      allow(ENV).to receive(:fetch).and_return('production')
+      expect { subject.get('test.test3.test2.test1') }.to raise_error(AppKonfig::ConfigurationKeyNotFound)
+    end
+
+    it 'allows to embed ruby inside a config file' do
+      allow(ENV).to receive(:[]).with('SECRET_KEY').and_return('value_from_env')
+      expect(subject.get('secret_key')).to eq('value_from_env')
+    end
   end
 
-  it 'allows to embed ruby inside a config file' do
-    allow(ENV).to receive(:[]).with('SECRET_KEY').and_return('value_from_env')
-    expect(subject.secret_key).to eq('value_from_env')
+  context 'a chain method invoking' do
+    it 'loads config based on RAILS_ENV' do
+      allow(ENV).to receive(:fetch).and_return('test')
+      expect(subject.hostname).to eq('test.example.com')
+    end
+
+    it 'uses development config by default' do
+      expect(described_class::DEFAULT_ENV).to eq('development')
+      expect(subject.hostname).to eq('example.com')
+    end
+
+    it 'handles nested keys' do
+      expect(subject.proxy.port).to eq(3000)
+    end
+
+    it 'merges config from secrets file' do
+      allow(ENV).to receive(:fetch).and_return('production')
+      expect(subject.hostname).to eq('production.example.com')
+      expect(subject.array_key).to eq(['first_new', 'second_new', 'third_new'])
+    end
+
+    it 'allows to use a configuration names the same as methods from the Hash class' do
+      allow(ENV).to receive(:fetch).and_return('production')
+      expect(subject.keys).to eq ["hostname", "key", "keys", "array_key", "other", "values", "value"]
+      expect(subject.other.values).to eq([["first_old", "second_old", "third_old"]])
+      expect(subject.values).to eq ["production.example.com", "key", 123456789, ["first_new", "second_new", "third_new"], {"values"=>["first_old", "second_old", "third_old"]}, "James Bond", ""]
+      expect(subject.value).to eq("")
+    end
+
+    it 'allows to embed ruby inside a config file' do
+      allow(ENV).to receive(:[]).with('SECRET_KEY').and_return('value_from_env')
+      expect(subject.secret_key).to eq('value_from_env')
+    end
   end
 
+
   context 'when secrets file is not found' do
     it 'fails silently' do
       stub_const('AppKonfig::Config::CONFIG_PATH', {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_konfig
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Bartosz Kopiński
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-05 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport