rabbitt-configurator 1.2.4

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+*.swp
+pkg/
+tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in configurator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    rabbitt-configurator (1.2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.6)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rabbitt-configurator!
+  rake
+  rspec

data/LICENSE

@@ -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.
+
+    
+    Copyright (C) 2013  Carl P. Corliss
+
+    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/README.md

@@ -0,0 +1,216 @@
+# Configurator
+
+## Installation
+1. Add `gem 'configurator', :git => 'https://github.com/rabbitt/configurator.git'` to your Gemfile
+2. Run `bundle install`
+
+## Usage
+
+### Creating a Configuration
+
+```ruby
+module Application
+  class Config
+    include Configurator::Bindings
+    configuration do
+      section :general do
+        option :bar, default: 'baz'
+        option :domain, default: -> { %x { hostname -f }.strip.split('.')[-2..-1].join('.') }
+        option :email,  validate: ->(_value) { _value.include?('@') && _value.count('.') >= 1 },
+                        validate_message: "email must contain @ and at least one '.'"
+      end
+      section :ldap do
+        option :hostname,   default: -> { "ldap.%s" % root.general.domain }
+        option :encryption, default: :none, expect: [ :none, :start_tls, :simple_tls ]
+        option :base_dn,    default: -> { "dc=%s,dc=%s" % root.general.domain.split('.') }
+        option :user_base,  default: -> { "ou=people,%s" % base_dn }
+      end
+      section :misc do
+        option :foobaz, :uri, deprecated: '10/29/2013'
+      end
+    end
+    renamed! 'misc.foo', 'general.bar'
+    renamed! 'ldap.host', 'ldap.hostname'
+    deprecated! 'misc', '10/31/2013'
+    alias! 'general.bar', 'general.baz'
+  end
+end
+```
+
+This creates a singleton Application::Config instance which you can use to access your configuration. Additionally, you can load up a YAML file by calling the `load(config_path, environment)` method of your new `Application::Config` object.
+
+#### Sections
+
+Sections are for defining nested groups of related information. Initially, by calling `configuration do; end` a root section (aptly called 'root') is automagically created for you. All top-level section/option definitions are added to the root section.
+
+#### Options
+
+Options are the actual meat of your configuration and can be defined with specific types, defaults, validations and can be auto-converted to another type on read if you provide casting information.
+
+The format of an option definition is as follows:
+
+`option <name>[[, type], options]`
+
+Note: type is completely optionally, however, if you don't provide a type, your option will be marked as type `:any` (unless you specify a default) which essentially marks it as accepting any data type, and prevents type validation from happening against it (unless you provide your own validation rule).
+
+As you build your configuration object, methods will be created automatically at each level providing you with access to each section and option. For example, given the above example `Application::Config` object, you would be able to reference the ldap encryption option by way of `Application::Config.ldap.encryption`. Additionally, each node has access back to it's parent node as well as the root node, so you could also (but probably never would) do the following to get the general domain option: `Application::Config.ldap.encryption.parent.hostname.root.general.domain`
+
+Valid options for the `option` command are:
+
+<dl>
+  <dt>:default</dt>
+  <dd>(<em>Mixed</em>) Can be used to specify a default value for the option. If you use a callable, it must <em>not</em> accept any parameters.</dd>
+
+  <dt>:cast</dt>
+  <dd>(<em>Mixed</em>) Can be used to specify a cast type for the option. If you use a callable, it <em>must</em> accept one parameters, the value to convert.</dd>
+
+  <dt>:validate</dt>
+  <dd>(<em>Boolean|Callable</em>) Can be used to specify validation rule. Default value is true. If you specify False, then no validation will be performed. If you use a callable, it <em>must</em> accept one parameters, the value to validate.</dd>
+
+  <dt>:validate_message</dt>
+  <dd>(<em>String</em>) Message to provide to the user if the option fails the custom validation rule (only relevant when using a callable with :validate).</dd>
+
+  <dt>:expect</dt>
+  <dd>(<em>Array|Callable</em>) Allows you to specify a list, or callable to validate the value against. If it a list (array) is provided, it will ensure that the input value is in that list. Otherwise, with a callable, it functions like :validate above.</dd>
+
+  <dt>:expect_message</dt>
+  <dd>(<em>String</em>) Message to provide to the user if the option fails the custom expect rule (only relevant when using a callable with :expect).</dd>
+
+  <dt>:optional OR :required</dt>
+  <dd>(<em>boolean</em>) specifies where the option is required or not. Note: you can only specify one or the other, not both :optional <em>and</em> :required.</dd>
+</dl>
+
+##### Types
+
+Configurator types are used for both validation and type-casting. Type is generally specified at option creation, but can be left off if you specify a default for the option. If your option has a default, and not type was specified, Configurator will make effort guess (based on the default) as to what the type should be.
+
+Following are the list of types that Configurator understands:
+
+<dl>
+  <dt>:any</dt>
+  <dd>Default type if none specified.</dd>
+  <dd><strong><em>Type Validation</em></strong>: Any data is considered valid for an option of this type.</dd>
+  <dd><strong><em>Type Casting</em></strong>: No type-casting is performed for this data type - data out == data in.</dd>
+
+  <dt>:scalar</dt>
+  <dd>Allows for values of :integer, :float and :string, :symbol, :boolean</dd>
+  <dd><strong><em>Type Validation</em></strong>: Any of :integer, :Float, :symbol, :string and :boolean are considered valid values </dd>
+  <dd><strong><em>Type Casting</em></strong>: No type-casting is performed for this data type - data out == data in.</dd>
+
+  <dt>:integer</dt>
+  <dd>Used for Bignum, Fixnum and generally any non-Float Numeric value.</dd>
+  <dd><strong><em>Type Validation</em></strong>: Ensures a valid integer value is present.</dd>
+  <dd><strong><em>Type Casting</em></strong>: Conversion to integer is performed using #to_i on the given object.</dd>
+
+  <dt>:float</dt>
+  <dd>Used for Bignum, Fixnum and generally any non-Float Numeric value.</dd>
+  <dd><strong><em>Type Validation</em></strong>: Ensures a valid float value is present.</dd>
+  <dd><strong><em>Type Casting</em></strong>: Conversion to Float is performed using #to_f on the given object.</dd>
+
+  <dt>:symbol, :string, :array, :hash</dt>
+  <dd>Used for values of the same basic Ruby type.</dd>
+  <dd><strong><em>Type Validation</em></strong>: Ensures input value is one of Symbol, String or Array.</dd>
+  <dd><strong><em>Type Casting</em></strong>: Data is converted to the specific type using one #to_s for strings, #to_s.to_sym for symbols and [*value] for arrays.</dd>
+
+  <dt>:boolean</dt>
+  <dd>Used for true/false type values. Automatically converts objects to their boolean equivalent.</dd>
+  <dd><strong><em>Type Validation</em></strong>: Ensure input value either a TrueClass or FalseClass.</dd>
+  <dd><strong><em>Type Casting</em></strong>: Converts strings containing any of: yes, no, enabled, disabled, true, false, off, on; otherwise converts to false for nil and true for any valid object.</dd>
+
+  <dt>:path</dt>
+  <dd>Used for pathing data, such as fully qualified, or relative paths to files/directories.</dd>
+  <dd><strong><em>Type Validation</em></strong>: Ensures value can be represented as a valid Pathname object.</dd>
+  <dd><strong><em>Type Casting</em></strong>: Converts value to a Pathname object.</dd>
+
+  <dt>:uri</dt>
+  <dd></dd>
+  <dd><strong><em>Type Validation</em></strong>: Ensures value can be represented sa a valid URI object.</dd>
+  <dd><strong><em>Type Casting</em></strong>: Converts vaue to a URI object</dd>
+
+  <dt>[&lt;subtype&gt;]</dt>
+  <dd>This type represents a collection of subtype objects, i.e, an array of objects of one given type. Subtype can be one of the types listed here, except another collection.</dd>
+  <dd><strong><em>Type Validation</em></strong>: Enssures the object is an array containing only elements of type 'subtype'</dd>
+  <dd><strong><em>Type Casting</em></strong>: Converts all elements in the array to type 'subtype'</dd>
+</dl>
+
+<dl>
+</dl>
+
+##### Defaults
+
+Defaults can be used to provide a default value for configuration options, and can either be a literal value or a callable lambda. Defaults are only used in the event that no overriding value has been assigned to the configuration option (either by loading a YAML config file via, or direct assignment). Callables must not accept any calling parameters and are executed within the context of the option's parent section. This allows for references to the option's sibling options, as well as the root and parent sections. See `ldap.hostname` and `ldap.user_base` as examples of this in the example under Usage above.
+
+##### Deprecations, Renames and Aliases
+
+In addition to specifying defaults, validations and casting types, you can also mark options as deprecated or renamed as well as alias one option to another. Deprecating, Renaming and Aliasing are all useful options for maintaining backwards compatability with your previous configurations. Additionally, it serves as a way to let your users know when changes have been made to the underlying structure of the configuration, allowing them to update their configuration files appropriately.
+
+###### Deprecation
+
+Deprecated options are a way of letting your end user know that a given option is planned for removal - even allowing for an end of life date to be provided. The signature for marking an option as deprecated is:
+
+  `deprecated! '&lt;option.path>'[, [end of life date]]`
+
+The option.path is the list of names of the path, starting with 'root' and proceeding section by section all the way to the option itself, separated by a dots. For example, the option path for `Application::Config.ldap.encryption` would be `root.ldap.encryption` - though 'root.' is optionally, so you could just as easily write 'ldap.encryption'.
+
+###### Renames
+
+Renames are a way of telling your users that an option has been renamed, or moved from one option path name to another. With renames, you should have already renamed/moved your option to it's new name (and optionally section) before calling `renamed!`. Once you call `renamed!`, a new option is added to your configuration using the `legacy path` you provided, and links that legacy path to the `new path`. Any assignments, or reads, from the `legacy path` will trigger warnings letting the user know that the path has changed, and what it has changed to.
+
+The signature for a rename is:
+
+  `renamed! 'legacy path', 'new path'`
+
+###### Aliases
+
+Aliases function like renames but do not actually emit warnings. They are useful as alternate access points for a given configuration option. Like renames, the link target must exist or an exception will be thrown.
+
+The signature for an alias is similar to Ruby's own alias method and is:
+
+  `alias! 'original.path', 'new.path'`
+
+#### Accessing / Modifying options
+
+```ruby
+config = Application::Config
+
+config.general.email # -> nil
+config.general.email.valid? # -> false
+config.general.email.required? # -> true
+config.general.email = 'dev@null.com'
+config.general.email.valid? # -> true
+config.general.email # -> 'dev@null.com'
+
+config.ldap.host # -> nil
+config.ldap.hostname # -> nil
+config.ldap.host = 'foo.bar.com'
+config.ldap.host # -> 'foo.bar.com'
+config.ldap.hostname # -> 'foo.bar.com'
+
+config.general.domain # -> 'example.com'
+config.ldap.base_dn # -> 'dc=example,dc=com'
+config.ldap.user_base # -> 'ou=people,dc=example,dc=com'
+config.general.daomin = 'foo.com'
+config.ldap.base_dn # -> 'dc=foo,dc=com'
+config.ldap.user_base # -> 'ou=people,dc=foo,dc=com'
+
+config.misc.foo # -> 'baz'
+config.general.bar # -> 'baz'
+config.misc.foo === config.general.bar # -> true
+```
+
+### Loading config file
+
+Probably the most import functionality of configurator is its ability to load a configuration file against this predefined structure that you create, and have the loaded values validated against your structure. Following is an example of how to load your data:
+
+```ruby
+Application::Config.load(File.expand_path('/path/to/config.yml'), :production)
+trap('HUP') { Application::Config.reload! }
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/configurator.gemspec

@@ -0,0 +1,44 @@
+=begin
+Copyright (C) 2013 Carl P. Corliss
+
+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.
+=end
+
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+require 'configurator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rabbitt-configurator"
+  spec.version       = Configurator::VERSION
+  spec.authors       = ["Carl P. Corliss"]
+  spec.email         = ["rabbitt@gmail.com"]
+  spec.description   = %q{A library used to create Config classes with validation, type enforcement, casting and other goodies.}
+  spec.summary       = %q{Config class builder and loader}
+  spec.homepage      = "http://github.com/rabbitt/configurator"
+  spec.license       = "GPLv2"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.extra_rdoc_files = ["README.md"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end