fiber_recycling 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13919e9d5f85666b880cebaca25b077824034b18
+  data.tar.gz: cf2cde3a386850c9177d0c04a5d2860d92840205
+SHA512:
+  metadata.gz: 19c3d05d76143172cb73db33dba29d04a64de0fef51d87c5327fd0d775c9689555da0c77289267ad3a014fc580ff4895cd50a5674891d074078e885bab57b2f6
+  data.tar.gz: 0f0b0289cff08d84e3d306ad4f6547107b3eceb3a5cfdf450ea56d543326e2ce54545f762e545e2ba0ce7ced48bc13416866d9d1172587e678c5cd6623cedf94

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Rob Fors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# Ruby Gem: FiberRecycling
+This gem offers a ducktype for `Fiber` that will reuse old native fibers for a small performance gain. It will work as a drop in replacment for Ruby's natve `Fiber`.

data/lib/fiber_recycling/duck_types.rb

@@ -0,0 +1,8 @@
+module FiberRecycling
+  module DuckTypes
+  
+    Fiber = Fiber
+    FiberError = FiberError
+  
+  end
+end

data/lib/fiber_recycling/fiber.rb

@@ -0,0 +1,51 @@
+module FiberRecycling
+  class Fiber
+  
+    def self.current
+      Thread.current[:fiber_recycling__fiber] || root
+    end
+    
+    def self.root
+      unless Thread.current.thread_variable_get(:fiber_recycling__root_fiber)
+        Thread.current.thread_variable_set(:fiber_recycling__root_fiber, new(RootFiberBackend.new))
+      end
+      Thread.current.thread_variable_get(:fiber_recycling__root_fiber)
+    end
+    
+    def self.yield(*args)
+      current.backend.class.yield(*args)
+    end
+    
+    attr_reader :backend
+    
+    def initialize(backend = nil, &block)
+      if backend && backend.is_a?(FiberBackend)
+        @backend = backend
+      else
+        raise ArgumentError, 'must pass a block' unless block_given?
+        @backend = NormalFiberBackend.new(self, block)
+      end
+    end
+    
+    def alive?
+      @backend.alive?
+    end
+    
+    def inspect
+      to_s
+    end
+    
+    def resume(*args)
+      @backend.resume(*args)
+    end
+    
+    def to_s
+      @backend.to_s
+    end
+    
+    def transfer(*args)
+      @backend.transfer(*args)
+    end
+    
+  end
+end

data/lib/fiber_recycling/fiber_backend.rb

@@ -0,0 +1,8 @@
+module FiberRecycling
+  
+  # this class only exists so we can type check backends
+  class FiberBackend
+  
+  end
+  
+end

data/lib/fiber_recycling/fiber_error.rb

@@ -0,0 +1,4 @@
+module FiberRecycling
+  class FiberError < StandardError
+  end
+end

data/lib/fiber_recycling/normal_fiber_backend.rb

@@ -0,0 +1,52 @@
+module FiberRecycling
+  class NormalFiberBackend < FiberBackend
+  
+    def self.yield(*args)
+      @state = 'suspended'
+      return_value = RecycledFiber.yield(*args)
+      @state = 'resumed'
+      return_value
+    end
+    
+    def initialize(fiber, block)
+      @state = 'created'
+      @recycled_fiber = RecycledFiberPool.local.release_recycled_fiber
+      @recycled_fiber.run { execute(fiber, block) }
+    end
+    
+    def alive?
+      @state != 'terminated'
+    end
+    
+    def inspect
+      to_s
+    end
+    
+    def resume(*args)
+      raise FiberError, 'dead fiber called' unless alive?
+      @recycled_fiber.resume(*args)
+    end
+    
+    def to_s
+      "#<RecycledFiber::Fiber:#{object_hexid} (#{@state})>"
+    end
+    
+    def transfer(*args)
+      raise FiberError, 'dead fiber called' unless alive?
+      @recycled_fiber.transfer(*args)
+    end
+    
+    private
+    
+    def execute(fiber, block)
+      args = RecycledFiber.yield
+      Thread.current[:fiber_recycling__fiber] = fiber
+      return_value = block.call(*args)
+      Thread.current[:fiber_recycling__fiber] = nil
+      @state = 'terminated'
+      RecycledFiberPool.local.absorb_recycled_fiber(@recycled_fiber)
+      return_value
+    end
+    
+  end
+end

