docile 1.0.0 → 1.0.1

data/Gemfile

@@ -5,6 +5,6 @@ gemspec
 
 # Explicitly require test gems for Travis CI, since we're excluding dev dependencies
 group :test do
-  gem "rake", "~> 0.9.2"
-  gem "rspec", "~> 2.11.0"
+  gem "rake", ">= 0.9.2"
+  gem "rspec", ">= 2.11.0"
 end

data/README.md

@@ -11,43 +11,73 @@ Let's make our Ruby DSLs more docile...
 [![Build Status](https://travis-ci.org/ms-ati/docile.png)](https://travis-ci.org/ms-ati/docile)
 [![Dependency Status](https://gemnasium.com/ms-ati/docile.png)](https://gemnasium.com/ms-ati/docile)
 
-## Usage
+## Basic Usage
 
-Let's treat an Array's methods as its own DSL:
+Let's say that we want to make a DSL for modifying Array objects.
+Wouldn't it be great if we could just treat the methods of Array as a DSL?
 
-``` ruby
-Docile.dsl_eval([]) do
+```ruby
+with_array([]) do
   push 1
   push 2
   pop
   push 3
 end
-#=> [1, 3]
+# => [1, 3]
 ```
 
-Mutating (changing) the array is fine, but what you probably really want as your DSL is actually a [Builder Pattern][2].
-
-For example, if you have a PizzaBuilder class that can already build a Pizza:
-
+No problem, just define the method `with_array` like this:
 ``` ruby
-@sauce_level = :extra
-pizza = PizzaBuilder.new.cheese.pepperoni.sauce(@sauce_level).build
-#=> #<Pizza:0x00001009dc398 @cheese=true, @pepperoni=true, @bacon=false, @sauce=:extra>
+def with_array(arr=[], &block)
+  Docile.dsl_eval(arr, &block)
+end
 ```
 
-Then you can use this same PizzaBuilder class as a DSL:
+Easy!
 
-``` ruby
+## Advanced Usage
+
+Mutating (changing) an Array instance is fine, but what usually makes a good DSL is a [Builder Pattern][2].
+
+For example, let's say you want a DSL to specify how you want to build a Pizza:
+```ruby
 @sauce_level = :extra
-pizza = Docile.dsl_eval(PizzaBuilder.new) do
+
+pizza do
   cheese
   pepperoni
   sauce @sauce_level
-end.build
+end
+# => #<Pizza:0x00001009dc398 @cheese=true, @pepperoni=true, @bacon=false, @sauce=:extra>
+```
+
+And let's say we have a PizzaBuilder, which builds a Pizza like this:
+```ruby
+Pizza = Struct.new(:cheese, :pepperoni, :bacon, :sauce)
+
+class PizzaBuilder
+  def cheese(v=true); @cheese = v; end
+  def pepperoni(v=true); @pepperoni = v; end
+  def bacon(v=true); @bacon = v; end
+  def sauce(v=nil); @sauce = v; 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>
 ```
 
-It's just that easy!
+Then implement your DSL like this:
+
+``` ruby
+def pizza(&block)
+  Docile.dsl_eval(PizzaBuilder.new, &block).build
+end
+```
+
+It's just that easy! 
 
 [2]: http://stackoverflow.com/questions/328496/when-would-you-use-the-builder-pattern  "Builder Pattern"
 

data/docile.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Running rspec tests from rake
-  s.add_development_dependency "rake", "~> 0.9.2"
-  s.add_development_dependency "rspec", "~> 2.11.0"
+  s.add_development_dependency "rake", ">= 0.9.2"
+  s.add_development_dependency "rspec", ">= 2.11.0"
 
   # Github flavored markdown in YARD documentation
   # http://blog.nikosd.com/2011/11/github-flavored-markdown-in-yard.html

data/lib/docile/version.rb

@@ -1,3 +1,3 @@
 module Docile
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docile
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.2
 - !ruby/object:Gem::Dependency
@@ -32,7 +32,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.11.0
   type: :development
@@ -40,7 +40,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.11.0
 - !ruby/object:Gem::Dependency
@@ -124,15 +124,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2020809152847392489
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2020809152847392489
 requirements: []
 rubyforge_project: docile
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Docile keeps your Ruby DSL's tame and well-behaved