active_record_proxy_adapters 0.1.0.rc2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a84998cef36e3e7ba5c4e69909a41db4641a22aaa2b589988fe38f74abefa600
-  data.tar.gz: e0ab2ac9b05420d952c89f7259c6d3539eadf7b44fd791bb178dc28e91066b30
+  metadata.gz: 265cb32e99a265497548122846934c46405747109fa3bee34d1e2e66203b14a3
+  data.tar.gz: d9de3faf7274a0a94166637032c0a967e083edf55fc275b2456123d3f9a7ee79
 SHA512:
-  metadata.gz: 39d6c4508378596812e6dbdf523e05ff662b279ace17f6ec0ec2db24171645374e9447fe5aff6e6a9f9f2bfb227fce4a0dddc6deebe016b2d2a1f62234f198f9
-  data.tar.gz: 8b423c0d1464157eff63c0c161481acb2a2ba55e95f9337c4a27819c1acbfe41ccf83e7e59bdb98cea1e80419159b475060a166336251c59759d4298fe0c502f
+  metadata.gz: 871504b4290e8304effa5e30962a8db9fdab6663c73b4f9d9e99edf403af630755ddaaafa557619a86430812b7e54e19931274ec71dd4f86a7b4dc32b73fc669
+  data.tar.gz: f7605b374452517ae3346d896d043e092539abd0a86445eb1a04defbd7516628a70bcd5157fca10c730b7ee6fe047733d1e8e4d65a016c49651cbb12f7e8dcee

data/.rubocop.yml

@@ -14,7 +14,3 @@ Style/StringLiteralsInInterpolation:
 RSpec/NestedGroups:
   Enabled: true
   Max: 5
-
-# TODO: Enable MFA once we open source the gem
-Gemspec/RequireMFA:
-  Enabled: false 

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.1.0] - 2024-11-19
+
+- Add PostgreSQLProxyAdapter
+
 ## [0.1.0.rc2] - 2024-10-28
 
 - Add PostgreSQLProxyAdapter

data/README.md

@@ -4,15 +4,13 @@ A set of ActiveRecord adapters that leverage Rails native multiple database setu
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add 'UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG'
+    $ bundle add 'active_record_proxy_adapters'
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install active_record_proxy_adapters
 
 ## Usage
 

data/lib/active_record/connection_adapters/postgresql_proxy_adapter.rb

@@ -2,8 +2,9 @@
 
 require "active_record/tasks/postgresql_proxy_database_tasks"
 require "active_record/connection_adapters/postgresql_adapter"
-require "active_record_proxy_adapters/postgresql_proxy"
+require "active_record_proxy_adapters/active_record_context"
 require "active_record_proxy_adapters/hijackable"
+require "active_record_proxy_adapters/postgresql_proxy"
 
 module ActiveRecord
   module ConnectionAdapters
@@ -14,7 +15,11 @@ module ActiveRecord
 
       ADAPTER_NAME = "PostgreSQLProxy"
 
-      delegate_to_proxy :execute, :exec_query, :exec_no_cache, :exec_cache
+      delegate_to_proxy :execute, :exec_query
+
+      unless ActiveRecordProxyAdapters::ActiveRecordContext.active_record_v8_0_or_greater?
+        delegate_to_proxy :exec_no_cache, :exec_cache
+      end
 
       def initialize(...)
         @proxy = ActiveRecordProxyAdapters::PostgreSQLProxy.new(self)
@@ -29,7 +34,7 @@ module ActiveRecord
   end
 end
 
-if ActiveRecordProxyAdapters::ActiveRecordContext.active_record_v7_2?
+if ActiveRecordProxyAdapters::ActiveRecordContext.active_record_v7_2_or_greater?
   ActiveRecord::ConnectionAdapters.register(
     "postgresql_proxy",
     "ActiveRecord::ConnectionAdapters::PostgreSQLProxyAdapter",

data/lib/active_record_proxy_adapters/active_record_context.rb

@@ -4,7 +4,7 @@ module ActiveRecordProxyAdapters
   # Collection of helpers to handle common active record methods that are defined in different places in different
   # versions of rails.
   class ActiveRecordContext
-    delegate :reading_role, :reading_role=, :writing_role, :writing_role=, to: :role_context
+    delegate :reading_role, :reading_role=, :writing_role, :writing_role=, to: :ActiveRecord
     delegate :legacy_connection_handling, :legacy_connection_handling=, to: :connection_handling_context
     delegate :version, to: :ActiveRecord, prefix: :active_record
 
@@ -22,45 +22,27 @@ module ActiveRecordProxyAdapters
       end
     end
 
-    def reading_role
-      role_context.reading_role
-    end
-
-    def writing_role
-      role_context.writing_role
-    end
-
     def connection_class_for(connection)
-      klass = active_record_v6_1? ? connection.connection_klass : connection.connection_class
-
-      klass || ActiveRecord::Base
+      connection.connection_class || ActiveRecord::Base
     end
 
     def connection_handling_context
       # This config option has been removed in Rails 7.1+
-      return NullConnectionHandlingContext.new if active_record_v7_1? || active_record_v7_2?
-
-      global_configuration_context
-    end
-
-    def role_context
-      global_configuration_context
-    end
+      return NullConnectionHandlingContext.new if active_record_v7_1_or_greater?
 
-    def global_configuration_context
-      active_record_v6_1? ? ActiveRecord::Base : ActiveRecord
+      ActiveRecord
     end
 
-    def active_record_v6_1?
-      active_record_version >= Gem::Version.new("6.1") && active_record_version < Gem::Version.new("7.0")
+    def active_record_v7_1_or_greater?
+      active_record_version >= Gem::Version.new("7.1")
     end
 
-    def active_record_v7_1?
-      active_record_version >= Gem::Version.new("7.1") && active_record_version < Gem::Version.new("7.2")
+    def active_record_v7_2_or_greater?
+      active_record_version >= Gem::Version.new("7.2")
     end
 
-    def active_record_v7_2?
-      active_record_version >= Gem::Version.new("7.2") && active_record_version < Gem::Version.new("8.0")
+    def active_record_v8_0_or_greater?
+      active_record_version >= Gem::Version.new("8.0")
     end
   end
 end

data/lib/active_record_proxy_adapters/postgresql_proxy.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 require "active_record_proxy_adapters/primary_replica_proxy"
+require "active_record_proxy_adapters/active_record_context"
 
 module ActiveRecordProxyAdapters
   # Proxy to the original PostgreSQLAdapter, allowing the use of the ActiveRecordProxyAdapters::PrimaryReplicaProxy.
   class PostgreSQLProxy < PrimaryReplicaProxy
     # ActiveRecord::PostgreSQLAdapter methods that should be proxied.
-    hijack_method :execute, :exec_query, :exec_no_cache, :exec_cache
+    hijack_method :execute, :exec_query
+
+    hijack_method :exec_no_cache, :exec_cache unless ActiveRecordContext.active_record_v8_0_or_greater?
   end
 end

data/lib/active_record_proxy_adapters/primary_replica_proxy.rb

@@ -29,7 +29,10 @@ module ActiveRecordProxyAdapters
 
     # Defines which methods should be hijacked from the original adapter and use the proxy
     # @param method_names [Array<Symbol>] the list of method names from the adapter
-    def self.hijack_method(*method_names)
+    def self.hijack_method(*method_names) # rubocop:disable Metrics/MethodLength
+      @hijacked_methods ||= Set.new
+      @hijacked_methods += Set.new(method_names)
+
       method_names.each do |method_name|
         define_method(method_name) do |*args, **kwargs, &block|
           proxy_bypass_method = "#{method_name}#{UNPROXIED_METHOD_SUFFIX}"
@@ -44,6 +47,10 @@ module ActiveRecordProxyAdapters
       end
     end
 
+    def self.hijacked_methods
+      @hijacked_methods.to_a
+    end
+
     # @param primary_connection [ActiveRecord::ConnectionAdatpers::AbstractAdapter]
     def initialize(primary_connection)
       @primary_connection    = primary_connection

data/lib/active_record_proxy_adapters/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordProxyAdapters
-  VERSION = "0.1.0.rc2"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_proxy_adapters
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc2
+  version: 0.1.1
 platform: ruby
 authors:
 - Matt Cruz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2024-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.a
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.a
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.a
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.a
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
 description: |-
   This gem allows automatic connection switching between a primary and one read replica database in ActiveRecord.
   It pattern matches the SQL statement being sent to decide whether it should go to the replica (SELECT) or the
@@ -91,6 +91,7 @@ metadata:
   homepage_uri: https://github.com/Nasdaq/active_record_proxy_adapters
   source_code_uri: https://github.com/Nasdaq/active_record_proxy_adapters
   changelog_uri: https://github.com/Nasdaq/active_record_proxy_adapters/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: