RubyGems - notifyhub - Versions diffs - 0.0.1 - Mend

notifyhub 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (28) hide show

data/CHANGELOG.rdoc +3 -0
data/LICENSE +20 -0
data/README.rdoc +19 -0
data/Rakefile +28 -0
data/doc/Master.html +396 -0
data/doc/Notify.html +432 -0
data/doc/NotifyHub/NotFound.html +134 -0
data/doc/NotifyHub/Redefining.html +134 -0
data/doc/NotifyHub.html +1312 -0
data/doc/NotifySet.html +762 -0
data/doc/_index.html +145 -0
data/doc/class_list.html +53 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +338 -0
data/doc/file.CHANGELOG.html +79 -0
data/doc/file.README.html +93 -0
data/doc/file_list.html +58 -0
data/doc/frames.html +28 -0
data/doc/index.html +93 -0
data/doc/js/app.js +214 -0
data/doc/js/full_list.js +178 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +178 -0
data/doc/top-level-namespace.html +112 -0
data/lib/notifyhub.rb +339 -0
data/test/test_notifyhub.rb +229 -0
metadata +92 -0

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,112 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.8.6.1
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Notify.html" title="Notify (class)">Notify</a></span>, <span class='object_link'><a href="NotifyHub.html" title="NotifyHub (class)">NotifyHub</a></span>, <span class='object_link'><a href="NotifySet.html" title="NotifySet (class)">NotifySet</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Sun Jan 19 21:55:11 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.6.1 (ruby-1.9.3).
+</div>
+  </body>
+</html>

data/lib/notifyhub.rb ADDED Viewed

