tiny_bus 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efb4754b66b36fa51ecd847ef7a0a92b8ef884c662e50d51cb3a1353d5fe98dc
-  data.tar.gz: dc6c393864d50f47131e7efc4dd2ec90781b5552ef68a452b4d0a92998dceb88
+  metadata.gz: fb6142b34ec3c5c72a2a4073b080d8aba77dd40b9c04df3df89d9802a26c5c39
+  data.tar.gz: b94962edf28bd4ad4affecb69cfd6d68d298b6623b98518cbbc9059fc117c83d
 SHA512:
-  metadata.gz: 4275c81f97f72fca9aa1d33a8cdff08afc70392539b3d98096a7878118c69f7eabd5fbb9e336c76a3adf357130ec492ce78715aed3edfe6cb83d83e605ec4e68
-  data.tar.gz: 99dc348ba1e2d1281da1bd84976a6b54bb14792633f93a36e4bf507cc7fe5e1a48faae79a2d24fd6e9fd15c88c5dbcf1533b6c72e264ffb41a751e88ae432580
+  metadata.gz: 1a29c06a16aab93b03d5a68384c55a4f461dd2a5e3b06c888d0d420325cd169dd1a16284af10a467eeb6953a525a809287deed3b25781a831ade89847d8dd0aa
+  data.tar.gz: 05de4ca2e32edad9a3d63a065752c1990135d5de66710f957dfbc49838a6f45e2ffb9b4c901f831a073bbf14dd4a5291ef62c9d96a9219a9021c4a32f197176b

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 those 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
@@ -70,8 +70,11 @@ class TinyBus
   # NOTE: it modifies the incoming msg object in place in order to avoid
   # unnecessary object allocations
   def msg(msg)
-    t = msg['topic']
-    subbers = @subs[t]
+    topic = msg['topic']
+
+    raise TinyBus::SendToDotTopicError.new("Cannot send to dot topic `#{topic}', because those are reserved for internal use") if topic.start_with?('.')
+
+    subbers = @subs[topic]
 
     annotated = msg.merge!({
                 '.time' => Time.now.utc.iso8601(6),
@@ -79,12 +82,12 @@ class TinyBus
               })
 
     if subbers
-      @stats[t] += 1
+      @stats[topic] += 1
       subbers.each{|s| s.msg(annotated) }
       @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 `#{topic}'")
       else
         @stats['.dead'] += 1
         @dead.puts annotated
@@ -92,13 +95,17 @@ 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
+class TinyBus::SendToDotTopicError< 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.2
 platform: ruby
 authors:
 - Jeff Lunt
@@ -24,9 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: want to have an in-memory message bus that takes hash-like objects and
-  distributes them out to subscribers based on a 'topic' key, with logging to $stdout
-  or a file, and absolutely nothing else? then this library is for you
+description: a tiny pubsub message bus with almost no features
 email: jefflunt@gmail.com
 executables: []
 extensions: []
@@ -55,5 +53,7 @@ requirements: []
 rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
-summary: a tiny pubsub message bus with almost no features
+summary: want to have an in-memory message bus that takes hash-like objects and distributes
+  them out to subscribers based on a 'topic' key, with logging to $stdout or a file,
+  and absolutely nothing else? then this library is for you
 test_files: []