celluloid 0.18.0.pre → 0.18.0

data/spec/celluloid/internals/links_spec.rb

@@ -0,0 +1,43 @@
+RSpec.describe Celluloid::Internals::Links do
+  subject { Celluloid::Internals::Links.new }
+
+  let(:mailbox_mock) do
+    Class.new(Array) do
+      attr_reader :address
+      def initialize(address)
+        @address = address
+      end
+    end
+  end
+
+  let(:first_actor) do
+    Struct.new(:mailbox).new(mailbox_mock.new("foo123"))
+  end
+
+  let(:second_actor) do
+    Struct.new(:mailbox).new(mailbox_mock.new("bar456"))
+  end
+
+  it "is Enumerable" do
+    expect(subject).to be_an(Enumerable)
+  end
+
+  it "adds actors by their mailbox address" do
+    expect(subject.include?(first_actor)).to be_falsey
+    subject << first_actor
+    expect(subject.include?(first_actor)).to be_truthy
+  end
+
+  it "removes actors by their mailbox address" do
+    subject << first_actor
+    expect(subject.include?(first_actor)).to be_truthy
+    subject.delete first_actor
+    expect(subject.include?(first_actor)).to be_falsey
+  end
+
+  it "iterates over all actors" do
+    subject << first_actor
+    subject << second_actor
+    expect(subject.inject([]) { |all, a| all << a }).to eq([first_actor, second_actor])
+  end
+end

data/spec/celluloid/internals/properties_spec.rb

@@ -0,0 +1,40 @@
+RSpec.describe Celluloid::Internals::Properties do
+  let(:default_value) { 42 }
+  let(:changed_value) { 43 }
+
+  let(:example_class) do
+    Class.new do
+      extend Celluloid::Internals::Properties
+      property :baz, default: 42
+    end
+  end
+
+  let(:example_subclass) do
+    Class.new(example_class)
+  end
+
+  let(:example_subclass_subclass) do
+    Class.new(example_subclass)
+  end
+
+  it "adds properties to classes" do
+    expect(example_class.baz).to eq default_value
+    example_class.baz changed_value
+    expect(example_class.baz).to eq changed_value
+  end
+
+  it "allows properties to be inherited" do
+    expect(example_subclass.baz).to eq default_value
+    example_subclass.baz changed_value
+    expect(example_subclass.baz).to eq changed_value
+    expect(example_class.baz).to eq default_value
+  end
+
+  it "allows properties to be deeply inherited" do
+    expect(example_subclass_subclass.baz).to eq default_value
+    example_subclass_subclass.baz changed_value
+    expect(example_subclass_subclass.baz).to eq changed_value
+    expect(example_subclass.baz).to eq default_value
+    expect(example_class.baz).to eq default_value
+  end
+end

data/spec/celluloid/internals/registry_spec.rb

@@ -0,0 +1,62 @@
+RSpec.describe Celluloid::Internals::Registry, actor_system: :global do
+  class Marilyn
+    include Celluloid
+
+    def sing_for(person)
+      "o/~ Happy birthday, #{person}"
+    end
+  end
+
+  it "registers Actors" do
+    Celluloid::Actor[:marilyn] = Marilyn.new
+    expect(Celluloid::Actor[:marilyn].sing_for("Mr. President")).to eq("o/~ Happy birthday, Mr. President")
+  end
+
+  it "refuses to register non-Actors" do
+    expect do
+      Celluloid::Actor[:impostor] = Object.new
+    end.to raise_error TypeError
+  end
+
+  it "lists all registered actors" do
+    Celluloid::Actor[:marilyn] = Marilyn.new
+    expect(Celluloid::Actor.registered).to include :marilyn
+  end
+
+  it "knows its name once registered" do
+    Celluloid::Actor[:marilyn] = Marilyn.new
+    expect(Celluloid::Actor[:marilyn].registered_name).to eq(:marilyn)
+  end
+
+  describe :delete do
+    before do
+      Celluloid::Actor[:marilyn] ||= Marilyn.new
+    end
+
+    it "removes reference to actors' name from the registry" do
+      Celluloid::Actor.delete(:marilyn)
+      expect(Celluloid::Actor.registered).not_to include :marilyn
+    end
+
+    it "returns actor removed from the registry" do
+      rval = Celluloid::Actor.delete(:marilyn)
+      expect(rval).to be_kind_of(Marilyn)
+    end
+  end
+
+  describe :clear do
+    it "should return a hash of registered actors and remove them from the registry" do
+      Celluloid::Actor[:marilyn] ||= Marilyn.new
+      rval = Celluloid::Actor.clear_registry
+      begin
+        expect(rval).to be_kind_of(Hash)
+        expect(rval).to have_key(:marilyn)
+        expect(rval[:marilyn].wrapped_object).to be_instance_of(Marilyn)
+        expect(Celluloid::Actor.registered).to be_empty
+      ensure
+        # Repopulate the registry once we're done
+        rval.each { |key, actor| Celluloid::Actor[key] = actor }
+      end
+    end
+  end
+end

