futuroscope 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f498b34f03cddab4ebf539fdd57083bb1d91a10
-  data.tar.gz: 7b0ce96ef70f87813fed0ff2d39384a04be5b01c
+  metadata.gz: 3209580d247ece206a07186449942582e6611740
+  data.tar.gz: b9b20627ef16e8b590d11d0c5cb1dd636960a76c
 SHA512:
-  metadata.gz: 886540396354bfd6f74a730e17a8fb60e9bd59d709bd4b4c8205f13334856a647a6033c42ce9d4eaed003b442c97d9d7e0b457f50f3f2f70f5a9bf5e4dc0e096
-  data.tar.gz: 2c098214076c334a5979348b5b2ad2b077579c181945f23a81b19f253a7779777182d6027ee1edfec5d8d5adfdcc1ea9f7f6cb564a4e99f1b6b1f970df6ba30b
+  metadata.gz: dea9d87bbe54b822f7960a2c412ea1ae3dc94e8c49f2ec8c931d70384aab9fa2ce18a0cb9d3dc2815699f150ef64250865d6b009384e293fe0256841b4d2c661
+  data.tar.gz: 209d3d2f712fbf64d4ad07faece782db1c1c998590716e1b55d5d901d5561ff20d764a5a5342fbdf0f35e290c0f790b7f3d60ee892f22e09dd7d6219b16abf43

data/.travis.yml

@@ -1,5 +1,9 @@
 rvm:
+  - 1.8.7
   - 1.9.3
   - 2.0.0
+  - rbx-18mode
   - rbx-19mode
+  - jruby-18mode
   - jruby-19mode
+  - ree

data/Guardfile

@@ -1,9 +1,9 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec' do
+guard 'rspec', bundler: false do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
 

data/README.md

@@ -23,7 +23,7 @@ method on in it will be forwarded to the block's return value.
 If the thread didn't finish yet, it will block the program's execution until
 it's finished. Otherwise, it will immediataly return its value.
 
-Futuroscope is tested on `MRI 1.9.3`, `MRI 2.0.0`, `JRuby` and `Rubinius`.
+Futuroscope is tested on `MRI 1.9.3`, `MRI 2.0.0`, `MRI 1.8.7`, `JRuby in 1.9 mode`, `JRuby in 1.8 mode`, `Rubinius 1.9 mode`, `Rubinius 1.8 mode` and `REE`.
 
 ## Installation
 
