rails_simple_config 0.0.1 → 0.0.2

data/README.md

@@ -13,12 +13,20 @@ Add RailsSimpleConfig to your Gemfile:
 Run the generator to create the default configuration file:
 
     rails generate rails_simple_config:install
+    
+The generator will create 3 files in your Rails root directory; namely `secrets.yml`, `secrets.example.yml` and `config.yml`. 
+
+The `secrets.yml` should _not_ be committed to source control, and it should be used to keep settings which are 
+considered a secret; such as your Amazon credentials. These settings will be loaded first. The `secrets.example.yml` filename
+can be added to source control and kept as an _example_ of the settings contained in the `secrets.yml` file.
+
+The `config.yml` file should contain all other configuration settings.
 
 ## Usage
 
 ### Define configuration settings
 
-Define your settings in the generated `config.yml` file, found in your Rails root directory. 
+Define your settings in the generated `secrets.yml` and `config.yml` file, found in your Rails root directory. 
 
 The file contains sections for the development, test and production Rails environments, and a shared section.
 It can also contain ERB code so that more advanced configuration scenarios can be supported.
@@ -95,6 +103,9 @@ For example, the `SimpleConfig.no_reply_email` will be accessible to the [devise
 
 `SimpleConfig` inherits from [ActiveSupport::OrderedOptions](http://api.rubyonrails.org/classes/ActiveSupport/OrderedOptions.html), so accessing undefined settings will always return `nil`.
 
+In development, the configuration is reloaded upon each request, however, any configuration used within the `application.rb` filename
+or any initializers will _not_ be automatically reloaded, without having to restart your web server.
+
 ## Project Info
 
 RailsSimpleConfig is hosted on [Github](http://github.com/virtualstaticvoid/rails_simple_config), where your contributions, forkings, comments and feedback are greatly welcomed.

data/lib/generators/rails_simple_config/install/install_generator.rb

@@ -4,6 +4,8 @@ module RailsSimpleConfig
     
     def copy_files
       template "config.yml", "./config.yml"
+      template "secrets.yml", "./secrets.yml"
+      template "secrets.yml", "./secrets.example.yml"
     end
   
   end

data/lib/rails_simple_config.rb

@@ -10,7 +10,18 @@ module SimpleConfig
 
     def load!
       puts "Loading configuration for '#{Rails.env}'."
-      filename = Rails.root + 'config.yml'
+      load(Rails.root + 'secrets.yml')
+      load(Rails.root + 'config.yml')
+    end
+    
+    def reload!
+      clear
+      load!
+    end
+    
+    private
+    
+    def load(filename)
       if File.exist?(filename)
         configuration = YAML.load(ERB.new(File.read(filename)).result)[Rails.env]
         configuration.each do |key, value|
@@ -18,11 +29,6 @@ module SimpleConfig
         end if configuration
       end
     end
-    
-    def reload!
-      clear
-      load!
-    end
 
   end
 
@@ -32,6 +38,10 @@ module SimpleConfig
     @@config.load!
   end
   
+  def self.reload!
+    @@config.reload!
+  end
+
   def self.method_missing(method, *args)
     @@config.__send__(method, *args)
   end

data/lib/rails_simple_config/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_simple_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: 2011-08-23 00:00:00.000000000Z
+date: 2011-09-09 00:00:00.000000000Z
 dependencies: []
 description: A simple YAML based configuration for Ruby on Rails 3+, which supports
   shared settings, ERB and more.