@@ -0,0 +1,339 @@
+# NotifyHub is a callback facility. NotifyHub is used by the informer
+# to notify clients about arbitrary events in the informer. NotifyHub
+# contains notification sets (NotifySet).
+#
+# NotifySet is identified by set ID and it can include one or many
+# notifications (Notify). Client defines the action performed at
+# notification (callback). Informer activates the notification when
+# notification events occur.
+#
+# Notifications can be enabled/disabled on different levels
+# (NotifyHub, NotifySet, and Notify).
+#
+# Example:
+#
+#    require 'notifyhub'
+#
+#    # Create class that includes interesting events.
+#    class Storage
+#
+#        # Handle to NotifyHub.
+#        attr_accessor :hub
+#
+#        def initialize
+#            # Create NotifyHub.
+#            @hub = NotifyHub.declare( :store, :load, :na )
+#        end
+#
+#        # Store data and notify clients.
+#        def store( data )
+#            @data = data
+#            @hub[ :store ].notify( @data )
+#        end
+#
+#        # Load data and notify clients.
+#        def load
+#            @hub[ :load ].notify( @data )
+#            @data
+#        end
+#    end
+#
+#
+#    storage = Storage.new
+#
+#    # Setup notify action for store.
+#    storage.hub[ :store ].action do |data|
+#        puts "store: #{data}"
+#    end
+#
+#    # Setup notify action for load.
+#    storage.hub[ :load ].action do |data|
+#        puts "load: #{data}"
+#    end
+#
+#
+#    # Use storage and get notifications.
+#    storage.store( "my data" )
+#    data = storage.load
+class NotifyHub
+    # Declare sets automatically at action registration.
+    attr_accessor :autodeclare
+    # Non-existing Notify error.
+    class NotFound < RuntimeError; end
+    # Redefining Notify error.
+    class Redefining < RuntimeError; end
+    # Create NotifyHub and declare sets.
+    #
+    # @param id [Array<Symbol>] Notify set(s).
+    def NotifyHub.declare( *id )
+        NotifyHub.new( *id )
+    end
+    # Create NotifyHub and with autodeclare for sets. Declare sets
+    # automatically at action registration.
+    #
+    # @param id [Array<Symbol>] Notify set(s).
+    def NotifyHub.auto( *id )
+        n = NotifyHub.new( *id )
+        n.autodeclare = true
+        n
+    end
+    # Create NotifyHub and run block with it.
+    #
+    # @yield Block to run with NotifyHub.
+    def NotifyHub.create( &blk )
+        cg = NotifyHub.new
+        if block_given?
+            cg.instance_eval( &blk )
+        end
+        cg
+    end
+    # Instantiation.
+    #
+    # @param id [Array<Symbol>] Notify set id(s).
+    def initialize( *id )
+        @autodeclare = false
+        @set = {}
+        declare( *id )
+    end
+    # Declare Notify by set. Multiple notifiers can exist per set.
+    #
+    # @param id [Array<Symbol>] Notify set id(s).
+    def declare( *id )
+        id.each do |i|
+            if @set[ i ]
+                raise Redefining, "Notify set already declared: #{i.to_s}"
+            else
+                @set[ i ] = NotifySet.new( i )
+            end
+        end
+    end
+    # Register action to NotifySet. Multiple notifies can
+    # exist per set.
+    #
+    # @param id [Symbol] Notify set id (class).
+    # @param action [Block] Notify action.
+    def action( id, &action )
+        useSet( id ) do |set|
+            set.action( &action )
+        end
+    end
+    alias register action
+    alias with     action
+    # Remove all or one Notify.
+    #
+    # @param id [Symbol] Notify set id (class).
+    # @param notify [Notify] Notify to remove (all if not given).
+    def remove( id, notify = nil )
+        withSet( id ) do |set|
+            set.remove( notify )
+        end
+    end
+    # Enable/disable Notify set or all if not set.
+    #
+    # @param id [Symbol] Notify set id (all if nil given).
+    # @param value [Boolean] Enable with true and disable with false.
+    def enable( id, value )
+        if id
+            withSet( id ) do |set|
+                set.enable = value
+            end
+        else
+            @set.each_value do |set|
+                set.enable = value
+            end
+        end
+    end
+    # Run all notifiers in Notify set.
+    #
+    # @param id [Symbol] Notify set id (class).
+    # @param args [Array<Object>] Arguments for notifiers.
+    def notify( id, *args )
+        withSet( id ) do |set|
+            set.notify( *args )
+        end
+    end
+    # Get NotifySet by ID.
+    #
+    # @param id [Symbol] Set ID.
+    # @return [NotifySet] Set.
+    def []( id )
+        useSet( id ) do |set|
+            set
+        end
+    end
+    private
+    # Check that NotifySet exists (or create it).
+    def withSet( id, &blk )
+        if @set[id]
+            yield @set[ id ]
+        else
+            raise NotFound, "Uknown notify set: #{id.to_s}"
+        end
+    end
+    # Check that NotifySet exists (or create it).
+    def useSet( id, &blk )
+        if @set[id] || @autodeclare
+            unless @set[id]
+                declare( id )
+            end
+            yield @set[ id ]
+        else
+            raise NotFound, "Uknown notify set: #{id.to_s}"
+        end
+    end
+end
+# Notify object that includes disable/enable features.
+class NotifySet
+    # Enable/disable NotifySet.
+    attr_accessor :enable
+    # Instantiation.
+    #
+    # @param id [Symbol] Id of the set.
+    def initialize( id = nil )
+        @id = id
+        @enable = true
+        @list = []
+    end
+    # Enable/disable Notify set.
+    #
+    # @param value [Boolean] Enable with true and disable with false.
+    def enable( value )
+        @enable = value
+    end
+    # Register Notify.
+    #
+    # @param action [Block] Notify action.
+    def action( &action )
+        n = Notify.new( &action )
+        @list.push n
+        n
+    end
+    alias register action
+    alias with     action
+    # Remove all or one Notify.
+    #
+    # @param notify [Notify] Notify to remove (all if not given).
+    def remove( notify = nil )
+        if notify
+            @list.delete( notify )
+        else
+            @list = []
+        end
+    end
+    # Run all notifiers in Notify set.
+    #
+    # @param args [Array<Object>] Arguments for notifiers.
+    def notify( *args )
+        if @enable
+            @list.each do |n|
+                n.notify( *args )
+            end
+        end
+    end
+    # Iterate over list of notifiers.
+    def each
+        @list.each do |n|
+            yield n
+        end
+    end
+    # Get Notify by index.
+    def []( idx )
+        @list[ idx ]
+    end
+end
+# Notify object including disable/enable possibility.
+class Notify
+    # Enabled/disabled status.
+    attr_reader :enable
+    # Instantiation.
+    #
+    # @param action [Proc] Notification action.
+    def initialize( &action )
+        @action = action
+        @enable = true
+    end
+    # Perform notification action if enabled.
+    #
+    # @param args [Array<Object>] Data provided to action.
+    def notify( *args )
+        if @enable
+            @action.yield( *args )
+        end
+    end
+    # Enable/disable Notify.
+    #
+    # @param value [Boolean] Enable with true and disable with false.
+    def enable( value )
+        @enable = value
+    end
+end

data/test/test_notifyhub.rb ADDED Viewed

