celluloid_pubsub 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4ee6c97f0f5d1bcda519f4670ab5b885c4751bd
-  data.tar.gz: a996759005640ed3bd498cb8b20c0624e078253d
+  metadata.gz: 6aad68d75f135124f475c703d0950b1bc0b45e2c
+  data.tar.gz: 5e47b790b66d01dc32af3313ec54bb7ba09c8208
 SHA512:
-  metadata.gz: f09f7ac3c17117442b84efe1ba90a2d739e4228152d647eba7b31ed3c7caf5888f1a04038514aaf766d9d7944c573ef25023642ad07314f532c4f973969ee64e
-  data.tar.gz: 4778aa4bab829487290694cf2d4bd6b5f26ae5f307e60474e4c299d43c316f644988685ddef4f8455c906abe9ddd492db1c39790a8b1a8a52f8bb50b83407e08
+  metadata.gz: c33c34fab870f68825fd75b42917b556880172b7dbb64108f64a94ed1fcd067980e984715be8118d936fbdb999b105d03c8aa85c1bd26efe2093caa9f56f73bc
+  data.tar.gz: 885da36eee95bce09adb0c7e6644d8a53691c87b622355de60b9d94b98757ee14a87360ca48812ed757836e29762cf095c4bdec6585602cae58951e0a41badde

data/.reek

@@ -0,0 +1,11 @@
+---
+Attribute:
+  enabled: false
+TooManyInstanceVariables:
+  enabled: false
+TooManyMethods:
+  enabled: false
+UtilityFunction:
+  enabled: false
+exclude_paths:
+  - examples

data/.rubocop.yml

@@ -4,7 +4,11 @@ AllCops:
     - bin/**/*
     - Guardfile
     - vendor/**/*
+    - examples/**/*
 
+ClassLength:
+  Max: 500
+  
 Documentation:
   Enabled: true
 

data/Rakefile

@@ -10,13 +10,6 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.rspec_opts = ['--backtrace', '--fail-fast'] if ENV['DEBUG']
 end
 
-# desc "Prepare dummy application"
-# task :prepare do
-#  ENV["RAILS_ENV"] ||= 'test'
-#  require File.expand_path("./spec/dummy/config/environment", File.dirname(__FILE__))
-#  Dummy::Application.load_tasks
-#  Rake::Task["db:test:prepare"].invoke
-# end
 YARD::Config.options[:load_plugins] = true
 YARD::Config.load_plugins
 
@@ -26,31 +19,18 @@ YARD::Rake::YardocTask.new do |t|
   t.stats_options = ['--list-undoc'] # optional
 end
 
-unless ENV['TRAVIS']
-  require 'rvm-tester'
-  RVM::Tester::TesterTask.new(:suite) do |t|
-    t.rubies = %w(1.9.3 2.0.0 2.1.0) # which versions to test (required!)
-    t.bundle_install = true # updates Gemfile.lock, default is true
-    t.use_travis = true # looks for Rubies in .travis.yml (on by default)
-    t.command = 'bundle exec rake' # runs plain "rake" by default
-    t.env = { 'VERBOSE' => '1', 'RAILS_ENV' => 'test', 'RACK_ENV' => 'test' } # set any ENV vars
-    t.num_workers = 5 # defaults to 3
-    t.verbose = true # shows more output, off by default
-  end
-end
-
 desc 'Default: run the unit tests.'
 task default: [:all]
 
 desc 'Test the plugin under all supported Rails versions.'
 task :all do |_t|
   if ENV['TRAVIS']
-    exec(' bundle exec phare &&  bundle exec rake  spec && bundle exec rake coveralls:push')
+    exec(' bundle exec rubocop . &&  bundle exec rake  spec && bundle exec rake coveralls:push')
   else
-    exec('bundle exec rubocop -a . && bundle exec phare && bundle exec rake spec')
+    exec('bundle exec rubocop -a .  && bundle exec reek . && bundle exec rake spec')
   end
 end
 
 task :docs do
-  exec(' bundle exec rubocop -a .  && bundle exec phare  && bundle exec inch --pedantic && bundle exec yard')
+  exec(' bundle exec rubocop -a .  && bundle exec reek . && bundle exec inch --pedantic && bundle exec yard')
 end

data/celluloid_pubsub.gemspec

@@ -26,20 +26,16 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
 
   s.add_development_dependency 'rspec-rails', '~> 3.3', '>= 3.3'
-  s.add_development_dependency 'guard', '~> 2.13', '>= 2.13'
-  s.add_development_dependency 'guard-rspec', '~> 4.6', '>= 4.6'
   s.add_development_dependency 'simplecov', '~> 0.10', '>= 0.10'
   s.add_development_dependency 'simplecov-summary', '~> 0.0.4', '>= 0.0.4'
   s.add_development_dependency 'mocha', '~> 1.1', '>= 1.1'
   s.add_development_dependency 'coveralls', '~> 0.7', '>= 0.7'
-  s.add_development_dependency 'rvm-tester', '~> 1.1', '>= 1.1'
 
   s.add_development_dependency 'rubocop', '~> 0.33', '>= 0.33'
-  s.add_development_dependency 'phare', '~> 0.7', '>= 0.7'
+  s.add_development_dependency 'reek', '~> 3.8', '>= 3.8.1'
   s.add_development_dependency 'yard', '~> 0.8', '>= 0.8.7'
   s.add_development_dependency 'yard-rspec', '~> 0.1', '>= 0.1'
   s.add_development_dependency 'redcarpet', '~> 3.3', '>= 3.3'
   s.add_development_dependency 'github-markup', '~> 1.3', '>= 1.3.3'
   s.add_development_dependency 'inch', '~> 0.6', '>= 0.6'
-  s.add_development_dependency 'guard-inch', '~> 0.1', '>= 0.1.0'
 end

data/examples/redis_test.rb

@@ -1,2 +1,2 @@
-$use_redis = true
+ENV['USE_REDIS'] = 'true'
 require_relative './shared_classes'

data/examples/shared_classes.rb

@@ -3,27 +3,14 @@ require 'celluloid_pubsub'
 require 'logger'
 
 debug_enabled = ENV['DEBUG'].present? && ENV['DEBUG'].to_s == 'true'
+use_redis = ENV['USE_REDIS'].present? && ENV['USE_REDIS'].to_s == 'true'
+log_file_path = File.join(File.expand_path(File.dirname(__FILE__)), 'log', 'celluloid_pubsub.log')
 
-if debug_enabled == true
-  log_file_path = File.join(File.expand_path(File.dirname(__FILE__)), 'log', 'celluloid_pubsub.log')
-  puts log_file_path
-  FileUtils.mkdir_p(File.dirname(log_file_path))
-  log_file = File.open(log_file_path, 'w')
-  log_file.sync = true
-  Celluloid.logger = ::Logger.new(log_file_path)
-  Celluloid.task_class = Celluloid::TaskThread
-  Celluloid.exception_handler do |ex|
-    unless ex.is_a?(Interrupt)
-      puts ex
-    end
-  end
-end
 
 # actor that subscribes to a channel
 class Subscriber
   include Celluloid
   include Celluloid::Logger
-  finalizer :shutdown
 
   def initialize(options = {})
     @client = CelluloidPubsub::Client.new({ actor: Actor.current, channel: 'test_channel' }.merge(options))
@@ -35,7 +22,6 @@ class Subscriber
       @client.publish('test_channel2', 'data' => ' subscriber got successfull subscription') # the message needs to be a Hash
     else
       puts "subscriber got message #{message.inspect}"
-      @client.unsubscribe('test_channel')
     end
   end
 
@@ -43,48 +29,43 @@ class Subscriber
     puts "websocket connection closed: #{code.inspect}, #{reason.inspect}"
     terminate
   end
-  def shutdown
-    debug "#{self.class} tries to 'shudown'"
-    terminate
-  end
+
+
 end
 
 # actor that publishes a message in a channel
 class Publisher
   include Celluloid
   include Celluloid::Logger
-  finalizer :shutdown
 
   def initialize(options = {})
     @client = CelluloidPubsub::Client.new({ actor: Actor.current, channel: 'test_channel2' }.merge(options))
   end
 
   def on_message(message)
-    puts " publisher got #{message.inspect}"
-    @client.publish('test_channel', 'data' => 'my_message') # the message needs to be a Hash
-    @client.unsubscribe('test_channel2')
+    if @client.succesfull_subscription?(message)
+      puts "publisher got successful subscription #{message.inspect}"
+      @client.publish('test_channel', 'data' => ' my_message') # the message needs to be a Hash
+    else
+      puts "publisher got message #{message.inspect}"
+    end
   end
 
   def on_close(code, reason)
     puts "websocket connection closed: #{code.inspect}, #{reason.inspect}"
     terminate
   end
-  def shutdown
-    debug "#{self.class} tries to 'shudown'"
-    terminate
-  end
+
 end
 
-CelluloidPubsub::WebServer.supervise_as(:web_server, enable_debug: debug_enabled, use_redis: $use_redis)
+
+CelluloidPubsub::WebServer.supervise_as(:web_server, enable_debug: debug_enabled, use_redis: use_redis,log_file_path: log_file_path )
 Subscriber.supervise_as(:subscriber, enable_debug: debug_enabled)
 Publisher.supervise_as(:publisher, enable_debug: debug_enabled)
 signal_received = false
 
-at_exit do
-  Celluloid.shutdown
-end
 Signal.trap('INT') do
-  puts "\nAn interrupt signal is happening!"
+  puts "\nAn interrupt signal has been triggered!"
   signal_received = true
 end
 

data/examples/simple_test.rb

@@ -1,2 +1,2 @@
-$use_redis = false
+ENV['USE_REDIS'] = 'false'
 require_relative './shared_classes'

data/lib/celluloid_pubsub/client.rb

@@ -1,3 +1,4 @@
+require_relative './helper'
 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
@@ -9,8 +10,8 @@ module CelluloidPubsub
   # @!attribute connect_blk
   #   @return [Proc] Block  that will execute after the connection is opened
   #
-  # @!attribute client
-  #   @return [Celluloid::WebSocket::Client] A websocket client that is used to chat witht the webserver
+  # @!attribute connection
+  #   @return [Celluloid::WebSocket::Client] A websocket connection that is used to chat witht the webserver
   #
   # @!attribute options
   #   @return [Hash] the options that can be used to connect to webser and send additional data
@@ -26,7 +27,9 @@ module CelluloidPubsub
   class Client
     include Celluloid
     include Celluloid::Logger
-    attr_accessor :actor, :client, :options, :hostname, :port, :path, :channel
+    include CelluloidPubsub::Helper
+
+    attr_reader :actor, :connection, :options, :hostname, :port, :path, :channel
     finalizer :shutdown
     #  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
@@ -43,44 +46,61 @@ module CelluloidPubsub
     #
     # @api public
     def initialize(options)
-      parse_options(options)
+      @options = options.stringify_keys!
+      @actor ||= @options.fetch('actor', nil)
+      @channel ||= @options.fetch('channel', nil)
       raise "#{self}: Please provide an actor in the options list!!!" if @actor.blank?
       raise "#{self}: Please provide an channel in the options list!!!" if @channel.blank?
-      @actor.link Actor.current if @actor.respond_to?(:link)
-      @client = Celluloid::WebSocket::Client.new("ws://#{@hostname}:#{@port}#{@path}", Actor.current)
-      Actor.current.link @client
+      supervise_actors
+      setup_celluloid_logger
     end
 
-    # the method will terminate the current actor
-    #
+    def log_file_path
+      @log_file_path ||= @options.fetch('log_file_path', nil)
+    end
+
+    # the method will link the current actor to the actor that is attached to, and the connection to the current actor
     #
     # @return [void]
     #
     # @api public
-    def shutdown
-      debug "#{self.class} tries to 'shudown'" if debug_enabled?
-      terminate
+    def supervise_actors
+      current_actor = Actor.current
+      @actor.link current_actor if @actor.respond_to?(:link)
+      current_actor.link connection
     end
 
-    # check the options list for values and sets default values if not found
+    # the method will return the client that is used to
+    #
+    #
+    # @return [Celluloid::WebSocket::Client] the websocket connection used to connect to server
+    #
+    # @api public
+    def connection
+      @connection ||= Celluloid::WebSocket::Client.new("ws://#{hostname}:#{port}#{path}", Actor.current)
+    end
+
+    def hostname
+      @hostname ||= @options.fetch('hostname', CelluloidPubsub::WebServer::HOST)
+    end
+
+    def port
+      @port ||= @options.fetch('port', CelluloidPubsub::WebServer::PORT)
+    end
+
+    def path
+      @path ||= @options.fetch('path', CelluloidPubsub::WebServer::PATH)
+    end
+
+    # the method will terminate the current actor
     #
-    # @param  [Hash]  options the options that can be used to connect to webser and send additional data
-    # @option options [String] :actor The actor that made the connection
-    # @option options [String]:hostname The hostname on which the webserver runs on
-    # @option options [String] :port The port on which the webserver runs on
-    # @option options [String] :path The request path that the webserver accepts
     #
     # @return [void]
     #
     # @api public
-    def parse_options(options)
-      raise 'Options is not a hash' unless options.is_a?(Hash)
-      @options = options.stringify_keys!
-      @actor = @options.fetch('actor', nil)
-      @channel = @options.fetch('channel', nil)
-      @hostname = @options.fetch('hostname', CelluloidPubsub::WebServer::HOST)
-      @port = @options.fetch('port', CelluloidPubsub::WebServer::PORT)
-      @path = @options.fetch('path', CelluloidPubsub::WebServer::PATH)
+    def shutdown
+      log_debug "#{self.class} tries to 'shudown'"
+      terminate
     end
 
     #  checks if debug is enabled
@@ -101,21 +121,10 @@ module CelluloidPubsub
     #
     # @api public
     def subscribe(channel)
-      debug("#{@actor.class} tries to subscribe to channel  #{channel}") if debug_enabled?
+      log_debug("#{@actor.class} tries to subscribe to channel  #{channel}")
       async.send_action('subscribe', channel)
     end
 
-    # checks if the message has the successfull subscription action
-    #
-    # @param [string] message
-    #
-    # @return [void]
-    #
-    # @api public
-    def succesfull_subscription?(message)
-      message.present? && message['client_action'].present? && message['client_action'] == 'successful_subscription'
-    end
-
     # publishes to a channel some data (can be anything)
     #
     # @param [string] channel
@@ -165,10 +174,14 @@ module CelluloidPubsub
     #
     # @api public
     def on_open
-      debug("#{@actor.class} websocket connection opened") if debug_enabled?
+      log_debug("#{@actor.class} websocket connection opened")
       async.subscribe(@channel)
     end
 
+    def log_debug(message)
+      debug message if debug_enabled?
+    end
+
     # callback executes when actor receives a message from a subscribed channel
     # and parses the message using JSON.parse and dispatches the parsed
     # message to the original actor that made the connection
@@ -179,9 +192,8 @@ module CelluloidPubsub
     #
     # @api public
     def on_message(data)
-      debug("#{@actor.class} received  plain #{data}") if debug_enabled?
       message = JSON.parse(data)
-      debug("#{@actor.class} received JSON  #{message}") if debug_enabled?
+      log_debug("#{@actor.class} received JSON  #{message}")
       @actor.async.on_message(message)
     end
 
@@ -195,9 +207,9 @@ module CelluloidPubsub
     #
     # @api public
     def on_close(code, reason)
-      @client.terminate
+      connection.terminate
       terminate
-      debug("#{@actor.class} dispatching on close  #{code} #{reason}") if debug_enabled?
+      log_debug("#{@actor.class} dispatching on close  #{code} #{reason}")
       @actor.async.on_close(code, reason)
     end
 
@@ -213,9 +225,8 @@ module CelluloidPubsub
     #
     # @api private
     def send_action(action, channel = nil, data = {})
-      publishing_data = { 'client_action' => action }
-      publishing_data = publishing_data.merge('channel' => channel) if channel.present?
-      publishing_data = publishing_data.merge('data' => data) if data.present?
+      data = data.is_a?(Hash) ? data : {}
+      publishing_data = { 'client_action' => action, 'channel' => channel, 'data' => data }.reject { |_key, value| value.blank? }
       async.chat(publishing_data)
     end
 
@@ -232,12 +243,11 @@ module CelluloidPubsub
       final_message = nil
       if message.is_a?(Hash)
         final_message = message.to_json
-        debug("#{@actor.class} sends #{message.to_json}") if debug_enabled?
       else
         final_message = JSON.dump(action: 'message', message: message)
-        debug("#{@actor.class} sends JSON  #{final_message}") if debug_enabled?
       end
-      @client.text final_message
+      log_debug("#{@actor.class} sends JSON #{final_message}")
+      connection.text final_message
     end
   end
 end

data/lib/celluloid_pubsub/helper.rb

@@ -0,0 +1,64 @@
+module CelluloidPubsub
+  # class that holds the options that are configurable for this gem
+  module Helper
+    # checks if the message has the successfull subscription action
+    #
+    # @param [string] message
+    #
+    # @return [void]
+    #
+    # @api public
+    def succesfull_subscription?(message)
+      message.is_a?(Hash) && message['client_action'] == 'successful_subscription'
+    end
+
+  module_function
+
+    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)
+      setup_celluloid_exception_handler
+    end
+
+    def setup_celluloid_exception_handler
+      Celluloid.task_class = Celluloid::TaskThread
+      Celluloid.exception_handler do |ex|
+        puts ex unless filtered_error?(ex)
+      end
+    end
+
+    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.sync = true
+    end
+
+    def filtered_error?(error)
+      [Interrupt].any? { |class_name| error.is_a?(class_name) }
+    end
+
+    #  receives a list of options that are used to configure the webserver
+    #
+    # @param  [Hash]  options the options that can be used to connect to webser and send additional data
+    # @option options [String]:hostname The hostname on which the webserver runs on
+    # @option options [Integer] :port The port on which the webserver runs on
+    # @option options [String] :path The request path that the webserver accepts
+    # @option options [Boolean] :spy Enable this only if you want to enable debugging for the webserver
+    # @option options [Integer]:backlog How many connections the server accepts
+    #
+    # @return [void]
+    #
+    # @api public
+    def parse_options(options)
+      options = options.is_a?(Array) ? options.first : options
+      options = options.is_a?(Hash) ? options.stringify_keys : {}
+      options
+    end
+
+    def log_debug(message)
+      debug message if respond_to?(:debug_enabled?) && debug_enabled?
+    end
+  end
+end