data/spec/celluloid/internals/stack/dump_spec.rb

@@ -0,0 +1,4 @@
+RSpec.describe Celluloid::Internals::Stack::Dump do
+  subject { actor_system.stack_dump }
+  it_behaves_like "a Celluloid Stack"
+end

data/spec/celluloid/internals/stack/summary_spec.rb

@@ -0,0 +1,4 @@
+RSpec.describe Celluloid::Internals::Stack::Summary do
+  subject { actor_system.stack_summary }
+  it_behaves_like "a Celluloid Stack"
+end

data/spec/celluloid/internals/thread_handle_spec.rb

@@ -0,0 +1,60 @@
+RSpec.describe Celluloid::Internals::ThreadHandle do
+  let(:actor_system) { Celluloid::Actor::System.new }
+  after { actor_system.shutdown }
+
+  context "given a living thread" do
+    let(:args) { [actor_system] }
+
+    before do
+      @thread = nil
+      @thread_info_queue = Queue.new
+      @handle = Celluloid::Internals::ThreadHandle.new(*args) do
+        @thread_info_queue << Thread.current
+        sleep
+      end
+      @thread = Timeout.timeout(2) { @thread_info_queue.pop }
+    end
+
+    it "knows the thread is alive" do
+      alive = @handle.alive?
+      if @thread
+        @thread.kill
+        @thread.join
+      else
+        STDERR.puts "NOTE: something failed - thread missing"
+      end
+      expect(alive).to be(true)
+    end
+
+    context "when a role is provided" do
+      let(:args) { [actor_system, :useful] }
+
+      it "can be retrieved from thread directly" do
+        role = @thread.role
+        if @thread
+          @thread.kill
+          @thread.join
+        else
+          STDERR.puts "NOTE: something failed - thread missing"
+        end
+        expect(role).to eq(:useful)
+      end
+    end
+  end
+
+  context "given a finished thread" do
+    before do
+      thread_info_queue = Queue.new
+      @handle = Celluloid::Internals::ThreadHandle.new(actor_system) do
+        thread_info_queue << Thread.current
+      end
+      thread = thread_info_queue.pop
+      thread.kill
+      Specs.sleep_and_wait_until { !thread.alive? }
+    end
+
+    it "knows the thread is no longer alive" do
+      expect(@handle).not_to be_alive
+    end
+  end
+end

data/spec/celluloid/internals/uuid_spec.rb

@@ -0,0 +1,9 @@
+RSpec.describe Celluloid::Internals::UUID do
+  U = Celluloid::Internals::UUID
+
+  it "generates unique IDs across the BLOCK_SIZE boundary" do
+    upper_bound = U::BLOCK_SIZE * 2 + 10
+    uuids = (1..upper_bound).map { U.generate }
+    expect(uuids.size).to eq(uuids.uniq.size)
+  end
+end

data/spec/celluloid/logging/ring_buffer_spec.rb

