a9n 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c22d5e7310407cb2773dc933fadaec4edeb9cc29
-  data.tar.gz: 074a49169e7a1c25ae6123f8b6fe82a3326da2d6
+  metadata.gz: 044172d147418c1f64d54e328192b4b9dbb06bd5
+  data.tar.gz: 2b2f7135afc4dc3805a0d14bf405547bfee1c0ec
 SHA512:
-  metadata.gz: 0b473d6dd3647dff4a443d80b86604cfb30268f18a46429d4d559267b77917c99b75ee0596bb3325e5a6615626949d1365d5bb31c5c872645fb9956052494688
-  data.tar.gz: 942b478f1f5fe7f76d686de2e2852d5290183c9ed79613803bf65018f43d220fff9cca161a51b9d00864616ec622306e7e830c78285cf4e914b82e758382f43c
+  metadata.gz: fb2d5778aa099e48696f1ba15190efcbf643e047aa9f365aee02d0d9ef7d3aedb10b062f192b67829f18043624b86783797dd49c27d128dd2c6a4e86ea5fde5a
+  data.tar.gz: 267caee0c0c17a25d1dfbc9045fda30ce94903a370b672d68af413350c151f8ccbed519d19fdb4bbbc5ee1126f44795d96495e5cc1c63840271ae0755f0e8607

data/.gitignore

@@ -12,4 +12,3 @@ rdoc
 spec/reports
 tmp
 .coveralls.yml
-.rspec

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/lib/a9n.rb

@@ -1,5 +1,6 @@
 require "a9n/version"
 require "a9n/struct"
+require "a9n/scope"
 require "a9n/ext/hash"
 require "a9n/loader"
 require "yaml"
@@ -13,7 +14,6 @@ module A9n
   class MissingConfigurationVariables < StandardError; end
   class NoSuchConfigurationVariable < StandardError; end
 
-  DEFAULT_SCOPE = :configuration
   EXTENSION_LIST = "{yml,yml.erb,yml.example,yml.erb.example}"
 
   class << self
@@ -54,7 +54,7 @@ module A9n
     end
 
     def default_files
-      files  = Dir[root.join("config/#{DEFAULT_SCOPE}.#{EXTENSION_LIST}").to_s]
+      files  = Dir[root.join("config/#{A9n::Scope::MAIN_NAME}.#{EXTENSION_LIST}").to_s]
       files += Dir[root.join("config/a9n/*.#{EXTENSION_LIST}")]
       files.map{ |f| f.sub(/.example$/,'') }.uniq
     end
@@ -77,35 +77,27 @@ module A9n
     private
 
     def load_file(file)
-      scope_name = scope_name_from_file(file)
-      scope_data = A9n::Loader.new(file, env).get
-      setup_scope(scope_name, scope_data)
+      scope = A9n::Scope.form_file_path(file)
+      scope_data = A9n::Loader.new(file, scope, env).get
+      setup_scope(scope, scope_data)
     end
 
-    def setup_scope(name, data)
-      if default_scope?(name)
+    def setup_scope(scope, data)
+      if scope.main?
         storage.merge(data)
         def_delegator :storage, :fetch
         def_delegators :storage, *data.keys
       else
-        storage[name] = data
-        def_delegator :storage, name
+        storage[scope.name] = data
+        def_delegator :storage, scope.name
       end
       return data
     end
 
-    def scope_name_from_file(file)
-      File.basename(file.to_s).split('.').first.to_sym
-    end
-
     def get_absolute_paths_for(files)
       files.map { |file| Pathname.new(file).absolute? ? file : self.root.join('config', file).to_s }
     end
 
-    def default_scope?(scope)
-      scope.to_s == DEFAULT_SCOPE.to_s
-    end
-
     def require_local_extension
       return if app.nil? || root.nil?
       local_extension_file = File.join(root, "config/a9n.rb")

data/lib/a9n/ext/hash.rb

@@ -1,9 +1,9 @@
 module A9n
-  class HashExt
+  class Hash
     class << self
-      def deep_prepare(hash)
+      def deep_prepare(hash, scope)
         hash.inject({}) do |result, (key, value)|
-          result[(key.to_sym rescue key)] = get_value(key, value)
+          result[(key.to_sym rescue key)] = get_value(key, value, scope)
           result
         end
       end
@@ -15,11 +15,11 @@ module A9n
 
       private
 
-      def get_value(key, value)
+      def get_value(key, value, scope)
         if value.is_a?(::Hash)
-          deep_prepare(value)
+          deep_prepare(value, scope)
         elsif value.is_a?(Symbol) && value == :env
-          ENV[key.to_s.upcase]
+          ENV[scope.full_key_name(key).upcase]
         else
           value
         end

data/lib/a9n/loader.rb

@@ -2,11 +2,12 @@ require 'ostruct'
 
 module A9n
   class Loader
-    attr_reader :env, :local_file, :example_file
+    attr_reader :scope, :env, :local_file, :example_file
 
     COMMON_SCOPE = "defaults"
 
