reactor 0.2.10 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b3832777ade1de29503fe30b12109e238702e68
-  data.tar.gz: 74107e0eba5012638fee991e573050a51790e656
+  metadata.gz: ec3412b610bacc15fa57793c615761da1191b283
+  data.tar.gz: 0f8613b3601c6573dc6d6c15520e9ed0496f9d25
 SHA512:
-  metadata.gz: 7236791284614629ec715b6f6ca1c93be6d9b6e1aafe03787e0f5918706786c96b729ad2be8324a0ace626863d5dc3b7be39aa2415b527ab8f8b41944fdc3bc5
-  data.tar.gz: afe337ddb5c6bfb53334c4c28a30a7bb8dd10a5a31898f6baa6bcfe42dbeb64ba8f561b7ba7d291611aabe4c2b536c173391c3194fdb9dd96ab3597f4bbda1fe
+  metadata.gz: a9d392a21a36ebf60fb6e07cb2505f1053dddd96a447a5d06b3b1595707e37ef716379e66d13dd56c2eaf926d5b612678d68fa159297d907eac6a7c166634568
+  data.tar.gz: 76a5d911946cbf24865daa12cddac19a627c1b4d3478b739e43f396bf64672f71b80881c9e643c6e9c8547ab6af7b005628d539de99e97508442540034652cd5

data/README.md

@@ -1,6 +1,14 @@
 # Reactor
 
-TODO: Write a gem description
+Warning: this is under active development!
+
+This gem aims to provide the following tools to augment your ActiveRecord & Sidekiq stack.
+
+ 1. Barebones event API through Sidekiq to publish whatever you want
+ 2. Database-driven API to manage subscribers so that users may rewire whatever you let them (transactional emails, campaigns, etc...)
+ 3. Static/Code-driven API to subscribe a basic ruby block to an event.
+ 4. A new communication pattern between your ActiveRecord models that runs asynchronously through Sidekiq.
+    a. describe model lifecycle events and callbacks with class-level helper methods/DSL
 
 ## Installation
 
@@ -18,7 +26,31 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Well, this is evolving, so it's probably best to go read the specs.
+
+
+### Barebones API
+
+   Event.publish(:event_name, any: 'data', you: 'want')
+
+### ActiveModel extensions
+
+#### Publishable
+
+  Describe lifecycle events like so
+
+    publishes :my_model_created
+    publishes :state_has_changed, if: -> { state_has_changed? }
+
+#### Subscribable
+
+  *New in 0.3*
+
+  You can now bind any block to an event in your models like so
+
+    subscribes_to :any_event do |event|
+      MyModel.find(event.target).do_something_about_it!
+    end
 
 ## Contributing
 

data/lib/reactor/event.rb

@@ -55,6 +55,12 @@ class Reactor::Event
     Reactor::Subscriber.where(event: '*').each do |s|
       Reactor::Subscriber.delay.fire s.id, data
     end
+
+    if (static_subscribers = Reactor::STATIC_SUBSCRIBERS[name.to_s] || []).any?
+      static_subscribers.each do |callback|
+        callback.call(Reactor::Event.new(data.merge(event: name.to_s)))
+      end
+    end
   end
 
   private

data/lib/reactor/models/concerns/{eventable.rb → publishable.rb}

@@ -1,4 +1,4 @@
-module Reactor::Eventable
+module Reactor::Publishable
   extend ActiveSupport::Concern
 
   included do

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

@@ -0,0 +1,9 @@
+module Reactor::Subscribable
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def subscribes_to(event, &callback)
+      (Reactor::STATIC_SUBSCRIBERS[event.to_s] ||= []).push(callback)
+    end
+  end
+end

data/lib/reactor/testing/matchers.rb

@@ -23,4 +23,12 @@ RSpec::Matchers.define :publish_events do |*events|
     end
     block.call
   end
+end
+
+RSpec::Matchers.define :subscribe_to do |name, data = {}, &expectations|
+
+  match do
+    expectations.call if expectations.present?
+    Reactor::Event.publish(name, data)
+  end
 end

data/lib/reactor/version.rb

@@ -1,3 +1,3 @@
 module Reactor
-  VERSION = "0.2.10"
+  VERSION = "0.3.0"
 end

data/lib/reactor.rb

@@ -1,11 +1,13 @@
 require "reactor/version"
-require "reactor/models/concerns/eventable"
+require "reactor/models/concerns/publishable"
+require "reactor/models/concerns/subscribable"
 require "reactor/models/concerns/optionally_subclassable"
 require "reactor/models/subscriber"
 require "reactor/event"
 
 module Reactor
-
+  STATIC_SUBSCRIBERS = {}
 end
 
-ActiveRecord::Base.send(:include, Reactor::Eventable)
+ActiveRecord::Base.send(:include, Reactor::Publishable)
+ActiveRecord::Base.send(:include, Reactor::Subscribable)

data/spec/models/concerns/{eventable_spec.rb → publishable_spec.rb}

@@ -30,7 +30,7 @@ class TestSubscriber < Reactor::Subscriber
   end
 end
 
-describe Reactor::Eventable do
+describe Reactor::Publishable do
   before { TestSubscriber.destroy_all }
   describe 'publish' do
     let(:pet) { Pet.create! }

data/spec/models/concerns/subscribable_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+
+class Auction < ActiveRecord::Base
+  subscribes_to :bid_made do |event|
+    event.target.update_column :status, 'first_bid_made'
+  end
+end
+
+describe Reactor::Subscribable do
+
+  describe 'subscribes_to' do
+    it 'binds block of code statically to event being fired' do
+      Auction.any_instance.should_receive(:update_column).with(:status, 'first_bid_made')
+      Reactor::Event.publish(:bid_made, target: Auction.create)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reactor
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.3.0
 platform: ruby
 authors:
 - winfred
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-09 00:00:00.000000000 Z
+date: 2013-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,14 +70,16 @@ files:
 - Rakefile
 - lib/reactor.rb
 - lib/reactor/event.rb
-- lib/reactor/models/concerns/eventable.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/testing/matchers.rb
 - lib/reactor/version.rb
 - reactor.gemspec
 - spec/event_spec.rb
-- spec/models/concerns/eventable_spec.rb
+- spec/models/concerns/publishable_spec.rb
+- spec/models/concerns/subscribable_spec.rb
 - spec/models/subscriber_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb
@@ -107,7 +109,8 @@ specification_version: 4
 summary: Sidekiq/ActiveRecord pubsub lib
 test_files:
 - spec/event_spec.rb
-- spec/models/concerns/eventable_spec.rb
+- spec/models/concerns/publishable_spec.rb
+- spec/models/concerns/subscribable_spec.rb
 - spec/models/subscriber_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb