knockoff 1.1.0.alpha → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b9352faddb2bf60d2ddf6f3c91c9e03bce498a41
-  data.tar.gz: c4bb57f7a8b240d71ca164d489de9b26535ce53b
+SHA256:
+  metadata.gz: 22fb5337ef43e286ab938ab8d6e4905529607979266b8bb7673eccdba23c5d3c
+  data.tar.gz: 9990634bf328df85fe419cbb3aea20b591d4a9c94420184f89012a15649ac2af
 SHA512:
-  metadata.gz: 13d2338a6425fe9eea71c30b8b838f7df6fe9c69e369193b67bd3be59c739062a8f0515f7cc28c2846e0df743d9745467b5e3b5e3cf2bfdbeb680719c2bc4efd
-  data.tar.gz: ffda5a9534ca24f6dfb85d59ea3a225bd5759a50eaa94f71ae869396abf7d7806fa05583108adfbd240abb0c5356b2d9b3bf241af0dc0f59fb3c0edeab906d1a
+  metadata.gz: d7e7d9f11f4a7ea199d48e98c322d66b75db01eb2659b5218ea3928c586e1cab1d4087e3c7eb2aa1c54bdce744beb4f5c46fd2e4b43dc3972c1d735c6762acbf
+  data.tar.gz: 4a6d620cffa48322560e060e1b500704791216d9daf6a3f6f81e90adaec25546012dbf0a55ca66c427265b87f42d3f0a1818f2aa93fbb84292a89ff7cd816bd2

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on: push
+
+jobs:
+  test:
+
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        ruby-version: ['2.4.0', '2.5.1', '2.6.6', '2.7.2']
+
+    steps:
+      # Pin to this commit: v2
+      - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
+      - name: Set up Ruby
+        # Lock to this commit, v1.82.0
+        uses: ruby/setup-ruby@5e4f0a10bfc39c97cd5358121291e27e5d97e09b
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake spec

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Unreleased
 
+## 1.1.1
+
+- Drop Ruby 2.3 support
+- Add Ruby 2.6 and 2.7 support
+- Fix a deprecation warning in Rails 6
+
+## 1.1.0
+
 - Allow for not checking `inside_transaction?` on primary database (https://github.com/joinhandshake/knockoff/pull/13)
 - Allow setting `Knockoff.default_target` to set the default target other than `:primary` (https://github.com/joinhandshake/knockoff/pull/11)
 - Drop Ruby 2.2 support

data/README.md

@@ -1,11 +1,11 @@
 # Knockoff
 
-[![Build Status](https://travis-ci.org/joinhandshake/knockoff.svg?branch=master)](https://travis-ci.org/joinhandshake/knockoff)
+[![Build Status](https://github.com/joinhandshake/knockoff/actions/workflows/ruby.yml/badge.svg)](https://github.com/joinhandshake/knockoff/actions)
 [![Gem Version](https://badge.fury.io/rb/knockoff.svg)](https://badge.fury.io/rb/knockoff)
 
 A gem for easily using read replicas.
 
-:handshake: Battle tested at [Handshake](https://joinhandshake.com/engineering/)
+:handshake: Battle tested at [Handshake](https://joinhandshake.com/)
 
 ## Library Goals
 
@@ -17,7 +17,7 @@ A gem for easily using read replicas.
 
 ## Supported Versions
 
-Knockoff supports Rails 4 and 5
+Knockoff supports Rails 4, 5 and 6
 
 ## Installation
 

data/knockoff.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'activerecord', '>= 4.0.0'
-  spec.add_runtime_dependency 'activesupport', '>= 4.0.0'
+  spec.add_runtime_dependency 'activerecord', '>= 4.0.0', '< 6.1'
+  spec.add_runtime_dependency 'activesupport', '>= 4.0.0', '< 6.1'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/knockoff/active_record/relation.rb

@@ -5,11 +5,11 @@ module ActiveRecord
     # Supports queries like User.on_replica.to_a
     alias_method :exec_queries_without_knockoff, :exec_queries
 
-    def exec_queries
+    def exec_queries(&block)
       if knockoff_target == :replica
-        Knockoff.on_replica { exec_queries_without_knockoff }
+        Knockoff.on_replica { exec_queries_without_knockoff(&block) }
       else
-        exec_queries_without_knockoff
+        exec_queries_without_knockoff(&block)
       end
     end
 

data/lib/knockoff/config.rb

@@ -95,11 +95,24 @@ module Knockoff
             end
 
           # Store the hash in configuration and use it when we establish the connection later.
+          # TODO: In ActiveRecord >= 6, this is a deprecated way to set a configuration. However
+          # there appears to be an issue when calling `ActiveRecord::Base.configurations.to_h` in
+          # version 6.0.4.8 where
+          # multi-database setup is being ignored / dropped. For example if a database.yml setup
+          # has something like..
+          #
+          # development:
+          #   primary:
+          #     ...
+          #   other:
+          #     ...
+          #
+          # then the 'other' database configuration is being dropped.
           key = "knockoff_replica_#{index}"
-          full_config = replica_config.merge(uri_config)
+          config = replica_config.merge(uri_config)
+          ActiveRecord::Base.configurations[key] = config
 
-          ActiveRecord::Base.configurations[key] = full_config
-          @replicas_configurations[key] = full_config
+          @replicas_configurations[key] = config
         rescue URI::InvalidURIError
           Rails.logger.info "LOG NOTIFIER: Invalid URL specified in follower_env_keys. Not including URI, which may result in no followers used." # URI is purposely not printed to logs
           # Return a 'nil' which will be removed from

data/lib/knockoff/replica_connection_pool.rb

@@ -30,6 +30,12 @@ module Knockoff
       end
     end
 
+    def set_schema_cache(cache)
+      @pool.each do |_name, klass|
+        klass.connection_pool.schema_cache = cache
+      end
+    end
+
     def random_replica_connection
       @pool[@pool.keys.sample]
     end

data/lib/knockoff/version.rb

@@ -1,3 +1,3 @@
 module Knockoff
-  VERSION = '1.1.0.alpha'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/lib/knockoff.rb

@@ -49,6 +49,10 @@ module Knockoff
       @config ||= Config.new
     end
 
+    def set_schema_cache(cache)
+      replica_pool.set_schema_cache(cache)
+    end
+
     def base_transaction_depth
       @base_transaction_depth ||= begin
         testcase = ActiveSupport::TestCase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockoff
 version: !ruby/object:Gem::Version
-  version: 1.1.0.alpha
+  version: 1.3.0
 platform: ruby
 authors:
 - Scott Ringwelski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-26 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +47,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -101,9 +113,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -136,12 +149,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A gem for easily using read replicas

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-notifications:
-  email: false
-rvm:
-  - 2.3.1
-  - 2.4.0
-  - 2.5.1
-  - ruby-head