@@ -111,11 +111,11 @@ config.awesome_stuff.my_variable # => "hello world" h2. Using your configuration in your Rails app -The plugin provides a convenient mixin for your ApplicationController to make configuration access as simple as possible. Assuming a configuration called "application" (as in the above examples), it defines a <code>config</code> method which can be used in any of your controllers. It also defines this as a method as a view helper using the Rails <code>helper_method</code> macro so you can access configuration data in your views. +The plugin provides a convenient mixin for your <code>ApplicationController</code> to make configuration access as simple as possible. Assuming a configuration called "application" (as in the above examples), it defines a <code>config</code> method which can be used in any of your controllers. It also defines this as a method as a view helper using the Rails <code>helper_method</code> macro so you can access configuration data in your views. Note - there is no direct way of accessing your configuration variables in your models other than making a direct call to <code>SimpleConfig.for</code>. I'd recommend designing your models in such a way that configuration data can be passed into them at runtime as method arguments by your controller to avoid coupling your model to SimpleConfig. -To use the mixin, simply include it in your ApplicationController: +To use the mixin, simply include it in your <code>ApplicationController</code>: <pre><code class="ruby"> class ApplicationController < ActionController::Base @@ -133,6 +133,19 @@ class MyController < ApplicationController end </code></pre> +The mixin provides also a class-level <code>config</code> method to access the configuration when you don't have a controller instance available. + +<pre><code class="ruby"> +class MyController < ApplicationController + protect_from_forgery :secret => config.secret_token + + def index + render :text => config.my_config_variable + end +end +</code></pre> + + fn1(footnote). SimpleConfig was designed with Rails 2.0 in mind but it has been tested with Rails 1.2. To use the Rails-style initializers that SimpleConfig takes advantage of in Rails 1.2, simply add this to the bottom of your environment.rb file: <pre><code class="ruby"> README.textile @@ -1,11 +1,31 @@ module SimpleConfig module ControllerMixin - def self.included(klass) - klass.send(:helper_method, :config) + + def self.included(base) + base.extend ClassMethods + base.class_eval do + include InstanceMethods + helper_method :config + end + end + + module ClassMethods + + # Returns the application config. + def config + SimpleConfig.for(:application) + end + end - def config - SimpleConfig.for(:application) + module InstanceMethods + + # Instance-level proxy to class-level +config+ method. + def config + self.class.config + end + end + end end lib/controller_mixin.rb @@ -13,6 +13,7 @@ class RailsController end class ControllerMixinTest < Test::Unit::TestCase + def setup @app_config = SimpleConfig.for(:application) do end @@ -20,7 +21,12 @@ class ControllerMixinTest < Test::Unit::TestCase @controller_klass = Class.new(RailsController) end - def test_should_define_a_config_method_that_returns_the_application_config_when_included + def test_should_define_a_config_class_method_that_returns_the_application_config_when_included + @controller_klass.send(:include, SimpleConfig::ControllerMixin) + assert_equal @app_config, @controller_klass.config + end + + def test_should_define_a_config_instance_method_that_returns_the_application_config_when_included @controller_klass.send(:include, SimpleConfig::ControllerMixin) assert_equal @app_config, @controller_klass.new.config end test/controller_mixin_test.rb 37f94882341779c1d5332a2ab3f384fb2a62cd10 lukeredpath lukeredpath@53438b35-87ee-0310-8825-c8c94c0097b6 http://github.com/lukeredpath/simpleconfig/commit/ec0d69f6f077df8840bdbc48d9e29864263ef308 ec0d69f6f077df8840bdbc48d9e29864263ef308 2008-11-05T10:19:54-08:00 2008-11-05T10:19:54-08:00 * Let config method to be accessible at class-level. git-svn-id: http://svn/repos/plugins/simple_config@14123 53438b35-87ee-0310-8825-c8c94c0097b6 7eab224252eb70e78485100a08877ed6f2d69db8 lukeredpath lukeredpath@53438b35-87ee-0310-8825-c8c94c0097b6