@@ -0,0 +1,229 @@
+require 'test/unit'
+require 'notifyhub'
+#    # Create class that includes interesting events.
+#    class Storage
+#
+#        # Handle to NotifyHub.
+#        attr_accessor :hub
+#
+#        def initialize
+#            # Create NotifyHub.
+#            @hub = NotifyHub.declare( :store, :load, :na )
+#        end
+#
+#        # Store data and notify clients.
+#        def store( data )
+#            @data = data
+#            @hub[ :store ].notify( @data )
+#        end
+#
+#        # Load data and notify clients.
+#        def load
+#            @hub[ :load ].notify( @data )
+#            @data
+#        end
+#    end
+#
+#
+#    storage = Storage.new
+#
+#    # Setup notify action for store.
+#    storage.hub[ :store ].action do |data|
+#        puts "store: #{data}"
+#    end
+#
+#    # Setup notify action for load.
+#    storage.hub[ :load ].action do |data|
+#        puts "load: #{data}"
+#    end
+#
+#
+#    # Use storage and get notifications.
+#    storage.store( "my data" )
+#    data = storage.load
+class NotifyHubTest < Test::Unit::TestCase
+    # Create class that includes interesting events.
+    class Storage
+        # Handle to NotifyHub.
+        attr_accessor :hub
+        def initialize
+            # Create NotifyHub.
+            @hub = NotifyHub.declare( :store, :load, :na )
+        end
+        # Store data and notify clients.
+        def store( data )
+            @data = data
+            @hub[ :store ].notify( @data )
+        end
+        # Load data and notify clients.
+        def load
+            @hub[ :load ].notify( @data )
+            @data
+        end
+    end
+    def setup
+        @check = {}
+        @n = NotifyHub.auto
+        @n[ :on ].action do |val|
+            @check[ :create_1 ] = val
+        end
+        @n[ :on ].action do |val|
+            @check[ :create_2 ] = val
+        end
+        @n[ :off ].action do |val|
+            @check[ :create_3 ] = val
+        end
+    end
+    def test_integration
+        storage = Storage.new
+        store_data = nil
+        load_data = nil
+        # Setup notify action for store.
+        storage.hub[ :store ].action do |data|
+            @check[:store_data] = data
+        end
+        # Setup notify action for load.
+        storage.hub[ :load ].action do |data|
+            @check[:load_data] = data
+        end
+        storage.store( "my data" )
+        storage.load
+        assert_equal( @check[:store_data], "my data" )
+        assert_equal( @check[:load_data], "my data" )
+    end
+    def test_defining
+        [ :declare, :create, :auto ].each do |type|
+            case type
+            when :declare; n = NotifyHub.declare( :on, :off )
+            when :create
+                n = NotifyHub.create do
+                    declare( :on, :off )
+                end
+            when :auto; n = NotifyHub.auto
+            end
+            n[ :on ].action do |val|
+                @check[ :create_1 ] = val
+            end
+            n[ :on ].action do |val|
+                @check[ :create_2 ] = val
+            end
+            n[ :off ].action do |val|
+                @check[ :create_3 ] = val
+            end
+            n[ :on ].notify( 1 )
+            n.notify( :off, 2 )
+            assert_equal( 1, @check[ :create_1 ] )
+            assert_equal( 1, @check[ :create_2 ] )
+            assert_equal( 2, @check[ :create_3 ] )
+            n = NotifyHub.create do
+                declare( :on, :off )
+            end
+        end
+    end
+    def test_enable_set
+        @n[ :off ].enable( false )
+        @n[ :off ].notify( 1 )
+        assert_equal( nil, @check[ :create_3 ] )
+        @n[ :off ].enable( true )
+        @n[ :off ].notify( 1 )
+        assert_equal( 1, @check[ :create_3 ] )
+    end
+    def test_enable_one
+        @n[ :on ][ 0 ].enable( false )
+        @n[ :on ].notify( 1 )
+        @n[ :off ].notify( 2 )
+        assert_equal( nil, @check[ :create_1 ] )
+        assert_equal( 1, @check[ :create_2 ] )
+        assert_equal( 2, @check[ :create_3 ] )
+        @n[ :on ].each do |i|
+            i.enable( true )
+        end
+        @n[ :on ].notify( 1 )
+        @n[ :off ].notify( 2 )
+        assert_equal( 1, @check[ :create_1 ] )
+        assert_equal( 1, @check[ :create_2 ] )
+        assert_equal( 2, @check[ :create_3 ] )
+    end
+    def test_remove
+        @n[ :on ].remove( @n[ :on ][ 0 ] )
+        @n[ :on ].notify( 1 )
+        @n[ :off ].notify( 2 )
+        assert_equal( nil, @check[ :create_1 ] )
+        assert_equal( 1, @check[ :create_2 ] )
+        assert_equal( 2, @check[ :create_3 ] )
+    end
+    def test_errors
+        n = NotifyHub.declare( :on, :off )
+        begin
+            n[ :not ].action do |val|
+                puts "This does not activate..."
+            end
+        rescue NotifyHub::NotFound
+            @check[ :error_action ] = true
+        end
+        assert_equal( true, @check[ :error_action ] )
+        begin
+            n[ :not ].notify( 2 )
+        rescue NotifyHub::NotFound
+            @check[ :error_notify ] = true
+        end
+        assert_equal( true, @check[ :error_notify ] )
+        begin
+            n.declare( :on )
+        rescue NotifyHub::Redefining
+            @check[ :error_redecl ] = true
+        end
+        assert_equal( true, @check[ :error_redecl ] )
+    end
+end