local_bus 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc19202ff3881f3519fd8cfe760b7b83f42fff39cb2b9658d2550fbd2b0bcca0
-  data.tar.gz: 2d2fc75beaa51eb84f2263dc82aa0049c3c2f51b24c32939f911c0b774ef74f9
+  metadata.gz: f6f1119ac19b5642c84099312240ce0baf8320b42098cb48c918b627385a5aff
+  data.tar.gz: 936a119be41c3885de3d27bf7a68effb07bbda58fe0856e8ca7043b76bfbfe47
 SHA512:
-  metadata.gz: 44e7b2c60c2be6b5435cc1a652ee624502b775ee503662f582cb32d884e082cb47ee2b8159a27080e820530988aaa4cc5fc3e47f420629d9a0a0b3be7b0a665d
-  data.tar.gz: 647481ca9e89a0239e26ea622c8551757d991595f52a1ba3aac06a0ac03a7266a8f42253dbd8cec30311361d49a2ed2bdd80e95f62648365d95e817de2a34853
+  metadata.gz: ad441d27aacd1447fd9cebc7aaa5b55ab79b75eb6ce8ed756fc6f11d8b77203412796ce724067707e4c859fd28c384c16c2a6abe56139e4df3a727bd76cc104b
+  data.tar.gz: be8cc2ed7325347e6b3447777144dce7992fdc07385f0e20af8cfe300834c7cfe651fd7b6b0ffc9bdd797fb439ad702095220e8caa5a3c20651deae647fc97a0

data/README.md

@@ -1,4 +1,4 @@
-[![Lines of Code](https://img.shields.io/badge/loc-364-47d299.svg)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
+[![Lines of Code](https://img.shields.io/badge/loc-365-47d299.svg)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
 [![GEM Version](https://img.shields.io/gem/v/local_bus)](https://rubygems.org/gems/local_bus)
 [![GEM Downloads](https://img.shields.io/gem/dt/local_bus)](https://rubygems.org/gems/local_bus)
 [![Tests](https://github.com/hopsoft/local_bus/actions/workflows/tests.yml/badge.svg)](https://github.com/hopsoft/local_bus/actions)
@@ -205,6 +205,13 @@ message.subscribers # blocks and waits until all subscribers complete and return
 
 message.subscribers.first.value
 #=> "It worked!"
+
+# subscribe with any object that responds to `#call`.
+worker = ->(message) do
+  # business logic (e.g. API calls, database queries, disk operations, etc.)
+  "It worked!"
+end
+LocalBus.subscribe "user.created", callable: worker
 ```
 
 ### Bus
@@ -215,6 +222,7 @@ bus = LocalBus::Bus.new # ... or LocalBus.instance.bus
 # register a subscriber
 bus.subscribe "user.created" do |message|
   # business logic (e.g. API calls, database queries, disk operations, etc.)
+  "It worked!"
 end
 
 message = bus.publish("user.created", user_id: 123)
@@ -222,12 +230,8 @@ message.wait        # blocks until all subscribers complete
 message.subscribers # waits and returns the subscribers
 #=> [#<LocalBus::Subscriber:0x000000012bbb79a8 ...>]
 
-# subscribe with any object that responds to `#call`.
-worker = ->(message) do
-  # business logic (e.g. API calls, database queries, disk operations, etc.)
-  "It worked!"
-end
-bus.subscribe "user.created", callable: worker
+message.subscribers.first.value
+#=> "It worked!"
 ```
 
 ### Station
@@ -247,13 +251,6 @@ message.subscribers # blocks and waits until all subscribers complete and return
 
 message.subscribers.first.value
 #=> "It worked!"
-
-# subscribe with any object that responds to `#call`.
-worker = ->(message) do
-  # business logic (e.g. API calls, database queries, disk operations, etc.)
-  "It worked!"
-end
-station.subscribe "user.created", callable: worker
 ```
 
 ## Advanced Usage
@@ -377,12 +374,11 @@ bin/demo-bus     # demonstrates Bus performance
 bin/demo-station # demonstrates Station performance
 ```
 
-Both demos simulate I/O-bound operations _(1 second latency per subscriber)_ to show how LocalBus handles concurrent processing. For example, on an 10-core system:
-
-- The Bus processes a message with 10 I/O-bound subscribers in ~1 second instead of 10 seconds
-- The Station processes 10 messages with 10 I/O-bound subscribers each in ~1 second instead of 100 seconds
+Both demos simulate I/O-bound operations _(1 second latency per subscriber)_ to show how LocalBus handles concurrent processing.
 
-This demonstrates how LocalBus offers high throughput for I/O-bound operations. :raised_hands:
+For example,
+LocalBus can process 10 messages with 10 I/O-bound subscribers each in **~1 second instead of 100 seconds**,
+on a 10-core system.
 
 ## See Also
 

data/lib/local_bus/bus.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rbs_inline: enabled
-
 class LocalBus
   # The Bus acts as a direct transport mechanism for messages, akin to placing a passenger directly onto a bus.
   # When a message is published to the Bus, it is immediately delivered to all subscribers, ensuring prompt execution of tasks.

data/lib/local_bus/message.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rbs_inline: enabled
-
 class LocalBus
   # Represents a message in the LocalBus system
   class Message

data/lib/local_bus/publication.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rbs_inline: enabled
-
 class LocalBus
   # Wraps an Async::Barrier and a list of Subscribers that are processing a Message.
   class Publication

data/lib/local_bus/station.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-# rbs_inline: enabled
-# rubocop:disable Lint/MissingCopEnableDirective
-# rubocop:disable Style/ArgumentsForwarding
-
 class LocalBus
   # The Station serves as a queuing system for messages, similar to a bus station where passengers wait for their bus.
   #
@@ -28,16 +24,17 @@ class LocalBus
     #       Will not delay process exit when the queue is empty.
     #
     # @rbs bus: Bus -- local message bus (default: Bus.new)
-    # @rbs interval: Float -- queue polling interval in seconds (default: 0.01)
+    # @rbs interval: Float -- queue polling interval in seconds (default: 0.1)
     # @rbs limit: Integer -- max queue size (default: 10_000)
     # @rbs threads: Integer -- number of threads to use (default: Etc.nprocessors)
     # @rbs timeout: Float -- seconds to wait for subscribers to process the message before cancelling (default: 60)
     # @rbs wait: Float -- seconds to wait for the queue to flush at process exit (default: 5)
     # @rbs return: void
-    def initialize(bus: Bus.new, interval: 0.01, limit: 10_000, threads: Etc.nprocessors, timeout: 60, wait: 5)
+    def initialize(bus: Bus.new, interval: 0.1, limit: 10_000, threads: Etc.nprocessors, timeout: 60, wait: 5)
       super()
       @bus = bus
-      @interval = [interval.to_f, 0.01].max
+      @interval = interval.to_f
+      @interval = 0.1 unless @interval.positive?
       @limit = limit.to_i.positive? ? limit.to_i : 10_000
       @threads = [threads.to_i, 1].max
       @timeout = timeout.to_f
@@ -67,11 +64,11 @@ class LocalBus
     attr_reader :timeout
 
     # Starts the station
-    # @rbs interval: Float -- queue polling interval in seconds (default: 0.01)
+    # @rbs interval: Float -- queue polling interval in seconds (default: self.interval)
     # @rbs threads: Integer -- number of threads to use (default: self.threads)
     # @rbs return: void
     def start(interval: self.interval, threads: self.threads)
-      interval = [interval.to_f, 0.01].max
+      interval = 0.1 unless interval.positive?
       threads = [threads.to_i, 1].max
 
       synchronize do

data/lib/local_bus/subscriber.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rbs_inline: enabled
-
 class LocalBus
   # Wraps a Callable (Proc) and Message intended for asynchronous execution.
   class Subscriber

data/lib/local_bus/version.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rbs_inline: enabled
-
 class LocalBus
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/local_bus.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rbs_inline: enabled
-
 require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem
 loader.setup

data/sig/generated/local_bus/station.rbs

@@ -25,7 +25,7 @@ class LocalBus
     #       Will not delay process exit when the queue is empty.
     #
     # @rbs bus: Bus -- local message bus (default: Bus.new)
-    # @rbs interval: Float -- queue polling interval in seconds (default: 0.01)
+    # @rbs interval: Float -- queue polling interval in seconds (default: 0.1)
     # @rbs limit: Integer -- max queue size (default: 10_000)
     # @rbs threads: Integer -- number of threads to use (default: Etc.nprocessors)
     # @rbs timeout: Float -- seconds to wait for subscribers to process the message before cancelling (default: 60)
@@ -54,7 +54,7 @@ class LocalBus
     attr_reader timeout: untyped
 
     # Starts the station
-    # @rbs interval: Float -- queue polling interval in seconds (default: 0.01)
+    # @rbs interval: Float -- queue polling interval in seconds (default: self.interval)
     # @rbs threads: Integer -- number of threads to use (default: self.threads)
     # @rbs return: void
     def start: (?interval: Float, ?threads: Integer) -> void

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: local_bus
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Nate Hopkins (hopsoft)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-03 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algorithms
@@ -267,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: A lightweight pub/sub system for decoupled intra-process communication in