wisper-activerecord 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 451585256ebdbf75f46b68cc6553221ccde75b4e
-  data.tar.gz: ed8138655b491c53530bd4ef515b649e2bbfd57f
+  metadata.gz: 666f55caf67abe6ebccc3a5670316f32c4ff8406
+  data.tar.gz: 10583078a56cb785deeb6c9548de3a09499d4e8d
 SHA512:
-  metadata.gz: 2af4ab484e153bdf2f0095e2dc29e52f205f3eef135a9d5755eccdfa49851196e2b878c277308e7ded811af7c16d99b15ea7ae03c1f2e37a769e52ac70d08d5c
-  data.tar.gz: f80a718f09e0f5102fef9df9932f516b19d4669818bf80831a2e7c30126edca13fae893570f060bc6276c7ad7e8086787c3cad02d3e304f02560e2a742398c91
+  metadata.gz: 2212d5f93e3ecd82c01369f52396e6ee0e41df1a320c95496c76d3e50d0e8409a2d508c22b31b606bfd847264b65ce80743676a22b68b75e8a54fdb165cc6d24
+  data.tar.gz: 5072defbcaf59d3df9eaf8ee6b8cfb01107b4be2793d53e24167d7ff3e9aa37747c6dbe6e7d19bdbd91e6e50009e1de3309d0e839e71afa9468259b6841af210

data/README.md

@@ -16,7 +16,7 @@ gem 'wisper-activerecord'
 
 ## Usage
 
-### The Model
+### Setup a publisher
 
 ```ruby
 class Meeting < ActiveRecord::Base
@@ -26,43 +26,47 @@ class Meeting < ActiveRecord::Base
 end
 ```
 
-If you wish all models to broadcast events without having explicitly include
-`Wisper.model` in each you can add the following to an initializer:
+If you wish all models to broadcast events without having to explicitly include
+`Wisper.model` add the following to an initializer:
 
 ```ruby
-# config/initializers/wisper.rb
 Wisper::ActiveRecord.extend_all
 ```
 
-#### Subscribing Listeners
+### Subscribing
 
-Subscribe a listener to instances of models:
+Subscribe a listener to model instances:
 
 ```ruby
 meeting = Meeting.new
 meeting.subscribe(Auditor.new)
 ```
 
-Subscribe a listener to all instances of a model:
+Subscribe a block to model instances:
 
 ```ruby
-Meeting.subscribe(Auditor.new)
+meeting.on(:create_meeting_successful) { |meeting| ... }
 ```
 
