configster 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 0.0.2 (September 12, 2012)
+
+Features:
+
+  - Added the ability to load multiple configurations.
+  - Added an examples directory with a basic HTTParty and ActiveRecord example.
+
+Documentation:
+
+  - Fixed a "bug" in the README.
+  - Added a note about accessing Configster directly.
+  - Added additional notes that reference the examples directory.

data/README.md

@@ -23,9 +23,9 @@ Or install it yourself as:
 For most applications, you'll want to load Configster before you start loading the rest of your application.  For example:
 
     require 'configster'
-    Configster.load_configster!(File.join('path', 'to', 'my_config.yml'))
+    Configster.load!(File.join('path', 'to', 'my_config.yml'))
     
-You can also pass a raw hash of stuff into `load_configster!` as long as it's in the format of `"ClassName" => { 'variable' => 'whatever' }`
+You can also pass a raw hash of stuff into `load!` as long as it's in the format of `"ClassName" => { 'variable' => 'whatever' }`
 
 Then, just include Configster in any classes you want:
 
@@ -48,7 +48,7 @@ First, make yourself a nice little configuration file and save it to `~/my_sweet
 Then, you'll write your application like this:
 
     require 'configster'
-    Configster.load_configster!('~/my_sweet_app_credentials.yml')
+    Configster.load!('File.expand_path(~/my_sweet_app_credentials.yml'))
     
     class MySweetApp
 
@@ -69,8 +69,18 @@ Then, you'll write your application like this:
       
     end
     
+You can also access the configuration more directly without the mixin by doing the following:
+    
+    # Return the config as an instance of OpenStruct
+    Configster.config_for('MySweetApp')
+    
+    # Return the config as a raw hash
+    Configster.raw_config_for('MySweetApp')
+    
 Now you can share your application without hard coding and/or sharing your credentials.
 
+For more examples accessing Configster directly or using it without YAML, check the examples directory in the gem.
+
 ## Contributing
 
 1. Fork it

data/configster.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["patricktulskie@gmail.com"]
   gem.description   = %q{Configster is a tidy little configuration management utility for your application.  Store your configuration as YAML outside of your application.  You probably haven't heard of it.}
   gem.summary       = %q{Configster keeps your configuration out of your application.}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/PatrickTulskie/configster"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/examples/active_record_example.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+require 'configster'
+
+Configster.load!(
+  'my_production_database' => {
+    :adapter  => 'mysql2',
+    :database => 'configster_production_database',
+    :cast     => false
+    :encoding => 'utf8'
+    :username => 'configster',
+    :password => 'configitywiggy',
+    :socket   => '/tmp/mysql.sock'
+  }
+)
+
+# You don't have to load from the mixin - you can just access Configster directly for free form configurations.
+my_database_config = Configster.raw_config_for('my_production_database')
+my_database_config.symbolize_keys!
+
+# And throw it into ActiveRecord
+ActiveRecord::Base.establish_connection(my_database_config)

data/examples/httparty_example.rb

@@ -0,0 +1,22 @@
+require 'configster'
+
+# Do this in an initializer somewhere...
+Configster.load!(
+  'MySweetApp' => {
+    'username' => 'SweetUsername',
+    'password' => 'SweetPassword123'
+  }
+)
+    
+class MySweetApp
+
+  include Configster
+  include HTTParty
+  # Configure your class here and then you're all set
+  basic_auth configster.username, configster.password
+      
+  def timeline(which = :friends, options = { })
+    self.class.get("/statuses/#{which}_timeline.json", options)
+  end
+      
+end

data/lib/configster/configster.rb

@@ -5,11 +5,11 @@ module Configster
   # =========================================
   module ClassMethods
     def configster
-      @configster ||= Configster.configuration_for(self)
+      @configster ||= Configster.config_for(self)
     end
     
     def raw_configster
-      Configster.raw_configuration_for(self)
+      Configster.raw_config_for(self)
     end
   end
   
@@ -31,21 +31,24 @@ module Configster
   # ===========================
   # = Core Configster Methods =
   # ===========================
-  def self.load_configster!(configster_config)
-    @configster_config = case configster_config
+  def self.load!(configster_config)
+    @configster_config ||= { }
+    new_config = case configster_config
     when Hash
       configster_config
     when String
       YAML.load_file(configster_config)
     end
+    
+    @configster_config.merge!(new_config)
   end
   
-  def self.configuration_for(klass)
+  def self.config_for(klass)
     klass_config = @configster_config[klass.to_s]
     klass_config ? OpenStruct.new(klass_config).freeze : nil
   end
   
-  def self.raw_configuration_for(klass)
+  def self.raw_config_for(klass)
     @configster_config[klass.to_s]
   end
   

data/lib/configster/version.rb

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

data/spec/configster_spec.rb

@@ -3,10 +3,16 @@ require "spec_helper"
 describe Configster do
   
   subject { Configster }
-  it { should respond_to(:configuration_for) }
+  it { should respond_to(:config_for) }
   
   it "should be able to load the configuration for a specific class" do
-    Configster.configuration_for(KonfiguredKlass).should_not be_nil
+    Configster.config_for(KonfiguredKlass).should_not be_nil
+  end
+  
+  it "should not destroy other configurations when loading additional configs" do
+    Configster.load!('test_thing' => { 'test' => true })
+    Configster.config_for('test_thing').test.should be_true
+    Configster.config_for(KonfiguredKlass).user_name.should == 'configster'
   end
   
 end

data/spec/spec_helper.rb

@@ -26,7 +26,7 @@ RSpec.configure do |config|
   end
 end
 
-Configster.load_configster!(File.join($spec_root, 'configurations', 'test_configuration.yml'))
+Configster.load!(File.join($spec_root, 'configurations', 'test_configuration.yml'))
 
 class KonfiguredKlass
   include Configster

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configster
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-11 00:00:00.000000000 Z
+date: 2012-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70264095054640 !ruby/object:Gem::Requirement
+  requirement: &70104961260240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70264095054640
+  version_requirements: *70104961260240
 description: Configster is a tidy little configuration management utility for your
   application.  Store your configuration as YAML outside of your application.  You
   probably haven't heard of it.
@@ -32,11 +32,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - configster.gemspec
+- examples/active_record_example.rb
+- examples/httparty_example.rb
 - lib/configster.rb
 - lib/configster/configster.rb
 - lib/configster/version.rb
@@ -44,7 +47,7 @@ files:
 - spec/configurations/test_configuration.yml
 - spec/konfigured_klass_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/PatrickTulskie/configster
 licenses: []
 post_install_message: 
 rdoc_options: []