basic_config 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+script: bundle exec rspec spec

data/README.md

@@ -1,5 +1,7 @@
 # BasicConfig
 
+[![Build Status](https://secure.travis-ci.org/stephan778/basic_config.png)](http://travis-ci.org/stephan778/basic_config)
+
 Friendly configuration wrapper. If you find yourself using things like:
 
 ```ruby
@@ -25,7 +27,12 @@ Or install it via RubyGems as:
 ## Usage
 
 ```ruby
+# Loading config is simple
 settings = BasicConfig.load_file('config.yml')
+# It's a simple variable, you can create as many as you like.
+# You can use constants for convinience:
+AppConfig = BasicConfig.load_file('config/app.yml')
+DatabaseConfig = BasicConfig.load_file('config/database.yml')
 
 # Access your configuration with simple method calls
 settings.some_param
@@ -45,7 +52,7 @@ If your file has sections for different environments:
 development:
   host: localhost
   port: 123
-test
+test:
   host: localhost
   port: 456
 ```
@@ -56,14 +63,14 @@ AppConfig = BasicConfig.load_env('config.yml', Rails.env)
 
 ## Why should I use it instead of plain Hash variables?
 
-### It raises errors when you unintentionally read non-existent keys:
+### It raises errors when you unintentionally read non-existent keys
 
 If you are using a `Hash`:
 ```ruby
 secret_token = AppConfig[:something]
 ```
-and for some reason your configuration does not have `:something` in it - you'll
-get a `nil`. Worst case: this `nil` will live inside your system compromising
+and for some reason your configuration does not have `:something` in it (or you
+make a typo) - you'll get a `nil`. Worst case: this `nil` will live inside your system compromising
 or corrupting some data until you finally notice and track it down back to this line.
 
 If you are using a `BasicConfig`:
@@ -78,7 +85,7 @@ particular key exist in your config - `AppConfig.include?(:something)`.
 Additionaly, for some keys it makes sense to get a `nil` when they do not exist and for this
 purpose there is a `[]` method which is delegated to underlying hash.
 
-### Works recursively.
+### Works recursively
 
 If your YAML is more than 1 level deep then simple `symbolize_keys` is not going to be enough:
 ```ruby
@@ -90,10 +97,16 @@ With BasicConfig above would look like this:
 AppConfig.something.have_to_use_string_here
 ```
 
-### Easier to test.
+### Easier to test
 
 You can stub out any config variable just like a normal method in your tests.
 
 ```ruby
 AppConfig.stub(:something).and_return('anything')
 ```
+
+## Gotchas
+
+The only thing that I can think of is be aware that you can not use Ruby Object
+method names for your configuration variable names (`puts`, `print`, `raise`,
+`display`, etc, you can see the full list with `BasicConfig.methods`).

data/basic_config.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(spec)/})
   gem.name          = 'basic_config'
   gem.require_path  = 'lib'
-  gem.version       = '0.0.1'
+  gem.version       = '0.0.2'
 
   gem.add_development_dependency('rspec', '~> 2.10')
 end

data/spec/basic_config_spec.rb

@@ -1,5 +1,4 @@
 require_relative '../lib/basic_config'
-require 'active_support/core_ext/hash'
 
 describe BasicConfig do
   let(:hash) do
@@ -11,6 +10,15 @@ describe BasicConfig do
       }
     }
   end
+  let(:symbolized_hash) do
+    {
+      :one => 'something',
+      :two => 'other_value',
+      :three => {
+        :nested => '123'
+      }
+    }
+  end
 
   subject { BasicConfig.new(hash) }
 
@@ -43,9 +51,7 @@ describe BasicConfig do
   end
 
   it 'can be converted back to hash' do
-    converted = subject.to_hash.stringify_keys
-    converted['three'] = converted['three'].stringify_keys
-    converted.should == hash
+    subject.to_hash.should == symbolized_hash
   end
 
   describe '::load_file' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: basic_config
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-30 00:00:00.000000000 Z
+date: 2012-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -36,6 +36,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md