fibre 0.10.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62efb12907acc747b90571c138cc84dea3b32c17
-  data.tar.gz: 1f0ce684a13f150071dfe450f8c29f7c66e21d02
+  metadata.gz: db1d530ae64a23f807393667c363468029793a08
+  data.tar.gz: 1e3beff3e7217e7d0342ed286a26d8582bd2f83e
 SHA512:
-  metadata.gz: 3db368b4a942f99e19ef9d2505b0133137e3214ffc54b12cc6b36d352fdf66293fa358250a435ec741c7a4d00bd34b151aa7eb29325bee1b2df3c7a2914cedff
-  data.tar.gz: 3065781a747648ccaa13850f579d1fadcc35cd9558b69b3bb88536c6abe13d70b0af20e85d3758f95bca3a61bff7d52bfa10281f963f13daebfbadaffdc65adf
+  metadata.gz: f9aeeb9131aa92c7e6b9dc635ff9febc58e8aef886efb7f4b193f2fcab9af56307cec183c516d5ebfc26cac33f5a9d39eac3cd029fecc723f85bee22a0230cff
+  data.tar.gz: 900961fecc9cf43a44e09bec69d66d9dc4eae5293765e51bdd314aa4e89ef99a601acc44ab48f5ca923a2ec96431d38c9701da942f51c3a93f9f92b84843343e

data/fibre.gemspec

@@ -4,27 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fibre/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fibre"
+  spec.name          = 'fibre'
   spec.version       = Fibre::VERSION
-  spec.authors       = ["inre"]
-  spec.email         = ["inre.storm@gmail.com"]
-  spec.summary       = %q{Fibre - fiber pool, mock and scoping fibres}
-  #spec.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['inre']
+  spec.email         = ['inre.storm@gmail.com']
+  spec.summary       = 'Fiber pool for Ruby'
+  spec.description   = spec.summary
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.required_ruby_version     = '>= 2.1.0'
   spec.required_rubygems_version = '>= 2.3.0'
 
-  spec.add_development_dependency "eventmachine", ">= 1.2.0"
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_dependency 'event_object', '~> 1'
 
-  spec.add_dependency "event_object", ">= 0.9"
+  spec.add_development_dependency 'eventmachine', '~> 1.2'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rspec', '~> 3'
 end

data/lib/fibre.rb

@@ -1,16 +1,16 @@
-require "event_object"
-require "fibre/version"
-require "fibre/core_ext/fiber"
-require "fibre/core_ext/synchrony"
-require "fibre/fiber_error"
-require "fibre/fiber_pool"
+require 'event_object'
+require 'fibre/version'
+require 'fibre/core_ext/fiber'
+require 'fibre/core_ext/synchrony'
+require 'fibre/fiber_error'
+require 'fibre/fiber_pool'
 
 module Fibre
-  autoload :Mock,         'fibre/mock'
-  autoload :Scope,        'fibre/scope'
+  autoload :Mock, 'fibre/mock'
+  autoload :Scope, 'fibre/scope'
 
   module Rack
-    autoload :FiberPool,  'fibre/rack/fiber_pool'
+    autoload :FiberPool, 'fibre/rack/fiber_pool'
   end
 
   extend self
@@ -19,22 +19,21 @@ module Fibre
   attr_accessor :root
   self.root = Fiber.current
 
-  # The pool size must be defined before the pool is called
-  attr_accessor :pool_size
-  self.pool_size = 20
+  DEFAULT_POOL_SIZE = 50
+  DEFAULT_POOL_QUEUE_SIZE = 1000
+  FIBER_POOL_THREADED = '__fiber_pool'
 
-  # Can be changed at any time
-  attr_accessor :max_pool_queue_size
-  self.max_pool_queue_size = 1000
+  def make_pool(pool_size: DEFAULT_POOL_SIZE, pool_queue_size: DEFAULT_POOL_QUEUE_SIZE)
+    FiberPool.new(pool_size: pool_size, pool_queue_size: pool_queue_size)
+  end
 
   # Auto-initialize at first call and each thread has own fiber pool
