docile 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57d90aa5d94c06fab36bcf2ad9c058e8b3c7ec3b
-  data.tar.gz: c73f0d3af5a1d87fcc3ae562e2c90bdd7e06b724
+  metadata.gz: fb7581d7fa7a2ace7257cb7d0fac9732c80480a5
+  data.tar.gz: 1fab351868ad13d87ceb0882460aa059428b29f0
 SHA512:
-  metadata.gz: 2ed37d882ad062a8ae1dc02963582c57ed51383b7916176964a55ad4833ee34e93a98743382d527113554f8cef5774ef96e8e681396de00b11bfdcb4bda80bef
-  data.tar.gz: a000461e5ffe9649801875b2d0228d1a5d61510813713a90fe5cfb4aa594abaaa52e7f2554ec57113eb0b679712f39be469664ccbe82f0ed9afbb9c1f1324d8b
+  metadata.gz: 762a98e99139ca515bd787e794be284c1a3a4dd1be805869736ce8f19bb6cadbcedf6a35b9fb72f71bce5806b45171190cf63b58b02754ebaf400b705971e338
+  data.tar.gz: 5825352e7d6d819b557909f296e2d23ba8bb8807a212bb24781d758f2c59ab030f977bf9f2cb7af5dae7709d86fde8e306a77e1f56f0accb5b5c5b939427a215

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0-p247
+ruby-2.0.0

data/.travis.yml

@@ -8,5 +8,4 @@ rvm:
   - ree
   - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
+  - rbx-2.2.0

data/Gemfile

@@ -1,11 +1,17 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify gem's dependencies in docile.gemspec
 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 "coveralls", :require => false
+  gem 'rake', '~> 0.9.2'
+  gem 'rspec', '~> 2.11.0'
+  gem 'mime-types', '~> 1.25.1'
+  gem 'coveralls', :require => false
+
+  platform :rbx do
+    gem 'rubysl'            # Since 2.2.0, Rubinius needs Ruby standard lib as gem
+    gem 'rubinius-coverage' # Coverage tooling for SimpleCov on Rubinius
+  end
 end

data/HISTORY.md

@@ -1,5 +1,10 @@
 # HISTORY
 
+## [v1.1.1 (Nov 26, 2013)](http://github.com/ms-ati/docile/compare/v1.1.0...v1.1.1)
+
+  - documentation updates and corrections
+  - fix Rubinius build in Travis CI
+
 ## [v1.1.0 (Jul 29, 2013)](http://github.com/ms-ati/docile/compare/v1.0.5...v1.1.0)
 
   - add functional-style DSL objects via `Docile#dsl_eval_immutable`

data/README.md

@@ -16,7 +16,9 @@ coding a bit more docile...
 
 [1]: http://www.google.com/search?q=docile+definition   "Google"
 
-## Basic Usage
+## Usage
+
+### Basic
 
 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?
@@ -41,7 +43,7 @@ end
 
 Easy!
 
-## Advanced Usage
+### Advanced
 
 Mutating (changing) an Array instance is fine, but what usually makes a good DSL is a [Builder Pattern][2].
 
@@ -64,10 +66,10 @@ And let's say we have a PizzaBuilder, which builds a Pizza like this:
 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 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
@@ -89,7 +91,7 @@ It's just that easy!
 
 [2]: http://stackoverflow.com/questions/328496/when-would-you-use-the-builder-pattern  "Builder Pattern"
 
-## Block parameters
+### Block parameters
 
 Parameters can be passed to the DSL block.
 
@@ -149,7 +151,7 @@ end
 
 [3]: http://www.sinatrarb.com "Sinatra"
 
