adhearsion 0.7.7 → 0.8.0

data/lib/theatre/README.markdown

@@ -0,0 +1,64 @@
+Theatre
+=======
+
+Present status: stable
+
+A library for choreographing a dynamic pool of hierarchically organized actors. This was originally extracted from the [Adhearsion](http://adhearsion.com) framework by Jay Phillips.
+
+In the Adhearsion framework, it was necessary to develop an internal message-passing system that could work either synchronously or asynchronously. This is used by the framework itself and for framework extensions (called _components_) to talk with each other. The source of the events is completely undefined -- events could originate from within the framework out outside the framework. For example, a Message Queue such as [Stomp](http://stomp.codehaus.org) can wire incoming events into Theatre and catch events going to a particular destination so it can proxy them out to the server.
+
+Motivations and Design Decisions
+--------------------------------
+
+* Must maintain Ruby 1.8 and JRuby compatibility
+* Must be Thread-safe
+* Must provide some level of transparency into the events going through it
+* Must be dynamic enough to reallocate the number of triggerrs based on load
+* Must help facilitate test-driven development of Actor functionality
+* Must allow external persistence in case of a crash
+
+Example
+-------
+
+Below is an example taken from Adhearsion for executing framework-level callbacks. Note: the framework treats this callback synchronously.
+
+    events.framework.asterisk.before_call.each do |event|
+      # Pull headers from event and respond to it here.
+    end
+
+Below is an example of integration with [Stomp](http://stomp.codehaus.org/), a simple yet robust open-protocol message queue.
+
+    events.stomp.new_call.each do |event|
+      # Handle all events from the Stomp MQ server whose name is "new_call" (the String)
+    end
+
+This will filter all events whose name is "new_call" and yield the Stomp::Message to the block.
+
+Framework terminology
+--------------------
+
+Below are definitions of terms I use in Theatre. See the respective links for more information.
+
+* **callback**: This is the block given to the `each` method which triggers events coming in.
+* **payload**: This is the "message" sent to the Theatre and is what will ultimately be yielded to the callback
+* **[Actor](http://en.wikipedia.org/wiki/Actor_model)**: This refers to concurrent responders to events in a concurrent system.
+
+Synchronous vs. Asynchronous
+----------------------------
+
+With Theatre, all events are asynchronous with the optional ability to synchronously block until the event is scheduled, triggered, and has returned. If you wish to synchronously trigger the event, simple call `wait` on an `Invocation` object returned from `trigger` and then check the `Invocation#current_state` property for `:success` or `:error`. Optionally the `Invocation#success?` and `Invocation#error?` methods also provide more intuitive access to the finished state. If the event finished with `:success`, you may retrieve the returned value of the event Proc by calling `Invocation#returned_value`. If the event finished with `:error`, you may get the Exception with `Invocation#error`.
+
+Because many callbacks can be registered for a particular namespace, each needing its own Invocation object, the `Theatre#trigger` method returns an Array of Invocation objects.
+
+    # We'll assume only one callback is registered and call #first on the Array of Invocations returned by #trigger
+    invocation = my_theatre.trigger("your/namespace/here", YourSpecialClass.new("this can be anything")).first
+    invocation.wait
+    raise invocation.error if invocation.error?
+    log "Actor finished with return value #{invocation.returned_value}"
+
+Ruby 1.8 vs. Ruby 1.9 vs. JRuby
+-------------------------------
+
+Theatre was created for Ruby 1.8 because no good Actor system existed on Ruby 1.8 that met Adhearsion's needs (e.g. hierarchal with synchronous and asynchronous modes. If you wish to achieve real processor-level concurrency, use JRuby.
+
+Presently Ruby 1.9 compatibility is not a priority but patches for compatibility will be accepted, as long as they preserve compatibility with both MRI and JRuby.

data/lib/theatre/callback_definition_loader.rb

@@ -0,0 +1,84 @@
+module Theatre
+  
+  ##
+  # This class provides the a wrapper aroung which an events.rb file can be instance_eval'd.
+  #
+  class CallbackDefinitionLoader
+    
+    attr_reader :theatre, :root_name
+    def initialize(theatre, root_name=:events)
+      @theatre   = theatre
+      @root_name = root_name
+      
+      create_recorder_method root_name
+    end
+    
+    def anonymous_recorder
+      BlankSlateMessageRecorder.new(&method(:callback_registered))
+    end
+    
+    ##
+    # Parses the given Ruby source code file and returns this object.
+    #
+    # @param [String, File] file The filename or File object for the Ruby source code file to parse.
+    #
+    def load_events_file(file)
+      file = File.open(file) if file.kind_of? String
+      instance_eval file.read, file.path
+      self
+    end
+    
+    ##
+    # Parses the given Ruby source code and returns this object.
+    #
+    # NOTE: Only use this if you're generating the code yourself! If you're loading a file from the filesystem, you should
+    # use load_events_file() since load_events_file() will properly attribute errors in the code to the file from which the
+    # code was loaded.
+    #
+    # @param [String] code The Ruby source code to parse
+    #
+    def load_events_code(code)
+      instance_eval code
+      self
+    end
+    
+    protected
+    
+    ##
+    # Immediately register the namespace and callback with the Theatre instance given to the constructor. This method is only
+    # called when a new BlankSlateMessageRecorder is instantiated and receives #each().
+    #
+    def callback_registered(namespaces, callback)
+      # Get rid of all arguments passed to the namespaces. Will support arguments in the future.
+      namespaces = namespaces.map { |namespace| namespace.first }
+      
+      theatre.namespace_manager.register_callback_at_namespace namespaces, callback
+    end
+    
+    def create_recorder_method(record_method_name)
+      (class << self; self; end).send(:alias_method, record_method_name, :anonymous_recorder)
+    end
+    
+    class BlankSlateMessageRecorder
+      
+      (instance_methods - %w[__send__ __id__]).each { |m| undef_method m }
+      
+      def initialize(&notify_on_completion)
+        @notify_on_completion = notify_on_completion
+        @namespaces = []
+      end
+      
+      def method_missing(*method_name_and_args)
+        raise ArgumentError, "Supplying a block is not supported" if block_given?
+        @namespaces << method_name_and_args
+        self
+      end
+      
+      def each(&callback)
+        @notify_on_completion.call(@namespaces, callback)
+      end
+      
+    end
+    
+  end
+end

data/lib/theatre/guid.rb

@@ -0,0 +1,23 @@
+# Right now Adhearsion also defines this method. The eventual solution will be to extract the Adhearsion features on which
+# Theatre depends and make that a dependent library.
+
+unless respond_to? :new_guid
+  
+  def random_character
+    case random_digit = rand(62)
+      when  0...10 : random_digit.to_s
+      when 10...36 : (random_digit + 55).chr
+      when 36...62 : (random_digit + 61).chr
+    end
+  end
+  
+  def random_string(length_of_string=8)
+    Array.new(length_of_string) { random_character }.join
+  end
+  
+  # This GUID implementation doesn't adhere to the RFC which wants to make certain segments based on the MAC address of a
+  # network interface card and other wackiness. It's sufficiently random for our needs.
+  def new_guid
+    [8,4,4,4,12].map { |segment_length| random_string(segment_length) }.join('-')
+  end
+end

data/lib/theatre/invocation.rb

@@ -0,0 +1,121 @@
+require 'theatre/guid'
+require 'thread'
+require 'monitor'
+
+module Theatre
+  
+  ##
+  # An Invocation is an object which Theatre generates and returns from Theatre#trigger.
+  #
+  class Invocation
+    
+    attr_reader :queued_time, :started_time, :finished_time, :unique_id, :callback, :namespace, :error, :returned_value
+    
+    class InvalidStateError < Exception; end
+    
+    ##
+    # Create a new Invocation.
+    #
+    # @param [String] namespace The "/foo/bar/qaz" path to the namespace to which this Invocation belongs.
+    # @param [Proc] callback The block which should be executed by an Actor scheduler.
+    # @param [Object] payload The message that will be sent to the callback for processing.
+    #
+    def initialize(namespace, callback, payload=:theatre_no_payload)
+      raise ArgumentError, "Callback must be a Proc" unless callback.kind_of? Proc
+      @payload       = payload
+      @unique_id     = new_guid.freeze
+      @callback      = callback
+      @current_state = :new
+      @state_lock    = Mutex.new
+      
+      # Used just to protect access to the @returned_value instance variable
+      @returned_value_lock = Monitor.new
+      
+      # Used when wait() is called to notify all waiting threads by using a ConditionVariable
+      @returned_value_blocker = Monitor::ConditionVariable.new @returned_value_lock
+    end
+    
+    def queued
+      with_state_lock do
+        raise InvalidStateError unless @current_state == :new
+        @current_state = :queued
+        @queued_time = Time.now.freeze
+      end
+      true
+    end
+    
+    def current_state
+      with_state_lock { @current_state }
+    end
+    
+    def start
+      with_state_lock do
+        raise InvalidStateError unless @current_state == :queued
+        @current_state = :running
+      end
+      @started_time = Time.now.freeze
+      
+      begin
+        self.returned_value = if @payload.equal? :theatre_no_payload
+          @callback.call
+        else
+          @callback.call @payload
+        end
+        with_state_lock { @current_state = :success }
+      rescue => @error
+        with_state_lock { @current_state = :error }
+      ensure
+        @finished_time = Time.now.freeze
+      end
+    end
+    
+    def execution_duration
+      return nil unless @finished_time
+      @finished_time - @started_time
+    end
+    
+    def error?
+      current_state.equal? :error
+    end
+    
+    def success?
+      current_state.equal? :success
+    end
+    
+    ##
+    # When this Invocation has been queued, started, and entered either the :success or :error state, this method will
+    # finally return. Until then, it blocks the Thread.
+    #
+    # @return [Object] The result of invoking this Invocation's callback
+    #
+    def wait
+      with_returned_value_lock { return @returned_value if defined? @returned_value }
+      @returned_value_blocker.wait
+      # Return the returned_value
+      with_returned_value_lock { @returned_value }
+    end
+    
+    protected
+    
+    ##
+    # Protected setter which does some other housework when the returned value is found (such as notifying wait()ers)
+    #
+    # @param [returned_value] The value to set this returned value to.
+    #
+    def returned_value=(returned_value)
+      with_returned_value_lock do
+        @returned_value = returned_value
+        @returned_value_blocker.broadcast
+      end
+    end
+    
+    def with_returned_value_lock(&block)
+      @returned_value_lock.synchronize(&block)
+    end
+    
+    def with_state_lock(&block)
+      @state_lock.synchronize(&block)
+    end
+    
+  end
+end

data/lib/theatre/namespace_manager.rb

@@ -0,0 +1,153 @@
+module Theatre
+  
+  ##
+  # Manages the hierarchial namespaces of a Theatre. This class is Thread-safe.
+  #
+  class ActorNamespaceManager
+
+    VALID_NAMESPACE = %r{^(/[\w_]+)+$}
+    
+    class << self
+      def valid_namespace_path?(namespace_path)
+        namespace_path =~ VALID_NAMESPACE
+      end
+      
+      ##
+      # Since there are a couple ways to represent namespaces, this is a helper method which will normalize
+      # them into the most practical: an Array of Symbols
+      # @param [String, Array] paths The namespace to register. Can be in "/foo/bar" or *[foo,bar] format
+      def normalize_path_to_array(paths)
+        paths = paths.is_a?(Array) ? paths.flatten : Array(paths)
+        paths.map! { |path_segment| path_segment.kind_of?(String) ? path_segment.split('/') : path_segment }
+        paths.flatten!
+        paths.reject! { |path| path.nil? || (path.kind_of?(String) && path.empty?) }
+        paths.map { |path| path.to_sym }
+      end
+
+    end
+    
+    def initialize
+      @registry_lock = Mutex.new
+      @root          = RootNamespaceNode.new
+    end
+    
+    ## 
+    # Have this registry recognize a new path and prepare it for callback registrations. All path segements will be created
+    # in order. For example, when registering "/foo/bar/qaz" when no namespaces at all have been registered, this method will
+    # first register "foo", then "bar", then "qaz". If the namespace was already registered, it will not be affected.
+    #
+    # @param [String, Array] paths The namespace to register. Can be in "/foo/bar" or *[foo,bar] format
+    # @return [NamespaceNode] The NamespaceNode representing the path given.
+    # @raise NamespaceNotFound if a segment has not been registered yet
+    #
+    def register_namespace_name(*paths)
+      paths = self.class.normalize_path_to_array paths
+      
+      paths.inject(@root) do |node, name|
+        node.register_namespace_name name
+      end
+    end
+    
+    ##
+    # Returns a Proc found after searching with the namespace you provide
+    #
+    # @raise NamespaceNotFound if a segment has not been registered yet
+    #
+    def callbacks_for_namespaces(*paths)
+      search_for_namespace(paths).callbacks
+    end
+    
+    ##
+    # Find a namespace in the tree.
+    #
+    # @param [Array, String] paths Must be an Array of segments or a name like "/foo/bar/qaz"
+    # @raise NamespaceNotFound if a segment has not been registered yet
+    #
+    def search_for_namespace(paths)
+      paths = self.class.normalize_path_to_array paths
+      path_string = "/"
+      
+      found_namespace = paths.inject(@root) do |last_node,this_node_name|
+        raise NamespaceNotFound.new(path_string) if last_node.nil?
+        path_string << this_node_name.to_s
+        last_node.child_named this_node_name
+      end
+      raise NamespaceNotFound.new("/#{paths.join('/')}") unless found_namespace
+      found_namespace
+    end
+    
+    ##
+    # Registers the given callback at a namespace, assuming the namespace was already registered.
+    #
+    # @param [Array] paths Must be an Array of segments
+    # @param [Proc] callback 
+    # @raise NamespaceNotFound if a segment has not been registered yet
+    #
+    def register_callback_at_namespace(paths, callback)
+      raise ArgumentError, "callback must be a Proc" unless callback.kind_of? Proc
+      search_for_namespace(paths).register_callback callback
+    end
+    
+    protected
+    
+    ##
+    # Used by NamespaceManager to build a tree of namespaces. Has a Hash of children which is not 
+    # Thread-safe. For Thread-safety, all access should semaphore through the NamespaceManager.
+    class NamespaceNode
+      
+      attr_reader :name
+      def initialize(name)
+        @name = name.freeze
+        @children  = {}
+        @callbacks = []
+      end
+      
+      def register_namespace_name(name)
+        @children[name] ||= NamespaceNode.new(name)
+      end
+      
+      def register_callback(callback)
+        @callbacks << callback
+        callback
+      end
+      
+      def callbacks
+        @callbacks.clone
+      end
+      
+      def delete_callback(callback)
+        @callbacks.delete callback
+      end
+      
+      def child_named(name)
+        @children[name]
+      end
+      
+      def destroy_namespace(name)
+        @children.delete name
+      end
+      
+      def root?
+        false
+      end
+      
+    end
+    
+    class RootNamespaceNode < NamespaceNode
+      def initialize
+        super :ROOT
+      end
+      def root?
+        true
+      end
+    end
+    
+  end
+  
+  class NamespaceNotFound < Exception
+    def initialize(full_path)
+      super "Could not find #{full_path.inspect} in the namespace registry. Did you register it yet?"
+    end
+  end
+  
+end