ventable 0.0.5 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 081c78cd805ad7b5dce14dbe88ad7177240152c6
+  data.tar.gz: 2a1a56d21086cdf8ce6dab880b2911af9bd8eb20
+SHA512:
+  metadata.gz: 81de27f259688d1132d67a6f0d47500c47ad10f1d5a9624c8f0890f49376cdc738ea9abc16cf958034579b50ce7614b7341d0112df4c2df2ef14fb377a5fab0e
+  data.tar.gz: 4e418cbc41c2c154b22be27f2cffaec76952da3e2dc49391b64c56ba18d862ef0859ccad5f74ed5c55349d9bf6f1697a823f862527188054cdf9ef3870163219

data/README.md

@@ -1,4 +1,7 @@
+[![Gem Version](https://badge.fury.io/rb/ventable.png)](http://badge.fury.io/rb/ventable)
 [![Build status](https://secure.travis-ci.org/kigster/ventable.png)](http://travis-ci.org/kigster/ventable)
+[![Code Climate](https://codeclimate.com/github/kigster/ventable.png)](https://codeclimate.com/github/kigster/ventable)
+
 
 # Ventable
 
@@ -129,6 +132,47 @@ class observe the ```UserRegisteredEvent```, and so all the mailing logic can li
 class, instead of, say, registration controller directly calling ```Mailer.deliver_user_registration!(user)```.
 The callback method will receive the event, that wraps the User instance, or any other useful data necessary.
 
+## Integration with tests
+
+There are times when it may be desirable to disable all eventing. For instance, when writing unit tests,
+testing that events are fired may be useful, but integrating with all observers adds complexity and confusion.
+In these cases, Ventable may be globally disabled.
+
+```ruby
+## in spec_helper
+
+around :each, eventing: false do |example|
+  Ventable.disable
+  example.run
+  Ventable.enable
+end
+```
+
+Now in a spec file:
+
+```ruby
+describe "Stuff", eventing: false do
+  it 'does stuff' do
+    ... my code that fires events, in isolation from event observers
+  end
+
+  it 'tests that events are fired, using stubs' do
+    event = double(fire!: true)
+    allow(MyEvent).to receive(:new).and_return(event)
+    ... my code that should fire event
+    expect(event).to have_received(:fire!)
+  end
+end
+
+describe 'Other stuff' do
+  it 'actually calls through to all observers, so valid data is required' do
+  end
+end
+```
+
+Note that in the version of RSpec that Ventable has been tested with, tags on a `describe` block
+override tags on an `it` block.
+
 ## Further Discussion
 
 It is worth mentioning that in the current form this gem is simply a software design pattern.  It helps
@@ -138,6 +182,10 @@ but unrelated to each other (such as sending email to the user).
 Future versions of this gem may offer a way to further decouple observers, by allowing them to be notified
 via a background queue, such as Sidekiq or Resque. If you are interested in helping, please email the author.
 
+For more information, check out the following blog post:
+
+[Detangling Business Logic in Rails Apps with Pure Ruby Observers](http://building.wanelo.com/post/57442907639/detangling-business-logic-in-rails-apps-with-poro).
+
 ## Contributing
 
 1. Fork it

data/lib/ventable.rb

@@ -2,6 +2,18 @@ require "ventable/version"
 require "ventable/event"
 
 module Ventable
+
+  def self.disable
+    @disabled = true
+  end
+
+  def self.enable
+    @disabled = false
+  end
+
+  def self.enabled?
+    @disabled != true
+  end
 end
 
 class String

data/lib/ventable/event.rb

@@ -17,7 +17,7 @@ module ::Ventable
     end
 
     def fire!
-      notify_observer_set(self.class.observers)
+      notify_observer_set(self.class.observers) if Ventable.enabled?
     end
 
     private
@@ -46,9 +46,10 @@ module ::Ventable
     end
 
     def notify_class_observer(observer)
-      return observer.send(self.class.default_callback_method, self) if observer.respond_to?(self.class.default_callback_method)
+      default_handler = self.class.default_callback_method
+      return observer.send(default_handler, self) if observer.respond_to?(default_handler)
       return observer.send(:handle_event, self) if observer.respond_to?(:handle_event)
-      raise Ventable::Error.new("suitable event handler method found in observer #{self.inspect}")
+      raise Ventable::Error.new("no suitable event handler method found for #{self.class} in observer #{observer} (try adding #{default_handler} to this observer)")
     end
 
     module ClassMethods

data/lib/ventable/version.rb

@@ -1,3 +1,3 @@
 module Ventable
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/ventable/ventable_spec.rb

@@ -7,6 +7,25 @@ describe Ventable do
     end
   end
 
+  describe '::enabled?' do
+    after { Ventable.enable }
+
+    it 'is true by default' do
+      expect(Ventable.enabled?).to be_true
+    end
+
+    it 'is false after Ventable is disabled' do
+      Ventable.disable
+      expect(Ventable.enabled?).to be_false
+    end
+
+    it 'is true after Ventable is re-enabled' do
+      Ventable.disable
+      Ventable.enable
+      expect(Ventable.enabled?).to be_true
+    end
+  end
+
   describe "including Ventable::Event" do
     it "should create a class instance variable to keep observers" do
       TestEvent.observers.should_not be_nil
@@ -113,6 +132,22 @@ describe Ventable do
       event_inside.should_not be_nil
       event_inside.should be_a(TestEvent)
     end
+
+    context 'when globally disabled' do
+      before { Ventable.disable }
+      after { Ventable.enable }
+
+      it 'does not notify observers' do
+        observers_notified = false
+
+        TestEvent.notifies do |event|
+          observers_notified = true
+        end
+
+        TestEvent.new.fire!
+        expect(observers_notified).to be_false
+      end
+    end
   end
 
   describe "#default_callback_method" do

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: ventable
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.0.6
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-07 00:00:00.000000000 Z
+date: 2014-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Event/Observable design pattern in ruby
@@ -66,9 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -82,27 +75,26 @@ files:
 - ventable.gemspec
 homepage: https://github.com/kigster/ventable
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Event/Observable design pattern in ruby
 test_files:
 - spec/spec_helper.rb