reactor 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8362bfb2d624d7faccf2571ebd5bd622cd88945a
-  data.tar.gz: c62cfe20ff087e4d012dabf64076c034d3e3c702
+  metadata.gz: bc723686f416100ec5c50b2ff2ccd1893f4c3076
+  data.tar.gz: 876912b1d837da0b05da0349249811d31e3b82ea
 SHA512:
-  metadata.gz: 0f026cd77012cd13c06be293f02ef47ff82a660294f449aab2c4e191cffb048aec4f791497ab0f67a8e2680a58c0fbee17ee6b0197ba0d1e946b2452ff13b7d1
-  data.tar.gz: fe1f845c5f003447464de076ba4a5e5dcc8c5f64a0dea9164730628f5c1f9fd713d7ca918af73e1daf717143c465b15963737fbe5a594fec5a010fad4154a1ea
+  metadata.gz: 47a87bcef246a5440a573976eac9eb4cc8051938322e0142379ae5f9bff742d97a42fc37ba042380e2895598bc58cc6508c426fb2abf85e2e79fad8a892f8980
+  data.tar.gz: e8c40d4a7d339263074a3ad2240204f581f43069879d65fc38987f6d5bcd8cc5f83c090278e728fae608c9f81d7a2b1e76140622dbfd5bfc42c62f53a78556f0

data/Changes.md

@@ -1,5 +1,9 @@
 # Reactor Change Log
 
+0.17.0
+----------
+`publishes` method in publishable now accepts `:enqueue_if` option
+
 0.16.0
 ----------
 Subscribers can now deprecate themselves for safe removal from production deployments.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    reactor (0.16.1)
+    reactor (0.17.0)
       rails
       sidekiq (> 4.0)
 
@@ -70,11 +70,11 @@ GEM
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
-    mini_portile2 (2.2.0)
+    mini_portile2 (2.3.0)
     minitest (5.10.2)
     nio4r (2.1.0)
-    nokogiri (1.8.0)
-      mini_portile2 (~> 2.2.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -142,7 +142,7 @@ GEM
     sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.0)
+    sprockets-rails (3.2.1)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
@@ -174,4 +174,4 @@ DEPENDENCIES
   test_after_commit
 
 BUNDLED WITH
-   1.15.3
+   1.15.4

data/README.md

