activerecord-spatial 2.0.0 → 3.0.0

data/.travis.yml

@@ -0,0 +1,17 @@
+cache: bundler
+sudo: false
+language: ruby
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+  - rbx-3
+  - jruby
+matrix:
+  allow_failures:
+    - rvm: rbx-3
+    - rvm: jruby
+addons:
+  apt:
+    packages:
+      - libgeos-c1

data/Gemfile

@@ -16,5 +16,6 @@ gem 'minitest-reporters'
 gem 'rake'
 gem 'rdoc'
 gem 'simplecov'
+gem 'terminal-notifier'
 
 instance_eval File.read('Gemfile.local') if File.exist?('Gemfile.local')

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2017 J Smith <dark.panda@gmail.com>
+Copyright (c) 2010-2019 J Smith <dark.panda@gmail.com>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.rdoc

@@ -107,21 +107,15 @@ See the test/database.yml file for example settings.
 
 == ActiveRecord Versions Supported
 
-We're starting to standardize on Rails 5 for our purposes, so future versions
-this gem function on versions of Rails 5 and above. To use spatial scopes on
-previous versions of ActiveRecord, see our geos-extensions gem available at
-https://github.com/dark-panda/geos-extensions . We have pulled the ActiveRecord
-extensions out of that gem and are instead packaging them here, thus allowing
-you to use the actual Geos extensions in an unfettered way. If you wish to
-use the spatial extensions with versions of Rails prior to 5, see versions of
-the ActiveRecordSpatial gem prior to version 1.0.0.
+Major version updates now coincide with Rails version updates. This particular
+version works with Rails 6.0. For older versions of Rails, see older versions of
+the gem.
 
 == PostGIS and PostgreSQL Versions Supported
 
-As of this writing, things we test on PostgreSQL 9.4 and PostGIS 2.1+.
-Some features are only available in PostGIS 2.0, such as the +st_3dintersects+
-scope and the like, as that spatial relationship function was added in PostGIS
-2.0.
+As of this writing, things we test on PostgreSQL 11 and PostGIS 2.5+.
+Some features are only available on newer versions of PostGIS such as certain
+scopes and the like.
 
 PostgreSQL 9.0 and below are currently not supported as some of the SQL we
 produce to create the spatial queries is not supported in older PostgreSQL

data/activerecord-spatial.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/dark-panda/activerecord-spatial'
   s.require_paths = ['lib']
 
-  s.add_dependency('rails', ['>= 5.0'])
+  s.add_dependency('rails', ['>= 6.0'])
   s.add_dependency('geos-extensions', ['>= 0.5'])
 end

data/lib/activerecord-spatial.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'geos-extensions'
 

data/lib/activerecord-spatial/active_record.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveRecordSpatial
   autoload :SpatialFunction, 'activerecord-spatial/spatial_function'

data/lib/activerecord-spatial/active_record/connection_adapters/postgresql/adapter_extensions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'active_record/connection_adapters/postgresql_adapter'
 require 'activerecord-spatial/active_record/connection_adapters/postgresql/adapter_extensions/active_record'

data/lib/activerecord-spatial/active_record/connection_adapters/postgresql/adapter_extensions/active_record.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveRecord
   module Type
@@ -37,10 +38,10 @@ ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES[:geom
 
 ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.class_eval do
   prepend(Module.new do
-    def initialize_type_map(type_map)
+    def initialize_type_map(m = type_map)
       super
-      type_map.register_type 'geometry', ::ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Geometry.new
-      type_map.register_type 'geography', ::ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Geography.new
+      m.register_type 'geometry', ::ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Geometry.new
+      m.register_type 'geography', ::ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Geography.new
     end
   end)
 end

data/lib/activerecord-spatial/active_record/connection_adapters/postgresql/postgis.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveRecordSpatial
   POSTGIS = begin

data/lib/activerecord-spatial/active_record/connection_adapters/postgresql/unknown_srid.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveRecordSpatial
   UNKNOWN_SRIDS = begin
@@ -8,7 +9,7 @@ module ActiveRecordSpatial
       }.freeze
     else
       {
-        geography:  0,
+        geography: 0,
         geometry: -1
       }.freeze
     end

data/lib/activerecord-spatial/active_record/models/geography_column.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveRecordSpatial
   class GeographyColumn < ActiveRecord::Base

data/lib/activerecord-spatial/active_record/models/geometry_column.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveRecordSpatial
   class GeometryColumn < ActiveRecord::Base

data/lib/activerecord-spatial/active_record/models/spatial_column.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveRecordSpatial
   module SpatialColumn #:nodoc:

data/lib/activerecord-spatial/active_record/models/spatial_ref_sys.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveRecordSpatial
   class SpatialRefSys < ::ActiveRecord::Base

data/lib/activerecord-spatial/associations.rb

