future-resource 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fada9a3ae4b808ac35ff57eeb6457279379f107a
+  data.tar.gz: 743d6407f87f5cb6cc457d9a71e294e0ac4ae328
+SHA512:
+  metadata.gz: a07de1b6a90bc493d5a266ace5216c77032a5a9b76073e262a104b01b689bdf6b6fb772018c997fa0c38c60982d1484aa387a3ac361933698e634074ecff0cec
+  data.tar.gz: 9575c571273ccc28f9fa6e5508c5ab5128825911c4c9e1ce64be83553d4252fb1aed1d6097079751086dadb162f4f973c8873ed9c5457f4576256dcd13a42033

data/.travis.yml

@@ -2,8 +2,8 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
-  - jruby-19mode # JRuby in 1.9 mode
-  - rbx-19mode # currently in active development, may or may not work for your project
+  - rbx-19mode
+  - jruby-19mode
   - ruby-head
 notifications:
   irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # develop
 
+# 1.1.0 - 2013-07-05
+  * Feature: Allow setting an alternative condition to permit use of Celluloid::Condition in place of ConditionVariable
+  * Feature: Allow termination of resources, which raises an exception on reads
+
 # 1.0.0 - 2012-03-13
   * Feature: Better testing and documentation
 

data/Gemfile

@@ -1,4 +1,3 @@
-source :rubygems
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in future-resource.gemspec
 gemspec

data/Guardfile

@@ -1,4 +1,4 @@
-guard 'rspec', :version => 2, :cli => '--format documentation' do
+guard 'rspec', :cli => '--format documentation' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec/" }

data/lib/future-resource.rb

@@ -23,11 +23,12 @@ class FutureResource
   ##
   # Create a new FutureResource.
   #
-  def initialize
+  def initialize(blocker = nil)
     @resource_lock          = Monitor.new
-    @resource_value_blocker = @resource_lock.new_cond
+    @resource_value_blocker = blocker || @resource_lock.new_cond
+    @terminated             = false
   end
-  
+
   ##
   # Checks if the value of the resource placeholder has been set yet.
   #
@@ -38,37 +39,62 @@ class FutureResource
   end
 
   ##
-  # Returns the value of a specific resource, optionally waiting for `timeout` seconds before raising a Timeout::Error exception.
-  # When called on a not set resource without a timeout, raises a deadlock.
+  # Checks if the attempt to read the resource has been terminated.
+  #
+  # @return [Boolean]
+  #
+  def terminated?
+    !!@resource_lock.synchronize { @terminated }
+  end
+
+  ##
+  # Returns the value of a specific resource, optionally waiting for `timeout` seconds before
+  # raising a Timeout::Error exception, or raising a FutureResource::Terminated exception if
+  # the attempt to read the resource is terminated early by another thread.  When called on
+  # an unset resource without a timeout, raises a deadlock.
   #
   # @param [Integer] timeout number of seconds to wait for the resource to become ready
   #
   # @raise [Timeout::Error] if timeout expires and resource is not ready
+  # @raise [FutureResource::Terminated] if the attempt to read the resource is terminated by another thread
   #
   # @return [Object]
   #
   def resource(timeout = nil)
     Timeout::timeout timeout do
       @resource_lock.synchronize do
-        @resource_value_blocker.wait unless defined? @resource
+        @resource_value_blocker.wait unless set_yet? or terminated?
+        raise Terminated if terminated?
         @resource
       end
     end
   end
-  
+
   ##
   # Sets the value for the resource, making it available for all waiting and following reads.
-  # Resourcs values can only be set once.
+  # Resource values can only be set once.  Calling this method on a terminated resource is
+  # ineffective.
   #
   # @param [Object] resource any value to be set for the resource
   #
   # @raise [FutureResource::ResourceAlreadySet] if resource is already set
+  #
   def resource=(resource)
-    @resource_lock.synchronize do
-      raise ResourceAlreadySetException if defined? @resource
+    set_or_terminate do
       @resource = resource
-      @resource_value_blocker.broadcast
-      @resource_value_blocker = nil # Don't really need it anymore.
+    end
+  end
+
+  ##
+  # Terminates the attempt to read the resource early, causing those waiting and any
+  # following reads to raise a FutureResource::Terminated exception. Subsequently calling
+  # this method again is ineffective.
+  #
+  # @raise [FutureResource::ResourceAlreadySet] if resource is already set
+  #
+  def terminate
+    set_or_terminate do
+      @terminated = true
     end
   end
 
@@ -80,4 +106,25 @@ class FutureResource
       super "Cannot set this resource twice!"
     end
   end
+
+  ##
+  # Raised when the attempt to read the resource is terminated early.
+  #
+  class Terminated < StandardError
+    def initialize
+      super "Resource read attempt terminated"
+    end
+  end
+
+  private
+
+  def set_or_terminate
+    @resource_lock.synchronize do
+      return if terminated?
+      raise ResourceAlreadySetException if set_yet?
+      yield
+      @resource_value_blocker.broadcast
+      @resource_value_blocker = nil # Don't really need it anymore.
+    end
+  end
 end

data/lib/future-resource/version.rb

@@ -1,3 +1,3 @@
 class FutureResource
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/future-resource_spec.rb

@@ -4,15 +4,21 @@ describe FutureResource do
   it { should be_instance_of FutureResource }
 
   it { should_not be_set_yet }
+  it { should_not be_terminated }
 
   it "should set resource" do
     subject.resource = :foo
   end
 
+  it "should be terminateable" do
+    subject.terminate
+  end
+
   describe "with a resource set" do
     before { subject.resource = :foo }
 
     it { should be_set_yet }
+    it { should_not be_terminated }
 
     its(:resource) { should === :foo }
 
@@ -21,6 +27,37 @@ describe FutureResource do
         subject.resource = :bar
       }.to raise_error FutureResource::ResourceAlreadySetException
     end
+
+    it "should raise ResourceAlreadySetException when terminating" do
+      expect {
+        subject.terminate
+      }.to raise_error FutureResource::ResourceAlreadySetException
+    end
+  end
+
+  describe "that is terminated" do
+    before { subject.terminate }
+
+    it { should_not be_set_yet }
+    it { should be_terminated }
+
+    it "should raise a Terminated exception when getting the resource" do
+      expect {
+        subject.resource
+      }.to raise_error FutureResource::Terminated
+    end
+
+    it "should ignore any attempt to set the resource" do
+      subject.resource = :bar
+
+      expect {
+        subject.resource
+      }.to raise_error FutureResource::Terminated
+    end
+
+    it "should ignore any attempt to terminate again" do
+      subject.terminate
+    end
   end
 
   it "should receive the resource value from another thread" do
@@ -30,4 +67,13 @@ describe FutureResource do
     end
     subject.resource.should === :foo
   end
+
+  it "should allow an alternative condition to be provided" do
+    resource = described_class.new(ConditionVariable.new)
+    Thread.new do
+      sleep 1
+      subject.resource = :foo
+    end
+    subject.resource.should === :foo
+  end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: future-resource
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Jay Phillips
@@ -10,74 +9,92 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-13 00:00:00.000000000 Z
+date: 2013-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2164502240 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2164502240
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2164501200 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *2164501200
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2164500260 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2164500260
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.3
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2164499560 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *2164499560
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2164499040 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164499040
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2164514760 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164514760
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Sometimes a value is set asynchronously and you need to wait until it
   appears. Easy!
 email:
@@ -101,27 +118,26 @@ files:
 - spec/future-resource_spec.rb
 homepage: https://github.com/adhearsion/future-resource
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: future-resource
-rubygems_version: 1.8.10
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Wait on resources being set in the future
 test_files:
 - spec/future-resource_spec.rb