isomer 0.0.1

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/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Paul Guelpa
+
+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,72 @@
+# Isomer
+
+[![Build Status](https://travis-ci.org/pguelpa/isomer.png?branch=master)](https://travis-ci.org/pguelpa/isomer)
+
+Isomer is a gem to help manage your application's configuration files.
+It is built with the following ideas in mind:
+
+* Easily define, store, and save configuration parameters
+* Work with YAML files and environment variables
+* Allow for mapping from file / environment variables to parameter
+* Allow for required parameters
+* Allow for default parameters
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'isomer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install isomer
+
+## Usage
+
+For most configurations, you can use the simple setup approach
+
+```ruby
+MY_FANCY_CONFIGURATION = Isomer.configure(:yaml, base: Rails.env) do |config|
+  config.parameter :url # defaults to { required: false, from: 'url', default: nil }
+  config.parameter :api_key
+  config.parameter :timeout
+
+  config.parameter :logger, default: Rails.logger
+end
+```
+
+If you have a more complex setup, or want add extra methods to your configuration class, you can create your own.
+
+```ruby
+class MyFancyConfiguration < Isomer::Base
+  parameter :url # defaults to { required: false, name: 'url', default: nil }
+  parameter :api_key, required: true
+  parameter :timeout
+
+  parameter :logger, default: Rails.logger
+end
+```
+
+### Initialize with a YAML file
+
+```ruby
+MY_FANCY_CONFIGURATION = MyFancyConfiguration.from(:yaml, file: Rails.root.join('config', 'app_card.yml'), base: Rails.env)
+```
+
+### Initialize with environment variables
+
+```ruby
+MY_FANCY_CONFIGURATION = MyFancyConfiguration.from(:environment, prefix: 'FANCY_CONFIG_')
+```
+
+## 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/isomer.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'isomer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "isomer"
+  spec.version       = Isomer::VERSION
+  spec.authors       = ["Paul Guelpa"]
+  spec.email         = ["paul.guelpa@gmail.com"]
+  spec.description   = %q{A general configuration solution}
+  spec.summary       = %q{A general configuration solution}
+  spec.homepage      = ""
+  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"
+end

data/lib/isomer.rb

@@ -0,0 +1,13 @@
+require_relative 'isomer/version'
+require_relative 'isomer/errors'
+require_relative 'isomer/base'
+require_relative 'isomer/parameter'
+require_relative 'isomer/sources'
+
+module Isomer
+  def self.configure(source_type, options)
+    Class.new(Isomer::Base) do
+      yield(self)
+    end.from(source_type, options)
+  end
+end

data/lib/isomer/base.rb

@@ -0,0 +1,23 @@
+class Isomer::Base
+  attr_reader :source, :base
+
+  def self.from(source_type, options = {})
+    source = Isomer::Sources.factory(source_type, @parameters, options)
+    source.load_and_validate
+
+    new(source)
+  end
+
+  def self.parameter(id, options = {})
+    parameter = Isomer::Parameter.new(id, options)
+    (@parameters ||= []) << parameter
+
+    define_method(id) do
+      source.for(parameter)
+    end
+  end
+
+  def initialize(source)
+    @source = source
+  end
+end

data/lib/isomer/errors.rb

@@ -0,0 +1,2 @@
+class Isomer::RequiredParameterError < StandardError
+end

data/lib/isomer/parameter.rb

@@ -0,0 +1,18 @@
+class Isomer::Parameter
+  attr_reader :default
+
+  def initialize(id, options)
+    @id = id
+    @required = options[:required] || false
+    @from = options[:from]
+    @default = options[:default]
+  end
+
+  def name
+    (@from || @id).to_s
+  end
+
+  def required?
+    @required === true
+  end
+end

data/lib/isomer/sources.rb

@@ -0,0 +1,19 @@
+module Isomer::Sources
+  def self.factory(type, parameters=[], options={})
+    case type
+    when :test
+      Isomer::Sources::Test.new(parameters, options)
+    when :yaml
+      Isomer::Sources::Yaml.new(parameters, options)
+    when :environment
+      Isomer::Sources::Environment.new(parameters, options)
+    else
+      raise "Unknown source type #{source_type}"
+    end
+  end
+end
+
+require_relative 'sources/base'
+require_relative 'sources/test'
+require_relative 'sources/yaml'
+require_relative 'sources/environment'

data/lib/isomer/sources/base.rb

@@ -0,0 +1,42 @@
+class Isomer::Sources::Base
+  attr_reader :parameters, :configuration, :errors
+
+  def initialize(parameters)
+    @parameters = parameters
+    @errors = []
+  end
+
+  def load_and_validate
+    load
+    validate
+  end
+
+  def load
+    raise NotImplementedError, "You must implement 'load' in #{self.class.name}"
+  end
+
+  def validate
+    parameters.each do |parameter|
+      if parameter.required?
+        value = configuration[parameter.name]
+        @errors << "#{parameter.name} is required" if valid(value)
+      end
+    end
+
+    raise Isomer::RequiredParameterError, errors.join(', ') if !errors.empty?
+  end
+
+  def for(parameter)
+    configuration[parameter.name] || parameter.default
+  end
+
+  private
+
+  def valid(value)
+    if value.respond_to?(:empty)
+      value.empty?
+    else
+      value.nil?
+    end
+  end
+end

data/lib/isomer/sources/environment.rb

@@ -0,0 +1,28 @@
+class Isomer::Sources::Environment < Isomer::Sources::Base
+  attr_reader :prefix
+
+  def initialize(parameters, options={})
+    @convert_case = options.has_key?(:convert_case) ? options[:convert_case] : true
+    @prefix = options[:prefix]
+
+    super(parameters)
+  end
+
+  def load
+    @configuration = {}
+    parameters.each do |parameter|
+      @configuration[parameter.name] = ENV[ convert_name(parameter.name) ]
+    end
+  end
+
+  def convert_case?
+    @convert_case
+  end
+
+  private
+
+  def convert_name(name)
+    converted = [prefix, name].compact.join
+    convert_case? ? converted.upcase : converted
+  end
+end

data/lib/isomer/sources/test.rb

@@ -0,0 +1,12 @@
+class Isomer::Sources::Test < Isomer::Sources::Base
+  attr_accessor :payload
+
+  def initialize(parameters, options={})
+    @payload = options[:payload]
+    super(parameters)
+  end
+
+  def load
+    @configuration = payload
+  end
+end

data/lib/isomer/sources/yaml.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+
+class Isomer::Sources::Yaml < Isomer::Sources::Base
+  attr_reader :file, :base
+
+  def initialize(parameters, options={})
+    @file = options[:file]
+    @base = options[:base]
+
+    super(parameters)
+  end
+
+  def load
+    if File.exists?(file)
+      values = YAML.load_file(file)
+      if base && values.has_key?(base)
+        @configuration = values[base]
+      else
+        @configuration = values
+      end
+    end
+  end
+end

data/lib/isomer/version.rb

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

data/spec/isomer/base_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Isomer::Base do
+  describe '.from' do
+    let(:klass) { Class.new(Isomer::Base) { |c| c.parameter :something } }
+    let(:source) { double('Source', load_and_validate: anything)}
+
+    it 'passes along the type, parameters, and options to the factory' do
+      parameter = double('Parameter', required?: false)
+      Isomer::Parameter.stub(:new).and_return(parameter)
+
+      Isomer::Sources.
+        should_receive(:factory).
+        with(:foo, [parameter], {bar: 'bar-option'}).
+        and_return(source)
+
+      klass.from(:foo, {bar: 'bar-option'})
+    end
+  end
+
+  describe '.parameter' do
+    let(:klass) do
+      Class.new(Isomer::Base) do
+        parameter :the_value, default: 'foo', from: 'bar'
+      end
+    end
+
+    let(:instance) do
+      klass.from(:test, payload: {'the_value' => 'my-value'})
+    end
+
+    it 'creates a method for the parameter' do
+      instance.respond_to?(:the_value).should == true
+    end
+
+    it 'creates a new Parameter' do
+      parameter = Isomer::Parameter.new(:double, {})
+      Isomer::Parameter.should_receive(:new).
+        with(:the_value, {default: 'foo', from: 'bar'}).
+        and_return(parameter)
+
+      instance
+    end
+  end
+end

data/spec/isomer/parameter_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Isomer::Parameter do
+  describe '#default' do
+    it 'is set from the initializer' do
+      parameter = Isomer::Parameter.new(:foo, {default: 'my default'})
+      parameter.default.should == 'my default'
+    end
+  end
+
+  describe '#name' do
+    context 'when there is no from option' do
+      it 'returns the id as a string' do
+        parameter = Isomer::Parameter.new(:foo, {})
+        parameter.name.should == 'foo'
+      end
+    end
+
+    context 'when there is a from option' do
+      it 'returns the from value as a string' do
+        parameter = Isomer::Parameter.new(:bar, {from: :baz})
+        parameter.name.should == 'baz'
+      end
+    end
+  end
+
+  describe '#required?' do
+    it 'returns true when required is set to true' do
+      parameter = Isomer::Parameter.new(anything, {required: true})
+      parameter.required?.should == true
+    end
+
+    it 'returns false when required is set to anything other than true' do
+      parameter = Isomer::Parameter.new(anything, {required: 'blarg'})
+      parameter.required?.should == false
+    end
+  end
+end

data/spec/isomer/sources/base_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Isomer::Sources::Base do
+  describe '.new' do
+    it 'initalizes errors to an empty array' do
+      source = Isomer::Sources::Base.new(anything)
+      source.errors.should == []
+    end
+  end
+
+  describe '#load' do
+    it 'raises a NotImplementedError' do
+      source = Isomer::Sources::Base.new(anything)
+      expect {
+        source.load
+      }.to raise_error(NotImplementedError, "You must implement 'load' in Isomer::Sources::Base")
+    end
+  end
+
+  describe '#validate' do
+    it 'raises an error for any required parameters not specified' do
+      parameter = Isomer::Parameter.new(:the_value, required: true)
+      source = Isomer::Sources::Test.new([parameter], payload: {})
+      source.load
+
+      expect { source.validate }.to raise_error Isomer::RequiredParameterError
+    end
+  end
+
+  describe '#for' do
+    it 'returns the value for the parameter' do
+      parameter = double('Parameter', name: 'name')
+      source = Isomer::Sources::Test.new([parameter], payload: {'name' => 'value'})
+      source.load
+
+      source.for(parameter).should == 'value'
+    end
+
+    it 'returns the default if there is no configuration value' do
+      parameter = double('Parameter', name: 'name', default: 'bar')
+      source = Isomer::Sources::Test.new([parameter], payload: {})
+      source.load
+
+      source.for(parameter).should == 'bar'
+    end
+  end
+end

data/spec/isomer/sources/environment_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Isomer::Sources::Environment do
+  let(:parameter) { double('Parameter', name: 'token') }
+
+  describe '#load' do
+    it 'looks up the parameters from the environment' do
+      source = Isomer::Sources::Environment.new([parameter])
+
+      ENV.should_receive(:[]).with('TOKEN')
+      source.load
+    end
+
+    it 'stores all values in the configuration' do
+      source = Isomer::Sources::Environment.new([parameter])
+
+      ENV.stub(:[]).with('TOKEN').and_return('abcd-efgh')
+      source.load
+      source.configuration.should == {'token' => 'abcd-efgh'}
+    end
+
+    context 'with convert case off' do
+      it 'does not uppercase parameter names' do
+        source = Isomer::Sources::Environment.new([parameter], convert_case: false)
+
+        ENV.should_receive(:[]).with('token')
+        source.load
+      end
+    end
+
+    context 'with a prefix' do
+      it 'appends the prefix when looking up the environment variable' do
+        source = Isomer::Sources::Environment.new([parameter], prefix: 'APP_')
+
+        ENV.should_receive(:[]).with('APP_TOKEN')
+        source.load
+      end
+
+      it 'respects the convert case flag' do
+        source = Isomer::Sources::Environment.new([parameter], convert_case: false, prefix: 'app_')
+
+        ENV.should_receive(:[]).with('app_token')
+        source.load
+      end
+    end
+  end
+end

data/spec/isomer/sources/yaml_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Isomer::Sources::Yaml do
+  describe '#load' do
+    it 'loads the YAML file configuration file' do
+      File.stub(:exists?).and_return(true)
+      YAML.should_receive(:load_file).with('/home/configuration.yml').and_return({'foo' => 'bar'})
+
+      source = Isomer::Sources::Yaml.new(anything, file: '/home/configuration.yml')
+      source.load
+
+      source.configuration.should == {'foo' => 'bar'}
+    end
+
+    it 'does not raise if the file does not exist' do
+      source = Isomer::Sources::Yaml.new(anything, file: '/home/configuration.yml')
+      expect { source.load }.to_not raise_error
+    end
+
+    context 'with a base' do
+      it 'returns the configuration under the base node' do
+        File.stub(:exists?).and_return(true)
+        YAML.stub(:load_file).and_return( 'production' => {'limit' => 100} )
+
+        source = Isomer::Sources::Yaml.new(anything, base: 'production')
+        source.load
+
+        source.configuration.should == {'limit' => 100}
+      end
+    end
+  end
+end

data/spec/isomer/sources_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Isomer::Sources do
+  describe '.factory' do
+    context 'with a source of :yaml' do
+      it 'uses the yaml source' do
+        Isomer::Sources::Yaml.
+          should_receive(:new).
+          with([], path: '/tmp/foo/bar.yml', base: 'development')
+
+        Isomer::Sources.factory(:yaml, [], path: '/tmp/foo/bar.yml', base: 'development')
+      end
+    end
+
+    context 'with a source of :environment' do
+      it 'uses the environment source' do
+        Isomer::Sources::Environment.
+          should_receive(:new).
+          with([], prefix: 'APP_')
+
+        Isomer::Sources.factory(:environment, [], prefix: 'APP_')
+      end
+    end
+
+    context 'with a source of :test' do
+      it 'uses the test source' do
+        Isomer::Sources::Test.
+          should_receive(:new).
+          with([], payload: {})
+
+        Isomer::Sources.factory(:test, [], payload: {})
+      end
+    end
+  end
+end

data/spec/isomer_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Isomer do
+  describe '.configure' do
+    before do
+      Isomer::Base.stub(:from)
+    end
+
+    it 'yields the configuration to the class' do
+      expect do |b|
+        Isomer.configure(anything, {}, &b)
+      end.to yield_control
+    end
+
+    it 'creates a new instance of the configuration class' do
+      klass = double('Anonymous Class')
+      Class.stub(:new).with(Isomer::Base).and_return(klass)
+
+      klass.should_receive(:from).with(:foo, :bar).and_return(:baz)
+      Isomer.configure(:foo, :bar).should == :baz
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'isomer'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: isomer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul Guelpa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A general configuration solution
+email:
+- paul.guelpa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- isomer.gemspec
+- lib/isomer.rb
+- lib/isomer/base.rb
+- lib/isomer/errors.rb
+- lib/isomer/parameter.rb
+- lib/isomer/sources.rb
+- lib/isomer/sources/base.rb
+- lib/isomer/sources/environment.rb
+- lib/isomer/sources/test.rb
+- lib/isomer/sources/yaml.rb
+- lib/isomer/version.rb
+- spec/isomer/base_spec.rb
+- spec/isomer/parameter_spec.rb
+- spec/isomer/sources/base_spec.rb
+- spec/isomer/sources/environment_spec.rb
+- spec/isomer/sources/yaml_spec.rb
+- spec/isomer/sources_spec.rb
+- spec/isomer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4134372492786935908
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4134372492786935908
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A general configuration solution
+test_files:
+- spec/isomer/base_spec.rb
+- spec/isomer/parameter_spec.rb
+- spec/isomer/sources/base_spec.rb
+- spec/isomer/sources/environment_spec.rb
+- spec/isomer/sources/yaml_spec.rb
+- spec/isomer/sources_spec.rb
+- spec/isomer_spec.rb
+- spec/spec_helper.rb