central_notifications 1.0.0

data/README.rdoc

@@ -0,0 +1,98 @@
+== Overview
+
+Based on the idea of notifications in objective-C.
+Register an object method for notifications.
+When registered method is called, all objects which have registered will be notified and will be able to know the result of the registered method.
+Can act as Rails observers, by registering on setters methods.
+You can register both class or instance methods.
+Several different objects, with different class can register for same object method.
+
+See tests units for more examples of usage.
+
+== Install
+
+  gem install central_notifications
+
+== Dependencies
+
+none
+
+== Usage
+
+
+=== Declaring a notifier
+==== In the model
+You can declare a notifier inside the model by including the module CentralNotifications and then declare in you model :
+  register_for_notification do |registration, notification|
+    registration.klass = Order
+    registration.method = :payment
+    notification.method = :one_order_has_been_payed
+  end
+In this way you don't have to have to declare the notification.klass which is automatically set to self.
+
+==== In an initializer
+You can register your notification in an initializer (for exemple, in Rails, in a file under config/initializers).
+The analog as previous example will be in this initializer :
+  CentralNotifications.notify do |registration, notification|
+    registration.klass = Order
+    registration.method = :payment
+    notification.klass = User
+    notification.method = :one_order_has_been_payed
+  end
+
+== Example
+Suppose you have classes User and Order, and, you have registered for notification on instance method :payment (as previous)
+
+  class User
+    def one_order_has_been_payed
+     puts "Hey! one user know that one order has been paid!"
+    end
+  end
+  
+  def Order
+    def payment(amount)
+      @amount = amount
+    end
+  end
+  
+  order = Order.new
+  order.payment(100)
+  
+  # => "Hey! one user know that one order has been paid!"
+  
+If you register notification for another class objects :
+
+  class Acounting
+    include CentralNotification
+    
+    def one_order_has_been_payed
+      "Hey ! an accounting object know that one order has been payed"
+    end
+    
+    register_for_notification do |registration, notification|
+      registration.klass = Order
+      registration.method = :payment
+      notification.method = :one_order_has_been_payed
+    end
+  end
+  
+then :
+  order = Order.new
+  order.payment(100)
+  
+   # => "Hey! one user know that one order has been paid!"
+   # => "Hey ! an accounting object know that one order has been payed"
+
+== Retrieve the result of the registered method
+
+You can get in User class the result of Order#payment in the instance variable @registration_result.
+
+  def one_order_has_been_payed
+    puts "Payment is : " + @registration_result.to_s
+  end
+  
+  order = Order.new
+  order.payment(100)
+  
+  # => "Payment is : 100"
+  

data/lib/central_notifications.rb

@@ -0,0 +1,25 @@
+require 'notifier'
+
+module CentralNotifications
+  
+  def self.notify
+    notifier = Notifier.instance
+    notifier.register do |registration, notification|
+      yield registration, notification
+    end
+  end
+  
+  def self.included(klass)
+    class << klass
+      def register_for_notification
+        notifier = Notifier.instance
+        notifier.register do |registration, notification|
+          notification.klass = self
+          yield registration, notification
+        end
+      end
+    end
+    
+  end
+end
+

data/lib/notifier.rb

@@ -0,0 +1,42 @@
+require 'registration'
+
+module CentralNotifications
+  class Notifier
+    attr_accessor :registrations, :klass, :method
+  
+    def initialize args={}
+      @registrations = {}
+    end
+  
+    def self.instance
+      return @@instance ||= Notifier.new
+    end
+  
+    def register
+      registration = Registration.new(:notifier => self)
+      yield registration, self
+
+      registration = registration_from_stack(registration)
+      registrations[registration] ||= []
+      registrations[registration] << {:klass => klass, :method => method}
+      registration.fork
+    end
+  
+    def alert(registration)
+      registrations[registration].each do |notified|
+        ObjectSpace.each_object(notified[:klass]) do |object|
+          object.send(:instance_variable_set, :@registration_result, registration.result)
+          object.send(notified[:method])
+        end
+      end
+    end
+  
+    private
+  
+    def registration_from_stack registration
+      reg = registrations.select {|registered, | registered.klass == registration.klass && registered.method == registration.method}
+      reg.empty? ? registration : reg.first.first 
+    end
+
+  end
+end

data/lib/registration.rb

@@ -0,0 +1,57 @@
+module CentralNotifications
+  class Registration
+    NOTIFIER_CLASS_VARIABLE = :@@_____notifier
+    attr_accessor :klass, :method, :result
+  
+    def initialize(args={})
+      @notifier = args[:notifier]
+    end
+  
+    def fork
+      @real_klass = singleton_method? ? (class << klass; self end) : klass 
+      @original_alias_symbol = original_alias_symbol
+      return if already_registered?
+      set_notifier_in_notifier_class
+      redefine_orinal_method
+    end
+
+    private
+  
+    def original_alias_symbol
+      (method.to_s + '_original___#central_notifications_gem').to_sym
+    end
+  
+    def already_registered?
+      @real_klass.instance_methods.include?(@original_alias_symbol.to_s)
+    end
+  
+    def set_notifier_in_notifier_class
+      @real_klass.send(:class_variable_set, NOTIFIER_CLASS_VARIABLE, @notifier)
+    end
+  
+    def redefine_orinal_method
+      original = @original_alias_symbol
+      @real_klass.send(:alias_method, original, @method)
+      redefine_method
+    end
+  
+    def redefine_method 
+      registration, eigenclass, original = self, on_eigenclass?, @original_alias_symbol
+      @real_klass.send(:define_method, method) do |*params|
+         registration.result = send(original, *params)
+         notifier = (eigenclass ? self : self.class).send(:class_variable_get, NOTIFIER_CLASS_VARIABLE)
+         notifier.alert(registration)
+         registration.result
+       end
+    end
+  
+    def singleton_method?
+      klass.send(:singleton_methods).include?(method.to_s)  
+    end
+  
+    def on_eigenclass?
+      @real_klass.ancestors.first != @real_klass
+    end
+  
+  end
+end  