-## Functional-Style DSL Objects
+### Functional-Style DSL Objects
 
 Sometimes, you want to use an object as a DSL, but it doesn't quite fit the
 [imperative](http://en.wikipedia.org/wiki/Imperative_programming) pattern shown
@@ -166,11 +168,16 @@ order to enforce [immutability](http://en.wikipedia.org/wiki/Immutable_object).
 Wouldn't it be great if we could just treat these methods as a DSL as well?
 
 ```ruby
-with_immutable_string("I'm immutable!".freeze) do
+s = "I'm immutable!".freeze
+
+with_immutable_string(s) do
   reverse
   upcase
 end
 #=> "!ELBATUMMI M'I"
+
+s
+#=> "I'm immutable!"
 ```
 
 No problem, just define the method `with_immutable_string` like this:
@@ -199,15 +206,14 @@ All set!
 $ gem install docile
 ```
 
-## Documentation
-
-Documentation hosted on *rubydoc.info*: [Docile Documentation](http://rubydoc.info/gems/docile)
-
-Or, read the code hosted on *github.com*: [Docile Code](https://github.com/ms-ati/docile)
+## Links
+* [Source](https://github.com/ms-ati/docile)
+* [Documentation](http://rubydoc.info/gems/docile)
+* [Bug Tracker](https://github.com/ms-ati/docile/issues)
 
 ## Status
 
-Version 1.0.x works on [all ruby versions since 1.8.7](https://github.com/ms-ati/docile/blob/master/.travis.yml).
+Works on [all ruby versions since 1.8.7](https://github.com/ms-ati/docile/blob/master/.travis.yml).
 
 ## Note on Patches/Pull Requests
 

data/Rakefile

@@ -1,6 +1,6 @@
-require "rake/clean"
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'rake/clean'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 # Default task for `rake` is to run rspec
 task :default => [:spec]
@@ -9,7 +9,7 @@ task :default => [:spec]
 RSpec::Core::RakeTask.new
 
 # Configure `rake clobber` to delete all generated files
-CLOBBER.include("pkg", "doc", "coverage")
+CLOBBER.include('pkg', 'doc', 'coverage')
 
 # Only configure yard doc generation when *not* on Travis
 if ENV['CI'] != 'true'

data/docile.gemspec

@@ -1,33 +1,33 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "docile/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'docile/version'
 
 Gem::Specification.new do |s|
-  s.name        = "docile"
+  s.name        = 'docile'
   s.version     = Docile::VERSION
-  s.authors     = ["Marc Siegel"]
-  s.email       = ["msiegel@usainnov.com"]
-  s.homepage    = "http://ms-ati.github.com/docile/"
-  s.summary     = "Docile keeps your Ruby DSL's tame and well-behaved"
-  s.description = "Docile turns any Ruby object into a DSL. Especially useful with the Builder pattern."
+  s.authors     = ['Marc Siegel']
+  s.email       = %w(msiegel@usainnov.com)
+  s.homepage    = 'http://ms-ati.github.com/docile/'
+  s.summary     = 'Docile keeps your Ruby DSLs tame and well-behaved'
+  s.description = 'Docile turns any Ruby object into a DSL. Especially useful with the Builder pattern.'
+  s.license     = 'MIT'
 
-  s.rubyforge_project = "docile"
+  s.rubyforge_project = 'docile'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = %w(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
-  s.add_development_dependency "yard"
-  s.add_development_dependency "redcarpet"
-  s.add_development_dependency "github-markup"
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'redcarpet'
+  s.add_development_dependency 'github-markup'
 
   # Coveralls test coverage tool
-  s.add_development_dependency "coveralls"
+  s.add_development_dependency 'coveralls'
 end

data/lib/docile.rb

@@ -1,7 +1,7 @@
-require "docile/version"
-require "docile/execution"
-require "docile/fallback_context_proxy"
-require "docile/chaining_fallback_context_proxy"
+require 'docile/version'
+require 'docile/execution'
+require 'docile/fallback_context_proxy'
+require 'docile/chaining_fallback_context_proxy'
 
 # Docile keeps your Ruby DSLs tame and well-behaved.
 module Docile
@@ -36,7 +36,7 @@ module Docile
   #
   # @param dsl   [Object] context object whose methods make up the DSL
   # @param args  [Array]  arguments to be passed to the block
-  # @yield                the block of DSL commands to be executed against the
+  # @param block [Proc]   the block of DSL commands to be executed against the
   #                         `dsl` context object
   # @return      [Object] the `dsl` context object after executing the block
   def dsl_eval(dsl, *args, &block)
@@ -74,7 +74,7 @@ module Docile
   # @param dsl   [Object] immutable context object whose methods make up the
   #                       initial DSL
   # @param args  [Array]  arguments to be passed to the block
-  # @yield                the block of DSL commands to be executed against the
+  # @param block [Proc]   the block of DSL commands to be executed against the
   #                         `dsl` context object and successor return values
   # @return      [Object] the return value of the final command in the block
   def dsl_eval_immutable(dsl, *args, &block)

data/lib/docile/chaining_fallback_context_proxy.rb

@@ -1,4 +1,4 @@
-require "docile/fallback_context_proxy"
+require 'docile/fallback_context_proxy'
 
 module Docile
   # @api private
@@ -9,7 +9,7 @@ module Docile
   # This is useful for implementing DSL evaluation for immutable context
   # objects.
   #
-  # @see Docile#dsl_eval_immutable
+  # @see Docile.dsl_eval_immutable
   class ChainingFallbackContextProxy < FallbackContextProxy
     # Proxy methods as in {FallbackContextProxy#method_missing}, replacing
     # `receiver` with the returned value.

data/lib/docile/execution.rb

@@ -1,7 +1,7 @@
 module Docile
   # @api private
   #
-  # A namespace for functions relating to the execution of a block agsinst a
+  # A namespace for functions relating to the execution of a block against a
   # proxy object.
   module Execution
     # Execute a block in the context of an object whose methods represent the
@@ -9,14 +9,13 @@ module Docile
     #
     # @param dsl        [Object] context object whose methods make up the
     #                            (initial) DSL
-    # @param proxy_type [FallbackContextProxy,
-    #                    ChainingFallbackContextProxy]
-    #                            class to instantiate as the proxy context
+    # @param proxy_type [FallbackContextProxy, ChainingFallbackContextProxy]
+    #                            which class to instantiate as proxy context
     # @param args       [Array]  arguments to be passed to the block
-    # @yield                     the block of DSL commands to be executed
+    # @param block      [Proc]   the block of DSL commands to be executed
     # @return           [Object] the return value of the block
     def exec_in_proxy_context(dsl, proxy_type, *args, &block)
-      block_context = eval("self", block.binding)
+      block_context = eval('self', block.binding)
       proxy_context = proxy_type.new(dsl, proxy_type.new(dsl, block_context))
       begin
         block_context.instance_variables.each do |ivar|

data/lib/docile/fallback_context_proxy.rb

@@ -12,12 +12,12 @@ module Docile
   #
   # This is useful for implementing DSL evaluation in the context of an object.
   #
-  # @see Docile#dsl_eval
+  # @see Docile.dsl_eval
   class FallbackContextProxy
     # The set of methods which will **not** be proxied, but instead answered
     # by this object directly.
     NON_PROXIED_METHODS = Set[:__send__, :object_id, :__id__, :==, :equal?,
-                              :"!", :"!=", :instance_exec, :instance_variables,
+                              :'!', :'!=', :instance_exec, :instance_variables,
                               :instance_variable_get, :instance_variable_set,
                               :remove_instance_variable]
 

data/lib/docile/version.rb

@@ -1,4 +1,4 @@
 module Docile
   # The current version of this library
-  VERSION = "1.1.0"
+  VERSION = '1.1.1'
 end

data/spec/docile_spec.rb

@@ -1,10 +1,10 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Docile do
 
-  describe "#dsl_eval" do
+  describe '.dsl_eval' do
 
-    context "when DSL context object is an Array" do
+    context 'when DSL context object is an Array' do
       let(:array) { [] }
       let!(:result) { execute_dsl_against_array }
 
@@ -17,15 +17,15 @@ describe Docile do
         end
       end
 
-      it "executes the block against the DSL context object" do
+      it 'executes the block against the DSL context object' do
          array.should == [1, 3]
       end
 
-      it "returns the DSL object after executing block against it" do
+      it 'returns the DSL object after executing block against it' do
          result.should == array
       end
 
-      it "doesn't proxy #__id__"  do
+      it "doesn't proxy #__id__" do
         Docile.dsl_eval(array) { __id__.should_not == array.__id__ }
       end
 
@@ -46,7 +46,7 @@ describe Docile do
       end
     end
 
-    context "when DSL context object is a Builder pattern" do
+    context 'when DSL context object is a Builder pattern' do
       let(:builder) { PizzaBuilder.new }
       let(:result) { execute_dsl_against_builder_and_call_build }
 
@@ -59,7 +59,7 @@ describe Docile do
         end.build
       end
 
-      it "returns correctly built object" do
+      it 'returns correctly built object' do
         result.should == Pizza.new(true, false, true, :extra)
       end
     end
@@ -86,12 +86,12 @@ describe Docile do
       Docile.dsl_eval(OuterDSL.new, &block)
     end
 
-    context "when given parameters for the DSL block" do
+    context 'when given parameters for the DSL block' do
       def parameterized(*args, &block)
         Docile.dsl_eval(OuterDSL.new, *args, &block)
       end
 
-      it "passes parameters to the block" do
+      it 'passes parameters to the block' do
         parameterized(1,2,3) do |x,y,z|
           x.should == 1
           y.should == 2
@@ -99,11 +99,11 @@ describe Docile do
         end
       end
 
-      it "finds parameters before methods" do
+      it 'finds parameters before methods' do
         parameterized(1) { |a| a.should == 1 }
       end
 
-      it "find outer dsl parameters in inner dsl scope" do
+      it 'find outer dsl parameters in inner dsl scope' do
         parameterized(1,2,3) do |a,b,c|
           inner_with_params(c) do |d,e|
             a.should == 1
@@ -116,18 +116,18 @@ describe Docile do
       end
     end
 
-    context "when DSL blocks are nested" do
+    context 'when DSL blocks are nested' do
 
-      context "method lookup" do
-        it "finds method of outer dsl in outer dsl scope" do
+      context 'method lookup' do
+        it 'finds method of outer dsl in outer dsl scope' do
           outer { a.should == 'a' }
         end
 
-        it "finds method of inner dsl in inner dsl scope" do
+        it 'finds method of inner dsl in inner dsl scope' do
           outer { inner { b.should == 'b' } }
         end
 
-        it "finds method of outer dsl in inner dsl scope" do
+        it 'finds method of outer dsl in inner dsl scope' do
           outer { inner { a.should == 'a' } }
         end
 
@@ -141,27 +141,27 @@ describe Docile do
           outer { inner { c.should == 'c' } }
         end
 
-        it "finds method of outer dsl in preference to block context" do
+        it 'finds method of outer dsl in preference to block context' do
           def a; 'not a'; end
           outer { a.should == 'a' }
           outer { inner { a.should == 'a' } }
         end
       end
 
-      context "local variable lookup" do
-        it "finds local variable from block context in outer dsl scope" do
+      context 'local variable lookup' do
+        it 'finds local variable from block context in outer dsl scope' do
           foo = 'foo'
           outer { foo.should == 'foo' }
         end
 
-        it "finds local variable from block definition in inner dsl scope" do
+        it 'finds local variable from block definition in inner dsl scope' do
           bar = 'bar'
           outer { inner { bar.should == 'bar' } }
         end
       end
 
-      context "instance variable lookup" do
-        it "finds instance variable from block definition in outer dsl scope" do
+      context 'instance variable lookup' do
+        it 'finds instance variable from block definition in outer dsl scope' do
           @iv1 = 'iv1'; outer { @iv1.should == 'iv1' }
         end
 
@@ -169,7 +169,7 @@ describe Docile do
           @iv1 = 'foo'; outer { @iv1 = 'bar' }; @iv1.should == 'bar'
         end
 
-        it "finds instance variable from block definition in inner dsl scope" do
+        it 'finds instance variable from block definition in inner dsl scope' do
           @iv2 = 'iv2'; outer { inner { @iv2.should == 'iv2' } }
         end
 
@@ -180,7 +180,7 @@ describe Docile do
 
     end
 
-    context "when DSL context object is a Dispatch pattern" do
+    context 'when DSL context object is a Dispatch pattern' do
       class DispatchScope
         def params
           { :a => 1, :b => 2, :c => 3 }
@@ -211,7 +211,7 @@ describe Docile do
         MessageDispatch.instance.dispatch(path, request)
       end
 
-      it "dispatches correctly" do
+      it 'dispatches correctly' do
         @first = @second = nil
 
         respond '/path' do |request|
@@ -246,9 +246,9 @@ describe Docile do
 
   end
 
-  describe "#dsl_eval_immutable" do
+  describe '.dsl_eval_immutable' do
 
-    context "when DSL context object is a frozen String" do
+    context 'when DSL context object is a frozen String' do
       let(:original) { "I'm immutable!".freeze }
       let!(:result) { execute_non_mutating_dsl_against_string }
 
@@ -263,12 +263,12 @@ describe Docile do
          original.should == "I'm immutable!"
       end
 
-      it "chains the commands in the block against the DSL context object" do
+      it 'chains the commands in the block against the DSL context object' do
          result.should == "!ELBATUMMI M'I"
       end
     end
 
-    context "when DSL context object is a number" do
+    context 'when DSL context object is a number' do
       let(:original) { 84.5 }
       let!(:result) { execute_non_mutating_dsl_against_number }
 
@@ -279,7 +279,7 @@ describe Docile do
         end
       end
 
-      it "chains the commands in the block against the DSL context object" do
+      it 'chains the commands in the block against the DSL context object' do
          result.should == 42
       end
     end
@@ -297,7 +297,7 @@ describe Docile::FallbackContextProxy do
 
     def create_fcp_and_set_one_instance_variable
       fcp = Docile::FallbackContextProxy.new(nil, nil)
-      fcp.instance_variable_set(:@foo, "foo")
+      fcp.instance_variable_set(:@foo, 'foo')
       fcp
     end
 
@@ -306,7 +306,7 @@ describe Docile::FallbackContextProxy do
       instance_variables.first.class
     end
 
-    it "returns proxied instance variables" do
+    it 'returns proxied instance variables' do
       subject.map(&:to_sym).should include(:@foo)
     end
 
@@ -314,7 +314,7 @@ describe Docile::FallbackContextProxy do
       subject.map(&:to_sym).should_not include(*excluded)
     end
 
-    it "preserves the type (String or Symbol) of names on this ruby version" do
+    it 'preserves the type (String or Symbol) of names on this ruby version' do
       actual_type_of_names.should == expected_type_of_names
     end
   end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: docile
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Marc Siegel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.11.0
 - !ruby/object:Gem::Dependency
@@ -123,7 +123,8 @@ files:
 - spec/docile_spec.rb
 - spec/spec_helper.rb
 homepage: http://ms-ati.github.com/docile/
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -141,10 +142,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: docile
-rubygems_version: 2.0.5
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Docile keeps your Ruby DSL's tame and well-behaved
+summary: Docile keeps your Ruby DSLs tame and well-behaved
 test_files:
 - spec/docile_spec.rb
 - spec/spec_helper.rb