store_base_sti_class 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d905b8e881303f37a959af003a8ae10b9a8c47d936a6adb9afc75bf149dbbd68
-  data.tar.gz: 53baeb1bf2222de935343215b1bfa036d3cbd4c26ae6087ead371e0918e11754
+  metadata.gz: 6bfa35237d6d92294c821edbb70e75070df5109027f984e567ea4d372cdbb5b1
+  data.tar.gz: c99a988b260c44d272790ae8e0ac47a09d3d75f2b248f4dab4759b63b7cff3f3
 SHA512:
-  metadata.gz: 285c2c32254eb69039e4cc5337065dcde7f1a99f65fdc6902e1027e6dbd380a36bd488ae87c0e5b2c718d463ce0f4a5fb82f1993246bab4f7ccee0ca2914c2ab
-  data.tar.gz: 9be85dd36e7ed71a298d95dc434940e73a05de94d798d21cf46d9b805a683129272ee07688e684c056a46bc7ce9321e06a6f2ece71f2f4219eeab11f902ef1f9
+  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.1'.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 =~ /^4\.2/
-  require 'store_base_sti_class_for_4_2'
-elsif 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'
-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_6_1.rb}

@@ -1,6 +1,6 @@
 require 'active_record/associations/join_dependency/join_part'
 
-if ActiveRecord::VERSION::STRING =~ /^5\.2/
+if ActiveRecord::VERSION::STRING =~ /^6\.1/
   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 ActiveRecord::VERSION::STRING =~ /^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/lib/store_base_sti_class_for_7_0.rb

@@ -0,0 +1,156 @@
+require 'active_record/associations/join_dependency/join_part'
+
+if ActiveRecord::VERSION::STRING =~ /\A7\.0/
+  module ActiveRecord
+
+    class Base
+      class_attribute :store_base_sti_class
+      self.store_base_sti_class = true
+    end
+
+    module Inheritance
+      module ClassMethods
+        def polymorphic_name
+          ActiveRecord::Base.store_base_sti_class ? base_class.name : name
+        end
+      end
+    end
+
+    module Associations
+      class Preloader
+        class ThroughAssociation < Association
+          private
+
+          def through_scope
+            scope = through_reflection.klass.unscoped
+            options = reflection.options
+
+            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]
+
+              adjusted_foreign_type =
+                if ActiveRecord::Base.store_base_sti_class
+                  options[:source_type]
+                else
+                  ([options[:source_type].constantize] + options[:source_type].constantize.descendants).map(&:to_s)
+                end
+
+              scope.where! reflection.foreign_type => adjusted_foreign_type
+              # END PATCH
+
+            elsif !reflection_scope.where_clause.empty?
+              scope.where_clause = reflection_scope.where_clause
+
+              if includes = values[:includes]
+                scope.includes!(source_reflection.name => includes)
+              else
+                scope.includes!(source_reflection.name)
+              end
+
+              if values[:references] && !values[:references].empty?
+                scope.references_values |= values[:references]
+              else
+                scope.references!(source_reflection.table_name)
+              end
+
+              if joins = values[:joins]
+                scope.joins!(source_reflection.name => joins)
+              end
+
+              if left_outer_joins = values[:left_outer_joins]
+                scope.left_outer_joins!(source_reflection.name => left_outer_joins)
+              end
+
+              if scope.eager_loading? && order_values = values[:order]
+                scope = scope.order(order_values)
+              end
+            end
+
+            scope
+          end
+        end
+      end
+
+      class AssociationScope
+        private
+
+        def next_chain_scope(scope, reflection, next_reflection)
+          primary_key = reflection.join_primary_key
+          foreign_key = reflection.join_foreign_key
+
+          table = reflection.aliased_table
+          foreign_table = next_reflection.aliased_table
+          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
+              klass = next_reflection.klass
+              value = ([klass] + klass.descendants).map(&:name)
+            end
+            scope = apply_scope(scope, table, reflection.type, value)
+            # END PATCH
+          end
+
+          scope.joins!(join(foreign_table, constraint))
+        end
+
+      end
+
+      class HasManyThroughAssociation
+        private
+
+        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
+              attributes[source_reflection.foreign_type] = options[:source_type] if options[:source_type]
+            end
+            # END PATCH
+
+            through_association.build(attributes)
+          end
+        end
+      end
+    end
+
+    module Reflection
+      class PolymorphicReflection
+        def source_type_scope
+          type = @previous_reflection.foreign_type
+          source_type = @previous_reflection.options[:source_type]
+
+          # START PATCH
+          adjusted_source_type =
+            if ActiveRecord::Base.store_base_sti_class
+              source_type
+            else
+              ([source_type.constantize] + source_type.constantize.descendants).map(&:to_s)
+            end
+          # END PATCH
+
+          lambda { |object| where(type => adjusted_source_type) }
+        end
+      end
+    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.1
+  version: 3.0.0
 platform: ruby
 authors:
 - AppFolio
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,93 +16,43 @@ 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
-- Gemfile.lock
 - LICENSE.txt
-- README.md
-- Rakefile
-- gemfiles/rails_4.2.11.gemfile
-- gemfiles/rails_5.0.7.gemfile
-- gemfiles/rails_5.1.6.gemfile
-- gemfiles/rails_5.2.3.gemfile
-- gemfiles/rails_5.2.4.gemfile
-- gemfiles/rails_6.0.1.gemfile
 - lib/store_base_sti_class.rb
 - lib/store_base_sti_class/version.rb
-- lib/store_base_sti_class_for_4_2.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: {}
-post_install_message: 
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -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.0.3
-signing_key: 
+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[
-  4.2.11
-  5.0.7
-  5.1.6
-  5.2.3
-  5.2.4
-  6.0.1
-].freeze
-
-RAILS_VERSIONS.each do |version|
-  appraise "rails_#{version}" do
-    gem 'activerecord', version
-    gem 'sqlite3', version == '6.0.1' ? '~> 1.4.0' : '~> 1.3.0'
-  end
-end

data/Gemfile

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

data/Gemfile.lock

@@ -1,46 +0,0 @@
-PATH
-  remote: .
-  specs:
-    store_base_sti_class (2.0.0)
-      activerecord (>= 4.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (6.0.1)
-      activesupport (= 6.0.1)
-    activerecord (6.0.1)
-      activemodel (= 6.0.1)
-      activesupport (= 6.0.1)
-    activesupport (6.0.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    appraisal (2.2.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    concurrent-ruby (1.1.5)
-    i18n (1.7.0)
-      concurrent-ruby (~> 1.0)
-    minitest (5.13.0)
-    rake (13.0.1)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    zeitwerk (2.2.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  appraisal
-  bundler
-  minitest (>= 4.0)
-  store_base_sti_class!
-
-BUNDLED WITH
-   1.17.2