future_proof 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15ccb48d47e099121a7d5f7244f78df5e3a9ac5a
+  data.tar.gz: a54c4d62b82764b907c03fb3882f2acb2fa194a8
+SHA512:
+  metadata.gz: 3994b096ae89e3cfe08f0a7358ee336ca38606b161ae8b5ffd8232ccb0b8e0efc75e53fa0aa85952be798f6da6b2fd4771e8f021b5fa9a134e0f6f2f9300e23b
+  data.tar.gz: a2d931e05870443e7a741df982193d8499eaeae9fffc04f6641cef25fec39067f5d4807e94289743e9946dcfd31667a10e9de2a10a52e09e13c588cfd421398d

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0
   - rbx-19mode
 script: bundle exec rspec spec

data/README.md

@@ -22,23 +22,31 @@ Or install it yourself as:
 
 ### Future
 
-    f = FutureProof::Future.new { |a, b| a + b }
+    future = FutureProof::Future.new { |a, b| a + b }
 
-    f.call(1, 2) # => executing in a thread
+    future.call(1, 2) # => executes in a thread
 
-    f.value # => returning value when ready
+    future.value # => returns value when ready
 
 ### ThreadPool
 
-    tp = FutureProof::ThreadPool.new(5)
+    thread_pool = FutureProof::ThreadPool.new(5)
 
     10.times do |i|
-      tp.submit(Proc.new { |a, b| a + b }, i, i + 1)
+      thread_pool.submit i, i + 1 do |a, b|
+        a + b
+      end
     end
 
-    tp.perform # executing 10 procs in 5 threads
+    thread_pool.perform # executes 10 procs in 5 threads
 
-    tp.values # releasing threads and returning values
+    thread_pool.values # releases threads and returns values
+
+## Exceptions
+
+  If exception happens inside a thread it doesn't affect the whole process.
+  Exception is raised when accessing specific value:
+      thread_pool.values[3] # => raises exception
 
 ## Contributing
 

data/lib/future_proof/exceptionable.rb

@@ -0,0 +1,10 @@
+module FutureProof
+  module Exceptionable
+
+  private
+
+    def raise_or_value(value)
+      value.is_a?(StandardError) ? raise(value) : value
+    end
+  end
+end

data/lib/future_proof/future.rb

@@ -1,23 +1,25 @@
-class FutureProof::Future
-  def initialize(&block)
-    @block = block
-  end
+module FutureProof
+  class Future
+    def initialize(&block)
+      @block = block
+    end
 
-  def call(*args)
-    thread(*args)
-  end
+    def call(*args)
+      thread(*args)
+    end
 
-  def value(*args)
-    thread(*args).value
-  end
+    def value(*args)
+      thread(*args).value
+    end
 
-  def complete?
-    !thread.alive?
-  end
+    def complete?
+      !thread.alive?
+    end
 
-private
+  private
 
-  def thread(*args)
-    @thread ||= Thread.new { @block.call *args }
+    def thread(*args)
+      @thread ||= Thread.new { @block.call *args }
+    end
   end
-end
+end

data/lib/future_proof/future_array.rb

@@ -0,0 +1,28 @@
+module FutureProof
+  class FutureArray
+    include Enumerable
+    include FutureProof::Exceptionable
+
+    def initialize(arg)
+      @arry = Array.new arg
+    end
+
+    def [](index)
+      raise_or_value @arry[index]
+    end
+
+    def all
+      map { |a| a }
+    end
+
+    [:first, :last, :empty?].each do |method|
+      define_method method do |*args, &block|
+        raise_or_value @arry.send(method, *args, &block)
+      end
+    end
+
+    def each
+      @arry.each { |a| yield raise_or_value(a) }
+    end
+  end
+end

data/lib/future_proof/future_proof_exception.rb

@@ -0,0 +1,3 @@
+module FutureProof
+  class FutureProofException < Exception; end
+end

data/lib/future_proof/future_queue.rb

@@ -0,0 +1,59 @@
+module FutureProof
+  class FutureQueue < Queue
+
+    include FutureProof::Exceptionable
+
+    def initialize
+      @finished = false
+      super()
+    end
+
+    def push(*values, &block)
+      raise_future_proof_exception if finished?
+      value = if block_given?
+        begin
+          block.call(*values)
+        rescue => e
+          e
+        end
+      else
+        values.size == 1 ? values[0] : values
+      end
+      super(value)
+    end
+
+    def pop
+      raise_future_proof_exception if finished?
+      raise_or_value super
+    end
+
+    def values
+      raise_future_proof_exception unless finished?
+      @values ||= FutureProof::FutureArray.new(instance_variable_get(:@que).dup)
+    end
+
+    def [](index)
+      raise_future_proof_exception unless finished?
+      values[index]
+    end
+
+    def stop!
+      @finished = true
+    end
+
+    def start!
+      @values   = nil
+      @finished = false
+    end
+
+  private
+
+    def finished?
+      @finished
+    end
+
+    def raise_future_proof_exception
+      raise FutureProof::FutureProofException.new 'Queu is not accessible in the state given!'
+    end
+  end
+end

data/lib/future_proof/thread_pool.rb

@@ -1,58 +1,57 @@
 require 'thread'
 
-class FutureProof::ThreadPool
-  def initialize(size)
-    @size    = size
-    @threads = []
-    @queue   = Queue.new
-    @values  = Queue.new
-  end
+module FutureProof
+  class ThreadPool
+    def initialize(size)
+      @size    = size
+      @threads = []
+      @queue   = Queue.new
+      @values  = FutureProof::FutureQueue.new
+    end
 
-  def submit(job, *args)
-    @queue.push [job, args]
-  end
+    def submit(*args, &block)
+      @queue.push [block, args]
+    end
 
-  def perform
-    unless @threads.any? { |t| t.alive? }
-      @size.times do
-        @threads << Thread.new do
-          while job = @queue.pop
-            if job == :END_OF_WORK
-              break
-            else
-              result = begin
-                job[0].call(*job[1])
-              rescue => e
-                e.to_s
+    def perform
+      unless @threads.any? { |t| t.alive? }
+        @values.start!
+        @size.times do
+          @threads << Thread.new do
+            while job = @queue.pop
+              if job == :END_OF_WORK
+                break
+              else
+                @values.push *job[1], &job[0]
               end
-              @values.push result
             end
           end
         end
       end
     end
-  end
 
-  def finalize
-    @size.times { @queue.push :END_OF_WORK }
-  end
+    def finalize
+      @size.times { @queue.push :END_OF_WORK }
+    end
 
-  def wait
-    finalize
-    @threads.map &:join
-  end
+    def wait
+      finalize
+      @threads.map &:join
+    end
 
-  def values
-    wait
-    @values.instance_variable_get(:@que)
-  end
+    def values
+      wait
+      @values.stop!
+      @values.values
+    end
 
-  def finalize
-    @size.times { @queue.push :END_OF_WORK }
-  end
+    def finalize
+      @size.times { @queue.push :END_OF_WORK }
+    end
 
-  def finalize!
-    @queue.clear
-    finalize
+    def finalize!
+      @queue.clear
+      finalize
+    end
   end
-end
+end

data/lib/future_proof/version.rb

@@ -1,3 +1,3 @@
 module FutureProof
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/future_proof.rb

@@ -1,3 +1,7 @@
 require 'future_proof/version'
+require 'future_proof/exceptionable'
 require 'future_proof/future'
-require 'future_proof/thread_pool'
+require 'future_proof/thread_pool'
+require 'future_proof/future_queue'
+require 'future_proof/future_array'
+require 'future_proof/future_proof_exception'

data/spec/future_proof/exceptionable_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe FutureProof::Exceptionable do
+  let(:exceptionable) do
+    class TestExceptionable
+      include FutureProof::Exceptionable
+    end
+    TestExceptionable.new
+  end
+
+  context 'without exception' do
+    it 'should return value' do
+      exceptionable.send(:raise_or_value, 25).should eq 25
+    end
+  end
+
+  context 'with exception' do
+   it 'should raise error' do
+      expect {
+        exceptionable.send(:raise_or_value, ZeroDivisionError.new)
+      }.to raise_error(ZeroDivisionError)
+    end
+  end
+end

data/spec/future_proof/future_array_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe FutureProof::FutureArray do
+  let(:future_array) do
+    FutureProof::FutureArray.new [1, 2, 3, 4, 5]
+  end
+
+  let(:future_array_with_exception) do
+    FutureProof::FutureArray.new [1, 2, 3, 4, ZeroDivisionError.new]
+  end
+
+  describe '#[]' do
+    context 'without exception' do
+      it 'should retrun value' do
+        future_array[4].should eq 5
+      end
+    end
+
+    context 'with_exception' do
+      it 'should raise exception' do
+        expect { future_array_with_exception[4] }.to raise_error(ZeroDivisionError)
+      end      
+    end
+  end
+
+  describe '#last' do
+    context 'without exception' do
+      it 'should retrun value' do
+        future_array.last.should eq 5
+      end
+    end
+
+    context 'with_exception' do
+      it 'should raise exception' do
+        expect { future_array_with_exception.last }.to raise_error(ZeroDivisionError)
+      end      
+    end
+  end
+
+  describe '#select' do
+    context 'without exception' do
+      it 'should select value' do
+        future_array.select { |e| e.even? }.should eq [2, 4]
+      end
+    end
+
+    context 'with_exception' do
+      it 'should raise exception' do
+        expect { future_array_with_exception.select { |e| e.even? } }.to raise_error(ZeroDivisionError)
+      end
+    end
+  end
+end

data/spec/future_proof/future_queu_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+
+describe FutureProof::FutureQueue do
+  let(:future_queue) { FutureProof::FutureQueue.new }
+
+  describe '#push' do
+    context 'running' do
+      context 'without exception' do
+        it 'should push' do
+          expect {
+            future_queue.push 24, 2 do |a, b|
+              a / b
+            end
+          }.not_to raise_error
+        end
+      end
+
+      context 'with exception' do
+        it 'should push' do
+          expect {
+            future_queue.push 24, 0 do |a, b|
+              a / b
+            end
+          }.not_to raise_error
+        end
+      end
+    end
+
+    context 'stoped' do
+      before { future_queue.stop! }
+      it 'should not push' do
+        expect { future_queue.push 5 }.to raise_error(FutureProof::FutureProofException)
+      end
+    end
+  end
+
+  describe '#pop' do
+    context 'running' do
+      context 'without exception' do
+        before { future_queue.push 77 }
+        it 'should pop value' do
+          future_queue.pop.should eq 77
+        end
+      end
+
+      context 'with exception' do
+        before { future_queue.push ZeroDivisionError.new }
+        it 'should raise error' do
+          expect { future_queue.pop }.to raise_error(ZeroDivisionError)
+        end
+      end
+    end
+
+    context 'stoped' do
+      before { future_queue.stop! }
+      it 'should raise error' do
+        expect { future_queue.pop }.to raise_error(FutureProof::FutureProofException)
+      end
+    end
+  end
+
+  describe '#values' do
+    context 'stoped' do
+      before { future_queue.stop! }
+      it 'should return instance of FutureArray' do
+        future_queue.values.should be_instance_of FutureProof::FutureArray
+      end
+    end
+
+    context 'running' do
+      it 'should not allow get values' do
+        expect { future_queue.values }.to raise_error(FutureProof::FutureProofException)
+      end
+    end
+  end
+
+  describe '#[]' do
+    context 'stoped' do
+      context 'single value' do
+        before do
+          future_queue.push 25
+          future_queue.stop!
+        end
+
+        it 'should return value' do
+          future_queue[0].should eq 25
+        end
+      end
+
+      context 'multiple values' do
+        before do
+          future_queue.push 25, 34
+          future_queue.stop!
+        end
+
+        it 'should return value' do
+          future_queue[0].should eq [25, 34]
+        end
+      end
+
+      context 'exception' do
+        before do
+          future_queue.push ZeroDivisionError.new
+          future_queue.stop!
+        end
+
+        it 'should raise exception' do
+          expect { future_queue[0] }.to raise_error(ZeroDivisionError)
+        end
+      end
+
+    end
+
+    context 'running' do
+      it 'should not allow acess value' do
+        expect { future_queue[0] }.to raise_error(FutureProof::FutureProofException)
+      end
+    end
+  end
+
+  describe '#stop and #start' do
+    it 'should allow stop and run queue multiple times' do
+      future_queue.push 1
+      future_queue.push 2
+      future_queue.push 3
+
+      future_queue.stop!
+
+      array_id = future_queue.values.object_id
+
+      array_id.should eq future_queue.values.object_id
+
+      future_queue.start!      
+
+      future_queue.push 4
+      future_queue.push 5
+      future_queue.push 6
+
+      future_queue.pop.should eq 1
+      future_queue.pop.should eq 2
+      future_queue.pop.should eq 3
+      
+      future_queue.stop!
+
+      array_id.should_not eq future_queue.values.object_id
+
+      future_queue.start!
+
+      future_queue.pop.should eq 4
+      future_queue.pop.should eq 5
+      future_queue.pop.should eq 6
+    end
+  end
+end