@@ -128,9 +128,32 @@ If you're looking for other ways to improve your code performance via
 concurrency, you should probably deal directly with [Ruby's
 threads](http://ruby-doc.org/core-2.0/Thread.html).
 
-## Ideas for the future
+## Thread pool
 
-* Having a thread pool so you can limit maximum concurrency.
+Futures are scheduled in a thread pool that helps managing concurrency in a way
+that doesn't get out of hands. Also comes with great benefits since their
+threads are spawned at load time (and not in runtime).
+
+The default thread pool comes with a concurrency of 8 threads, which seems
+reasonable for the most use cases.
+
+The default thread pool can be replaced by a new pool with different 
+concurrency like this:
+
+```Ruby
+Futuroscope.default_pool = Futuroscope::Pool.new(24)
+```
+
+Also, each future can be scheduled to a different pool like this:
+
+```Ruby
+pool = Futuroscope::Pool.new(32)
+
+future = Future.new(pool){ :edballs }
+
+# Or with the convenience method
+future = future(pool){ :edballs }
+```
 
 ## Contributing
 

data/futuroscope.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-mocks"
 end

data/lib/futuroscope.rb

@@ -1,5 +1,23 @@
 require "futuroscope/version"
+require "futuroscope/pool"
 require "futuroscope/future"
+require "futuroscope/map"
 
 module Futuroscope
+  # Gets the default futuroscope's pool.
+  #
+  # Returns a Pool
+  def self.default_pool
+    @default_pool ||= Pool.new
+  end
+
+  # Sets a new default pool. It's useful when you want to set a different
+  # number of concurrent threads.
+  #
+  # Example:
+  #   Futuroscope.default_pool = Futuroscope::Pool.new(24)
+  #
+  def self.default_pool=(pool)
+    @default_pool = pool
+  end
 end

data/lib/futuroscope/convenience.rb

@@ -2,8 +2,8 @@ require 'futuroscope/future'
 require 'futuroscope/map'
 
 module Kernel
-  def future(&block)
-    Futuroscope::Future.new(&block)
+  def future(pool = Futuroscope.default_pool, &block)
+    Futuroscope::Future.new(pool, &block)
   end
 end
 

data/lib/futuroscope/future.rb

@@ -19,16 +19,21 @@ module Futuroscope
     #   # This will return in 1 second and not 2 if the execution wasn't
     #   # deferred to a thread.
     #
+    # pool  - A pool where all the futures will be scheduled.
     # block - A block that will be run in the background.
     #
     # Returns a Future
-    def initialize(&block)
+    def initialize(pool = Futuroscope.default_pool, &block)
       @mutex = Mutex.new
+      @queue = Queue.new
+      @pool = pool
+      @block = block
+      @pool.queue self
+    end
 
-      @thread = Thread.new do
-        result = block.call
-        self.future_value = result
-      end
+    def run_future
+      self.future_value = @block.call
+      @queue.push :ok
     end
 
     # Semipublic: Returns the future's value. Will wait for the future to be 
@@ -39,7 +44,7 @@ module Futuroscope
       @mutex.synchronize do
         return @future_value if defined?(@future_value)
       end
-      @thread.join
+      @queue.pop
       @future_value
     end
 

data/lib/futuroscope/pool.rb

@@ -0,0 +1,44 @@
+require 'thread'
+
+module Futuroscope
+  # Futuroscope's pool is design to control concurency and keep it between some
+  # certain benefits. Moreover, we warm up the threads beforehand so we don't
+  # have to spin them up each time a future is created.
+  class Pool
+    attr_reader :threads
+
+    # Initializes a new Pool.
+    #
+    # thread_count - The number of threads that this pool is gonna have
+    def initialize(thread_count = 8)
+      @thread_count = thread_count
+      @mutex = Mutex.new
+      @queue = Queue.new
+      @threads = Array.new
+      spin_threads
+    end
+
+    # Enqueues a new Future into the pool.
+    #
+    # future - The Future to enqueue.
+    def queue(future)
+      @queue.push future
+    end
+
+    private
+
+    def spin_threads
+      @thread_count.times do |i|
+        @threads << Thread.new do
+          loop do
+            @queue.pop.run_future
+          end
+        end
+      end
+    end
+
+    def finalize
+      @threads.each(&:kill)
+    end
+  end
+end

data/lib/futuroscope/version.rb

@@ -1,3 +1,3 @@
 module Futuroscope
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/futuroscope/future_spec.rb

@@ -20,7 +20,7 @@ module Futuroscope
       end
     end
 
-    it "delegates some important methods to the original object's" do
+    it "delegates some Object methods to the original object's" do
       object = [1, 2, 3]
       future = Future.new{object}
 
@@ -30,5 +30,11 @@ module Futuroscope
       expect(future.clone).to eq(object)
       expect(future.to_s).to eq(object.to_s)
     end
+
+    it "delegates missing methods" do
+      object = [1, 2, 3]
+      future = Future.new{object}
+      expect(future).to_not be_empty
+    end
   end
 end

data/spec/futuroscope/pool_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'futuroscope/pool'
+
+module Futuroscope
+  describe Pool do
+    it "spins up a number of threads" do
+      pool = Pool.new(2)
+      expect(pool.threads).to have(2).threads
+
+      pool = Pool.new(3)
+      expect(pool.threads).to have(3).threads
+    end
+
+    describe "queue" do
+      it "enqueues a job and runs it" do
+        pool = Pool.new
+        future = double(:future)
+
+        future.should_receive :run_future
+        pool.queue future
+        sleep(0.1)
+      end
+    end
+  end
+end

data/spec/futuroscope_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'futuroscope'
+
+describe Futuroscope do
+  describe "default_pool" do
+    it "returns a pool by default" do
+      expect(Futuroscope.default_pool).to be_kind_of(Futuroscope::Pool)
+    end
+  end
+
+  describe "default_pool=" do
+    it "allows you to set a new default pool" do
+      pool = Futuroscope::Pool.new
+      Futuroscope.default_pool = pool
+      expect(Futuroscope.default_pool).to equal(pool)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
-require 'coveralls'
-Coveralls.wear!
+if ENV["CI"]
+  require 'coveralls'
+  Coveralls.wear!
+end
 
 require 'futuroscope'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: futuroscope
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-03 00:00:00.000000000 Z
+date: 2013-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Futuroscope is yet another simple gem that implements the Futures concurrency
   pattern.
 email:
@@ -75,10 +89,13 @@ files:
 - lib/futuroscope/convenience.rb
 - lib/futuroscope/future.rb
 - lib/futuroscope/map.rb
+- lib/futuroscope/pool.rb
 - lib/futuroscope/version.rb
 - spec/futuroscope/convenience_spec.rb
 - spec/futuroscope/future_spec.rb
 - spec/futuroscope/map_spec.rb
+- spec/futuroscope/pool_spec.rb
+- spec/futuroscope_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -109,4 +126,6 @@ test_files:
 - spec/futuroscope/convenience_spec.rb
 - spec/futuroscope/future_spec.rb
 - spec/futuroscope/map_spec.rb
+- spec/futuroscope/pool_spec.rb
+- spec/futuroscope_spec.rb
 - spec/spec_helper.rb