celluloid 0.18.0.pre → 0.18.0.pre2

data/architecture.md

@@ -0,0 +1,120 @@
+# Architecture
+
+The purpose of this document is to provide an overview of the `Celluloid` project architecture. It is intended as a learning tool for
+GSoC (Google Summer of Code) and for anyone else interested in peeking under the hood to figure out how Celluloid works.
+
+This document will evolve since the people writing it are learning the project too. It will likely evolve in the following manner:
+
+1. Document all major classes by describing the purpose of each one.
+2. Document the dependencies between classes described in item 1.
+3. Describe the flow of messages between the classes documented in items 1 and 2.
+4. Generate a Big Picture overview of the overall Celluloid architecture.
+5. Create a flew graphics to depict class dependencies and message flows (perhaps as a directed acyclic graph).
+
+## Document Status
+
+The document is working on item 1.
+
+## Required Libraries
+`logger`
+`thread`
+`timeout`
+`set`
+
+## Require Lifecycle
+Document the steps taken from the moment `require "celluloid"` is executed by the runtime.
+
+The file `celluloid.rb` is read in by the runtime. This file requires some standard libraries like `Thread` and `Set` (see Required Libraries for full list) and initializes the `Celluloid` module namespace. It then sets up a Celluloid singleton class which will contain utility functions that need to be accessed from anywhere. Think of these singleton methods as global methods. These specific methods should be considered private to the library and should not be directly called by user code.
+
+From here it continues to `extend` and `include` other modules so that any Ruby object that executes `include Celluloid` as part of its class definition automatically gains all of the Celluloid magic. 
+
+Next, it defines regular methods within the Celluloid namespace. These are also global methods but they are essentially the public API to the outside world. These methods (such as `current_actor` and `terminate`) can be called by user code.
+
+Next we have a list of `require`'d subfiles. This loads the remainder of the library in preparation to start running.
+
+Next, the code sets up two global default settings for the `task_class` and `group_class`. I don't know what these are yet but by exposing them this way it's clearly intended for these items to be defined in such a way that user code can override them with use-case-specific code. The code here can also read names from the environment variables to set the defaults. This is likely intended for use by the spec/test system.
+
+Lastly, the code registers some methods for shutdown to terminate all actors `at_exit` and then initializes the system.
+
+To boot the system, call `require 'celluloid'`.
+
+## Supervision Lifecycle
+The final call to `Actor::System.new.start` kicks off the top level supervisor. The supervisor container is an actor and it will keep track of all defined actors as they are added for supervision. A user may create an actor that is not supervised, so the top-level supervisor does not necessarily have a reference to every actor in the system.
+
+The Registry is also created at this time and lives within the main container. Actors can be added to the registry even if they are not supervised. The two concepts are separate even though the code is somewhat comingled. 
+
+## Classes / Modules
+
+### Celluloid Module
+* Sets up class accessors used throughout/globally such as `logger`
+* When using `include Celluloid` on a class, it performs the following work during `include`:
+  * Extends `ClassMethods` and `Internals::Properties`
+  * Includes `InstanceMethods`
+  * Sets properties on the class object.
+  * Removes `trap_exit` and `exclusive` if they exist on the singleton class so that Celluloid can redefine them for itself.
+* Defines class methods inside the `Celluloid` namespace such as `actor?` and `mailbox` and `cores`. These are utility functions. They are defined on the Celluloid singleton.
+* Provides the entry method `boot` to start up the whole system and its opposite `shutdown` to terminate everything.
+
+#### Depends On Classes
+* Internals::Logger
+* Internals::CallChain
+* Actor::System
+* Celluloid::Mailbox
+* Thread (primarily for Thread.current to access fiber locals like `:celluloid_actor`)
+* Future
+
+### ClassMethods Module
+This class contains class-level methods which are added to every user class that contains `include Celluloid`. 
+
+* Overrides `new` for the class object.
+
+#### Depends On Classes
+* Cell
+* Actor
+* Celluloid
+
+### InstanceMethods Module
+This module contains instance-level methods which are added to every user class that contains `include Celluloid`.
+
+#### Depends on Classes
+* Actor
+* Celluloid
+
+
+### Actor::System class
+Is created and `start`'ed as part of the entire boot sequence. This class provides essential services utilized by the rest of the library such as the Registry and the top-level Supervisor.
+
+#### Lifecycle
+Creates the `Registry` and initializes the `Celluloid.group_class`. Upon `start` it makes sure that it switches the `Thread.current[:celluloid_actor_system]` to itself, then defines and deploys the `Root` services.
+
+#### Depends On Classes
+* Supervision::Service::Root which is in gem `celluloid-supervision`
+* Celluloid::Notifications::Fanout
+* Celluloid::IncidentReporter
+* Celluloid::Supervision::Service::Public
+* Celluloid::Actor::Manager
+* Celluloid
+* Internals::Registry
+* Celluloid.group_class
+
+## Gem - celluloid-supervision
+Necessary for the core system to boot.
+
+Really has only two classes/modules of note. One is Supervision::Container which is an actor that keeps track of all actors under supervision. It also handles restart. Two is Supervision::Configuration. This class manages the several different ways that an actor may be placed under supervision, arguments passed to it, and other data.
+
+Be careful when reading the code. Each file in the gem relies on open Ruby classes. These files reopen previously defined classes and add more behavior, so to get a complete picture for what the Configuration and Container classes can do you must look through all of the files. While this logical separation of business logic to its own file is neat, it adds to the cognitive load when reading the code since the entire class defintion is spread over multiple files.
+
+### Supervision::Service::Root
+
+#### Depends On Classes
+* Supervision::Container
+
+
+### Supervision::Container
+Stores references to Actors on behalf of a Supervisor.
+
+This is the only class under the `Supervision` namespace that is an Actor. Every other class is a regular Ruby class.
+
+#### Depends On Classes
+* Supervision::Configuration
+* 

data/examples/basic_usage.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.push File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.push File.expand_path("../lib", __dir__)
 require "celluloid/autostart"
 
 class Counter

data/examples/configurations.rb

@@ -0,0 +1,78 @@
+require "celluloid/current"
+
+puts "Use Supervision::Configuration objects!"
+
+class Hello
+  include Celluloid
+
+  finalizer :ceasing
+
+  def initialize(to)
+    @to = to
+    puts "Created Hello #{@to}"
+  end
+
+  def ceasing
+    puts "Hello #{@to} go buhbye"
+  end
+end
+
+class FooBar
+  include Celluloid
+
+  finalizer :ceasing
+
+  def initialize(i = 0)
+    @i = i
+    puts "Created FooBar: #{@i}"
+  end
+
+  def ceasing
+    puts "FooBar FooBar: #{@i} go buhbye"
+  end
+end
+
+puts "\nInstantiated in bulk, using #deploy"
+
+config = Celluloid::Supervision::Configuration.define([
+                                                        { type: FooBar, as: :foobar },
+                                                        { type: Hello, as: :hello, args: ["World"] }
+                                                      ])
+
+config.deploy
+puts "...shut it down"
+config.shutdown
+
+puts "\nInstantiated in bulk, using .deploy"
+
+config = Celluloid::Supervision::Configuration.deploy([
+                                                        { type: FooBar, as: :foobar, args: [1] },
+                                                        { type: Hello, as: :hello, args: ["World"] }
+                                                      ])
+
+puts "...shut it down"
+config.shutdown
+
+puts "\nInstantiated two actors individually, using a local configuration object"
+
+config = Celluloid::Supervision::Configuration.new
+config.define type: FooBar, as: :foobar11, args: [11]
+config.define type: FooBar, as: :foobar33, args: [33]
+config.deploy
+
+puts "Instantiated another, which starts automatically."
+puts "... using the local configuration object"
+puts "... using a lazy loaded argument"
+config.add type: Hello, as: :hello, args: -> { "Spinning World" }
+
+config.shutdown
+
+puts "\nReuse our last configuration!"
+
+config.deploy
+puts "...shut it down"
+config.shutdown
+
+puts "Thinking for 4 seconds, and 4 seconds only."
+sleep 4
+puts "Use Supervision::Configuration objects. Really!"

data/examples/futures.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.push File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.push File.expand_path("../lib", __dir__)
 require "celluloid/autostart"
 require "digest/sha2"
 

data/examples/ring.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.push File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.push File.expand_path("../lib", __dir__)
 require "celluloid/autostart"
 
 class Ring
@@ -28,7 +28,7 @@ class Ring
 
   # Go around the ring the given number of times
   def run(n)
-    fail ArgumentError, "I can't go around a negative number of times" if n < 0
+    raise ArgumentError, "I can't go around a negative number of times" if n < 0
 
     async.around n
     wait :done
@@ -48,14 +48,15 @@ if $PROGRAM_NAME == __FILE__
   require "benchmark"
   SIZE  = 512
   TIMES = 10
+  ring = nil
 
   puts "*** Creating a #{SIZE} node ring..."
   puts Benchmark.measure {
-    $ring = Ring.new(SIZE)
+    ring = Ring.new(SIZE)
   }
 
   puts "*** Sending a message around #{TIMES} times"
   puts Benchmark.measure {
-    $ring.run(TIMES)
+    ring.run(TIMES)
   }
 end

data/examples/simple_pmap.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.push File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.push File.expand_path("../lib", __dir__)
 require "celluloid/autostart"
 
 module Enumerable

data/examples/stack.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.push File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.push File.expand_path("../lib", __dir__)
 require "celluloid/autostart"
 
 # This example builds on basic_usage.rb to show two things about #async: the
@@ -17,7 +17,7 @@ class Stack
   def push(x)
     @ary.push x
   end
-  alias_method :<<, :push
+  alias << push
 
   def pop
     @ary.pop

data/examples/supervisors_and_registry.rb

@@ -0,0 +1,82 @@
+require "celluloid/autostart"
+
+class MyActor
+  include Celluloid
+  attr_reader :state
+
+  def initialize
+    @state = :clean
+  end
+
+  def broken_method
+    @state = :dirty
+    oh_crap_im_totally_broken
+  end
+end
+
+#
+# Using the Supervisor API directly
+#
+
+puts "*** Demonstrating using the Supervisor API directly"
+
+# Calling supervise directly returns the supervisor
+supervisor = MyActor.supervise
+
+# We can get to the current version of an actor by calling
+# Celluloid::Supervisor#actors. This prints ':clean'
+puts "We should be in a clean state now: #{supervisor.actors.first.state}"
+puts "Brace yourself for a crash message..."
+
+# If we call a method that crashes an actor, it will print out a debug message,
+# then restart an actor in a clean state
+begin
+  supervisor.actors.first.broken_method
+rescue NameError
+  puts "Uhoh, we crashed the actor..."
+end
+
+puts "The supervisor should automatically restart the actor"
+
+# By now we'll be back in a :clean state!
+begin
+  puts "We should now be in a clean state again: #{supervisor.actors.first.state}"
+rescue Celluloid::DeadActorError
+  # Perhaps we got ahold of the actor before the supervisor restarted it
+  retry
+end
+
+#
+# Using the Actor Registry
+# This is the preferred approach and will make using DCell easier
+#
+
+puts "*** Demonstrating using the actor registry"
+
+# We can give our actor a name and thus avoid interacting with the supervisor
+MyActor.supervise as: :my_actor
+
+# Same as above, just getting the actor from a different place
+puts "We should be in a clean state now: #{Celluloid::Actor[:my_actor].state}"
+puts "Brace yourself for a crash message..."
+
+# If we call a method that crashes an actor, it will print out a debug message,
+# then restart an actor in a clean state
+begin
+  Celluloid::Actor[:my_actor].broken_method
+rescue NameError
+  puts "Uhoh, we crashed the actor..."
+end
+
+puts "The supervisor should automatically restart the actor"
+
+# By now we'll be back in a :clean state!
+begin
+  puts "We should now be in a clean state again: #{Celluloid::Actor[:my_actor].state}"
+rescue Celluloid::DeadActorError
+  # Perhaps we got ahold of the actor before the supervisor restarted it
+  # Don't want to catch Celluloid::DeadActorError all over the place? If this
+  # code were in a supervised Celluloid::Actor itself, the supervisor would
+  # catch Celluloid::DeadActorError and automatically restart this actor
+  retry
+end

data/examples/timers.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.push File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.push File.expand_path("../lib", __dir__)
 require "celluloid/current"
 
 class TimerExample

data/lib/celluloid.rb

@@ -1,17 +1,17 @@
+# TODO: eliminate use of global variables
+require "English"
+
 require "logger"
-require "thread"
-require "timeout"
 require "set"
+require "timeout"
 
+# !!! DO NOT INTRODUCE ADDITIONAL GLOBAL VARIABLES !!!
+# rubocop:disable Style/GlobalVars
 $CELLULOID_DEBUG = false
-$CELLULOID_MANAGED ||= false
+$CELLULOID_MONITORING = false
+# rubocop:enable Style/GlobalVars
 
 require "celluloid/version"
