docile 1.0.1 → 1.0.2

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p385@docile"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.18.8 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/HISTORY.md

@@ -0,0 +1,14 @@
+# HISTORY
+
+## [v1.0.2 (Apr 1, 2013)](http://github.com/ms-ati/docile/compare/v1.0.1...v1.0.2)
+
+  - allow passing parameters to DSL blocks (thanks @dslh!)
+
+## [v1.0.1 (Nov 29, 2012)](http://github.com/ms-ati/docile/compare/v1.0.0...v1.0.1)
+
+  - relaxed rspec and rake dependencies to allow newer versions
+  - fixes to documentation
+
+## [v1.0.0 (Oct 29, 2012)](http://github.com/ms-ati/docile/compare/1b225c8a27...v1.0.0)
+
+  - Initial Feature Set

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Marc Siegel
+Copyright (c) 2012-2013 Marc Siegel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -81,6 +81,64 @@ It's just that easy!
 
 [2]: http://stackoverflow.com/questions/328496/when-would-you-use-the-builder-pattern  "Builder Pattern"
 
+## Block parameters
+
+Parameters can be passed to the DSL block.
+
+Supposing you want to make some sort of cheap [Sinatra][3] knockoff:
+```ruby
+@last_request = nil
+respond '/path' do |request|
+  puts "Request received: #{request}"
+  @last_request = request
+end
+
+def ride bike
+  # Play with your new bike
+end
+
+respond '/new_bike' do |bike|
+  ride(bike)
+end
+```
+
+You'd put together a dispatcher something like this:
+```ruby
+require 'singleton'
+
+class DispatchScope
+  def a_method_you_can_call_from_inside_the_block
+    :useful_huh?
+  end
+end
+
+class MessageDispatch
+  include Singleton
+
+  def initialize
+    @responders = {}
+  end
+
+  def add_responder path, &block
+    @responders[path] = block
+  end
+
+  def dispatch path, request
+    Docile.dsl_eval(DispatchScope.new, request, &@responders[path])
+  end
+end
+
+def respond path, &handler
+  MessageDispatch.instance.add_responder path, handler
+end
+
+def send_request path, request
+  MessageDispatch.instance.dispatch path, request
+end
+```
+
+[3]: http://www.sinatrarb.com "Sinatra"
+
 ## Features
 
   1.  method lookup falls back from the DSL object to the block's context