-    def initialize(file_path, env)
+    def initialize(file_path, scope, env)
+      @scope = scope
       @env = env.to_s
       @local_file = file_path
       @example_file = "#{file_path}.example"
@@ -17,8 +18,8 @@ module A9n
     end
 
     def load
-      local_config    = self.class.load_yml(local_file, env)
-      example_config  = self.class.load_yml(example_file, env)
+      local_config    = self.class.load_yml(local_file, scope, env)
+      example_config  = self.class.load_yml(example_file, scope, env)
 
       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}*")
@@ -32,19 +33,19 @@ module A9n
     end
 
     class << self
-      def load_yml(file_path, env)
+      def load_yml(file_path, scope, 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)
+        common_scope = prepare_yml_scope(yml, scope, COMMON_SCOPE)
+        env_scope    = prepare_yml_scope(yml, scope, env)
 
-        A9n::HashExt.merge(common_scope, env_scope)
+        A9n::Hash.merge(common_scope, env_scope)
       end
 
-      def prepare_yml_scope(yml, env_scope)
-        if yml[env_scope].is_a?(::Hash)
-          A9n::HashExt.deep_prepare(yml[env_scope])
+      def prepare_yml_scope(yml, scope, env)
+        if yml[env].is_a?(::Hash)
+          A9n::Hash.deep_prepare(yml[env], scope)
         else
           nil
         end

data/lib/a9n/scope.rb

@@ -0,0 +1,24 @@
+module A9n
+  class Scope
+    MAIN_NAME = :configuration
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name.to_sym
+    end
+
+    def main?
+      name == MAIN_NAME
+    end
+
+    def full_key_name(key)
+      main? ? key : "#{name}_#{key}"
+    end
+
+    def self.form_file_path(path)
+      name = File.basename(path.to_s).split('.').first.to_sym
+      self.new(name)
+    end
+  end
+end

data/lib/a9n/version.rb

@@ -1,3 +1,3 @@
 module A9n
-  VERSION = "0.4.5"
+  VERSION = "0.4.6"
 end

data/spec/integration/a9n_spec.rb

@@ -1,12 +1,12 @@
-require "spec_helper"
-
-describe A9n do
+RSpec.describe A9n do
   subject { described_class }
 
   let(:env) { "test" }
 
   before do
     clean_singleton(subject)
+    ENV["MANDRILL_API_KEY"] = "ASDF1234"
+    ENV["API_KEY"] = "XYZ999"
     subject.app = double(env: env)
     subject.root = File.expand_path("../../../test_app", __FILE__)
     subject.load
@@ -14,6 +14,8 @@ describe A9n do
 
   after do
     clean_singleton(subject)
+    ENV.delete("MANDRILL_API_KEY")
+    ENV.delete("API_KEY")
   end
 
   context "base config file" do
@@ -65,12 +67,12 @@ describe A9n do
 
     it do
       expect(subject.mandrill.username).to eq("joe")
-      expect(subject.mandrill.api_key).to eq("asdf1234")
+      expect(subject.mandrill.api_key).to eq("ASDF1234")
     end
 
     it do
       expect(subject.mandrill.fetch(:username)).to eq("joe")
-      expect(subject.mandrill.fetch(:api_key)).to eq("asdf1234")
+      expect(subject.mandrill.fetch(:api_key)).to eq("ASDF1234")
     end
 
     it do

data/spec/spec_helper.rb

@@ -1,17 +1,24 @@
-require 'simplecov'
-require 'codeclimate-test-reporter'
+require "simplecov"
+require "codeclimate-test-reporter"
 
 CodeClimate::TestReporter.start
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-require 'a9n'
+require "a9n"
 
 RSpec.configure do |config|
-  config.expect_with :rspec do |expect_with|
-    expect_with.syntax = :expect
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
   end
+
   config.order = "random"
   config.tty = true
 end

data/spec/unit/a9n_spec.rb

@@ -1,6 +1,4 @@
-require "spec_helper"
-
-describe A9n do
+RSpec.describe A9n do
   subject { described_class }
   before { clean_singleton(subject) }
   after { clean_singleton(subject) }
@@ -177,7 +175,7 @@ describe A9n do
       expect(described_class).to receive(:env).exactly(2).times.and_return("dev")
       subject.root = "/apps/test_app"
       files.each do |f, cfg|
-        expect(A9n::Loader).to receive(:new).with(f, "dev").and_return(double(get: cfg))
+        expect(A9n::Loader).to receive(:new).with(f, kind_of(A9n::Scope), "dev").and_return(double(get: cfg))
       end
     end
 

data/spec/unit/loader_spec.rb

@@ -1,12 +1,12 @@
-require "spec_helper"
-
-describe A9n::Loader do
+RSpec.describe A9n::Loader do
+  let(:scope) { A9n::Scope.new("configuration") }
   let(:env) { "test" }
   let(:root) { File.expand_path("../../../test_app", __FILE__) }
   let(:file_path) { File.join(root, "config/configuration.yml") }
-  subject { described_class.new(file_path, env) }
+  subject { described_class.new(file_path, scope, env) }
 
   describe "#intialize" do