-require "celluloid/notices"
-
-$CELLULOID_BACKPORTED = false if defined?(CELLULOID_FUTURE) && CELLULOID_FUTURE
-$CELLULOID_BACKPORTED = (ENV["CELLULOID_BACKPORTED"] != "false") unless defined?($CELLULOID_BACKPORTED)
-Celluloid::Notices.backported if $CELLULOID_BACKPORTED
 
 module Celluloid
   # Expose all instance methods as singleton methods
@@ -21,7 +21,7 @@ module Celluloid
   LINKING_TIMEOUT = 5
 
   # Warning message added to Celluloid objects accessed outside their actors
-  BARE_OBJECT_WARNING_MESSAGE = "WARNING: BARE CELLULOID OBJECT "
+  BARE_OBJECT_WARNING_MESSAGE = "WARNING: BARE CELLULOID OBJECT ".freeze
 
   class << self
     attr_writer :actor_system # Default Actor System
@@ -33,9 +33,11 @@ module Celluloid
 
     def actor_system
       if Thread.current.celluloid?
-        Thread.current[:celluloid_actor_system] || fail(Error, "actor system not running")
+        Thread.current[:celluloid_actor_system] || raise(Error, "actor system not running")
       else
-        Thread.current[:celluloid_actor_system] || @actor_system || fail(Error, "Celluloid is not yet started; use Celluloid.boot")
+        Thread.current[:celluloid_actor_system] ||
+          @actor_system ||
+          raise(Error, "Celluloid is not yet started; use Celluloid.boot")
       end
     end
 
@@ -54,15 +56,23 @@ module Celluloid
       klass.property :exclusive_actor, default: false
       klass.property :exclusive_methods, multi: true
       klass.property :execute_block_on_receiver,
-                     default: [:after, :every, :receive],
+                     default: %i[after every receive],
                      multi: true
 
       klass.property :finalizer
       klass.property :exit_handler_name
 
       singleton = class << klass; self; end
-      singleton.send(:remove_method, :trap_exit) rescue nil
-      singleton.send(:remove_method, :exclusive) rescue nil
+      begin
+        singleton.send(:remove_method, :trap_exit)
+      rescue
+        nil
+      end
+      begin
+        singleton.send(:remove_method, :exclusive)
+      rescue
+        nil
+      end
 
       singleton.send(:define_method, :trap_exit) do |*args|
         exit_handler_name(*args)
@@ -96,20 +106,20 @@ module Celluloid
     def cores
       Internals::CPUCounter.cores
     end
-    alias_method :cpus, :cores
-    alias_method :ncpus, :cores
+    alias cpus cores
+    alias ncpus cores
 
     # Perform a stack dump of all actors to the given output object
     def stack_dump(output = STDERR)
       actor_system.stack_dump.print(output)
     end
-    alias_method :dump, :stack_dump
+    alias dump stack_dump
 
     # Perform a stack summary of all actors to the given output object
     def stack_summary(output = STDERR)
       actor_system.stack_summary.print(output)
     end
-    alias_method :summarize, :stack_summary
+    alias summarize stack_summary
 
     def public_registry
       actor_system.public_registry
@@ -157,14 +167,16 @@ module Celluloid
 
     def running?
       actor_system && actor_system.running?
+    rescue Error
+      false
     end
 
-    #de TODO Anticipate outside process finalizer that would by-pass this.
+    # de TODO Anticipate outside process finalizer that would by-pass this.
     def register_shutdown
       return if defined?(@shutdown_registered) && @shutdown_registered
       # Terminate all actors at exit, unless the exit is abnormal.
       at_exit do
-        Celluloid.shutdown unless $!
+        Celluloid.shutdown unless $ERROR_INFO
       end
       @shutdown_registered = true
     end
@@ -172,6 +184,7 @@ module Celluloid
     # Shut down all running actors
     def shutdown
       actor_system.shutdown
+      @actor_system = nil
     end
 
     def version
@@ -186,18 +199,18 @@ module Celluloid
       proxy._send_(:initialize, *args, &block)
       proxy
     end
-    alias_method :spawn, :new
+    alias spawn new
 
     # Create a new actor and link to the current one
     def new_link(*args, &block)
-      fail NotActorError, "can't link outside actor context" unless Celluloid.actor?
+      raise NotActorError, "can't link outside actor context" unless Celluloid.actor?
 
       proxy = Cell.new(allocate, behavior_options, actor_options).proxy
       Actor.link(proxy)
       proxy._send_(:initialize, *args, &block)
       proxy
     end
