reactor 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca073addd79592f3fc3030cfb308b9790f772f56
-  data.tar.gz: b6bdfb4341a2bb713a118764e4584d418c882469
+  metadata.gz: e47dd61c52db1bfaa846f2fbb50876b081a1c60b
+  data.tar.gz: 917e730109e0f193c63706ba55025d2ebb877ee3
 SHA512:
-  metadata.gz: 31e70511c4102b306ab4cf76b7ae5e3e85a93c0586eecf3d985e1748b1b10aadbce653f056c4a9f35cc2db7be2c26799584e83730b240d3601785454b57af69f
-  data.tar.gz: 10f3d2bb4624af3eceef841ec5c714866ab648cf578a464117d2c71d137e0e4c8feca7f1334ddafc6f852be7bd90f8ff31bb32bade1faa1fa0ce909f066735cc
+  metadata.gz: 10185cdd733e3d93292dc9a94f48a35a100411f030dfa4e7d47f687fe794cb659e77d57ae0ad287daa367b203fe6230621430c8292e8aa3abf933cbee8856c00
+  data.tar.gz: 6687577b3635233ba535a8ada13ab83446c6a90a2273d44157717ac48d9faceafb161913ca6cab4fac56fce158c2996f8f9d67c0f37972c69967b66d993607ca

data/Changes.md

@@ -0,0 +1,13 @@
+# Reactor Change Log
+
+0.11.0
+-----------
+Static Subscriber class names have changed to be more deterministic. THIS _MAY BE_ A BREAKING CHANGE.
+See https://github.com/hired/reactor/issues/40 for background info.
+
+Previously, when you added an `on_event :foo` block to an object, say `MyObject`, Reactor would dynamically generate a Sidekiq worker class named `Reactor::StaticSubscribers::FooHandler0`.
+
+In 0.11.0, the naming of this dynamically generated worker class has changed to `Reactor::StaticSubscribers::MyObject::FooHandler`.
+If you require more than one `on_event` block for the same event, you must name the handler so that it is unique and deterministic: i.e. `on_event :foo, handler_name: :do_better` otherwise an exception will be raised at load time.
+
+Because the worker class names are changing, when deploying this change it's important that your Sidekiq queue not have any pending jobs with the old naming scheme, otherwise they will fail to deserialize!

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    reactor (0.10.1)
+    reactor (0.11.0)
       activerecord (< 5.0)
       sidekiq
 

data/lib/reactor/models/concerns/subscribable.rb

@@ -1,25 +1,38 @@
 module Reactor::Subscribable
   extend ActiveSupport::Concern
 
+  class EventHandlerAlreadyDefined < StandardError ; end
+
   module ClassMethods
     def on_event(*args, &block)
       options = args.extract_options!
       event, method = args
-      (Reactor::SUBSCRIBERS[event.to_s] ||= []).push(StaticSubscriberFactory.create(event, method, {source: self}.merge(options), &block))
+      (Reactor::SUBSCRIBERS[event.to_s] ||= []).push(create_static_subscriber(event, method, options, &block))
     end
-  end
 
-  class StaticSubscriberFactory
+    private
+
+    def create_static_subscriber(event, method = nil, options = {}, &block)
+      worker_class = build_worker_class
+
+      name_worker_class worker_class, handler_name(event, options[:handler_name])
+
+      worker_class.tap do |k|
+        k.source = self
+        k.method = method || block
+        k.delay = options[:delay] || 0
+        k.in_memory = options[:in_memory]
+        k.dont_perform = Reactor.test_mode?
+      end
+    end
 
-    def self.create(event, method = nil, options = {}, &block)
-      handler_class_prefix = event == '*' ? 'Wildcard': event.to_s.camelize
-      i = 0
-      begin
-        new_class = "#{handler_class_prefix}Handler#{i}"
-        i+= 1
-      end while Reactor::StaticSubscribers.const_defined?(new_class)
+    def handler_name(event, handler_name_option = nil)
+      return handler_name_option.to_s.camelize if handler_name_option
+      "#{event == '*' ? 'Wildcard': event.to_s.camelize}Handler"
+    end
 
-      klass = Class.new do
+    def build_worker_class
+      Class.new do
         include Sidekiq::Worker
 
         class_attribute :method, :delay, :source, :in_memory, :dont_perform
@@ -42,16 +55,24 @@ module Reactor::Subscribable
           end
         end
       end
+    end
 
-      Reactor::StaticSubscribers.const_set(new_class, klass)
+    def name_worker_class(klass, handler_name)
+      if static_subscriber_namespace.const_defined?(handler_name)
+        raise EventHandlerAlreadyDefined.new(
+          "A Reactor event named #{handler_name} already has been defined on #{static_subscriber_namespace}.
+           Specify a `:handler_name` option on your subscriber's `on_event` declaration to name this event handler deterministically."
+        )
+      end
+      static_subscriber_namespace.const_set(handler_name, klass)
+    end
 
-      klass.tap do |k|
-        k.method = method || block
-        k.delay = options[:delay] || 0
-        k.source = options[:source]
-        k.in_memory = options[:in_memory]
-        k.dont_perform = Reactor.test_mode?
+    def static_subscriber_namespace
+      unless Reactor::StaticSubscribers.const_defined?(self.name, false)
+        Reactor::StaticSubscribers.const_set(self.name, Module.new)
       end
