dsl_maker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6149b9dfdb94cd22dec949a542d68eaf6ab8a58
+  data.tar.gz: 688c84bd9102359e839b2884967c610f6435a726
+SHA512:
+  metadata.gz: edd7f3990066e812e461e42981cc920517f434d34ceab0801f16dcd8f9ab385828b6faea8732cd7f9f638fa11a3e2e596075253d135b9063c9a1b5431bc08ec3
+  data.tar.gz: cf857c182b8145d4b47dcd8b08e12c3697f60f2ea9a50aed770607112178f40185ce23d0a9086c5147999341b18cbceb10512fa94cc2c0fe22b94435815b8036

data/.gitattributes

@@ -0,0 +1 @@
+* text=auto

data/.gitignore

@@ -0,0 +1,42 @@
+# Swapfiles of various kinds
+*.sw?
+*~     # Randomness
+
+Gemfile.lock
+
+# Everything below here was auto-generated by GitHub
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--tty
+--require spec_helper
+-I lib

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+cache: bundler
+rvm:
+  - ruby-head
+  - 2.2
+  - 2.1
+  - 2.0.0
+  - 1.9.3
+  - rbx-2
+matrix:
+  include:
+    - rvm: jruby-head
+      env: JRUBY_OPTS="$JRUBY_OPTS -Xcli.debug=true --debug"  # for simplecov
+    - rvm: jruby-21mode
+      env: JRUBY_OPTS="$JRUBY_OPTS -Xcli.debug=true --debug"  # for simplecov
+    - rvm: jruby-20mode
+      env: JRUBY_OPTS="$JRUBY_OPTS -Xcli.debug=true --debug"  # for simplecov
+    - rvm: jruby-19mode
+      env: JRUBY_OPTS="$JRUBY_OPTS -Xcli.debug=true --debug"  # for simplecov
+  fast_finish: true

data/.yardopts

@@ -0,0 +1,7 @@
+--title 'DSL::Maker Documentation'
+
+--no-private
+--main=README.md
+
+--markup-provider=redcarpet
+--markup=markdown

data/Gemfile

