ruby-configurable 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,13 @@
+=== 1.0.1 / 2011-05-06
+
+* 2 bugfixes
+
+  * to_args now returns a Hash with symbols as keys. This lets you pass
+    your configuration directly to methods that expect option-style hash
+    arguments.
+
+  * to_args now excludes nil values from the resulting hash.
+
 === 1.0.0 / 2011-05-03
 
 * 1 major enhancement

data/README.txt

@@ -40,51 +40,68 @@ Lets you make your Ruby class configurable with a simple mixin.
 
 == SYNOPSIS:
 
-    require 'configurable'
-    class Doodad
-      include Configurable
+ require 'configurable'
+ class Doodad
+   include Configurable
 
-      # Declare the allowed options and their default values
-      configurable_options :foo => 'default',
-        :bar => {:quux => 42, :wibble => nil},
-        :baz => nil
-    end
+   # Declare the allowed options and their default values
+   configurable_options :foo => 'default',
+     :bar => {:quux => 42, :wibble => nil},
+     :baz => nil
+ end
 
-    Doodad::Config              # => a ConfigStruct::Struct
-    Doodad::Config::Bar         # => another ConfigStruct::Struct
+ Doodad::Config              # => a ConfigStruct::Struct
+ Doodad::Config::Bar         # => another ConfigStruct::Struct
 
-    Doodad.default_config       # => #<struct Doodad::Config
-                                #     bar=#<struct Doodad::Config::Bar
-                                #          quux=42, wibble=nil>,
-                                #     baz=nil,
-                                #     foo="default">
+ Doodad.default_config       # => #<struct Doodad::Config
+                             #     bar=#<struct Doodad::Config::Bar
+                             #          quux=42, wibble=nil>,
+                             #     baz=nil,
+                             #     foo="default">
 
-    Doodad.config               # => a (deep) copy of default_config,
-                                #    ready for use
+ Doodad.config               # => a (deep) copy of default_config,
+                             #    ready for use
 
-    Doodad.config.replace(      # replaces config with passed values
-      :foo => 'mine',
-      :bar => {:quux => 9})
+ Doodad.config.replace(      # replaces config with passed values
+   :foo => 'mine',
+   :bar => {:quux => 9})
 
-    Doodad.config.replace(      # loads config from a YAML file
-      YAML.load('config.yml'))
+ Doodad.config.update(       # loads config from a YAML file
+   YAML.load('config.yml'))
 
 See the documentation on Configurable for an overview and links to more
 specifics.
 
+=== Using with Rails
+
+If you want to make a Rails class configurable, you'll need some special
+mojo to reconfigure the class when it gets reloaded in development mode.
+You can do this with Rails.application.config.to_prepare. For example,
+to have your class configuration reloaded from a YAML file, create an
+initializer like so:
+
+ Rails.application.config.to_prepare do
+   begin
+     Doodad.config.update(
+       YAML.load_file(File.join(Rails.root, 'config', 'doodad.yml')) || {})
+   rescue Errno::ENOENT
+     # handle missing config file
+   end
+ end
+
 == REQUIREMENTS:
 
 * Ruby
 
 == INSTALL:
 
-    $ gem install configurable
+ $ gem install ruby-configurable
 
 == DEVELOPERS:
 
 After checking out the source, run:
 
-  $ rake newb
+ $ rake newb
 
 This task will install any missing dependencies, run the tests/specs,
 and generate the RDoc.

data/lib/configurable.rb

@@ -30,7 +30,7 @@ require 'configurable/core_ext/inflections'
 #     Doodad.config.one                 # => 1
 #
 module Configurable
-  VERSION = '1.0.0' #:nodoc:
+  VERSION = '1.0.1' #:nodoc:
 
   def self.included(klass) #:nodoc:
     klass.extend Macros

data/lib/configurable/config_struct.rb

@@ -116,11 +116,12 @@ module ConfigStruct
     #
     def to_hash
       members.inject({}) do |hsh, k|
+        v = self[k]
         hsh.tap do |h|
-          h[k] = if self[k].is_a? Struct
-                   self[k].to_hash
+          h[k] = if v.is_a? Struct
+                   v.to_hash
                  else
-                   self[k]
+                   v
                  end
         end
       end
@@ -129,8 +130,19 @@ module ConfigStruct
     # Puts config values into an array suitable for expanding into a
     # parameter list. This is for convenience in recursive traversals of
     # a struct instance.
-    def to_args
-      self.to_hash.to_args
+    def to_args(box = true)
+      args = each_pair.inject({}) do |hsh, pair|
+        k, v = pair
+        hsh.tap do |h|
+          next if v.nil?
+          h[k.to_sym] = if v.is_a? Struct
+                          v.to_args(false)
+                        else
+                          v
+                        end
+        end
+      end
+      box ? args.to_args : args
     end
 
 

data/lib/configurable/core_ext/extract_options.rb

@@ -22,7 +22,7 @@ class Array
 
   # Returns the array in a form suitable for expanding into a parameter
   # list, that is, just the array itself.
-  def to_args
+  def to_args(box = true)
     self
   end
 end
@@ -39,11 +39,27 @@ class Hash
     end
   end
 
+  # needed for to_args
+  unless {}.respond_to? :symbolize_keys!
+    # Destructively convert all keys to symbols, as long as they respond
+    # to +to_sym+.
+    def symbolize_keys!
+      keys.each do |key|
+        self[(key.to_sym rescue key) || key] = delete(key)
+      end
+      self
+    end
+
+    def symbolize_keys
+      dup.symbolize_keys!
+    end
+  end
+
   # Puts the hash into an array suitable for expanding into a parameter
   # list, such that it will be interpreted as keyword parameters if the
   # method you're calling expects that.
-  def to_args
-    [self]
+  def to_args(box = true)
+    args = self.symbolize_keys
+    box ? [args] : args
   end
 end
-

data/test/test_config_struct.rb

@@ -27,6 +27,26 @@ describe ConfigStruct::Struct do
     assert_equal 42, inst.to_hash['a']
   end
 
+  describe 'to_args' do
+    before do
+      @inst = @struct.new(42, 'foobar')
+      @args = @inst.to_args
+    end
+
+    it 'should convert to option args' do
+      # should be a hash wrapped in an array
+      assert_respond_to @args, :[]
+      assert_respond_to @args.first, :keys
+      assert_respond_to @args.first, :to_hash
+    end
+
+    it 'should have symbol keys' do
+      for key in @args.first.keys
+        assert_kind_of Symbol, key
+      end
+    end
+  end
+
   describe 'replace' do
     before do
       @inst = @struct.new(5, 3)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-configurable
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Kevin R. Bullock
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-05 00:00:00 Z
+date: 2011-05-06 00:00:00 -05:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rubyforge
@@ -74,6 +75,7 @@ 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: []
 
@@ -104,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: handtools
-rubygems_version: 1.7.2
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: Lets you make your Ruby class configurable with a simple mixin.