-    alias_method :spawn_link, :new_link
+    alias spawn_link new_link
 
     # Run an actor in the foreground
     def run(*args, &block)
@@ -215,7 +228,7 @@ module Celluloid
         mailbox_class: mailbox_class,
         mailbox_size: mailbox_size,
         task_class: task_class,
-        exclusive: exclusive_actor,
+        exclusive: exclusive_actor
       }
     end
 
@@ -225,7 +238,7 @@ module Celluloid
         exclusive_methods: exclusive_methods,
         exit_handler_name: exit_handler_name,
         finalizer: finalizer,
-        receiver_block_executions: execute_block_on_receiver,
+        receiver_block_executions: execute_block_on_receiver
       }
     end
 
@@ -253,7 +266,7 @@ module Celluloid
     def bare_object
       self
     end
-    alias_method :wrapped_object, :bare_object
+    alias wrapped_object bare_object
 
     # Are we being invoked in a different thread from our owner?
     def leaked?
@@ -269,18 +282,18 @@ module Celluloid
     def registered_name
       Actor.registered_name
     end
-    alias_method :name, :registered_name
+    alias name registered_name
 
     def inspect
       return "..." if Celluloid.detect_recursion
 
       str = "#<"
 
-      if leaked?
-        str << Celluloid::BARE_OBJECT_WARNING_MESSAGE
-      else
-        str << "Celluloid::Proxy::Cell"
-      end
+      str << if leaked?
+               Celluloid::BARE_OBJECT_WARNING_MESSAGE
+             else
+               "Celluloid::Proxy::Cell"
+             end
 
       str << "(#{self.class}:0x#{object_id.to_s(16)})"
       str << " " unless instance_variables.empty?
@@ -308,9 +321,10 @@ module Celluloid
     cause = case cause
             when String then RuntimeError.new(cause)
             when Exception then cause
-            else fail TypeError, "Exception object/String expected, but #{cause.class} received"
-    end
-    fail AbortError.new(cause)
+            else raise TypeError, "Exception object/String expected, but #{cause.class} received"
+            end
+
+    raise AbortError, cause
   end
 
   # Terminate this actor
@@ -447,14 +461,13 @@ module Celluloid
   end
 end
 
-if defined?(JRUBY_VERSION) && JRUBY_VERSION == "1.7.3"
-  fail "Celluloid is broken on JRuby 1.7.3. Please upgrade to 1.7.4+"
-end
-
 require "celluloid/exceptions"
 
 Celluloid.logger = Logger.new(STDERR).tap do |logger|
+  # !!! DO NOT INTRODUCE ADDITIONAL GLOBAL VARIABLES !!!
+  # rubocop:disable Style/GlobalVars
   logger.level = Logger::INFO unless $CELLULOID_DEBUG
+  # rubocop:enable Style/GlobalVars
 end
 
 Celluloid.shutdown_timeout = 10
@@ -473,8 +486,6 @@ require "celluloid/proxies"
 require "celluloid/mailbox"
 require "celluloid/mailbox/evented"
 
-require "celluloid/essentials"
-
 require "celluloid/group"
 require "celluloid/group/spawner"
 require "celluloid/group/pool"      # TODO: Find way to only load this if being used.
@@ -487,13 +498,27 @@ require "celluloid/actor"
 require "celluloid/cell"
 require "celluloid/future"
 
+require "celluloid/internals/call_chain"
+require "celluloid/internals/cpu_counter"
+require "celluloid/internals/handlers"
+require "celluloid/internals/links"
+require "celluloid/internals/logger"
+require "celluloid/internals/method"
+require "celluloid/internals/properties"
+require "celluloid/internals/receivers"
+require "celluloid/internals/registry"
+require "celluloid/internals/responses"
+require "celluloid/internals/signals"
+require "celluloid/internals/stack"
+require "celluloid/internals/task_set"
+require "celluloid/internals/thread_handle"
+require "celluloid/internals/uuid"
+
+require "celluloid/notifications"
+require "celluloid/supervision"
+
+require "celluloid/logging"
 require "celluloid/actor/system"
-require "celluloid/actor/manager"
-
-require "celluloid/deprecate" unless $CELLULOID_BACKPORTED == false
-
-$CELLULOID_MONITORING = false
-Celluloid::Notices.output
 
 # Configure default systemwide settings