ruby-configurable 1.0.1 → 1.0.2

data/History.txt

@@ -1,3 +1,12 @@
+=== 1.0.2 / 2011-05-10
+
+* 1 minor enhancement
+
+  * Default config is now accessible thru the generated Config module,
+    as Config.defaults. The default_config method added to your class
+    when you include Configurable is deprecated, but will continue to
+    work (on both your class and instances of it).
+
 === 1.0.1 / 2011-05-06
 
 * 2 bugfixes

data/README.txt

@@ -53,13 +53,13 @@ Lets you make your Ruby class configurable with a simple mixin.
  Doodad::Config              # => a ConfigStruct::Struct
  Doodad::Config::Bar         # => another ConfigStruct::Struct
 
- Doodad.default_config       # => #<struct Doodad::Config
+ Doodad::Config.defaults     # => #<struct Doodad::Config
                              #     bar=#<struct Doodad::Config::Bar
                              #          quux=42, wibble=nil>,
                              #     baz=nil,
                              #     foo="default">
 
- Doodad.config               # => a (deep) copy of default_config,
+ Doodad.config               # => a (deep) copy of Doodad::Config.defaults,
                              #    ready for use
 
  Doodad.config.replace(      # replaces config with passed values

data/lib/configurable.rb

@@ -14,7 +14,7 @@ require 'configurable/core_ext/inflections'
 #
 # This creates a ConfigStruct::Struct called Doodad::Config, along with
 # a frozen instance of it containing the default options accessible with
-# the Doodad.default_config method (see ConfigAccessors.default_config).
+# the Doodad::Config.defaults method (see ConfigStructDefaults).
 #
 # You can then use Doodad.config (see ConfigAccessors.config) to store
 # the configuration for your class. See ConfigStruct::Struct for the
@@ -30,15 +30,14 @@ require 'configurable/core_ext/inflections'
 #     Doodad.config.one                 # => 1
 #
 module Configurable
-  VERSION = '1.0.1' #:nodoc:
+  VERSION = '1.0.2' #:nodoc:
 
   def self.included(klass) #:nodoc:
     klass.extend Macros
     klass.extend ConfigAccessors
   end
 
-  # Returns the class' default configuration object.
-  def default_config
+  def default_config #:nodoc:
     self.class.default_config
   end
 
@@ -64,10 +63,10 @@ module Configurable
     # configuration struct will be created as Doodad::Config.)
     #
     # You may also declare options with default settings, which will
-    # then be available thru the default_config method on your class
-    # (e.g. Doodad.default_config; see documentation on
-    # ConfigAccessors.default_config). To declare defaults, pass them as
-    # hash parameters:
+    # then be available thru the Config::defaults method on the
+    # generated struct (e.g. Doodad::Config.defaults; see documentation
+    # on ConfigStructDefaults). To declare defaults, pass them as hash
+    # parameters:
     #
     #     configurable_options :one => 1, :two => 2
     #
@@ -86,6 +85,8 @@ module Configurable
     def configurable_options(*args)
       @_config_struct, @_default_config =
         create_struct(self, 'Config', *args)
+      @_config_struct.extend ConfigStructDefaults
+      @_config_struct.defaults = @_default_config
     end
 
 
@@ -110,10 +111,25 @@ module Configurable
     end
 
     def config_struct #:nodoc:
+      # the ||= nil quashes an 'instance variable not initialized' warning
       @_config_struct ||= nil
     end
   end
 
+  # Accessors for the class' default configuration to add to the
+  # generated Config module.
+  module ConfigStructDefaults
+    # The class' default configuration object. This object is a frozen
+    # instance of the Config struct (which is a ConfigStruct::Struct
+    # created by the Macros.configurable_options method).
+    attr_reader :defaults
+
+    def defaults=(new_defaults)
+      raise TypeError, 'defaults can only be assigned once' if defaults
+      @defaults = new_defaults
+    end
+  end
+
   # Methods to access the class' current configuration and default
   # configuration.
   module ConfigAccessors
@@ -125,17 +141,13 @@ module Configurable
     def config
       raise NameError, 'use configurable_options to define settings' unless
         config_struct
-      @_config ||= @_default_config.dup # dup unfreezes
+      @_config ||= config_struct.defaults.dup # dup unfreezes
     end
 
-    # Returns the class' default configuration object. This object is a
-    # frozen instance of the class' Config struct (which is a
-    # ConfigStruct::Struct created by the Macros.configurable_options
-    # method).
-    def default_config
+    def default_config #:nodoc:
       raise NameError, 'use configurable_options to define settings' unless
         config_struct
-      @_default_config
+      config_struct.defaults
     end
   end
 end

data/test/test_configurable.rb

@@ -119,6 +119,35 @@ describe Configurable do
       end
     end
 
+    describe 'generated Config class' do
+      before do
+        @struct = @test_class.const_get('Config')
+        refute_equal ::Config, @struct
+      end
+
+      it 'should return the default config' do
+        assert_respond_to @struct, :defaults
+        @defaults = @struct.defaults
+        assert_equal 1, @defaults.one
+        assert_nil @defaults.two
+      end
+
+      it 'should return the same instance as the class default_config' do
+        assert_equal @test_class.default_config, @struct.defaults
+        assert_equal @test_class.default_config.object_id,
+          @struct.defaults.object_id
+      end
+
+      it 'should raise an error if you try to reassign to defaults' do
+        begin
+          @struct.defaults = @struct.new
+          flunk 'expected TypeError'
+        rescue TypeError
+          # passed test if #defaults= raises TypeError
+        end
+      end
+    end
+
     describe 'an instance' do
       before do
         @test_inst = @test_class.new

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-configurable
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Kevin R. Bullock
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-06 00:00:00 -05:00
-default_executable: 
+date: 2011-05-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rubyforge
@@ -75,7 +74,6 @@ files:
 - lib/configurable/core_ext/inflections.rb
 - test/test_config_struct.rb
 - test/test_configurable.rb
-has_rdoc: true
 homepage: http://bitbucket.org/krbullock/configurable
 licenses: []
 
@@ -106,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: handtools
-rubygems_version: 1.6.1
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Lets you make your Ruby class configurable with a simple mixin.