evt-component_host 0.1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d2bd4f87854d29af6a297eeff88d89f10eb1280
+  data.tar.gz: 9a2ad4c114ff8ad79309617813491a512b10d97c
+SHA512:
+  metadata.gz: 58f87556a16591d3f490c81f83020278b152096c6cc98d8439aa5ea258b2fee9d3021187d7de04a45f6f19db17f5460d7b86af42bdddb516ce9c439c1c8028f0
+  data.tar.gz: e39f8800e022ebdd72a002cad48f864ca3f8e62f60fe72daed997f60951e8ba7fe963e4ebcacb868d8cb2bfb41cc10b34732a81e911ea75a31c7f376042313e9

data/lib/component_host.rb

@@ -0,0 +1,14 @@
+require 'actor'
+require 'async_invocation'
+require 'casing'
+require 'log'
+require 'virtual'
+
+require 'component_host/log'
+require 'component_host/signal'
+
+require 'component_host/host'
+require 'component_host/supervisor_observers/log'
+require 'component_host/supervisor_observers/record_errors'
+
+require 'component_host/component_host'

data/lib/component_host/component_host.rb

@@ -0,0 +1,13 @@
+module ComponentHost
+  def self.start(component_name, &block)
+    logger = ::Log.get self
+
+    host = Host.build
+
+    host.instance_exec host, &block
+
+    host.start do
+      logger.info "Started component: #{component_name} (ProcessID: #{::Process.pid})"
+    end
+  end
+end

data/lib/component_host/controls.rb

@@ -0,0 +1,7 @@
+require 'component_host/controls/error'
+require 'component_host/controls/process_name'
+require 'component_host/controls/start_component'
+require 'component_host/controls/start_component/actor_crashes'
+require 'component_host/controls/start_component/raises_error'
+require 'component_host/controls/start_component/runs_continuously'
+require 'component_host/controls/start_component/stops_immediately'

data/lib/component_host/controls/error.rb

@@ -0,0 +1,11 @@
+module ComponentHost
+  module Controls
+    module Error
+      def self.example
+        Example.new
+      end
+
+      Example = Class.new StandardError
+    end
+  end
+end

data/lib/component_host/controls/process_name.rb

@@ -0,0 +1,9 @@
+module ComponentHost
+  module Controls
+    module ProcessName
+      def self.example
+        'some-process'
+      end
+    end
+  end
+end

data/lib/component_host/controls/start_component.rb

@@ -0,0 +1,23 @@
+module ComponentHost
+  module Controls
+    module StartComponent
+      def self.example
+        Example.new
+      end
+
+      class Example
+        attr_accessor :executed
+
+        def call
+          self.executed = true
+        end
+
+        module Assertions
+          def executed?
+            executed ? true : false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/component_host/controls/start_component/actor_crashes.rb

@@ -0,0 +1,27 @@
+module ComponentHost
+  module Controls
+    module StartComponent
+      module ActorCrashes
+        def self.call
+          Actor.start
+        end
+
+        def self.error
+          @error ||= Error.example
+        end
+
+        class Actor
+          include ::Actor
+
+          handle :start do
+            raise error
+          end
+
+          def error
+            ActorCrashes.error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/component_host/controls/start_component/raises_error.rb

@@ -0,0 +1,15 @@
+module ComponentHost
+  module Controls
+    module StartComponent
+      module RaisesError
+        def self.call
+          raise error
+        end
+
+        def self.error
+          @error ||= Error.example
+        end
+      end
+    end
+  end
+end

data/lib/component_host/controls/start_component/runs_continuously.rb

@@ -0,0 +1,40 @@
+module ComponentHost
+  module Controls
+    module StartComponent
+      module RunsContinuously
+        def self.call
+          Actor.start
+        end
+
+        class Actor
+          include ::Actor
+          include ::Log::Dependency
+
+          attr_writer :counter
+
+          handle :start do
+            :print_heartbeat
+          end
+
+          handle :print_heartbeat do
+            logger.info "Heartbeat (Counter: #{counter})"
+
+            :next
+          end
+
+          handle :next do
+            self.counter += 1
+
+            sleep 1
+
+            :print_heartbeat
+          end
+
+          def counter
+            @counter ||= 0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/component_host/controls/start_component/stops_immediately.rb

@@ -0,0 +1,19 @@
+module ComponentHost
+  module Controls
+    module StartComponent
+      module StopsImmediately
+        def self.call
+          Actor.start
+        end
+
+        class Actor
+          include ::Actor
+
+          handle :start do
+            :stop
+          end
+        end
+      end
+    end
+  end
+end

data/lib/component_host/host.rb