@@ -1,17 +1,13 @@
+# frozen_string_literal: true
 
 require 'activerecord-spatial/associations/base'
 require 'activerecord-spatial/associations/reflection/spatial_reflection'
-require 'activerecord-spatial/associations/preloader/spatial_association'
+require 'activerecord-spatial/associations/spatial_association'
 require 'activerecord-spatial/associations/active_record'
 
 module ActiveRecordSpatial::Associations
   module ClassMethods #:nodoc:
-    def has_many_spatially(name, scope = nil, options = {}, &extension)
-      if scope.is_a?(Hash)
-        options = scope
-        scope   = nil
-      end
-
+    def has_many_spatially(name, scope = nil, **options, &extension)
       options = build_options(options)
 
       unless ActiveRecordSpatial::SpatialScopeConstants::RELATIONSHIPS.include?(options[:relationship].to_s)
@@ -20,11 +16,7 @@ module ActiveRecordSpatial::Associations
 
       reflection = ActiveRecord::Associations::Builder::Spatial.build(self, name, scope, options, &extension)
 
-      if ActiveRecord::Reflection.respond_to?(:add_reflection)
-        ActiveRecord::Reflection.add_reflection(self, name, reflection)
-      end
-
-      reflection
+      ActiveRecord::Reflection.add_reflection(self, name, reflection)
     end
   end
 end

data/lib/activerecord-spatial/associations/active_record.rb

@@ -1,69 +1,35 @@
+# frozen_string_literal: true
 
 module ActiveRecord
   module Associations #:nodoc:
-    class Preloader #:nodoc:
-      class SpatialAssociation < HasMany #:nodoc:
-        private
+    class SpatialAssociationScope < AssociationScope #:nodoc:
+      INSTANCE = create
 
-          def load_records(&block)
-            return {} if owner_keys.empty?
+      class << self
+        def scope(association)
+          ActiveRecord::Associations::SpatialAssociationScope::INSTANCE.scope(association)
+        end
 
-            slices = owner_keys.each_slice(klass.connection.in_clause_length || owner_keys.size)
-            @preloaded_records = slices.flat_map do |slice|
-              records_for(slice).load(&block)
-            end
+        def get_bind_values(owner, chain)
+          binds = []
+          last_reflection = chain.last
 
-            @preloaded_records.each_with_object({}) do |record, memo|
-              keys = record[association_key_name].split(',')
-              keys.each do |key|
-                memo[key] ||= []
-                memo[key] << record
-              end
-            end
+          if last_reflection.type
+            binds << owner.class.polymorphic_name
           end
 
-          def associated_records_by_owner(_preloader)
-            records = load_records do |record|
-              record[association_key_name].split(',').each do |key|
-                owner = owners_by_key[convert_key(key)]
-                association = owner.association(reflection.name)
-                association.set_inverse_instance(record)
-              end
-            end
-
-            owners.each_with_object({}) do |owner, result|
-              result[owner] = records[convert_key(owner[owner_key_name])] || []
+          chain.each_cons(2).each do |reflection, next_reflection|
+            if reflection.type
+              binds << next_reflection.klass.polymorphic_name
             end
           end
-      end
-    end
-
-    class SpatialAssociation < HasManyAssociation #:nodoc:
-      def association_scope
-        return unless klass
-
-        @association_scope ||= SpatialAssociationScope.scope(self, klass.connection)
-      end
-
-      private
-
-        def get_records
-          scope.to_a
-        end
-    end
-
-    class SpatialAssociationScope < AssociationScope #:nodoc:
-      INSTANCE = create
-
-      class << self
-        def scope(association, connection)
-          INSTANCE.scope(association, connection)
+          binds
         end
       end
 
-      def last_chain_scope(scope, table, reflection, owner, assoc_klass)
+      def last_chain_scope(scope, reflection, owner)
         geom_options = {
-          class: assoc_klass
+          class: reflection.klass
         }
 
         if reflection.geom.is_a?(Hash)
@@ -74,15 +40,91 @@ module ActiveRecord
           geom_options[:name] = reflection.geom
         end
 
+        table = reflection.aliased_table
         scope = scope.send("st_#{reflection.relationship}", geom_options, reflection.scope_options)
 
         if reflection.type
-          polymorphic_type = transform_value(owner.class.base_class.name)
-          scope = scope.where(table.name => { reflection.type => polymorphic_type })
+          polymorphic_type = transform_value(owner.class.polymorphic_name)
+          scope = apply_scope(scope, table, reflection.type, polymorphic_type)
         end
 
         scope
       end
     end
+
+    class Preloader #:nodoc:
+      class SpatialAssociation < Association #:nodoc:
+        SPATIAL_FIELD_ALIAS = '__spatial_ids__'
+        SPATIAL_JOIN_NAME = '__spatial_ids_join__'
+        SPATIAL_JOIN_QUOTED_NAME = %{"#{SPATIAL_JOIN_NAME}"}
+
+        private
+
+          def records_for(ids)
+            join_name = reflection.active_record.quoted_table_name
+            column = %{#{SPATIAL_JOIN_QUOTED_NAME}.#{klass.quoted_primary_key}}
+            geom = {
+              class: reflection.active_record,
+              table_alias: SPATIAL_JOIN_NAME
+            }
+
+            if reflection.options[:geom].is_a?(Hash)
+              geom.merge!(reflection.options[:geom])
+            else
+              geom[:column] = reflection.options[:geom]
+            end
+
+            where_function = klass.send(
+              "st_#{reflection.options[:relationship]}",
+              geom,
+              (reflection.options[:scope_options] || {}).merge(
+                column: reflection.options[:foreign_geom]
+              )
+            )
+
+            spatial_scope = scope
+              .select(%{#{klass.quoted_table_name}.*, array_to_string(array_agg(#{column}), ',') AS "#{SPATIAL_FIELD_ALIAS}"})
+              .joins(
+                "INNER JOIN #{join_name} AS #{SPATIAL_JOIN_QUOTED_NAME} ON (" +
+                  where_function.where_clause.send(:predicates).join(' AND ') +
+                  ')'
+              )
+              .where(klass.arel_table.alias(SPATIAL_JOIN_NAME)[klass.primary_key].in(ids))
+              .group(klass.arel_table[klass.primary_key])
+
+            spatial_scope.load do |record|
+              record[SPATIAL_FIELD_ALIAS].split(',').each do |spatial_id|
+                owner = owners_by_key[convert_key(spatial_id)].first
+
+                association = owner.association(reflection.name)
+                association.set_inverse_instance(record)
+              end
+            end
+          end
+
+          def records_by_owner
+            @records_by_owner ||= preloaded_records.each_with_object({}.compare_by_identity) do |record, result|
+              record[SPATIAL_FIELD_ALIAS].split(',').each do |spatial_id|
+                owners_by_key[convert_key(spatial_id)].each do |owner|
+                  (result[owner] ||= []) << record
+                end
+              end
+            end
+          end
+      end
+
+      private
+
+        prepend(Module.new do
+          def preloader_for(reflection, owners)
+            return super unless reflection.is_a?(ActiveRecord::Reflection::SpatialReflection)
+            return AlreadyLoaded if owners.first.association(reflection.name).loaded?
+
+            reflection.check_preloadable!
+
+            SpatialAssociation
+          end
+      end)
+    end
   end
 end

data/lib/activerecord-spatial/associations/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveRecord
   module Associations #:nodoc:
@@ -13,7 +14,7 @@ module ActiveRecord
         :inverse_of
       ].freeze
 
-      def macro
+      def self.macro
         SPATIAL_MACRO
       end
 
@@ -21,24 +22,6 @@ module ActiveRecord
         super + VALID_SPATIAL_OPTIONS - INVALID_SPATIAL_OPTIONS
       end
     end
-
-    class Preloader #:nodoc:
-      class SpatialAssociation < HasMany #:nodoc:
-        SPATIAL_FIELD_ALIAS = '__spatial_ids__'.freeze
-        SPATIAL_JOIN_NAME = '__spatial_ids_join__'.freeze
-        SPATIAL_JOIN_QUOTED_NAME = %{"#{SPATIAL_JOIN_NAME}"}.freeze
-      end
-
-      prepend(Module.new do
-        def preloader_for(reflection, *args)
-          if reflection.is_a?(ActiveRecord::Reflection::SpatialReflection)
-            SpatialAssociation
-          else
-            super
-          end
-        end
-      end)
-    end
   end
 end
 

data/lib/activerecord-spatial/associations/reflection/spatial_reflection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveRecord
   module Reflection #:nodoc:

data/lib/activerecord-spatial/associations/spatial_association.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Associations
+    class SpatialAssociation < HasManyAssociation #:nodoc:
+      def association_scope
+        return unless klass
+
+        @association_scope ||= SpatialAssociationScope.scope(self)
+      end
+
+      private
+
+        def find_target
+          scope = self.scope
+          return scope.to_a if skip_statement_cache?(scope)
+
+          conn = klass.connection
+
+          # Since we're not using binds, we need to disable the scope cache,
+          # basically, as otherwise the non-bound parameters we use will cause
+          # cache misses that basically ignore subsequent scopes. This would
+          # be much better to remove completely, but this will do for now
+          # until we can find a better solution.
+          reflection.clear_association_scope_cache
+
+          sc = reflection.association_scope_cache(conn, owner) do |params|
+            as = SpatialAssociationScope.create { params.bind }
+            target_scope.merge!(as.scope(self))
+          end
+
+          binds = SpatialAssociationScope.get_bind_values(owner, reflection.chain)
+          sc.execute(binds, conn) { |record| set_inverse_instance(record) } || []
+        end
+
+        def association_key_name
+          SPATIAL_FIELD_ALIAS
+        end
+    end
+  end
+end