reactor 0.13.0 → 0.14.0

data/spec/models/concerns/subscribable_spec.rb

@@ -35,6 +35,29 @@ module MyNamespace
   end
 end
 
+class KittenMailer < ActionMailer::Base
+
+  include Reactor::Subscribable
+
+  on_event :auction, handler_name: 'auction' do |event|
+    raise "Event auction"
+  end
+
+  on_event :kitten_streaming do |event|
+    kitten_livestream(event)
+  end
+
+  def kitten_livestream(event)
+    mail(
+      to: 'admin@kittens.com',
+      from: 'test@kittens.com',
+      subject: 'Livestreaming kitten videos'
+    ) do |format|
+      format.text { 'Your favorite kittens are now live!' }
+    end
+  end
+end
+
 Reactor.in_test_mode do
   class TestModeAuction < ActiveRecord::Base
     on_event :test_puppy_delivered, -> (event) { "success" }
@@ -43,9 +66,12 @@ end
 
 describe Reactor::Subscribable do
   let(:scheduled) { Sidekiq::ScheduledSet.new }
-  before { Reactor::TEST_MODE_SUBSCRIBERS.clear }
 
   describe 'on_event' do
+    before do
+      Reactor.enable_test_mode_subscriber(Auction)
+    end
+
     it 'binds block of code statically to event being fired' do
       expect_any_instance_of(Auction).to receive(:update_column).with(:status, 'first_bid_made')
       Reactor::Event.publish(:bid_made, target: Auction.create!(start_at: 10.minutes.from_now))
@@ -63,6 +89,8 @@ describe Reactor::Subscribable do
     end
 
     describe 'binding symbol of class method' do
+      let(:pooped_handler) { Reactor::StaticSubscribers::Auction::PoopedHandler }
+
       it 'fires on event' do
         expect(Auction).to receive(:ring_bell)
         Reactor::Event.publish(:puppy_delivered)
@@ -70,7 +98,7 @@ describe Reactor::Subscribable do
 
       it 'can be delayed' do
         expect(Auction).to receive(:pick_up_poop)
-        expect(Auction).to receive(:delay_for).with(5.minutes).and_return(Auction)
+        expect(pooped_handler).to receive(:perform_in).with(5.minutes, anything).and_call_original
         Reactor::Event.perform('pooped', {})
       end
     end
@@ -85,6 +113,16 @@ describe Reactor::Subscribable do
       Reactor::Event.publish(:another_event, actor: Auction.create!(start_at: 5.minutes.from_now))
     end
 
+    # ran into a case where if a class for the event name already exists,
+    # it will re-open that class instead of putting it in the proper namespace
+    # which raised a NoMethodError for perform_where_needed
+    it 'handles names that already exist in the global namespace' do
+      expect(::Auction).to be_a(Class)
+      # have to ensure multiple subscribers are loaded
+      expect(KittenMailer).to be_a(Class)
+      expect { Reactor::Event.publish :auction }.not_to raise_error
+    end
+
     describe 'in_memory flag' do
       it 'doesnt fire perform_async when true' do
         expect(Auction).to receive(:puppies!)
@@ -99,16 +137,34 @@ describe Reactor::Subscribable do
     end
 
     describe '#perform' do
+      around(:each) do |example|
+        Reactor.in_test_mode { example.run }
+      end
+
       it 'returns :__perform_aborted__ when Reactor is in test mode' do
         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::TestModeAuction::TestPuppyDeliveredHandler.new.perform({})).not_to eq(:__perform_aborted__)
-        Reactor::Event.publish(:test_puppy_delivered)
+        Reactor.with_subscriber_enabled(TestModeAuction) do
+          expect(Reactor::StaticSubscribers::TestModeAuction::TestPuppyDeliveredHandler.new.perform({})).not_to eq(:__perform_aborted__)
+          Reactor::Event.publish(:test_puppy_delivered)
+        end
       end
     end
   end
+
+  describe 'mailers', type: :mailer do
+    before { Reactor.enable_test_mode_subscriber KittenMailer }
+    after  { Reactor.disable_test_mode_subscriber KittenMailer }
+
+    def deliveries
+      ActionMailer::Base.deliveries
+    end
+
+    it 'sends an email from a method on_event', focus: true do
+      expect { Reactor::Event.publish(:kitten_streaming) }.to change{ deliveries.count }.by(1)
+    end
+  end
 end

data/spec/models/subscriber_spec.rb

@@ -23,8 +23,15 @@ describe Reactor::Subscriber do
 
 
   describe 'matcher' do