data/test/helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'test/unit'
+require 'central_notifications'
+require 'models/user'
+require 'models/order'
+require 'models/accounting'
+
+require 'mocha'

data/test/models/accounting.rb

@@ -0,0 +1,17 @@
+class Accounting
+ 
+  def initialize args={}
+    
+  end
+  
+  def one_order_has_been_payed 
+    
+  end
+  
+  def all_orders_has_been_asked
+    
+  end
+  
+
+  
+end

data/test/models/central_notifications_initializer.rb

@@ -0,0 +1,13 @@
+CentralNotifications.notify do |registration, notification|
+  registration.klass = Order
+  registration.method = :payment
+  notification.klass = Accounting
+  notification.method = :one_order_has_been_payed
+end
+
+CentralNotifications.notify do |registration, notification|
+  registration.klass = Order
+  registration.method = :all
+  notification.klass = Accounting
+  notification.method = :all_orders_has_been_asked
+end

data/test/models/order.rb

@@ -0,0 +1,19 @@
+class Order
+  attr_accessor :amount, :currency
+  
+  def initialize args={}
+    
+  end
+  
+  def payment amount, currency=:euro
+    @amount = amount
+    @currency = currency
+    "payment done"
+  end
+  
+  def self.all
+    
+  end
+  
+  
+end

data/test/models/user.rb

@@ -0,0 +1,43 @@
+require 'central_notifications'
+require 'models/order'
+
+class User
+  include CentralNotifications
+ 
+  attr_accessor :new_amount
+  
+  def initialize args={}
+    
+  end
+  
+  def one_order_has_been_payed 
+    
+  end
+  
+  def all_orders_has_been_asked
+    
+  end
+  
+  def amount_has_changed
+    @new_amount = @registration_result
+  end
+  
+  register_for_notification do |registration, notification|
+    registration.klass = Order
+    registration.method = :payment
+    notification.method = :one_order_has_been_payed
+  end
+  
+  register_for_notification do |registration, notification|
+    registration.klass = Order
+    registration.method = :all
+    notification.method = :all_orders_has_been_asked
+  end
+  
+  register_for_notification do |registration, notification|
+    registration.klass = Order
+    registration.method = :amount=
+    notification.method = :amount_has_changed
+  end
+  
+end

data/test/test_notifier.rb

@@ -0,0 +1,66 @@
+# User use central notifications by including module, Accounting by initializer
+
+require 'helper'
+require 'models/central_notifications_initializer'
+
+class TestNotifier < Test::Unit::TestCase
+ 
+  def test_notifier_should_have_singleton_instance
+    assert_equal CentralNotifications::Notifier.instance , CentralNotifications::Notifier.instance
+  end
+  
+  def test_when_registered_method_is_called_method_triggered_of_registering_objects_should_be_called
+    user, admin, order = User.new, User.new,  Order.new
+
+    user.expects(:one_order_has_been_payed)
+    admin.expects(:one_order_has_been_payed)
+    
+    order.payment(100, :usd)
+  end 
+  
+  def test_should_call_orinal_method_with_original_parameters
+    user, order = User.new, Order.new
+    
+    order.payment(100, :usd)
+
+    assert_equal 100, order.amount
+    assert_equal :usd, order.currency
+  end
+  
+  def test_aliased_method_should_return_orginal_method_result
+    assert_equal "payment done", Order.new.payment(100)
+  end
+  
+  def test_notified_method_should_be_able_to_know_the_return_of_notfied_method
+    user, order = User.new, Order.new
+    
+    result = order.payment(100, :usd)
+
+    assert_equal result, user.instance_variable_get(:@registration_result)
+  end
+  
+  def test_should_notify_class_method
+    user = User.new
+    
+    user.expects(:all_orders_has_been_asked)
+    Order.all
+  end
+  
+  def test_should_be_able_to_act_as_observer_on_attributes_change
+    user, order = User.new, Order.new
+    
+    user.expects(:amount_has_changed)
+    order.amount = 200
+    assert_equal 200, order.amount
+  end
+  
+  def test_notifications_on_same_klass_method_for_many_objects_should_be_able
+    user, accounting, order = User.new, Accounting.new, Order.new
+    
+    user.expects(:one_order_has_been_payed)
+    accounting.expects(:one_order_has_been_payed)
+    
+    order.payment(100)
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: central_notifications
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Philippe Cantin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-19 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: "\n   Based on the idea of notifications in objective-C.\n   Register an object method for notifications.\n   When registered method is called, all objects which have registered will be notified and\n   will be able to know the result of the registered method.\n   Can replace Rails observers.\n  "
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/central_notifications.rb
+- lib/notifier.rb
+- lib/registration.rb
+- README.rdoc
+- test/helper.rb
+- test/models/accounting.rb
+- test/models/central_notifications_initializer.rb
+- test/models/order.rb
+- test/models/user.rb
+- test/test_notifier.rb
+has_rdoc: true
+homepage: http://github.com/anoiaque/central_notifications
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Register an object method for notifications
+test_files: 
+- test/helper.rb
+- test/models/accounting.rb
+- test/models/central_notifications_initializer.rb
+- test/models/order.rb
+- test/models/user.rb
+- test/test_notifier.rb