data/lib/fiber_recycling/recycled_fiber.rb

@@ -0,0 +1,66 @@
+module FiberRecycling
+  class RecycledFiber
+  
+    def self.yield(*args)
+      NativeFiber.yield(*args)
+    end
+    
+    def initialize
+      @native_fiber = NativeFiber.new { execution_loop }
+      @state = :initialized
+      start
+    end
+    
+    def close
+      raise 'can not close, currently running a block' unless @state == :waiting_for_instruction
+      @native_fiber.resume(:close)
+      nil
+    end
+    
+    def run(*args, &block)
+      raise 'can not run, already running a block' unless @state == :waiting_for_instruction
+      @native_fiber.resume(:run)
+      @native_fiber.resume(args)
+      block_reutrn_value = @native_fiber.resume(block)
+      block_reutrn_value
+    end
+    
+    def execution_loop
+      last_reutrn_value = nil
+      loop do
+        @state = :waiting_for_instruction
+        instruction = NativeFiber.yield(last_reutrn_value)
+        case instruction
+        when :run
+          @state = :executing_block
+          args = NativeFiber.yield
+          proc = NativeFiber.yield
+          last_reutrn_value = proc.call(*args)
+        when :close
+          @state = :closed
+          break
+        else
+          raise 'invalid instruction'
+        end
+      end
+    end
+    
+    def resume(*args)
+      raise 'can not resume, not running a block' unless @state == :executing_block
+      @native_fiber.resume(*args)
+    end
+    
+    def transfer(*args)
+      raise 'can not transfer, not running a block' unless @state == :executing_block
+      @native_fiber.transfer(*args)
+    end
+    
+    private
+    
+    def start
+      @native_fiber.resume
+      nil
+    end
+  
+  end
+end

data/lib/fiber_recycling/recycled_fiber_pool.rb

@@ -0,0 +1,24 @@
+module FiberRecycling
+  class RecycledFiberPool < QuackPool
+    
+    def self.local
+      unless Thread.current.thread_variable_get(:fiber_recycling__recycled_fiber_pool)
+        Thread.current.thread_variable_set(:fiber_recycling__recycled_fiber_pool, new)
+      end
+      Thread.current.thread_variable_get(:fiber_recycling__recycled_fiber_pool)
+    end
+    
+    def initialize
+      super(resource_class: RecycledFiber)
+    end
+    
+    def release_recycled_fiber
+      release_resource
+    end
+    
+    def absorb_recycled_fiber(recycled_fiber)
+      absorb_resource(recycled_fiber)
+    end
+  
+  end
+end

data/lib/fiber_recycling/root_fiber_backend.rb

@@ -0,0 +1,29 @@
+module FiberRecycling
+  class RootFiberBackend < FiberBackend
+  
+    def self.yield(*args)
+      raise FiberError, "can't yield from root fiber"
+    end
+    
+    def alive?
+      NativeFiber.root.alive?
+    end
+    
+    def inspect
+      NativeFiber.root.inspect
+    end
+    
+    def resume(*args)
+      NativeFiber.root.resume(*args)
+    end
+    
+    def to_s
+      "#<RecycledFiber::Fiber:#{object_hexid}>"
+    end
+    
+    def transfer(*args)
+      NativeFiber.root.transfer(*args)
+    end
+    
+  end
+end

data/lib/fiber_recycling.rb

@@ -0,0 +1,19 @@
+require 'thread'
+require 'fiber'
+require 'quack_pool'
+require 'thread_root_fiber'
+
+require 'fiber_recycling/fiber'
+require 'fiber_recycling/fiber_backend'
+require 'fiber_recycling/fiber_error'
+require 'fiber_recycling/duck_types'
+require 'fiber_recycling/normal_fiber_backend'
+require 'fiber_recycling/recycled_fiber'
+require 'fiber_recycling/recycled_fiber_pool'
+require 'fiber_recycling/root_fiber_backend'
+
+module FiberRecycling
+
+  NativeFiber = ::Fiber
+
+end

data/spec/fiber_spec.rb

