celluloid-supervision 0.20.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d758087a7c87232e429ecab55a0a1361cb3cca75
+  data.tar.gz: 7a2a877f7c9fb2d91de1e469b6464ff4db8c2a27
+SHA512:
+  metadata.gz: a4e2a0fed81099cc2ec77bf10f42b137f1c3befaa50d5506d08044b5ab865232060d4bfb84455350cde1ae641fef9d1e936d1929fb3b2a3a0d2a3cbde60cc29a
+  data.tar.gz: afd6c4dc05c56e4ac9cf5d1968d848d6d39d334c415062594f62be54a84416f82b5df458213ea701c369d5418e26bab3abdc2c3980308110876f919393c684cb

data/.env-ci

@@ -0,0 +1,4 @@
+CELLULOID_SPECS_LOG_STRATEGY=stderr
+CELLULOID_SPECS_LOG_LEVEL=3
+CELLULOID_SPECS_LOG_FILE=../../log/ci.log
+CELLULOID_SPECS_LOG_SYNC=false

data/.env-dev

@@ -0,0 +1,4 @@
+CELLULOID_SPECS_LOG_STRATEGY=single
+CELLULOID_SPECS_LOG_FILE=../../log/test.log
+CELLULOID_SPECS_LOG_LEVEL=0
+CELLULOID_SPECS_LOG_SYNC=true

data/.gitignore

@@ -0,0 +1,9 @@
+coverage/
+rdoc/
+doc/
+pkg/
+tmp/
+.yardoc
+.bundle
+Gemfile.lock
+log

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "culture"]
+	path = culture
+	url = http://github.com/celluloid/culture.git

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--format documentation
+--order random
+--warnings
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - culture/rubocop/rubocop.yml

data/.travis.yml

@@ -0,0 +1,28 @@
+script: rake ci
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.2.2
+  - jruby
+  - ruby-head
+  - jruby-head
+  - rbx-2
+
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - env: CELLULOID_TASK_CLASS=Threaded
+
+env:
+  matrix:
+    - CELLULOID_TASK_CLASS=Fibered
+    - CELLULOID_TASK_CLASS=Threaded
+    - CELLULOID_BACKPORTED=false
+
+notifications:
+  irc: "irc.freenode.org#celluloid"
+
+sudo: false
+install: bundle install --retry=3 --without=development

data/CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,31 @@
+source "https://rubygems.org"
+
+gem "coveralls", require: false
+
+gemspec development_group: :gem_build_tools
+
+group :development do
+  gem "pry"
+  # de gem 'guard'
+  # de gem 'guard-rspec'
+  # de gem 'rb-fsevent', '~> 0.9.1' if RUBY_PLATFORM =~ /darwin/
+  gem "rubocop"
+end
+
+group :test do
+  gem "dotenv", "~> 2.0"
+  gem "nenv"
+  gem "benchmark_suite"
+  gem "rspec", "~> 3.2"
+  gem "rspec-retry"
+  gem "rspec-log_split", github: "abstractive/rspec-log_split", branch: "master"
+end
+
+group :gem_build_tools do
+  gem "rake"
+end
+
+gem 'celluloid-essentials', github: 'celluloid/celluloid-essentials', branch: 'master'
+gem 'celluloid-gems', github: 'celluloid/celluloid-gems', branch: 'master'
+
+gem 'celluloid', github: 'celluloid/celluloid', branch: '0.17.0-prerelease'

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Celluloid
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1 @@
+Supervisors, Supervision Groups, and Supervision Trees for Celluloid.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+Dir["tasks/**/*.rake"].each { |task| load task }
+
+default_tasks = ["spec"]
+default_tasks << "rubocop" unless ENV["CI"]
+task default: default_tasks
+
+task ci: %w(spec benchmark)

data/celluloid-supervision.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/celluloid/supervision/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name         = "celluloid-supervision"
+  gem.version      = Celluloid::Supervision::VERSION
+  gem.platform     = Gem::Platform::RUBY
+  gem.summary      = "Celluloid Supervision"
+  gem.description  = "Supervisors, Supervision Groups, and Supervision Trees for Celluloid."
+  gem.licenses     = ["MIT"]
+
+  gem.authors      = ["digitalextremist //", "Tony Arcieri", "Tim Carey-Smith"]
+  gem.email        = ["code@extremist.digital", "tony.arcieri@gmail.com"]
+  gem.homepage     = "https://github.com/celluloid/"
+
+  gem.required_ruby_version     = ">= 1.9.2"
+  gem.required_rubygems_version = ">= 1.3.6"
+
+  gem.files        = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|examples|spec|features)/}) }
+  gem.require_path = "lib"
+
+  gem.add_development_dependency "bundler"
+  gem.add_dependency "celluloid"
+  gem.add_dependency "celluloid-gems"
+  gem.add_dependency "celluloid-essentials"
+
+end

