notifyhub 0.0.2 → 0.0.3

data/lib/notifyhub.rb

@@ -1,16 +1,16 @@
-# 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).
+# {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
+# {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).
+# ({NotifyHub}, {NotifySet}, and {Notify}).
 #
-# Example:
+# Usage example:
 #
 #    require 'notifyhub'
 #
@@ -19,9 +19,9 @@
 #
 #        # Handle to NotifyHub.
 #        attr_accessor :hub
-#        
+#
 #        def initialize
-#            # Create NotifyHub.
+#            # Create NotifyHub with 3 callbacks.
 #            @hub = NotifyHub.declare( :store, :load, :na )
 #        end
 #
@@ -48,14 +48,18 @@
 #
 #    # Setup notify action for load.
 #    storage.hub[ :load ].action do |data|
-#        puts "load: #{data}"
+#        puts "load:  #{data}"
 #    end
 #
 #
 #    # Use storage and get notifications.
 #    storage.store( "my data" )
 #    data = storage.load
-
+#
+#
+# Produces:
+#   store: my data
+#   load:  my data
 class NotifyHub
 
 
@@ -63,14 +67,14 @@ class NotifyHub
     attr_accessor :autodeclare
 
 
-    # Non-existing Notify error.
+    # Non-existing {Notify} error.
     class NotFound < RuntimeError; end
 
-    # Redefining Notify error.
+    # Redefining {Notify} error.
     class Redefining < RuntimeError; end
 
 
-    # Create NotifyHub and declare sets.
+    # Create {NotifyHub} and declare sets.
     #
     # @param id [Array<Symbol>] Notify set(s).
     def NotifyHub.declare( *id )
@@ -78,7 +82,7 @@ class NotifyHub
     end
 
 
-    # Create NotifyHub and with autodeclare for sets. Declare sets
+    # Create {NotifyHub} and with autodeclare for sets. Declare sets
     # automatically at action registration.
     #
     # @param id [Array<Symbol>] Notify set(s).
@@ -89,7 +93,7 @@ class NotifyHub
     end
 
 
-    # Create NotifyHub and run block with it.
+    # Create {NotifyHub} and run block with it.
     #
     # @yield Block to run with NotifyHub.
     def NotifyHub.create( &blk )
@@ -99,7 +103,7 @@ class NotifyHub
         end
         cg
     end
-    
+
 
     # Instantiation.
     #
@@ -111,7 +115,7 @@ class NotifyHub
     end
 
 
-    # Declare Notify by set. Multiple notifiers can exist per set.
+    # Declare {Notify} by set. Multiple notifiers can exist per set.
     #
     # @param id [Array<Symbol>] Notify set id(s).
     def declare( *id )
@@ -125,19 +129,19 @@ class NotifyHub
     end
 
 
-    # Register action to NotifySet. Multiple notifies can
+    # 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 )            
+            set.action( &action )
         end
     end
 
-    alias register action 
-    alias with     action 
+    alias register action
+    alias with     action
 
 
     # Remove all or one Notify.
@@ -151,7 +155,7 @@ class NotifyHub
     end
 
 
-    # Enable/disable Notify set or all if not set.
+    # 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.
@@ -166,9 +170,9 @@ class NotifyHub
             end
         end
     end
-    
-    
-    # Run all notifiers in Notify set.
+
+
+    # Run all notifiers in {Notify} set.
     #
     # @param id [Symbol] Notify set id (class).
     # @param args [Array<Object>] Arguments for notifiers.
@@ -179,7 +183,7 @@ class NotifyHub
     end
 
 
-    # Get NotifySet by ID.
+    # Get {NotifySet} by ID.
     #
     # @param id [Symbol] Set ID.
     # @return [NotifySet] Set.
@@ -190,7 +194,7 @@ class NotifyHub
     end
 
 
-    # Get list of NotifySet IDs.
+    # Get list of {NotifySet} IDs.
     #
     # @return [Array<Symbol>] NotifySet IDs.
     def ids
@@ -201,7 +205,7 @@ class NotifyHub
 
     private
 
-    # Check that NotifySet exists (or create it).
+    # Check that {NotifySet} exists (or create it).
     def withSet( id, &blk )
         if @set[id]
             yield @set[ id ]
@@ -211,9 +215,9 @@ class NotifyHub
     end
 
 
-    # Check that NotifySet exists (or create it).
+    # Check that {NotifySet} exists (or create it).
     def useSet( id, &blk )
-        
+
         if @set[id] || @autodeclare
 
             unless @set[id]
@@ -228,17 +232,18 @@ class NotifyHub
 
         end
     end
-        
+
 end
 
 
 
-# Notify object that includes disable/enable features.
+# {Notify} object container that includes disable/enable features.
 class NotifySet
-    
-    # Enable/disable NotifySet.
+
+
+    # Enable/disable {NotifySet}.
     attr_accessor :enable
-    
+
 
     # Instantiation.
     #
@@ -248,9 +253,9 @@ class NotifySet
         @enable = true
         @list = []
     end
-    
 
-    # Enable/disable Notify set.
+
+    # Enable/disable {NotifySet}.
     #
     # @param value [Boolean] Enable with true and disable with false.
     def enable( value )
@@ -258,22 +263,22 @@ class NotifySet
     end
 
 
-    # Register Notify.
+    # Register {Notify}.
     #
-    # @param action [Block] Notify action.
+    # @param action [Block] {Notify} action.
     def action( &action )
         n = Notify.new( &action )
         @list.push n
         n
     end
 
-    alias register action 
-    alias with     action 
+    alias register action
+    alias with     action
 
 
     # Remove all or one Notify.
     #
-    # @param notify [Notify] Notify to remove (all if not given).
+    # @param notify [Notify] {Notify} to remove (all if not given).
     def remove( notify = nil )
         if notify
             @list.delete( notify )
@@ -282,7 +287,7 @@ class NotifySet
         end
     end
 
-    # Run all notifiers in Notify set.
+    # Run all notifiers in {NotifySet}.
     #
     # @param args [Array<Object>] Arguments for notifiers.
     # @return [Array<Object>] Array or single callback return value.
@@ -312,7 +317,7 @@ class NotifySet
     end
 
 
-    # Get Notify by index.
+    # Get {Notify} by index.
     def []( idx )
         @list[ idx ]
     end
@@ -347,7 +352,7 @@ class Notify
     end
 
 
-    # Enable/disable Notify.
+    # Enable/disable {Notify}.
     #
     # @param value [Boolean] Enable with true and disable with false.
     def enable( value )
@@ -355,3 +360,7 @@ class Notify
     end
 
 end
+
+
+# Include version definitions.
+require_relative 'version'

data/test/test_notifyhub.rb

@@ -1,57 +1,15 @@
 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 )
@@ -75,7 +33,7 @@ class NotifyHubTest < Test::Unit::TestCase
         @check = {}
 
         @n = NotifyHub.auto
-    
+
         @n[ :on ].action do |val|
             @check[ :create_1 ] = val
         end
@@ -140,7 +98,7 @@ class NotifyHubTest < Test::Unit::TestCase
             n[ :off ].action do |val|
                 @check[ :create_3 ] = val
             end
-            
+
             n[ :on ].notify( 1 )
             n.notify( :off, 2 )
 
@@ -183,7 +141,7 @@ class NotifyHubTest < Test::Unit::TestCase
         @n[ :off ].notify( 2 )
         assert_equal( 1, @check[ :create_1 ] )
         assert_equal( 1, @check[ :create_2 ] )
-        assert_equal( 2, @check[ :create_3 ] ) 
+        assert_equal( 2, @check[ :create_3 ] )
     end
 
 
@@ -226,4 +184,10 @@ class NotifyHubTest < Test::Unit::TestCase
 
     end
 
+
+    def test_ids
+        assert_equal( [ :on, :off ], @n.ids )
+    end
+
+
 end

metadata

@@ -1,92 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: notifyhub
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Tero Isannainen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-21 00:00:00.000000000 Z
+date: 2014-11-23 00:00:00.000000000 Z
 dependencies: []
-description: ! 'NotifyHub is a callback facility. NotifyHub is used by the informer
-
+description: |-
+  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).'
+  (NotifyHub, NotifySet, and Notify).
 email: tero.isannainen@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- README.rdoc
 - CHANGELOG.rdoc
 - LICENSE
-- Rakefile
-- lib/notifyhub.rb
-- test/test_notifyhub.rb
-- doc/top-level-namespace.html
-- doc/js/full_list.js
-- doc/js/app.js
-- doc/js/jquery.js
-- doc/index.html
+- README.rdoc
 - doc/Master.html
 - doc/Notify.html
+- doc/NotifyHub.html
+- doc/NotifyHub/NotFound.html
+- doc/NotifyHub/Redefining.html
+- doc/NotifySet.html
+- doc/_index.html
+- doc/class_list.html
 - doc/css/common.css
 - doc/css/full_list.css
 - doc/css/style.css
+- doc/file.CHANGELOG.html
 - doc/file.README.html
-- doc/method_list.html
 - doc/file_list.html
-- doc/NotifyHub/Redefining.html
-- doc/NotifyHub/NotFound.html
-- doc/NotifySet.html
-- doc/NotifyHub.html
-- doc/class_list.html
-- doc/_index.html
-- doc/file.CHANGELOG.html
 - doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/notifyhub.rb
+- test/test_notifyhub.rb
 homepage: 
 licenses:
 - Ruby
+metadata: {}
 post_install_message: Check README...
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: NotifyHub is implementation of the Observer pattern using composition.
 test_files: []
 has_rdoc: 

data/Rakefile

@@ -1,28 +0,0 @@
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-    t.libs << 'test'
-end
-
-desc "Run tests"
-task :default => :test
-
-task :cleanup_test do
-    sh "rm -rf test/test"
-end
-
-task :build => :doc do
-    sh "gem build notifyhub.gemspec"
-end
-
-task :doc do
-    sh "yardoc lib/* - README.rdoc CHANGELOG.rdoc"
-end
-
-task :publish do
-    if Dir.glob('notifyhub-*gem').length == 1
-        sh "gem push notifyhub*.gem"
-    else
-        raise "Multiple gems in the directory..."
-    end
-end