-    before { MySubscriber.create!(event_name: '*') }
-    after { MySubscriber.destroy_all }
+    before do
+      MySubscriber.create!(event_name: '*')
+      Reactor.enable_test_mode_subscriber Reactor::Subscriber
+    end
+
+    after do
+      Reactor.disable_test_mode_subscriber Reactor::Subscriber
+      MySubscriber.destroy_all
+    end
 
     it 'can be set to star to bind to all events' do
       expect_any_instance_of(MySubscriber).to receive(:fire).with(hash_including('random' => 'data', 'event' => 'this_event'))

data/spec/reactor_spec.rb

@@ -11,6 +11,8 @@ describe Reactor do
   let(:subscriber) { SomeClass }
 
   describe '.test_mode!' do
+    before { Reactor.disable_test_mode! }
+
     it 'sets Reactor into test mode' do
       expect(Reactor.test_mode?).to be_falsey
       Reactor.test_mode!

data/spec/spec_helper.rb

@@ -6,13 +6,23 @@ require 'support/active_record'
 require 'sidekiq'
 require 'sidekiq/testing/inline'
 require 'sidekiq/api'
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/testing/"
+end
+
 require 'reactor'
 require 'reactor/testing/matchers'
 
 require 'rspec/its'
 
+REDIS_URL = ENV["REDISTOGO_URL"] || ENV["REDIS_URL"] || "redis://localhost:6379/4"
+
+ActionMailer::Base.delivery_method = :test
+
 Sidekiq.configure_server do |config|
-  config.redis = { url: ENV["REDISTOGO_URL"] }
+  config.redis = { url: REDIS_URL }
 
   database_url = ENV['DATABASE_URL']
   if database_url
@@ -22,13 +32,19 @@ Sidekiq.configure_server do |config|
 end
 
 Sidekiq.configure_client do |config|
-  config.redis = { url: ENV["REDISTOGO_URL"] }
+  config.redis = { url: REDIS_URL }
 end
 
 
 RSpec.configure do |config|
   # some (optional) config here
 
+  config.before(:each) do
+    Reactor.test_mode!
+    Reactor.clear_test_subscribers!
+    ActionMailer::Base.deliveries.clear
+  end
+
   # Runs Sidekiq jobs inline by default unless the RSpec metadata :sidekiq is specified,
   # in which case it will use the real Redis-backed Sidekiq queue
   config.before(:each, :sidekiq) do
@@ -45,4 +61,4 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = "random"
-end
+end

data/spec/subscription_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Reactor::Subscription do
+
+  describe '.build_handler_name' do
+    let(:event_name) { :kitten_sleeping }
+
+    subject { described_class.build_handler_name(event_name) }
+
+    it 'should camelize event name' do
+      expect(subject).to eq('KittenSleepingHandler')
+    end
+
+    context 'with wildcard event name' do
+      let(:event_name) { '*' }
+      it { is_expected.to eq('WildcardHandler') }
+    end
+
+    context 'with handler name specified' do
+      let(:result) { 'SleepyKittenHandler' }
+      subject { described_class.build_handler_name(event_name, handler_name) }
+
+      context 'as snake_cased' do
+        let(:handler_name) { :sleepy_kitten_handler }
+        it { is_expected.to eq(result) }
+      end
+
+      context 'as CamelCased' do
+        let(:handler_name) { 'SleepyKittenHandler' }
+        it { is_expected.to eq(result) }
+      end
+    end
+  end
+
+  describe 'building a new subscriptiong' do
+    class SleepyKittenSubscriber ; end
+
+    let(:source) { SleepyKittenSubscriber }
+    let(:event_name) { :kitten_sleeping }
+    let(:action) { double('Callable Action') }
+
+    context 'for delayed async worker' do
+      let(:delay) { 10.minutes }
+    end
+
+    context 'for synchronous runners' do
+      let(:async) { false }
+    end
+
+    context 'with handler name specified' do
+      let(:handler_name) { :sleepy_kitten_streaming_handler }
+    end
+  end
+
+end

data/spec/support/active_record.rb

@@ -14,6 +14,16 @@ ActiveRecord::Migration.create_table :auctions do |t|
   t.timestamps null: false
 end
 
+ActiveRecord::Migration.create_table :publishers do |t|
+  t.string :name
+  t.datetime :start_at
+  t.datetime :close_at
+  t.boolean :we_want_it
+  t.integer :pet_id
+
+  t.timestamps null: false
+end
+
 ActiveRecord::Migration.create_table :subscribers do |t|
   t.string :event_name
   t.string :type

