armoire 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42a40ddec2fa56e735333d7637b35fa2c2cf0888
+  data.tar.gz: 3aa33261a4a659f3aaa01b10ce90a2d21dc5340f
+SHA512:
+  metadata.gz: f2a1e5a29ab8c10fb9a0f85f6e51d5c9c545840c4ae09f4e882a5eaa1a8a6aedb8840519854c0d0a881830e2e7e5f959f6ed3cc328783bbe26ac80dd44a87edb
+  data.tar.gz: 9afb5e3ab52352fbbbbdb74418d9e2dda6d146acd61df59ca555c196bb45564c63873c45c624390a3925c9993887e3d355a4a9d3cfe8a84f85500bdbd60a8657

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in configuration.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Smith
+
+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,52 @@
+# Armoire [![Build Status](https://travis-ci.org/mikespokefire/armoire.png?branch=master)](https://travis-ci.org/mikespokefire/armoire) [![Code Climate](https://codeclimate.com/github/mikespokefire/armoire.png)](https://codeclimate.com/github/mikespokefire/armoire)
+
+A simple configuration tool for your ruby application settings
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'configuration'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install configuration
+
+## Usage
+
+Armoire should be simple. Simply create a yaml file in `config/application.yml` with the following:
+
+    development:
+      foo: "bar"
+      baz: 42
+      nested_options:
+        nested_foo: "nested_bar"
+        nested_baz: 99.999
+      boolean_value: true
+      parsed_things: <% "something_in_erb" %>
+
+    test:
+      foo: "bar"
+      baz: 42
+      nested_options:
+        nested_foo: "nested bar"
+        nested_baz: 99.999
+      boolean_value: true
+      parsed_things: <% "something_in_erb" %>
+
+Simply call `Armoire["foo"]` to get `"bar"` or `Armoire["nested_options"]["nested_foo"]` to get `"nested_bar"`. Any ERB will be parsed when the config file is loaded. If a configuration option is missing, it will throw an `Armoire::ConfigSettingMissing` exception.
+
+The configuration environment will initially be taken from `ENV['RAILS_ENV']`, then `ENV['RACK_ENV']` and if neither exist then it will fall back to `development`
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/armoire.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'armoire/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "armoire"
+  spec.version       = Armoire::VERSION
+  spec.authors       = ["Michael Smith"]
+  spec.email         = ["mike@spokefire.co.uk"]
+  spec.description   = %q{A simple configuration tool}
+  spec.summary       = %q{A simple configuration tool}
+  spec.homepage      = "https://github.com/mikespokefire/armoire"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13"
+  spec.add_development_dependency "simplecov", "~> 0.7"
+end

data/lib/armoire/railtie.rb

@@ -0,0 +1,7 @@
+class Armoire
+  class Railtie < Rails::Railtie
+    config.before_configuration do
+      Armoire.load! Rails.root.join('config', 'application.yml')
+    end
+  end
+end

data/lib/armoire/setting.rb

@@ -0,0 +1,18 @@
+class Armoire
+  class Setting
+    def initialize(setting)
+      @setting = setting
+    end
+
+    def [](key)
+      value = setting.fetch(key) do
+        raise ConfigSettingMissing, %Q{"#{key}" is not set}
+      end
+
+      value.kind_of?(Hash) ? self.class.new(value) : value
+    end
+
+    private
+    attr_reader :setting
+  end
+end

data/lib/armoire/version.rb

@@ -0,0 +1,3 @@
+class Armoire
+  VERSION = "1.0.1"
+end

data/lib/armoire.rb

@@ -0,0 +1,36 @@
+require 'singleton'
+require 'yaml'
+
+require "armoire/setting"
+require "armoire/version"
+require "armoire/railtie" if defined?(Rails)
+
+class Armoire
+  include Singleton
+
+  attr_accessor :settings
+
+  def environment
+    ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+  end
+
+  def self.[](key)
+    instance.settings[key]
+  end
+
+  def self.load!(path_to_config_file)
+    instance.settings = Setting.new(instance.load_settings(path_to_config_file))
+  end
+
+  def load_settings(path_to_config_file)
+    YAML.load(ERB.new(File.read(path_to_config_file)).result)[environment]
+  rescue Errno::ENOENT => e
+    raise MissingSettingsFile.new('The settings file cannot be found')
+  end
+
+  # When the settings file cannot be read, this exception will be raised
+  class MissingSettingsFile < StandardError; end
+
+  # When a config setting isn't set, this exception will be raised
+  class ConfigSettingMissing < StandardError; end
+end

data/spec/fixtures/application.yml

@@ -0,0 +1,6 @@
+test:
+  simple_config_option: "simple_config_option_value"
+  erb_config_option: <%= "erb_config_option_value" %>
+  nested:
+    config:
+      option: "nested_config_option_value"

data/spec/fixtures/custom_load.yml

@@ -0,0 +1,2 @@
+test:
+  custom_config_option: "custom_config_option_value"

data/spec/lib/armoire/setting_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Armoire::Setting do
+  let(:setting) do
+    described_class.new({
+      "simple" => "simple value",
+      "nested" => {
+        "config" => "nested config value"
+      }
+    })
+  end
+
+  describe '#[]' do
+    context 'setting is a value' do
+      subject { setting["simple"] }
+
+      it 'returns the value' do
+        expect(subject).to eql("simple value")
+      end
+    end
+
+    context 'setting is a hash' do
+      subject { setting["nested"] }
+
+      it 'returns a new setting object' do
+        expect(subject).to be_an_instance_of(described_class)
+      end
+    end
+
+    context 'it can be chained' do
+      subject { setting["nested"]["config"] }
+      it 'returns the nested value' do
+        expect(subject).to eql("nested config value")
+      end
+    end
+
+    context 'missing key' do
+      subject { setting["missing_setting"] }
+      it "raises an error" do
+        expect { subject }.to raise_error(Armoire::ConfigSettingMissing, '"missing_setting" is not set')
+      end
+    end
+  end
+end

data/spec/lib/armoire_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe Armoire do
+  describe '#.environment' do
+    subject { described_class.instance.environment }
+
+    context "ENV['RAILS_ENV'] is set" do
+      before do
+        @prev_rails_env = ENV['RAILS_ENV']
+        ENV['RAILS_ENV'] = 'rails_env'
+      end
+
+      it "returns the result of ENV['RAILS_ENV'] as first priority" do
+        expect(subject).to eql('rails_env')
+      end
+
+      after do
+        ENV['RAILS_ENV'] = @prev_rails_env
+      end
+    end
+
+    context "ENV['RACK_ENV'] is set" do
+      before do
+        @prev_rails_env = ENV['RAILS_ENV']
+        @prev_rack_env = ENV['RACK_ENV']
+        ENV['RAILS_ENV'] = nil
+        ENV['RACK_ENV'] = 'rack_env'
+      end
+
+      it "returns the result of ENV['RACK_ENV'] as second priority" do
+        expect(subject).to eql('rack_env')
+      end
+
+      after do
+        ENV['RAILS_ENV'] = @prev_rails_env
+        ENV['RACK_ENV'] = @prev_rack_env
+      end
+    end
+
+    context "nothing is set" do
+      before do
+        @prev_rails_env = ENV['RAILS_ENV']
+        @prev_rack_env = ENV['RACK_ENV']
+        ENV['RAILS_ENV'] = nil
+        ENV['RACK_ENV'] = nil
+      end
+
+      it "returns development as a fallback if nothing else is set" do
+        expect(subject).to eql("development")
+      end
+
+      after do
+        ENV['RAILS_ENV'] = @prev_rails_env
+        ENV['RACK_ENV'] = @prev_rack_env
+      end
+    end
+  end
+
+  describe '#[]' do
+    context "simple config option" do
+      subject { Armoire["simple_config_option"] }
+
+      it { expect(subject).to eql("simple_config_option_value") }
+    end
+
+    context "erb config option" do
+      subject { Armoire["erb_config_option"] }
+
+      it { expect(subject).to eql("erb_config_option_value") }
+    end
+
+    context "nested config option" do
+      subject { Armoire["nested"]["config"]["option"] }
+
+      it { expect(subject).to eql("nested_config_option_value") }
+    end
+
+    context 'config setting is missing' do
+      subject { Armoire["missing_setting"] }
+
+      it "raises an error" do
+        expect { subject }.to raise_error(Armoire::ConfigSettingMissing, '"missing_setting" is not set')
+      end
+    end
+
+    context 'nested config setting is missing' do
+      subject { Armoire["nested"]["config"]["missing_setting"] }
+
+      it "raises an error" do
+        expect { subject }.to raise_error(Armoire::ConfigSettingMissing, '"missing_setting" is not set')
+      end
+    end
+  end
+
+  describe '.load!' do
+    context 'setting files exists' do
+      before do
+        Armoire.load! File.expand_path('../fixtures/custom_load.yml', File.dirname(__FILE__))
+      end
+
+      it "returns the new config settings" do
+        expect(Armoire["custom_config_option"]).to eql("custom_config_option_value")
+      end
+
+      it "doesn't keep the original settings" do
+        expect { Armoire["simple_config_option"] }.to raise_error(Armoire::ConfigSettingMissing, '"simple_config_option" is not set')
+      end
+    end
+
+    context 'settings file does not exist' do
+      subject { Armoire.load! File.expand_path('../fixtures/missing_file.yml', File.dirname(__FILE__)) }
+
+      it "returns an exception" do
+        expect { subject }.to raise_error(Armoire::MissingSettingsFile, 'The settings file cannot be found')
+      end
+    end
+
+    after do
+      Armoire.load! File.expand_path('../fixtures/application.yml', File.dirname(__FILE__))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'simplecov'
+SimpleCov.start
+
+require 'armoire'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.order = 'random'
+
+  config.before(:all) do
+    Armoire.load! File.expand_path('fixtures/application.yml', File.dirname(__FILE__))
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: armoire
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Michael Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: A simple configuration tool
+email:
+- mike@spokefire.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- armoire.gemspec
+- lib/armoire.rb
+- lib/armoire/railtie.rb
+- lib/armoire/setting.rb
+- lib/armoire/version.rb
+- spec/fixtures/application.yml
+- spec/fixtures/custom_load.yml
+- spec/lib/armoire/setting_spec.rb
+- spec/lib/armoire_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mikespokefire/armoire
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A simple configuration tool
+test_files:
+- spec/fixtures/application.yml
+- spec/fixtures/custom_load.yml
+- spec/lib/armoire/setting_spec.rb
+- spec/lib/armoire_spec.rb
+- spec/spec_helper.rb