gem_configurator 0.0.3 → 0.0.4

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.rvmrc

data/README.md

@@ -1,6 +1,6 @@
 # GemConfigurator
 
-TODO: Write a gem description
+Provides a simple, uniform way to configure a gem with a yaml file. Designed to work within a Rails app.
 
 ## Installation
 
@@ -18,7 +18,55 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Include the module into a class that you wish to configure via YAML.
+
+```ruby
+  class Foo
+    include GemConfigurator
+    
+    def initialize()
+      configure
+      ...
+    end
+    
+    ...
+  end
+```
+
+Within your rails app, place a config file in the /config directory. The config file's name must match the class's name. For example, to configure Foo, name the file foo.yml.
+
+Example yaml file:
+
+```yaml
+  development:
+    [setting name]: [setting value]
+    ...
+  
+  test: 
+    ...
+```    
+
+On instantiation, the settings for your current environment are placed in an instance variable called @settings. Retrieve the settings with `@settings[:setting_name]`
+
+### Default Settings
+
+If you want your object to have default settings, simply define a `default_settings` instance method.
+
+```ruby
+  class Foo
+    include GemConfigurator
+    
+    def initialize()
+      configure
+      ...
+    end
+    
+    def defualt_settings
+      {:setting_name => setting_value}
+    end
+```
+
+Default settings will be merged with any settings defined in the YAML file. YAML file settings will overwrite a default setting of the same name.
 
 ## Contributing
 

data/lib/gem_configurator/version.rb

@@ -1,3 +1,3 @@
 module GemConfigurator
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/gem_configurator.rb

@@ -2,9 +2,11 @@ require "gem_configurator/version"
 require 'active_support/inflector'
 
 module GemConfigurator
-  
+
   attr_reader :settings
   
+  private
+  
   def config_path
     config_file_name = "#{self.class.to_s.underscore}.yml"
     if defined?(Rails) && File.exists?(Rails.root.join("config",config_file_name))
@@ -30,10 +32,6 @@ module GemConfigurator
     end
   end
   
-  def test
-    self.private_methods.sort
-  end
-
   def parse_yaml(path)
     path ? YAML.load_file(path) : nil
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_configurator
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-23 00:00:00.000000000Z
+date: 2012-08-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: &2165596960 !ruby/object:Gem::Requirement
+  requirement: &2164680820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2165596960
+  version_requirements: *2164680820
 description: Implements a standard way of using yml files to configure gems.
 email:
 - ian@ianwhitney.com