Merge pull request rails-on-services#243 from eraffel-MDSol/development

Support Rails 7.1, drop Ruby 2.x and Rails < 6.1

.circleci/config.yml

@@ -3,11 +3,9 @@ version: 2.1
 jobs:
   build:
     docker:
-      - image: << parameters.ruby_version >>
-      - image: postgres:11.19-alpine
-        environment:
-          POSTGRES_HOST_AUTH_METHOD: "trust"
-      - image: mysql:5.7
+      - image: cimg/<< parameters.ruby_version >>
+      - image: cimg/postgres:12.13
+      - image: cimg/mysql:8.0
         environment:
           MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
     parameters:
@@ -19,31 +17,16 @@ jobs:
       BUNDLE_GEMFILE: << parameters.gemfile >>
     steps:
       - checkout
-      # Restore Cached Dependencies
-      # - restore_cache:
-      #     keys:
-      #       - gem-cache-v1-{{ arch }}-{{ .Branch }}-{{ checksum "<< parameters.gemfile >>.lock" }}
-      #       - gem-cache-v1-{{ arch }}-{{ .Branch }}
-      #       - gem-cache-v1
 
       - run: bundle install --path vendor/bundle
 
-      # - save_cache:
-      #     key: gem-cache-v1-{{ arch }}-{{ .Branch }}-{{ checksum "<< parameters.gemfile >>.lock" }}
-      #     paths:
-      #       - vendor/bundle
-
       - run:
           name: Update apt
-          command: apt update -y
+          command: sudo apt update -y
 
       - run:
           name: Install dependencies
