ruby--ruby/spec/ruby/library/fiber/transfer_spec.rb

require_relative '../../spec_helper'
require_relative '../../shared/fiber/resume'

require 'fiber'

describe "Fiber#transfer" do
  it_behaves_like :fiber_resume, :transfer
end

describe "Fiber#transfer" do
  it "transfers control from one Fiber to another when called from a Fiber" do
    fiber1 = Fiber.new { :fiber1 }
    fiber2 = Fiber.new { fiber1.transfer; :fiber2 }

    ruby_version_is '' ... '3.0' do
      fiber2.resume.should == :fiber1
    end
    ruby_version_is '3.0' do
      fiber2.resume.should == :fiber2
    end
  end

  it "returns to the root Fiber when finished" do
    f1 = Fiber.new { :fiber_1 }
    f2 = Fiber.new { f1.transfer; :fiber_2 }

    f2.transfer.should == :fiber_1
    f2.transfer.should == :fiber_2
  end

  it "can be invoked from the same Fiber it transfers control to" do
    states = []
    fiber = Fiber.new { states << :start; fiber.transfer; states << :end }
    fiber.transfer
    states.should == [:start, :end]

    states = []
    fiber = Fiber.new { states << :start; fiber.transfer; states << :end }
    fiber.resume
    states.should == [:start, :end]
  end

  ruby_version_is '' ... '3.0' do
    it "can transfer control to a Fiber that has transferred to another Fiber" do
      states = []
      fiber1 = Fiber.new { states << :fiber1 }
      fiber2 = Fiber.new { states << :fiber2_start; fiber1.transfer; states << :fiber2_end}
      fiber2.resume.should == [:fiber2_start, :fiber1]
      fiber2.transfer.should == [:fiber2_start, :fiber1, :fiber2_end]
    end
  end

  ruby_version_is '3.0' do
    it "can not transfer control to a Fiber that has suspended by Fiber.yield" do
      states = []
      fiber1 = Fiber.new { states << :fiber1 }
      fiber2 = Fiber.new { states << :fiber2_start; Fiber.yield fiber1.transfer; states << :fiber2_end}
      fiber2.resume.should == [:fiber2_start, :fiber1]
      -> { fiber2.transfer }.should raise_error(FiberError)
    end
  end

  it "raises a FiberError when transferring to a Fiber which resumes itself" do
    fiber = Fiber.new { fiber.resume }
    -> { fiber.transfer }.should raise_error(FiberError)
  end

  it "works if Fibers in different Threads each transfer to a Fiber in the same Thread" do
    # This catches a bug where Fibers are running on a thread-pool
    # and Fibers from a different Ruby Thread reuse the same native thread.
    # Caching the Ruby Thread based on the native thread is not correct in that case,
    # and the check for "fiber called across threads" in Fiber#transfer
    # might be incorrect based on that.
    2.times do
      Thread.new do
        io_fiber = Fiber.new do |calling_fiber|
          calling_fiber.transfer
        end
        io_fiber.transfer(Fiber.current)
        value = Object.new
        io_fiber.transfer(value).should equal value
      end.join
    end
  end

  it "transfers control between a non-main thread's root fiber to a child fiber and back again" do
    states = []
    thread = Thread.new do
      f1 = Fiber.new do |f0|
        states << 0
        value2 = f0.transfer(1)
        states << value2
        3
      end

      value1 = f1.transfer(Fiber.current)
      states << value1
      value3 = f1.transfer(2)
      states << value3
    end
    thread.join
    states.should == [0, 1, 2, 3]
  end

  ruby_version_is "" ... "3.0" do
    it "runs until Fiber.yield" do
      obj = mock('obj')
      obj.should_not_receive(:do)
      fiber = Fiber.new { 1 + 2; Fiber.yield; obj.do }
      fiber.transfer
    end

    it "resumes from the last call to Fiber.yield on subsequent invocations" do
      fiber = Fiber.new { Fiber.yield :first; :second }
      fiber.transfer.should == :first
      fiber.transfer.should == :second
    end

    it "sets the block parameters to its arguments on the first invocation" do
      first = mock('first')
      first.should_receive(:arg).with(:first).twice

      fiber = Fiber.new { |arg| first.arg arg; Fiber.yield; first.arg arg; }
      fiber.transfer :first
      fiber.transfer :second
    end
  end
end