@@ -0,0 +1,36 @@
+RSpec.describe Celluloid::RingBuffer do
+  subject { Celluloid::RingBuffer.new(2) }
+
+  it { is_expected.to be_empty }
+  it { is_expected.not_to be_full }
+
+  it "should push and shift" do
+    subject.push("foo")
+    subject.push("foo2")
+    expect(subject.shift).to eq("foo")
+    expect(subject.shift).to eq("foo2")
+  end
+
+  it "should push past the end" do
+    subject.push("foo")
+    subject.push("foo2")
+    subject.push("foo3")
+    expect(subject).to be_full
+  end
+
+  it "should shift the most recent" do
+    (1..5).each { |i| subject.push(i) }
+    expect(subject.shift).to be 4
+    expect(subject.shift).to be 5
+    expect(subject.shift).to be_nil
+  end
+
+  it "should return nil when shifting empty" do
+    expect(subject).to be_empty
+    expect(subject.shift).to be_nil
+  end
+
+  it "should be thread-safe" do
+    # TODO: how to test?
+  end
+end

data/spec/celluloid/mailbox/evented_spec.rb

@@ -2,36 +2,25 @@ RSpec.describe Celluloid::Mailbox::Evented do
   subject { TestEventedMailbox.new }
   it_behaves_like "a Celluloid Mailbox"
 
-  # NOTE: this example seems too exotic to "have to" succeed on RBX, though I
-  # don't know why it hangs on subject.receive and the timeout never occurs
-  #
-  # Other than
-  #
-  # Links:
-  #   https://github.com/celluloid/celluloid-io/pull/98
-  #   https://github.com/celluloid/celluloid-io/issues/56
-  #
-  unless RUBY_ENGINE == "rbx"
-    it "recovers from timeout exceeded to process mailbox message" do
-      timeout_interval = Specs::TIMER_QUANTUM + 0.1
-      started_at = Time.now
-      expect do
-        Kernel.send(:timeout, timeout_interval) do
-          subject.receive { false }
-        end
-      end.to raise_exception(Timeout::Error)
+  it "recovers from timeout exceeded to process mailbox message" do
+    timeout_interval = Specs::TIMER_QUANTUM + 0.1
+    started_at = Time.now
+    expect do
+      ::Timeout.timeout(timeout_interval) do
+        subject.receive { false }
+      end
+    end.to raise_exception(Timeout::Error)
 
-      expect(Time.now - started_at).to be_within(Specs::TIMER_QUANTUM).of timeout_interval
-    end
+    expect(Time.now - started_at).to be_within(Specs::TIMER_QUANTUM).of timeout_interval
   end
 
   it "discard messages when reactor wakeup fails" do
-    expect(Celluloid::Internals::Logger).to receive(:crash).with('reactor crashed', RuntimeError)
+    expect(Celluloid::Internals::Logger).to receive(:crash).with("reactor crashed", RuntimeError)
     expect(Celluloid.logger).to receive(:debug).with("Discarded message (mailbox is dead): first")
 
     bad_reactor = Class.new do
       def wakeup
-        fail
+        raise
       end
     end
     mailbox = Celluloid::Mailbox::Evented.new(bad_reactor)

data/spec/celluloid/misc/leak_spec.rb

@@ -13,11 +13,10 @@ RSpec.describe "Leaks", actor_system: :global, leaktest: true,
       []
     end
 
-    def terminate
-    end
+    def terminate; end
   end
 
-  def wait_for_release(weak, _what, count=1000)
+  def wait_for_release(weak, _what, count = 1000)
     trash = []
     count.times do |step|
       GC.start
@@ -43,7 +42,7 @@ RSpec.describe "Leaks", actor_system: :global, leaktest: true,
   end
 
   context "celluloid actor" do
-    it "is properly destroyed upon termination" do
+    xit "is properly destroyed upon termination" do
       actor_life("actor") do |actor|
         WeakRef.new actor
       end

data/spec/celluloid/notifications_spec.rb

@@ -0,0 +1,140 @@
+RSpec.describe Celluloid::Notifications, actor_system: :global do
+  class Admirer
+    include Celluloid
+    include Celluloid::Notifications
+
+    attr_reader :mourning
+    attr_reader :mourning_count
+
+    def someone_died(_topic, name)
+      @mourning = name
+      @mourning_count ||= 0
+      @mourning_count += 1
+    end
+  end
+
+  class President
+    include Celluloid
+    include Celluloid::Notifications
+
+    def die(topic = "death")
+      publish(topic, "Mr. President")
+    end
+  end
+
+  it "notifies relevant subscribers" do
+    marilyn = Admirer.new
+    jackie = Admirer.new
+
+    marilyn.subscribe("death", :someone_died)
+    jackie.subscribe("alive", :someone_died)
+
+    president = President.new
+
+    president.die
+    expect(marilyn.mourning).to eq("Mr. President")
+    expect(jackie.mourning).not_to eq("Mr. President")
+  end
+
+  it "allows multiple subscriptions from the same actor" do
+    marilyn = Admirer.new
+
+    marilyn.subscribe("death", :someone_died)
+    marilyn.subscribe("death", :someone_died)
+
+    president = President.new
+
+    president.die
+    expect(marilyn.mourning_count).to be(2)
+  end
+
+  it "notifies subscribers" do
+    marilyn = Admirer.new
+    jackie = Admirer.new
+
+    marilyn.subscribe("death", :someone_died)
+    jackie.subscribe("death", :someone_died)
+
+    president = President.new
+
+    president.die
+    expect(marilyn.mourning).to eq("Mr. President")
+    expect(jackie.mourning).to eq("Mr. President")
+  end
+
+  it "publishes even if there are no subscribers" do
+    president = President.new
+    president.die
+  end
+
+  it "allows symbol subscriptions" do
+    marilyn = Admirer.new
+    jackie = Admirer.new
+
+    marilyn.subscribe(:death, :someone_died)
+    jackie.subscribe("death", :someone_died)
+
+    president = President.new
+    president.die(:death)
+    expect(marilyn.mourning).to eq("Mr. President")
+    expect(jackie.mourning).to eq("Mr. President")
+  end
+
+  it "allows regex subscriptions" do
+    marilyn = Admirer.new
+
+    marilyn.subscribe(/(death|assassination)/, :someone_died)
+
+    president = President.new
+    president.die
+    expect(marilyn.mourning).to eq("Mr. President")
+  end
+
+  it "matches symbols against regex subscriptions" do
+    marilyn = Admirer.new
+
+    marilyn.subscribe(/(death|assassination)/, :someone_died)
+
+    president = President.new
+    president.die(:assassination)
+    expect(marilyn.mourning).to eq("Mr. President")
+  end
+
+  it "allows unsubscribing" do
+    marilyn = Admirer.new
+
+    subscription = marilyn.subscribe("death", :someone_died)
+    marilyn.unsubscribe(subscription)
+
+    president = President.new
+    president.die
+    expect(marilyn.mourning).to be_nil
+  end
+
+  it "prunes dead subscriptions" do
+    marilyn = Admirer.new
+    jackie = Admirer.new
+
+    marilyn.subscribe("death", :someone_died)
+    jackie.subscribe("death", :someone_died)
+
+    listeners = Celluloid::Notifications.notifier.listeners_for("death").size
+    marilyn.terminate
+    after_listeners = Celluloid::Notifications.notifier.listeners_for("death").size
+
+    expect(after_listeners).to eq(listeners - 1)
+  end
+
+  it "prunes multiple subscriptions from a dead actor" do
+    marilyn = Admirer.new
+
+    marilyn.subscribe("death", :someone_died)
+    marilyn.subscribe("death", :someone_died)
+
+    listeners = Celluloid::Notifications.notifier.listeners_for("death").size
+    marilyn.terminate
+    after_listeners = Celluloid::Notifications.notifier.listeners_for("death").size
+
+    expect(after_listeners).to eq(listeners - 2)
+  end
+end