a9n 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1fa842e61082deb4d82eb3059efed6cb0ce0e50
-  data.tar.gz: a3250f33bf6df0ae3b06de1bb30774acf958d65f
+  metadata.gz: 2c19e68e2155ba1e5eb4b94f13f4345cec6a6550
+  data.tar.gz: d49bfe9ff3a925e4117a094b190b57493acc0478
 SHA512:
-  metadata.gz: ca996bb79d7331734d27e51eb5b35c1759a95bc680056ca6a25c78ec138d2c6c2272e613cb2bbd18aa4cbb01155ef981d8fa4719f909239abfb3c15c273e9b2a
-  data.tar.gz: d9e4c62825e16d882d3f9dadb56e4689e64b7036a47b77557208ff9c89a2f5798992fde85eb77fbe26c97d310c35dfd8967b627135497fd18e0f6a1ad0e37841
+  metadata.gz: db39e6ebef8b3cbff249bfcd43a57b42fe276886903df28e772ba5f59da862fa8e72d3656b38c98a0f85dc7117c4538dc7d88e00272047cd1473994d877637b6
+  data.tar.gz: 18c31604129a4785bac83c6d4d28be8225eff924cb0f1b9ae96c32ccd61fe578d3125f2504087681a05212ea0d9e6d12f45f291009353e8e5f0ac73dd245adf1

data/.travis.yml

@@ -4,3 +4,6 @@ rvm:
   - 2.0.0
   - 2.1.2
   - jruby-19mode
+addons:
+  code_climate:
+    repo_token: 9aa2aa2432639c57772b6917ad9da468709e5536b75617575b02b35201a2eaf8

data/Gemfile

@@ -2,5 +2,5 @@ source 'https://rubygems.org'
 
 gemspec
 gem 'rake'
-gem 'rspec', '~> 2.14.1'
-gem 'coveralls', require: false
+gem 'rspec', '~> 3.0.0'
+gem 'codeclimate-test-reporter', require: false

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Krzysztof Knapik @knapo
+Copyright (c) 2014 Krzysztof Knapik @knapo
 
 MIT License
 
@@ -19,4 +19,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

