concurrent-ruby 0.3.0 → 0.3.1.pre.1

data/spec/concurrent/agent_spec.rb

@@ -23,6 +23,11 @@ module Concurrent
       Agent.thread_pool = FixedThreadPool.new(1)
     end
 
+    it 'includes Dereferenceable' do
+      agent = Agent.new(10)
+      agent.should be_a(Dereferenceable)
+    end
+
     context '#initialize' do
 
       it 'sets the value to the given initial state' do
@@ -268,7 +273,7 @@ module Concurrent
       end
     end
 
-    context 'dereference' do
+    context 'Dereferenceable' do
 
       it 'defaults :dup_on_deref to false' do
         value = 'value'
@@ -362,6 +367,52 @@ module Concurrent
         agent = Agent.new(value, dup_on_deref: true, freeze_on_deref: true, copy_on_deref: copy)
         agent.value.should eq frozen
       end
+
+      it 'does not call #dup when #dup_on_deref is set and the value is nil' do
+        allow_message_expectations_on_nil
+        result = nil
+        result.should_not_receive(:dup).with(any_args())
+        agent = Agent.new(result, dup_on_deref: true)
+        agent.value
+      end
+
+      it 'does not call #freeze when #freeze_on_deref is set and the value is nil' do
+        allow_message_expectations_on_nil
+        result = nil
+        result.should_not_receive(:freeze).with(any_args())
+        agent = Agent.new(result, freeze_on_deref: true)
+        agent.value
+      end
+
+      it 'does not call the #copy_on_deref block when the value is nil' do
+        copier = proc { 42 }
+        agent = Agent.new(nil, copy_on_deref: copier)
+        agent.value.should be_nil
+      end
+
+      it 'does not lock when all options are false' do
+        agent = Agent.new(0)
+        mutex = double('mutex')
+        agent.stub(:mutex).and_return(mutex)
+        mutex.should_not_receive(:synchronize)
+        agent.value
+      end
+
+      it 'supports dereference flags with observers' do
+        result = 'result'
+        result.should_receive(:dup).and_return(result)
+        result.should_receive(:freeze).and_return(result)
+        copier = proc { result }
+
+        observer = double('observer')
+        observer.should_receive(:update).with(any_args())
+
+        agent = Agent.new(nil, dup_on_deref: true, freeze_on_deref: true, copy_on_deref: copier)
+        agent.add_observer(observer)
+
+        agent << proc { 'original result' }
+        sleep(0.1)
+      end
     end
 
     context 'observation' do

data/spec/concurrent/contract_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require_relative 'obligation_shared'
+
+module Concurrent
+
+  describe Contract do
+
+    let!(:fulfilled_value) { 10 }
+    let(:rejected_reason) { StandardError.new('Boom!') }
+
+    let(:pending_subject) do
+      @contract = Contract.new
+      Thread.new do
+        sleep(3)
+        @contract.complete(fulfilled_value, nil)
+      end
+      @contract
+    end
+
+    let(:fulfilled_subject) do
+      contract = Contract.new
+      contract.complete(fulfilled_value, nil)
+      contract
+    end
+
+    let(:rejected_subject) do
+      contract = Contract.new
+      contract.complete(nil, rejected_reason)
+      contract
+    end
+
+    it_should_behave_like :obligation
+  end
+end

data/spec/concurrent/future_spec.rb

@@ -28,7 +28,12 @@ module Concurrent
       Future.thread_pool = FixedThreadPool.new(1)
     end
 
-    it_should_behave_like Concurrent::Obligation
+    it_should_behave_like :obligation
+
+    it 'includes Dereferenceable' do
+      future = Future.new{ nil }
+      future.should be_a(Dereferenceable)
+    end
 
     context '#initialize' do
 

data/spec/concurrent/obligation_shared.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-share_examples_for Concurrent::Obligation do
+share_examples_for :obligation do
 
   context '#state' do
 

data/spec/concurrent/promise_spec.rb

@@ -29,7 +29,12 @@ module Concurrent
       Promise.thread_pool = FixedThreadPool.new(1)
     end
 
-    it_should_behave_like Concurrent::Obligation
+    it_should_behave_like :obligation
+
+    it 'includes Dereferenceable' do
+      promise = Promise.new{ nil }
+      promise.should be_a(Dereferenceable)
+    end
 
     context '#then' do
 

data/spec/concurrent/runnable_shared.rb

@@ -12,7 +12,7 @@ share_examples_for :runnable do
 
     it 'starts the (blocking) runner on the current thread when stopped' do
       @thread = Thread.new { subject.run }
-      @thread.join(1).should be_nil
+      @thread.join(0.1).should be_nil
     end
 
     it 'raises an exception when already running' do

data/spec/concurrent/scheduled_task_spec.rb