@@ -0,0 +1,115 @@
+module ComponentHost
+  class Host
+    include ::Log::Dependency
+
+    dependency :signal, Signal
+    dependency :send, Actor::Messaging::Send
+
+    def self.build
+      instance = new
+      Signal.configure instance
+      instance.send = Actor::Messaging::Send
+      instance
+    end
+
+    def register(start_proc, name=nil, &block)
+      start_proc ||= proc { yield }
+
+      logger.trace { "Registering component (StartProcedure: #{start_proc}, Name: #{name || '(none)'})" }
+
+      component = Component.new start_proc, name
+
+      components << component
+
+      logger.debug { "Component registered (StartProcedure: #{start_proc}, Name: #{name || '(none)'})" }
+
+      component
+    end
+
+    def record_error(&block)
+      record_errors_observer.record_error_proc = block
+    end
+
+    def start(&block)
+      started_components = []
+
+      Actor::Supervisor.start do |supervisor|
+        supervisor.add_observer record_errors_observer
+
+        supervisor.add_observer log_observer
+
+        signal.trap 'TSTP' do
+          message = Actor::Messages::Suspend
+
+          send.(message, supervisor.address)
+
+          logger.info { "Handled TSTP signal (MessageName: #{message.message_name}, SupervisorAddress: #{supervisor.address.id})" }
+        end
+
+        signal.trap 'CONT' do
+          message = Actor::Messages::Resume
+
+          send.(message, supervisor.address)
+
+          logger.info { "Handled CONT signal (MessageName: #{message.message_name}, SupervisorAddress: #{supervisor.address.id})" }
+        end
+
+        signal.trap 'INT' do
+          message = Actor::Messages::Shutdown
+
+          send.(message, supervisor.address)
+
+          logger.info { "Handled INT signal (MessageName: #{message.message_name}, SupervisorAddress: #{supervisor.address.id})" }
+        end
+
+        start_components do |component|
+          started_components << component
+        end
+
+        block.(supervisor) if block
+      end
+
+      started_components
+    end
+
+    def start_components(&block)
+      components.each do |component|
+        component.start
+
+        block.(component) if block
+      end
+
+    rescue => error
+      record_errors_observer.(error)
+      raise error
+    end
+
+    def record_errors_observer
+      @record_errors_observer ||= SupervisorObservers::RecordErrors.new
+    end
+
+    def log_observer
+      @log_observer ||= SupervisorObservers::Log.new
+    end
+
+    def components
+      @components ||= []
+    end
+
+    Component = Struct.new :start_proc, :name do
+      def start
+        start_proc.()
+      end
+    end
+
+    module Assertions
+      def registered?(&block)
+        block ||= proc { true }
+
+        components.any? do |component|
+          block.(component.start_proc, component.name)
+        end
+      end
+    end
+  end
+end

data/lib/component_host/log.rb

@@ -0,0 +1,8 @@
+module ComponentHost
+  class Log < Log
+    def tag!(tags)
+      tags << :component_host
+      tags << :verbose
+    end
+  end
+end

data/lib/component_host/signal.rb

@@ -0,0 +1,53 @@
+module ComponentHost
+  module Signal
+    def self.configure(receiver, attr_name: nil)
+      attr_name ||= :signal
+
+      receiver.public_send "#{attr_name}=", ::Signal
+    end
+
+    module Substitute
+      def self.build
+        Signal.new
+      end
+
+      class Signal
+        def trap(signal, &handler)
+          handlers[signal] = handler
+        end
+
+        def simulate_signal(signal)
+          handler = handlers[signal]
+
+          return if handler.nil?
+
+          handler.()
+
+          record = Record.new signal
+          records << record
+          record
+        end
+
+        def handlers
+          @handlers ||= {}
+        end
+
+        def records
+          @records ||= []
+        end
+
+        Record = Struct.new :signal
+
+        module Assertions
+          def trapped?(signal=nil)
+            if signal.nil?
+              records.any?
+            else
+              records.any? { |record| record.signal == signal }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/component_host/supervisor_observers/log.rb

@@ -0,0 +1,22 @@
+module ComponentHost
+  module SupervisorObservers
+    class Log
+      include Actor::Supervisor::Observer
+      include ComponentHost::Log::Dependency
+
+      handle Actor::Messages::ActorStarted do |msg|
+        logger.debug "Actor started (Address: #{msg.address.id}, Actor: #{msg.actor.digest})"
+      end
+
+      handle Actor::Messages::ActorStopped do |msg|
+        logger.debug "Actor stopped (Address: #{msg.address.id}, Actor: #{msg.actor.digest})"
+      end
+
+      handle Actor::Messages::ActorCrashed do |msg|
+        error = msg.error
+
+        logger.error "Error raised (ErrorClass: #{error.class.name}, Actor: #{msg.actor.digest}, Message: #{error.message.inspect})"
+      end
+    end
+  end
+end

data/lib/component_host/supervisor_observers/record_errors.rb

@@ -0,0 +1,23 @@
+module ComponentHost
+  module SupervisorObservers
+    class RecordErrors
+      include Actor::Supervisor::Observer
+
+      attr_writer :record_error_proc
+
+      handle Actor::Messages::ActorCrashed do |msg|
+        error = msg.error
+
+        self.(error)
+      end
+
+      def call error
+        record_error_proc.(error)
+      end
+
+      def record_error_proc
+        @record_error_proc ||= proc { }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: evt-component_host
+version: !ruby/object:Gem::Version
+  version: 0.1.0.0
+platform: ruby
+authors:
+- The Eventide Project
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ntl-actor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-async_invocation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-casing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-log
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-virtual
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test_bench
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " "
+email: opensource@eventide-project.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/component_host.rb
+- lib/component_host/component_host.rb
+- lib/component_host/controls.rb
+- lib/component_host/controls/error.rb
+- lib/component_host/controls/process_name.rb
+- lib/component_host/controls/start_component.rb
+- lib/component_host/controls/start_component/actor_crashes.rb
+- lib/component_host/controls/start_component/raises_error.rb
+- lib/component_host/controls/start_component/runs_continuously.rb
+- lib/component_host/controls/start_component/stops_immediately.rb
+- lib/component_host/host.rb
+- lib/component_host/log.rb
+- lib/component_host/signal.rb
+- lib/component_host/supervisor_observers/log.rb
+- lib/component_host/supervisor_observers/record_errors.rb
+homepage: https://github.com/eventide-project/component-host
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Host components inside a single physical process
+test_files: []