-          command: apt install -y curl postgresql-client default-mysql-client
-
-      - run:
-          name: Install dockerize
-          command: curl -sfL $(curl -s https://api.github.com/repos/powerman/dockerize/releases/latest | grep -i /dockerize-$(uname -s)-$(uname -m)\" | cut -d\" -f4) | install /dev/stdin /usr/local/bin/dockerize
+          command: sudo apt install -y curl postgresql-client default-mysql-client
 
       - run:
           name: Configure config database.yml
@@ -75,12 +58,5 @@ workflows:
       - build:
           matrix:
             parameters:
-              ruby_version: ["ruby:2.7-buster", "ruby:3.0-buster", "ruby:3.1-buster", "ruby:3.2-buster"]
-              gemfile: ["gemfiles/rails_5_2.gemfile", "gemfiles/rails_6_0.gemfile", "gemfiles/rails_6_1.gemfile", "gemfiles/rails_7_0.gemfile"]
-            exclude:
-              - ruby_version: "ruby:3.0-buster"
-                gemfile: "gemfiles/rails_5_2.gemfile"
-              - ruby_version: "ruby:3.1-buster"
-                gemfile: "gemfiles/rails_5_2.gemfile"
-              - ruby_version: "ruby:3.2-buster"
-                gemfile: "gemfiles/rails_5_2.gemfile"
+              ruby_version: ["ruby:3.1.4", "ruby:3.2.2"]
+              gemfile: ["gemfiles/rails_6_1.gemfile", "gemfiles/rails_7_0.gemfile", "gemfiles/rails_7_1.gemfile"]

.ruby-version

@@ -1 +1 @@
-2.7.7
+3.1.4

Appraisals

@@ -1,28 +1,19 @@
 # frozen_string_literal: true
 
-appraise 'rails-5-2' do
-  gem 'rails', '~> 5.2.0'
-  platforms :jruby do
-    gem 'activerecord-jdbc-adapter', '~> 52.0'
-    gem 'activerecord-jdbcpostgresql-adapter', '~> 52.0'
-    gem 'activerecord-jdbcmysql-adapter', '~> 52.0'
-  end
-end
-
-appraise 'rails-6-0' do
-  gem 'rails', '~> 6.0.0'
+appraise 'rails-6-1' do
+  gem 'rails', '~> 6.1.0'
   platforms :ruby do
     gem 'sqlite3', '~> 1.4'
   end
   platforms :jruby do
-    gem 'activerecord-jdbc-adapter', '~> 60.0'
-    gem 'activerecord-jdbcpostgresql-adapter', '~> 60.0'
-    gem 'activerecord-jdbcmysql-adapter', '~> 60.0'
+    gem 'activerecord-jdbc-adapter', '~> 61.0'
+    gem 'activerecord-jdbcpostgresql-adapter', '~> 61.0'
+    gem 'activerecord-jdbcmysql-adapter', '~> 61.0'
   end
 end
 
-appraise 'rails-6-1' do
-  gem 'rails', '~> 6.1.0'
+appraise 'rails-7-0' do
+  gem 'rails', '~> 7.0.0'
   platforms :ruby do
     gem 'sqlite3', '~> 1.4'
   end
@@ -33,10 +24,10 @@ appraise 'rails-6-1' do
   end
 end
 
-appraise 'rails-7-0' do
-  gem 'rails', '~> 7.0.0'
+appraise 'rails-7-1' do
+  gem 'rails', '~> 7.1.0'
   platforms :ruby do
-    gem 'sqlite3', '~> 1.4'
+    gem 'sqlite3', '~> 1.6'
   end
   platforms :jruby do
     gem 'activerecord-jdbc-adapter', '~> 61.0'

Rakefile

@@ -132,22 +132,8 @@ def my_config
   config['mysql']
 end
 
-def activerecord_below_5_2?
-  ActiveRecord.version.release < Gem::Version.new('5.2.0')
-end
-
-def activerecord_below_6_0?
-  ActiveRecord.version.release < Gem::Version.new('6.0.0')
-end
-
 def migrate
-  if activerecord_below_5_2?
-    ActiveRecord::Migrator.migrate('spec/dummy/db/migrate')
-  elsif activerecord_below_6_0?
-    ActiveRecord::MigrationContext.new('spec/dummy/db/migrate').migrate
-  else
-    # TODO: Figure out if there is any other possibility that can/should be
-    # passed here as the second argument for the migration context
-    ActiveRecord::MigrationContext.new('spec/dummy/db/migrate', ActiveRecord::SchemaMigration).migrate
-  end
+  # TODO: Figure out if there is any other possibility that can/should be
+  # passed here as the second argument for the migration context
+  ActiveRecord::MigrationContext.new('spec/dummy/db/migrate', ActiveRecord::SchemaMigration).migrate
 end

gemfiles/rails_7_1.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 7.1.0"
+
+platforms :ruby do
+  gem "sqlite3", "~> 1.6"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbc-adapter", "~> 61.0"
+  gem "activerecord-jdbcpostgresql-adapter", "~> 61.0"
+  gem "activerecord-jdbcmysql-adapter", "~> 61.0"
+end
+
+gemspec path: "../"

lib/apartment.rb

@@ -7,15 +7,9 @@
 require 'apartment/tenant'
 
 require_relative 'apartment/log_subscriber'
-
-if ActiveRecord.version.release >= Gem::Version.new('6.0')
-  require_relative 'apartment/active_record/connection_handling'
-end
-
-if ActiveRecord.version.release >= Gem::Version.new('6.1')
-  require_relative 'apartment/active_record/schema_migration'
-  require_relative 'apartment/active_record/internal_metadata'
-end
+require_relative 'apartment/active_record/connection_handling'
+require_relative 'apartment/active_record/schema_migration'
+require_relative 'apartment/active_record/internal_metadata'
 
 # Apartment main definitions
 module Apartment
@@ -33,14 +27,10 @@ class << self
     attr_accessor(*ACCESSOR_METHODS)
     attr_writer(*WRITER_METHODS)
 
-    if ActiveRecord.version.release >= Gem::Version.new('6.1')
-      def_delegators :connection_class, :connection, :connection_db_config, :establish_connection
+    def_delegators :connection_class, :connection, :connection_db_config, :establish_connection
 
-      def connection_config
-        connection_db_config.configuration_hash
-      end
-    else
-      def_delegators :connection_class, :connection, :connection_config, :establish_connection
+    def connection_config
+      connection_db_config.configuration_hash
     end
 
     # configure apartment with available options

lib/apartment/active_record/connection_handling.rb

@@ -1,22 +1,20 @@
 # frozen_string_literal: true
 
 module ActiveRecord # :nodoc:
-  if ActiveRecord::VERSION::MAJOR >= 6
-    # This is monkeypatching Active Record to ensure that whenever a new connection is established it
-    # switches to the same tenant as before the connection switching. This problem is more evident when
-    # using read replica in Rails 6
-    module ConnectionHandling
-      def connected_to_with_tenant(role: nil, prevent_writes: false, &blk)
-        current_tenant = Apartment::Tenant.current
+  # This is monkeypatching Active Record to ensure that whenever a new connection is established it
+  # switches to the same tenant as before the connection switching. This problem is more evident when
+  # using read replica in Rails 6
+  module ConnectionHandling
+    def connected_to_with_tenant(role: nil, prevent_writes: false, &blk)
+      current_tenant = Apartment::Tenant.current
 
-        connected_to_without_tenant(role: role, prevent_writes: prevent_writes) do
-          Apartment::Tenant.switch!(current_tenant)
-          yield(blk)
-        end
+      connected_to_without_tenant(role: role, prevent_writes: prevent_writes) do
+        Apartment::Tenant.switch!(current_tenant)
+        yield(blk)
       end
-
-      alias connected_to_without_tenant connected_to
-      alias connected_to connected_to_with_tenant
     end
+
+    alias connected_to_without_tenant connected_to
+    alias connected_to connected_to_with_tenant
   end
 end

lib/apartment/active_record/schema_migration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveRecord
-  class SchemaMigration < ActiveRecord::Base # :nodoc:
+  class SchemaMigration # :nodoc:
     class << self
       def table_exists?
         connection.table_exists?(table_name)

lib/apartment/migrator.rb

@@ -13,40 +13,22 @@ def migrate(database)
 
         migration_scope_block = ->(migration) { ENV['SCOPE'].blank? || (ENV['SCOPE'] == migration.scope) }
 
-        if activerecord_below_5_2?
-          ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_paths, version, &migration_scope_block)
-        else
-          ActiveRecord::Base.connection.migration_context.migrate(version, &migration_scope_block)
-        end
+        ActiveRecord::Base.connection.migration_context.migrate(version, &migration_scope_block)
       end
     end
 
     # Migrate up/down to a specific version
     def run(direction, database, version)
       Tenant.switch(database) do
-        if activerecord_below_5_2?
-          ActiveRecord::Migrator.run(direction, ActiveRecord::Migrator.migrations_paths, version)
-        else
-          ActiveRecord::Base.connection.migration_context.run(direction, version)
-        end
+        ActiveRecord::Base.connection.migration_context.run(direction, version)
       end
     end
 
     # rollback latest migration `step` number of times
     def rollback(database, step = 1)
       Tenant.switch(database) do
-        if activerecord_below_5_2?
-          ActiveRecord::Migrator.rollback(ActiveRecord::Migrator.migrations_paths, step)
-        else
-          ActiveRecord::Base.connection.migration_context.rollback(step)
-        end
+        ActiveRecord::Base.connection.migration_context.rollback(step)
       end
     end
-
-    private
-
-    def activerecord_below_5_2?
-      ActiveRecord.version.release < Gem::Version.new('5.2.0')
-    end
   end
 end

ros-apartment.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/rails-on-services/apartment'
   s.licenses = ['MIT']
 
-  s.add_dependency 'activerecord', '>= 5.0.0', '< 7.1'
+  s.add_dependency 'activerecord', '>= 6.1.0', '< 7.2'
   s.add_dependency 'parallel', '< 2.0'
   s.add_dependency 'public_suffix', '>= 2.0.5', '< 6.0'
   s.add_dependency 'rack', '>= 1.3.6', '< 3.0'
@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'rspec', '~> 3.4'
   s.add_development_dependency 'rspec_junit_formatter'
-  s.add_development_dependency 'rspec-rails', '~> 3.4'
+  s.add_development_dependency 'rspec-rails', '~> 6.1'
   s.add_development_dependency 'rubocop', '~> 0.93'
   s.add_development_dependency 'rubocop-performance', '~> 1.10'
   s.add_development_dependency 'rubocop-rails', '~> 2.1'

spec/dummy/db/migrate/20110613152810_create_dummy_models.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-migration_class = ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[4.2] : ActiveRecord::Migration
-class CreateDummyModels < migration_class
+class CreateDummyModels < ActiveRecord::Migration[4.2]
   def self.up
     create_table :companies do |t|
       t.boolean :dummy

spec/dummy/db/migrate/20111202022214_create_table_books.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-migration_class = ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[4.2] : ActiveRecord::Migration
-class CreateTableBooks < migration_class
+class CreateTableBooks < ActiveRecord::Migration[4.2]
   def up
     create_table :books do |t|
       t.string :name

spec/dummy/db/migrate/20180415260934_create_public_tokens.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-migration_class = ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[4.2] : ActiveRecord::Migration
-class CreatePublicTokens < migration_class
+class CreatePublicTokens < ActiveRecord::Migration[4.2]
   def up
     create_table :public_tokens do |t|
       t.string :token

spec/examples/schema_adapter_examples.rb

@@ -213,7 +213,7 @@
       it 'should not raise any errors' do
         expect do
           subject.switch! 'unknown_schema'
-        end.not_to raise_error(Apartment::TenantNotFound)
+        end.not_to raise_error
       end
     end