with_model 2.1.7 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83aa1a692c521015759725b2641f53304ab13f6c3aac17550dc7b802c8e015ea
-  data.tar.gz: e8c44ffe440d68a3f8311f2250a2184e88fffbe1d9713f0b870a5c15fcf8ec2e
+  metadata.gz: 809e5984c60e2fa27b71d3d3ce7664feae0a3b2c7a59f345e2a94a819affb623
+  data.tar.gz: 5e8b519ef7d338aa754755efd065af68b718e6dc1f96fe27632266752e7b4990
 SHA512:
-  metadata.gz: 3acf78cc398a2c3c7612a1ee534d3d11ed93f701b8cbfaa218d8b64fb5c3dc0a3a5cf23080f3853e97cf1ba72a9cc202673f058a7c784213287bf9b81e0a1e85
-  data.tar.gz: 0b8ccf8fa27e19880fbfdd166d3eb0974cecaecc94955c2d32204306eb3ca48f050f2b578a9042d81a34e0bfc7d6ab14e5c42b16d802e4b16cfc7efeb38bfecc
+  metadata.gz: cf09e4aabe724638f054a54199d62a61ae9efd0cca28485412f85fd082a99f104d4f538bd7041f1777c9380398e7d1497d5f01dcc07cb5fdacc116ad3e7dd69f
+  data.tar.gz: 6f795b756e9b33abd148d51010a0afb80e01660af35c76d1a98a634c6b2d31c38a616e94aeff99c6d8b19b019c69b994c9b5dc21e69439fbbcb004528dc3606b

data/.github/workflows/ci.yml

@@ -6,8 +6,6 @@ on:
       - master
       - github-actions
   pull_request:
-    branches:
-      - master
 
 jobs:
   test:
@@ -17,18 +15,31 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+        ruby-version: ['3.1', '3.2', '3.3', '3.4']
         active-record-version-env:
-          - ACTIVE_RECORD_VERSION="~> 6.0.0"
-          - ACTIVE_RECORD_VERSION="~> 6.1.0"
           - ACTIVE_RECORD_VERSION="~> 7.0.0"
+          - ACTIVE_RECORD_VERSION="~> 7.1.0"
+          - ACTIVE_RECORD_VERSION="~> 7.2.0"
+          - ACTIVE_RECORD_VERSION="~> 8.0.0"
         allow-failure: [false]
+        exclude:
+          - ruby-version: '3.1'
+            active-record-version-env: ACTIVE_RECORD_VERSION="~> 8.0.0"
         include:
-          - ruby-version: '3.2'
-            active-record-version-env: ACTIVE_RECORD_BRANCH="7-0-stable"
+          - ruby-version: '3.4'
+            active-record-version-env: ACTIVE_RECORD_BRANCH="main"
+            allow-failure: true
+          - ruby-version: '3.4'
+            active-record-version-env: ACTIVE_RECORD_BRANCH="8-0-stable"
             allow-failure: true
-          - ruby-version: '3.2'
-            active-record-version-env: ACTIVE_RECORD_BRANCH="6-1-stable"
+          - ruby-version: '3.4'
+            active-record-version-env: ACTIVE_RECORD_BRANCH="7-2-stable"
+            allow-failure: true
+          - ruby-version: '3.4'
+            active-record-version-env: ACTIVE_RECORD_BRANCH="7-1-stable"
+            allow-failure: true
+          - ruby-version: '3.4'
+            active-record-version-env: ACTIVE_RECORD_BRANCH="7-0-stable"
             allow-failure: true
     continue-on-error: ${{ matrix.allow-failure }}
     steps:

data/.rspec

@@ -1,3 +1,3 @@
 --color
 --format documentation
---order default
+--order defined

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 2.2.0
+
+- Fix dependency tracking issue when `cache_classes: true` is set in Rails 7+.
+- Create table in same database as `superclass` (Joe Lind)
+- Switch to standard instead of rubocop for linting.
+- Add support for Active Record 7 and 8.
+- Require Active Record 7 or later.
+- Add support for Ruby 3.3.
+- Require Ruby 3.1 or later.
+
 ### 2.1.7
 - Require Ruby 2.7 or later
 - Add Ruby 3.2 support

data/Gemfile

@@ -1,33 +1,31 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-ar_branch = ENV.fetch('ACTIVE_RECORD_BRANCH', nil)
-ar_version = ENV.fetch('ACTIVE_RECORD_VERSION', nil)
-is_jruby = RUBY_PLATFORM == 'java'
+ar_branch = ENV.fetch("ACTIVE_RECORD_BRANCH", nil)
+ar_version = ENV.fetch("ACTIVE_RECORD_VERSION", nil)
 
 if ar_branch
-  gem 'activerecord', git: 'https://github.com/rails/rails.git', branch: ar_branch
-  if ar_branch == 'master'
-    gem 'arel', git: 'https://github.com/rails/arel.git'
-    gem 'activerecord-jdbcsqlite3-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter.git' if is_jruby
-  end
+  gem "activerecord", git: "https://github.com/rails/rails.git", branch: ar_branch
+  gem "arel", git: "https://github.com/rails/arel.git" if ar_branch == "master"
 elsif ar_version
-  gem 'activerecord', ar_version
-  if is_jruby && !Gem::Requirement.new(ar_version).satisfied_by?(Gem::Version.new('5.2.0'))
-    gem 'activerecord-jdbcsqlite3-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter.git'
-  end
+  gem "activerecord", ar_version
 end
 
-gem 'bundler'
-gem 'minitest'
-gem 'rake'
-gem 'rspec'
-gem 'rubocop'
-gem 'rubocop-minitest'
-gem 'rubocop-rake'
-gem 'rubocop-rspec'
-gem 'simplecov'
-gem 'sqlite3', '~> 1.6.0' unless is_jruby
+gem "bigdecimal"
+gem "bundler"
+gem "debug"
+gem "logger"
+gem "minitest"
+gem "mutex_m"
+gem "rake"
+gem "rspec"
+gem "standard"
+
+if ar_branch == "7-0-stable" || ar_version == "~> 7.0.0"
+  gem "sqlite3", "< 2"
+else
+  gem "sqlite3"
+end

data/Rakefile

@@ -1,23 +1,14 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rake/testtask'
-require 'rubocop/rake_task'
+require "bundler/gem_tasks"
 
-desc 'Run specs'
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = Dir.glob('spec/**/*_spec.rb')
-end
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
 
-desc 'Run tests'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-end
+require "minitest/test_task"
+Minitest::TestTask.create
 
-desc 'Run lint'
-RuboCop::RakeTask.new
+# standard rake task
+require "standard/rake"
 
-task default: %i[spec test rubocop]
+task default: %i[spec test standard]

data/lib/with_model/constant_stubber.rb

@@ -37,7 +37,7 @@ module WithModel
     end
 
     def lookup_list
-      @const_name.to_s.split('::')
+      @const_name.to_s.split("::")
     end
 
     def basename

data/lib/with_model/descendants_tracker.rb

@@ -0,0 +1,87 @@
+require "active_support/descendants_tracker"
+
+module WithModel
+  # Based on https://github.com/rails/rails/blob/491afff27e2dd3d5f301b478b9a43d3c31709af8/activesupport/lib/active_support/descendants_tracker.rb
+  module DescendantsTracker
+    if RUBY_ENGINE == "ruby"
+      # On MRI `ObjectSpace::WeakMap` keys are weak references.
+      # So we can simply use WeakMap as a `Set`.
+      class WeakSet < ObjectSpace::WeakMap # :nodoc:
+        alias_method :to_a, :keys
+
+        def <<(object)
+          self[object] = true
+        end
+      end
+    else
+      # On TruffleRuby `ObjectSpace::WeakMap` keys are strong references.
+      # So we use `object_id` as a key and the actual object as a value.
+      #
+      # JRuby for now doesn't have Class#descendant, but when it will, it will likely
+      # have the same WeakMap semantic than Truffle so we future proof this as much as possible.
+      class WeakSet # :nodoc:
+        def initialize
+          @map = ObjectSpace::WeakMap.new
+        end
+
+        def [](object)
+          @map.key?(object.object_id)
+        end
+        alias_method :include?, :[]
+
+        def []=(object, _present)
+          @map[object.object_id] = object
+        end
+
+        def to_a
+          @map.values
+        end
+
+        def <<(object)
+          self[object] = true
+        end
+      end
+    end
+    @excluded_descendants = WeakSet.new
+
+    class << self
+      def clear(classes) # :nodoc:
+        classes.each do |klass|
+          @excluded_descendants << klass
+          klass.descendants.each do |descendant|
+            @excluded_descendants << descendant
+          end
+        end
+      end
+
+      def reject!(classes) # :nodoc:
+        if @excluded_descendants
+          classes.reject! { |d| @excluded_descendants.include?(d) }
+        end
+        classes
+      end
+    end
+
+    module DestroyedClassesFiltering
+      def subclasses
+        WithModel::DescendantsTracker.reject!(super)
+      end
+
+      def descendants
+        WithModel::DescendantsTracker.reject!(super)
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  extend WithModel::DescendantsTracker::DestroyedClassesFiltering
+end
+
+module ActiveSupport
+  module DescendantsTracker
+    class << self
+      attr_reader :clear_disabled
+    end
+  end
+end

data/lib/with_model/model.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
-require 'active_record'
-require 'active_support/core_ext/string/inflections'
-require 'English'
-require 'with_model/constant_stubber'
-require 'with_model/methods'
-require 'with_model/table'
+require "logger"
+require "active_record"
+require "active_support/core_ext/string/inflections"
+require "English"
+require "with_model/constant_stubber"
+require "with_model/descendants_tracker"
+require "with_model/methods"
+require "with_model/table"
 
 module WithModel
   # In general, direct use of this class should be avoided. Instead use
@@ -38,6 +40,7 @@ module WithModel
       cleanup_descendants_tracking
       reset_dependencies_cache
       table.destroy
+      WithModel::DescendantsTracker.clear([@model])
       @model = nil
     end
 
@@ -54,15 +57,8 @@ module WithModel
     end
 
     def cleanup_descendants_tracking
-      if defined?(ActiveSupport::DescendantsTracker)
-        if ActiveSupport::VERSION::MAJOR >= 7
-          ActiveSupport::DescendantsTracker.clear([@model])
-        else
-          ActiveSupport::DescendantsTracker.class_variable_get(:@@direct_descendants).delete(ActiveRecord::Base)
-        end
-      elsif @model.superclass.respond_to?(:direct_descendants)
-        @model.superclass.direct_descendants.delete(@model)
-      end
+      ActiveSupport::DescendantsTracker.clear([@model]) \
+        unless ActiveSupport::DescendantsTracker.clear_disabled
     end
 
     def reset_dependencies_cache
@@ -76,7 +72,7 @@ module WithModel
     end
 
     def table
-      @table ||= Table.new table_name, @table_options, &@table_block
+      @table ||= Table.new table_name, @table_options, connection: @superclass.connection, &@table_block
     end
 
     def table_name

data/lib/with_model/table.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'active_record'
+require "active_record"
 
 module WithModel
   # In general, direct use of this class should be avoided. Instead use
@@ -8,12 +8,14 @@ module WithModel
   class Table
     # @param [Symbol] name The name of the table to create.
     # @param options Passed to ActiveRecord `create_table`.
+    # @param connection The connection to use for creating the table.
     # @param block Passed to ActiveRecord `create_table`.
     # @see https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/SchemaStatements.html#method-i-create_table
-    def initialize(name, options = {}, &block)
+    def initialize(name, options = {}, connection: ActiveRecord::Base.connection, &block)
       @name = name.freeze
       @options = options.freeze
       @block = block
+      @connection = connection
     end
 
     # Creates the table with the initialized options. Drops the table if
@@ -29,6 +31,8 @@ module WithModel
 
     private
 
+    attr_reader :connection
+
     def exists?
       if connection.respond_to?(:data_source_exists?)
         connection.data_source_exists?(@name)
@@ -36,9 +40,5 @@ module WithModel
         connection.table_exists?(@name)
       end
     end
-
-    def connection
-      ActiveRecord::Base.connection
-    end
   end
 end

data/lib/with_model/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WithModel
-  VERSION = '2.1.7'
+  VERSION = "2.2.0"
 end

data/lib/with_model.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'with_model/model'
-require 'with_model/model/dsl'
-require 'with_model/table'
-require 'with_model/version'
+require "with_model/model"
+require "with_model/model/dsl"
+require "with_model/table"
+require "with_model/version"
 
 module WithModel
   class MiniTestLifeCycle < Module
@@ -61,7 +61,7 @@ module WithModel
   # @param [Object] object The new model object instance to create
   # @param scope Passed to `before`/`after` in the test context. Rspec only.
   # @param [Symbol] runner The test running, either :rspec or :minitest, defaults to :rspec
-  def setup_object(object, scope: nil, runner: nil) # rubocop:disable Metrics/MethodLength
+  def setup_object(object, scope: nil, runner: nil)
     case runner || WithModel.runner
     when :rspec
       before(*scope) do
@@ -76,7 +76,7 @@ module WithModel
         include MiniTestLifeCycle.call(object)
       end
     else
-      raise ArgumentError, 'Unsupported test runner set, expected :rspec or :minitest'
+      raise ArgumentError, "Unsupported test runner set, expected :rspec or :minitest"
     end
   end
 end

data/spec/active_record_behaviors_spec.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
-describe 'ActiveRecord behaviors' do
-  describe 'a temporary ActiveRecord model created with with_model' do
-    context 'that has a named scope' do
+describe "ActiveRecord behaviors" do
+  describe "a temporary ActiveRecord model created with with_model" do
+    context "that has a named scope" do
       before do
         @regular_model = Class.new ActiveRecord::Base do
-          self.table_name = 'regular_models'
-          scope :title_is_foo, -> { where(title: 'foo') }
+          self.table_name = "regular_models"
+          scope :title_is_foo, -> { where(title: "foo") }
         end
 
         @regular_model.connection.create_table(@regular_model.table_name, force: true) do |t|
-          t.string 'title'
-          t.text 'content'
+          t.string "title"
+          t.text "content"
           t.timestamps null: false
         end
       end
@@ -24,37 +24,37 @@ describe 'ActiveRecord behaviors' do
 
       with_model :BlogPost do
         table do |t|
-          t.string 'title'
-          t.text 'content'
+          t.string "title"
+          t.text "content"
           t.timestamps null: false
         end
 
         model do
-          scope :title_is_foo, -> { where(title: 'foo') }
+          scope :title_is_foo, -> { where(title: "foo") }
         end
       end
 
-      describe 'the named scope' do
-        it 'works like a regular named scope' do
-          included = @regular_model.create!(title: 'foo', content: 'Include me!')
-          @regular_model.create!(title: 'bar', content: 'Include me!')
+      describe "the named scope" do
+        it "works like a regular named scope" do
+          included = @regular_model.create!(title: "foo", content: "Include me!")
+          @regular_model.create!(title: "bar", content: "Include me!")
 
           expect(@regular_model.title_is_foo).to eq [included]
 
-          included = BlogPost.create!(title: 'foo', content: 'Include me!')
-          BlogPost.create!(title: 'bar', content: 'Include me!')
+          included = BlogPost.create!(title: "foo", content: "Include me!")
+          BlogPost.create!(title: "bar", content: "Include me!")
 
           expect(BlogPost.title_is_foo).to eq [included]
         end
       end
     end
 
-    context 'that has a polymorphic belongs_to' do
+    context "that has a polymorphic belongs_to" do
       before do
         animal = Class.new ActiveRecord::Base do
           has_many :tea_cups, as: :pet
         end
-        stub_const 'Animal', animal
+        stub_const "Animal", animal
       end
 
       with_model :TeaCup do
@@ -74,24 +74,24 @@ describe 'ActiveRecord behaviors' do
         end
       end
 
-      describe 'the polymorphic belongs_to' do
-        it 'works like a regular polymorphic belongs_to' do
+      describe "the polymorphic belongs_to" do
+        it "works like a regular polymorphic belongs_to" do
           animal = Animal.create!
           stuffed_animal = StuffedAnimal.create!
 
           tea_cup_for_animal = TeaCup.create!(pet: animal)
-          expect(tea_cup_for_animal.pet_type).to eq 'Animal'
+          expect(tea_cup_for_animal.pet_type).to eq "Animal"
           expect(animal.tea_cups).to include(tea_cup_for_animal)
 
           tea_cup_for_stuffed_animal = TeaCup.create!(pet: stuffed_animal)
-          expect(tea_cup_for_stuffed_animal.pet_type).to eq 'StuffedAnimal'
+          expect(tea_cup_for_stuffed_animal.pet_type).to eq "StuffedAnimal"
           expect(stuffed_animal.tea_cups).to include(tea_cup_for_stuffed_animal)
         end
       end
     end
   end
 
-  context 'with an association' do
+  context "with an association" do
     with_model :Province do
       table do |t|
         t.belongs_to :country
@@ -103,13 +103,13 @@ describe 'ActiveRecord behaviors' do
 
     with_model :Country
 
-    context 'in earlier examples' do
-      it 'works as normal' do
+    context "in earlier examples" do
+      it "works as normal" do
         expect { Province.create!(country: Country.create!) }.not_to raise_error
       end
     end
 
-    context 'in later examples' do
+    context "in later examples" do
       it "does not hold a reference to earlier example groups' classes" do
         expect(Province.reflect_on_association(:country).klass).to eq Country
       end

data/spec/constant_stubber_spec.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 module WithModel
   describe ConstantStubber do
-    it 'allows calling unstub_const multiple times' do
-      stubber = described_class.new('Foo')
+    it "allows calling unstub_const multiple times" do
+      stubber = described_class.new("Foo")
       stubber.stub_const(1)
       expect { 2.times { stubber.unstub_const } }.not_to raise_error
     end
 
-    it 'allows calling unstub_const without stub_const' do
-      stubber = described_class.new('Foo')
+    it "allows calling unstub_const without stub_const" do
+      stubber = described_class.new("Foo")
       expect { stubber.unstub_const }.not_to raise_error
     end
   end

data/spec/descendants_tracking_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "Descendants tracking" do
+  with_model :BlogPost do
+    model do
+      def self.inspect
+        "BlogPost class #{object_id}"
+      end
+    end
+  end
+
+  def blog_post_classes
+    ActiveRecord::Base.descendants.select do |c|
+      c.table_name == BlogPost.table_name
+    end
+  end
+
+  shared_examples "clearing descendants between test runs" do
+    it "includes the correct model class in descendants on the first test run" do
+      expect(blog_post_classes).to eq [BlogPost]
+    end
+
+    it "includes the correct model class in descendants on the second test run" do
+      expect(blog_post_classes).to eq [BlogPost]
+    end
+  end
+
+  context "with ActiveSupport::DescendantsTracker (cache_classes: true)" do
+    before do
+      expect(ActiveSupport::DescendantsTracker.clear_disabled).to be_falsey
+      expect { ActiveSupport::DescendantsTracker.clear([]) }.not_to raise_exception
+    end
+
+    include_examples "clearing descendants between test runs"
+  end
+
+  context "without ActiveSupport::DescendantsTracker (cache_classes: false)" do
+    before do
+      ActiveSupport::DescendantsTracker.disable_clear!
+      expect(ActiveSupport::DescendantsTracker.clear_disabled).to be_truthy
+      expect { ActiveSupport::DescendantsTracker.clear([]) }.to raise_exception(RuntimeError)
+    end
+
+    include_examples "clearing descendants between test runs"
+  end
+end