elasticonf 1.0.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d4cb7fab94c126c86f3bed8843b45aa68fe7caf
+  data.tar.gz: 5d7f9d9fde89b9d4f1c9bc15b188e4a00194f224
+SHA512:
+  metadata.gz: 11ee18dd6df50ebb4791652272468d1b53d9a5ca5e2f967f7b467c23a98e86b85566ce0e7fec7dccf4d88eed2c8c0fb5c386a54a71bb1aad02d083e1eca84cd3
+  data.tar.gz: d2a9bcb6c914c3df134528579ef47e45c76e408c57d8d457081330b6495920e989b312085dafc9c8074f1360bcda18c93c160eaa25abccf3892d0f947f71c0d7

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+.yardoc
+doc
+pkg
+vendor/bundle

data/.rspec

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

data/.yardopts

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    elasticonf (1.0.0.beta)
+      hashie
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    hashie (2.1.1)
+    rake (10.3.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  elasticonf!
+  rake
+  rspec
+  yard

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Sergey Rezvanov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,39 @@
+ElastiConf
+==========
+
+Powerfull and flexible application config solution worked in any ruby program. No clases definition, no dependencies. It just works!
+
+## Installation
+
+First add the following lines to your application `Gemfile`:
+
+``` ruby
+gem 'elasticonf', '~> 1.0.0.beta'
+```
+
+Then run `bundle install` to update your's gems bundle.
+
+## Configuration
+
+Will be available soon.
+
+## Documentation
+
+Will be available soon.
+
+## Testing
+
+Run this commands in terminal:
+
+0. `cd some/path`
+0. `git clone git@github.com:rezwyi/elasticonf.git`
+0. `cd elasticonf/`
+0. `bin/rspec`
+
+## Versioning
+
+ElastiConf uses RubyGems Rational Versioning Policy.
+
+## Copyright
+
+See LICENSE file.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler::GemHelper.install_tasks

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/yard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

data/bin/yardoc

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yardoc')

data/bin/yri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yri')

data/elasticonf.gemspec

@@ -0,0 +1,25 @@
+require File.expand_path('../lib/elasticonf/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'elasticonf'
+  s.summary = 'Powerfull and flexible application config solution worked in any ruby program'
+  s.description = s.summary
+
+  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'
+
+  s.licenses = ['MIT']
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_dependency 'hashie'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'yard'
+end

data/lib/elasticonf/config.rb

@@ -0,0 +1,62 @@
+module ElastiConf
+  module Config
+    def configure
+      yield self
+    end
+
+    def reset_config!
+      %w(
+        config_root
+        config_file
+        const_name
+        raise_if_already_initialized_constant
+      ).each do |v|
+        instance_variable_set "@#{v}", nil
+      end
+    end
+
+    def config_root
+      @config_root ||= raise(ArgumentError, 'You must first specify config root')
+    end
+
+    def config_root=(value)
+      unless [String, Symbol, Pathname].include?(value.class)
+        raise ArgumentError, "String or Pathname expected #{value.class} given"
+      end
+      @config_root = value.is_a?(String) ? Pathname.new(value.to_s) : value
+    end
+
+    def config_file
+      @config_file ||= 'config'
+    end
+
+    def config_file=(value)
+      unless [String, Symbol].include?(value.class)
+        raise ArgumentError, "String or Symbol expected #{value.class} given"
+      end
+      @config_file = value
+    end
+
+    def const_name
+      @const_name ||= 'Settings'
+    end
+
+    def const_name=(value)
+      unless [String, Symbol].include?(value.class)
+        raise ArgumentError, "String or Symbol expected #{value.class} given"
+      end
+      @const_name = value.to_s
+    end
+
+    def raise_if_already_initialized_constant
+      @raise_if_already_initialized_constant.nil? ? true : @raise_if_already_initialized_constant
+    end
+
+    def raise_if_already_initialized_constant=(value)
+      unless [TrueClass, FalseClass].include?(value.class)
+        raise ArgumentError, "TrueClass or FalseClass expected #{value.class} given"
+      end
+      @raise_if_already_initialized_constant = value
+    end
+  end
+end

data/lib/elasticonf/loader.rb

@@ -0,0 +1,4 @@
+module ElastiConf
+  class Loader < Hashie::Mash
+  end
+end

data/lib/elasticonf/version.rb

@@ -0,0 +1,3 @@
+module ElastiConf
+  VERSION = '1.0.0.beta'
+end

data/lib/elasticonf.rb

@@ -0,0 +1,40 @@
+require 'hashie'
+require 'yaml'
+
+require 'elasticonf/version'
+require 'elasticonf/config'
+require 'elasticonf/loader'
+
+module ElastiConf
+  extend Config
+
+  module_function
+
+  def root
+    @root ||= Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '..')))
+  end
+
+  def load!(env = nil)
+  	const_name = ElastiConf.const_name
+  	config_file = ElastiConf.config_root.join(ElastiConf.config_file + '.yml')
+    
+    env_config_file = env ?
+      ElastiConf.config_root.join(ElastiConf.config_file, "#{env}.yml") :
+      nil
+    
+    raise("Config file #{config_file} not found. Cannot continue") unless File.exists?(config_file)
+    
+    config = Loader[YAML.load_file(config_file)]
+    if env_config_file && File.exists?(env_config_file)
+      config = config.deep_merge(Loader[YAML.load_file(env_config_file)])
+    end
+    
+    if Kernel.const_defined?(const_name)
+      raise_if_already_initialized_constant ?
+        raise("Cannot set constant #{const_name} because it is already initialized") :
+        Kernel.send(:remove_const, const_name)
+    end
+    
+    Kernel.const_set const_name, config
+  end
+end

