activerecord-postgres_pub_sub 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f74c76d5872b835ef89c6fedb2f516225ce6b3b742598dc2401621ba6131f4e7
-  data.tar.gz: a64cb743a412aeceb92192b93565b9ed56edeaf6f8aa48c35eaf8ed71afedfaf
+  metadata.gz: 1b886594148cd3420c38dee50e9baeba2d73f01901cd682704efb624ee999b51
+  data.tar.gz: ee644f50f830c05f60efc505f50b73ffefbbb4971bbbca256e63d4d00d16c9f2
 SHA512:
-  metadata.gz: d19558e79e5bb221923f258fcaf1c1e6180e3e4393ea918a9a8a54e5e2156bac29ed83f27041e2bda474542b6023f6ccd63fd9b281e7262aa3bc5a58d32f86b1
-  data.tar.gz: a585933b618e85e9e37706d3de0834be3dff763a01ffad5cbcadc13f2d023646ce0cd7d8e7ce9c018e5467de3a508cb2dc7ea580347cffe379fe59fcf35247da
+  metadata.gz: 02d2b855c61be06e21b9acedb849a0ada4a99f7345f5be171ac33fcf4ca67ceced2ffd9fa023cce5851a0cb3eadc8a344192f8d35ab15ac947c45a9d0ccf7ce6
+  data.tar.gz: c23a5d3df02df37aad3e136924926428a366721d1da68e854e6968c2f728db43cb6059f5258e276d0bbc10008ab2bec319908f4c1babc280ead7952d5d102d6d

data/Appraisals

@@ -1,30 +1,15 @@
 # frozen_string_literal: true
 
-appraise "rails-5.1" do
-  gem "activerecord", "5.1.6"
-  gem "pg", "0.18.4"
-end
-
 appraise "rails-5.2_pg-1.1" do
   gem "activerecord", "5.2.1"
   gem "pg", "1.1.4"
 end
 
-appraise "rails-5.2_pg-0.18" do
-  gem "activerecord", "5.2.1"
-  gem "pg", "0.18.4"
-end
-
 appraise "rails-5.2_pg-1.2" do
   gem "activerecord", "5.2.1"
   gem "pg", "1.2.0"
 end
 
-appraise "rails-6.0_pg-0.18" do
-  gem "activerecord", ">= 6.0.0", "< 6.1"
-  gem "pg", "0.18.4"
-end
-
 appraise "rails-6.0_pg-1.1" do
   gem "activerecord", ">= 6.0.0", "< 6.1"
   gem "pg", "1.1.4"
@@ -44,3 +29,13 @@ appraise "rails-6.1_pg-1.2" do
   gem "activerecord", ">= 6.1.0", "< 6.2"
   gem "pg", "1.2.0"
 end
+
+appraise "rails-7.0_pg-1.1" do
+  gem "activerecord", ">= 7.0.0", "< 7.1"
+  gem "pg", "1.1.4"
+end
+
+appraise "rails-7.0_pg-1.2" do
+  gem "activerecord", ">= 7.0.0", "< 7.1"
+  gem "pg", "1.2.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # activerecord-postgres_pub_sub
 
+## v2.2.0
+- Add support for listening to multiple channels.
+
+## v2.1.0
+- Set required ruby version to 2.7.0
+- Add support for Rails 7.0
+
+## v2.0.1
+- Fix version constraint on pg gem.
+- Drop support for rails 5.1 as a result of pg constraint change.
+
 ## v2.0.0
 - Add support for Rails 6.1.
 - Drop support for pg 0.18 as support has been [dropped in activerecord 6.1](https://github.com/rails/rails/commit/592358e182effecebe8c6a4645bd4431f5a73654).

data/README.md

@@ -2,7 +2,7 @@
 
 [![CircleCI](https://circleci.com/gh/ezcater/activerecord-postgres_pub_sub.svg?style=svg)](https://circleci.com/gh/ezcater/activerecord-postgres_pub_sub)
 
-This gem contains support for PostgreSQL LISTEN and NOTIFY functionality: 
+This gem contains support for PostgreSQL LISTEN and NOTIFY functionality:
 [doc](https://www.postgresql.org/docs/9.6/static/libpq-notify.html).
 
 ## Installation
@@ -25,7 +25,8 @@ Or install it yourself as:
 
 ### Listener
 
-The `Listener` class is used to handle notification messages.
+The `Listener` class is used to handle notification messages on one or more
+channels.
 
 The listener can be configured with three blocks:
 
@@ -33,13 +34,13 @@ The listener can be configured with three blocks:
 * **on_start**: called before receiving any notifications.
 * **on_timeout**: called based on a configurable timeout, when no notifications
   have been received.
-  
+
 When creating a listener, the following configuration is supported:
 
-* **listen_timeout**: If set, the `on_timeout` block will be called if 
-  no notifications are received within this period. (Default `nil`).  
+* **listen_timeout**: If set, the `on_timeout` block will be called if
+  no notifications are received within this period. (Default `nil`).
 * **notify_only**: A payload string can be included in notifications. By default
-  the listener ignores the payload and coalesces multiple notifications into a 
+  the listener ignores the payload and coalesces multiple notifications into a
   single call. When this option is `false`, the `on_notify` block is called with
   the payload for each notification. (Default `true`).
 * **exclusive_lock**: Acquire a lock using
@@ -51,16 +52,16 @@ Example:
 ```ruby
 ActiveRecord::PostgresPubSub::Listener.listen("notify_channel", listen_timeout: 30) do |listener|
   listener.on_start do
-    # when starting assume we missed something and perform regular activity 
+    # when starting assume we missed something and perform regular activity
     handle_notification
   end
-  
+
   listener.on_notify do
     handle_notification
   end
-  
+
   listener.on_timeout do
-    perform_regular_maintenance 
+    perform_regular_maintenance
   end
 end
 ```

data/activerecord-postgres_pub_sub.gemspec

@@ -39,9 +39,10 @@ Gem::Specification.new do |spec|
   spec.bindir        = "bin"
   spec.executables   = []
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.7.0"
 
-  spec.add_runtime_dependency "activerecord", ">= 5.1", "< 6.2"
-  spec.add_runtime_dependency "pg", ">= 0.18", "< 2.0"
+  spec.add_runtime_dependency "activerecord", "> 5.1", "< 7.1"
+  spec.add_runtime_dependency "pg", "~> 1.1"
   spec.add_runtime_dependency "private_attr"
   spec.add_runtime_dependency "with_advisory_lock"
 
@@ -49,7 +50,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", ">= 1.3.0"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "ezcater_matchers"
-  spec.add_development_dependency "ezcater_rubocop", "1.0.2"
+  spec.add_development_dependency "ezcater_rubocop", "~> 3.0"
   spec.add_development_dependency "overcommit"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.4"

data/gemfiles/rails_7.0_pg_1.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", ">= 7.0.0", "< 7.1"
+gem "pg", "1.1.4"
+
+gemspec path: "../"

data/gemfiles/rails_7.0_pg_1.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", ">= 7.0.0", "< 7.1"
+gem "pg", "1.2.0"
+
+gemspec path: "../"

data/lib/activerecord/postgres_pub_sub/listener.rb

@@ -9,10 +9,10 @@ module ActiveRecord
       extend PrivateAttr
 
       private_attr_reader :on_notify_blk, :on_start_blk, :on_timeout_blk,
-                          :channel, :listen_timeout, :exclusive_lock, :notify_only
+                          :channels, :listen_timeout, :exclusive_lock, :notify_only
 
-      def self.listen(channel, listen_timeout: nil, exclusive_lock: true, notify_only: true)
-        listener = new(channel,
+      def self.listen(*channels, listen_timeout: nil, exclusive_lock: true, notify_only: true)
+        listener = new(*channels,
                        listen_timeout: listen_timeout,
                        exclusive_lock: exclusive_lock,
                        notify_only: notify_only)
@@ -20,8 +20,8 @@ module ActiveRecord
         listener.listen
       end
 
-      def initialize(channel, listen_timeout: nil, exclusive_lock: true, notify_only: true)
-        @channel = channel
+      def initialize(*channels, listen_timeout: nil, exclusive_lock: true, notify_only: true)
+        @channels = channels
         @listen_timeout = listen_timeout
         @exclusive_lock = exclusive_lock
         @notify_only = notify_only
@@ -44,8 +44,8 @@ module ActiveRecord
           on_start_blk&.call
 
           loop do
-            wait_for_notify(connection) do |payload|
-              notify_only ? on_notify_blk.call : on_notify_blk.call(payload)
+            wait_for_notify(connection) do |payload, channel|
+              notify_only ? on_notify_blk.call : on_notify_blk.call(payload, channel)
             end
           end
         end
@@ -56,27 +56,31 @@ module ActiveRecord
       def with_connection
         ActiveRecord::Base.connection_pool.with_connection do |connection|
           with_optional_lock do
-            connection.execute("LISTEN #{channel}")
+            channels.each do |channel|
+              connection.execute("LISTEN #{channel};")
+            end
 
             begin
               yield(connection)
             ensure
-              connection.execute("UNLISTEN #{channel}")
+              channels.each do |channel|
+                connection.execute("UNLISTEN #{channel}")
+              end
             end
           end
         end
       end
 
-      def with_optional_lock
+      def with_optional_lock(&block)
         if exclusive_lock
-          ActiveRecord::Base.with_advisory_lock(lock_name) { yield }
+          ActiveRecord::Base.with_advisory_lock(lock_name, &block)
         else
           yield
         end
       end
 
       def lock_name
-        "#{channel}-listener"
+        "#{channels.join('-')}-listener"
       end
 
       def empty_channel(connection)
@@ -87,10 +91,11 @@ module ActiveRecord
 
       def wait_for_notify(connection)
         connection_pid = connection.raw_connection.backend_pid
-        event_result = connection.raw_connection.wait_for_notify(listen_timeout) do |_event, pid, payload|
+        event_result = connection.raw_connection.wait_for_notify(listen_timeout) do |notify_channel, pid, payload|
           if pid != connection_pid
             empty_channel(connection.raw_connection) if notify_only
-            yield(payload)
+
+            yield(payload, notify_channel)
           end
         end
 

data/lib/activerecord/postgres_pub_sub/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module PostgresPubSub
-    VERSION = "2.0.0"
+    VERSION = "2.2.0"
   end
 end

metadata

@@ -1,55 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres_pub_sub
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - ezCater, Inc
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-20 00:00:00.000000000 Z
+date: 2022-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.18'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.18'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: private_attr
   requirement: !ruby/object:Gem::Requirement
@@ -138,16 +132,16 @@ dependencies:
   name: ezcater_rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: overcommit
   requirement: !ruby/object:Gem::Requirement
@@ -240,6 +234,8 @@ files:
 - gemfiles/rails_6.0_pg_1.2.gemfile
 - gemfiles/rails_6.1_pg_1.1.gemfile
 - gemfiles/rails_6.1_pg_1.2.gemfile
+- gemfiles/rails_7.0_pg_1.1.gemfile
+- gemfiles/rails_7.0_pg_1.2.gemfile
 - lib/activerecord-postgres_pub_sub.rb
 - lib/activerecord/postgres_pub_sub/listener.rb
 - lib/activerecord/postgres_pub_sub/version.rb
@@ -250,7 +246,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -258,15 +254,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Support for Postgres Notify/Listen
 test_files: []