ration 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ccdac579175651f9ae74c5334d16cdd199e2019fe538bb717938c3749de726a
-  data.tar.gz: 180279e4a5276f3a7258f7e507d1ae3c4cf495eacf8ab661d1896bb658216b19
+  metadata.gz: 06d085f3d4d3bd600254eb694a8e3052e231166adfa65c4af78b0447c7f1bd7e
+  data.tar.gz: bb65889b2ba23c9817f30a46de4e1eef18342684e05d6c404ffd6e26fb2ff9d1
 SHA512:
-  metadata.gz: 22c49c8344b06a2c8a169cdfa219d23ad1372bf4e2bdcc06f762937e08409e755829d0e883ac6ff78e523f39d0e57a25b8e5191ac62981986c20c8e6f7e55e36
-  data.tar.gz: 3f655214bf8f81d2c1e0097a5e8e71b101bf148c499da5fbd1c63f7d0b997a01dafdf0f2685a9f6a2f7740e444740c25c47b60437140e3eea573e2d34226caab
+  metadata.gz: a6607e53d4fcc195b113dc6a31f30789ced563d9ebfba9958b5a685c9a239eb1c2ed9a7dcf196c4c21b2f41169ac3cb109bf9b48e84a079883d8caf8f9500916
+  data.tar.gz: 619058a038310db757089ddb2c54373f1d4fa8d3dfbb3ad75e48422bf329f85c6984f1b8180afc2cbf85aaec876e5f697a5b47c4f4d513dee3ed979785e05fd9

data/lib/ration/backends/memory.rb

@@ -9,7 +9,7 @@ module Ration
         @max_payload_bytes = max_payload_bytes
         @sync              = sync
         @logger            = logger || Logger.new($stderr)
-        @queue             = nil
+        @queue             = Queue.new
         @thread            = nil
       end
 
@@ -27,7 +27,6 @@ module Ration
         return if @sync
         return if @thread
 
-        @queue  = Queue.new
         @thread = Thread.new {
           while (event = @queue.pop)
             begin
@@ -42,9 +41,9 @@ module Ration
       def stop
         return if @sync
 
-        @queue&.close
+        @queue.close
         @thread&.join
-        @queue  = nil
+        @queue  = Queue.new
         @thread = nil
       end
     end

data/lib/ration/backends/postgres.rb

@@ -23,7 +23,7 @@ module Ration
         @channel           = channel
         @max_payload_bytes = max_payload_bytes
         @poll_interval     = poll_interval
-        @publish_with      = publish_with
+        @publish_with      = publish_with || method(:publish_direct)
         @logger            = logger || Logger.new($stderr)
         @thread            = nil
         @stop              = false
@@ -33,16 +33,7 @@ module Ration
         payload = event.to_json
         check_payload_size!(payload, @max_payload_bytes)
 
-        if @publish_with
-          @publish_with.call(@channel, payload)
-        else
-          conn = PG.connect(@url)
-          begin
-            conn.exec_params('SELECT pg_notify($1, $2)', [@channel, payload])
-          ensure
-            conn.close
-          end
-        end
+        @publish_with.call(@channel, payload)
       end
 
       def start
@@ -61,6 +52,15 @@ module Ration
 
       private
 
+      def publish_direct(channel, payload)
+        conn = PG.connect(@url)
+        begin
+          conn.exec_params('SELECT pg_notify($1, $2)', [channel, payload])
+        ensure
+          conn.close
+        end
+      end
+
       def connect_and_listen
         conn = PG.connect(@url)
         conn.exec("LISTEN #{conn.escape_identifier(@channel)}")

data/lib/ration/backends/redis.rb

@@ -23,9 +23,9 @@ module Ration
         @channel           = channel
         @max_payload_bytes = max_payload_bytes
         @poll_interval     = poll_interval
-        @publish_with      = publish_with
-        @logger            = logger || Logger.new($stderr)
         @config            = RedisClient.config(url: url)
+        @publish_with      = publish_with || method(:publish_direct)
+        @logger            = logger || Logger.new($stderr)
         @thread            = nil
         @stop              = false
       end
@@ -34,16 +34,7 @@ module Ration
         payload = event.to_json
         check_payload_size!(payload, @max_payload_bytes)
 
-        if @publish_with
-          @publish_with.call(@channel, payload)
-        else
-          client = @config.new_client
-          begin
-            client.call('PUBLISH', @channel, payload)
-          ensure
-            client.close
-          end
-        end
+        @publish_with.call(@channel, payload)
       end
 
       def start
@@ -62,6 +53,15 @@ module Ration
 
       private
 
+      def publish_direct(channel, payload)
+        client = @config.new_client
+        begin
+          client.call('PUBLISH', channel, payload)
+        ensure
+          client.close
+        end
+      end
+
       def subscribe_client
         client = @config.new_client
         pubsub = client.pubsub

data/lib/ration/subscription.rb

@@ -3,6 +3,7 @@ require 'securerandom'
 module Ration
   class Subscription
     OVERFLOW_POLICIES = %i[close drop_oldest].freeze
+    DEFAULT_FILTER    = ->(_event) { true }
 
     attr_reader :id
 
@@ -13,7 +14,7 @@ module Ration
 
       @id          = SecureRandom.uuid
       @queue       = SizedQueue.new(max)
-      @filter      = filter
+      @filter      = filter || DEFAULT_FILTER
       @on_overflow = on_overflow
       @logger      = logger
     end
@@ -59,8 +60,6 @@ module Ration
     private
 
     def passes_filter?(event)
-      return true if @filter.nil?
-
       @filter.call(event)
     rescue => e
       @logger.error("Ration filter raised, closing subscription #{@id}: #{e.class}: #{e.message}")

data/lib/ration/version.rb

@@ -1,3 +1,3 @@
 module Ration
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/lib/ration.rb

@@ -11,12 +11,11 @@ module Ration
     def configure
       yield config
 
-      if config.backend.nil?
+      backend = config.backend or
         raise NotConfigured, 'No backend configured. Set config.backend to a Ration::Backends::* instance.'
-      end
 
       @hub&.stop
-      @hub = Hub.new(backend: config.backend, logger: config.logger)
+      @hub = Hub.new(backend: backend, logger: config.logger)
     end
 
     def config
@@ -27,8 +26,8 @@ module Ration
       hub.publish(event)
     end
 
-    def subscribe(**kwargs, &block)
-      hub.subscribe(**kwargs, &block)
+    def subscribe(...)
+      hub.subscribe(...) # steep:ignore UnresolvedOverloading
     end
 
     def unsubscribe(sub)
@@ -44,9 +43,7 @@ module Ration
     private
 
     def hub
-      raise NotConfigured, 'Ration is not configured. Call Ration.configure first.' unless @hub
-
-      @hub
+      @hub or raise NotConfigured, 'Ration is not configured. Call Ration.configure first.'
     end
   end
 end

data/sig/external.rbs

@@ -0,0 +1,19 @@
+module PG
+  class Error < StandardError
+  end
+
+  def self.connect: (String) -> untyped
+end
+
+module RedisClient
+  class Error < StandardError
+  end
+
+  def self.config: (**untyped) -> untyped
+end
+
+module Concurrent
+  class Map[unchecked out K, unchecked out V]
+    def clear: () -> self
+  end
+end

data/sig/ration/backends/base.rbs

@@ -0,0 +1,19 @@
+module Ration
+  module Backends
+    class Base
+      DEFAULT_MAX_PAYLOAD_BYTES: Integer
+
+      @on_event: ^(Ration::event) -> void | nil
+
+      def publish: (Ration::event) -> void
+      def on_event: () { (Ration::event) -> void } -> (^(Ration::event) -> void)
+      def start: () -> void
+      def stop: () -> void
+
+      private
+
+      def emit: (Ration::event) -> void
+      def check_payload_size!: (String, Integer) -> void
+    end
+  end
+end

data/sig/ration/backends/memory.rbs

@@ -0,0 +1,16 @@
+module Ration
+  module Backends
+    class Memory < Base
+      @max_payload_bytes: Integer
+      @sync: bool
+      @logger: Logger
+      @queue: Thread::Queue
+      @thread: Thread?
+
+      def initialize: (?max_payload_bytes: Integer, ?sync: bool, ?logger: Logger?) -> void
+      def publish: (Ration::event) -> void
+      def start: () -> void
+      def stop: () -> void
+    end
+  end
+end

data/sig/ration/backends/postgres.rbs

@@ -0,0 +1,42 @@
+module Ration
+  module Backends
+    class Postgres < Base
+      DEFAULT_CHANNEL: String
+      INITIAL_BACKOFF_SECONDS: Integer
+      MAX_BACKOFF_SECONDS: Integer
+      DEFAULT_POLL_INTERVAL: Float
+
+      type publish_with = ^(String, String) -> void
+
+      @url: String
+      @channel: String
+      @max_payload_bytes: Integer
+      @poll_interval: Numeric
+      @publish_with: publish_with
+      @logger: Logger
+      @thread: Thread?
+      @stop: bool
+
+      def initialize: (
+        url: String,
+        ?channel: String,
+        ?max_payload_bytes: Integer,
+        ?poll_interval: Numeric,
+        ?publish_with: publish_with?,
+        ?logger: Logger?
+      ) -> void
+
+      def publish: (Ration::event) -> void
+      def start: () -> void
+      def stop: () -> void
+
+      private
+
+      def publish_direct: (String, String) -> void
+      def connect_and_listen: () -> untyped
+      def run_loop: (untyped) -> void
+      def reconnect_with_backoff: () -> untyped
+      def listen_loop: (untyped) -> void
+    end
+  end
+end

data/sig/ration/backends/redis.rbs

@@ -0,0 +1,44 @@
+module Ration
+  module Backends
+    class Redis < Base
+      DEFAULT_CHANNEL: String
+      INITIAL_BACKOFF_SECONDS: Integer
+      MAX_BACKOFF_SECONDS: Integer
+      DEFAULT_POLL_INTERVAL: Float
+
+      type publish_with = ^(String, String) -> void
+
+      @url: String
+      @channel: String
+      @max_payload_bytes: Integer
+      @poll_interval: Numeric
+      @publish_with: publish_with
+      @logger: Logger
+      @config: untyped
+      @thread: Thread?
+      @stop: bool
+
+      def initialize: (
+        url: String,
+        ?channel: String,
+        ?max_payload_bytes: Integer,
+        ?poll_interval: Numeric,
+        ?publish_with: publish_with?,
+        ?logger: Logger?
+      ) -> void
+
+      def publish: (Ration::event) -> void
+      def start: () -> void
+      def stop: () -> void
+
+      private
+
+      def publish_direct: (String, String) -> void
+      def subscribe_client: () -> untyped
+      def run_loop: (untyped) -> void
+      def reconnect_with_backoff: () -> untyped
+      def listen_loop: (untyped) -> void
+      def close_quietly: (untyped) -> void
+    end
+  end
+end

data/sig/ration/configuration.rbs

@@ -0,0 +1,8 @@
+module Ration
+  class Configuration
+    attr_accessor backend: Backends::Base?
+    attr_accessor logger: Logger
+
+    def initialize: () -> void
+  end
+end

data/sig/ration/errors.rbs

@@ -0,0 +1,10 @@
+module Ration
+  class Error < StandardError
+  end
+
+  class PayloadTooLarge < Error
+  end
+
+  class NotConfigured < Error
+  end
+end

data/sig/ration/hub.rbs

@@ -0,0 +1,22 @@
+module Ration
+  class Hub
+    @backend: Backends::Base
+    @logger: Logger
+    @subscriptions: Concurrent::Map[String, Subscription]
+    @started: bool
+    @start_mutex: Thread::Mutex
+
+    def initialize: (backend: Backends::Base, logger: Logger) -> void
+    def publish: (Ration::event) -> void
+    def subscribe: (max: Integer, ?filter: Ration::filter?, ?on_overflow: Symbol) -> Subscription
+                 | [T] (max: Integer, ?filter: Ration::filter?, ?on_overflow: Symbol) { (Subscription) -> T } -> T
+    def unsubscribe: (Subscription) -> void
+    def stop: () -> void
+    def subscription_count: () -> Integer
+
+    private
+
+    def ensure_started: () -> void
+    def deliver: (Ration::event) -> void
+  end
+end

data/sig/ration/rails.rbs

@@ -0,0 +1,22 @@
+module Ration
+  module Rails
+    interface _Response
+      def headers: () -> Hash[String, String]
+    end
+
+    interface _Request
+      def headers: () -> Hash[String, untyped]
+      def env: () -> Hash[String, untyped]
+    end
+
+    interface _Controller
+      def response: () -> _Response
+      def request: () -> _Request
+      def response_body=: (untyped) -> void
+    end
+
+    module SSE : _Controller
+      def sse_stream: () { (Enumerator::Yielder, String?) -> void } -> void
+    end
+  end
+end

data/sig/ration/sse.rbs

@@ -0,0 +1,27 @@
+module Ration
+  module SSE
+    interface _Output
+      def <<: (String) -> void
+    end
+
+    type id_from = ^(Ration::event) -> untyped
+
+    DEFAULT_ID_FROM: id_from
+
+    def self.event: (data: untyped, ?event: String?, ?id: untyped, ?retry_ms: Integer?) -> String
+    def self.comment: (?String) -> String
+    def self.ping: () -> String
+    def self.stream: (
+      Subscription,
+      _Output,
+      ?heartbeat: _ToF?,
+      ?since: untyped,
+      ?id_from: id_from
+    ) { (Ration::event) -> String? } -> untyped
+
+    private
+
+    def self.ensure_field_value_safe!: (String, String) -> void
+    def self.ensure_no_newline!: (String, String) -> void
+  end
+end

data/sig/ration/subscription.rbs

@@ -0,0 +1,26 @@
+module Ration
+  class Subscription
+    OVERFLOW_POLICIES: Array[Symbol]
+    DEFAULT_FILTER: Ration::filter
+
+    attr_reader id: String
+
+    @queue: Thread::SizedQueue
+    @filter: Ration::filter
+    @on_overflow: Symbol
+    @logger: Logger
+
+    def initialize: (max: Integer, ?filter: Ration::filter?, ?on_overflow: Symbol, logger: Logger) -> void
+    def pop: (?timeout: _ToF?) -> Ration::event?
+    def each_event: (?timeout: _ToF?) -> Enumerator[Ration::event?, self]
+                  | (?timeout: _ToF?) { (Ration::event?) -> void } -> self
+    def closed?: () -> bool
+    def close: () -> void
+    def deliver: (Ration::event) -> void
+
+    private
+
+    def passes_filter?: (Ration::event) -> boolish
+    def handle_overflow: (Ration::event) -> void
+  end
+end

data/sig/ration/version.rbs

@@ -0,0 +1,3 @@
+module Ration
+  VERSION: String
+end

data/sig/ration.rbs

@@ -0,0 +1,19 @@
+module Ration
+  type event = Hash[Symbol, untyped]
+  type filter = ^(event) -> boolish
+
+  self.@config: Configuration?
+  self.@hub: Hub?
+
+  def self.configure: () { (Configuration) -> void } -> void
+  def self.config: () -> Configuration
+  def self.publish: (event) -> void
+  def self.subscribe: (max: Integer, ?filter: filter?, ?on_overflow: Symbol) -> Subscription
+                    | [T] (max: Integer, ?filter: filter?, ?on_overflow: Symbol) { (Subscription) -> T } -> T
+  def self.unsubscribe: (Subscription) -> void
+  def self.reset!: () -> void
+
+  private
+
+  def self.hub: () -> Hub
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ration
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Keita Urashima
@@ -58,6 +58,19 @@ files:
 - lib/ration/sse.rb
 - lib/ration/subscription.rb
 - lib/ration/version.rb
+- sig/external.rbs
+- sig/ration.rbs
+- sig/ration/backends/base.rbs
+- sig/ration/backends/memory.rbs
+- sig/ration/backends/postgres.rbs
+- sig/ration/backends/redis.rbs
+- sig/ration/configuration.rbs
+- sig/ration/errors.rbs
+- sig/ration/hub.rbs
+- sig/ration/rails.rbs
+- sig/ration/sse.rbs
+- sig/ration/subscription.rbs
+- sig/ration/version.rbs
 homepage: https://github.com/ursm/ration
 licenses:
 - MIT