ruby-configurable 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/COPYING.txt

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2011-05-03
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,12 @@
+.autotest
+COPYING.txt
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/configurable.rb
+lib/configurable/config_struct.rb
+lib/configurable/core_ext/extract_options.rb
+lib/configurable/core_ext/inflections.rb
+test/test_config_struct.rb
+test/test_configurable.rb

data/README.txt

@@ -0,0 +1,110 @@
+= configurable
+
+* http://bitbucket.org/krbullock/configurable
+
+== DESCRIPTION:
+
+Lets you make your Ruby class configurable with a simple mixin.
+
+== FEATURES/PROBLEMS:
+
+* Generic mixin that you can use in any Ruby class (or application).
+
+* Separates handling configuration of a class from its implementation.
+
+* Supports nested settings.
+
+* Rejects configuration keys outside those you specify.
+
+* Supports setting defaults on a class which can then be modified for
+  each instance of the class.
+
+* Settings are stored in Structs (well, actually a subclass of Struct),
+  so they can be accessed via normal methods calls, or by Symbol or
+  String keys.
+
+* Settings (even nested settings) can be serialized to a hash with
+  string keys, which means you can also trivially serialize to YAML (or
+  JSON).
+
+* Settings (even nested settings) can be loaded from a hash, which means
+  you can also trivially deserialize from YAML (and remember, YAML is a
+  superset of JSON).
+
+* Plays nicely with the Singleton module.
+
+* Can safely store other kinds of structs as opaque config values. They
+  won't get automatically deep-copied.
+
+* Doesn't yet support independent configs for classes and their subclasses.
+
+== SYNOPSIS:
+
+    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
+
+    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.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(      # loads config from a YAML file
+      YAML.load('config.yml'))
+
+See the documentation on Configurable for an overview and links to more
+specifics.
+
+== REQUIREMENTS:
+
+* Ruby
+
+== INSTALL:
+
+    $ gem install configurable
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(GNU General Public License v2.0)
+
+Copyright (C) 2010 Kevin R. Bullock
+
+This program is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2 of the License, or (at your
+option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
+Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

data/Rakefile

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'ruby-configurable' do
+  developer('Kevin R. Bullock', 'kbullock@ringworld.org')
+
+  self.rubyforge_name = 'handtools'
+end
+
+# vim: syntax=ruby

data/lib/configurable/config_struct.rb

@@ -0,0 +1,163 @@
+require 'configurable/core_ext/extract_options'
+
+# See documentation on ConfigStruct::Struct.
+module ConfigStruct
+  module HashInitializer #:nodoc:
+    def initialize(*args)
+      hash_args = args.extract_options!
+      super(*args)
+      for k,v in hash_args
+        self[k] = v
+      end
+    end
+  end
+
+  # A beefed-up version of Ruby's built-in Struct (and in fact a subclass of
+  # it). An instance of a ConfigStruct::Struct is created just as you would
+  # create a normal struct:
+  #
+  #     A = ConfigStruct::Struct.new(:a, :b)
+  #
+  # You can then create an instance of this struct using hash parameters or
+  # ordered parameters:
+  #
+  #     a = A.new(:a => 1, :b => 2)     # => #<struct A a=1, b=2>
+  #
+  # You can pass values in order simultaneously with hash parameters. Values
+  # passed as hash parameters override those passed as normal parameters:
+  #
+  #     a = A.new(1, 2, :a => 3)        # => #<struct A a=3, b=2>
+  #
+  # ConfigStruct::Structs also get deeply copied, that is, any member of a
+  # ConfigStruct::Struct instance that is also an instance of a
+  # ConfigStruct::Struct will get copied recursively:
+  #
+  #     a = A.new(1, 2)         # => #<struct A a=1, b=2>
+  #     b = A.new(3, a)         # => #<struct A a=3, b=#<struct A a=1, b=2>>
+  #     c = b.dup
+  #     b.object_id == c.object_id      # => false
+  #     b.b.object_id == c.b.object_id  # => false
+  #
+  class Struct < ::Struct
+    def self.new(*args) #:nodoc:
+      klass = super
+      klass.send(:include, HashInitializer)
+    end
+
+    # Recursively copies members of the original struct that are also
+    # instances of ConfigStruct::Struct.
+    def initialize_copy(orig)
+      super
+      for member in members
+        self[member] = self[member].dup if self[member].is_a? Struct
+      end
+    end
+
+    # Replaces the current values with the given values. Values can be given
+    # in order:
+    #
+    #     A = ConfigStruct::Struct.new(:a, :b)
+    #     a = A.new(1, 2)
+    #     a.replace(3, 4)               # => #<struct A a=3, b=4>
+    #
+    # ...or as hash parameters:
+    #
+    #     a.replace(:a => 3, :b => 4)   # => #<struct A a=3, b=4>
+    #
+    # As when creating new instances, values given as hash parameters
+    # override those given as positional parameters:
+    #
+    #     a.replace(3, 4, :a => 5)      # => #<struct A a=5, b=4>
+    #
+    # Any members not given values will be set to nil.
+    #
+    def replace(*args)
+      hash_args = args.extract_options!
+      for member, v in members.zip(args)
+        replace_member!(member, v)
+      end
+      for k, v in hash_args
+        replace_member!(k, v)
+      end
+    end
+
+    # Updates the current values from the given values. Values can be
+    # given in order:
+    #
+    #     A = ConfigStruct::Struct.new(:a, :b)
+    #     a = A.new(1, 2)               # => #<struct A a=1, b=2>
+    #     a.update(3)                   # => #<struct A a=3, b=2>
+    #
+    # ...or as hash parameters:
+    #
+    #     a.update(:a => 3)             # => #<struct A a=3, b=2>
+    #
+    # As when creating new instances, values given as hash parameters
+    # override those given as positional parameters:
+    #
+    #     a.replace(3, :a => 5)         # => #<struct A a=5, b=2>
+    #
+    def update(*args)
+      hash_args = args.extract_options!
+      args.each_with_index do |v, i|
+        update_member!(i, v)
+      end
+      for k, v in hash_args
+        update_member!(k, v)
+      end
+    end
+    alias merge! update
+
+    # Converts the struct to a hash with string keys. This allows you,
+    # for example, to trivially serialize the struct as YAML.
+    #
+    #     A = ConfigStruct::Struct.new(:a, :b)
+    #     A.new(1, 2).to_hash           # => {"a"=>1, "b"=>2}
+    #
+    def to_hash
+      members.inject({}) do |hsh, k|
+        hsh.tap do |h|
+          h[k] = if self[k].is_a? Struct
+                   self[k].to_hash
+                 else
+                   self[k]
+                 end
+        end
+      end
+    end
+
+    # 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
+    end
+
+
+    private
+
+    # member may also be an index
+    def replace_member!(member, value) #:nodoc:
+      if self[member].is_a? Struct
+        raise TypeError,
+        'cannot replace a ConfigStruct::Struct with a scalar' unless
+          value.respond_to? :to_args
+        self[member].replace(*value.to_args)
+      else
+        self[member] = value
+      end
+    end
+
+    # member may also be an index
+    def update_member!(member, value) #:nodoc:
+      if self[member].is_a? Struct
+        raise TypeError,
+        'cannot replace a ConfigStruct::Struct with a scalar' unless
+          value.respond_to? :to_args
+        self[member].update(*value.to_args)
+      else
+        self[member] = value
+      end
+    end
+  end
+end

data/lib/configurable/core_ext/extract_options.rb

@@ -0,0 +1,49 @@
+# Define Array#extract_options! and associated methods if they're not
+# already defined. Code taken from Rails' ActiveSupport.
+class Array
+  unless [].respond_to? :extract_options!
+    # Extracts options from a set of arguments. Removes and returns the last
+    # element in the array if it's a hash, otherwise returns a blank hash.
+    #
+    #   def options(*args)
+    #     args.extract_options!
+    #   end
+    #
+    #   options(1, 2)           # => {}
+    #   options(1, 2, :a => :b) # => {:a=>:b}
+    def extract_options!
+      if last.is_a?(Hash) && last.extractable_options?
+        pop
+      else
+        {}
+      end
+    end
+  end
+
+  # Returns the array in a form suitable for expanding into a parameter
+  # list, that is, just the array itself.
+  def to_args
+    self
+  end
+end
+
+class Hash
+  unless {}.respond_to? :extractable_options?
+    # By default, only instances of Hash itself are extractable.
+    # Subclasses of Hash may implement this method and return
+    # true to declare themselves as extractable. If a Hash
+    # is extractable, Array#extract_options! pops it from
+    # the Array when it is the last element of the Array.
+    def extractable_options?
+      instance_of?(Hash)
+    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]
+  end
+end
+

data/lib/configurable/core_ext/inflections.rb

@@ -0,0 +1,10 @@
+# Define some simplified inflection methods on String if they're not already
+# defined. Code adapted from Rails' ActiveSupport.
+class String
+  unless String.respond_to?(:camelize)
+    # Turns a_string_like_this into AStringLikeThis.
+    def camelize
+      self.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    end
+  end
+end

data/lib/configurable.rb

@@ -0,0 +1,141 @@
+require 'configurable/config_struct'
+require 'configurable/core_ext/extract_options'
+require 'configurable/core_ext/inflections'
+
+# Include this module in a class to make it configurable, and declare
+# allowed settings with the Macros.configurable_options method:
+#
+#     require 'configurable'
+#     class Doodad
+#       include Configurable
+#       configurable_options :one, :two, :three,  # keep options in order
+#         :one => 1, :two => 'zwei'               # set defaults
+#     end
+#
+# 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).
+#
+# You can then use Doodad.config (see ConfigAccessors.config) to store
+# the configuration for your class. See ConfigStruct::Struct for the
+# available methods. The config object is lazily created when
+# Doodad.config is called.
+#
+# Each instance of Doodad can have its own configuration object as well:
+#
+#     aDoodad = Doodad.new
+#     aDoodad.config                    # => a copy of Doodad.config
+#     aDoodad.config.one = 'eins'
+#     aDoodad.config.one                # => 'eins'
+#     Doodad.config.one                 # => 1
+#
+module Configurable
+  VERSION = '1.0.0' #:nodoc:
+
+  def self.included(klass) #:nodoc:
+    klass.extend Macros
+    klass.extend ConfigAccessors
+  end
+
+  # Returns the class' default configuration object.
+  def default_config
+    self.class.default_config
+  end
+
+  # Returns the object's current configuration object. This object is
+  # lazily created the first time the method is called as a copy of the
+  # class' current config.
+  def config
+    @_config ||= self.class.config.dup
+  end
+
+
+  # Setup macros for classes that include Configurable.
+  module Macros
+
+    # Declares the allowed configuration settings and (optionally) their
+    # default values. Field names should be passed as symbols. Example:
+    #
+    #     configurable_options :one, :two
+    #
+    # This creates a new ConfigStruct::Struct (which is a subclass of
+    # Ruby's built-in Struct) called Config within the class it's called
+    # on. (Thus if you call it within a class called Doodad, the
+    # 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:
+    #
+    #     configurable_options :one => 1, :two => 2
+    #
+    # In Ruby 1.8, this will not preserve the order of the options. To
+    # define the options in a specific order _and_ declare defaults for
+    # them, declare the field names first and then the defaults:
+    #
+    #     configurable_options :one, :two, :one => 1
+    #
+    # Fields not listed in order but that are passed as hash params will
+    # be added after all the ordered parameters, in unspecified order:
+    #
+    #     configurable_options :one, :two, :one => 1, :five => '3 sir'
+    #     Config.members # => ["one", "two", "five"]
+    #
+    def configurable_options(*args)
+      @_config_struct, @_default_config =
+        create_struct(self, 'Config', *args)
+    end
+
+
+    private
+
+    def create_struct(base, name, *args) #:nodoc:
+      defaults = args.extract_options!
+      members = (args + defaults.keys).uniq
+      struct = ConfigStruct::Struct.new(*members)
+      default_config = struct.new
+      base.const_set(name, struct)
+      for k, v in defaults
+        if v.respond_to?(:to_args)
+          substruct, subdefault =
+            create_struct(struct, k.to_s.camelize, *(v.to_args))
+          default_config[k] = subdefault
+        else
+          default_config[k] = v
+        end
+      end
+      [struct, default_config.freeze]
+    end
+
+    def config_struct #:nodoc:
+      @_config_struct ||= nil
+    end
+  end
+
+  # Methods to access the class' current configuration and default
+  # configuration.
+  module ConfigAccessors
+    # Returns the class' configuration object. This object is an
+    # instance of the class' Config struct (which is a
+    # ConfigStruct::Struct created by the Macros.configurable_options
+    # method). It is lazily created the first time the method is called
+    # as a copy of the default configuration object.
+    def config
+      raise NameError, 'use configurable_options to define settings' unless
+        config_struct
+      @_config ||= @_default_config.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
+      raise NameError, 'use configurable_options to define settings' unless
+        config_struct
+      @_default_config
+    end
+  end
+end

