a9n 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+.bundle
+.config
+.yardoc
+Gemfile.lock
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp
+nbproject/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'rspec'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 knapo
+
+MIT License
+
+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,29 @@
+# A9n
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'a9n'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install a9n
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/a9n.gemspec

@@ -0,0 +1,17 @@
+# encoding: utf-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 app configuration}
+  gem.summary       = %q{Simple tool for managing app configuration}
+  gem.homepage      = "https://github.com/knapo/a9n"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "a9n"
+  gem.require_paths = ["lib"]
+  gem.version       = A9n::VERSION
+end

data/lib/a9n.rb

@@ -0,0 +1,56 @@
+require 'a9n/version'
+require 'a9n/store'
+
+module A9n
+  class ConfigurationNotLoaded < StandardError; end
+  class MissingConfigurationFile < StandardError; end
+  class MissingConfigurationVariables < StandardError; end
+  class NoSuchConfigurationVariable < StandardError; end
+  
+  class << self
+
+    def cfg
+      @@configuration
+    rescue NameError
+      raise ConfigurationNotLoaded.new("Configuration does not seem to be loaded. Plase call A9n.load.")
+    end
+
+    def local_app
+      @@local_app ||= Rails
+    end
+
+    def local_app=(local_app)
+      @@local_app = local_app
+    end
+
+    def load
+      base  = load_yml('config/configuration.yml.example')
+      local = load_yml('config/configuration.yml')
+
+      if base.nil? && local.nil?
+        raise MissingConfigurationFile.new("Neither config/configuration.yml.example nor config/configuration.yml was found")
+      end
+
+      if !base.nil? && !local.nil?
+        verify!(base, local)
+      end
+
+      @@configuration = Store.new(local || base)
+    end
+
+    def load_yml(file)
+      path = File.join(local_app.root, file)
+      return unless File.exists?(path)
+      YAML.load_file(path)[local_app.env]
+    end
+
+    private
+
+    def verify!(base, local)
+      missing_keys = base.keys - local.keys
+      if missing_keys.any?
+        raise MissingConfigurationVariables.new("Following variables are missing in your configuration file: #{missing_keys.join(',')}")
+      end
+    end
+  end
+end

data/lib/a9n/store.rb

@@ -0,0 +1,14 @@
+require 'ostruct'
+
+module A9n
+  class Store < OpenStruct
+    def method_missing(name, *args)
+      value = @table[name]
+      if value.nil?
+        raise NoSuchConfigurationVariable.new(name)
+      else
+        return value
+      end
+    end
+  end
+end

data/lib/a9n/version.rb

@@ -0,0 +1,3 @@
+module A9n
+  VERSION = "0.0.1"
+end