data/spec/future_proof/thread_pool_spec.rb

@@ -7,7 +7,7 @@ describe FutureProof::ThreadPool do
   let(:thread_pool) { FutureProof::ThreadPool.new pool_size }
 
   describe '#submit' do
-    before { thread_pool.submit(task, 24, 2) }
+    before { thread_pool.submit(24, 2, &task) }
 
     it 'task should be submitted to queue' do
       thread_pool.instance_variable_get(:@queue).size.should eq 1
@@ -27,13 +27,13 @@ describe FutureProof::ThreadPool do
       describe 'first task' do
         it 'should start executing' do
           thread_pool.finalize
-          thread_pool.values.should eq [12]
+          thread_pool.values.all.should eq [12]
         end
       end
 
       describe 'rest tasks' do
         it 'should start executing on #submit' do
-          thread_pool.submit task, 6, 3
+          thread_pool.submit 6, 3, &task
           sleep 3
           thread_pool.instance_variable_get(:@values).instance_variable_get(:@que).size.should eq 2
         end
@@ -43,34 +43,46 @@ describe FutureProof::ThreadPool do
 
   describe '#finalize' do
     it 'should allow all tasks to finish' do
-      5.times { thread_pool.submit(task, 24, 2) }
+      5.times { thread_pool.submit(24, 2, &task) }
       thread_pool.finalize
       thread_pool.perform
-      thread_pool.values.should eq [12, 12, 12, 12, 12]
+      thread_pool.values.all.should eq [12, 12, 12, 12, 12]
     end
-  end
 
+    it 'should allow to restart pool' do
+      thread_pool.submit(24, 2, &task)
+      thread_pool.perform
+      thread_pool.values.count.should eq 1
+      thread_pool.submit(24, 2, &task)
+      thread_pool.values.count.should eq 1
+      thread_pool.perform
+      thread_pool.values.count.should eq 2
+    end
+  end
 
   describe '#finalize!' do
     it 'should not start executing not started tasks' do
-      5.times { thread_pool.submit(task, 24, 2) }
+      5.times { thread_pool.submit(24, 2, &task) }
       thread_pool.perform
       sleep 0.5
       thread_pool.finalize!
-      thread_pool.values.should eq [12, 12, 12]
+      thread_pool.values.all.should eq [12, 12, 12]
     end
   end
 
   describe 'exceptions' do
-    before { thread_pool.submit(task, 24, 0) }
+    before { thread_pool.submit(24, 0, &task) }
 
-    it 'should not raise exceptions' do
-      expect { thread_pool.perform; thread_pool.wait }.not_to raise_error
+    context 'without asking for specific value' do
+      it 'should not raise exceptions' do
+        expect { thread_pool.perform; thread_pool.wait }.not_to raise_error
+      end
     end
 
-    it 'should return name of an exception' do
-      thread_pool.perform
-      thread_pool.values.should eq ['divided by 0']
+    context 'with asking for specific value' do
+      it 'should raise an exception' do
+        expect { thread_pool.perform; thread_pool.values[0] }.to raise_error(ZeroDivisionError)
+      end
     end
   end
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: future_proof
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Nikita Cernovs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-04 00:00:00.000000000 Z
+date: 2013-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,33 +27,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby concurrency extenstions
@@ -74,38 +67,47 @@ files:
 - Rakefile
 - future_proof.gemspec
 - lib/future_proof.rb
+- lib/future_proof/exceptionable.rb
 - lib/future_proof/future.rb
+- lib/future_proof/future_array.rb
+- lib/future_proof/future_proof_exception.rb
+- lib/future_proof/future_queue.rb
 - lib/future_proof/thread_pool.rb
 - lib/future_proof/version.rb
+- spec/future_proof/exceptionable_spec.rb
+- spec/future_proof/future_array_spec.rb
+- spec/future_proof/future_queu_spec.rb
 - spec/future_proof/future_spec.rb
 - spec/future_proof/thread_pool_spec.rb
 - spec/spec_helper.rb
 homepage: http://nikitachernov.github.io/FutureProof
 licenses:
 - MIT
+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: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby concurrency extenstions
 test_files:
+- spec/future_proof/exceptionable_spec.rb
+- spec/future_proof/future_array_spec.rb
+- spec/future_proof/future_queu_spec.rb
 - spec/future_proof/future_spec.rb
 - spec/future_proof/thread_pool_spec.rb
 - spec/spec_helper.rb