ntl-actor 0.3.1 → 0.4.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0c88b4604c03bb629e693a7d72e274dfae3c2cc
-  data.tar.gz: ec1392122225b29127297bfb32ad2e080276685a
+  metadata.gz: 8390670d6cdb63d966590bc7456a583e424b21aa
+  data.tar.gz: 71bc7ef3d159c05ada78869eff267f6e683ff7a9
 SHA512:
-  metadata.gz: 3dc160915615a234617ad0a4880bcc9a5a07e88bb92ff6ce91ca5ab80743a2f7231599fe989783f50e433df6ff698faafe4745cc6de327127724e21ff1727e90
-  data.tar.gz: ead037eba5b21614ba7169227906544e878e4c6470182d6362ebb6656420fb5803ece15fa4b2b62079ab8029aa7a447aecbabbdb01f4632e23220668222ea300
+  metadata.gz: d9bc1d1dd129fa2d4275a3bb57a051826c7808f6d426c68cde2a3e336f1d70301ac2456729516dc7203e6a30a7ac8c17523e27d453270fd3f87867fca4acbcbf
+  data.tar.gz: 7164e075114eec599f0233c386f6bf77335e03edd140e51d28159d379e8b5280fc5181ffdce386f80ce6b6a37cb89076bbecedeee081a9fd4b84f72d1be879da

data/lib/actor/actor.rb

@@ -1,151 +1,11 @@
 module Actor
+  # It is possible to `include Actor' in the top-level namespace in order to
+  # bring this library's constants into focus (i.e. reference them without any
+  # leading `Actor' reference to qualify them). The test suite does this; see
+  # tests/test_init.rb. In that case, we take care not to attach any Actor
+  # behavior onto Object. This is achieved by placing the implementation of
+  # Actor in Actor::Module
   def self.included cls
-    cls.class_exec do
-      extend Destructure
-      extend Spawn
-      extend Start
-
-      prepend UpdateStatistics
-    end
-  end
-
-  attr_accessor :actor_address
-  attr_accessor :actor_state
-  attr_writer :reader
-
-  def action
-  end
-
-  def actor_statistics
-    @actor_statistics ||= Statistics.new
-  end
-
-  def handle _
-  end
-
-  def handle_system_message message
-    case message
-    when Message::Pause then
-      self.actor_state = State::Paused
-
-    when Message::Resume then
-      self.actor_state = State::Running
-
-    when Message::Stop then
-      self.actor_state = State::Running
-      raise StopIteration
-
-    when Message::RecordStatus then
-      status = message.status
-
-      Statistics::Copy.(status, actor_statistics)
-
-      status.state = actor_state
-      status.actor_class = self.class.name
-
-      Messaging::Writer.(status, message.reply_address)
-    end
-  end
-
-  def reader
-    @reader ||= Reader::Substitute.new
-  end
-
-  def run_loop
-    loop do
-      while message = reader.(wait: actor_state == State::Paused)
-        handle message
-
-        if message.is_a? Message
-          handle_system_message message
-        end
-      end
-
-      action if actor_state == State::Running
-
-      Thread.pass
-    end
-
-    self.actor_state = State::Stopped
-
-  rescue => error
-    self.actor_state = State::Crashed
-    raise error
-  end
-
-  module Destructure
-    def destructure actor, address, thread, include: nil
-      return address if include.nil?
-
-      result = [address]
-
-      include.each do |variable_name|
-        value = binding.local_variable_get variable_name
-
-        result << value
-      end
-
-      return *result
-    end
-  end
-
-  module Spawn
-    def spawn *positional_arguments, include: nil, **keyword_arguments, &block
-      address = Messaging::Address.build
-
-      method = if respond_to? :build then :build else :new end
-
-      if keyword_arguments.empty?
-        instance = __send__ method, *positional_arguments, &block
-      else
-        instance = __send__ method, *positional_arguments, **keyword_arguments, &block
-      end
-
-      reader = Messaging::Reader.build address
-
-      instance.actor_address = address
-      instance.actor_state = State::Paused
-      instance.reader = reader
-
-      thread = ::Thread.new do
-        instance.run_loop
-      end
-
-      destructure instance, address, thread, include: include
-    end
-  end
-
-  module Start
-    def start *positional_arguments, include: nil, **keyword_arguments, &block
-      address, instance, thread = spawn(
-        *positional_arguments,
-        include: %i(actor thread),
-        **keyword_arguments,
-        &block
-      )
-
-      Messaging::Writer.(Message::Resume.new, address)
-
-      destructure instance, address, thread, include: include
-    end
-  end
-
-  module State
-    Crashed = :crashed
-    Paused = :paused
-    Running = :running
-    Stopped = :stopped
-  end
-
-  module UpdateStatistics
-    def action
-      actor_statistics.executing_action
-
-      result = super
-
-      actor_statistics.action_executed
-
-      result
-    end
+    cls.include Module unless cls == Object
   end
 end