data/spec/a9n_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+
+describe A9n do
+  describe '.local_app' do
+    context 'when no rails found' do
+      it 'raises error' do
+        expect {
+          described_class.local_app
+        }.to raise_error(NameError, 'uninitialized constant Module::Rails')
+      end
+    end
+    
+    context 'when custom non-rails app is being used' do
+      let(:local_app) { stub(:env => 'test', :root => 'local_app') }
+      before { described_class.local_app = local_app}
+
+      specify { described_class.local_app.should == local_app }
+    end
+  end
+    
+  describe '.load' do
+    let(:base_sample_config){
+      { :app_url => 'http://127.0.0.1:3000' }
+    }
+    let(:local_sample_config){
+      { :app_host => '127.0.0.1:3000' }
+    }
+    subject { described_class.cfg }
+
+    context 'when no configuration file exists' do
+      before do
+        described_class.should_receive(:load_yml).with('config/configuration.yml.example').and_return(nil)
+        described_class.should_receive(:load_yml).with('config/configuration.yml').and_return(nil)
+        described_class.should_receive(:verify!).never
+      end
+      it 'raises expection'  do
+        lambda {
+          described_class.load
+        }.should raise_error(described_class::MissingConfigurationFile)
+      end
+    end
+    
+    context 'when base configuration file exists' do
+      before do
+        described_class.should_receive(:load_yml).with('config/configuration.yml.example').and_return(base_sample_config)
+        described_class.should_receive(:load_yml).with('config/configuration.yml').and_return(nil)
+        described_class.should_receive(:verify!).never
+        described_class.load
+      end
+      it { should_not be_nil }
+      its(:app_url) { should_not be_nil }
+      specify {
+        expect { subject.app_host }.to raise_error(described_class::NoSuchConfigurationVariable)
+      }
+    end
+
+    context 'when local configuration file exists' do
+      before do
+        described_class.should_receive(:load_yml).with('config/configuration.yml.example').and_return(nil)
+        described_class.should_receive(:load_yml).with('config/configuration.yml').and_return(local_sample_config)
+        described_class.should_receive(:verify!).never
+        described_class.load
+      end
+
+      it { should_not be_nil }
+      its(:app_host) { should_not be_nil }
+      specify {
+        expect { subject.app_url }.to raise_error(described_class::NoSuchConfigurationVariable)
+      }
+    end
+
+    context 'when both local and base configuration file exists' do
+      context 'with same data' do
+        before do
+          described_class.should_receive(:load_yml).with('config/configuration.yml.example').and_return(base_sample_config)
+          described_class.should_receive(:load_yml).with('config/configuration.yml').and_return(base_sample_config)
+          described_class.load
+        end
+        it { should_not be_nil }
+        its(:app_url) { should_not be_nil }
+        specify {
+          expect { subject.app_host }.to raise_error(described_class::NoSuchConfigurationVariable)
+        }
+      end
+
+      context 'with different data' do
+        before do
+          described_class.should_receive(:load_yml).with('config/configuration.yml.example').and_return(base_sample_config)
+          described_class.should_receive(:load_yml).with('config/configuration.yml').and_return(local_sample_config)
+        end
+        it 'raises expection'  do
+          expect {
+            described_class.load
+          }.to raise_error(described_class::MissingConfigurationVariables)
+        end
+      end
+    end
+  end
+
+  describe '.load_yml' do
+    let(:root) { File.dirname(__FILE__) }
+    subject {  described_class.load_yml(file_path) }
+
+    before do
+      described_class.should_receive(:local_app).at_least(:once).and_return(stub(:env => 'test', :root => root))
+    end
+
+    context 'when file not exists' do
+      let(:file_path) { 'file_not_existing_in_universe.yml' }
+      it 'returns nil' do
+        subject.should be_nil
+      end
+    end
+
+    context 'when file exists' do
+      let(:file_path) { 'fixtures/configuration.yml'}
+      it 'returns non-empty hash' do
+        subject.should be_kind_of(Hash)
+        subject.keys.should_not be_empty
+      end
+    end
+  end
+end

data/spec/fixtures/configuration.yml

@@ -0,0 +1,5 @@
+development:
+  app_url: 'http://127.0.0.1:3000'
+
+test:
+  app_url: 'http://127.0.0.1:3000'

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'a9n'
+require 'a9n/store'
+
+RSpec.configure do |config|
+  config.order = "random"
+end

data/spec/store_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe A9n::Store do
+  subject { described_class.new(:app_host => 'http://127.0.0.1:3000') }
+
+  it 'gets value' do
+    subject.app_host.should == 'http://127.0.0.1:3000'
+  end
+
+  it 'raises exception when value not exists' do
+    expect { 
+      subject.non_existing
+    }.to raise_error(A9n::NoSuchConfigurationVariable)
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: a9n
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Krzysztof Knapik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-05 00:00:00.000000000 Z
+dependencies: []
+description: Simple tool for managing app configuration
+email:
+- knapo@knapo.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- a9n.gemspec
+- lib/a9n.rb
+- lib/a9n/store.rb
+- lib/a9n/version.rb
+- spec/a9n_spec.rb
+- spec/fixtures/configuration.yml
+- spec/spec_helper.rb
+- spec/store_spec.rb
+homepage: https://github.com/knapo/a9n
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple tool for managing app configuration
+test_files:
+- spec/a9n_spec.rb
+- spec/fixtures/configuration.yml
+- spec/spec_helper.rb
+- spec/store_spec.rb