central_notifications 1.0.0 → 1.0.1

data/README.rdoc

@@ -1,10 +1,15 @@
 == 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.
@@ -28,10 +33,11 @@ You can declare a notifier inside the model by including the module CentralNotif
     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 this way you don't have to declare the notification klass, it will be 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
@@ -55,9 +61,9 @@ Suppose you have classes User and Order, and, you have registered for notificati
     end
   end
   
+  user = User.new
   order = Order.new
   order.payment(100)
-  
   # => "Hey! one user know that one order has been paid!"
   
 If you register notification for another class objects :
@@ -77,6 +83,8 @@ If you register notification for another class objects :
   end
   
 then :
+  user = User.new
+  accounting = Accounting.new
   order = Order.new
   order.payment(100)
   
@@ -91,8 +99,38 @@ You can get in User class the result of Order#payment in the instance variable @
     puts "Payment is : " + @registration_result.to_s
   end
   
+  user = User.new
   order = Order.new
   order.payment(100)
   
   # => "Payment is : 100"
-  
+
+== Acting as Observer
+
+You can use central notifications as observers on attribute values change.
+For that, just register on setter :
+    
+    class Order
+      attr_accessor :amount
+    end
+
+    class User
+      include CentralNotification
+    
+      def amount_has_changed
+        puts "The amount has changed and is now:" + @registration_result.to_s
+      end
+    
+      register_for_notification do |registration, notification|
+        registration.klass = Order
+        registration.method = :amount=
+        notification.method = :amount_has_changed
+      end
+    end
+
+
+
+  user = User.new
+  order = Order.new
+  order.amount = 100
+  #=> From user : The amount has changed and is now: 100

data/lib/registration.rb

@@ -22,7 +22,7 @@ module CentralNotifications
     end
   
     def already_registered?
-      @real_klass.instance_methods.include?(@original_alias_symbol.to_s)
+      @real_klass.instance_methods.map(&:to_sym).include?(@original_alias_symbol)
     end
   
     def set_notifier_in_notifier_class
@@ -35,7 +35,7 @@ module CentralNotifications
       redefine_method
     end
   
-    def redefine_method 
+    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)
@@ -46,7 +46,7 @@ module CentralNotifications
     end
   
     def singleton_method?
-      klass.send(:singleton_methods).include?(method.to_s)  
+      klass.send(:singleton_methods).map(&:to_sym).include?(@method)  
     end
   
     def on_eigenclass?

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: central_notifications
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Philippe Cantin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-19 00:00:00 +01:00
+date: 2010-12-20 00:00:00 +01:00
 default_executable: 
 dependencies: []