store_base_sti_class 2.0.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e65e14ac35f409bec5e78c411a0b3fac80ca189d8e77f693fc2ecc9f4cf609d
-  data.tar.gz: c0aabbee8bba07b1818f5f2fca9f94a916f56e29bcff73d9f1919fa53d269bcc
+  metadata.gz: 6bfa35237d6d92294c821edbb70e75070df5109027f984e567ea4d372cdbb5b1
+  data.tar.gz: c99a988b260c44d272790ae8e0ac47a09d3d75f2b248f4dab4759b63b7cff3f3
 SHA512:
-  metadata.gz: 6078f16de9958cead9799a9da35830c2c031c17bbead961b801f6194905e65e43ab6f002ab34fd34ef6431e0b8f9ab1fc52b0c502372a3957a768480459df882
-  data.tar.gz: 22e514b7f2ce662d2cfa8f8fe6b2bc62f4491defe8b182c76121922f01ca7929146f546cfb7eab0d8d42ba8417c4343ae54d616cb949a44bba48c98fa5b0469f
+  metadata.gz: 6dccdf1b15ea2c0da67d06dcd9f5b2b81a8ab30e529658565de35cabe389998b54ad13b0b4e4732841f8b0c4a52c269899c742b86b0c1d2450be97f199110658
+  data.tar.gz: f8eb0a6a6dc3c677aabdbad59753413d8620b48b586e8c90143a0e232099bb56aca538d395f01b6424ca566151d1b63c9afa75f9e2b0178ef94cf70a352a19d6

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2019 AppFolio, inc.
+Copyright (c) 2011-2022 AppFolio, Inc
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/store_base_sti_class/version.rb

@@ -1,3 +1,3 @@
 module StoreBaseSTIClass
-  VERSION = '2.0.3'.freeze
+  VERSION = '3.0.0'.freeze
 end

data/lib/store_base_sti_class.rb

@@ -1,16 +1,8 @@
+# frozen_string_literal: true
+
 require 'active_record'
 
-if ActiveRecord::VERSION::STRING =~ /^5\.0/
-  require 'store_base_sti_class_for_5_0'
-elsif ActiveRecord::VERSION::STRING =~ /^5\.1/
-  require 'store_base_sti_class_for_5_1'
-elsif ActiveRecord::VERSION::STRING =~ /^5\.2/
-  require 'store_base_sti_class_for_5_2'
-elsif ActiveRecord::VERSION::STRING =~ /^6\.0/
-  require 'store_base_sti_class_for_6_0'
-elsif ActiveRecord::VERSION::STRING =~ /^6\.1/
-  require 'store_base_sti_class_for_6_1'
-end
+require "store_base_sti_class_for_#{ActiveRecord::VERSION::MAJOR}_#{ActiveRecord::VERSION::MINOR}"
 
 module StoreBaseSTIClass
 end

data/lib/{store_base_sti_class_for_5_2.rb → store_base_sti_class_for_7_0.rb}

@@ -1,6 +1,6 @@
 require 'active_record/associations/join_dependency/join_part'
 
-if ActiveRecord::VERSION::STRING =~ /^5\.2/
+if ActiveRecord::VERSION::STRING =~ /\A7\.0/
   module ActiveRecord
 
     class Base
@@ -25,8 +25,12 @@ if ActiveRecord::VERSION::STRING =~ /^5\.2/
             scope = through_reflection.klass.unscoped
             options = reflection.options
 
-            if options[:source_type]
+            values = reflection_scope.values
+            if annotations = values[:annotate]
+              scope.annotate!(*annotations)
+            end
 
+            if options[:source_type]
               # BEGIN PATCH
               # original:
               # scope.where! reflection.foreign_type => options[:source_type]
@@ -43,7 +47,6 @@ if ActiveRecord::VERSION::STRING =~ /^5\.2/
 
             elsif !reflection_scope.where_clause.empty?
               scope.where_clause = reflection_scope.where_clause
-              values = reflection_scope.values
 
               if includes = values[:includes]
                 scope.includes!(source_reflection.name => includes)
@@ -52,7 +55,7 @@ if ActiveRecord::VERSION::STRING =~ /^5\.2/
               end
 
               if values[:references] && !values[:references].empty?
-                scope.references!(values[:references])
+                scope.references_values |= values[:references]
               else
                 scope.references!(source_reflection.table_name)
               end
