isomer 0.0.1 → 0.1.0

data/README.md

@@ -30,9 +30,9 @@ Or install it yourself as:
 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
+MY_FANCY_CONFIGURATION = Isomer.configure(:yaml, file: File.join('config', 'fancy.yml')) do |config|
+  config.parameter :url, name: 'host'
+  config.parameter :api_key, required: true
   config.parameter :timeout
 
   config.parameter :logger, default: Rails.logger
@@ -43,24 +43,63 @@ If you have a more complex setup, or want add extra methods to your configuratio
 
 ```ruby
 class MyFancyConfiguration < Isomer::Base
-  parameter :url # defaults to { required: false, name: 'url', default: nil }
+  parameter :url, name: 'host'
   parameter :api_key, required: true
   parameter :timeout
 
   parameter :logger, default: Rails.logger
 end
+
+...
+
+# In some initializer
+MY_FANCY_CONFIG = MyFancyConfiguration.from(:yaml, file: File.join('config', 'fancy.yml'))
 ```
 
+## Parameters
+
+The core of Isomer is allowing you to define the parameters to pull out of your configuration source.  It takes a parameter name along with a number of options.
+
+The name will be how you access the value from the configuration object.  It also is the default value used when trying to find the value of the parameter in the source.
+
+You can also specify a number of parameters:
+
+* `required`: Means this parameter is required.  If any are missing, `from` will raise a Isomer::RequiredParameterError.  Defaults to `false`
+* `name`: If the configuration source uses a different name than that of the parameter
+* `default`: If you want to specify a default value
+
+## Sources
+
 ### Initialize with a YAML file
 
+#### Options
+
+* `file`: Path to the YAML file (required)
+* `root`: If there are multiple configurations (eg. for different environments), you can specify which one to use
+* `required`: If the configuration file is required
+
+
+#### Example
+
 ```ruby
-MY_FANCY_CONFIGURATION = MyFancyConfiguration.from(:yaml, file: Rails.root.join('config', 'app_card.yml'), base: Rails.env)
+MY_FANCY_CONFIGURATION = MyFancyConfiguration.from(:yaml, file: Rails.root.join('config', 'fancy.yml'), base: Rails.env) do |config|
+  ...
+end
 ```
 
 ### Initialize with environment variables
 
+#### Options
+
+* `convert_case`: Should we automatically uppercase any parameter names when looking for the environment variable (defaults to `true`)
+* `prefix`: Add a prefix when looking up all parameters in the environment
+
+#### Example
+
 ```ruby
-MY_FANCY_CONFIGURATION = MyFancyConfiguration.from(:environment, prefix: 'FANCY_CONFIG_')
+MY_FANCY_CONFIGURATION = MyFancyConfiguration.from(:environment, prefix: 'FANCY_CONFIG_') do |config|
+  ...
+end
 ```
 
 ## Contributing

data/lib/isomer/errors.rb

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

data/lib/isomer/parameter.rb

@@ -4,12 +4,12 @@ class Isomer::Parameter
   def initialize(id, options)
     @id = id
     @required = options[:required] || false
-    @from = options[:from]
+    @name = options[:name]
     @default = options[:default]
   end
 
   def name
-    (@from || @id).to_s
+    (@name || @id).to_s
   end
 
   def required?

data/lib/isomer/sources/yaml.rb

@@ -1,11 +1,14 @@
 require 'yaml'
 
 class Isomer::Sources::Yaml < Isomer::Sources::Base
-  attr_reader :file, :base
+  attr_reader :file, :base, :required
 
   def initialize(parameters, options={})
     @file = options[:file]
+    raise Isomer::Error, "YAML source requires the 'file' parameter" if file.nil? || file.empty?
+
     @base = options[:base]
+    @required = !!options[:required]
 
     super(parameters)
   end
@@ -18,6 +21,9 @@ class Isomer::Sources::Yaml < Isomer::Sources::Base
       else
         @configuration = values
       end
+    else
+      raise Isomer::Error, "Missing required configuration file '#{file}'" if required
+      @configuration = {}
     end
   end
 end

data/lib/isomer/version.rb

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

data/spec/isomer/parameter_spec.rb

@@ -18,7 +18,7 @@ describe Isomer::Parameter do
 
     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 = Isomer::Parameter.new(:bar, {name: :baz})
         parameter.name.should == 'baz'
       end
     end

data/spec/isomer/sources/yaml_spec.rb

@@ -1,6 +1,14 @@
 require 'spec_helper'
 
 describe Isomer::Sources::Yaml do
+  describe '.new' do
+    it 'blows up if the file parameter is missing' do
+      expect {
+        Isomer::Sources::Yaml.new(anything)
+      }.to raise_error(Isomer::Error, "YAML source requires the 'file' parameter")
+    end
+  end
+
   describe '#load' do
     it 'loads the YAML file configuration file' do
       File.stub(:exists?).and_return(true)
@@ -12,9 +20,28 @@ describe Isomer::Sources::Yaml do
       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
+    context 'when the file does not exist' do
+      context 'when it is not required' do
+        it 'does not blow up' do
+          source = Isomer::Sources::Yaml.new(anything, file: '/home/configuration.yml')
+          expect { source.load }.to_not raise_error
+        end
+
+        it 'sets the configuration to an empty hash' do
+          source = Isomer::Sources::Yaml.new(anything, file: '/home/configuration.yml')
+          source.load
+          source.configuration.should == {}
+        end
+      end
+
+      context 'when it is required' do
+        it 'raises an error' do
+          source = Isomer::Sources::Yaml.new(anything, file: '/home/configuration.yml', required: true)
+          expect {
+            source.load
+          }.to raise_error(Isomer::Error, "Missing required configuration file '/home/configuration.yml'")
+        end
+      end
     end
 
     context 'with a base' do
@@ -22,7 +49,7 @@ describe Isomer::Sources::Yaml 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 = Isomer::Sources::Yaml.new(anything, file: 'filish.yml', base: 'production')
         source.load
 
         source.configuration.should == {'limit' => 100}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: isomer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-08 00:00:00.000000000 Z
+date: 2013-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4134372492786935908
+      hash: 1846134878671279424
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4134372492786935908
+      hash: 1846134878671279424
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25