+
+      Reactor::StaticSubscribers.const_get(self.name, false)
     end
   end
 end

data/lib/reactor/version.rb

@@ -1,3 +1,3 @@
 module Reactor
-  VERSION = "0.10.1"
+  VERSION = "0.11.0"
 end

data/spec/event_spec.rb

@@ -9,6 +9,15 @@ module MyModule
 end
 
 class ArbitraryModel < ActiveRecord::Base
+
+  on_event :barfed, handler_name: :bad do
+    raise 'UNEXPECTED!'
+  end
+
+  on_event :barfed do
+    'that was gross'
+  end
+
 end
 
 class OtherWorker
@@ -55,19 +64,8 @@ describe Reactor::Event do
     end
 
     describe 'when subscriber throws exception', :sidekiq do
-      let(:mock) { double(:thing, some_method: 3) }
       let(:barfing_event) { Reactor::Event.perform('barfed', somethin: 'up', actor_id: model.id.to_s, actor_type: model.class.to_s) }
 
-      before do
-        Reactor::SUBSCRIBERS['barfed'] ||= []
-        Reactor::SUBSCRIBERS['barfed'] << Reactor::Subscribable::StaticSubscriberFactory.create('barfed') do |event|
-          raise 'UNEXPECTED!'
-        end
-        Reactor::SUBSCRIBERS['barfed'] << Reactor::Subscribable::StaticSubscriberFactory.create('barfed') do |event|
-          mock.some_method
-        end
-      end
-
       it 'doesnt matter because it runs in a separate worker process' do
         expect { barfing_event }.to_not raise_exception
       end

data/spec/models/concerns/subscribable_spec.rb

@@ -6,7 +6,9 @@ class Auction < ActiveRecord::Base
   end
 
   on_event :puppy_delivered, :ring_bell
-  on_event :puppy_delivered, -> (event) { }
+  on_event :puppy_delivered, handler_name: :do_nothing_handler do |event|
+
+  end
   on_event :any_event, -> (event) {  puppies! }
   on_event :pooped, :pick_up_poop, delay: 5.minutes
   on_event '*' do |event|
@@ -40,8 +42,8 @@ describe Reactor::Subscribable do
 
     describe 'building uniquely named subscriber handler classes' do
       it 'adds a static subscriber to the global lookup constant' do
-        expect(Reactor::SUBSCRIBERS['puppy_delivered'][0]).to eq(Reactor::StaticSubscribers::PuppyDeliveredHandler0)
-        expect(Reactor::SUBSCRIBERS['puppy_delivered'][1]).to eq(Reactor::StaticSubscribers::PuppyDeliveredHandler1)
+        expect(Reactor::SUBSCRIBERS['puppy_delivered'][0]).to eq(Reactor::StaticSubscribers::Auction::PuppyDeliveredHandler)
+        expect(Reactor::SUBSCRIBERS['puppy_delivered'][1]).to eq(Reactor::StaticSubscribers::Auction::DoNothingHandler)
       end
     end
 
@@ -71,25 +73,25 @@ describe Reactor::Subscribable do
     describe 'in_memory flag' do
       it 'doesnt fire perform_async when true' do
         expect(Auction).to receive(:puppies!)
-        expect(Reactor::StaticSubscribers::CatDeliveredHandler0).not_to receive(:perform_async)
+        expect(Reactor::StaticSubscribers::Auction::CatDeliveredHandler).not_to receive(:perform_async)
         Reactor::Event.publish(:cat_delivered)
       end
 
       it 'fires perform_async when falsey' do
-        expect(Reactor::StaticSubscribers::WildcardHandler0).to receive(:perform_async)
+        expect(Reactor::StaticSubscribers::Auction::WildcardHandler).to receive(:perform_async)
         Reactor::Event.publish(:puppy_delivered)
       end
     end
 
     describe '#perform' do
       it 'returns :__perform_aborted__ when Reactor is in test mode' do
-        expect(Reactor::StaticSubscribers::TestPuppyDeliveredHandler0.new.perform({})).to eq(:__perform_aborted__)
+        expect(Reactor::StaticSubscribers::TestModeAuction::TestPuppyDeliveredHandler.new.perform({})).to eq(:__perform_aborted__)
         Reactor::Event.publish(:test_puppy_delivered)
       end
 
       it 'performs normally when specifically enabled' do
         Reactor.enable_test_mode_subscriber(TestModeAuction)
-        expect(Reactor::StaticSubscribers::TestPuppyDeliveredHandler0.new.perform({})).not_to eq(:__perform_aborted__)
+        expect(Reactor::StaticSubscribers::TestModeAuction::TestPuppyDeliveredHandler.new.perform({})).not_to eq(:__perform_aborted__)
         Reactor::Event.publish(:test_puppy_delivered)
       end
     end

data/spec/reactor_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
+Reactor.in_test_mode do
+  class SomeClass
+    include Reactor::Subscribable
+    on_event :test_event, -> (event) { self.spy_on_me }
+  end
+end
 
 describe Reactor do
-  let(:subscriber) do
-    Reactor.in_test_mode do
-      Class.new(ActiveRecord::Base) do
-        on_event :test_event, -> (event) { self.spy_on_me }
-      end
-    end
-  end
+  let(:subscriber) { SomeClass }
 
   describe '.test_mode!' do
     it 'sets Reactor into test mode' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reactor
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - winfred
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -167,6 +167,7 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- Changes.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt