arproxy 0.2.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97417dad77bf18a6a058b5a7bf30cfd2118e70a2db8da4eb9574f5d6694b1119
-  data.tar.gz: 76361afc976b7fd086c702fb7dd0629b3d0ad85776667b1438d323db64173139
+  metadata.gz: e079e98bb0b0f67bb3bc2189c4ee95b27e7177b4db0e9ba52ac746b8cc492366
+  data.tar.gz: e6e388e344e42d79aca1a40eddb3ee4e2b08f55a2e470ee34bc75ac97ec8963c
 SHA512:
-  metadata.gz: 0515356f2ddafdb1f77bbb6dfb49769fbc4d08d1381bf2657f32210d3dd9841f3e29d5ca157f6e24e23392d219f0123dc703c0e1c34e083ee06ed58d3f09ec32
-  data.tar.gz: 95ce473dc91f7d5a38009eb105b35b3f8760f31f8fbb85b9fe45c66151864c98120585f6476363dc395f3a1d66a3d3433e4d2355c420b36dff4e392464c9c51d
+  metadata.gz: 97cba7c8a4a525a072ddc48bc89425b53a98f6f2f3445f4e3733a9b97feb3f83fc303536ce0962a23891b1281e6feb949e85ce36a90e209d2c62f3e614319c4b
+  data.tar.gz: dff9dc34f6349c4fd61aa9cbaa786b81a11d648c26d3905a600221b27a8235933158ecae199c44036de498bcae648bc976807f666d93c584b6aa48b63bd1227f

data/lib/arproxy/base.rb

@@ -1,9 +1,5 @@
 module Arproxy
+  # This class is no longer used since Arproxy v1.
   class Base
-    attr_accessor :proxy_chain, :next_proxy
-
-    def execute(sql, name=nil, **kwargs)
-      next_proxy.execute sql, name, **kwargs
-    end
   end
 end

data/lib/arproxy/config.rb

@@ -1,5 +1,7 @@
-require "active_record"
-require "active_record/base"
+require 'active_record'
+require 'active_record/base'
+require 'arproxy/base'
+require 'arproxy/error'
 
 module Arproxy
   class Config
@@ -9,22 +11,31 @@ module Arproxy
     def initialize
       @proxies = []
       if defined?(Rails)
-        @adapter = Rails.application.config_for(:database)["adapter"]
+        @adapter = Rails.application.config_for(:database)['adapter']
       end
     end
 
     def use(proxy_class, *options)
+      if proxy_class.is_a?(Class) && proxy_class.ancestors.include?(Arproxy::Base)
+        raise Arproxy::Error, "Error on loading a proxy `#{proxy_class.inspect}`: the superclass `Arproxy::Base` is no longer supported since Arproxy v1. Use `Arproxy::Proxy` instead. See: https://github.com/cookpad/arproxy/blob/main/UPGRADING.md"
+      end
+
       ::Arproxy.logger.debug("Arproxy: Mounting #{proxy_class.inspect} (#{options.inspect})")
       @proxies << [proxy_class, options]
     end
 
     def plugin(name, *options)
       plugin_class = Plugin.get(name)
+
+      if plugin_class.is_a?(Class) && plugin_class.ancestors.include?(Arproxy::Base)
+        raise Arproxy::Error, "Error on loading a plugin `#{plugin_class.inspect}`: the superclass `Arproxy::Base` is no longer supported since Arproxy v1. Use `Arproxy::Proxy` instead. See: https://github.com/cookpad/arproxy/blob/main/UPGRADING.md"
+      end
+
       use(plugin_class, *options)
     end
 
     def adapter_class
-      raise Arproxy::Error, "config.adapter must be set" unless @adapter
+      raise Arproxy::Error, 'config.adapter must be set' unless @adapter
       case @adapter
       when String, Symbol
         eval "::ActiveRecord::ConnectionAdapters::#{camelized_adapter_name}Adapter"
@@ -37,19 +48,19 @@ module Arproxy
 
     private
 
-    def camelized_adapter_name
-      adapter_name = @adapter.to_s.split("_").map(&:capitalize).join
+      def camelized_adapter_name
+        adapter_name = @adapter.to_s.split('_').map(&:capitalize).join
 
-      case adapter_name
-      when 'Sqlite3'
-        'SQLite3'
-      when 'Sqlserver'
-        'SQLServer'
-      when 'Postgresql'
-        'PostgreSQL'
-      else
-        adapter_name
+        case adapter_name
+        when 'Sqlite3'
+          'SQLite3'
+        when 'Sqlserver'
+          'SQLServer'
+        when 'Postgresql'
+          'PostgreSQL'
+        else
+          adapter_name
+        end
       end
-    end
   end
 end

data/lib/arproxy/connection_adapter_patch.rb

@@ -0,0 +1,118 @@
+module Arproxy
+  class ConnectionAdapterPatch
+    attr_reader :adapter_class
+
+    def initialize(adapter_class)
+      @adapter_class = adapter_class
+      @applied_patches = Set.new
+    end
+
+    def self.register_patches(adapter_name, patches: [], binds_patches: [])
+      @@patches ||= {}
+      @@patches[adapter_name] = {
+        patches: patches,
+        binds_patches: binds_patches
+      }
+    end
+
+    if ActiveRecord.version >= Gem::Version.new('8.0')
+      register_patches('Mysql2', patches: [], binds_patches: [:raw_execute])
+      register_patches('Trilogy', patches: [], binds_patches: [:raw_execute])
+    elsif ActiveRecord.version >= Gem::Version.new('7.0')
+      register_patches('Mysql2', patches: [:raw_execute], binds_patches: [])
+      register_patches('Trilogy', patches: [:raw_execute], binds_patches: [])
+    else
+      register_patches('Mysql2', patches: [:execute], binds_patches: [])
+      register_patches('Trilogy', patches: [:raw_execute], binds_patches: [])
+    end
+
+    if ActiveRecord.version >= Gem::Version.new('8.0')
+      register_patches('PostgreSQL', patches: [], binds_patches: [:raw_execute])
+      register_patches('SQLServer', patches: [], binds_patches: [:raw_execute])
+      register_patches('SQLite', patches: [], binds_patches: [:raw_execute])
+    elsif ActiveRecord.version >= Gem::Version.new('7.1')
+      register_patches('PostgreSQL', patches: [:raw_execute], binds_patches: [:exec_no_cache, :exec_cache])
+      register_patches('SQLServer', patches: [:raw_execute], binds_patches: [:internal_exec_query])
+      register_patches('SQLite', patches: [:raw_execute], binds_patches: [:internal_exec_query])
+    else
+      register_patches('PostgreSQL', patches: [:execute], binds_patches: [:exec_no_cache, :exec_cache])
+      register_patches('SQLServer', patches: [:execute], binds_patches: [:exec_query])
+      register_patches('SQLite', patches: [:execute], binds_patches: [:exec_query])
+    end
+
+    def enable!
+      patches = @@patches[adapter_class::ADAPTER_NAME]
+      if patches
+        patches[:patches]&.each do |patch|
+          apply_patch patch
+        end
+        patches[:binds_patches]&.each do |binds_patch|
+          apply_patch_binds binds_patch
+        end
+      else
+        raise Arproxy::Error, "Unexpected connection adapter: patches not registered for #{adapter_class&.name}"
+      end
+      ::Arproxy.logger.debug("Arproxy: Enabled (#{adapter_class::ADAPTER_NAME})")
+    end
+
+    def disable!
+      @applied_patches.dup.each do |target_method|
+        adapter_class.class_eval do
+          if instance_methods.include?(:"#{target_method}_with_arproxy")
+            alias_method target_method, :"#{target_method}_without_arproxy"
+            remove_method :"#{target_method}_with_arproxy"
+          end
+        end
+        @applied_patches.delete(target_method)
+      end
+      ::Arproxy.logger.debug("Arproxy: Disabled (#{adapter_class::ADAPTER_NAME})")
+    end
+
+    private
+
+      def apply_patch(target_method)
+        return if @applied_patches.include?(target_method)
+        adapter_class.class_eval do
+          raw_execute_method_name = :"#{target_method}_without_arproxy"
+          patched_execute_method_name = :"#{target_method}_with_arproxy"
+          break if instance_methods.include?(patched_execute_method_name)
+          define_method(patched_execute_method_name) do |sql, name=nil, **kwargs|
+            context = QueryContext.new(
+              raw_connection: self,
+              execute_method_name: raw_execute_method_name,
+              with_binds: false,
+              name: name,
+              kwargs: kwargs,
+            )
+            ::Arproxy.proxy_chain.head.execute(sql, context)
+          end
+          alias_method raw_execute_method_name, target_method
+          alias_method target_method, patched_execute_method_name
+        end
+        @applied_patches << target_method
+      end
+
+      def apply_patch_binds(target_method)
+        return if @applied_patches.include?(target_method)
+        adapter_class.class_eval do
+          raw_execute_method_name = :"#{target_method}_without_arproxy"
+          patched_execute_method_name = :"#{target_method}_with_arproxy"
+          break if instance_methods.include?(patched_execute_method_name)
+          define_method(patched_execute_method_name) do |sql, name=nil, binds=[], **kwargs|
+            context = QueryContext.new(
+              raw_connection: self,
+              execute_method_name: raw_execute_method_name,
+              with_binds: true,
+              name: name,
+              binds: binds,
+              kwargs: kwargs,
+            )
+            ::Arproxy.proxy_chain.head.execute(sql, context)
+          end
+          alias_method raw_execute_method_name, target_method
+          alias_method target_method, patched_execute_method_name
+        end
+        @applied_patches << target_method
+      end
+  end
+end

data/lib/arproxy/proxy.rb

@@ -0,0 +1,15 @@
+require 'arproxy/query_context'
+
+module Arproxy
+  class Proxy
+    attr_accessor :context, :next_proxy
+
+    def execute(sql, context)
+      unless context.instance_of?(QueryContext)
+        raise Arproxy::Error, "`context` is expected a `Arproxy::QueryContext` but got `#{context.class}`"
+      end
+
+      next_proxy.execute(sql, context)
+    end
+  end
+end

data/lib/arproxy/proxy_chain.rb

@@ -1,20 +1,21 @@
-module Arproxy
-  autoload :ChainTail, "arproxy/chain_tail"
+require 'arproxy/proxy_chain_tail'
+require 'arproxy/connection_adapter_patch'
 
+module Arproxy
   class ProxyChain
-    attr_reader :head, :tail
+    attr_reader :head, :tail, :patch
 
-    def initialize(config)
+    def initialize(config, patch)
       @config = config
+      @patch = patch
       setup
     end
 
     def setup
-      @tail = ChainTail.new self
+      @tail = ProxyChainTail.new
       @head = @config.proxies.reverse.inject(@tail) do |next_proxy, proxy_config|
         cls, options = proxy_config
         proxy = cls.new(*options)
-        proxy.proxy_chain = self
         proxy.next_proxy = next_proxy
         proxy
       end
@@ -28,31 +29,11 @@ module Arproxy
     end
 
     def enable!
-      @config.adapter_class.class_eval do
-        def execute_with_arproxy(sql, name=nil, **kwargs)
-          ::Arproxy.proxy_chain.connection = self
-          ::Arproxy.proxy_chain.head.execute sql, name, **kwargs
-        end
-        alias_method :execute_without_arproxy, :execute
-        alias_method :execute, :execute_with_arproxy
-        ::Arproxy.logger.debug("Arproxy: Enabled")
-      end
+      @patch.enable!
     end
 
     def disable!
-      @config.adapter_class.class_eval do
-        alias_method :execute, :execute_without_arproxy
-        ::Arproxy.logger.debug("Arproxy: Disabled")
-      end
+      @patch.disable!
     end
-
-    def connection
-      Thread.current[:arproxy_connection]
-    end
-
-    def connection=(val)
-      Thread.current[:arproxy_connection] = val
-    end
-
   end
 end

data/lib/arproxy/proxy_chain_tail.rb

@@ -0,0 +1,18 @@
+require 'arproxy/proxy'
+require 'arproxy/query_context'
+
+module Arproxy
+  class ProxyChainTail < Proxy
+    def execute(sql, context)
+      unless context.instance_of?(QueryContext)
+        raise Arproxy::Error, "`context` is expected a `Arproxy::QueryContext` but got `#{context.class}`"
+      end
+
+      if context.with_binds?
+        context.raw_connection.send(context.execute_method_name, sql, context.name, context.binds, **context.kwargs)
+      else
+        context.raw_connection.send(context.execute_method_name, sql, context.name, **context.kwargs)
+      end
+    end
+  end
+end

data/lib/arproxy/query_context.rb

@@ -0,0 +1,18 @@
+module Arproxy
+  class QueryContext
+    attr_accessor :raw_connection, :execute_method_name, :with_binds, :name, :binds, :kwargs
+
+    def initialize(raw_connection:, execute_method_name:, with_binds:, name: nil, binds: [], kwargs: {})
+      @raw_connection = raw_connection
+      @execute_method_name = execute_method_name
+      @with_binds = with_binds
+      @name = name
+      @binds = binds
+      @kwargs = kwargs
+    end
+
+    def with_binds?
+      !!@with_binds
+    end
+  end
+end

data/lib/arproxy/version.rb

@@ -1,3 +1,3 @@
 module Arproxy
-  VERSION = '0.2.9'
+  VERSION = '1.0.0'
 end

data/lib/arproxy.rb

@@ -1,73 +1,81 @@
-require "logger"
-require "arproxy/base"
-require "arproxy/config"
-require "arproxy/proxy_chain"
-require "arproxy/error"
-require "arproxy/plugin"
+require 'logger'
+require 'arproxy/base'
+require 'arproxy/config'
+require 'arproxy/connection_adapter_patch'
+require 'arproxy/proxy_chain'
+require 'arproxy/error'
+require 'arproxy/plugin'
 
 module Arproxy
-  @config = @enabled = nil
+  @config = nil
+  @enabled = nil
+  @patch = nil
 
   module_function
-  def clear_configuration
-    @config = Config.new
-  end
-
-  def configure
-    clear_configuration unless @config
-    yield @config
-  end
-
-  def enable!
-    if enable?
-      Arproxy.logger.warn "Arproxy has been already enabled"
-      return
+
+    def clear_configuration
+      @config = nil
     end
 
-    unless @config
-      raise Arproxy::Error, "Arproxy should be configured"
+    def configure
+      @config ||= Config.new
+      yield @config
     end
 
-    @proxy_chain = ProxyChain.new @config
-    @proxy_chain.enable!
+    def enable!
+      if enable?
+        Arproxy.logger.warn 'Arproxy has already been enabled'
+        return
+      end
+
+      unless @config
+        raise Arproxy::Error, 'Arproxy has not been configured'
+      end
 
-    @enabled = true
-  end
+      @patch = ConnectionAdapterPatch.new(@config.adapter_class)
+      @proxy_chain = ProxyChain.new(@config, @patch)
+      @proxy_chain.enable!
 
-  def disable!
-    unless enable?
-      Arproxy.logger.warn "Arproxy is not enabled yet"
-      return
+      @enabled = true
     end
 
-    if @proxy_chain
-      @proxy_chain.disable!
-      @proxy_chain = nil
+    def disable!
+      unless enable?
+        Arproxy.logger.warn 'Arproxy is not enabled yet'
+        return
+      end
+
+      if @proxy_chain
+        @proxy_chain.disable!
+        @proxy_chain = nil
+      end
+
+      @enabled = false
     end
-    @enabled = false
-  end
-
-  def enable?
-    !!@enabled
-  end
-
-  def reenable!
-    if enable?
-      @proxy_chain.reenable!
-    else
-      enable!
+
+    def enable?
+      !!@enabled
+    end
+
+    def reenable!
+      if enable?
+        @proxy_chain.reenable!
+      else
+        enable!
+      end
+    end
+
+    def logger
+      @logger ||= @config && @config.logger ||
+                      defined?(::Rails) && ::Rails.logger ||
+                      ::Logger.new(STDOUT)
+    end
+
+    def proxy_chain
+      @proxy_chain
+    end
+
+    def connection_adapter_patch
+      @patch
     end
-  end
-
-  def logger
-    @logger ||= begin
-                  @config && @config.logger ||
-                    defined?(::Rails) && ::Rails.logger ||
-                    ::Logger.new(STDOUT)
-                end
-  end
-
-  def proxy_chain
-    @proxy_chain
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arproxy
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Issei Naruta
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-18 00:00:00.000000000 Z
+date: 2025-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,83 +16,31 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-description: Arproxy is a proxy between ActiveRecord and database adapter
-email: naruta@cookpad.com
+        version: '6.1'
+description: Arproxy is a proxy layer that allows hooking into ActiveRecord query
+  execution and injecting custom processing
+email: mimitako@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/arproxy.rb
 - lib/arproxy/base.rb
-- lib/arproxy/chain_tail.rb
 - lib/arproxy/config.rb
+- lib/arproxy/connection_adapter_patch.rb
 - lib/arproxy/error.rb
 - lib/arproxy/plugin.rb
+- lib/arproxy/proxy.rb
 - lib/arproxy/proxy_chain.rb
+- lib/arproxy/proxy_chain_tail.rb
+- lib/arproxy/query_context.rb
 - lib/arproxy/version.rb
 homepage: https://github.com/cookpad/arproxy
 licenses:
@@ -113,8 +61,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: Proxy between ActiveRecord and DB adapter
+summary: A proxy layer between ActiveRecord and database adapters
 test_files: []

data/lib/arproxy/chain_tail.rb

@@ -1,11 +0,0 @@
-module Arproxy
-  class ChainTail < Base
-    def initialize(proxy_chain)
-      self.proxy_chain = proxy_chain
-    end
-
-    def execute(sql, name=nil, **kwargs)
-      self.proxy_chain.connection.execute_without_arproxy sql, name, **kwargs
-    end
-  end
-end