data/lib/celluloid/supervision/configuration/injections.rb

@@ -0,0 +1,8 @@
+module Celluloid
+  module Supervision
+    class Configuration
+      class Injection
+      end
+    end
+  end
+end

data/lib/celluloid/supervision/configuration/instance.rb

@@ -0,0 +1,113 @@
+module Celluloid
+  module Supervision
+    class Configuration
+      class Instance
+        attr_accessor :configuration
+
+        def initialize(configuration={})
+          @state = :initializing # :ready
+          resync_accessors
+          @configuration = configuration
+          define configuration if configuration.any?
+        end
+
+        def export
+          @configuration.select { |k, v| !REMOVE_AT_EXPORT.include? k }
+        end
+
+        def ready?(fail=false)
+          unless @state == :ready
+            @state = :ready if Configuration.valid? @configuration, fail
+          end
+          @state == :ready
+        end
+
+        def define(instance, fail=false)
+          fail Configuration::Error::AlreadyDefined if ready? fail
+          invoke_injection(:before_configuration)
+          @configuration = Configuration.options(instance)
+          ready?
+        end
+
+        def injection!(key, proc)
+          @configuration[:injections] ||= {}
+          @configuration[:injections][key] = proc
+        end
+
+        def injections!(_procs)
+          @configuration[:injections] = proces
+        end
+
+        def resync_accessors
+          # methods for setting and getting the usual defaults
+          Configuration.parameters(:mandatory, :optional, :plugins, :meta).each do |key|
+            self.class.instance_eval do
+              remove_method :"#{key}!" rescue nil # avoid warnings in tests
+              define_method(:"#{key}!") { |value| @configuration[key] = value }
+            end
+            self.class.instance_eval do
+              remove_method :"#{key}=" rescue nil # avoid warnings in tests
+              define_method(:"#{key}=") { |value| @configuration[key] = value }
+            end
+            self.class.instance_eval do
+              remove_method :"#{key}?" rescue nil # avoid warnings in tests
+              define_method(:"#{key}?") { !@configuration[key].nil? }
+            end
+            self.class.instance_eval do
+              remove_method :"#{key}" rescue nil # avoid warnings in tests
+              define_method(:"#{key}") { @configuration[key] }
+            end
+          end
+
+          Configuration.aliases.each do |_alias, _original|
+            ["!", :"=", :"?", :""]. each do |m|
+              self.class.instance_eval do
+                remove_method :"#{_alias}#{m}" rescue nil # avoid warnings in tests
+                alias_method :"#{_alias}#{m}", :"#{_original}#{m}"
+              end
+            end
+          end
+          true
+        end
+
+        def merge!(values)
+          @configuration = @configuration.merge(values)
+        end
+
+        def merge(values)
+          if values.is_a? Configuration
+            @configuration.merge(values.configuration)
+          elsif values.is_a? Hash
+            @configuration.merge(values)
+          else
+            fail Error::Invalid
+          end
+        end
+
+        def key?(k)
+          @configuration.key?(k)
+        end
+
+        def set(key, value)
+          @configuration[key] = value
+        end
+        alias_method :[]=, :set
+
+        def get(key)
+          @configuration[key]
+        end
+        alias_method :[], :get
+
+        def delete(k)
+          current_instance.delete(k)
+        end
+
+        private
+
+        def invoke_injection(_point)
+          # de puts "injection? #{point}"
+        end
+      end
+    end
+  end
+end

data/lib/celluloid/supervision/configuration.rb