@@ -102,7 +160,7 @@ Or, read the code hosted on *github.com*: [Docile Code](https://github.com/ms-at
 
 ## Status
 
-Version 1.0 works on [all ruby versions](https://github.com/ms-ati/docile/blob/master/.travis.yml).
+Version 1.0.x works on [all ruby versions since 1.8.7](https://github.com/ms-ati/docile/blob/master/.travis.yml).
 
 ## Note on Patches/Pull Requests
 
@@ -117,4 +175,4 @@ Version 1.0 works on [all ruby versions](https://github.com/ms-ati/docile/blob/m
 
 ## Copyright
 
-Copyright (c) 2012 Marc Siegel. See LICENSE for details.
+Copyright (c) 2012-2013 Marc Siegel. See LICENSE for details.

data/lib/docile.rb

@@ -15,14 +15,15 @@ module Docile
   #     #=> [1, 3]
   #
   # @param dsl   [Object] an object whose methods represent a DSL
+  # @param args  [Array]  arguments to be passed to the block
   # @param block [Proc]   a block to execute in the DSL context
   # @return      [Object] the dsl object, after execution of the block
-  def dsl_eval(dsl, &block)
+  def dsl_eval(dsl, *args, &block)
     block_context = eval("self", block.binding)
     proxy_context = FallbackContextProxy.new(dsl, block_context)
     begin
       block_context.instance_variables.each { |ivar| proxy_context.instance_variable_set(ivar, block_context.instance_variable_get(ivar)) }
-      proxy_context.instance_eval(&block)
+      proxy_context.instance_exec(*args,&block)
     ensure
       block_context.instance_variables.each { |ivar| block_context.instance_variable_set(ivar, proxy_context.instance_variable_get(ivar)) }
     end

data/lib/docile/fallback_context_proxy.rb

@@ -2,7 +2,7 @@ require 'set'
 
 module Docile
   class FallbackContextProxy
-    NON_PROXIED_METHODS = Set[:object_id, :__send__, :__id__, :==, :equal?, :"!", :"!=", :instance_eval,
+    NON_PROXIED_METHODS = Set[:object_id, :__send__, :__id__, :==, :equal?, :"!", :"!=", :instance_exec,
                               :instance_variables, :instance_variable_get, :instance_variable_set,
                               :remove_instance_variable]
 
@@ -50,4 +50,4 @@ module Docile
       end
     end
   end
-end
+end

data/lib/docile/version.rb

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

data/spec/docile_spec.rb

@@ -45,12 +45,46 @@ describe Docile do
       def inner(&block)
         Docile.dsl_eval(InnerDSL.new, &block)
       end
+
+      def inner_with_params(param,&block)
+        Docile.dsl_eval(InnerDSL.new, param, :foo, &block)
+      end
     end
 
     def outer(&block)
       Docile.dsl_eval(OuterDSL.new, &block)
     end
 
+    def parameterized(*args,&block)
+      Docile.dsl_eval(OuterDSL.new, *args, &block)
+    end
+
+    context "parameters" do
+      it "should pass parameters to the block" do
+        parameterized(1,2,3) do |x,y,z|
+          x.should == 1
+          y.should == 2
+          z.should == 3
+        end
+      end
+
+      it "should find parameters before methods" do
+        parameterized(1) { |a| a.should == 1 }
+      end
+
+      it "should find outer parameters in inner dsl scope" do
+        parameterized(1,2,3) do |a,b,c|
+          inner_with_params(c) do |d,e|
+            a.should == 1
+            b.should == 2
+            c.should == 3
+            d.should == c
+            e.should == :foo
+          end
+        end
+      end
+    end
+
     context "methods" do
       it "should find method of outer dsl in outer dsl scope" do
         outer { a.should == 'a' }
@@ -111,6 +145,65 @@ describe Docile do
       end
     end
 
+    class DispatchScope
+      def params
+        { :a => 1, :b => 2, :c => 3 }
+      end
+    end
+
+    class MessageDispatch
+      include Singleton
+
+      def initialize
+        @responders = {}
+      end
+
+      def add_responder path, &block
+        @responders[path] = block
+      end
+
+      def dispatch path, request
+        Docile.dsl_eval(DispatchScope.new, request, &@responders[path])
+      end
+    end
+
+    def respond path, &block
+      MessageDispatch.instance.add_responder path, &block
+    end
+
+    def send_request path, request
+      MessageDispatch.instance.dispatch path, request
+    end
+
+    it "should handle the dispatch pattern" do
+      @first = @second = nil
+      respond '/path' do |request|
+        @first = request
+      end
+
+      respond '/new_bike' do |bike|
+        @second = "Got a new #{bike}"
+      end
+
+      def x(y) ; "Got a #{y}"; end
+      respond '/third' do |third|
+        x(third).should == 'Got a third thing'
+      end
+
+      fourth = nil
+      respond '/params' do |arg|
+        fourth = params[arg]
+      end
+
+      send_request '/path', 1
+      send_request '/new_bike', 'ten speed'
+      send_request '/third', 'third thing'
+      send_request '/params', :b
+
+      @first.should == 1
+      @second.should == 'Got a new ten speed'
+      fourth.should == 2
+    end
   end
 
-end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'rspec'
+require 'singleton'
 
 test_dir = File.dirname(__FILE__)
 $LOAD_PATH.unshift test_dir unless $LOAD_PATH.include?(test_dir)
@@ -7,4 +8,4 @@ $LOAD_PATH.unshift test_dir unless $LOAD_PATH.include?(test_dir)
 lib_dir = File.join(File.dirname(test_dir), 'lib')
 $LOAD_PATH.unshift lib_dir unless $LOAD_PATH.include?(lib_dir)
 
-require 'docile'
+require 'docile'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docile
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-29 00:00:00.000000000 Z
+date: 2013-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -100,9 +100,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
 - .travis.yml
 - .yardopts
 - Gemfile
+- HISTORY.md
 - LICENSE
 - README.md
 - Rakefile
@@ -126,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2020809152847392489
+      hash: -106941105642538059
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,10 +137,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2020809152847392489
+      hash: -106941105642538059
 requirements: []
 rubyforge_project: docile
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Docile keeps your Ruby DSL's tame and well-behaved