@@ -70,7 +73,7 @@ if ActiveRecord::VERSION::STRING =~ /^5\.2/
               end
             end
 
-            scope unless scope.empty_scope?
+            scope
           end
         end
       end
@@ -79,19 +82,19 @@ if ActiveRecord::VERSION::STRING =~ /^5\.2/
         private
 
         def next_chain_scope(scope, reflection, next_reflection)
-          join_keys = reflection.join_keys
-          key = join_keys.key
-          foreign_key = join_keys.foreign_key
+          primary_key = reflection.join_primary_key
+          foreign_key = reflection.join_foreign_key
 
           table = reflection.aliased_table
           foreign_table = next_reflection.aliased_table
-          constraint = table[key].eq(foreign_table[foreign_key])
+          constraint = table[primary_key].eq(foreign_table[foreign_key])
 
           if reflection.type
             # BEGIN PATCH
             # original:
             # value = transform_value(next_reflection.klass.polymorphic_name)
             # scope = apply_scope(scope, table, reflection.type, value)
+
             if ActiveRecord::Base.store_base_sti_class
               value = transform_value(next_reflection.klass.polymorphic_name)
             else
@@ -110,43 +113,20 @@ if ActiveRecord::VERSION::STRING =~ /^5\.2/
       class HasManyThroughAssociation
         private
 
-        if Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new('5.2.4')
-          def build_through_record(record)
-            @through_records[record.object_id] ||= begin
-              ensure_mutable
+        def build_through_record(record)
+          @through_records[record.object_id] ||= begin
+            ensure_mutable
 
-              attributes = through_scope_attributes
-              attributes[source_reflection.name] = record
-
-              # START PATCH
-              if ActiveRecord::Base.store_base_sti_class
-                if options[:source_type]
-                  attributes[source_reflection.foreign_type] = options[:source_type]
-                end
-              end
-              # END PATCH
+            attributes = through_scope_attributes
+            attributes[source_reflection.name] = record
 
-              through_association.build(attributes)
+            # START PATCH
+            if ActiveRecord::Base.store_base_sti_class
+              attributes[source_reflection.foreign_type] = options[:source_type] if options[:source_type]
             end
-          end
-        else
-          def build_through_record(record)
-            @through_records[record.object_id] ||= begin
-              ensure_mutable
-
-              through_record = through_association.build(*options_for_through_record)
-              through_record.send("#{source_reflection.name}=", record)
-
-              # START PATCH
-              if ActiveRecord::Base.store_base_sti_class
-                if options[:source_type]
-                  through_record.send("#{source_reflection.foreign_type}=", options[:source_type])
-                end
-              end
-              # END PATCH
+            # END PATCH
 
-              through_record
-            end
+            through_association.build(attributes)
           end
         end
       end

data/store_base_sti_class.gemspec

@@ -1,29 +1,30 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'store_base_sti_class/version'
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name = 'store_base_sti_class'
-  s.version = StoreBaseSTIClass::VERSION
+require_relative 'lib/store_base_sti_class/version'
 
-  s.require_paths = ['lib']
-  s.authors = ['AppFolio']
-  s.description = "\n    ActiveRecord has always stored the base class in polymorphic _type columns when using STI. This can have non-trivial\n    performance implications in certain cases. This gem adds the 'store_base_sti_class' configuration option which controls\n    whether ActiveRecord will store the base class or the actual class. Defaults to true for backwards compatibility.\n  "
-  s.email = 'engineering@appfolio.com'
-  s.extra_rdoc_files = %w(
-    LICENSE.txt
-    README.md
-  )
-  s.files = Dir['**/*'].reject{ |f| f[%r{^pkg/}] || f[%r{^test/}] }
+Gem::Specification.new do |spec|
+  spec.name                  = 'store_base_sti_class'
+  spec.version               = StoreBaseSTIClass::VERSION
+  spec.platform              = Gem::Platform::RUBY
+  spec.author                = 'AppFolio'
+  spec.email                 = 'opensource@appfolio.com'
+  spec.description           = <<~MSG
+    ActiveRecord has always stored the base class in polymorphic _type columns when using STI. This can have non-trivial
+    performance implications in certain cases. This gem adds the 'store_base_sti_class' configuration option which
+    controls whether ActiveRecord will store the base class or the actual class. Defaults to true for backwards
+    compatibility.'
+  MSG
+  spec.summary               = <<~MSG
+    Modifies ActiveRecord 5.0.x - 7.0.x with the ability to store the actual class (instead of the base class) in
+    polymorhic _type columns when using STI.
+  MSG
+  spec.homepage              = 'https://github.com/appfolio/store_base_sti_class'
+  spec.license               = 'MIT'
+  spec.files                 = Dir['**/*'].select { |f| f[%r{^(lib/|LICENSE.txt|.*gemspec)}] }
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.3')
 
-  s.homepage = 'http://github.com/appfolio/store_base_sti_class'
-  s.licenses = ['MIT']
-  s.rubygems_version = '2.2.2'
-  s.summary = 'Modifies ActiveRecord 4.2.x - 6.0.x with the ability to store the actual class (instead of the base class) in polymorhic _type columns when using STI'
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  s.add_runtime_dependency(%q<activerecord>, ['>= 4.0'])
-  s.add_development_dependency(%q<minitest>, ['>= 4.0'])
-  s.add_development_dependency(%q<appraisal>, ['>= 0'])
-  s.add_development_dependency(%q<bundler>, ['>= 0'])
+  spec.add_dependency('activerecord', ['>= 6', '< 7.1'])
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: store_base_sti_class
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 3.0.0
 platform: ruby
 authors:
 - AppFolio
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,92 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: '6'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '7.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '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:
-    - - ">="
+        version: '6'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
-description: "\n    ActiveRecord has always stored the base class in polymorphic _type
-  columns when using STI. This can have non-trivial\n    performance implications
-  in certain cases. This gem adds the 'store_base_sti_class' configuration option
-  which controls\n    whether ActiveRecord will store the base class or the actual
-  class. Defaults to true for backwards compatibility.\n  "
-email: engineering@appfolio.com
+        version: '7.1'
+description: |
+  ActiveRecord has always stored the base class in polymorphic _type columns when using STI. This can have non-trivial
+  performance implications in certain cases. This gem adds the 'store_base_sti_class' configuration option which
+  controls whether ActiveRecord will store the base class or the actual class. Defaults to true for backwards
+  compatibility.'
+email: opensource@appfolio.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.md
+extra_rdoc_files: []
 files:
-- Appraisals
-- Gemfile
 - LICENSE.txt
-- README.md
-- Rakefile
-- gemfiles/rails_5.0.7.gemfile
-- gemfiles/rails_5.1.7.gemfile
-- gemfiles/rails_5.2.3.gemfile
-- gemfiles/rails_5.2.4.gemfile
-- gemfiles/rails_5.2.5.gemfile
-- gemfiles/rails_6.0.3.gemfile
-- gemfiles/rails_6.1.0.gemfile
 - lib/store_base_sti_class.rb
 - lib/store_base_sti_class/version.rb
-- lib/store_base_sti_class_for_5_0.rb
-- lib/store_base_sti_class_for_5_1.rb
-- lib/store_base_sti_class_for_5_2.rb
 - lib/store_base_sti_class_for_6_0.rb
 - lib/store_base_sti_class_for_6_1.rb
+- lib/store_base_sti_class_for_7_0.rb
 - store_base_sti_class.gemspec
-homepage: http://github.com/appfolio/store_base_sti_class
+homepage: https://github.com/appfolio/store_base_sti_class
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -110,16 +60,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: Modifies ActiveRecord 4.2.x - 6.0.x with the ability to store the actual
-  class (instead of the base class) in polymorhic _type columns when using STI
+summary: Modifies ActiveRecord 5.0.x - 7.0.x with the ability to store the actual
+  class (instead of the base class) in polymorhic _type columns when using STI.
 test_files: []

data/Appraisals

@@ -1,15 +0,0 @@
-RAILS_VERSIONS = %w[
-  5.0.7
-  5.1.7
-  5.2.3
-  5.2.4
-  6.0.3
-  6.1.0
-].freeze
-
-RAILS_VERSIONS.each do |version|
-  appraise "rails_#{version}" do
-    gem 'activerecord', version
-    gem 'sqlite3', ['6.0.3', '6.1.0'].include?(version) ? '~> 1.4.0' : '~> 1.3.0'
-  end
-end

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/README.md