@@ -0,0 +1,205 @@
+module Celluloid
+  module Supervision
+    class Configuration
+      class << self
+        def deploy(options={})
+          define(options).deploy
+        end
+
+        def define(options={})
+          new(options)
+        end
+
+        def valid?(configuration, fail=false)
+          parameters(:mandatory).each do |k|
+            unless configuration.key? k
+              if fail
+                fail Error::Incomplete, "Missing `:#{k}` in supervision configuration."
+              else
+                return false
+              end
+            end
+          end
+          arity.each do |klass, args|
+            unless configuration[args].is_a? Proc
+              __a = configuration[args] && configuration[args].count || 0
+              __arity = configuration[klass].allocate.method(:initialize).arity
+              unless __arity == -1 || __a == __arity
+                if fail
+                  fail ArgumentError.new("#{__a} vs. #{__arity}")
+                else
+                  return false
+                end
+              end
+            end
+          end
+          true
+        end
+
+        def options(args, options={})
+          configuration = args.merge(options)
+          return configuration if configuration.is_a? Configuration
+          configuration[:initialize] = Container::Behavior.configure(configuration)
+          valid?(configuration, true)
+          configuration
+        end
+      end
+
+      extend Forwardable
+
+      def_delegators :current_instance,
+                     :delete,
+                     :key?,
+                     :set,
+                     :get,
+                     :[],
+                     :[]=,
+                     :injection!,
+                     :injections!
+
+      attr_accessor :instances
+
+      def initialize(options={})
+        @instances = [Instance.new]
+        @branch = :services
+        @i = 0 # incrementer of instances in this branch
+        resync_accessors
+        @configuration = options
+        @supervisor ||= :"Celluloid.services"
+
+        if options.is_a? Hash
+          options[:initialize] ||= Container::Behavior.configure(options)
+          @configuration = instance_eval(&options[:initialize])
+          @supervisor ||= @configuration.fetch(:supervisor, :"Celluloid.services")
+        end
+
+        if (@configuration.is_a?(Hash) || @configuration.is_a?(Array)) && @configuration.any?
+          define(@configuration)
+        end
+      end
+
+      def provider
+        @provider ||= if @supervisor.is_a? Hash
+                        @supervisor[:type].run!(as: @supervisor[:as])
+                      elsif @supervisor.is_a? Symbol
+                        @supervisor = Object.module_eval(@supervisor.to_s)
+                        provider
+                      elsif @supervisor.is_a? Class
+                        @supervisor.run!
+                      elsif @supervisor.respond_to? :supervise
+                        @supervisor
+                      else
+                        fail Error::InvalidSupervisor
+        end
+      end
+
+      def deploy(options={})
+        define(options) if options.any?
+        @instances.each do |instance|
+          provider.supervise instance.merge(branch: @branch)
+        end
+        provider
+      end
+
+      def count
+        @instances.count
+      end
+
+      def each(&block)
+        @instances.each(&block)
+      end
+
+      def resync_accessors
+        # methods for setting and getting the usual defaults
+        Configuration.parameters(:mandatory, :optional, :plugins, :meta).each do |key|
+          [:"#{key}!", :"#{key}="].each do |m|
+            self.class.instance_eval do
+              remove_method :"#{m}" rescue nil # avoid warnings in tests
+              define_method(m) { |p| current_instance.send(m, p) }
+            end
+          end
+          [:"#{key}?", :"#{key}"].each do |m|
+            self.class.instance_eval do
+              remove_method :"#{m}" rescue nil # avoid warnings in tests
+              define_method(m) { current_instance.send(m) }
+            end
+          end
+        end
+
+        Configuration.aliases.each do |_alias, _original|
+          ["!", :"=", :"?", :""]. each do |m|
+            self.class.instance_eval do
+              remove_method :"#{_alias}#{m}" rescue nil # avoid warnings in tests
+              alias_method :"#{_alias}#{m}", :"#{_original}#{m}"
+            end
+          end
+        end
+      end
+
+      def merge!(values)
+        if values.is_a?(Configuration) || values.is_a?(Hash)
+          current_instance.merge!(values)
+        else
+          fail Error::Invalid
+        end
+      end
+
+      def merge(values)
+        if values.is_a?(Configuration) || values.is_a?(Hash)
+          current_instance.merge(values)
+        else
+          fail Error::Invalid
+        end
+      end
+
+      def export
+        return current_instance.to_hash if @i == 0
+        @instances.map(&:export)
+      end
+
+      def include?(name)
+        @instances.map(&:name).include? name
+      end
+
+      def define(configuration, fail=false)
+        if configuration.is_a? Array
+          configuration.each { |c| define(c, fail) }
+        else
+          unless include? configuration[:as]
+            begin
+              current_instance.define(configuration, fail)
+            rescue Error::AlreadyDefined
+              increment
+              retry
+            end
+          end
+        end
+        self
+      end
+
+      def increment
+        @i += 1
+      end
+      alias_method :another, :increment
+
+      def add(options)
+        define(options)
+        provider.supervise options if Configuration.valid? options
+      end
+
+      def shutdown
+        @provider.shutdown
+      end
+
+      private
+
+      def current_instance
+        @instances[@i] ||= Instance.new
+      end
+
+      def invoke_injection(_point)
+        # de puts "injection? #{point}"
+      end
+    end
+  end
+end

data/lib/celluloid/supervision/constants.rb

@@ -0,0 +1,123 @@
+module Celluloid
+  module Supervision
+    # TODO: Do not hard-code. Allow configurable values.
+    INSTANCE_RETRY_WAIT = 3
+    INSTANCE_RETRY_LIMIT = 5
+
+    module Error
+      class NoPublicService < StandardError; end
+    end
+
+    class Configuration
+      module Error
+        class AlreadyDefined < StandardError; end
+        class InvalidSupervisor < StandardError; end
+        class InvalidValues < StandardError; end
+        class Incomplete < StandardError; end
+        class Invalid < StandardError; end
+      end
+
+      # Using class variable so that parameters can be added by plugins.
+
+      @@parameters = {
+
+        mandatory: [:type],
+
+        optional: [
+          :as,
+          :args,
+          :block,
+        ],
+
+        # TODO: Move these into Behaviors.
+        plugins: [
+          # de :size,        # Supervision::Pool
+          # de :routers,     # Supervision::Coordinator
+          # de :supervises   # Supervision::Tree
+        ],
+
+        meta: [
+          :registry,
+          :branch,
+          :method,
+        ],
+      }
+
+      @@arity = {
+        type: :args,
+      }
+
+      @@aliases = {
+        name: :as,
+        kind: :type,
+        # de :pool => :size,   # TODO: Move into Behaviors.
+        # de :supervise => :supervises
+      }
+
+      @@defaults = {}
+
+      class << self
+        def save_defaults
+          @@defaults = {
+            parameters: @@parameters.inject({}) { |p, (k, v)| p[k] = v.dup; p },
+            aliases: @@aliases.dup,
+            arity: @@arity.dup,
+          }
+        end
+
+        def resync_parameters
+          @@parameters = @@defaults[:parameters].inject({}) { |p, (k, v)| p[k] = v.dup; p }
+          @@aliases = @@defaults[:aliases].dup
+          @@arity = @@defaults[:arity].dup
+        end
+
+        def parameters(*args)
+          args.inject([]) { |parameters, p| parameters += @@parameters[p]; parameters }
+        end
+
+        def parameter!(key, value)
+          @@parameters[key] << value unless @@parameters[key].include? value
+        end
+
+        def arity(*_args)
+          @@arity
+        end
+
+        def arity!(key, value)
+          @@arity[key] = value
+        end
+
+        def aliases
+          @@aliases
+        end
+
+        def alias!(aliased, original)
+          @@aliases[aliased] = original
+        end
+      end
+
+      save_defaults
+      resync_parameters
+
+      # This was originally added for `#pool` and `PoolManager
+      # `:before_initialize` was added to allow detecting `:size => N`
+      # and turning that into a pool. Other uses could be for `coordinator`
+      # appointing a `router` by detecting `:routers => N`, and many other uses.
+
+      ################ These are applied inside Supervision::Member ################
+
+      REMOVE_AT_EXPORT = [
+        :initialize,
+        :behavior,
+      ]
+
+      INJECTIONS = [
+        :configuration,
+        :before_initialization,
+        :after_initialization,
+        :before_start,
+        :before_restart,
+      ]
+    end
+  end
+end

data/lib/celluloid/supervision/container/behavior/tree.rb

@@ -0,0 +1,29 @@
+module Celluloid
+  module Supervision
+    class Container
+      #       class << self
+      #         def tree(actors=[], *args, &block)
+      #           blocks << lambda do |container|
+      #             container.tree(Configuration.options(args, :supervise => actors, :block => block ))
+      #           end
+      #         end
+      #       end
+
+      class Tree
+        include Behavior
+
+        identifier! :supervises, :supervise
+
+        configuration do
+          if @configuration[:supervise].is_a? Array
+            @supervisor = @configuration.dup
+            @branch = @configuration.fetch(:branch, @configuration[:as])
+            @configuration.delete(Behavior.parameter(:supervise, @configuration))
+          else
+            fail ArgumentError.new("No actors given to Tree to supervise.")
+          end
+        end
+      end
+    end
+  end
+end