data/spec/fixtures/application/production.yml

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

data/spec/fixtures/application/test.yml

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

data/spec/fixtures/application.yml

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

data/spec/fixtures/config.yml

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

data/spec/lib/elasticonf/config_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe ElastiConf::Config do
+  it 'should be a module' do
+    subject.should be_a(Module)
+  end
+end

data/spec/lib/elasticonf/loader_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe ElastiConf::Loader do
+  it 'should be inherited from Hashie::Mash' do
+    subject.should be_kind_of(Hashie::Mash)
+  end
+end

data/spec/lib/elasticonf_spec.rb

@@ -0,0 +1,221 @@
+require 'spec_helper'
+
+describe ElastiConf do
+  it { should be_a(Module) }
+
+  describe '#configure' do
+    before do
+      subject.configure do |config|
+        config.config_root = '/config'
+        config.config_file = 'application'
+        config.const_name = 'AppSettings'
+        config.raise_if_already_initialized_constant = false
+      end
+    end
+
+    its(:config_root) { should eql(Pathname('/config')) }
+    its(:config_file) { should eql('application') }
+    its(:const_name) { should eql('AppSettings') }
+    its(:raise_if_already_initialized_constant) { should be_false }
+  end
+
+  describe '#reset_config!' do
+    before { subject.reset_config! }
+
+    its(:config_file) { should eql('config') }
+    its(:const_name) { should eql('Settings') }
+    its(:raise_if_already_initialized_constant) { should be_true }
+
+    it 'should raise an error' do
+      expect { subject.config_root }.to raise_error
+    end
+  end
+
+  describe '#config_root' do
+    it 'should raise an error' do
+      expect { subject.config_root }.to raise_error
+    end
+
+    it 'should return some value' do
+      subject.config_root = '/config'
+      subject.config_root.should eql(Pathname.new('/config'))
+    end
+
+    context 'when wrong argument given' do
+      it 'should raise an error' do
+        expect { subject.config_root = -> {} }.to raise_error
+      end
+
+      it 'should raise an error' do
+        expect { subject.config_root = {} }.to raise_error
+      end
+
+      it 'should raise an error' do
+        expect { subject.config_root = [] }.to raise_error
+      end
+    end
+  end
+
+  describe '#config_file' do
+    its(:config_file) { should eql('config') }
+
+    it 'should return some value' do
+      expect {
+        subject.config_file = 'application'
+      }.to change(subject, :config_file).to('application')
+    end
+
+    context 'when wrong argument given' do
+      it 'should raise an error' do
+        expect { subject.config_file = -> {} }.to raise_error
+      end
+
+      it 'should raise an error' do
+        expect { subject.config_file = {} }.to raise_error
+      end
+
+      it 'should raise an error' do
+        expect { subject.config_file = [] }.to raise_error
+      end
+    end
+  end
+
+  describe '#const_name' do
+    its(:const_name) { should eql('Settings') }
+
+    it 'should return some value' do
+      expect {
+        subject.const_name = 'AppSettings'
+      }.to change(subject, :const_name).to('AppSettings')
+    end
+
+    it 'should return some value' do
+      expect {
+        subject.const_name = :'AppSettings'
+      }.to change(subject, :const_name).to('AppSettings')
+    end
+
+    context 'when wrong argument given' do
+      it 'should raise an error' do
+        expect { subject.const_name = -> {} }.to raise_error
+      end
+
+      it 'should raise an error' do
+        expect { subject.const_name = {} }.to raise_error
+      end
+
+      it 'should raise an error' do
+        expect { subject.const_name = [] }.to raise_error
+      end
+    end
+  end
+
+  describe '#raise_if_already_initialized_constant' do
+    its(:raise_if_already_initialized_constant) { should be_true }
+
+    it 'should change to false' do
+      expect {
+        subject.raise_if_already_initialized_constant = false
+      }.to change(subject, :raise_if_already_initialized_constant).to(false)
+    end
+
+    context 'when wrong argument given' do
+      it 'should raise an error' do
+        expect {
+          subject.raise_if_already_initialized_constant = 'some_string'
+        }.to raise_error
+      end
+
+      it 'should raise an error' do
+        expect {
+          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 = -> {}
+        }.to raise_error
+      end
+
+      it 'should raise an error' do
+        expect {
+          subject.raise_if_already_initialized_constant = {}
+        }.to raise_error
+      end
+
+      it 'should raise an error' do
+        expect {
+          subject.raise_if_already_initialized_constant = []
+        }.to raise_error
+      end
+    end
+  end
+
+  describe '#root' do
+    its(:root) do
+      should eql(Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))))
+    end
+  end
+
+  describe '#load!' do
+    before do
+      subject.configure do |config|
+        config.config_root = ElastiConf.root.join('spec', 'fixtures')
+        config.config_file = 'application'
+        config.const_name = const_name
+      end
+    end
+
+    after do
+      Kernel.send :remove_const, const_name
+    end
+
+    let(:const_name) { 'AppSettings' }
+
+    it 'should not raise an error' do
+      expect { subject.load! }.not_to raise_error
+    end
+
+    it 'should load some configuration' do
+      subject.load!
+      expect(AppSettings.some_config.int_key).to eql(1)
+    end
+
+    it 'should load some configuration' do
+      subject.load!
+      expect(AppSettings.some_config.str_key).to eql('1')
+    end
+
+    context 'when some env given' do
+      let(:env) { :test }
+      
+      it 'should not raise an error' do
+        expect { subject.load!(env) }.not_to raise_error
+      end
+
+      it 'should load some configuration' do
+        subject.load! env
+        expect(AppSettings.some_config.int_key).to eql(2)
+      end
+
+      it 'should load some configuration' do
+        subject.load! env
+        expect(AppSettings.some_config.str_key).to eql('2')
+      end
+    end
+
+    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
+
+      it 'should not raise an error' do
+        subject.raise_if_already_initialized_constant = false
+        expect { subject.load! }.not_to raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'bundler'
+Bundler.require :default
+
+require 'elasticonf'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # After each test spec rollback configuration to its default state
+  config.after(:each) { ElastiConf.reset_config! }
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: elasticonf
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta
+platform: ruby
+authors:
+- Sergey Rezvanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Powerfull and flexible application config solution worked in any ruby
+  program
+email:
+- sergey@rezvanov.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/autospec
+- bin/rake
+- bin/rspec
+- bin/yard
+- bin/yardoc
+- bin/yri
+- elasticonf.gemspec
+- lib/elasticonf.rb
+- lib/elasticonf/config.rb
+- lib/elasticonf/loader.rb
+- lib/elasticonf/version.rb
+- spec/fixtures/application.yml
+- spec/fixtures/application/production.yml
+- spec/fixtures/application/test.yml
+- spec/fixtures/config.yml
+- spec/lib/elasticonf/config_spec.rb
+- spec/lib/elasticonf/loader_spec.rb
+- spec/lib/elasticonf_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rezwyi/elasticonf
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Powerfull and flexible application config solution worked in any ruby program
+test_files: []
+has_rdoc: