activerecord-postgres_pub_sub 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbcb38025bb4b4992bb6a8d7ed1b2c1288fcc9b3df9c3bc4459a9be8ce7e96bd
-  data.tar.gz: fefad9359ecce30c1198a3c34e2c64ebb9993b797e2ff7320dd47ae23e6dfa2f
+  metadata.gz: ab5807899dcfd7a9aa7b51233366b26742bee55276024aeb92c796e1fe6ef59b
+  data.tar.gz: 3e7a055319a847476d2c3f32bca43245cdf1d9f633ab3142b365ce0f3a2d9a1f
 SHA512:
-  metadata.gz: ce692f2b1d176e51767ca21d679d8b618a84e9c029cd5f70e4430e32dec6ba6d9d9c226945c25530125d4e7f7692f7ab049673117aa0c86f3ed8bfdae08ef3d6
-  data.tar.gz: 7166ae680431461ea81a0e44e0d3f8b0b26607255d23869417c2c59c98a74a04ba75c783e7682c576a8c4de9b305d0d9906e36fe433e11fe6ff8c979adc57d03
+  metadata.gz: d7b51388aaddb2ed46258e3515a0a49b6f30413701b899c2b6f725cbf2e44f18a7257c71fa7dd864493c716f49bfaed06e5080735c4e17ec4b0efca0cf5391d2
+  data.tar.gz: 1f87512ac9faef62475c133f288d39e2f46e7d6a465b37c19556e21976dff57be72e898b3a0ffac8000a0dc8956a119d8f6aaa3295fbbaec3eaba859d22ebd16

data/.github/workflows/codeql.yml

@@ -0,0 +1,71 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+    # https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/customizing-code-scanning#avoiding-unnecessary-scans-of-pull-requests
+    paths-ignore:
+      - '**/*.md'
+      - '**/*.txt'
+  schedule:
+    - cron: '41 22 * * 2'
+
+jobs:
+  scan:
+    name: Scan
+    runs-on: [ ubuntu-latest ]
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      # Setting fail-fast to false to prevent a failed scan in
+      # any of the matrix.language's from stopping the other scans
+      # If there are multiple offenses, better to find/report them
+      # all at once
+      fail-fast: false
+      matrix:
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]      
+        # https://aka.ms/codeql-docs/language-support
+        language: [ 'ruby' ]
+        
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+    # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

data/Appraisals

@@ -39,3 +39,13 @@ appraise "rails-7.0_pg-1.2" do
   gem "activerecord", ">= 7.0.0", "< 7.1"
   gem "pg", "1.2.0"
 end
+
+appraise "rails-7.1_pg-1.1" do
+  gem "activerecord", ">= 7.1.0", "< 7.2"
+  gem "pg", "1.1.4"
+end
+
+appraise "rails-7.1_pg-1.2" do
+  gem "activerecord", ">= 7.1.0", "< 7.2"
+  gem "pg", "1.2.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # activerecord-postgres_pub_sub
 
+## v2.3.0
+- Add support for Rails 7.1
+
+## 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

data/README.md

@@ -1,8 +1,6 @@
 # activerecord-postgres_pub_sub
 
-[![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 +23,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 +32,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 +50,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

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
 
-  excluded_files = %w(.circleci/config.yml
+  excluded_files = %w(.github/workflows/ci.yml
                       .github/PULL_REQUEST_TEMPLATE.md
                       .gitignore
                       .rspec
@@ -41,7 +41,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 2.7.0"
 
-  spec.add_runtime_dependency "activerecord", "> 5.1", "< 7.1"
+  spec.add_runtime_dependency "activerecord", "> 5.1", "< 7.2"
   spec.add_runtime_dependency "pg", "~> 1.1"
   spec.add_runtime_dependency "private_attr"
   spec.add_runtime_dependency "with_advisory_lock"

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,12 +56,16 @@ 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
@@ -76,7 +80,7 @@ module ActiveRecord
       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.1.0"
+    VERSION = "2.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres_pub_sub
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - ezCater, Inc
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-23 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -219,6 +219,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/codeql.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -246,7 +247,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -262,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Support for Postgres Notify/Listen
 test_files: []