celluloid_pubsub 1.1.2 → 2.0.0

data/gemfiles/{celluloid_0.17.3.gemfile → cell_0.17.3.gemfile}

@@ -4,4 +4,4 @@ source "http://rubygems.org"
 
 gem "celluloid", "0.17.3"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/{celluloid_0.18.0.pre.gemfile → cell_0.17.4.gemfile}

@@ -2,6 +2,6 @@
 
 source "http://rubygems.org"
 
-gem "celluloid", "0.18.0.pre"
+gem "celluloid", "0.17.4"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/cell_0.18.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "celluloid", "0.18.0"
+
+gemspec path: "../"

data/init.rb

@@ -1,3 +1,4 @@
 # encoding: utf-8
 # frozen_string_literal: true
+
 require 'celluloid_pubsub'

data/lib/celluloid_pubsub.rb

@@ -1,15 +1,16 @@
 # encoding: utf-8
 # frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 require 'bundler/setup'
 require 'celluloid/io'
-require 'reel'
 require 'celluloid/websocket/client'
 require 'active_support/all'
 require 'json'
 require 'thread'
 require 'celluloid/pmap'
 require 'celluloid_pubsub/base_actor'
+require 'reel'
 Gem.find_files('celluloid_pubsub/initializers/**/*.rb').each { |path| require path }
 Gem.find_files('celluloid_pubsub/**/*.rb').each { |path| require path }

data/lib/celluloid_pubsub/base_actor.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 # frozen_string_literal: true
+
 require_relative './helper'
 module CelluloidPubsub
   # base actor used for compatibility between celluloid versions
@@ -39,6 +40,7 @@ module CelluloidPubsub
       # @return [Class] returns the logger class from celluloid depending on version
       #
       # @api public
+      # :nocov:
       def celluloid_logger_class
         if version_less_than_seventeen?
           Celluloid::Logger
@@ -46,6 +48,7 @@ module CelluloidPubsub
           Celluloid::Internals::Logger
         end
       end
+      # :nocov:
 
       # returns the celluloid version loaded
       # @return [String] returns the celluloid version loaded
@@ -63,12 +66,34 @@ module CelluloidPubsub
         verify_gem_version(celluloid_version, '0.17', operator: '<')
       end
 
+      # returns true if celluloid version less than 0.18, otherwise false
+      # @return [Boolean] returns true if celluloid version less than 0.17, otherwise false
+      #
+      # @api public
+      def version_less_than_eigthteen?
+        verify_gem_version(celluloid_version, '0.18', operator: '<')
+      end
+
+      # tries to boot up Celluloid if it is not running
+      # @return [Boolean] returns true if Celluloid started false otherwise
+      #
+      # @api public
+      def boot_up
+        celluloid_running = begin
+          Celluloid.running?
+        rescue StandardError
+          false
+        end
+        Celluloid.boot unless celluloid_running
+      end
+
       # sets up the actor supervision based on celluloid version
       # @param [Class] class_name The class that will be used to supervise the actor
       # @param [Hash] options Additional options needed for supervision
       # @return [void]
       #
       # @api public
+      # :nocov:
       def setup_actor_supervision(class_name, options)
         actor_name, args = options.slice(:actor_name, :args).values
         if version_less_than_seventeen?
@@ -77,17 +102,24 @@ module CelluloidPubsub
           class_name.supervise(as: actor_name, args: [args].compact)
         end
       end
+      # :nocov:
     end
   end
 end
 
-
+# :nocov:
 if CelluloidPubsub::BaseActor.version_less_than_seventeen?
   require 'celluloid'
   require 'celluloid/autostart'
-else
+elsif CelluloidPubsub::BaseActor.version_less_than_eigthteen?
   require 'celluloid/current'
-  celluloid_running = Celluloid.running? rescue false
-   Celluloid.boot unless celluloid_running
+  CelluloidPubsub::BaseActor.boot_up
+  require 'celluloid'
+else
   require 'celluloid'
+  require 'celluloid/pool'
+  require 'celluloid/fsm'
+  require 'celluloid/supervision'
+  CelluloidPubsub::BaseActor.boot_up
 end
+# :nocov:

data/lib/celluloid_pubsub/client.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 # frozen_string_literal: true
+
 require_relative './helper'
+require_relative './client_connection'
 module CelluloidPubsub
   # worker that subscribes to a channel or publishes to a channel
   # if it used to subscribe to a channel the worker will dispatch the messages to the actor that made the
@@ -30,6 +32,7 @@ module CelluloidPubsub
     attr_accessor :channel
 
     finalizer :shutdown
+    trap_exit :actor_died
     #  receives a list of options that are used to connect to the webserver and an actor to which the callbacks are delegated to
     #  when receiving messages from a channel
     #
@@ -48,9 +51,21 @@ module CelluloidPubsub
       @options = options.stringify_keys!
       @actor ||= @options.fetch('actor', nil)
       @channel ||= @options.fetch('channel', nil)
+      @shutting_down = false
       raise "#{self}: Please provide an actor in the options list!!!" if @actor.blank?
-      supervise_actors
       setup_celluloid_logger
+      log_debug "#{@actor.class} starting on #{hostname}:#{port}"
+      supervise_actors
+    end
+
+    # the method will return true if the actor is shutting down
+    #
+    #
+    # @return [Boolean] returns true if the actor is shutting down
+    #
+    # @api public
+    def shutting_down?
+      @shutting_down == true
     end
 
     # the method will return the path to the log file where debug messages will be printed
@@ -62,6 +77,15 @@ module CelluloidPubsub
       @log_file_path ||= @options.fetch('log_file_path', nil)
     end
 
+    # the method will return the log level of the logger
+    #
+    # @return [Integer, nil] return the log level used by the logger ( default is 1 - info)
+    #
+    # @api public
+    def log_level
+      @log_level ||= @options['log_level'] || ::Logger::Severity::INFO
+    end
+
     # the method will link the current actor to the actor that is attached to, and the connection to the current actor
     #
     # @return [void]
@@ -80,7 +104,7 @@ module CelluloidPubsub
     #
     # @api public
     def connection
-      @connection ||= Celluloid::WebSocket::Client.new("ws://#{hostname}:#{port}#{path}", Actor.current)
+      @connection ||= CelluloidPubsub::ClientConnection.new("ws://#{hostname}:#{port}#{path}", Actor.current)
     end
 
     # the method will return the hostname of the server
@@ -120,7 +144,8 @@ module CelluloidPubsub
     #
     # @api public
     def shutdown
-      log_debug "#{self.class} tries to 'shudown'"
+      @shutting_down = true
+      log_debug "#{self.class} tries to 'shutdown'"
       terminate
     end
 
@@ -228,17 +253,19 @@ module CelluloidPubsub
     #
     # @api public
     def on_close(code, reason)
-      connection.terminate
-      terminate
-      log_debug("#{@actor.class} dispatching on close  #{code} #{reason}")
+      log_debug("#{self.class} dispatching on close  #{code} #{reason}")
       if @actor.respond_to?(:async)
         @actor.async.on_close(code, reason)
       else
         @actor.on_close(code, reason)
       end
+    ensure
+      log_debug("#{self.class} closing the connection on close and terminating")
+      connection.terminate unless actor_dead?(connection)
+      terminate
     end
 
-  private
+    private
 
     # method used to send an action to the webserver reactor , to a chanel and with data
     #
@@ -269,5 +296,18 @@ module CelluloidPubsub
       log_debug("#{@actor.class} sends JSON #{final_message}")
       connection.text final_message
     end
+
+    # method called when the actor is exiting
+    #
+    # @param [actor] actor - the current actor
+    # @param [Hash] reason - the reason it crashed
+    #
+    # @return [void]
+    #
+    # @api public
+    def actor_died(actor, reason)
+      @shutting_down = true
+      log_debug "Oh no! #{actor.inspect} has died because of a #{reason.class}"
+    end
   end
 end

data/lib/celluloid_pubsub/client_connection.rb

@@ -0,0 +1,57 @@
+require 'celluloid/websocket/client/connection'
+require 'websocket/driver'
+require_relative './helper'
+module CelluloidPubsub
+  class ClientConnection < ::Celluloid::WebSocket::Client::Connection
+    include CelluloidPubsub::Helper
+
+    finalizer :shutdown
+    trap_exit :actor_died
+
+    def initialize(url, handler)
+      @shutting_down = false
+      super(url, handler)
+    end
+
+    def run
+      super
+    rescue EOFError, Errno::ECONNRESET, StandardError
+      @client.emit(:close, ::WebSocket::Driver::CloseEvent.new(1001, 'server closed connection'))
+    end
+
+    # the method will return true if the actor is shutting down
+    #
+    #
+    # @return [Boolean] returns true if the actor is shutting down
+    #
+    # @api public
+    def shutting_down?
+      @shutting_down == true
+    end
+
+    # the method will terminate the current actor
+    #
+    #
+    # @return [void]
+    #
+    # @api public
+    def shutdown
+      @shutting_down = true
+      log_debug "#{self.class} tries to 'shutdown'"
+      terminate
+    end
+
+    # method called when the actor is exiting
+    #
+    # @param [actor] actor - the current actor
+    # @param [Hash] reason - the reason it crashed
+    #
+    # @return [void]
+    #
+    # @api public
+    def actor_died(actor, reason)
+      @shutting_down = true
+      log_debug "Oh no! #{actor.inspect} has died because of a #{reason.class}"
+    end
+  end
+end