@@ -3,14 +3,16 @@
 [![Gem Version](https://badge.fury.io/rb/a9n.png)][gem_version]
 [![Build status](https://secure.travis-ci.org/knapo/a9n.png)][travis]
 [![Code Climate](https://codeclimate.com/github/knapo/a9n.png)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/knapo/a9n/badge.png?branch=master)][coveralls]
+[![Coverage Status](https://codeclimate.com/github/knapo/a9n/coverage.png)][coverage]
 
 [gem_version]: https://rubygems.org/gems/a9n
 [travis]: http://travis-ci.org/knapo/a9n
 [codeclimate]: https://codeclimate.com/github/knapo/a9n
-[coveralls]: https://coveralls.io/r/knapo/a9n
+[coverage]: https://codeclimate.com/github/knapo/a9n
 
-A9n is a simple tool for managing extra configuration in ruby/rails apps. It supports Rails 2.x, 3.x, 4.x and Ruby 1.9, 2.0. 2.1. Ruby 1.8 is not supported since version 0.1.2.
+A9n is a simple tool to keep ruby/rails apps configuration maintanable and verifiable. It supports Rails 2.x, 3.x, 4.x and Ruby 1.9, 2.0. 2.1. Ruby 1.8 is not supported since version 0.1.2.
+
+Why it's named a9n? It's a numeronym for application (where 9 stands for the number of letters between the first **a** and last **n**, similar to i18n or l10n).
 
 ## Installation
 
@@ -26,9 +28,8 @@ Add `configuration.yml.example` and/or `configuration.yml` file into the config
 directory. When none fo these files exists, `A9n::MissingConfigurationFile`
 exception is thrown.
 If both file exist, content of `configuration.yml` is validated. It means that
-all keys existing in example file must exist in base file - in case of missing
-keys`A9n::MissingConfigurationVariables` is thrown with information about
-missing keys.
+all keys existing in example file must exist in local file - in case of missing
+keys `A9n::MissingConfigurationVariables` is thrown with the explanation what is missing.
 
 Set application root and load configuration by adding to your `application.rb` or `environment.rb` right
 after budler requires:
@@ -36,6 +37,7 @@ after budler requires:
     A9n.root = File.expand_path('../..', __FILE__)
     A9n.load
 
+This step is not required ,if you don't use `a9n` in the environment settings or initializers.
 It works with `Rails` by default. If you want to use `A9n` with non-rails app
 you may need to tell that to A9n by:
 
@@ -60,19 +62,29 @@ is accessible by:
 
 ## Custom and multiple configuration files
 
-If you want to scope configuration you may split to 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('lib/facebook/api.yml', 'config/mongoid.yml')`. In such cases config items are accessialbe via scope consistient 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/facebook.yml', 'config/mongoid.yml')`. In such cases config items are accessible through the scope consistent with the file name.
 
 E.g. if you have `config/a9n/mandrill.yml`:
-     
+
      defaults:
        username: "joe"
        api_key: "1234asdf"
 
-you can access it by:
+You can access it by:
 
      A9n.mandrill.username # => `joe`
      A9n.mandrill.api_key # => `1234asdf`
 
+    
+## Capistrano
+
+If you use capistrano and you feel safe enough to keep all your instance ( staging, production) configuration in the repository, you may find it useful to use capistrano extensions.
+Just add an instance configuration file e.g. `configuration.yml.staging`, `configuration.yml.production` (NOTE: file extension must be consistent with the capistrano stage) and add
+
+    require 'a9n/capistrano'
+    
+to your deploy.rb file. This way `configuration.yml.<stage>` overrides `configuration.yml` on each deploy.
+
 ## Contributing
 
 1. Fork it

data/a9n.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/a9n/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Krzysztof Knapik"]
   gem.email         = ["knapo@knapo.net"]
-  gem.description   = %q{Simple tool for managing extra configuration in ruby/rails apps}
-  gem.summary       = %q{a9n is a simple tool for managing extra configuration in ruby/rails apps}
+  gem.description   = %q{a9n is a tool to keep ruby/rails apps extra configuration easily maintainable and verifiable}
+  gem.summary       = %q{a9n is a tool to keep ruby/rails apps extra configuration easily maintainable and verifiable}
   gem.homepage      = "https://github.com/knapo/a9n"
   gem.license       = 'MIT'
   gem.files         = `git ls-files`.split($\)

data/lib/a9n/loader.rb

@@ -4,6 +4,8 @@ module A9n
   class Loader
     attr_reader :env, :local_file, :example_file
 
+    COMMON_SCOPE = "defaults"
+
     def initialize(file_path, env)
       @env = env.to_s
       @local_file = file_path
@@ -15,33 +17,37 @@ module A9n
     end
 
     def load
-      env_example      = self.class.load_yml(example_file, env)
-      env_local        = self.class.load_yml(local_file, env)
-      default_example  = self.class.load_yml(example_file, "defaults")
-      default_local    = self.class.load_yml(local_file, "defaults")
+      local_config    = self.class.load_yml(local_file, env)
+      example_config  = self.class.load_yml(example_file, env)
 
-      if env_example.nil? && env_local.nil? && default_example.nil? && default_local.nil?
+      if local_config.nil? && example_config.nil?
         raise A9n::MissingConfigurationData.new("Configuration data for *#{env}* env was not found in neither *#{example_file}* nor *#{local_file}*")
       end
 
-      example = A9n::HashExt.merge(default_example, env_example)
-      local   = A9n::HashExt.merge(default_local, env_local)
-
-      if !example.nil? && !local.nil?
-        verify!(example, local)
+      if !local_config.nil? && !example_config.nil?
+        verify!(local_config, example_config)
       end
 
-      @struct = A9n::Struct.new(local || example)
+      @struct = A9n::Struct.new(local_config || example_config)
     end
 
-    def self.load_yml(file_path, env)
-      return nil unless File.exists?(file_path)
-      yml = YAML.load(ERB.new(File.read(file_path)).result)
+    class << self
+      def load_yml(file_path, env)
+        return nil unless File.exists?(file_path)
+        yml = YAML.load(ERB.new(File.read(file_path)).result)
+
+        common_scope = prepare_yml_scope(yml, COMMON_SCOPE)
+        env_scope    = prepare_yml_scope(yml, env)
+
+        A9n::HashExt.merge(common_scope, env_scope)
+      end
 
-      if yml[env].is_a?(::Hash)
-        A9n::HashExt.deep_symbolize_keys(yml[env])
-      else
-        return nil
+      def prepare_yml_scope(yml, env_scope)
+        if yml[env_scope].is_a?(::Hash)
+          A9n::HashExt.deep_symbolize_keys(yml[env_scope])
+        else
+          nil
+        end
       end
     end
 

data/lib/a9n/version.rb

@@ -1,3 +1,3 @@
 module A9n
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/spec_helper.rb

@@ -1,13 +1,7 @@
 require 'simplecov'
-require 'coveralls'
+require 'codeclimate-test-reporter'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
-SimpleCov.start do
-  add_filter '/spec/'
-end
+CodeClimate::TestReporter.start
 
 require 'rubygems'
 require 'bundler/setup'
@@ -15,8 +9,9 @@ require 'bundler/setup'
 require 'a9n'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.expect_with :rspec do |expect_with|
+    expect_with.syntax = :expect
+  end
   config.order = "random"
-  config.color_enabled = true
   config.tty = true
 end

data/spec/unit/loader_spec.rb

@@ -13,18 +13,12 @@ describe A9n::Loader do
   end
 
   describe "#load" do
-    let(:example_env_config) {
-      { app_url: "http://127.0.0.1:3000", api_key: "base1234" }
+    let(:example_config) {
+      { app_url: "http://127.0.0.1:3000", api_key: "example1234" }
     }
-    let(:local_env_config) {
+    let(:local_config) {
       { app_host: "127.0.0.1:3000", api_key: "local1234" }
     }
-    let(:example_default_config) {
-      { page_title: "Base Kielbasa", api_key: "example1234default"  }
-    }
-    let(:local_default_config) {
-      { page_title: "Local Kielbasa", api_key: "local1234default" }
-    }
     let(:env){
       "tropical"
     }
@@ -34,8 +28,6 @@ describe A9n::Loader do
       before do
         expect(described_class).to receive(:load_yml).with(subject.example_file, env).and_return(nil)
         expect(described_class).to receive(:load_yml).with(subject.local_file, env).and_return(nil)
-        expect(described_class).to receive(:load_yml).with(subject.example_file, "defaults").and_return(nil)
-        expect(described_class).to receive(:load_yml).with(subject.local_file, "defaults").and_return(nil)
         expect(subject).to receive(:verify!).never
       end
       it "raises expection"  do
@@ -45,37 +37,30 @@ describe A9n::Loader do
       end
     end
 
-    context "when example configuration file exists with defaults" do
+    context "when only example configuration file exists" do
       before do
-        expect(described_class).to receive(:load_yml).with(subject.example_file, env).and_return(example_env_config)
+        expect(described_class).to receive(:load_yml).with(subject.example_file, env).and_return(example_config)
         expect(described_class).to receive(:load_yml).with(subject.local_file, env).and_return(nil)
-        expect(described_class).to receive(:load_yml).with(subject.example_file, "defaults").and_return(example_default_config)
-        expect(described_class).to receive(:load_yml).with(subject.local_file, "defaults").and_return(nil)
-
         expect(described_class).to receive(:verify!).never
         subject.load
       end
 
       it { expect(config.app_url).to eq("http://127.0.0.1:3000") }
-      it { expect(config.page_title).to eq("Base Kielbasa") }
-      it { expect(config.api_key).to eq("base1234") }
+      it { expect(config.api_key).to eq("example1234") }
 
       it {
         expect { config.app_host }.to raise_error(A9n::NoSuchConfigurationVariable)
       }
     end
 
-    context "when local configuration file exists with defaults" do
+    context "when only local configuration file exists" do
       before do
         expect(described_class).to receive(:load_yml).with(subject.example_file, env).and_return(nil)
-        expect(described_class).to receive(:load_yml).with(subject.local_file, env).and_return(local_env_config)
-        expect(described_class).to receive(:load_yml).with(subject.example_file, "defaults").and_return(nil)
-        expect(described_class).to receive(:load_yml).with(subject.local_file, "defaults").and_return(local_default_config)
+        expect(described_class).to receive(:load_yml).with(subject.local_file, env).and_return(local_config)
         expect(described_class).to receive(:verify!).never
         subject.load
       end
       it { expect(config.app_host).to eq("127.0.0.1:3000") }
-      it { expect(config.page_title).to eq("Local Kielbasa") }
       it { expect(config.api_key).to eq("local1234") }
 
       it {
@@ -86,19 +71,14 @@ describe A9n::Loader do
     context "when both local and base configuration file exists without defaults" do
       context "with same data" do
         before do
-          expect(described_class).to receive(:load_yml).with(subject.example_file, env).and_return(example_env_config)
-          expect(described_class).to receive(:load_yml).with(subject.local_file, env).and_return(example_env_config)
-          expect(described_class).to receive(:load_yml).with(subject.example_file, "defaults").and_return(nil)
-          expect(described_class).to receive(:load_yml).with(subject.local_file, "defaults").and_return(nil)
+          expect(described_class).to receive(:load_yml).with(subject.example_file, env).and_return(example_config)
+          expect(described_class).to receive(:load_yml).with(subject.local_file, env).and_return(example_config)
           subject.load
         end
 
         it { expect(config.app_url).to eq("http://127.0.0.1:3000") }
-        it { expect(config.api_key).to eq("base1234") }
+        it { expect(config.api_key).to eq("example1234") }
 
-        it {
-          expect { config.page_title }.to raise_error(A9n::NoSuchConfigurationVariable)
-        }
         it {
           expect { config.app_host }.to raise_error(A9n::NoSuchConfigurationVariable)
         }
@@ -106,10 +86,8 @@ describe A9n::Loader do
 
       context "with different data" do
         before do
-          expect(described_class).to receive(:load_yml).with(subject.example_file, env).and_return(example_env_config)
-          expect(described_class).to receive(:load_yml).with(subject.local_file, env).and_return(local_env_config)
-          expect(described_class).to receive(:load_yml).with(subject.example_file, "defaults").and_return(nil)
-          expect(described_class).to receive(:load_yml).with(subject.local_file, "defaults").and_return(nil)
+          expect(described_class).to receive(:load_yml).with(subject.example_file, env).and_return(example_config)
+          expect(described_class).to receive(:load_yml).with(subject.local_file, env).and_return(local_config)
         end
         it "raises expection"  do
           expect {
@@ -125,22 +103,31 @@ describe A9n::Loader do
     subject {  described_class.load_yml(file_path, env) }
 
     context "when file not exists" do
-      let(:file_path) { "file_not_existing_in_universe.yml" }
+      let(:file_path) { "file_not_existing_in_the_universe.yml" }
 
       it{ expect(subject).to be_nil }
     end
 
     context "when file exists" do
-      let(:file_path) { File.join(root, "config/configuration.yml") }
+      shared_examples "non-empty config file" do
+        it "returns non-empty hash" do
+          expect(subject).to be_kind_of(Hash)
+          expect(subject.keys).to_not be_empty
+        end
+      end
 
       before {
         ENV["DWARF"] = "erbized dwarf"
       }
 
-      context "and has data" do
-        it "returns non-empty hash" do
-          expect(subject).to be_kind_of(Hash)
-          expect(subject.keys).to_not be_empty
+      context "having env and defaults data" do
+        let(:file_path) { File.join(root, "config/configuration.yml") }
+
+        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")
         end
 
         it "has symbolized keys" do
@@ -154,9 +141,30 @@ describe A9n::Loader do
         end
       end
 
-      context "and has no data" do
+      context "having no env and only defaults data" do
+        let(:file_path) { File.join(root, "config/configuration.yml") }
         let(:env) { "production" }
-        it{ expect(subject).to be_nil }
+
+        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")
+        end
+      end
+
+      context "having only env and no default data" do
+        let(:file_path) { File.join(root, "config/no_defaults.yml") }
+
+        context "valid env" do
+          let(:env) { "production" }
+          it_behaves_like "non-empty config file"
+        end
+
+        context "invalid env" do
+          let(:env) { "tropical" }
+          it { expect(subject).to be_nil }
+        end
       end
     end
   end

data/test_app/config/no_defaults.yml

@@ -0,0 +1,3 @@
+production:
+  username: "joe"
+  api_key: "asdf1234"

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: a9n
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Krzysztof Knapik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2014-07-25 00:00:00.000000000 Z
 dependencies: []
-description: Simple tool for managing extra configuration in ruby/rails apps
+description: a9n is a tool to keep ruby/rails apps extra configuration easily maintainable
+  and verifiable
 email:
 - knapo@knapo.net
 executables: []
@@ -39,6 +40,7 @@ files:
 - test_app/config/a9n/mandrill.yml
 - test_app/config/configuration.yml
 - test_app/config/configuration.yml.example
+- test_app/config/no_defaults.yml
 homepage: https://github.com/knapo/a9n
 licenses:
 - MIT
@@ -62,7 +64,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: a9n is a simple tool for managing extra configuration in ruby/rails apps
+summary: a9n is a tool to keep ruby/rails apps extra configuration easily maintainable
+  and verifiable
 test_files:
 - spec/integration/a9n_spec.rb
 - spec/spec_helper.rb