+    it { expect(subject.scope).to eq(scope) }
     it { expect(subject.env).to eq(env) }
     it { expect(subject.local_file).to eq(file_path) }
     it { expect(subject.example_file).to eq("#{file_path}.example") }
@@ -26,9 +26,8 @@ describe A9n::Loader do
 
     context "when no 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(nil)
-        expect(subject).to receive(:verify!).never
+        expect(described_class).to receive(:load_yml).with(subject.example_file, scope, env).and_return(nil)
+        expect(described_class).to receive(:load_yml).with(subject.local_file, scope, env).and_return(nil)
       end
 
       it "raises expection"  do
@@ -40,9 +39,8 @@ describe A9n::Loader 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_config)
-        expect(described_class).to receive(:load_yml).with(subject.local_file, env).and_return(nil)
-        expect(described_class).to receive(:verify!).never
+        expect(described_class).to receive(:load_yml).with(subject.example_file, scope, env).and_return(example_config)
+        expect(described_class).to receive(:load_yml).with(subject.local_file, scope, env).and_return(nil)
         subject.load
       end
 
@@ -56,9 +54,8 @@ describe A9n::Loader 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_config)
-        expect(described_class).to receive(:verify!).never
+        expect(described_class).to receive(:load_yml).with(subject.example_file, scope, env).and_return(nil)
+        expect(described_class).to receive(:load_yml).with(subject.local_file, scope, env).and_return(local_config)
         subject.load
       end
 
@@ -73,8 +70,8 @@ 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_config)
-          expect(described_class).to receive(:load_yml).with(subject.local_file, env).and_return(example_config)
+          expect(described_class).to receive(:load_yml).with(subject.example_file, scope, env).and_return(example_config)
+          expect(described_class).to receive(:load_yml).with(subject.local_file, scope, env).and_return(example_config)
           subject.load
         end
 
@@ -88,8 +85,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_config)
-          expect(described_class).to receive(:load_yml).with(subject.local_file, env).and_return(local_config)
+          expect(described_class).to receive(:load_yml).with(subject.example_file, scope, env).and_return(example_config)
+          expect(described_class).to receive(:load_yml).with(subject.local_file, scope, env).and_return(local_config)
         end
 
         let(:missing_variables_names) { example_config.keys - local_config.keys }
@@ -105,7 +102,7 @@ describe A9n::Loader do
 
   describe ".load_yml" do
     let(:env) { "test" }
-    subject {  described_class.load_yml(file_path, env) }
+    subject {  described_class.load_yml(file_path, scope, env) }
 
     context "when file not exists" do
       let(:file_path) { "file_not_existing_in_the_universe.yml" }

data/spec/unit/scope_spec.rb

@@ -0,0 +1,27 @@
+RSpec.describe A9n::Scope do
+  subject { described_class.new(name) }
+
+  describe "#name" do
+    let(:name) { "configuration" }
+    it { expect(subject.name).to eq(:configuration) }
+  end
+
+  describe "#main?" do
+    context "when name is configuration" do
+      let(:name) { "configuration" }
+      it { expect(subject).to be_main }
+    end
+
+    context "when name is other than configuration" do
+      let(:name) { "mandrill" }
+      it { expect(subject).not_to be_main }
+    end
+  end
+
+  describe ".form_file_path" do
+    let(:path) { "config/a9n/mandrill.yml.example" }
+    subject { described_class.form_file_path(path) }
+
+    it { expect(subject.name).to eq(:mandrill) }
+  end
+end

data/spec/unit/struct_spec.rb

@@ -1,6 +1,4 @@
-require "spec_helper"
-
-describe A9n::Struct do
+RSpec.describe A9n::Struct do
   context "without any values" do
     subject { described_class.new }
 

data/test_app/config/a9n/mandrill.yml

@@ -1,3 +1,3 @@
 defaults:
   username: "joe"
-  api_key: "asdf1234"
+  api_key: :env

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: a9n
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Krzysztof Knapik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-26 00:00:00.000000000 Z
+date: 2015-09-16 00:00:00.000000000 Z
 dependencies: []
 description: a9n - ruby/rails apps configuration manager
 email:
@@ -18,6 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rspec.example"
 - ".ruby-version"
 - ".travis.yml"
@@ -32,12 +33,14 @@ files:
 - lib/a9n/capistrano/ver2x.rb
 - lib/a9n/ext/hash.rb
 - lib/a9n/loader.rb
+- lib/a9n/scope.rb
 - lib/a9n/struct.rb
 - lib/a9n/version.rb
 - spec/integration/a9n_spec.rb
 - spec/spec_helper.rb
 - spec/unit/a9n_spec.rb
 - spec/unit/loader_spec.rb
+- spec/unit/scope_spec.rb
 - spec/unit/struct_spec.rb
 - test_app/benchmark.rb
 - test_app/config/a9n/cloud.yml.erb
@@ -76,4 +79,5 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/a9n_spec.rb
 - spec/unit/loader_spec.rb
+- spec/unit/scope_spec.rb
 - spec/unit/struct_spec.rb