data/lib/actor/address.rb

@@ -0,0 +1,18 @@
+module Actor
+  Address = Struct.new :stream, :uuid do
+    def self.build stream=nil
+      stream ||= Stream.new
+
+      uuid = SecureRandom.uuid
+
+      instance = new stream, uuid
+      instance
+    end
+  end
+
+  class Address
+    NoneClass = Class.new Address
+
+    None = NoneClass.build Stream::Null
+  end
+end

data/lib/actor/controls/actor.rb

@@ -8,66 +8,53 @@ module Actor
       class Example
         include ::Actor
 
-        def action
-          @acted = true
+        def initialize
+          @messages = []
         end
 
-        def action_executed?
-          @acted == true
+        handle Message::Example do |message|
+          @messages << message
+          nil
         end
 
-        def handle message
-          handled_messages << message
-        end
-
-        def handled_messages
-          @handled_messages ||= []
+        def handled? message
+          @messages.include? message
         end
+      end
 
-        module Assertions
-          def handled_message? expected_message
-            expected_message ||= Message.example
+      class Continues
+        include ::Actor
 
-            @handled_messages.include? expected_message
+        def handle message
+          if message == Message.example
+            Message::Other.example
+          else
+            Message.example
           end
         end
       end
 
-      class CrashesImmediately < Example
-        def action
-          super
-          raise Error, "Induced error"
-        end
+      class Stops
+        include ::Actor
 
-        Error = Class.new StandardError
-      end
+        handle :start do
+          @stopped = true
 
-      class StopsImmediately < Example
-        def action
-          super
           raise StopIteration
         end
-      end
 
-      class ConstructorArguments < StopsImmediately
-        attr_reader :req, :opt, :keyreq, :key, :block
-
-        def initialize req, opt=nil, keyreq:, key: nil, &block
-          @req, @opt, @keyreq, @key, @block = req, opt, keyreq, key, block
+        def stopped?
+          @stopped ? true : false
         end
       end
 
-      class FactoryMethod < ConstructorArguments
-        def self.build req
-          new req, keyreq: 'keyreq-value'
-        end
-
-        def argument_passed_in? value
-          req == value
-        end
+      class Singleton
+        include ::Actor
 
-        def constructed_by_factory_method?
-          keyreq == 'keyreq-value'
+        def self.define &block
+          cls = Class.new Singleton
+          cls.class_exec &block if block
+          cls.new
         end
       end
     end

data/lib/actor/controls/address.rb

@@ -0,0 +1,48 @@
+module Actor
+  module Controls
+    module Address
+      def self.example id_offset=nil, stream: nil
+        stream ||= Stream.new
+
+        uuid = UUID.example id_offset
+
+        ::Actor::Address.new stream, uuid
+      end
+
+      def self.pair id_offset=nil
+        stream = Stream.new
+
+        queue = Queue.new
+        stream.add_queue queue
+
+        address = example id_offset, stream: stream
+
+        return address, queue
+      end
+
+      module Actor
+        def self.example
+          Address.example 0
+        end
+      end
+
+      module Supervisor
+        def self.example
+            Address.example 1
+        end
+
+        module Broadcast
+          def self.example
+            Address.example 2
+          end
+        end
+      end
+
+      module Router
+        def self.example
+          Address.example 3
+        end
+      end
+    end
+  end
+end

data/lib/actor/controls/error.rb

@@ -0,0 +1,17 @@
+module Actor
+  module Controls
+    module Error
+      def self.example
+        instance_eval <<~RUBY, '/path/to/some_file.rb', 1
+          def method_1; raise ::Actor::Controls::Error::Example; end
+          def method_2; method_1; end
+          method_2
+        RUBY
+      rescue Example => error
+        return error
+      end
+
+      Example = Class.new StandardError
+    end
+  end
+end

data/lib/actor/controls/message/attribute.rb

@@ -0,0 +1,17 @@
+module Actor
+  module Controls
+    module Message
+      module Attribute
+        def self.example
+          'some-attribute'
+        end
+
+        module Other
+          def self.example
+            'other-attribute'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/actor/controls/message.rb

@@ -2,7 +2,29 @@ module Actor
   module Controls
     module Message
       def self.example
-        'some-message'
+        attribute = Attribute.example
+
+        Example.new attribute
+      end
+
+      module Other
+        def self.example
+          attribute = Attribute::Other.example
+
+          Example.new attribute
+        end
+      end
+
+      Example = Struct.new :some_attribute do
+        include Messaging::Message
+      end
+
+      module ActorStarted
+        def self.example
+          actor_address = Address::Actor.example
+
+          Messages::ActorStarted.new actor_address
+        end
       end
     end
   end

data/lib/actor/controls/thread.rb

@@ -0,0 +1,9 @@
+module Actor
+  module Controls
+    module Thread
+      def self.example
+        Substitutes::Thread.new
+      end
+    end
+  end
+end

data/lib/actor/controls/uuid.rb

@@ -0,0 +1,15 @@
+module Actor
+  module Controls
+    module UUID
+      def self.example id_offset=nil
+        id_offset ||= 0
+
+        id_offset = id_offset.to_s 16
+
+        dword = id_offset.rjust 8, '0'
+
+        "#{dword}-0000-4000-8000-000000000000"
+      end
+    end
+  end
+end

data/lib/actor/controls.rb

@@ -1,11 +1,7 @@
-require 'actor/controls/actor'
+require 'actor/controls/address'
+require 'actor/controls/error'
 require 'actor/controls/message'
-require 'actor/controls/statistics'
-require 'actor/controls/statistics/elapsed_time'
-require 'actor/controls/statistics/elapsed_time/average'
-require 'actor/controls/statistics/elapsed_time/maximum'
-require 'actor/controls/statistics/elapsed_time/minimum'
-require 'actor/controls/statistics/elapsed_time/standard_deviation'
-require 'actor/controls/statistics/timer'
-require 'actor/controls/time'
-require 'actor/controls/time/clock'
+require 'actor/controls/actor'
+require 'actor/controls/message/attribute'
+require 'actor/controls/uuid'
+require 'actor/controls/thread'

data/lib/actor/destructure.rb

@@ -0,0 +1,23 @@
+module Actor
+  module Destructure
+    def self.call primary_return_value, include=nil, **values
+      include = Array(include)
+
+      if include.empty?
+        primary_return_value
+      else
+        return_values = include.map do |return_value_name|
+          begin
+            values.fetch return_value_name
+          rescue KeyError
+            raise Error, "Invalid return value to include `#{return_value_name.inspect}'"
+          end
+        end
+
+        return primary_return_value, *return_values
+      end
+    end
+
+    Error = Class.new StandardError
+  end
+end

data/lib/actor/{time_unit.rb → duration.rb}

@@ -1,5 +1,5 @@
 module Actor
-  module TimeUnit
+  module Duration
     def self.millisecond
       0.001
     end