@@ -1,101 +0,0 @@
-[![CI](https://github.com/appfolio/store_base_sti_class/workflows/CI/badge.svg)](https://github.com/appfolio/store_base_sti_class/actions)
-
-## Description
-
-Given the following class definitions:
-
-```ruby
-class Address
-  belongs_to :addressable, :polymorphic => true
-end
-
-class Person
-  has_many :addresses, :as => addressable
-end
-
-class Vendor < Person
-end
-```
-
-and given the following code:
-
-```ruby
-vendor = Vendor.create(...)
-address = vendor.addresses.create(...)
-
-p vendor
-p address
-```
-
-will output:
-
-```ruby
-#<Vendor id: 1, type: "Vendor" ...>
-#<Address id: 1, addressable_id: 1, addressable_type: 'Person' ...>
-```
-
-Notice that addressable_type column is Person even though the actual class is Vendor.
-
-Normally, this isn't a problem, however, it can have negative performance
-characteristics in certain circumstances. The most obvious one is that a join
-with persons or an extra query is required to find out the actual type of
-addressable.
-
-This gem adds the ActiveRecord::Base.store_base_sti_class configuration
-option. It defaults to true for backwards compatibility. Setting it to false
-will alter ActiveRecord's behavior to store the actual class in polymorphic
-_type columns when STI is used.
-
-In the example above, if the ActiveRecord::Base.store_base_sti_class is false, the output will be,
-
-```
-  #<Vendor id: 1, type: "Vendor" ...>
-  #<Address id: 1, addressable_id: 1, addressable_type: 'Vendor' ...>
-```
-
-## Usage
-
-Add the following line to your Gemfile,
-
-```ruby
-gem 'store_base_sti_class'
-```
-
-then bundle install. Once you have the gem installed, add the following to one
-of the initializers (or make a new one) in config/initializers,
-
-    ActiveRecord::Base.store_base_sti_class = false
-
-When changing this behavior, you will have write a migration to update all of
-your existing _type columns accordingly. You may also need to change your
-application if it explicitly relies on the _type columns.
-
-## Notes
-
-This gem incorporates work from:
-
-- https://github.com/codepodu/store_base_sti_class_for_4_0
-
-It currently works with ActiveRecord 4.2.x through 6.0.x. If you need support
-for ActiveRecord 3.x, use a pre-1.0 version of the gem, or ActiveRecord < 4.2
-use a pre-2.0 version of the gem.
-
-## Conflicts
-
-This gem produces known conflicts with these other gems:
-
-### friendly_id
-
-When using [friendly_id](https://github.com/norman/friendly_id) >= 5.2.5 with the [History module](https://norman.github.io/friendly_id/FriendlyId/History.html) enabled, duplicate slugs will be generated for STI subclasses with the same sluggable identifier (ex: name). This will either cause saves to fail if you have the proper indexes in place, or will cause slug lookups to be non-deterministic, either of which is undesirable.
-
-## History
-
-* https://github.com/rails/rails/issues/724
-* https://github.com/rails/rails/issues/5441#issuecomment-4563865
-* https://github.com/rails/rails/issues/4729#issuecomment-5729297
-* https://github.com/rails/rails/issues/5441#issuecomment-264871920
-
-## Copyright
-
-Copyright (c) 2011-2019 AppFolio, inc. See LICENSE.txt for
-further details.

data/Rakefile

@@ -1,23 +0,0 @@
-require 'rubygems'
-require 'bundler'
-
-require 'appraisal'
-
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-

data/gemfiles/rails_5.0.7.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "5.0.7"
-gem "sqlite3", "~> 1.3.0"
-
-gemspec path: "../"

data/gemfiles/rails_5.1.7.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "5.1.7"
-gem "sqlite3", "~> 1.3.0"
-
-gemspec path: "../"

data/gemfiles/rails_5.2.3.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "5.2.3"
-gem "sqlite3", "~> 1.3.0"
-
-gemspec path: "../"

data/gemfiles/rails_5.2.4.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "5.2.4"
-gem "sqlite3", "~> 1.3.0"
-
-gemspec path: "../"

data/gemfiles/rails_5.2.5.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "5.2.5"
-gem "sqlite3", "~> 1.3.0"
-
-gemspec path: "../"

data/gemfiles/rails_6.0.3.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "6.0.3"
-gem "sqlite3", "~> 1.4.0"
-
-gemspec path: "../"

data/gemfiles/rails_6.1.0.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "6.1.0"
-gem "sqlite3", "~> 1.4.0"
-
-gemspec path: "../"