elasticonf 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa70ead7bcaae31e24429db8b9054eb62aaef07a
-  data.tar.gz: 5a0e3c812f8b3e9454d05ce74ac06a2fff6cc408
+  metadata.gz: c7d9d65ebdccdbdabb548b8b36628247765a3ce3
+  data.tar.gz: ee94d162f67b29f3caca0df5296d6381a5cf9df9
 SHA512:
-  metadata.gz: b36e15f8901a3aaee7a635550ea462e29d08d64d14634a2f4907ff89764796a0865275f9918c896adea09bddb693c706a2150a7336f251f0f5dd0dd6047df384
-  data.tar.gz: 1aadce5ac6ce226e40c2de0dfb176275d6e9e2873534fa6b1f5c40f5cb2d5f4f2a9fb78279e990e6daccb9af7e37b9bb7f73d02d8f468174dc8b4225c0fef361
+  metadata.gz: 4aed8f70ff65d966b3658b61ed55e7bc320f55743f7b8127b342db722b6a3158eac3925b5f762909fe3be6780322502784b070372eefe73ed3e06c3a51052168
+  data.tar.gz: 24a0acd93cfbdba4edbbd14df9c2d3ae310e92892d8d72deeda9a567deddbb5b579c33cd5404b73b232504f06821d2e32887211ac146e449bff102e2f90eb4ec

data/.gitignore

@@ -3,4 +3,4 @@
 doc
 pkg
 vendor/bundle
-coverage/
+coverage/

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format progress
+--format progress

data/.travis.yml

@@ -1,22 +1,26 @@
 language: ruby
 
 rvm:
-  - ruby-head
-  - jruby-head
-  - rbx-head
-  - 2.1.2
-  - 2.1.1
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
   - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.10
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
 
 matrix:
   allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: rbx-head
+    - rvm: 1.9.2
+    - rvm: 1.9.3
+    - rvm: 2.0.0
+    - rvm: 2.1.10
+    - rvm: 2.2.9
 
 branches:
   only:
-    - master
+    - master
+
+before_install:
+  - gem install bundler

data/.yardopts

@@ -1,2 +1,2 @@
 --main README.md
---no-private
+--no-private

data/Gemfile

@@ -4,4 +4,4 @@ gemspec
 
 group :test do
   gem 'coveralls', require: false
-end
+end

data/Gemfile.lock

@@ -1,28 +1,24 @@
 PATH
   remote: .
   specs:
-    elasticonf (1.1.3)
-      hashie (>= 2.0)
+    elasticonf (1.1.4)
+      hashie (~> 3.0)
+      semantic (> 0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coveralls (0.7.1)
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      term-ansicolor
-      thor
-    diff-lcs (1.2.5)
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
     docile (1.1.5)
-    hashie (3.3.1)
-    mime-types (2.3)
-    multi_json (1.10.1)
-    netrc (0.7.7)
-    rake (10.3.2)
-    rest-client (1.7.2)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
+    hashie (3.5.7)
+    json (2.1.0)
+    rake (10.5.0)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
@@ -31,16 +27,17 @@ GEM
     rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.6)
-    simplecov (0.9.0)
+    semantic (1.6.0)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
-      multi_json
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    term-ansicolor (1.3.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
       tins (~> 1.0)
-    thor (0.19.1)
-    tins (1.3.2)
-    yard (0.8.7.4)
+    thor (0.19.4)
+    tins (1.16.3)
+    yard (0.9.12)
 
 PLATFORMS
   ruby
@@ -48,6 +45,9 @@ PLATFORMS
 DEPENDENCIES
   coveralls
   elasticonf!
-  rake (~> 10.3)
+  rake (~> 10.0)
   rspec (~> 2.14.0)
   yard (~> 0.8)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,25 +1,103 @@
+<img align="left" src="/logo.png?raw=true"></img>
+
 Elasticonf [![Build Status](https://travis-ci.org/rezwyi/elasticonf.svg?branch=master)](https://travis-ci.org/rezwyi/elasticonf) [![Dependency Status](https://gemnasium.com/rezwyi/elasticonf.svg)](https://gemnasium.com/rezwyi/elasticonf) [![Coverage Status](https://img.shields.io/coveralls/rezwyi/elasticonf.svg)](https://coveralls.io/r/rezwyi/elasticonf)
 ==========
 
+<br />
+
 Powerfull and flexible application config solution worked in any ruby program. No clases definition, no dependencies. It just works!
 
+## Prerequisites
+
+You need to have Ruby 2.0 or higher installed on your system.
+
 ## Installation
 
 First add the following lines to your application `Gemfile`:
 
-``` ruby
-gem 'elasticonf', '~> 1.1.0'
+```ruby
+gem 'elasticonf', '~> 1.1.4'
 ```
 
 Then run `bundle install` to update your's gems bundle.
 
-## Configuration
+## Setup and usage
+
+For basic setup you must pass a block to `Elasticonf.configure` method and call `Elasticonf.load!`.
+
+To load settings from the file `some/path/settings.yml` and define `Settings` constant, you need to run the following code:
+
+```ruby
+require 'elasticonf'
+
+Elasticonf.configure do |config|
+  config.config_root = 'some/path'
+end
+
+Elasticonf.load!
+puts Settings.some_key # will print some value
+```
+
+To load settings from the file `some/path/config.yml` and define `Config` constant, you need:
+
+```ruby
+require 'elasticonf'
+
+Elasticonf.configure do |config|
+  config.config_root = 'some/path'
+  config.config_file = 'config'
+  config.constant_name = 'Config'
+end
+
+Elasticonf.load!
+puts Config.some_key # will print some value
+```
+
+There is also support for multi environment. To do this change the value of the `config.env` (the default is `'development'`).
 
-Will be available soon.
+Elasticonf supports the following priorities of files (the priority decreases from top to bottom). For the default configuration:
+
+0. `#{Elasticonf.config_root}/settings.local.yml`
+0. `#{Elasticonf.config_root}/settings/development.yml`
+0. `#{Elasticonf.config_root}/settings.yml`
+
+Sometimes there can be a situation when the constant defined Elasticonf already exists. In this case, exception will raise and method execution will stop. To change this behavior you need to set `config.raise_if_already_initialized_constant` to `false`. Take a look:
+
+```ruby
+require 'elasticonf'
+
+Settings = "I'm predefined constant!"
+
+Elasticonf.configure do |config|
+  config.config_root = 'some/path'
+end
+
+Elasticonf.load! # will raise RuntimeError "Cannot set constant Settings because it is already initialized"
+```
+
+However, this code is okay:
+
+```ruby
+require 'elasticonf'
+
+Settings = "I'm predefined constant!"
+
+Elasticonf.configure do |config|
+  config.config_root = 'some/path'
+  config.raise_if_already_initialized_constant = false
+end
+
+Elasticonf.load! # will not raise any error
+puts Settings.some_key # will print some value
+```
 
 ## Documentation
 
-Will be available soon.
+Run this commands in terminal:
+
+0. `cd path/to/elasticonf/repo`
+0. `bin/yard server`
+0. Go to [http://localhost:8808](http://localhost:8808) (by default) in your favorite browser
 
 ## Testing
 
@@ -37,4 +115,4 @@ Elasticonf uses RubyGems Rational Versioning Policy.
 
 ## Copyright
 
-See LICENSE file.
+See LICENSE file.

data/Rakefile

@@ -8,4 +8,4 @@ RSpec::Core::RakeTask.new do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
 end
 
-task default: :spec
+task default: :spec

data/elasticonf.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
 
   s.version  = Elasticonf::VERSION
   s.platform  = Gem::Platform::RUBY
-  
+
   s.authors = ['Sergey Rezvanov']
   s.email = ['sergey@rezvanov.info']
   s.homepage = 'https://github.com/rezwyi/elasticonf'
@@ -19,9 +19,10 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 1.9'
 
-  s.add_dependency 'hashie', '>= 2.0'
+  s.add_dependency 'hashie', '~> 3.0'
+  s.add_dependency 'semantic', '> 0'
 
-  s.add_development_dependency 'rake', '~> 10.3'
+  s.add_development_dependency 'rake', '~> 10.0'
   s.add_development_dependency 'rspec', '~> 2.14.0'
   s.add_development_dependency 'yard', '~> 0.8'
 end

data/lib/elasticonf.rb

@@ -29,7 +29,7 @@ module Elasticonf
     end
 
     loader = Loader[YAML.load_file(config_file)]
-    
+
     env_config_file = config.config_root.join(config.config_file, "#{config.env}.yml")
     if File.exists?(env_config_file)
       loader = loader.deep_merge(Loader[YAML.load_file(env_config_file)])
@@ -39,13 +39,13 @@ module Elasticonf
     if File.exists?(local_config_file)
       loader = loader.deep_merge(Loader[YAML.load_file(local_config_file)])
     end
-    
+
     if Kernel.const_defined?(config.const_name)
       config.raise_if_already_initialized_constant ?
         raise("Cannot set constant #{config.const_name} because it is already initialized") :
         Kernel.send(:remove_const, config.const_name)
     end
-    
+
     Kernel.const_set config.const_name, loader
   end
 
@@ -60,4 +60,4 @@ module Elasticonf
     configure { |config| yield(config) }
     load!
   end
-end
+end

data/lib/elasticonf/config.rb

@@ -11,7 +11,7 @@ module Elasticonf
         instance_variable_set "@#{v}", nil
       end
     end
-    
+
     def env
       @env ||= 'development'
     end
@@ -67,4 +67,4 @@ module Elasticonf
       @raise_if_already_initialized_constant = value
     end
   end
-end
+end

data/lib/elasticonf/loader.rb

@@ -1,17 +1,25 @@
+require 'semantic'
+
 module Elasticonf
   class Loader < Hashie::Mash
     def get(key)
       unless [String, Symbol].include?(key.class)
         raise ArgumentError, "String or Symbol expected #{key.class} given"
       end
-      
-      hash, items = self, key.split('.')
-      
-      while (item = items.shift)
-        (hash = hash[item.to_sym]) || break
-      end
 
-      hash
+      ruby_version = Semantic::Version.new(RUBY_VERSION)
+
+      if ruby_version.major == 2 && ruby_version.minor >= 3
+        dig *key.split('.')
+      else
+        result, items = self.dup, key.split('.')
+
+        while (item = items.shift)
+          (result = result[item.to_sym]) || break
+        end
+
+        result
+      end
     end
   end
-end
+end

data/lib/elasticonf/version.rb

@@ -1,3 +1,3 @@
 module Elasticonf
-  VERSION = '1.1.3'
-end
+  VERSION = '1.1.4'
+end

data/spec/fixtures/application.yml

@@ -1,3 +1,3 @@
 some_config:
   int_key: 1
-  str_key: '1'
+  str_key: '1'

data/spec/fixtures/application/production.yml

@@ -1,3 +1,3 @@
 some_config:
   int_key: 3
-  str_key: '3'
+  str_key: '3'

data/spec/fixtures/application/test.yml

@@ -1,3 +1,3 @@
 some_config:
   int_key: 2
-  str_key: '2'
+  str_key: '2'

data/spec/fixtures/config.yml

@@ -1,3 +1,3 @@
 some_config:
   int_key: 1
-  str_key: '1'
+  str_key: '1'

data/spec/lib/elasticonf/config_spec.rb

@@ -8,10 +8,10 @@ describe Elasticonf::Config do
       subject.config_file = 'application'
       subject.const_name = 'AppSettings'
       subject.raise_if_already_initialized_constant = false
-      
+
       subject.reset_config!
     end
-    
+
     its(:env) { should eql('development') }
     its(:config_file) { should eql('settings') }
     its(:const_name) { should eql('Settings') }
@@ -144,7 +144,7 @@ describe Elasticonf::Config do
           subject.raise_if_already_initialized_constant = :some_symbol
         }.to raise_error
       end
-      
+
       it 'should raise an error' do
         expect {
           subject.raise_if_already_initialized_constant = -> {}
@@ -164,4 +164,4 @@ describe Elasticonf::Config do
       end
     end
   end
-end
+end

data/spec/lib/elasticonf/loader_spec.rb

@@ -5,7 +5,7 @@ describe Elasticonf::Loader do
     file = Elasticonf.root.join('spec', 'fixtures', 'config.yml')
     described_class[YAML.load_file(file)]
   end
-  
+
   it 'should be inherited from Hashie::Mash' do
     subject.should be_kind_of(Hashie::Mash)
   end
@@ -14,7 +14,7 @@ describe Elasticonf::Loader do
     it 'should return nil' do
       expect(subject.get('some.unexisting.key')).to be_nil
     end
-    
+
     it 'should return some value' do
       expect(subject.get('some_config.int_key')).to eql(1)
     end
@@ -27,7 +27,7 @@ describe Elasticonf::Loader do
       it 'should raise an error' do
         expect { subject.get }.to raise_error
       end
-      
+
       it 'should raise an error' do
         expect { subject.get({}) }.to raise_error
       end
@@ -41,4 +41,4 @@ describe Elasticonf::Loader do
       end
     end
   end
-end
+end

data/spec/lib/elasticonf_spec.rb

@@ -73,7 +73,7 @@ describe Elasticonf do
 
     context 'when some env given (as argument)' do
       let(:env) { :test }
-      
+
       it 'should not raise an error' do
         expect { subject.load!(env) }.not_to raise_error
       end
@@ -109,7 +109,7 @@ describe Elasticonf do
 
     context 'when already initialized constant' do
       before { Kernel.const_set(const_name, {}) }
-      
+
       it 'should raise an error' do
         expect { subject.load! }.to raise_error
       end
@@ -123,7 +123,7 @@ describe Elasticonf do
     context 'when .local file present' do
       let(:config_file) { subject.config.config_root.join('application.yml') }
       let(:local_config_file) { subject.config.config_root.join('application.local.yml') }
-      
+
       before do
         YAML::load_file(config_file).tap do |config|
           config['some_config']['str_key'] = 'local'
@@ -142,7 +142,7 @@ describe Elasticonf do
         subject.load!
         expect(AppSettings.some_config.int_key).to eql(1)
       end
-      
+
       it 'should override values from config file' do
         subject.load!
         expect(AppSettings.some_config.str_key).to eql('local')
@@ -189,14 +189,14 @@ describe Elasticonf do
   describe '#reload!' do
     let(:config_file) { subject.config.config_root.join('application.yml') }
     let(:bak_file) { subject.config.config_root.join('application.bak') }
-    
+
     before do
       subject.configure do |config|
         config.config_root = subject.root.join('spec', 'fixtures')
         config.config_file = 'application'
         config.const_name = 'AppSettings'
       end
-      
+
       subject.load!
 
       # Assume that our configuration has been changed since we have already
@@ -217,14 +217,14 @@ describe Elasticonf do
 
   describe '#configure_and_load!' do
     before { Elasticonf.stub(:load!).and_return(true) }
-    
+
     let(:config_block) do
       Proc.new do |config|
         config.config_root = subject.root.join('spec', 'fixtures')
         config.raise_if_already_initialized_constant = false
       end
     end
-    
+
     it 'should call configure' do
       subject.should_receive :configure
       subject.configure_and_load! &config_block
@@ -235,4 +235,4 @@ describe Elasticonf do
       subject.configure_and_load! &config_block
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -12,4 +12,4 @@ RSpec.configure do |config|
 
   # After each test spec rollback configuration to its default state
   config.after(:each) { Elasticonf.config.reset_config! }
-end
+end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: elasticonf
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Sergey Rezvanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-15 00:00:00.000000000 Z
+date: 2018-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: semantic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,7 @@ files:
 - lib/elasticonf/config.rb
 - lib/elasticonf/loader.rb
 - lib/elasticonf/version.rb
+- logo.png
 - spec/fixtures/application.yml
 - spec/fixtures/application/production.yml
 - spec/fixtures/application/test.yml
@@ -122,9 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Powerfull and flexible application config solution worked in any ruby program
 test_files: []
-has_rdoc: