a9n 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f995c7f50ba67e72854fae222d3f3d1d56954e5d
-  data.tar.gz: 85396eed16848d240fab8ede3ac86054bcb9078d
+  metadata.gz: 5f1aa00ff577227a9d07088e0053ea48814a8816
+  data.tar.gz: 932f917737c5c1c6cdb6919a9b16a1127a0a1c8f
 SHA512:
-  metadata.gz: fa210dc6b9944ee7c4e33fa06b0cc95f63d8393e2fb6c5eed6dcf687af48ce161454cfda0cce1029bf42b048e70a1544c42044912a5f96dea9a9b38015a77905
-  data.tar.gz: a31bb71f27ba83c90106a1138582b40c6fb695df20a14307772bcf04c4fc0a7e22bc255f57b07b14a9f05138ae0a87125d617de803081740bf977cd597a0c00c
+  metadata.gz: 1e69852a57a9f29d640d4983dfec8406c7943b038d07a5b58a441461a2f2ae7df8cfc6489c3df784dcb1b698a1c66ad8aeb4519c21c9bf00218217cc6478a507
+  data.tar.gz: d578632bc24b83cbfcdc835f7a76f727ba850bd527134bdd08940823af9a49d3a6d9d9655401d3428e5fa115724bdbb8c45ec21caf11a47a3346ea014ff9acff

data/.travis.yml

@@ -1,9 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.2
-  - jruby-19mode
+  - 2.1.5
+  - 2.2.0
 addons:
   code_climate:
     repo_token: 9aa2aa2432639c57772b6917ad9da468709e5536b75617575b02b35201a2eaf8

data/README.md

@@ -10,7 +10,7 @@
 [codeclimate]: https://codeclimate.com/github/knapo/a9n
 [coverage]: https://codeclimate.com/github/knapo/a9n
 
-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.
+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 2.0. 2.1, 2.2. Ruby 1.8 is not supported since version 0.1.2. Ruby 1.9 is not supported since version 0.4.0.
 
 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).
 

data/lib/a9n.rb

@@ -6,6 +6,8 @@ require "yaml"
 require "erb"
 
 module A9n
+  extend SingleForwardable
+
   class ConfigurationNotLoaded < StandardError; end
   class MissingConfigurationData < StandardError; end
   class MissingConfigurationVariables < StandardError; end
@@ -47,19 +49,6 @@ module A9n
       ENV[name]
     end
 
-    def fetch(*args)
-      scope(DEFAULT_SCOPE).fetch(*args)
-    end
-
-    def scope(name)
-      load unless instance_variable_defined?(var_name_for(name))
-      instance_variable_get(var_name_for(name))
-    end
-
-    def var_name_for(file)
-      :"@#{File.basename(file.to_s).split('.').first}"
-    end
-
     def default_files
       files  = Dir[root.join("config/#{DEFAULT_SCOPE}.#{EXTENSION_LIST}").to_s]
       files += Dir[root.join("config/a9n/*.#{EXTENSION_LIST}")]
@@ -67,28 +56,48 @@ module A9n
     end
 
     def load(*files)
-      if files.empty?
-        files = default_files
-      else
-        files = get_absolute_paths_for(files)
-      end
-      files.map do |file|
-        instance_variable_set(var_name_for(file), A9n::Loader.new(file, env).get)
-      end
+      files = files.empty? ? default_files : get_absolute_paths_for(files)
+      files.map { |file| load_file(file) }
+    end
+
+    def storage
+      @storage ||= A9n::Struct.new
     end
 
     def method_missing(name, *args)
-      if scope(name).is_a?(A9n::Struct)
-        scope(name)
+      load if storage.empty?
+      storage.send(name)
+    end
+
+    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)
+    end
+
+    def setup_scope(name, data)
+      if default_scope?(name)
+        storage.merge(data)
+        def_delegators :storage, *data.keys
       else
-        scope(DEFAULT_SCOPE).send(name, *args)
+        storage[name] = data
+        def_delegators :storage, name
       end
+      return data
     end
 
-    private
+    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
   end
 end

data/lib/a9n/struct.rb

@@ -2,6 +2,10 @@ require 'ostruct'
 
 module A9n
   class Struct < OpenStruct
+    def empty?
+      @table.empty?
+    end
+
     def keys
       @table.keys
     end
@@ -10,6 +14,16 @@ module A9n
       @table.fetch(name.to_sym, default)
     end
 
+    def key?(key)
+      to_h.key?(key)
+    end
+
+    def merge(key_value)
+      key_value.each_pair do |key, value|
+        self[key] = value
+      end
+    end
+
     def method_missing(name, *args)
       raise NoSuchConfigurationVariable.new(name)
     end

data/lib/a9n/version.rb

@@ -1,3 +1,3 @@
 module A9n
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

data/spec/integration/a9n_spec.rb

@@ -8,6 +8,7 @@ describe A9n do
   before {
     subject.app = double(env: env)
     subject.root = File.expand_path("../../../test_app", __FILE__)
+    subject.load
   }
 
   after {

data/spec/unit/a9n_spec.rb

@@ -4,6 +4,7 @@ describe A9n do
   subject { described_class }
 
   after {
+    subject.instance_variable_set(:@storage, nil)
     subject.instance_variable_set(:@env, nil)
     subject.root = nil
     subject.app = nil
@@ -105,41 +106,6 @@ describe A9n do
     it { expect(subject.get_env_var("IS_DWARF")).to be_nil}
   end
 
-  describe ".var_name_for" do
-    it { expect(subject.var_name_for(:configuration)).to eq(:@configuration) }
-    it { expect(subject.var_name_for("configuration.yml")).to eq(:@configuration) }
-    it { expect(subject.var_name_for("custom_dir/extra.yml")).to eq(:@extra) }
-  end
-
-  describe ".fetch" do
-    let(:example_config) { A9n::Struct.new({hello: "world"}) }
-    before {
-      expect(subject).to receive(:scope).with(subject::DEFAULT_SCOPE).twice.and_return(example_config)
-    }
-    it {
-      expect(subject.fetch(:hello)).to eq("world")
-      expect(subject.fetch(:wold)).to eq(nil)
-    }
-  end
-
-  describe ".scope" do
-    context "when config has been loaded" do
-      before {
-        subject.instance_variable_set(:@custom1, { api_key: '1234asdf'})
-        expect(subject).to receive(:load).never
-      }
-      it {
-        expect(subject.scope(:custom1)).to eq({ api_key: '1234asdf'})
-      }
-    end
-    context "when config has not been loaded yet" do
-      it {
-        expect(subject).to receive(:load)
-        subject.scope(:custom2)
-      }
-    end
-  end
-
   describe ".default_files" do
     before {
       subject.root = File.expand_path("../../../test_app", __FILE__)
@@ -195,4 +161,24 @@ describe A9n do
       }
     end
   end
+
+  describe ".method_missing" do
+    context "when storage is empty" do
+      before { expect(subject).to receive(:load).once }
+      it {
+        expect(subject.storage).to be_empty
+        expect { subject.whatever }.to raise_error(A9n::NoSuchConfigurationVariable)
+      }
+    end
+
+    context "when storage is not empty" do
+      before {
+        subject.storage[:whenever] = 'whenever'
+        expect(subject).not_to receive(:load)
+      }
+      it {
+        expect { subject.whatever }.to raise_error(A9n::NoSuchConfigurationVariable)
+      }
+    end
+  end
 end

data/spec/unit/struct_spec.rb

@@ -1,66 +1,109 @@
 require 'spec_helper'
 
 describe A9n::Struct do
-  subject {
-    described_class.new({
-        non_empty_dwarf: 'dwarf',
-        nil_dwarf:   nil,
-        false_dwarf: false,
-        true_dwarf:  true,
-        hash_dwarf:  { dwarf: 'hello' }
-      })
-  }
-
-  describe '#keys' do
-    subject { super().keys }
-    it { should == [:non_empty_dwarf, :nil_dwarf, :false_dwarf, :true_dwarf, :hash_dwarf] }
-  end
+  context "without any values" do
+    subject { described_class.new }
 
-  it 'gets non-empty value' do
-    expect(subject.non_empty_dwarf).to eq('dwarf')
-  end
+    it 'is empty' do
+      expect(subject).to be_empty
+    end
 
-  it 'gets nil value' do
-    expect(subject.nil_dwarf).to eq(nil)
+    it 'raises error' do
+      expect {
+        subject.dwarf
+      }.to raise_error(A9n::NoSuchConfigurationVariable, 'dwarf')
+    end
   end
 
-  it 'gets true value' do
-    expect(subject.true_dwarf).to eq(true)
-  end
+  context "with values" do
+    subject {
+      described_class.new({
+          non_empty_dwarf: 'dwarf',
+          nil_dwarf:   nil,
+          false_dwarf: false,
+          true_dwarf:  true,
+          hash_dwarf:  { dwarf: 'hello' }
+        })
+    }
 
-  it 'gets false value' do
-    expect(subject.false_dwarf).to eq(false)
-  end
+    describe '#keys' do
+      subject { super().keys }
 
-  it 'gets hash value' do
-    expect(subject.hash_dwarf).to be_kind_of(Hash)
-  end
+      it do
+        expect(subject).to eq [:non_empty_dwarf, :nil_dwarf, :false_dwarf, :true_dwarf, :hash_dwarf]
+      end
+    end
 
-  it 'raises exception when value not exists' do
-    expect {
-      subject.non_existing_dwarf
-    }.to raise_error(A9n::NoSuchConfigurationVariable)
-  end
+    describe '#merge' do
+      before { subject.merge(argument) }
+
+      context 'hash' do
+        let(:argument) { { non_empty_dwarf: 'hello dwarf' } }
+
+        it do
+          expect(subject.non_empty_dwarf).to eq('hello dwarf')
+        end
+      end
+
+      context 'struct' do
+        let(:argument) { described_class.new(non_empty_dwarf: 'hello dwarf') }
 
-  describe '#fetch' do
-    it 'return non empty value' do
-      expect(subject.fetch(:non_empty_dwarf)).to eq('dwarf')
+        it do
+          expect(subject.non_empty_dwarf).to eq('hello dwarf')
+        end
+      end
     end
 
-    it 'return false value' do
-      expect(subject.fetch(:false_dwarf)).to eq(false)
+    it 'is not empty' do
+      expect(subject).not_to be_empty
     end
 
-    it 'return nil value' do
-      expect(subject.fetch(:nil_dwarf)).to eq(nil)
+    it 'gets non-empty value' do
+      expect(subject.non_empty_dwarf).to eq('dwarf')
     end
 
-    it 'return nil for non existing value' do
-      expect(subject.fetch(:non_existing_dwarf)).to eq(nil)
+    it 'gets nil value' do
+      expect(subject.nil_dwarf).to eq(nil)
     end
 
-    it 'return default for non existing value' do
-      expect(subject.fetch(:non_existing_dwarf, 'default')).to eq('default')
+    it 'gets true value' do
+      expect(subject.true_dwarf).to eq(true)
+    end
+
+    it 'gets false value' do
+      expect(subject.false_dwarf).to eq(false)
+    end
+
+    it 'gets hash value' do
+      expect(subject.hash_dwarf).to be_kind_of(Hash)
+    end
+
+    it 'raises exception when value not exists' do
+      expect {
+        subject.non_existing_dwarf
+      }.to raise_error(A9n::NoSuchConfigurationVariable)
+    end
+
+    describe '#fetch' do
+      it 'return non empty value' do
+        expect(subject.fetch(:non_empty_dwarf)).to eq('dwarf')
+      end
+
+      it 'return false value' do
+        expect(subject.fetch(:false_dwarf)).to eq(false)
+      end
+
+      it 'return nil value' do
+        expect(subject.fetch(:nil_dwarf)).to eq(nil)
+      end
+
+      it 'return nil for non existing value' do
+        expect(subject.fetch(:non_existing_dwarf)).to eq(nil)
+      end
+
+      it 'return default for non existing value' do
+        expect(subject.fetch(:non_existing_dwarf, 'default')).to eq('default')
+      end
     end
   end
 end

data/test_app/benchmark.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'benchmark'
+require 'a9n'
+
+class SampleBenchmarkApp
+  def run
+    0.upto(1_000).map do |index|
+      "#{index} #{::A9n.string_dwarf} #{::A9n.overriden_dwarf}"
+    end
+  end
+
+  def root
+    Pathname.new('./test_app').expand_path
+  end
+
+  def env
+    :test
+  end
+end
+
+A9n.app = SampleBenchmarkApp.new
+results = []
+
+(1..10).each do
+  results << Benchmark.realtime { A9n.app.run }
+end
+
+puts (results.reduce(&:+) / 10).round(4)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: a9n
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Krzysztof Knapik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-14 00:00:00.000000000 Z
+date: 2015-02-17 00:00:00.000000000 Z
 dependencies: []
 description: a9n is a tool to keep ruby/rails apps extra configuration easily maintainable
   and verifiable
@@ -40,6 +40,7 @@ files:
 - spec/unit/a9n_spec.rb
 - spec/unit/loader_spec.rb
 - spec/unit/struct_spec.rb
+- test_app/benchmark.rb
 - test_app/config/a9n/cloud.yml.erb
 - test_app/config/a9n/mailer.yml.example
 - test_app/config/a9n/mandrill.yml