-Please refer to the [Wisper README](https://github.com/krisleech/wisper) for full details about subscribing.
+Subscribe a listener to _all_ instances of a model:
 
-The events broadcast are:
+```ruby
+Meeting.subscribe(Auditor.new)
+```
 
-* `before_{create, update, destroy}`
-* `after_{create, update, destroy}`
+Please refer to the [Wisper README](https://github.com/krisleech/wisper) for full details about subscribing.
 
-### Subscribing blocks
+The events which are automatically broadcast are:
 
-```ruby
-meeting.on(:create_meeting_successful) { |meeting| ... }
-```
+* `after_create`
+* `after_create`
+* `after_destroy`
+* `create_<model_name>_{successful, failed}`
+* `update_<model_name>_{successful, failed}`
+* `destroy_<model_name>_successful`
+* `after_rollback`
 
-### Reacting to events
+### Reacting to Events
 
 To receive an event the listener must implement a method matching the name of
 the event with a single argument, the instance of the model.
@@ -73,33 +77,9 @@ def create_meeting_successful(meeting)
 end
 ```
 
-### Success and Failure events for Create and Update
-
-To have event broadcast for success and failure of create and
-update you must use the `commit` method.
-
-```ruby
-meeting.title = 'My Meeting'
-meeting.commit
-```
-
-You can also pass attributes directly to `commit`:
-
-```ruby
-meeting.commit(title: 'My Meeting')
-```
-
-And use the class method for creating new records:
-
-```ruby
-Meeting.commit(title: 'My Meeting')
-```
-
-In addition the the regular events broadcast the following events are also broadcast:
-
-* `{create, update}_<model_name>_{successful, failed}`
+## Example
 
-### Example controller
+### Controller
 
 ```ruby
 class MeetingsController < ApplicationController
@@ -112,7 +92,7 @@ class MeetingsController < ApplicationController
     @meeting.subscribe(Auditor.instance)
     @meeting.on(:meeting_create_successful) { redirect_to meeting_path }
     @meeting.on(:meeting_create_failed)     { render action: :new }
-    @meeting.commit
+    @meeting.save
   end
 
   def edit
@@ -124,14 +104,14 @@ class MeetingsController < ApplicationController
     @meeting.subscribe(Auditor.instance)
     @meeting.on(:meeting_update_successful) { redirect_to meeting_path }
     @meeting.on(:meeting_update_failed)     { render :action => :edit }
-    @meeting.commit(params[:meeting])
+    @meeting.update_attributes(params[:meeting])
   end
 end
 ```
 
-#### An example Listener
+### Listener
 
-**Which simply logs all events in memory**
+**Which simply records an audit in memory**
 
 ```ruby
 class Auditor

data/lib/wisper/active_record/publisher.rb

@@ -6,43 +6,51 @@ module Wisper
 
         include Wisper::Publisher
 
-        after_commit :publish_creation, on: :create
-        after_commit :publish_update,   on: :update
-        after_commit :publish_destroy,  on: :destroy
+        after_validation :after_validation_broadcast
+        after_commit     :after_create_broadcast,  on: :create
+        after_commit     :after_update_broadcast,  on: :update
+        after_commit     :after_destroy_broadcast, on: :destroy
+        after_rollback   :after_rollback_broadcast
       end
 
       def commit(_attributes = nil)
-        _action = new_record? ? 'create' : 'update'
+        warn "[DEPRECATED] use save, create, update_attributes as usual"
         assign_attributes(_attributes) if _attributes.present?
-        result = save
-        if result
-          broadcast("#{_action}_#{self.class.model_name.param_key}_successful", self)
-        else
-          broadcast("#{_action}_#{self.class.model_name.param_key}_failed", self)
-        end
-        result
+        save
       end
 
       module ClassMethods
         def commit(_attributes = nil)
-          new(_attributes).commit
+          warn "[DEPRECATED] use save, create, update_attributes as usual"
+          new(_attributes).save
         end
       end
 
       private
 
-      def publish_creation
+      def after_validation_broadcast
+        action = new_record? ? 'create' : 'update'
+        broadcast("#{action}_#{self.class.model_name.param_key}_failed", self) unless errors.empty?
+      end
+
+      def after_create_broadcast
         broadcast(:after_create, self)
+        broadcast("create_#{self.class.model_name.param_key}_successful", self)
       end
 
-      def publish_update
+      def after_update_broadcast
         broadcast(:after_update, self)
+        broadcast("update_#{self.class.model_name.param_key}_successful", self)
       end
 
-      def publish_destroy
+      def after_destroy_broadcast
         broadcast(:after_destroy, self)
         broadcast("destroy_#{self.class.model_name.param_key}_successful", self)
       end
+
+      def after_rollback_broadcast
+        broadcast(:after_rollback, self)
+      end
     end
   end
 end

data/lib/wisper/active_record/version.rb

@@ -1,5 +1,5 @@
 module Wisper
   module ActiveRecord
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/wisper/activerecord_spec.rb

@@ -9,10 +9,8 @@ describe 'ActiveRecord' do
     expect(Wisper.model).to eq Wisper::ActiveRecord::Publisher
   end
 
-  describe '.commit' do
-
+  describe '.commit' do # DEPRECATED
     describe 'when creating' do
-
       context 'and model is valid' do
         it 'publishes create_<model_name>_successful event to listener' do
           expect(listener).to receive(:create_meeting_successful).with(instance_of(model_class))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wisper-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kris Leech
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wisper