dynamic_configuration 0.2.0 → 0.3.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Jarosław Rzeszótko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README

@@ -0,0 +1,157 @@
+# dynamic_configuration
+
+Rails made great innovations in almost all areas of web application
+development, yet it surprisingly does not provide any means for
+application configuration, and each of the so far available plugins I
+have seen had some serious disadvantages. Here are the features that
+differentiate dynamic_configuration from other configuration plugins:
+
+ * very easy setup with only two lines of code
+
+ * configuration files are very clean-looking Ruby files
+
+ * in Rails development environment, one doesn't have to restart the
+   server to add/remove/modify a setting
+
+ * the settings are divided into groups, each group being defined in a
+   separate file, making it easier to remember individual setting
+   names and maintain the whole configuration
+
+ * settings can be overridden per-Rails-environment and locally for a
+   given installation (useful for customizing the configuration
+   per-server, while keeping the core settings in Git)
+
+ * throughout field- and unit- tested
+
+Developed as part of my work for http://www.tutoria.de/.
+
+## Setup
+
+### Rails 3 application:
+
+Add the gem to your Gemfile:
+
+  gem 'dynamic_configuration'
+
+Create a config/options directory, then a config/options/options.rb
+file with the following contents:
+
+  DynamicConfiguration::create(:Options, File.join(Rails.root, "config/options"))
+
+Require config/options/options.rb somewhere in your
+config/application.rb, like this:
+
+  module SomeApplication
+    class Application < Rails::Application
+      require "config/options/options"
+        
+      # ..., rest of the config
+    end
+  end
+
+### Ruby application:
+
+Create a subdirectory of your project directory where you want to
+store the options, e. g. options/, and put the following before your
+application initialization code:
+
+  DynamicConfiguration::create(:Options, "options/")
+
+## Usage
+
+### Basics
+
+You create a settings group by creating a file somewhere in the
+options directory, to see how it works, create options/main.rb and
+define a single setting in it:
+
+  # config/options/main.rb
+  a_string "sample value"
+
+This will make Options.main.a_string evaluate to "sample value"
+anywhere in your application:
+
+  Options.main.a_string
+  => "sample value"
+
+The name of the group of options is set to be the same as the base
+name of the file, so if you create emails.rb, the settings will be
+accessible as Options.emails.whatever_you_define etc.
+
+The value of each settings can be any kind of Ruby object, so the
+following is a valid config file:
+
+  # config/options/main.rb
+  a_string "Some string"
+   
+  an_array [1, 2, 3]
+   
+  a_fancy_string_array(%w{
+  string1
+  string2
+  })
+
+Which you can use in other places of your application like this:
+
+  Options.main.a_string
+  => "Some string"
+  Options.main.an_array
+  => [1, 2, 3]
+  Options.main.a_fancy_string_array
+  => ["string1", "string2"]
+
+Note that hash map values have to be wrapped in parenthesis, since
+defining a setting works under the hood as a Ruby method call, so it
+has to have the syntax of one.
+
+### Overriding settings per Rails environment ###
+
+To overwrite the settings for a given Rails environment, just create a
+subdirectory of the options directory named after the name of the
+environment, for example config/options/test/. Then create a file
+corresponding to the group of settings of which one or more you want
+to override. For example, if config/options/main.rb looks like above,
+and you create config/options/test/main.rb looking like this:
+
+  # config/options/test/main.rb
+  a_string "Test"
+
+Then Options.main.a_string will evaluate to "Test" in the test
+environment, while all the other Options.main settings will evaluate
+to their values defined in config/options/main.rb.
+
+### Overriding settings locally ###
+
+This is mostly meant for applications that are stored in a version
+control system and on which multiple persons work. One can keep the
+core settings in config/options, and also create a
+config/options/local directory, that can be svn ignore'd or added to
+.gitignore. If then someone wants to override some setting just on a
+particular server or just on his local development environment, he/she
+can create a file corresponding to the group of settings of which one
+or more he/she wants to override, for example
+config/options/local/main.rb:
+
+  # config/options/local/main.rb
+  an_array [4, 5, 6]
+
+Then, Options.main.an_array will evaluate to [4, 5, 6] regardless of
+Rails environment and other Options.main settings will be evaluated
+according to their per-Rails-environment definitions if present, or
+according to their global definitions in config/options/main.rb
+otherwise.
+
+## Robustness ##
+
+dynamic_configuration overwrites method_missing in the context of the
+configuration files to enable the syntax it provides. It doesn't do
+anything to method_missing globally, nor does it do any other "magic"
+that could affect any piece of your application other then the
+configuration files themselves.
+
+All the settings are frozen as soon as they are defined, so you won't
+accidentally modify them. If you try to access a settings group that
+wasn't defined, you will get an
+DynamicConfiguration::MissingGroupException, if you try to access a
+setting that isn't defined of a group that _is_ defined, you will get
+a DynamicConfiguration::MissingGroupException.

data/README.markdown

@@ -174,4 +174,4 @@ accidentally modify them. If you try to access a settings group that
 wasn't defined, you will get an
 DynamicConfiguration::MissingGroupException, if you try to access a
 setting that isn't defined of a group that _is_ defined, you will get
-a DynamicConfiguration::MissingGroupException.
+a DynamicConfiguration::MissingSettingException.

data/Rakefile

@@ -19,7 +19,7 @@ Jeweler::Tasks.new do |gem|
   gem.email = "jrzeszotko@gmail.com"
   gem.homepage = "http://github.com/jaroslawr/dynamic_configuration"
   gem.authors = ["Jarosław Rzeszótko"]
-  gem.add_dependency('builder')
+  gem.add_dependency('blankslate')
 end
 
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/dynamic_configuration.gemspec

@@ -5,17 +5,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dynamic_configuration}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Jarosław Rzeszótko}]
-  s.date = %q{2012-01-26}
+  s.date = %q{2013-01-21}
   s.description = %q{Flexible configuration library for Ruby and Rails applications.}
   s.email = %q{jrzeszotko@gmail.com}
   s.extra_rdoc_files = [
+    "LICENSE",
+    "README",
     "README.markdown"
   ]
   s.files = [
+    "LICENSE",
+    "README",
     "README.markdown",
     "Rakefile",
     "VERSION",
@@ -37,12 +41,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<builder>, [">= 0"])
+      s.add_runtime_dependency(%q<blankslate>, [">= 0"])
     else
-      s.add_dependency(%q<builder>, [">= 0"])
+      s.add_dependency(%q<blankslate>, [">= 0"])
     end
   else
-    s.add_dependency(%q<builder>, [">= 0"])
+    s.add_dependency(%q<blankslate>, [">= 0"])
   end
 end
 

data/lib/dynamic_configuration.rb

@@ -79,7 +79,9 @@ module DynamicConfiguration
     end
   end
 
-  class Config < ::BlankSlate    
+  class Config < ::BlankSlate
+    reveal :freeze
+    
     def initialize(const_name, config_path)
       @const_name, @config_path = const_name, config_path
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_configuration
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-26 00:00:00.000000000 Z
+date: 2013-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: builder
-  requirement: &76717450 !ruby/object:Gem::Requirement
+  name: blankslate
+  requirement: &77485380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,14 +21,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *76717450
+  version_requirements: *77485380
 description: Flexible configuration library for Ruby and Rails applications.
 email: jrzeszotko@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- LICENSE
+- README
 - README.markdown
 files:
+- LICENSE
+- README
 - README.markdown
 - Rakefile
 - VERSION