@@ -0,0 +1,138 @@
+require 'fiber_recycling'
+
+RSpec.describe FiberRecycling::Fiber do
+  
+  describe "#resume" do
+  
+    context "when called on fiber that does not yield" do
+      it "should return last value" do
+        fiber = FiberRecycling::Fiber.new { 1 }
+        last_value = fiber.resume
+        expect(last_value).to eql 1
+      end
+    end
+    
+    context "when called for the fist time" do
+      it "should use argument passed to 'resume' as block parameter" do
+        fiber = FiberRecycling::Fiber.new { |a| a }
+        expect(fiber.resume(1)).to eql 1
+      end
+      
+      it "should use arguments passed to it as block parameters" do
+        fiber = FiberRecycling::Fiber.new { |a, b| [a, b] }
+        expect(fiber.resume(1,2)).to eql [1, 2]
+      end
+    end
+    
+    context "when called on fiber that yields" do
+      it "should return argument passed to yield and 'yield' should return argument passed to 'resume'" do
+        fiber = FiberRecycling::Fiber.new do |a|
+          FiberRecycling::Fiber.yield(a)
+        end
+        expect(fiber.resume(1)).to eql 1
+      end
+    end
+    
+    context "when called on dead fiber" do
+      it "should raise FiberError" do
+        fiber = FiberRecycling::Fiber.new {}
+        fiber.resume
+        expect{ fiber.resume }.to raise_error FiberRecycling::FiberError
+      end
+    end
+    
+  end
+  
+  describe "::current" do
+  
+    context "when not in a fiber" do
+      it "should return a fiber" do
+        fiber = FiberRecycling::Fiber.current
+        expect(fiber).to be_a(FiberRecycling::Fiber)
+      end
+      
+      it "should return root fiber" do
+        fiber = FiberRecycling::Fiber.current
+        expect(fiber).to eql FiberRecycling::Fiber.root
+      end
+    end
+    
+    context "when in a fiber" do
+      it "should return a fiber" do
+        fiber = FiberRecycling::Fiber.new do
+          FiberRecycling::Fiber.current
+        end
+        expect(fiber.resume).to be_a(FiberRecycling::Fiber)
+      end
+      
+      it "should return current fiber" do
+        fiber = FiberRecycling::Fiber.new do
+          FiberRecycling::Fiber.current
+        end
+        expect(fiber.resume).to eql fiber
+      end
+    end
+    
+  end
+    
+  describe "::yield" do
+    
+    context "when called in root fiber" do
+      it "should raise FiberError" do
+        expect{ FiberRecycling::Fiber.yield }.to raise_error FiberRecycling::FiberError
+      end
+    end
+    
+  end
+  
+  describe "#alive?" do
+    
+    context "when called on new fiber" do
+      it "should return true" do
+        fiber = FiberRecycling::Fiber.new do
+          FiberRecycling::Fiber.yield
+        end
+        expect(fiber.alive?).to eql true
+      end
+    end
+    
+    context "when called on yielded fiber" do
+      it "should return true" do
+        fiber = FiberRecycling::Fiber.new do
+          FiberRecycling::Fiber.yield
+        end
+        fiber.resume
+        expect(fiber.alive?).to eql true
+      end
+    end
+    
+    context "when called on completed fiber" do
+      it "should return false" do
+        fiber = FiberRecycling::Fiber.new {}
+        fiber.resume
+        expect(fiber.alive?).to eql false
+      end
+    end
+    
+  end
+  
+  
+  describe "#transfer" do
+  
+    context "when called from within a fiber" do
+      it "should resume the callee fiber" do
+        fiber1 = FiberRecycling::Fiber.new do
+          Fiber.yield(1)
+        end
+        
+        fiber2 = Fiber.new do
+          fiber1.transfer
+          2
+        end
+        
+        expect(fiber2.resume).to eql 1
+      end
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: fiber_recycling
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Rob Fors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thread_root_fiber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Duck type for Fiber that will reuse old native Fibers after they have
+  finished executing their block. Reusing old Fibers will offer a small performance
+  gain.
+email: mail@robfors.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fiber_recycling.rb
+- lib/fiber_recycling/duck_types.rb
+- lib/fiber_recycling/fiber.rb
+- lib/fiber_recycling/fiber_backend.rb
+- lib/fiber_recycling/fiber_error.rb
+- lib/fiber_recycling/normal_fiber_backend.rb
+- lib/fiber_recycling/recycled_fiber.rb
+- lib/fiber_recycling/recycled_fiber_pool.rb
+- lib/fiber_recycling/root_fiber_backend.rb
+- spec/fiber_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/robfors/fiber_recycling
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Recycles old Fibers for performance
+test_files: []