configreader 0.0.1 → 0.0.2

data/.rvmrc

@@ -1 +1 @@
-rvm --create use 1.9.2@config_reader
+rvm --create use 1.8.7@config_reader

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    configreader (0.0.1)
+    configreader (0.0.2)
       rails
 
 GEM

data/README.md

@@ -1,9 +1,11 @@
-# ConfigReader 0.0.1  [![Build Status](https://secure.travis-ci.org/TheGiftsProject/configreader.png)](http://travis-ci.org/TheGiftsProject/configreader)
+# ConfigReader 0.0.2  [![Build Status](https://secure.travis-ci.org/TheGiftsProject/configreader.png)](http://travis-ci.org/TheGiftsProject/configreader)
 
  ConfigReader provides an easy way to load up your configuration YAML files into Ruby objects,
  providing a more concise API to access your configuration data, by accessing methods instead of Hash keys. It also
  allows you to configure environment aware configuration objects, keeping your code DRY.
 
+ You can use it to access your FACEBOOK / ANALYTICS configuration YAML's for instance.
+
  Note: Only the first level YAML keys can be accessed as methods.
 
 ## Usage
@@ -17,30 +19,40 @@ Note: The examples are for a Rails 3 app.
 * The most simple way to use ConfigReader is to change your existing config initializer files to use it
 like so:
 
-Let's say you have a YAML config like  `config/initializers/example.rb`
+Let's say you have a YAML config like `config/facebook.yml`
 ```yaml
+ defaults:
+    id: default_id
+    secret_key: default_secret_key
  development:
-    some_config: 123
+    id: 123
+    secret_key: secret_key
  production:
-    some_config: 456
+    id: 456
+    secret_key: secret_key
  test:
-    some_config: 678
+    id: 678
+    secret_key: secret_key
  staging:
-    some_config: 154
+    id: 154
+    secret_key: secret_key
 ```
 
 In your config initializer, initialize an EnvConfigReader like so:
 ```ruby
-   EXAMPLE = ConfigReader::EnvConfigReader.new("example.yml")
+   FACEBOOK = ConfigReader::EnvConfigReader.new("facebook.yml")
 ```
 
-Then you could access EXAMPLE config from anywhere in your Rails app:
+Then you could access FACEBOOK config from anywhere in your Rails app:
 ```ruby
-   EXAMPLE.some_config
+   FACEBOOK.id
+   FACEBOOK.secret_key
 ```
 
-Since we are using an EnvConfigReader object, the some_config we asked for is loaded up from the current RAILS_ENVIRONMENT.
+Since we are using an EnvConfigReader object, the FACEBOOK.id key we asked for is loaded up from the current RAILS_ENVIRONMENT.
 By default, ConfigReader will assume your config folder is your Rails.root/config, and will build the full path using it.
+If the current environment is not specified in the YAML file (for example the demo environment) then EnvConfigReader will use
+the settings nested under the 'defaults' hash. If no 'defaults' hash exist then the EnvConfigReader will raise an exception.
 
 There's also a FlatConfigReader, which is the more basic version. it's useful for flat config files like so:
 ```yaml
@@ -79,7 +91,7 @@ in your Rails app, just like we already did in the initializers.
 like ConfigReader, so then you'll be able to access them using that object: `ConfigReader::EXAMPLE`
 
 `auto_create_config_folder` - The default value to the config_folder is `#{Rails.root}/config/configreader`. Use this config
-item to override it another path.
+item to override it to another path.
 
 ## Requirements
 

data/lib/configreader/env_configreader.rb

@@ -1,4 +1,4 @@
-require_relative './flat_configreader'
+require File.expand_path('../flat_configreader', __FILE__)
 
 module ConfigReader
 
@@ -8,7 +8,7 @@ module ConfigReader
 
     def initialize(file_name)
       super(file_name)
-      @data = @data[Rails.env]
+      @data = @data[Rails.env] || @data['defaults']
       raise EnvironmentNotFoundInYaml.new if @data.nil?
     end
 

data/lib/configreader/version.rb

@@ -1,3 +1,3 @@
 module ConfigReader
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/config/fake_env.yml

@@ -1,3 +1,8 @@
+defaults:
+  id: defaultID
+  appid: defaultAppID
+  certid: defaultCertID
+
 test:
   id:       testID
   devid:    devid

data/spec/lib/env_configreader_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require_relative '../../lib/configreader/env_configreader'
+require File.expand_path('../../../lib/configreader/env_configreader', __FILE__)
 
 describe ConfigReader::EnvConfigReader do
 
@@ -23,14 +23,23 @@ describe ConfigReader::EnvConfigReader do
     subject.id.should == "testID"
   end
 
-  context "configuration file with out test env" do
-    it "should raise an EnvironmentNotFoundInYaml when loading" do
+  context 'when an environment does not exist in the configuration' do
+
+    it 'should fallback to default settings if defaults exist' do
+      Rails.stub(:env) { 'unknown' }
+      config = ConfigReader::EnvConfigReader.new 'fake_env.yml'
+
+      config.id.should == 'defaultID'
+      config.appid.should == 'defaultAppID'
+      config.certid.should == 'defaultCertID'
+    end
+
+    it 'should raise an EnvironmentNotFoundInYaml when loading if defaults do not exist' do
       expect {
         ConfigReader::EnvConfigReader.new("fake_invalid.yml")
       }.to raise_error(ConfigReader::EnvConfigReader::EnvironmentNotFoundInYaml)
     end
-  end
-
 
+  end
 
 end

metadata

@@ -1,75 +1,78 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: configreader
-version: !ruby/object:Gem::Version
-  version: 0.0.1
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
 platform: ruby
-authors:
+authors: 
 - Itay Adler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-13 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-01-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !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
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: ! "ConfigReader provides an easy way to load up your configuration YAML
-  files into Ruby objects,\n                  providing a more concise API to access
-  your configuration data, by accessing methods instead of Hash keys. It also\n                  allows
-  you to configure environment aware configuration objects, and by so inverting the
-  logic of\n                  environment specific configuration into the ConfigReader."
-email:
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: |-
+  ConfigReader provides an easy way to load up your configuration YAML files into Ruby objects,
+                    providing a more concise API to access your configuration data, by accessing methods instead of Hash keys. It also
+                    allows you to configure environment aware configuration objects, and by so inverting the logic of
+                    environment specific configuration into the ConfigReader.
+email: 
 - itayadler@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gemspec
 - .gitignore
 - .rspec
@@ -96,29 +99,38 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/TheGiftsProject/configreader
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: ConfigReader - An easy way to manage your configuration files
-test_files:
-- spec/lib/config_spec.rb
-- spec/lib/env_configreader_spec.rb
+test_files: 
 - spec/lib/flat_configreader_spec.rb
+- spec/lib/env_configreader_spec.rb
+- spec/lib/config_spec.rb