-  attr_writer :pool
   def pool
-    Thread.current[:__fiber_pool] ||= FiberPool.new(pool_size)
+    Thread.current[FIBER_POOL_THREADED] ||= make_pool
   end
 
   def reset
-    Thread.current[:__fiber_pool] = nil
+    Thread.current[FIBER_POOL_THREADED] = nil
     pool
   end
 end

data/lib/fibre/core_ext/fiber.rb

@@ -2,7 +2,7 @@
 #
 # Outline,
 #
-#   Fiber.sync do |fiber|
+#   Fiber.await do |fiber|
 #     fiber.resume response
 #     fiber.leave StandardError, "Something"
 #   end
@@ -26,14 +26,18 @@ class Fiber
     attributes[key] = value
   end
 
+  def leave(exception, message=nil)
+    resume exception.is_a?(Class) ? exception.new(message) : exception
+  end
+
   class <<self
 
     def scope(*a, &b)
       Fibre::Scope.scope(*a, &b)
     end
 
-    def sync(*a, &b)
-      Fibre::Scope.scope? ? Fibre::Scope.sync(*a, &b) : wait(*a, &b)
+    def await(*a, &b)
+      Fibre::Scope.in_scope? ? Fibre::Scope.await(*a, &b) : await_only(*a, &b)
     end
 
     # raise exception if we catch exception
@@ -43,13 +47,9 @@ class Fiber
       end
     end
 
-    def wait
+    def await_only
       yield(Fiber.current) if block_given?
       Fiber.yield!
     end
   end
-
-  def leave(exception, message=nil)
-    resume exception.is_a?(Class) ? exception.new(message) : exception
-  end
 end

data/lib/fibre/core_ext/synchrony.rb

@@ -9,14 +9,14 @@
 module Fibre::Synchrony
 
   refine Array do
-    def sync
-      res = Fiber.scope { collect(&:sync) }
+    def await
+      res = Fiber.scope { collect(&:await) }
       res.collect(&:result)
     end
 
-    def sync!
+    def await!
       res = Fiber.scope do
-        deep_sync_scoped
+        await_deep_scoped
       end
 
       res.each do |mock|
@@ -30,15 +30,15 @@ module Fibre::Synchrony
       self
     end
 
-    def deep_sync_scoped(path: [])
+    def await_deep_scoped(path: [])
       each_with_index do |item, index|
         # deeeep
         if item.is_a?(Array) || item.is_a?(Hash) # item.respond_to?(:deep_sync_scoped) not works in ruby 2.1.2
-          item.deep_sync_scoped(path: path + [index])
+          item.await_deep_scoped(path: path + [index])
           next
         end
 
-        item.sync.tap do |mock|
+        item.await.tap do |mock|
           mock.path = path + [index]
         end
       end
@@ -46,8 +46,8 @@ module Fibre::Synchrony
   end
 
   refine Hash do
-    def sync
-      res = Fiber.scope { values.collect(&:sync) }
+    def await
+      res = Fiber.scope { values.collect(&:await) }
       hash = {}
       res.each_with_index do |mock, index|
         hash[keys[index]] = mock.result
@@ -55,9 +55,9 @@ module Fibre::Synchrony
       hash
     end
 
-    def sync!
+    def await!
       res = Fiber.scope do
-        deep_sync_scoped
+        await_deep_scoped
       end
 
       res.each do |mock|
@@ -71,14 +71,14 @@ module Fibre::Synchrony
       self
     end
 
-    def deep_sync_scoped(path: [])
+    def await_deep_scoped(path: [])
       each do |key, item|
         # deeeep
         if item.is_a?(Array) || item.is_a?(Hash) # item.respond_to?(:deep_sync_scoped) not works in ruby 2.1.2
-          item.deep_sync_scoped(path: path + [key])
+          item.await_deep_scoped(path: path + [key])
           next
         end
-        item.sync.tap do |mock|
+        item.await.tap do |mock|
           mock.path = path + [key]
         end
       end

data/lib/fibre/fiber_pool.rb

@@ -13,11 +13,18 @@ module Fibre
   class FiberPool
     events :error, :before, :after
 
-    # Initialize fibers pool
-    def initialize(size)
-      @pool = size.times.collect { ::Fiber.new(&self.method(:fiber_entry)) }
+    attr_reader :pool_size
+    attr_reader :pool_queue_size
+    attr_reader :reserved
+    attr_reader :queue
+
+    # Initialize fiber's pool
+    def initialize(pool_size: DEFAULT_POOL_SIZE, pool_queue_size: DEFAULT_POOL_QUEUE_SIZE)
+      @pool_size = pool_size
+      @pool_queue_size = pool_queue_size
       @reserved = {}
       @queue = []
+      @pool = @pool_size.times.collect { ::Fiber.new(&self.method(:fiber_entry)) }
     end
 
     # Borrow fiber from the pool and call the block inside
@@ -25,7 +32,7 @@ module Fibre
       spec = { block: b, parent: ::Fiber.current }
 
       if @pool.empty?
-        raise "The fiber queue has been overflowed" if @queue.size > Fibre.max_pool_queue_size
+        raise "The fiber queue has been overflowed" if @queue.size > @pool_queue_size
         @queue.push spec
         return
       end
@@ -38,19 +45,6 @@ module Fibre
       self
     end
 
-    # The size of pool
-    def size
-      @pool.size
-    end
-
-    def reserved
-      @reserved
-    end
-
-    def queue
-      @queue
-    end
-
     private
 
     # There is entrypoint running fibers

data/lib/fibre/scope.rb

@@ -6,7 +6,7 @@ module Fibre
     class <<self
 
       def scope
-        raise "nested scopes" if Fiber.current[:scope]
+        raise 'nested scopes' if Fiber.current[:scope]
         scope = self.new(Fiber.current)
         Fiber.current[:scope] = scope
         yield
@@ -15,11 +15,11 @@ module Fibre
         scope.mocks
       end
 
-      def scope?
+      def in_scope?
         !!Fiber.current[:scope]
       end
 
-      def sync
+      def await
         scope = Fiber.current[:scope]
         mock = Fibre::Mock.new(scope)
         scope.mocks << mock

data/lib/fibre/version.rb

@@ -1,3 +1,3 @@
 module Fibre
-  VERSION = "0.10.0"
+  VERSION = '1.0.1'
 end

data/spec/fiber_pool_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe Fibre do
+  using EventObject
+  using Fibre::Synchrony
+
+  before { Fibre.reset }
+  let(:probe) { lambda {} }
+  let(:pool) { Fibre.make_pool }
+
+  it "creates fiber's pool" do
+    expect(Fibre.pool.pool_size).to be(50)
+    expect(Fibre.pool.pool_queue_size).to be(1000)
+  end
+
+  it "has the root fiber" do
+    expect(Fibre.root).to equal(Fiber.current)
+    expect(Fiber.current.root?).to be true
+  end
+
+  it "checks out the fiber" do
+    expect(probe).to receive(:call)
+    pool.checkout(&probe)
+  end
+
+  it "calls in scope" do
+    expect(probe).to receive(:call)
+    pool.checkout do
+      Fiber.scope do
+        probe.call
+      end
+    end
+  end
+
+  def raise_method
+    raise "test exception"
+  end
+
+  it "raises an exception in the fiber" do
+    expect {
+      pool.checkout do
+        raise_method
+      end
+  }.to raise_error(Fibre::FiberError)
+  end
+
+  it "catches up an exception with `error` event" do
+    expect(probe).to receive(:call)
+    pool.on :error do |error|
+      probe.call
+    end
+
+    expect {
+      pool.checkout do
+        raise
+      end
+    }.to_not raise_error
+  end
+end

data/spec/synchrony_spec.rb

@@ -0,0 +1,107 @@
+require "spec_helper"
+
+describe Fibre do
+  using EventObject
+  using Fibre::Synchrony
+
+  before { Fibre.reset }
+  let(:probe) { lambda {} }
+  let(:pool) { Fibre.make_pool }
+
+  around do |examples|
+    EventMachine.run_block do
+      pool.checkout(&examples)
+    end
+  end
+
+  class FibreTestOperation
+    def initialize(number)
+      @number = number
+    end
+
+    def await
+      Fiber.await do |fiber|
+        EM.next_tick do
+          fiber.resume @number
+        end
+      end
+    end
+  end
+
+  class FibreTestOperationWithException
+    def initialize(number)
+      @number = number
+    end
+
+    def await
+      Fiber.await { |f|
+        Fibre.pool.checkout do
+          raise "test"
+        end
+      }
+    end
+  end
+
+  it "waits a successful answer" do
+    result = Fiber.await do |fiber|
+      EM.next_tick do
+        fiber.resume :success
+      end
+    end
+    expect(result).to be :success
+  end
+
+  it "raises an expcetion and catches Fibre error" do
+    expect {
+      pool.checkout do
+        raise "test"
+      end
+    }.to raise_error Fibre::FiberError
+  end
+
+  it "raises an exception during await" do
+    expect {
+      op = FibreTestOperationWithException.new(4)
+      op.await
+    }.to raise_error Fibre::FiberError
+  end
+
+  it "waits couple async requests wrapped up with Array" do
+    op1 = FibreTestOperation.new(4)
+    op2 = FibreTestOperation.new(7)
+    res = [op1, op2].await
+    expect(res[0]).to be(4)
+    expect(res[1]).to be(7)
+  end
+
+  it "waits three async requests wrapped up with Hash" do
+    op1 = FibreTestOperation.new(3)
+    op2 = FibreTestOperation.new(13)
+    op3 = FibreTestOperation.new(5)
+    res = {op1: op1, op2: op2, op3: op3}.await
+    expect(res).to include(op1: 3, op2: 13, op3: 5)
+  end
+
+  it "runs a lot of asynchronous operations" do
+    op1 = FibreTestOperation.new(3)
+    op2 = FibreTestOperation.new(13)
+    op3 = FibreTestOperation.new(5)
+    op4 = FibreTestOperation.new(8)
+    op5 = FibreTestOperation.new(9)
+    res = {
+      ops: [op1, op2],
+      op3: op3,
+      child: {
+        op45: [op4, { op5: op5 }]
+      }
+    }.await!
+
+    expect(res).to include(
+      op3: 5,
+      ops: match_array([3,13]),
+      child: include(
+        op45: match_array([8, include(op5: 9)])
+      )
+    )
+  end
+end

metadata

@@ -1,86 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: fibre
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.1
 platform: ruby
 authors:
 - inre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: eventmachine
+  name: event_object
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :development
+        version: '1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '10'
 - !ruby/object:Gem::Dependency
-  name: event_object
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
+        version: '3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-description: 
+        version: '3'
+description: Fiber pool for Ruby
 email:
 - inre.storm@gmail.com
 executables: []
@@ -102,8 +102,9 @@ files:
 - lib/fibre/rack/fiber_pool.rb
 - lib/fibre/scope.rb
 - lib/fibre/version.rb
-- spec/fibre_spec.rb
+- spec/fiber_pool_spec.rb
 - spec/spec_helper.rb
+- spec/synchrony_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -124,10 +125,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
-summary: Fibre - fiber pool, mock and scoping fibres
+summary: Fiber pool for Ruby
 test_files:
-- spec/fibre_spec.rb
+- spec/fiber_pool_spec.rb
 - spec/spec_helper.rb
+- spec/synchrony_spec.rb

data/spec/fibre_spec.rb

@@ -1,170 +0,0 @@
-require "spec_helper"
-
-describe Fibre do
-  using EventObject
-  using Fibre::Synchrony
-
-  before { Fibre.reset }
-  let(:probe) { lambda {} }
-
-  it "should create default pool with default size" do
-    expect(Fibre.pool.size).to be(20)
-    expect(Fibre.max_pool_queue_size).to be(1000)
-  end
-
-  it "should have right root fiber" do
-    expect(Fibre.root).to equal(Fiber.current)
-    expect(Fiber.current.root?).to be true
-  end
-
-
-  it "should checkout fiber" do
-    expect(probe).to receive(:call)
-    Fibre.pool.checkout(&probe)
-  end
-
-  it "should rescue error in fiber" do
-    expect(probe).to receive(:call)
-    Fibre.pool.on(:error) do |error|
-      probe.call
-    end
-
-    Fibre.pool.checkout do
-      raise
-    end
-  end
-
-
-  it "should scope" do
-    expect(probe).to receive(:call)
-    Fibre.pool.checkout do
-      Fiber.scope do
-        probe.call
-      end
-    end
-  end
-
-  def raise_method
-    raise "test exception"
-  end
-
-  it "should raise uncatched exceptions" do
-    expect {
-      Fibre.pool.checkout do
-        raise_method
-      end
-  }.to raise_error(Fibre::FiberError)
-  end
-
-  it "should catch exception" do
-    Fibre.pool.on :error do |error|
-      # catch exception here
-    end
-
-    expect {
-      Fibre.pool.checkout do
-        raise
-      end
-    }.to_not raise_error
-  end
-
-  describe "in fiber specs" do
-
-    around do |examples|
-      EventMachine.run_block do
-        Fibre.pool.checkout(&examples)
-      end
-    end
-
-    class FibreTestOperation
-      def initialize(number)
-        @number = number
-      end
-
-      def sync
-        Fiber.sync do |fiber|
-          EM.next_tick do
-            fiber.resume @number
-          end
-        end
-      end
-    end
-
-    class FibreTestOperationWithException
-      def initialize(number)
-        @number = number
-      end
-
-      def sync
-        Fiber.sync do |f|
-          Fibre.pool.checkout do
-            raise "test"
-          end
-        end
-      end
-    end
-
-    it "should Fiber.sync works well" do
-      result = Fiber.sync do |fiber|
-        EM.next_tick do
-          fiber.resume :success
-        end
-      end
-      expect(result).to be :success
-    end
-
-    it "should raise exception in fiber" do
-      expect {
-        Fibre.pool.checkout do
-          raise "test"
-        end
-      }.to raise_error Fibre::FiberError
-    end
-
-    it "should sync with exception" do
-      expect {
-        op = FibreTestOperationWithException.new(4)
-        op.sync
-      }.to raise_error Fibre::FiberError
-    end
-
-    it "should sync array (scoping test)" do
-      op1 = FibreTestOperation.new(4)
-      op2 = FibreTestOperation.new(7)
-      res = [op1, op2].sync
-      expect(res[0]).to be(4)
-      expect(res[1]).to be(7)
-    end
-
-    it "should sync hash" do
-      op1 = FibreTestOperation.new(3)
-      op2 = FibreTestOperation.new(13)
-      op3 = FibreTestOperation.new(5)
-      res = {op1: op1, op2: op2, op3: op3}.sync
-      expect(res).to include(op1: 3, op2: 13, op3: 5)
-    end
-
-    it "should deep sync and sync! method (two in one)" do
-      op1 = FibreTestOperation.new(3)
-      op2 = FibreTestOperation.new(13)
-      op3 = FibreTestOperation.new(5)
-      op4 = FibreTestOperation.new(8)
-      op5 = FibreTestOperation.new(9)
-      res = {
-        ops: [op1, op2],
-        op3: op3,
-        child: {
-          op45: [op4, { op5: op5 }]
-        }
-      }.sync!
-
-      expect(res).to include(
-        op3: 5,
-        ops: match_array([3,13]),
-        child: include(
-          op45: match_array([8, include(op5: 9)])
-        )
-      )
-    end
-  end
-end