data/spec/workers/database_subscriber_worker_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+class DbSubscriber < Reactor::Subscriber
+  attr_accessor :was_called
+
+  on_fire do
+    self.was_called = true
+  end
+end
+
+describe Reactor::Workers::DatabaseSubscriberWorker do
+  let(:event_name) { :fire_db_subscriber }
+  let(:data) { Hash[unused: :data] }
+  let!(:db_subscriber) { DbSubscriber.create!(event_name: event_name) }
+
+  let(:instance) { described_class.new }
+
+  describe '#perform' do
+
+    subject { instance.perform(db_subscriber.id, data) }
+
+    context 'when should_perform? is false' do
+      before { allow_any_instance_of(DbSubscriber).to receive(:should_perform?).and_return(false) }
+
+      it { is_expected.to eq(:__perform_aborted__) }
+    end
+
+    context 'when should_perform? is true' do
+      before do
+        allow(instance).to receive(:should_perform?).and_return(true)
+      end
+
+      it 'fires subscriber' do
+        expect(Reactor::Subscriber).to receive(:fire).with(db_subscriber.id, data)
+        subject
+      end
+    end
+
+  end
+
+  describe '#should_perform?' do
+    subject { instance.should_perform? }
+
+    context 'in test mode' do
+      context 'when subscriber is not enabled' do
+        it { is_expected.to eq(false) }
+      end
+
+      context 'when subscriber is enabled' do
+        it 'should equal true' do
+          Reactor.with_subscriber_enabled Reactor::Subscriber do
+            expect(subject).to eq(true)
+          end
+        end
+      end
+    end
+
+    context 'outside test mode' do
+      before do
+        allow(Reactor).to receive(:test_mode?).and_return(false)
+      end
+
+      it { is_expected.to eq(true) }
+    end
+  end
+
+end

data/spec/workers/event_worker_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+class SourceSubscriber
+  include Reactor::Subscribable
+
+  def self.fire_worker(event)
+    :method_called
+  end
+end
+
+class FailingEventWorker < Reactor::Workers::EventWorker
+end
+
+class MyEventWorker < Reactor::Workers::EventWorker
+  self.source = SourceSubscriber
+  self.action = :fire_worker
+  self.async  = true
+  self.delay  = 0
+end
+
+class MyBlockWorker < Reactor::Workers::EventWorker
+  self.source = SourceSubscriber
+  self.action = lambda { |event| :block_ran }
+  self.async  = true
+  self.delay  = 0
+end
+
+class MyDelayedWorker < Reactor::Workers::EventWorker
+  self.source = SourceSubscriber
+  self.action = :fire_worker
+  self.async  = true
+  self.delay  = 1 # seconds
+end
+
+class MyImmediateWorker < Reactor::Workers::EventWorker
+  self.source = SourceSubscriber
+  self.action = :fire_worker
+  self.async  = false
+  self.delay  = 0
+end
+
+describe Reactor::Workers::EventWorker do
+  let(:event_name) { :fire_worker }
+  let(:event_data) { Hash[my_event_data: true] }
+
+  describe '.configured?' do
+    context 'for unconfigured class' do
+      subject { FailingEventWorker.configured? }
+
+      it { is_expected.to eq(false) }
+    end
+
+    context 'for configured class' do
+      subject { MyEventWorker.configured? }
+
+      it { is_expected.to eq(true) }
+    end
+  end
+
+  describe '.perform_where_needed?' do
+    context 'for delayed worker' do
+      let(:klass) { MyDelayedWorker }
+      subject { klass.perform_where_needed(event_data) }
+
+      it 'uses perform_in to delay execution' do
+        expect(klass).to receive(:perform_in).with(1, event_data)
+        subject
+      end
+    end
+
+    context 'for async workers' do
+      let(:klass) { MyEventWorker }
+      subject { klass.perform_where_needed(event_data) }
+
+      it 'uses perform_async to execute wherever' do
+        expect(klass).to receive(:perform_async).with(event_data)
+        subject
+      end
+    end
+
+    context 'for immediate workers' do
+      let(:klass) { MyImmediateWorker }
+      subject { klass.perform_where_needed(event_data) }
+
+      it 'creates and executes new instance' do
+        expect_any_instance_of(klass).to receive(:perform).with(event_data)
+        subject
+      end
+    end
+  end
+
+  describe '#perform' do
+    let(:klass) { MyEventWorker }
+    subject { klass.new.perform(event_data) }
+
+    context 'for unconfigured worker' do
+      let(:klass) { FailingEventWorker }
+
+      it 'raises an error' do
+        expect { subject }.to raise_error(Reactor::UnconfiguredWorkerError)
+      end
+    end
+
+    context 'when should_perform? is false' do
+      let(:klass) { MyEventWorker }
+
+      it 'returns :__perform_aborted__' do
+        expect(subject).to eq(:__perform_aborted__)
+      end
+    end
+
+    context 'when should_perform? is true' do
+      before { allow_any_instance_of(klass).to receive(:should_perform?).and_return(true) }
+
+      it 'calls class method by symbol' do
+        expect(subject).to eq(:method_called)
+      end
+
+      context 'for block workers' do
+        let(:klass) { MyBlockWorker }
+        it { is_expected.to eq(:block_ran) }
+      end
+    end
+  end
+
+end

data/spec/workers/mailer_worker_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+class MailerSubscriber < ActionMailer::Base
+  include Reactor::Subscribable
+
+  def fire_mailer(event)
+    mail subject: 'Here is a mailer',
+         to: 'reactor@hired.com',
+         from: 'test+reactor@hired.com',
+         body: 'an example email body'
+  end
+end
+
+class MyMailerWorker < Reactor::Workers::MailerWorker
+  self.source = MailerSubscriber
+  self.action = :fire_mailer
+  self.async  = false
+  self.delay  = 0
+end
+
+class MyBlockMailerWorker < Reactor::Workers::MailerWorker
+  self.source = MailerSubscriber
+  self.async  = false
+  self.delay  = 0
+  self.action = lambda { |event| fire_mailer(event) }
+end
+
+describe Reactor::Workers::MailerWorker do
+  let(:klass) { MyMailerWorker }
+  let(:event_data) { Hash[some_example: :event_data] }
+  subject { klass.new.perform(event_data) }
+
+  before do
+    allow_any_instance_of(klass).to receive(:should_perform?).and_return(true)
+  end
+
+  it 'sends an email from symbol method name' do
+    expect { subject }.to change { ActionMailer::Base.deliveries.count }.by(1)
+  end
+
+  context 'for a block subscription' do
+    let(:klass) { MyBlockMailerWorker }
+
+    it 'sends an email from the block' do
+      expect { subject }.to change { ActionMailer::Base.deliveries.count }.by(1)
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reactor
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - winfred
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-11 00:00:00.000000000 Z
+date: 2017-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -28,19 +28,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 5.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +153,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: " rails chrono reactor "
 email:
 - winfred@hired.com
@@ -174,6 +188,7 @@ files:
 - README.md
 - Rakefile
 - lib/reactor.rb
+- lib/reactor/controllers.rb
 - lib/reactor/controllers/concerns/actions/action_event.rb
 - lib/reactor/controllers/concerns/actions/create_event.rb
 - lib/reactor/controllers/concerns/actions/destroy_event.rb
@@ -183,13 +198,22 @@ files:
 - lib/reactor/controllers/concerns/actions/show_event.rb
 - lib/reactor/controllers/concerns/actions/update_event.rb
 - lib/reactor/controllers/concerns/resource_actionable.rb
+- lib/reactor/errors.rb
 - lib/reactor/event.rb
+- lib/reactor/models.rb
 - lib/reactor/models/concerns/optionally_subclassable.rb
 - lib/reactor/models/concerns/publishable.rb
 - lib/reactor/models/concerns/subscribable.rb
 - lib/reactor/models/subscriber.rb
+- lib/reactor/static_subscribers.rb
+- lib/reactor/subscription.rb
+- lib/reactor/testing.rb
 - lib/reactor/testing/matchers.rb
 - lib/reactor/version.rb
+- lib/reactor/workers.rb
+- lib/reactor/workers/database_subscriber_worker.rb
+- lib/reactor/workers/event_worker.rb
+- lib/reactor/workers/mailer_worker.rb
 - reactor.gemspec
 - spec/controllers/concerns/resource_actionable_spec.rb
 - spec/event_spec.rb
@@ -198,7 +222,11 @@ files:
 - spec/models/subscriber_spec.rb
 - spec/reactor_spec.rb
 - spec/spec_helper.rb
+- spec/subscription_spec.rb
 - spec/support/active_record.rb
+- spec/workers/database_subscriber_worker_spec.rb
+- spec/workers/event_worker_spec.rb
+- spec/workers/mailer_worker_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -231,4 +259,8 @@ test_files:
 - spec/models/subscriber_spec.rb
 - spec/reactor_spec.rb
 - spec/spec_helper.rb
+- spec/subscription_spec.rb
 - spec/support/active_record.rb
+- spec/workers/database_subscriber_worker_spec.rb
+- spec/workers/event_worker_spec.rb
+- spec/workers/mailer_worker_spec.rb