store_base_sti_class 1.1.0 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 82287e5bc596474535ed2f815cb34cbfe2abb089
-  data.tar.gz: 3f1999f09ccaa5f380cb4230f4cba6eb81c2dc2e
+SHA256:
+  metadata.gz: 5e65e14ac35f409bec5e78c411a0b3fac80ca189d8e77f693fc2ecc9f4cf609d
+  data.tar.gz: c0aabbee8bba07b1818f5f2fca9f94a916f56e29bcff73d9f1919fa53d269bcc
 SHA512:
-  metadata.gz: fccef96be8809df757d5936781d2fe4811b5d4fd56d5b53fd026448c35d86288f4c10327b1562b4478e360f7e38f2c8406a7b3995b2364ffff05cfaf231b8d00
-  data.tar.gz: 94e2b0a7c09cfcd051f791077636c9d0301687cd713ce0d899efc39994fbf07e5604e9f38a3ecd02ec008774f43694f5ed354103983e193fc1d7e0f25bade606
+  metadata.gz: 6078f16de9958cead9799a9da35830c2c031c17bbead961b801f6194905e65e43ab6f002ab34fd34ef6431e0b8f9ab1fc52b0c502372a3957a768480459df882
+  data.tar.gz: 22e514b7f2ce662d2cfa8f8fe6b2bc62f4491defe8b182c76121922f01ca7929146f546cfb7eab0d8d42ba8417c4343ae54d616cb949a44bba48c98fa5b0469f

data/Appraisals

@@ -1,61 +1,15 @@
-RAILS_VERSIONS = %w(
-  4.0.0
-  4.0.1
-  4.0.2
-  4.0.3
-  4.0.4
-  4.0.5
-  4.0.6
-  4.0.7
-  4.0.8
-  4.0.9
-  4.0.10
-  4.0.11
-  4.0.11.1
-  4.0.12
-  4.0.13
-  4.1.0
-  4.1.1
-  4.1.2
-  4.1.3
-  4.1.4
-  4.1.5
-  4.1.6
-  4.1.7
-  4.1.7.1
-  4.1.8
-  4.1.9
-  4.1.10
-  4.1.11
-  4.1.12
-  4.1.13
-  4.1.14
-  4.1.14.1
-  4.1.14.2
-  4.1.15
-  4.2.0
-  4.2.1
-  4.2.2
-  4.2.3
-  4.2.4
-  4.2.5
-  4.2.5.1
-  4.2.5.2
-  4.2.6
-  4.2.7
-  4.2.7.1
-  4.2.8
-  5.0.0
-  5.0.0.1
-  5.0.1
-  5.0.2
-  5.0.3
-  5.1.0
-  5.1.1
-)
+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/LICENSE.txt

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

data/README.md

@@ -1,4 +1,5 @@
-[![Build Status](https://travis-ci.org/appfolio/store_base_sti_class.svg?branch=master)](https://travis-ci.org/appfolio/store_base_sti_class)
+[![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:
@@ -35,12 +36,18 @@ will output:
 
 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.
+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.
+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' ...>
@@ -54,21 +61,41 @@ Add the following line to your Gemfile,
 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,
+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
+    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.
+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.0.x through 5.0.x. If you need support for ActiveRecord 3.x, use a pre-1.0 version of the gem.
+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-2017 AppFolio, inc. See LICENSE.txt for
+Copyright (c) 2011-2019 AppFolio, inc. See LICENSE.txt for
 further details.
-

data/gemfiles/rails_5.0.7.gemfile

@@ -0,0 +1,8 @@
+# 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

@@ -0,0 +1,8 @@
+# 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

@@ -0,0 +1,8 @@
+# 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

@@ -0,0 +1,8 @@
+# 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

@@ -0,0 +1,8 @@
+# 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

@@ -0,0 +1,8 @@
+# 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

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

data/lib/store_base_sti_class.rb

@@ -1,15 +1,15 @@
 require 'active_record'
 
-if ActiveRecord::VERSION::STRING =~ /^4\.0/
-  require 'store_base_sti_class_for_4_0'
-elsif ActiveRecord::VERSION::STRING =~ /^4\.1/
-  require 'store_base_sti_class_for_4_1'
-elsif ActiveRecord::VERSION::STRING =~ /^4\.2/
-  require 'store_base_sti_class_for_4_2'
-elsif ActiveRecord::VERSION::STRING =~ /^5\.0/
+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
 
 module StoreBaseSTIClass

data/lib/store_base_sti_class/version.rb

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

data/lib/store_base_sti_class_for_5_0.rb

@@ -8,6 +8,22 @@ if ActiveRecord::VERSION::STRING =~ /^5\.0/
       self.store_base_sti_class = true
     end
 
+    class PredicateBuilder
+      class AssociationQueryHandler
+        def call(attribute, value)
+          queries = {}
+
+          table = value.associated_table
+          if value.base_class
+            queries[table.association_foreign_type.to_s] = ActiveRecord::Base.store_base_sti_class ? value.base_class.name : value.value.class.name
+          end
+
+          queries[table.association_foreign_key.to_s] = value.ids
+          predicate_builder.build_from_hash(queries)
+        end
+      end
+    end
+
     module Associations
       class Association
         private

data/lib/store_base_sti_class_for_5_1.rb

@@ -8,6 +8,22 @@ if ActiveRecord::VERSION::STRING =~ /^5\.1/
       self.store_base_sti_class = true
     end
 
+    class PredicateBuilder
+      class AssociationQueryHandler
+        def call(attribute, value)
+          queries = {}
+
+          table = value.associated_table
+          if value.base_class
+            queries[table.association_foreign_type.to_s] = ActiveRecord::Base.store_base_sti_class ? value.base_class.name : value.value.class.name
+          end
+
+          queries[table.association_foreign_key.to_s] = value.ids
+          predicate_builder.build_from_hash(queries)
+        end
+      end
+    end
+
     module Associations
       class Association
         private

data/lib/store_base_sti_class_for_5_2.rb

@@ -0,0 +1,176 @@
+require 'active_record/associations/join_dependency/join_part'
+
+if ActiveRecord::VERSION::STRING =~ /^5\.2/
+  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
+
+            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
+              values = reflection_scope.values
+
+              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[: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 unless scope.empty_scope?
+          end
+        end
+      end
+
+      class AssociationScope
+        private
+
+        def next_chain_scope(scope, reflection, next_reflection)
+          join_keys = reflection.join_keys
+          key = join_keys.key
+          foreign_key = join_keys.foreign_key
+
+          table = reflection.aliased_table
+          foreign_table = next_reflection.aliased_table
+          constraint = table[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
+
+        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
+
+              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
+
+              through_association.build(attributes)
+            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
+
+              through_record
+            end
+          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