notification_center 0.2

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    notification_center (0.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.7)
+    diff-lcs (1.1.3)
+    method_source (0.7.1)
+    pry (0.9.9.6)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    slop (2.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  notification_center!
+  pry
+  rspec (~> 2.10.0)

data/README.md

@@ -0,0 +1,81 @@
+## Notification/listener solution for ruby
+
+## Features
+
+* any number of listners
+* only one event of one kind can be fired per request (cache)
+* disable/enable events (nice feature for tests)
+
+## Configuration for rails
+
+In your Gemfile
+
+```ruby
+gem 'notification_center', github: 'Houdini/notification_center'
+```
+
+config/initializers/notification_center.rb
+
+```ruby
+NotificationCenter.configure do
+  enable_cache = true # only one event fired in one request scope, default is false
+end
+```
+
+## Use
+
+In any class or multiple classes:
+
+```ruby
+class SomeClass
+  observe :some_event
+
+  def some_event_handler # any number of args are possible
+  end
+end
+```
+
+Anywhere in code:
+
+```ruby
+NotificationCenter.post_notification :some_event
+```
+
+## Common practice
+
+Create directory app/listeners and put listeners there, like user_listener.rb
+
+```ruby
+class UserListener
+  observe :user_did_some_action
+  
+  def user_did_some_action_handler
+    # some complex logic
+  end
+end
+```
+
+## Important
+
+Make sure, that your classes are preloaded!
+So for app/listeners, put this code to your application.rb
+
+```ruby
+Dir[Rails.root.join + 'app/listeners/*.rb'].map{|f| require f}
+```
+
+## For rspec
+
+In your spec_helper.rb
+
+```ruby
+require 'notification_center/rspec_helpers'
+```
+
+Then you can use notifications: false in describe, context, it. Like:
+
+```ruby
+describe User, notifications: false do
+
+it "should do smth", notifications: false do
+```

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/lib/notification_center/configuration.rb

@@ -0,0 +1,22 @@
+module NotificationCenter
+  module Configuration
+    VALID_OPTIONS_KEYS = [:enable_cache, :enable_notifications, :method_suffix]
+
+    DEFAULT_ENABLE_CACHE = false
+    DEFAULT_ENABLE_NOTIFICATIONS = true
+    DEFAULT_METHOD_SUFFIX = 'handler'
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.extended base
+      base.reset
+    end
+
+    def reset
+      self.enable_cache = DEFAULT_ENABLE_CACHE
+      self.enable_notifications = DEFAULT_ENABLE_NOTIFICATIONS
+      self.method_suffix = DEFAULT_METHOD_SUFFIX
+      self
+    end
+  end
+end

data/lib/notification_center/core_ext/module.rb

@@ -0,0 +1,17 @@
+module NotificationCenter
+  module CoreExt
+    module Module
+      def observe *events
+        stored_events = NotificationCenter.events.dup
+        for event in events
+          next if stored_events.has_key? event
+          stored_events[event] += Array self
+          stored_events[event] = stored_events[event].uniq
+        end
+        NotificationCenter.events = stored_events
+      end
+    end
+  end
+end
+
+::Module.__send__ :include, NotificationCenter::CoreExt::Module

data/lib/notification_center/rspec_helpers.rb

@@ -0,0 +1,11 @@
+module NotificationCenter
+  module RspecHelpers
+    Rspec.configure do |config|
+      config.around(:each) do |spec|
+        NotificationCenter.enable_notifications = false if spec.metadata[:notifications] == false
+        spec.call
+        NotificationCenter.enable_notifications = true if spec.metadata[:notifications] == false
+      end
+    end
+  end
+end

data/lib/notification_center/version.rb

@@ -0,0 +1,3 @@
+module NotificationCener
+  VERSION = "0.2".freeze
+end

data/lib/notification_center.rb

@@ -0,0 +1,42 @@
+require 'notification_center/core_ext/module'
+require 'notification_center/configuration'
+require 'set'
+
+module NotificationCenter
+  extend Configuration
+  class << self
+    def events; @@events end
+    def events= hash; @@events = hash end
+
+    def flush_cache!; @cache = nil end
+
+    def _initialize_event_store
+      @@events = Hash.new Array.new
+    end
+    alias :forget_observers! :_initialize_event_store
+
+    def post_notification *args
+      event = args.shift
+      if enable_notifications
+        enable_cache ? _with_cache(event){ _notify! event, *args } : _notify!(event, *args)
+      end
+    end
+
+    def _notify! event, *args
+      event_handler = "#{event}_#{method_suffix}"
+      receivers = @@events[event]
+      for receiver in receivers
+        receiver.send event_handler, *args
+      end
+    end
+
+    def _with_cache event
+      @cache ||= Set.new
+      unless @cache.include? event
+        yield
+        @cache << event
+      end
+    end
+  end
+  self._initialize_event_store
+end

data/notification_center.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "notification_center/version"
+
+Gem::Specification.new do |s|
+  s.name        = "notification_center"
+  s.version     = NotificationCener::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Dmitrii Golub"]
+  s.email       = ["dmitrii.golub@gmail.com"]
+  s.homepage    = "http://github.com/Houdini/notification_center"
+  s.summary     = %q{Observer pattern for ruby}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency("bundler")
+  s.add_development_dependency("rspec", "~> 2.10.0")
+  s.add_development_dependency("pry")
+end

data/spec/lib/notification_center_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+
+describe NotificationCenter do
+  describe '.post_notification' do
+    before { NotificationCenter.flush_cache! }
+
+    it "should fire event handler" do
+      EventListener = Class.new { observe :event }
+      EventListener.should_receive(:event_handler)
+      NotificationCenter.post_notification :event
+    end
+
+    it "should not raise any exception when no event" do
+      NotificationCenter.post_notification :imaginary_event
+    end
+
+    context 'when cache disabled' do
+      before { NotificationCenter.enable_cache = false }
+      it "should not fire event twice" do
+        EventListener = Class.new { observe :event }
+        EventListener.should_receive(:event_handler).twice
+
+        NotificationCenter.post_notification :event
+        NotificationCenter.post_notification :event
+      end
+    end
+
+    context 'when cache enabled' do
+      before { NotificationCenter.enable_cache = true }
+
+      it "should not fire event twice" do
+        EventListener = Class.new { observe :event }
+        EventListener.should_receive :event_handler
+
+        NotificationCenter.post_notification :event
+        NotificationCenter.post_notification :event
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'pry'
+require 'notification_center'
+
+RSpec.configure do |config|
+  config.before do
+    NotificationCenter.forget_observers!
+    NotificationCenter.reset
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: notification_center
+version: !ruby/object:Gem::Version
+  version: '0.2'
+  prerelease: 
+platform: ruby
+authors:
+- Dmitrii Golub
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
+email:
+- dmitrii.golub@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/notification_center.rb
+- lib/notification_center/configuration.rb
+- lib/notification_center/core_ext/module.rb
+- lib/notification_center/rspec_helpers.rb
+- lib/notification_center/version.rb
+- notification_center.gemspec
+- spec/lib/notification_center_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/Houdini/notification_center
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Observer pattern for ruby
+test_files:
+- spec/lib/notification_center_spec.rb
+- spec/spec_helper.rb
+has_rdoc: