dynamic_configuration 0.1.5 → 0.1.6

data/README.markdown

@@ -0,0 +1,57 @@
+# dynamic_configuration: Application configuration made easy
+
+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
+
+ * the configuration is automatically reloaded in Rails development environment
+
+ * the settings are divided into groups, with each group living in a
+   separate file, making it easier to remember individual setting
+   names and maintain the whole configuration
+
+ * settings can be overridden locally for a given installation and
+   per-Rails-environment
+
+ * throughout field- and unit- tested
+
+## Setup
+
+### Rails 3 application:
+
+Add the gem to your Gemfile:
+
+    gem 'dynamic_configuration'
+
+Create a config/options directory, in it a config/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 directory where you want to store the options, e. g.
+options/, and put the following before your application initialization
+code:
+
+    DynamicConfiguration::create(:Options, "/path/to/options")
+
+
+## Usage

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/dynamic_configuration.gemspec

@@ -5,14 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dynamic_configuration}
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   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.description = %q{Flexible configuration library for Ruby and Rails applications.}
   s.email = %q{jrzeszotko@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
   s.files = [
+    "README.markdown",
     "Rakefile",
     "VERSION",
     "dynamic_configuration.gemspec",

data/lib/dynamic_configuration.rb

@@ -88,7 +88,7 @@ module DynamicConfiguration
       mod_name = file_pathname.basename.to_s[0..-4]
 
       @modules ||= {}
-      @modules[mod_name.intern] ||= Submodule.new
+      @modules[mod_name.intern] ||= Group.new
       @modules[mod_name.intern].instance_eval(::IO.read(file_pathname.to_s))
 
       @settings ||= {}
@@ -97,14 +97,14 @@ module DynamicConfiguration
 
     def method_missing(name, *args, &block)
       unless @settings && @settings[name]
-        raise MissingSubmoduleException.new("No configuration defined for a '#{name}' submodule")
+        raise MissingGroupException.new("No configuration defined for a '#{name}' submodule")
       end
 
       @settings[name]
     end
   end
 
-  class Submodule < ::BlankSlate
+  class Group < ::BlankSlate
     attr_accessor :settings
 
     def initialize
@@ -129,6 +129,6 @@ module DynamicConfiguration
     end
   end
 
-  class MissingSubmoduleException < StandardError; end
+  class MissingGroupException < StandardError; end
   class MissingSettingException < StandardError; end
 end

data/spec/dynamic_configuration_spec.rb

@@ -53,7 +53,7 @@ describe DynamicConfiguration do
     lambda {
       DynamicConfiguration::create(:Settings, path)
       Settings.xyz.setting_three
-    }.should raise_error(DynamicConfiguration::MissingSubmoduleException)
+    }.should raise_error(DynamicConfiguration::MissingGroupException)
   end
 
   it "should raise an exception if trying to use a setting that is not defined" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_configuration
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &75603140 !ruby/object:Gem::Requirement
+  requirement: &81569210 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,13 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *75603140
+  version_requirements: *81569210
 description: Flexible configuration library for Ruby and Rails applications.
 email: jrzeszotko@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.markdown
 files:
+- README.markdown
 - Rakefile
 - VERSION
 - dynamic_configuration.gemspec