data/lib/celluloid_pubsub/gem_version_parser.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module CelluloidPubsub
   # class used for parsing gem versions
   # @!attribute [r] version
@@ -7,8 +8,7 @@ module CelluloidPubsub
   # @!attribute [r] options
   #   @return [Hash] The additional options for parsing the version
   class GemVersionParser
-    attr_reader :version
-    attr_reader :options
+    attr_reader :version, :options
 
     #  receives the version and the additional options
     #

data/lib/celluloid_pubsub/helper.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 # frozen_string_literal: true
+
 require_relative './gem_version_parser'
 module CelluloidPubsub
   # class that holds the options that are configurable for this gem
@@ -15,7 +16,39 @@ module CelluloidPubsub
       message.is_a?(Hash) && message['client_action'] == 'successful_subscription'
     end
 
-  module_function
+    # the method try to decide if an actor is dead
+    # In Celluloid 0.18 there is no `dead?` method anymore
+    #  So we are trying to be backward-compatible with older versions
+    #
+    # @param [Celluloid::Actor] actor
+    # @return [Boolean] returns true if the actor is dead, otherwise false
+    #
+    # @api public
+    def actor_dead?(actor)
+      raise actor.class.inspect if !actor.respond_to?(:dead?) && !actor.respond_to?(:alive?)
+      (actor.respond_to?(:dead?) && actor.dead?) ||
+        (actor.respond_to?(:alive?) && !actor.alive?)
+    end
+
+    # returns the instance of the class that includes the actor, this is useful in tests
+    #
+    # @return [Object] returns the object
+    #
+    # @api public
+    def own_self
+      self
+    end
+
+    # returns the current actor
+    #
+    # @return [::Celluloid::Actor] returns the current actor
+    #
+    # @api public
+    def cell_actor
+      ::Celluloid::Actor.current
+    end
+
+    module_function
 
     # returns the gem's property from its speification or nil
     # @param [String] name the name of the gem
@@ -91,36 +124,48 @@ module CelluloidPubsub
     # @return [void]
     #
     # @api private
+    # :nocov:
     def setup_celluloid_logger
       return if !debug_enabled? || (respond_to?(:log_file_path) && log_file_path.blank?)
       setup_log_file
-      Celluloid.logger = ::Logger.new(log_file_path.present? ? log_file_path : STDOUT)
+      Celluloid.logger = ::Logger.new(log_file_path).tap do |logger|
+        logger.level = respond_to?(:log_level) ? log_level : ::Logger::Severity::INFO
+      end
       setup_celluloid_exception_handler
     end
+    # :nocov:
 
     # sets the celluloid exception handler
     #
     # @return [void]
     #
     # @api private
+    # :nocov:
     def setup_celluloid_exception_handler
       Celluloid.task_class = defined?(Celluloid::TaskThread) ? Celluloid::TaskThread : Celluloid::Task::Threaded
       Celluloid.exception_handler do |ex|
-        puts ex unless filtered_error?(ex)
+        unless filtered_error?(ex)
+          puts ex
+          puts ex.backtrace
+          puts ex.cause
+        end
       end
     end
+    # :nocov:
 
     # creates the log file where the debug messages will be printed
     #
     # @return [void]
     #
     # @api private
+    # :nocov:
     def setup_log_file
       return if !debug_enabled? || (respond_to?(:log_file_path) && log_file_path.blank?)
       FileUtils.mkdir_p(File.dirname(log_file_path)) unless File.directory?(log_file_path)
-      log_file = File.open(log_file_path, 'w')
+      log_file = File.open(log_file_path, 'wb')
       log_file.sync = true
     end
+    # :nocov:
 
     # checks if a given error needs to be filtered
     #
@@ -143,9 +188,8 @@ module CelluloidPubsub
     #
     # @api private
     def parse_options(options)
-      options = options.is_a?(Array) ? options.first : options
-      options = options.is_a?(Hash) ? options.stringify_keys : {}
-      options
+      options = options.is_a?(Array) ? options.last : options
+      options.is_a?(Hash) ? options.deep_stringify_keys : {}
     end
 
     #  receives a message, and logs it to the log file if debug is enabled
@@ -155,8 +199,12 @@ module CelluloidPubsub
     # @return [void]
     #
     # @api private
+    # :nocov:
     def log_debug(message)
-      debug message if respond_to?(:debug_enabled?) && debug_enabled?
+      return unless respond_to?(:debug_enabled?)
+      return if Celluloid.logger.blank? || !debug_enabled?
+      Celluloid.logger.debug(message)
     end
+    # :nocov:
   end
 end