data/lib/actor/messages.rb

@@ -0,0 +1,15 @@
+module Actor
+  module Messages
+    class Start
+      include Messaging::Message
+    end
+
+    ActorStarted = Struct.new :actor_address do
+      include Messaging::Message
+    end
+
+    class Stop
+      include Messaging::Message
+    end
+  end
+end

data/lib/actor/messaging/message.rb

@@ -0,0 +1,5 @@
+module Actor
+  module Messaging
+    Message = Module.new
+  end
+end

data/lib/actor/messaging/{writer → read}/substitute.rb

@@ -1,8 +1,18 @@
 module Actor
   module Messaging
-    class Writer
+    class Read
       class Substitute
-        def call message
+        def call wait: nil
+          message = messages.shift
+
+          if message.nil? and wait
+            raise WouldWait
+          end
+
+          message
+        end
+
+        def add_message message
           messages << message
         end
 
@@ -10,15 +20,8 @@ module Actor
           @messages ||= []
         end
 
-        module Assertions
-          def written? &block
-            block ||= proc { true }
-
-            messages.any? &block
-          end
-        end
+        WouldWait = Class.new StandardError
 
-        # Eventide compatibility
         singleton_class.send :alias_method, :build, :new
       end
     end

data/lib/actor/messaging/read.rb

@@ -0,0 +1,50 @@
+module Actor
+  module Messaging
+    class Read
+      attr_reader :queue
+      attr_reader :stream
+
+      def initialize queue, stream
+        @queue = queue
+        @stream = stream
+      end
+
+      def self.build address
+        stream = address.stream
+
+        queue = Queue.new
+        stream.add_queue queue
+
+        instance = new queue, stream
+        instance
+      end
+
+      def self.call address, wait: nil
+        instance = build address
+        instance.(wait: wait)
+      end
+
+      def self.configure receiver, address, attr_name: nil
+        attr_name ||= :reader
+
+        instance = build address
+        receiver.public_send "#{attr_name}=", instance
+        instance
+      end
+
+      def call wait: nil
+        if wait
+          queue.deq
+        else
+          non_block = true
+
+          begin
+            queue.deq non_block
+          rescue ThreadError
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/actor/messaging/write/substitute.rb

@@ -0,0 +1,39 @@
+module Actor
+  module Messaging
+    class Write
+      class Substitute
+        attr_reader :records
+
+        def initialize
+          @records = []
+        end
+
+        def call message, address
+          record = Record.new message, address
+
+          records << record
+
+          record
+        end
+
+        Record = Struct.new :message, :address
+
+        singleton_class.send :alias_method, :build, :new
+
+        module Assertions
+          def written? message=nil, &block
+            if message.nil?
+              block ||= proc { true }
+            else
+              block ||= proc { |msg| msg == message }
+            end
+
+            records.any? do |record|
+              block.(record.message, record.address)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/actor/messaging/write.rb

@@ -0,0 +1,26 @@
+module Actor
+  module Messaging
+    class Write
+      def self.call message, address
+        instance = new
+        instance.(message, address)
+      end
+
+      def self.configure receiver, attr_name: nil
+        attr_name ||= :writer
+
+        instance = new
+        receiver.public_send "#{attr_name}=", instance
+        instance
+      end
+
+      def call message, address
+        stream = address.stream
+
+        stream.write message
+
+        nil
+      end
+    end
+  end
+end

data/lib/actor/module/build.rb

@@ -0,0 +1,20 @@
+module Actor
+  module Module
+    module Build
+      def build address, *positional_arguments, **keyword_arguments, &block
+        if keyword_arguments.empty?
+          instance = new *positional_arguments, &block
+        else
+          instance = new *positional_arguments, **keyword_arguments, &block
+        end
+
+        instance.reader = Messaging::Read.build address
+        instance.writer = Messaging::Write.new
+
+        instance.configure
+
+        instance
+      end
+    end
+  end
+end