data/test/test_config_struct.rb

@@ -0,0 +1,125 @@
+require 'minitest/unit'
+require 'minitest/autorun'
+
+require 'configurable/config_struct'
+
+describe ConfigStruct::Struct do
+  before do
+    @struct = ConfigStruct::Struct.new(:a, :b)
+  end
+
+  it 'should be initialized from keyword args' do
+    inst = @struct.new(:a => 42)
+    assert_equal 42, inst.a
+  end
+
+  it 'should reject unknown keywords' do
+    assert_raises(NameError) { @struct.new(:z => 'invalid argument') }
+  end
+
+  it 'should override positional args with keyword args' do
+    inst = @struct.new(1, :a => 42)
+    assert_equal 42, inst.a
+  end
+
+  it 'should convert to a hash' do
+    inst = @struct.new(42)
+    assert_equal 42, inst.to_hash['a']
+  end
+
+  describe 'replace' do
+    before do
+      @inst = @struct.new(5, 3)
+    end
+
+    it 'should replace values from positional args' do
+      @inst.replace(42)
+      assert_equal 42, @inst.a
+    end
+
+    it 'should replace values from keyword args' do
+      @inst.replace(:a => 42)
+      assert_equal 42, @inst.a
+    end
+
+    it 'should override positional args with keyword args' do
+      @inst.replace(42, :a => 3)
+      assert_equal 3, @inst.a
+    end
+
+    it 'should set unspecified values to nil' do
+      @inst.replace(:b => 42)
+      assert_nil @inst.a
+    end
+  end
+
+  describe 'update' do
+    before do
+      @inst = @struct.new(5)
+    end
+
+    it 'should replace values from positional args' do
+      @inst.replace(42)
+      assert_equal 42, @inst.a
+    end
+
+    it 'should replace values from keyword args' do
+      @inst.replace(:a => 42)
+      assert_equal 42, @inst.a
+    end
+
+    it 'should override positional args with keyword args' do
+      @inst.replace(42, :a => 3)
+      assert_equal 3, @inst.a
+    end
+
+    it 'should merge values' do
+      @inst.update(:b => 42)
+      assert_equal 5, @inst.a
+      assert_equal 42, @inst.b
+    end
+  end
+
+  describe 'with a nested ConfigStruct::Struct' do
+    before do
+      @nested = ConfigStruct::Struct.new(:b)
+      @inst = @struct.new(:a => @nested.new(:b => 1))
+      @inst.freeze
+      @inst.a.freeze
+      assert_equal 1, @inst.a.b
+    end
+
+    it 'should deep-copy' do
+      @copy = @inst.dup
+      refute_nil @copy.a
+      @copy.a.b = 2
+      assert_equal 1, @inst.a.b
+    end
+
+    it 'should convert to a hash recursively' do
+      assert_kind_of Hash, @inst.to_hash['a']
+      assert_equal 1, @inst.to_hash['a']['b']
+    end
+  end
+
+  describe 'with a nested ::Struct' do
+    before do
+      @nested = ::Struct.new(:b)
+      @inst = @struct.new(:a => @nested.new(1))
+      @inst.freeze
+      assert_equal 1, @inst.a.b
+    end
+
+    it 'should shallow-copy' do
+      @copy = @inst.dup
+      refute_nil @copy.a
+      @copy.a.b = 2
+      assert_equal 2, @inst.a.b
+    end
+
+    it 'should not convert to a hash recursively' do
+      assert_kind_of @nested, @inst.to_hash['a']
+      assert_equal 1, @inst.to_hash['a'].b
+    end
+  end
+end

data/test/test_configurable.rb

@@ -0,0 +1,172 @@
+require 'minitest/unit'
+require 'minitest/autorun'
+require 'set'
+
+require 'configurable'
+
+describe Configurable do
+  before do
+    @test_class = Class.new
+    @test_class.instance_eval do
+      include Configurable
+    end
+  end
+
+  describe 'before configurable_options is called' do
+    describe 'config' do
+      it 'should raise NameError' do
+        assert_raises(NameError) { @test_class.config }
+      end
+    end
+
+    describe 'default_config' do
+      it 'should raise NameError' do
+        assert_raises(NameError) { @test_class.default_config }
+      end
+    end
+  end
+
+  describe 'configurable_options' do
+    before do
+      @test_class.instance_eval do
+        configurable_options :one => 1, :two => nil
+      end
+    end
+
+    it 'should create the config struct' do
+      begin
+        # config struct should be created as <base class>::Config
+        @struct = @test_class.const_get('Config')
+      rescue NameError
+        flunk "#{@test_class}::Config not found"
+      end
+      refute_equal ::Config, @struct
+      assert @struct.ancestors.include? ConfigStruct::Struct
+    end
+
+    it 'should store defaults' do
+      assert_respond_to @test_class.default_config, :[]
+      assert_equal 1, @test_class.default_config[:one]
+      assert_nil @test_class.default_config[:two]
+    end
+  end
+
+  describe 'configurable_options with positional args' do
+    before do
+      @test_class.instance_eval do
+        configurable_options :one, :two,
+          :one => 1, :five => 3
+      end
+      @struct = @test_class.instance_eval { @_config_struct }
+    end
+
+    it 'should order the keys the config struct' do
+      assert_equal ['one', 'two'], @struct.members[0,2]
+    end
+
+    it 'should create members from hash keys at the end' do
+      assert_equal 'five', @struct.members.last
+    end
+  end
+
+  describe 'configurable_options with nested args' do
+    before do
+      @test_class.instance_eval do
+        configurable_options :a => [:b], :c => {:d => 42}
+      end
+      @struct = @test_class.const_get('Config')
+    end
+
+    it 'should create the config struct' do
+      refute_equal ::Config, @struct
+      assert_equal %w(a c).to_set, @struct.members.to_set
+    end
+
+    it 'should create a nested A struct' do
+      begin
+        a_struct = @struct.const_get('A')
+      rescue NameError
+        flunk "#{@test_class}::Config::A not found"
+      end
+      assert a_struct.ancestors.include? ConfigStruct::Struct
+    end
+
+    it 'should create a nested C struct' do
+      begin
+        c_struct = @struct.const_get('C')
+      rescue NameError
+        flunk "#{@test_class}::Config::C not found"
+      end
+      assert c_struct.ancestors.include? ConfigStruct::Struct
+    end
+
+    it 'should store defaults' do
+      defaults = @test_class.default_config
+      assert_respond_to defaults, :a
+      assert_respond_to defaults.a, :b
+      assert_equal nil, defaults.a.b
+
+      assert_respond_to defaults, :c
+      assert_respond_to defaults.c, :d
+      assert_equal 42, defaults.c.d
+    end
+  end
+
+  describe 'after configurable_options is called' do
+    before do
+      @test_class.instance_eval do
+        configurable_options :one => 1, :two => nil
+      end
+    end
+
+    describe 'an instance' do
+      before do
+        @test_inst = @test_class.new
+      end
+
+      it 'should have its own config' do
+        assert @test_inst.config
+        @test_inst.config.one = 42
+        refute_equal 42, @test_class.config
+      end
+
+      it "should defer to the class's default config" do
+        assert @test_inst.default_config
+        assert_equal @test_class.default_config, @test_inst.default_config
+        assert_equal @test_class.default_config.object_id,
+          @test_inst.default_config.object_id
+      end
+    end
+
+    describe 'default_config' do
+      before do
+        @defaults = @test_class.default_config
+      end
+
+      it 'should return the default config' do
+        assert_equal 1, @defaults.one
+        assert_equal nil, @defaults.two
+      end
+
+      it 'should be frozen' do
+        assert @defaults.frozen?
+        assert_raises(TypeError) { @defaults.one = 42 }
+      end
+    end
+
+    describe 'config' do
+      before do
+        @config = @test_class.config
+      end
+
+      it 'should not be frozen' do
+        refute @config.frozen?
+        begin
+          @config.one = 42
+        rescue TypeError
+          flunk "couldn't set config.one"
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-configurable
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Kevin R. Bullock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 6
+        - 1
+        version: 2.6.1
+  type: :development
+  version_requirements: *id002
+description: Lets you make your Ruby class configurable with a simple mixin.
+email: 
+- kbullock@ringworld.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- COPYING.txt
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- COPYING.txt
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/configurable.rb
+- lib/configurable/config_struct.rb
+- lib/configurable/core_ext/extract_options.rb
+- lib/configurable/core_ext/inflections.rb
+- test/test_config_struct.rb
+- test/test_configurable.rb
+homepage: http://bitbucket.org/krbullock/configurable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: handtools
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Lets you make your Ruby class configurable with a simple mixin.
+test_files: 
+- test/test_config_struct.rb
+- test/test_configurable.rb