with_statement 0.1.1 → 0.2.0

data/README.rdoc

@@ -5,22 +5,46 @@ with statement.
 
 Simple usage:
 
-  with expression do |resource|
-    # ... interact with resource ...
-  end
+    with expression do |resource|
+      # ... interact with resource ...
+    end
 
-The expression passed must return a context manager. A context manager
-is an object which implements two methods: +acquire+ and
-+release+. When Kernel#with receives the context manager it calls its
-+acquire+ method and grab the result. Then it yields the result to the
-block. When the block returns, the context manager send the +release+
-message to the context manager.
+The expression must return a context manager. A context manager is an
+object which implements two methods: +acquire+ and +release+. When
+Kernel#with receives the context manager it calls its +acquire+ method
+and grab the result. Then it yields the result to the block. When the
+block returns, the context manager send the +release+ message to the
+context manager.
 
 Kernel#with by itself does not attempt to run +acquire+ or +release+
 atomically; the context manager should ensure that if required.
 
+Since 0.2.0 release you can put several context managers in a single
+with sentence:
+
+    with exp1, exp2 do |r1, r2|
+      # do something with the acquired resources
+    end
+
+That sentence it's semantically equivalent to:
+
+    with exp1 do |r1|
+      with exp2 do }r2|
+        # do something with the acquired resources
+      end
+    end
+
+The general syntax for the Kernel#with method is:
+
+    with(*managers){|*resources|
+      #code
+    }
+
+If any of the context managers fails to enter (acquire), the block is
+never executed and any previous acquired resource is released.
+
 == Contributing to with_statement
- 
+
 * Check out the latest master to make sure the feature hasn't been
   implemented or the bug hasn't been fixed yet
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/with_statement.rb

@@ -3,7 +3,23 @@ module Kernel
   # Similar to Python's with statement. This statement enters the
   # context of an object +resource+, executes the block, and exits the
   # context.
-  def with(resource)
+  def with(*resources, &block)
+    raise SyntaxError, 'with statement called with no arguments' if resources.size == 0
+    if resources.size == 1
+      simple_with(resources.shift, &block)
+    else
+      simple_with(resources.shift) do |what|
+        with(*resources) {|*rs|
+          args = [what] + rs
+          block.call(*args)
+        }
+      end
+    end
+  end
+
+  private
+
+  def simple_with(resource, &block)
     what = resource.acquire
     begin
       yield(what)
@@ -12,4 +28,3 @@ module Kernel
     end
   end
 end
-

data/test/test_with_statement.rb

@@ -2,6 +2,8 @@ require 'helper'
 
 class TestWithStatement < Test::Unit::TestCase
   context "A simple non-reentrant resource class" do
+    class ResourceException < Exception; end
+
     class Resource
       attr_reader :locked
 
@@ -10,13 +12,13 @@ class TestWithStatement < Test::Unit::TestCase
       end
 
       def acquire
-        raise Exception.new "Already acquired" if @locked
+        raise ResourceException.new "Already acquired" if @locked
         @locked = true
         self
       end
 
       def release
-        raise Exception.new "Not acquired" unless @locked
+        raise ResourceException.new "Not acquired" unless @locked
         @locked = false
       end
 
@@ -25,20 +27,37 @@ class TestWithStatement < Test::Unit::TestCase
       end
     end
 
+    class LockedResource < Resource
+      def initialize
+        super
+        @locked = true
+      end
+    end
+
+    class WeirdException < Exception; end
+
     setup do
       @resource = Resource.new
+      @inner = Resource.new
+      @locked = LockedResource.new
     end
 
     should "be locked within with statement, and release outside it" do
-      with @resource do 
+      with @resource do
         assert @resource.locked
       end
       assert !@resource.locked
     end
 
+    should 'raise an exception on a locked resource' do
+      assert_raise ResourceException do
+        with @locked do; end
+      end
+    end
+
     should "raise an exception when double locked" do
       with @resource do
-        assert_raise Exception do 
+        assert_raise ResourceException do
           with @resource do; end
         end
       end
@@ -50,5 +69,49 @@ class TestWithStatement < Test::Unit::TestCase
         assert what.do_something
       end
     end
+
+    should "allow nested withs" do
+      with @resource do |a|
+        with @inner do |b|
+          assert @resource.locked
+          assert @inner.locked
+        end
+        assert @resource.locked
+        assert !@inner.locked
+      end
+    end
+
+    should "allow multiple context managers" do
+      with @resource, @inner do |a, b, *others|
+        assert a == @resource
+        assert b == @inner
+        assert others == [], 'no more resources'
+        assert @resource.locked
+        assert @inner.locked
+      end
+      assert !@resource.locked
+      assert !@inner.locked
+    end
+
+    should 'release the first resource if the second fails to enter' do
+      assert_raise ResourceException do
+        with @resource, @locked do
+          raise StandardError, 'This exception should not be raised; because this code should never be called'
+        end
+      end
+      assert !@resource.locked
+    end
+
+    should 'raise a SyntaxError when no context managers are given' do
+      assert_raise SyntaxError do
+        with {}
+      end
+    end
+
+    should 'raise an exception if no block is given' do
+      assert_raise LocalJumpError do
+        with @resource
+      end
+    end
   end
 end

data/with_statement.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{with_statement}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Manuel V\303\241zquez Acosta"]
-  s.date = %q{2010-12-06}
+  s.date = %q{2011-01-02}
   s.description = %q{With statements opens the Kernel and defines a with method which behaves similar to Python with statement}
   s.email = %q{mva.led@gmail.com}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: with_statement
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Manuel V\xC3\xA1zquez Acosta"
@@ -15,12 +15,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-06 00:00:00 -05:00
+date: 2011-01-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
   name: shoulda
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -29,12 +31,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
-  type: :development
-  version_requirements: *id001
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
   name: bundler
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -45,12 +47,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  prerelease: false
-  type: :development
-  version_requirements: *id002
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
   name: jeweler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -61,12 +63,12 @@ dependencies:
         - 5
         - 1
         version: 1.5.1
-  prerelease: false
-  type: :development
-  version_requirements: *id003
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
   name: rcov
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -75,9 +77,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
-  type: :development
-  version_requirements: *id004
+  requirement: *id004
 description: With statements opens the Kernel and defines a with method which behaves similar to Python with statement
 email: mva.led@gmail.com
 executables: []