config_for 0.1.2 → 0.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0140a146eebc3856380341e7b08fabbe9c778e54
-  data.tar.gz: bbb183467237d3654193569b17a3c5765c5a7d5b
+  metadata.gz: 8f3f3b81d68611878491f67a0014bb0d1f8bc13d
+  data.tar.gz: 6c954ff1b4082e9b8b6c7bfa59fae50357427090
 SHA512:
-  metadata.gz: d7e54d525bd1c4a6cfe8f14bf6365ab2ae101980352259b74fa9fe5e4b695df63d8af094df919e569ae6e28de2c03741681617887d5c61abea9672332c2bc715
-  data.tar.gz: 64564734a19fafaf3691322dd719ea94576fa79aa56b9669c368d8088d14d7aad774765b6023ce7eac2a1a2c01867faf8f0b37172bfa39c28ee524e96abf8c3b
+  metadata.gz: 1f7bb67663da4cbd96470890c8e2e88f66ba2d5c4e3ecf413d2d59967a116ed7dd5a56030f95ddac0159e40912c7b50fabe957383e91f68ad30f58d4c6a0fdf0
+  data.tar.gz: 2b8738ab9ef1edd4beceff12116d13235202f837afd7d895439a6402a20bbc05e30b198c16b74fcce9fc4c56ef7b37f2f69fc0e020404bd0dc412d39992d00ca

data/.travis.yml

@@ -8,3 +8,6 @@ rvm:
 - 2.1.2
 - 2.0.0
 - 1.9.3
+env:
+  global:
+    secure: SDYF7gJE/x/3rEwL9CxXHRLwTRBHtqtY/djQ+hg98zlvIQoMYmXcteEqiSM85x6LeFMu1pz4hqinKsSZOQ7ftZi46iWqbFPWHEqTaM7676klzH0xvMAG+I9Yo7NEUyA5OPKrWSJ1+9Smm42WggH3tqwMG5tut4zej310VFD5GMY=

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 All notable changes to this project will be documented in this file.
 
 ## master - unreleased
+### Changed
+- Introduced `ConfigFor.load_config!` that raises exception when environment is missing
+- Both integrations will raise exception when environment is missing
 
 ## 0.1.2 - 2014-10-29
 

data/Gemfile

@@ -1,9 +1,13 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in config_for.gemspec
-gemspec
+gemspec development_group: :test
+
+group :test do
+  gem 'codeclimate-test-reporter', require: false
+  gem 'appraisal'
+end
 
-gem 'appraisal'
 
 platforms :mri_20, :mri_21 do
   gem 'pry-byebug'

data/README.md

@@ -1,4 +1,4 @@
-# ConfigFor [![Build Status](https://travis-ci.org/3scale/config_for.svg?branch=master)](https://travis-ci.org/3scale/config_for)
+# ConfigFor [![Build Status](https://travis-ci.org/3scale/config_for.svg?branch=master)](https://travis-ci.org/3scale/config_for) [![Code Climate](https://codeclimate.com/github/3scale/config_for/badges/gpa.svg)](https://codeclimate.com/github/3scale/config_for) [![Test Coverage](https://codeclimate.com/github/3scale/config_for/badges/coverage.svg)](https://codeclimate.com/github/3scale/config_for)
 
 Framework for generating, uploading and loading config files in Ruby apps.
 
@@ -6,6 +6,14 @@ It offers integrations with Rails and Sinatra.
 
 For generating and uploading configs it uses Capistrano task.
 
+# How to use it?
+
+* Check [RDoc documentation](http://www.rubydoc.info/github/3scale/config_for/master/frames)
+* If you have Rails/Sinatra, just add the gem to Gemfile and use it (
+[Sinatra example](http://www.rubydoc.info/github/3scale/config_for/master/ConfigFor/Sinatra:config_for),
+[Rails example](http://www.rubydoc.info/github/3scale/config_for/master/ConfigFor/Rails:config_for))
+* Otherwise check [ConfigFor.load_config!](http://www.rubydoc.info/github/3scale/config_for/master/ConfigFor.load_config!)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -115,7 +123,7 @@ If you have your own framework. You need to create your own `config_for` method.
 require 'config_for'
 module MyApp
   def self.config_for(name)
-    ConfigFor.load_config(MyApp.root.join('config'), name, MyApp.env)
+    ConfigFor.load_config!(MyApp.root.join('config'), name, MyApp.env)
   end
 end
 ```

data/gemfiles/rails_3.gemfile

@@ -2,11 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "appraisal"
 gem "rails", "~> 3.2.14"
 
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+  gem "appraisal"
+end
+
 platforms :mri_20, :mri_21 do
   gem "pry-byebug"
 end
 
-gemspec :path => "../"
+gemspec :development_group => :test, :path => "../"

data/gemfiles/rails_4.gemfile

@@ -2,11 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "appraisal"
 gem "rails", "~> 4.0.0"
 
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+  gem "appraisal"
+end
+
 platforms :mri_20, :mri_21 do
   gem "pry-byebug"
 end
 
-gemspec :path => "../"
+gemspec :development_group => :test, :path => "../"

data/gemfiles/rails_4_1.gemfile

@@ -2,11 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "appraisal"
 gem "rails", "~> 4.1.0"
 
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+  gem "appraisal"
+end
+
 platforms :mri_20, :mri_21 do
   gem "pry-byebug"
 end
 
-gemspec :path => "../"
+gemspec :development_group => :test, :path => "../"

data/lib/config_for.rb

@@ -1,58 +1,51 @@
 require 'config_for/version'
-require 'pathname'
-
-require 'yaml'
-require 'erb'
-
-require 'active_support/hash_with_indifferent_access'
-# HashWithIndifferentAccess needs this core extension to be loaded
-require 'active_support/core_ext/hash/indifferent_access'
 
 module ConfigFor
-  if defined?(::Rails)
-    require 'config_for/rails'
-  end
+  ReadError = Class.new(StandardError)
+  InvalidConfigError = Class.new(StandardError)
+  MissingEnvironmentError = Class.new(StandardError)
 
-  if defined?(::Sinatra)
-    require 'config_for/sinatra'
-  end
+  autoload :Rails, 'config_for/rails'
+  autoload :Sinatra, 'config_for/sinatra'
+  autoload :Capistrano, 'config_for/capistrano'
 
-  if defined?(::Capistrano)
-    require 'config_for/capistrano'
-  end
+  autoload :Config, 'config_for/config'
 
   # inspired by https://github.com/rails/rails/commit/9629dea4fb15a948ab4394590fdd946bd9dd4f91
 
-  # Loads yaml file "#{{name}}.yml" from path and gets
+  # Loads yaml file "#{{name}}.yml" from path and gets given environment key.
+  # In case the environment is not found, it returns empty hash.
   #
   # @param [Pathname, String] path partial of full path to folder with configs
   # @param [String] name without extension
   # @param [Symbol,String] env key to get from the config
+  # @raise [ConfigFor::InvalidConfigError] when the config is invalid YAML
+  # @raise [ConfigFor::ReadError] when the config can't be read
   # @return [ActiveSupport::HashWithIndifferentAccess] config file for given env
-  # @raise [RuntimeError] when file does not exist or can't be parsed
   # @example Load config in rails
   #  ConfigFor.load_config(Rails.root.join('config'), 'redis', Rails.env)
   def self.load_config(path, name, env)
-    yaml = File.join(path, "#{name}.yml")
-
-    if File.readable?(yaml)
-      config = parse_yaml(yaml)
-      ActiveSupport::HashWithIndifferentAccess.new(config).fetch(env) { Hash.new }
-    else
-      raise "Could not load configuration. Can't read #{yaml}"
-    end
+    config(path, name).fetch(env) { ConfigFor::Config.empty }
   end
 
-  # Parse and process a yaml file through ERB
-
-  # @param [Pathname, String] full path to yaml file
-  # @return [Hash]
-  # @raise [RuntimeError] when file can't be parsed
-  def self.parse_yaml(file)
-    ::YAML.load(::ERB.new(File.read(file)).result) || {}
-  rescue ::Psych::SyntaxError => e
-    raise "YAML syntax error occurred while parsing #{file}. " \
-      "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
-      "Error: #{e.message}"
+  # Same as ConfigFor.load_config but raises exception when environment is not found.
+  # Note that this is the preferred way of loading configuration. Also it is used by
+  # Rails and Sinatra integrations.
+  #
+  # @param (see .load_config)
+  # @raise (see .load_config)
+  # @raise [ConfigFor::MissingEnvironmentError] when the config does not have the environment key
+  # @return (see .load_config)
+  def self.load_config!(path, name, env)
+    config(path, name).fetch(env)
+  end
+
+  private
+
+  # @api private
+  def self.config(path, name)
+    ConfigFor::Config.new(path, name)
   end
 end
+
+require 'config_for/integrations'

data/lib/config_for/config.rb

@@ -0,0 +1,69 @@
+require 'erb'
+require 'yaml'
+require 'forwardable'
+require 'monitor'
+require 'pathname'
+
+require 'active_support/hash_with_indifferent_access'
+# HashWithIndifferentAccess needs this core extension to be loaded
+require 'active_support/core_ext/hash/indifferent_access'
+
+module ConfigFor
+  # @api private
+  class Config
+    extend Forwardable
+
+    CONFIG_CLASS = ActiveSupport::HashWithIndifferentAccess
+
+    def initialize(path, name)
+      @path = path
+      @name = name
+      @monitor = Monitor.new
+      @pathname = Pathname("#{name}.yml").expand_path(path)
+    end
+
+    def self.empty
+      CONFIG_CLASS.new
+    end
+
+    def environments
+      config.keys
+    end
+
+    def fetch(key, &block)
+      config.fetch(key, &block)
+    rescue KeyError
+      raise ConfigFor::MissingEnvironmentError, "#{@pathname} contains just #{environments}, not #{key}"
+    end
+
+    private
+
+    def config
+      @monitor.synchronize do
+        if instance_variable_defined?(:@config)
+          @config
+        else
+          @config = convert(parse)
+        end
+      end
+    end
+
+    def convert(hash)
+      CONFIG_CLASS.new(hash)
+    end
+
+    def read
+      @pathname.read
+    rescue => error
+      raise ConfigFor::ReadError, error.message
+    end
+
+    def parse
+      content = read
+      erb = ::ERB.new(content).result
+      ::YAML.load(erb, @pathname)
+    rescue ::Psych::SyntaxError => e
+      fail ConfigFor::InvalidConfigError, "YAML syntax error occurred while parsing #{content}. Error: #{e.message}"
+    end
+  end
+end

data/lib/config_for/integrations.rb

@@ -0,0 +1,11 @@
+if defined?(::Sinatra)
+  require 'config_for/integrations/sinatra'
+end
+
+if defined?(::Rails)
+  require 'config_for/integrations/rails'
+end
+
+if defined?(::Capistrano)
+  require 'config_for/capistrano'
+end

data/lib/config_for/integrations/rails.rb

@@ -0,0 +1,3 @@
+::Rails::Application.class_eval do
+  include ::ConfigFor::Rails
+end

data/lib/config_for/integrations/sinatra.rb

@@ -0,0 +1 @@
+::Sinatra.register(::ConfigFor::Sinatra)

data/lib/config_for/rails.rb

@@ -1,19 +1,18 @@
+require 'config_for'
+
 module ConfigFor
   module Rails
     # Convenience loading of config files
     #
     # @param [String, Symbol] name the config file to load
+    # @raise (see ConfigFor.load_config!)
     # @return [ActiveSupport::HashWithIndifferentAccess] loaded config file
     # @example in config/production.rb
     #   Rails.application.configure do
     #     config.redis = config_for(:redis)
     #   end
     def config_for(name)
-      ConfigFor.load_config(paths['config'].existent.first, name, ::Rails.env)
+      ConfigFor.load_config!(paths['config'].existent.first, name, ::Rails.env)
     end
   end
 end
-
-::Rails::Application.class_eval do
-  include ConfigFor::Rails
-end

data/lib/config_for/sinatra.rb

@@ -1,10 +1,17 @@
+require 'config_for'
+
 module ConfigFor
   module Sinatra
 
-    # Convenience loading of config files
+    def self.registered(base)
+      base.set :config_path, lambda { File.join(base.settings.root, 'config') }
+    end
+
+    # Convenience loading of config files.
     #
     # @param [String, Symbol] name the config file to load
     # @return [ActiveSupport::HashWithIndifferentAccess] loaded config file for current environment
+    # @raise (see ConfigFor.load_config!)
     # @example
     #   class MyApp < Sinatra::Base
     #     register ConfigFor::Sinatra
@@ -12,10 +19,7 @@ module ConfigFor
     #     set :redis, Redis.new(config_for(:redis))
     #   end
     def config_for(name)
-      config = File.join(settings.root, 'config')
-      ConfigFor.load_config(config, name, settings.environment)
+      ConfigFor.load_config!(settings.config_path, name, settings.environment)
     end
   end
 end
-
-Sinatra.register(ConfigFor::Sinatra)

data/lib/config_for/version.rb

@@ -1,3 +1,3 @@
 module ConfigFor
-  VERSION = '0.1.2'
+  VERSION = '0.2.0.beta1'
 end

data/spec/config_for_spec.rb

@@ -2,38 +2,52 @@ require 'config_for'
 
 RSpec.describe ConfigFor do
   let(:env) { 'production' }
-  subject(:config) { config_for(self.class.description) }
 
-  def config_for(name)
-    described_class.load_config(fixtures_path, name, env)
-  end
+  shared_examples 'load_config' do
+    subject(:config) { config_for(self.class.metadata.fetch(:name)) }
 
-  context 'database' do
     it { is_expected.to eq('host' => 'localhost', 'port' => 3306) }
     it { is_expected.to include(port: 3306, host: 'localhost') }
-  end
 
-  context 'unknown' do
-    it do
-      expect{ subject }
-          .to raise_error(RuntimeError,
-                          'Could not load configuration. Can\'t read spec/fixtures/unknown.yml')
+    context 'with symbol as env' do
+      let(:env) { :production }
+
+      it { is_expected.to_not be_empty }
+    end
+
+    context 'unknown config', name: 'unknown' do
+      it do
+        expect{ subject }
+            .to raise_error(ConfigFor::ReadError, /^No such file or directory/)
+      end
     end
   end
 
-  context 'with symbol as env' do
-    let(:env) { :production }
+  context '.load_config', name: 'database' do
 
-    context 'database' do
-      it { is_expected.to_not be_empty }
+    def config_for(name)
+      described_class.load_config(fixtures_path, name, env)
     end
-  end
 
-  context 'for unknown env' do
-    let(:env) { 'unknown' }
+    include_examples 'load_config'
 
-    context 'database' do
+    context 'with unknown env' do
+      let(:env) { 'unknown' }
       it { is_expected.to be_empty }
     end
   end
+
+  context '.load_config!', name: 'database' do
+    def config_for(name)
+      described_class.load_config!(fixtures_path, name, env)
+    end
+
+    include_examples 'load_config'
+
+    context 'unknown env' do
+      let(:env) { 'unknown' }
+      it { expect{subject}
+               .to raise_error(ConfigFor::MissingEnvironmentError, /database\.yml contains just \["production", "development"\], not unknown/) }
+    end
+  end
 end

data/spec/rails_spec.rb

@@ -1,7 +1,6 @@
 require 'rails'
 require 'rails/application'
-require 'config_for'
-require 'config_for/rails'
+require 'config_for/integrations/rails'
 
 RSpec.describe ConfigFor::Rails do
   # TODO: remove when dropping rails 3 compatibility

data/spec/sinatra_spec.rb

@@ -1,5 +1,5 @@
 require 'sinatra/base'
-require 'config_for/sinatra'
+require 'config_for/integrations/sinatra'
 
 RSpec.describe ConfigFor::Sinatra do
   it { expect(Sinatra::Application.extensions).to include(described_class) }

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'config_for'
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause this
@@ -112,6 +117,6 @@ RSpec.shared_examples 'framework integration' do
     before { MemFs.touch(config.join('database.yml')) }
 
     after { subject }
-    it { expect(ConfigFor).to receive(:load_config).with(config.to_s,:database,'production') }
+    it { expect(ConfigFor).to receive(:load_config!).with(config.to_s,:database,'production') }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_for
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0.beta1
 platform: ruby
 authors:
 - Michal Cichra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-29 00:00:00.000000000 Z
+date: 2014-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -165,6 +165,10 @@ files:
 - gemfiles/rails_4_1.gemfile
 - lib/config_for.rb
 - lib/config_for/capistrano.rb
+- lib/config_for/config.rb
+- lib/config_for/integrations.rb
+- lib/config_for/integrations/rails.rb
+- lib/config_for/integrations/sinatra.rb
 - lib/config_for/rails.rb
 - lib/config_for/sinatra.rb
 - lib/config_for/version.rb
@@ -189,9 +193,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2