@@ -0,0 +1,259 @@
+require 'spec_helper'
+require 'timecop'
+require_relative 'obligation_shared'
+require_relative 'runnable_shared'
+
+module Concurrent
+
+  describe ScheduledTask do
+
+    context 'behavior' do
+
+      # runnable
+
+      subject { ScheduledTask.new(0.5){ nil } }
+      it_should_behave_like :runnable
+
+      # obligation
+
+      let!(:fulfilled_value) { 10 }
+      let!(:rejected_reason) { StandardError.new('mojo jojo') }
+
+      let(:pending_subject) do
+        task = ScheduledTask.new(1){ fulfilled_value }
+        task.run!
+        task
+      end
+
+      let(:fulfilled_subject) do
+        task = ScheduledTask.new(0.1){ fulfilled_value }
+        task.run
+        task
+      end
+
+      let(:rejected_subject) do
+        task = ScheduledTask.new(0.1){ raise rejected_reason }
+        task.run
+        task
+      end
+
+      it_should_behave_like :obligation
+    end
+
+    context '#initialize' do
+
+      it 'accepts a number of seconds (from now) as the shcedule time' do
+        Timecop.freeze do
+          now = Time.now
+          task = ScheduledTask.new(60){ nil }
+          task.schedule_time.to_i.should eq now.to_i + 60
+        end
+      end
+
+      it 'accepts a time object as the schedule time' do
+        schedule = Time.now + (60*10)
+        task = ScheduledTask.new(schedule){ nil }
+        task.schedule_time.should eq schedule
+      end
+
+      it 'raises an exception when seconds is less than zero' do
+        expect {
+          ScheduledTask.new(-1){ nil }
+        }.to raise_error(ArgumentError)
+      end
+
+      it 'raises an exception when schedule time is in the past' do
+        expect {
+          ScheduledTask.new(Time.now - 60){ nil }
+        }.to raise_error(ArgumentError)
+      end
+
+      it 'raises an exception when no block given' do
+        expect {
+          ScheduledTask.new(1)
+        }.to raise_error(ArgumentError)
+      end
+
+      it 'sets the initial state to :pending' do
+        task = ScheduledTask.new(1){ nil }
+        task.should be_pending
+      end
+    end
+
+    context '#cancel' do
+
+      it 'returns false if the task has already been performed' do
+        task = ScheduledTask.new(0.1){ 42 }
+        task.run!
+        sleep(0.2)
+        task.cancel.should be_false
+      end
+
+      it 'returns false if the task is already in progress' do
+        task = ScheduledTask.new(0.1){ sleep(1); 42 }
+        task.run!
+        sleep(0.2)
+        task.cancel.should be_false
+      end
+
+      it 'cancels the task if it has not yet started' do
+        @expected = true
+        task = ScheduledTask.new(0.3){ @expected = false }
+        task.run!
+        sleep(0.1)
+        task.cancel
+        sleep(0.5)
+        @expected.should be_true
+      end
+
+      it 'returns true on success' do
+        task = ScheduledTask.new(0.3){ @expected = false }
+        task.run!
+        sleep(0.1)
+        task.cancel.should be_true
+      end
+
+      it 'sets the state to :cancelled when cancelled' do
+        task = ScheduledTask.new(10){ 42 }
+        task.run!
+        sleep(0.1)
+        task.cancel
+        task.should be_cancelled
+      end
+
+      it 'stops the runnable' do
+        task = ScheduledTask.new(0.2){ 42 }
+        task.run!
+        sleep(0.1)
+        task.cancel
+        sleep(0.2)
+        task.should_not be_running
+      end
+    end
+
+    context 'execution' do
+
+      it 'sets the state to :in_progress when the task is running' do
+        task = ScheduledTask.new(0.1){ sleep(1); 42 }
+        task.run!
+        sleep(0.2)
+        task.should be_in_progress
+      end
+
+      it 'stops itself on task completion' do
+        task = ScheduledTask.new(0.1){ 42 }
+        task.run!
+        sleep(0.2)
+        task.should_not be_running
+      end
+    end
+
+    context 'observation' do
+
+      let(:clazz) do
+        Class.new do
+          attr_reader :value
+          attr_reader :reason
+          attr_reader :count
+          define_method(:update) do |time, value, reason|
+            @count = @count.to_i + 1
+            @value = value
+            @reason = reason
+          end
+        end
+      end
+
+      let(:observer) { clazz.new }
+
+      it 'returns true for an observer added while :pending' do
+        task = ScheduledTask.new(1){ 42 }
+        task.run!
+        task.add_observer(observer).should be_true
+      end
+
+      it 'returns true for an observer added while :in_progress' do
+        task = ScheduledTask.new(0.1){ sleep(1); 42 }
+        task.run!
+        sleep(0.2)
+        task.add_observer(observer).should be_true
+      end
+
+      it 'returns true for an observer added while not running' do
+        task = ScheduledTask.new(1){ 42 }
+        task.add_observer(observer).should be_true
+      end
+
+      it 'returns false for an observer added once :cancelled' do
+        task = ScheduledTask.new(1){ 42 }
+        task.run!
+        sleep(0.1)
+        task.cancel
+        sleep(0.1)
+        task.add_observer(observer).should be_false
+      end
+
+      it 'returns false for an observer added once :fulfilled' do
+        task = ScheduledTask.new(0.1){ 42 }
+        task.run!
+        sleep(0.2)
+        task.add_observer(observer).should be_false
+      end
+
+      it 'returns false for an observer added once :rejected' do
+        task = ScheduledTask.new(0.1){ raise StandardError }
+        task.run!
+        sleep(0.2)
+        task.add_observer(observer).should be_false
+      end
+
+      it 'notifies all observers on fulfillment' do
+        task = ScheduledTask.new(0.1){ 42 }
+        task.add_observer(observer)
+        task.run!
+        sleep(0.2)
+        task.value.should == 42
+        task.reason.should be_nil
+        observer.value.should == 42
+        observer.reason.should be_nil
+      end
+
+      it 'notifies all observers on rejection' do
+        task = ScheduledTask.new(0.1){ raise StandardError }
+        task.add_observer(observer)
+        task.run!
+        sleep(0.2)
+        task.value.should be_nil
+        task.reason.should be_a(StandardError)
+        observer.value.should be_nil
+        observer.reason.should be_a(StandardError)
+      end
+
+      it 'does not notify an observer added after fulfillment' do
+        observer.should_not_receive(:update).with(any_args())
+        task = ScheduledTask.new(0.1){ 42 }
+        sleep(0.2)
+        task.add_observer(observer)
+        sleep(0.1)
+      end
+
+      it 'does not notify an observer added after rejection' do
+        observer.should_not_receive(:update).with(any_args())
+        task = ScheduledTask.new(0.1){ raise StandardError }
+        sleep(0.2)
+        task.add_observer(observer)
+        sleep(0.1)
+      end
+
+      it 'does not notify an observer added after cancellation' do
+        observer.should_not_receive(:update).with(any_args())
+        task = ScheduledTask.new(0.5){ 42 }
+        task.run!
+        sleep(0.1)
+        task.cancel
+        sleep(0.1)
+        task.add_observer(observer)
+        sleep(0.5)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concurrent-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1.pre.1
 platform: ruby
 authors:
 - Jerry D'Antonio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-17 00:00:00.000000000 Z
+date: 2013-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -40,6 +40,8 @@ files:
 - lib/concurrent/agent.rb
 - lib/concurrent/cached_thread_pool/worker.rb
 - lib/concurrent/cached_thread_pool.rb
+- lib/concurrent/contract.rb
+- lib/concurrent/dereferenceable.rb
 - lib/concurrent/event.rb
 - lib/concurrent/event_machine_defer_proxy.rb
 - lib/concurrent/fixed_thread_pool/worker.rb
@@ -50,24 +52,28 @@ files:
 - lib/concurrent/obligation.rb
 - lib/concurrent/promise.rb
 - lib/concurrent/runnable.rb
+- lib/concurrent/scheduled_task.rb
 - lib/concurrent/supervisor.rb
 - lib/concurrent/timer_task.rb
 - lib/concurrent/utilities.rb
 - lib/concurrent/version.rb
 - lib/concurrent.rb
 - lib/concurrent_ruby.rb
+- md/actor.md
 - md/agent.md
 - md/event.md
 - md/future.md
 - md/goroutine.md
 - md/obligation.md
 - md/promise.md
+- md/scheduled_task.md
 - md/supervisor.md
 - md/thread_pool.md
 - md/timer_task.md
 - spec/concurrent/actor_spec.rb
 - spec/concurrent/agent_spec.rb
 - spec/concurrent/cached_thread_pool_spec.rb
+- spec/concurrent/contract_spec.rb
 - spec/concurrent/event_machine_defer_proxy_spec.rb
 - spec/concurrent/event_spec.rb
 - spec/concurrent/fixed_thread_pool_spec.rb
@@ -78,6 +84,7 @@ files:
 - spec/concurrent/promise_spec.rb
 - spec/concurrent/runnable_shared.rb
 - spec/concurrent/runnable_spec.rb
+- spec/concurrent/scheduled_task_spec.rb
 - spec/concurrent/supervisor_spec.rb
 - spec/concurrent/thread_pool_shared.rb
 - spec/concurrent/timer_task_spec.rb
@@ -103,12 +110,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Modern concurrency tools including agents, futures, promises, thread pools,
@@ -117,6 +124,7 @@ test_files:
 - spec/concurrent/actor_spec.rb
 - spec/concurrent/agent_spec.rb
 - spec/concurrent/cached_thread_pool_spec.rb
+- spec/concurrent/contract_spec.rb
 - spec/concurrent/event_machine_defer_proxy_spec.rb
 - spec/concurrent/event_spec.rb
 - spec/concurrent/fixed_thread_pool_spec.rb
@@ -127,6 +135,7 @@ test_files:
 - spec/concurrent/promise_spec.rb
 - spec/concurrent/runnable_shared.rb
 - spec/concurrent/runnable_spec.rb
+- spec/concurrent/scheduled_task_spec.rb
 - spec/concurrent/supervisor_spec.rb
 - spec/concurrent/thread_pool_shared.rb
 - spec/concurrent/timer_task_spec.rb