tiny_bus 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efb4754b66b36fa51ecd847ef7a0a92b8ef884c662e50d51cb3a1353d5fe98dc
-  data.tar.gz: dc6c393864d50f47131e7efc4dd2ec90781b5552ef68a452b4d0a92998dceb88
+  metadata.gz: d4d536f5d26c59f828baf005884e8d6be51596b61c151a2c77e129c2a1f80305
+  data.tar.gz: 885f08feed148a3808dfde24a38871544e01ac82fe27114ef8000e7fe0f8a630
 SHA512:
-  metadata.gz: 4275c81f97f72fca9aa1d33a8cdff08afc70392539b3d98096a7878118c69f7eabd5fbb9e336c76a3adf357130ec492ce78715aed3edfe6cb83d83e605ec4e68
-  data.tar.gz: 99dc348ba1e2d1281da1bd84976a6b54bb14792633f93a36e4bf507cc7fe5e1a48faae79a2d24fd6e9fd15c88c5dbcf1533b6c72e264ffb41a751e88ae432580
+  metadata.gz: 8ead2a2d5889921a3544a8ffc91fe93929bb3a52efe3edd1de14c0046533641f7a170f1de32b065cdeb19984d007904a6ef391a9b58fcb61839baf557868a33e
+  data.tar.gz: 453bd1af26f50d84155a45ba454f66fbdf1cd83b6418cd0543120c3a012a0f91738d6109faea9f983656ed4bdd2ebf0992de95ca449fc3fcbeb0b154a008bd6c

data/lib/tiny_bus.rb

@@ -6,23 +6,23 @@ require 'tiny_log'
 # This class implements a very simpler PubSub system where:
 # - subscribers can subscribe via the #sub method
 # - subscribers can unsubscribe via the #unsub method
-# - msgs can enter the MsgBus via the #msg method
+# - msgs can enter the TinyBus via the #msg method
 #
-# The messages that come into this MsgBus are assumed to be Hash-like, in the
+# The messages that come into this TinyBus are assumed to be Hash-like, in the
 # sense that they have a 'topic' key that can be accessed using Hash-like key
 # access syntax, and that the 'topic' key will serve as the method of
 # distribution.
 #
 # Usage:
-#   mb = MsgBus.new
-#   mb.sub('news', <some object that responds to #msg)
-#   mb.msg({'topic' => 'news', 'details' => 'Historic happenings!})     # goes to 'news' subscribers
-#   mb.msg({'topic' => 'whatever', 'details' => 'Historic happenings!}) # goes to dead letter output, or raises exception, depending on the configuration
+#   t = TinyBus.new
+#   t.sub('news', <some object that responds to #msg)
+#   t.msg({'topic' => 'news', 'details' => 'Historic happenings!})     # goes to 'news' subscribers
+#   t.msg({'topic' => 'whatever', 'details' => 'Historic happenings!}) # goes to dead letter output, or raises exception, depending on the configuration
 #
 # Initialization options:
-#   MsgBus.new(log: <some object that responds to #puts>)               # will send a copy of all successful messages to the log
-#   MsgBus.new(dead: <some object that responds to #puts>)              # will send a copy of all unsuccessful messages to the dead object
-#   MsgBus.new(raise_on_dead: true)                                     # strict mode for undeliverable messages, defaults to false
+#   TinyBus.new(log: <some object that responds to #puts>)               # will send a copy of all successful messages to the log
+#   TinyBus.new(dead: <some object that responds to #puts>)              # will send a copy of all unsuccessful messages to the dead object
+#   TinyBus.new(raise_on_dead: true)                                     # strict mode for undeliverable messages, defaults to false
 class TinyBus
   # log:
   #   if specified it should be a valid filename
@@ -45,11 +45,11 @@ class TinyBus
   # adds a subscriber to a topic
   #
   # topics can be any string that doesn't start with a dot (.) - dot topics are
-  # reserved for internal MsgBus usage, such as:
+  # reserved for internal TinyBus usage, such as:
   # - .log
   def sub(topic, subber)
-    raise SubscriptionToDotTopicError.new("Cannot subscribe to dot topic `#{topic}', because these are reserved for internal use") if topic.start_with?('.')
-    raise SubscriberDoesNotMsg.new("The specified subscriber type `#{subber.class.inspect}' does not respond to #msg") unless subber.respond_to?(:msg)
+    raise TinyBus::SubscriptionToDotTopicError.new("Cannot subscribe to dot topic `#{topic}', because these are reserved for internal use") if topic.start_with?('.')
+    raise TinyBus::SubscriberDoesNotMsg.new("The specified subscriber type `#{subber.class.inspect}' does not respond to #msg") unless subber.respond_to?(:msg)
 
     @subs[topic] ||= Set.new
     @subs[topic] << subber
@@ -84,7 +84,7 @@ class TinyBus
       @log.puts annotated
     else
       if @raise_on_dead
-        raise DeadMsgException.new("Could not deliver message to topic `#{t}'")
+        raise TinyBus::DeadMsgError.new("Could not deliver message to topic `#{t}'")
       else
         @stats['.dead'] += 1
         @dead.puts annotated
@@ -92,13 +92,16 @@ class TinyBus
     end
   end
 
+  # helpful for debugging, gives you a count of the number of messages sent to
+  # each topic, including the .dead topic, which is where messages go where
+  # there are no subscribes for a given topic
   def to_s
     <<~DEBUG
-    MsgBus stats: #{@subs.keys.length > 0 ? "\n  " + @stats.keys.sort.map{|t| "#{t.rjust(12)}: #{@stats[t]}" }.join("\n  ") : '<NONE>'}
+    TinyBus stats: #{@subs.keys.length > 0 ? "\n  " + @stats.keys.sort.map{|t| "#{t.rjust(12)}: #{@stats[t]}" }.join("\n  ") : '<NONE>'}
     DEBUG
   end
 end
 
-class DeadMsgError < RuntimeError; end
-class SubscriptionToDotTopicError < RuntimeError; end
-class SubscriberDoesNotMsg < RuntimeError; end
+class TinyBus::DeadMsgError < RuntimeError; end
+class TinyBus::SubscriptionToDotTopicError < RuntimeError; end
+class TinyBus::SubscriberDoesNotMsg < RuntimeError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tiny_bus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jeff Lunt