@@ -64,12 +64,19 @@ end
 publishes :reminder_sent, at: :reminder_email_time, watch: :created_at
 ```
 
-  Scheduled events can check conditionally fire -- eg: in 2 days fire reminder_email if the user hasn't already responded.
+  Scheduled events can check conditionally fire -- eg: in 2 days fire reminder_email if the user hasn't already responded. Note that this check will occur at the time the event is intended to fire, after which the state of the model may have changed. 
 
 ```ruby
 publishes :reminder_sent, at: :reminder_email_time, if: -> { user.responded == false }
 ```
 
+  It is also possible to conditionally trigger events so that the check happens within the context of the model, at the moment an update occurs, rather than later in the context of the Reactor::Event
+
+```ruby
+publishes :model_changed_in_some_important_way, enqueue_if: -> { important_change_occurred? }
+```
+
+
 #### Subscribable
 
   You can now bind any block to an event in your models like so
@@ -234,6 +241,20 @@ end
 
 for your testing convenience.
 
+#### Matchers
+
+You can clean up some event assertions with these somewhat imperfect matchers.
+
+```
+# DRY up strict event & data assertions.
+expect { some_thing }.to publish_event(:some_event, actor: this_user, target: this_object)
+```
+
+```
+# DRY up multi-event assertions. Unfortunately can't test key-values with this at the moment.
+expect { some_thing }.to publish_events(:some_event, :another_event)
+```
+
 
 ### Production Deployments
 

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

@@ -39,19 +39,29 @@ module Reactor::Publishable
 
   def reschedule(name, data)
     if data[:at]
-      Reactor::Event.reschedule name,
-        data.merge(
-            at: send(data[:at]),
-            actor: ( data[:actor] ? send(data[:actor]) : self ),
-            target: ( data[:target] ? self : nil),
-            was: previous_changes[data[:at]].try(:first) || send("#{data[:at]}_was"))
+      event = event_data_for_signature(data).merge(
+        was: previous_changes[data[:at]].try(:first) || send("#{data[:at]}_was")
+      )
+      Reactor::Event.reschedule(name, event) if should_fire_reactor_event?(data)
     end
   end
 
   def schedule_events
     self.class.events.each do |name, data|
       event = event_data_for_signature(data)
-      Reactor::Event.publish name, event
+      Reactor::Event.publish(name, event) if should_fire_reactor_event?(data)
+    end
+  end
+
+  def should_fire_reactor_event?(data, handler_name = :enqueue_if)
+    handler = data[handler_name]
+    case handler
+    when Proc
+      instance_exec(&handler)
+    when Symbol
+      send(handler)
+    when NilClass
+      true
     end
   end
 
@@ -60,6 +70,6 @@ module Reactor::Publishable
         actor: (signature[:actor] ? send(signature[:actor]) : self),
         target: (signature[:target] ? self : nil),
         at: (signature[:at] ? send(signature[:at]) : nil)
-    ).except(:watch)
+    ).except(:watch, :enqueue_if)
   end
 end

data/lib/reactor/testing/matchers.rb

@@ -1,3 +1,10 @@
+#
+# DRY up strict event & data assertions.
+#
+# Example:
+#
+#  expect { some_thing }.to publish_event(:some_event, actor: this_user, target: this_object)
+#
 RSpec::Matchers.define :publish_event do |name, data = {}|
   supports_block_expectations
 
@@ -12,6 +19,14 @@ RSpec::Matchers.define :publish_event do |name, data = {}|
   end
 end
 
+
+#
+# DRY up multi-event assertions. Unfortunately can't test key-values with this at the moment.
+#
+# Example:
+#
+#  expect { some_thing }.to publish_events(:some_event, :another_event)
+#
 RSpec::Matchers.define :publish_events do |*names|
   supports_block_expectations
 

data/lib/reactor/version.rb

@@ -1,3 +1,3 @@
 module Reactor
-  VERSION = "0.16.1"
+  VERSION = "0.17.0"
 end

data/spec/models/concerns/publishable_spec.rb

@@ -15,7 +15,8 @@ class Publisher < ActiveRecord::Base
   publishes :bell
   publishes :ring, at: :ring_timeout, watch: :start_at
   publishes :begin, at: :start_at, additional_info: 'curtis was here'
-  publishes :conditional_event_on_save, at: :start_at, if: -> { we_want_it }
+  publishes :conditional_event_on_save, at: :start_at, enqueue_if: -> { we_want_it }
+  publishes :conditional_event_on_publish, at: :start_at, if: -> { we_want_it }
   publishes :woof, actor: :pet, target: :self
 end
 
@@ -87,14 +88,14 @@ describe Reactor::Publishable do
       )
     end
 
-    context 'conditional firing' do
+    context 'conditional firing at publish time' do
       before do
         Sidekiq::Testing.fake!
         Sidekiq::Worker.clear_all
-        TestSubscriber.create! event_name: :conditional_event_on_save
+        TestSubscriber.create! event_name: :conditional_event_on_publish
         publisher
         job = Reactor::Event.jobs.detect do |job|
-          job['class'] == 'Reactor::Event' && job['args'].first == 'conditional_event_on_save'
+          job['class'] == 'Reactor::Event' && job['args'].first == 'conditional_event_on_publish'
         end
         @job_args = job['args']
       end
@@ -108,7 +109,7 @@ describe Reactor::Publishable do
         publisher.start_at = 3.day.from_now
         allow(Reactor::Event).to receive(:perform_at)
         publisher.save!
-        expect(Reactor::Event).to have_received(:perform_at).with(publisher.start_at, :conditional_event_on_save, anything())
+        expect(Reactor::Event).to have_received(:perform_at).with(publisher.start_at, :conditional_event_on_publish, anything())
 
         Reactor::Event.perform(@job_args[0], @job_args[1])
       end
@@ -125,7 +126,7 @@ describe Reactor::Publishable do
         old_start_at = publisher.start_at
         publisher.start_at = 3.day.from_now
         allow(Reactor::Event).to receive(:publish)
-        expect(Reactor::Event).to receive(:publish).with(:conditional_event_on_save, {
+        expect(Reactor::Event).to receive(:publish).with(:conditional_event_on_publish, {
           at: publisher.start_at,
           actor: publisher,
           target: nil,
@@ -138,7 +139,7 @@ describe Reactor::Publishable do
       it 'keeps the if intact when scheduling' do
         start_at = 3.days.from_now
         allow(Reactor::Event).to receive(:publish)
-        expect(Reactor::Event).to receive(:publish).with(:conditional_event_on_save, {
+        expect(Reactor::Event).to receive(:publish).with(:conditional_event_on_publish, {
           at: start_at,
           actor: anything,
           target: nil,
@@ -148,6 +149,59 @@ describe Reactor::Publishable do
       end
     end
 
+    context 'conditional firing on save' do
+      before do
+        Sidekiq::Testing.fake!
+        Sidekiq::Worker.clear_all
+        TestSubscriber.create! event_name: :conditional_event_on_save
+        publisher
+        job = Reactor::Event.jobs.detect do |job|
+          job['class'] == 'Reactor::Event' && job['args'].first == 'conditional_event_on_save'
+        end
+        @job_args = job ? job['args'] : []
+      end
+
+      after do
+        Sidekiq::Testing.inline!
+      end
+
+      it 'does not call the subscriber when if is set to false' do
+        old_start_at = publisher.start_at
+        publisher.we_want_it = false
+        publisher.start_at = 3.days.from_now
+        allow(Reactor::Event).to receive(:publish)
+        expect(Reactor::Event).to_not receive(:reschedule).with(:conditional_event_on_save)
+        expect(Reactor::Event).to_not receive(:publish).with(:conditional_event_on_save)
+        publisher.save!
+      end
+
+      it 'does rescheduling' do
+        old_start_at = publisher.start_at
+        publisher.we_want_it = true
+        publisher.start_at = 3.day.from_now
+        allow(Reactor::Event).to receive(:publish)
+        expect(Reactor::Event).to receive(:publish).with(:conditional_event_on_save, {
+          at: publisher.start_at,
+          actor: publisher,
+          target: nil,
+          was: old_start_at,
+        })
+        publisher.save!
+      end
+
+      it 'does conditional scheduling scheduling' do
+        start_at = 3.days.from_now
+        allow(Reactor::Event).to receive(:publish)
+        expect(Reactor::Event).to receive(:publish).with(:conditional_event_on_save, {
+          at: start_at,
+          actor: anything,
+          target: nil,
+        })
+        Publisher.create!(start_at: start_at, we_want_it: true)
+      end
+    end
+
+
     it 'supports immediate events (on create) that get fired once' do
       Reactor.with_subscriber_enabled(Reactor::Subscriber) do
         TestSubscriber.create! event_name: :bell

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reactor
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.17.0
 platform: ruby
 authors:
 - winfred
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -266,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Sidekiq/ActiveRecord pubsub lib