store_base_sti_class 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aabffbc0536524e6c2a17e341a8959ce740b8c46
-  data.tar.gz: f9d1c2edbd97b6e0971abcb5eb0b567ec0c0350b
+SHA256:
+  metadata.gz: ee6cec99ea0b5aba6ca085f1119ad70837f40502af8b248d78d466e649b66a02
+  data.tar.gz: 6b2e0d8ba7829f225efa6eeb98fc74b30568f922bfe4664dbf8c1b060e4a3b6b
 SHA512:
-  metadata.gz: 25f4895ee9da5799f5ba11d65dc831c7c8fdfe07ce169eb74c471a50345674028bb57d8e15e8a56a37e71d18d365a4b457ea3f03d57111a2b3561915ce935607
-  data.tar.gz: 9cab2026fa30b27d2901ad0574d0cf478405dce07068298a7f77f595959dd17dcba8c66936c3125a7822ee1b58e2af168ba5e2aad359cf71704456b1a9bd5717
+  metadata.gz: 229854ef106a719bde09b41a71e821aa2cd69ee73877125f5fbc83a9b2fe9467e1e4b4f0d934579f7c1650ba53adbc581a4b08efe50837ef03fa42be6381e870
+  data.tar.gz: 950d8d123ba09b1d26c88ac3601b676ba61018e24697792487bb07da21686a4ce3749c378f667f2eb69948a51b87a3631ee2308e2346012be80629188b351bb5

data/Appraisals

@@ -1,71 +1,14 @@
-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
-  4.2.9
-  4.2.10
-  5.0.0
-  5.0.0.1
-  5.0.1
-  5.0.2
-  5.0.3
-  5.0.4
-  5.0.5
-  5.0.6
-  5.1.0
-  5.1.1
-  5.1.2
-  5.1.3
-  5.1.4
-  5.1.5
-  5.2.0
-)
+RAILS_VERSIONS = %w[
+  4.2.11
+  5.0.7
+  5.1.6
+  5.2.2
+  6.0.0
+].freeze
 
 RAILS_VERSIONS.each do |version|
   appraise "rails_#{version}" do
     gem 'activerecord', version
+    gem 'sqlite3', version == '6.0.0' ? '~> 1.4.0' : '~> 1.3.0'
   end
 end

data/Gemfile.lock

@@ -1,38 +1,37 @@
 PATH
   remote: .
   specs:
-    store_base_sti_class (1.1.0)
+    store_base_sti_class (2.0.0)
       activerecord (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.1.4)
-      activesupport (= 5.1.4)
-    activerecord (5.1.4)
-      activemodel (= 5.1.4)
-      activesupport (= 5.1.4)
-      arel (~> 8.0)
-    activesupport (5.1.4)
+    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)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
     appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
-    arel (8.0.0)
-    concurrent-ruby (1.0.5)
-    i18n (0.9.5)
+    concurrent-ruby (1.1.5)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.11.1)
-    rake (12.3.1)
-    sqlite3 (1.3.13)
-    thor (0.20.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
@@ -41,8 +40,7 @@ DEPENDENCIES
   appraisal
   bundler
   minitest (>= 4.0)
-  sqlite3
   store_base_sti_class!
 
 BUNDLED WITH
-   1.16.1
+   1.17.2

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

@@ -35,12 +35,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 +60,26 @@ 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.
 
 ## 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_4.2.11.gemfile

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

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.6.gemfile

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

data/gemfiles/rails_5.2.2.gemfile

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

data/gemfiles/rails_6.0.0.gemfile

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

data/lib/store_base_sti_class.rb

@@ -1,10 +1,6 @@
 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/
+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'
@@ -12,6 +8,8 @@ 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
 
 module StoreBaseSTIClass

data/lib/store_base_sti_class/version.rb

@@ -1,3 +1,3 @@
 module StoreBaseSTIClass
-  VERSION = '1.2.0'.freeze
+  VERSION = '2.0.0'.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_6_0.rb

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