@@ -0,0 +1,12 @@
+require File.expand_path('on_what', File.dirname(__FILE__))
+source 'https://rubygems.org'
+
+# Travis-only dependencies go here
+if on_travis? && !on_1_8?
+  group :test do
+    gem 'codecov', '>= 0.0.9', :require => false
+  end
+end
+
+# Specify gem's dependencies in dsl_maker.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,340 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+ 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.
+
+    {description}
+    Copyright (C) {year}  {fullname}
+
+    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,321 @@
+# DSL::Maker
+
+[![Build Status](https://img.shields.io/travis/robkinyon/ruby-dsl-maker.svg)](https://travis-ci.org/robkinyon/ruby-dsl-maker)
+[![Code Climate](https://img.shields.io/codeclimate/github/robkinyon/ruby-dsl-maker.svg)](https://codeclimate.com/github/robkinyon/ruby-dsl-maker)
+[![Code Coverage](https://img.shields.io/codecov/c/github/robkinyon/ruby-dsl-maker.svg)](https://codecov.io/github/robkinyon/ruby-dsl-maker)
+[![Inline docs](http://inch-ci.org/github/robkinyon/ruby-dsl-maker.png)](http://inch-ci.org/github/robkinyon/ruby-dsl-maker)
+
+
+Writing single-level Ruby-like DSLs is really easy. Ruby practically builds them
+for you with a little meta-programming. [Docile](https://github.com/ms-ati/docile)
+makes it ridiculously easy and there are nearly a dozen other modules to do so.
+
+Unfortunately, writing multi-level DSLs becomes repetitive and overly complex.
+Which is dumb. Multi-level DSLs are where the sweetness lives. We write DSLs in
+order to make things simpler for ourselves, particularly when we want to have
+less-experienced individuals able to make changes because they have the business
+or domain knowledge. Limiting everything to single-level DSLs makes no sense.
+
+`DSL::Maker` provides a quasi-DSL-like structure that allows you to easily build
+multi-level DSLs and handle the output.
+
+## Usage
+
+### Single-level DSLs
+
+In its documentation, [Docile](https://github.com/ms-ati/docile) has a DSL that
+builds pizza. An example would look like:
+
+```ruby
+@sauce_level = :extra
+
+pizza do
+  cheese
+  pepperoni
+  sauce @sauce_level
+end
+#=> #<Pizza:0x00001009dc398 @cheese=true, @pepperoni=true, @bacon=false, @sauce=:extra>
+```
+
+The PizzaBuilder code (via Docile) looks like:
+
+```ruby
+Pizza = Struct.new(:cheese, :pepperoni, :bacon, :sauce)
+
+class PizzaBuilder
+  def cheese(v=true); @cheese = v; self; end
+  def pepperoni(v=true); @pepperoni = v; self; end
+  def bacon(v=true); @bacon = v; self; end
+  def sauce(v=nil); @sauce = v; self; end
+  def build
+    Pizza.new(!!@cheese, !!@pepperoni, !!@bacon, @sauce)
+  end
+end
+
+PizzaBuilder.new.cheese.pepperoni.sauce(:extra).build
+#=> #<Pizza:0x00001009dc398 @cheese=true, @pepperoni=true, @bacon=false, @sauce=:extra>
+```
+
+But, this doesn't actually implement the DSL. That is left for another snippet:
+
+``` ruby
+def pizza(&block)
+  Docile.dsl_eval(PizzaBuilder.new, &block).build
+end
+```
+
+And it's not quite clear where to actually put this code so that you can ship this
+DSL like Chef or Sinatra.
+
+You would implement the same DSL using DSL::Maker as so:
+
+```ruby
+class PizzaBuilder < DSL::Maker
+  add_entrypoint(:pizza, {
+    :cheese => Boolean,
+    :pepperoni => Boolean,
+    :bacon => Boolean,
+    :sauce => String,
+  }) do
+    Pizza.new(cheese, pepperoni, bacon, sauce)
+  end
+end
+
+pizza = PizzaBuilder.parse_dsl(dsl_block)
+```
+
+Now, you accept the strings (possibly from `IO.read()`) and magically get the
+result of your DSL.
+
+(The PizzaBuilder is used in the test suite in `spec/single_level_spec.rb`.)
+
+### Multi-level DSLs
+
+So far, this isn't that impressive - slightly better type coercion and a method
+for handling the parsing of a string isn't much to crow about.
+
+```ruby
+Person = Struct.new(:name, :mother, :father)
+
+class FamilyTree < DSL::Maker
+  add_entrypoint(:person, {
+    :name => String,
+    :mother => generate_dsl({
+      :name => String,
+    }) do
+      Person.new(name, nil, nil)
+    end,
+    :father => generate_dsl({
+      :name => String,
+    }) do
+      Person.new(name, nil, nil)
+    end,
+  }) do
+    Person.new(name, mother, father)
+  end
+end
+
+john_smith = FamilyTree.parse_dsl("
+  person {
+    name 'John Smith'
+    mother {
+      name 'Mary Smith'
+    }
+    father {
+      name 'Tom Smith'
+    }
+  }
+")
+```
+
+Refactor that a bit and we end up with:
+
+```ruby
+class FamilyTree < DSL::Maker
+  parent = generate_dsl({
+    :name => String,
+  }) do
+    Person.new(name)
+  end
+
+  add_entrypoint(:person, {
+    :name => String,
+    :mother => parent,
+    :father => parent,
+  }) do
+    Person.new(name, mother, father)
+  end
+end
+```
+
+There's no limit to the number of levels you can go define.
+
+### Handling Arguments
+
+We can improve the family tree DSL a bit by handling arguments. An example works
+best to explain.
+
+```ruby
+Person = Struct.new(:name, :age, :mother, :father)
+class FamilyTree < DSL::Maker
+  parent = generate_dsl({
+    :name => String,
+    :age  => String,
+  }) do |*args|
+    default(:name, args)
+    Person.new(name, age)
+  end
+
+  add_entrypoint(:person, {
+    :name => String,
+    :age  => String,
+    :mother => parent,
+    :father => parent,
+  }) do |*args|
+    default('name', args, 0)
+    Person.new(name, age, mother, father)
+  end
+end
+
+john_smith = FamilyTree.parse_dsl("
+  person 'John Smith' do
+    age 20
+    mother 'Mary Smith' do
+      age 50
+    end
+    father {
+      name 'Tom Smith'
+      age 49
+    }
+  end
+")
+```
+
+The result is exactly the same as before.
+
+### Handling multiple items
+
+Chef's recipe files have many entries of different types in them. It doesn't do
+you any good if you can't do the same thing.
+
+```ruby
+Car = Struct.new(:make, :model)
+Truck = Struct.new(:make, :model)
+
+class VehicleDSL < DSL::Maker
+  add_entrypoint(:car, {
+    :make => String,
+    :model => String,
+  }) {
+    Car.new(make, model)
+  }
+
+  add_entrypoint(:truck, {
+    :make => String,
+    :model => String,
+  }) {
+    Truck.new(make, model)
+  }
+end
+
+vehicles = VehicleDSL.parse_dsl("
+  car {
+    make 'Honda'
+    model 'Civic'
+  }
+
+  truck {
+    make 'Ford'
+    model 'F150'
+  }
+")
+```
+
+`vehicles` is an `Array` with a `Car` and a `Truck` in it, in that order. If your
+DSL snippet has only one item, you get back that item. If it has multiple items,
+you get back an `Array` with everything in the right order.
+
+## API
+
+### Class Methods
+
+DSL::Maker provides three class methods - two for constructing your DSL and one
+for parsing your DSL.
+
+* `add_entrypoint(Symbol, Hash={}, Block)`
+
+This is used in defining your DSL class to create an entrypoint - the highest
+level of your DSL. `add_entrypoint()` will create the right class methods for
+Docile to use when `parse_dsl()` is called. It will also invoke `generate_dsl()`
+with the Hash you give it to create the parsing.
+
+* `generate_dsl(Hash={}, Block)`
+
+This is used in defining your DSL to describe the innards - the guts that actually
+have meaning. Once this level has been completed, the Block will be called and the
+return value provided back to the name.
+
+* `build_dsl_element(Class, String, Type)`
+
+This is normally called by `generate_dsl()` to actually construct the DSL element.
+It is provided for you so that you can create recursive DSL definitions. Look at
+the tests in `spec/multi_level_spec.rb` for an example of this.
+
+* `parse_dsl(String)`
+
+You call this on your DSL class when you're ready to invoke your DSL. It will
+return whatever the block provided `add_entrypoint()` returns.
+
+In the case of multiple DSL entrypoints (for example, a normal Chef recipe),
+`parse_dsl()` will return an array with all the return values in the order of
+invocation.
+
+### Coercions
+
+There are three defined coercions for use within `generate_dsl()`:
+
+  * String - This takes any string.
+  * Boolean - This takes whatever you give it and returns the truthiness of it.
+  * `generate_dsl()` - This descends into another level of DSL.
+
+You will be able to add your own coercions in a forthcoming version of DSL::Maker.
+
+### Helpers
+
+There is one pre-defined helper.
+
+* `default(String, Array, Integer=0)`
+
+This takes a method name and the args provided to the block. It then ensures that
+the method defaults to the value in the args at the optional third argument.
+
+## Installation
+
+``` bash
+$ gem install dsl_maker
+```
+
+## Links
+* [Source](https://github.com/robkinyon/ruby-dsl-maker)
+* [Documentation](http://rubydoc.info/gems/ruby-dsl-maker)
+* [Bug Tracker](https://github.com/robkinyon/ruby-dsl-maker/issues)
+
+## Status
+
+Works on [all ruby versions since 1.9.3](https://github.com/robkinyon/ruby-dsl-maker/blob/master/.travis.yml), or so Travis CI [tells us](https://travis-ci.org/robkinyon/ruby-dsl-maker).
+
+## Note on Patches/Pull Requests
+
+  * Fork the project.
+  * Setup your development environment with:
+      `gem install bundler; bundle install`
+  * Make your feature addition or bug fix in a branch.
+  * Add tests for it. This is important so I don't break it in a future version
+      unintentionally. Plus, I maintain 100% code coverage.
+  * Commit.
+  * Send me a pull request.
+    * I will only accept PRs from branches, never master.
+
+## Copyright & License
+
+Copyright (c) 2015 Rob Kinyon