spatial_features 3.0.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57499f73e1190669ab1f3b5893c718db536fda282cce4a91bb0936908c5b2548
-  data.tar.gz: 0eb2e143c321b8e4e0dc498673d4a3c82e6d8d66df131a6ce445654a2f874772
+  metadata.gz: fabdd3f0f73eb21327f8e3deb1b7dda5969d97bdb7c053c60199a63fe5cd04b1
+  data.tar.gz: 777c5dc188ba968ab4cba25e58fa2f361c9d3814781ecfb9e751cf0fc1b40b0e
 SHA512:
-  metadata.gz: 8dca234339ac5c209752e01ae0eea025f8ad88e51480b73d4d5ec3beed2ebd019c58f4c96ba56a25f0655611474eea396ee0da0be8d13ece5db0b279d5de2e27
-  data.tar.gz: 72f3fbceb533ffad03a849cf7d3caed587749d0d3d3a6830538beb59787588fc67803c965b3ad7fed10512d3cc3aecdc9878f45c8cbf52a1656746289b3e598d
+  metadata.gz: e3f28e99e814f1fcc2ba49edf8a59ff957b9f92c9e0d990f93409c61f00d4c496e7ac5f60eb3616660df720c615033f62dbe02d707c1584cc4cee7d9cb88067c
+  data.tar.gz: 18e776f2d1bc792e7a0313d5742345e93adca24f060472bb10a36611eb3e62cf7fe8fcf2d7d520db16cd9b1755e85b4e40e75cabcb4110e25c397e42087fd9e0

data/README.md

@@ -31,7 +31,6 @@ Adds spatial methods to a model.
         feature_type character varying(255),
         geog geography,
         geom geometry(Geometry,4326),
-        geom_lowres geometry(Geometry,4326),
         tilegeom geometry(Geometry,3857),
         metadata hstore,
         area double precision,
@@ -50,7 +49,6 @@ Adds spatial methods to a model.
     CREATE INDEX index_features_on_feature_type ON features USING btree (feature_type);
     CREATE INDEX index_features_on_spatial_model_id_and_spatial_model_type ON features USING btree (spatial_model_id, spatial_model_type);
     CREATE INDEX index_features_on_geom ON features USING gist (geom);
-    CREATE INDEX index_features_on_geom_lowres ON features USING gist (geom_lowres);
     CREATE INDEX index_features_on_tilegeom ON features USING gist (tilegeom);
 
     CREATE TABLE spatial_caches (
@@ -181,3 +179,26 @@ add_column :features, :tilegeom, :geometry
 add_index :features, :tilegeom, :using => :gist
 Feature.update_all('tilegeom = ST_Transform(geom, 3857)')
 ```
+
+## Upgrading From 3.0/3.1 to 3.2
+SpatialProximity now expects the `model_a` and `model_b` records to be decided based on the name of the record type so
+queries can be optimized. Migrate existing SpatialProximity rows to this new scheme by running the code below.
+
+```ruby
+SpatialProximity.normalize
+```
+
+## Testing
+
+Create a postgres database:
+```bash
+createdb spatial_features_test
+```
+
+There are multiple gemfiles available for testing against different Rails versions.  Set `BUNDLE_GEMFILE` to target them, e.g.
+
+```bash
+bundle install
+BUNDLE_GEMFILE=gemfiles/rails_7_0.gemfile bundle install
+BUNDLE_GEMFILE=gemfiles/rails_7_0.gemfile bundle exec rspec
+```

data/app/models/abstract_feature.rb

@@ -69,11 +69,11 @@ class AbstractFeature < ActiveRecord::Base
   end
 
   def self.intersecting(other)
-    join_other_features(other).where('ST_Intersects(features.geom_lowres, other_features.geom_lowres)').uniq
+    join_other_features(other).where('ST_Intersects(features.geom_lowres, other_features.geom_lowres)').distinct
   end
 
   def self.within_distance(other, distance_in_meters)
-    join_other_features(other).where('ST_DWithin(features.geom_lowres, other_features.geom_lowres, ?)', distance_in_meters).uniq
+    join_other_features(other).where('ST_DWithin(features.geom_lowres, other_features.geom_lowres, ?)', distance_in_meters).distinct
   end
 
   def self.invalid(column = 'geog::geometry')
@@ -126,8 +126,8 @@ class AbstractFeature < ActiveRecord::Base
     SQL
   end
 
-  def self.mvt(*args)
-    select_sql = mvt_sql(*args)
+  def self.mvt(*args, **kwargs)
+    select_sql = mvt_sql(*args, **kwargs)
 
     # Result is a hex string representing the desired binary output so we need to convert it to binary
     result = SpatialFeatures::Utils.select_db_value(select_sql)

data/app/models/spatial_proximity.rb

@@ -2,10 +2,34 @@ class SpatialProximity < ActiveRecord::Base
   belongs_to :model_a, :polymorphic => true
   belongs_to :model_b, :polymorphic => true
 
-  def self.between(scope_1, scope_2)
-    where <<-SQL.squish
-      (#{SpatialFeatures::Utils.polymorphic_condition(scope_1, 'model_a')} AND #{SpatialFeatures::Utils.polymorphic_condition(scope_2, 'model_b')}) OR
-      (#{SpatialFeatures::Utils.polymorphic_condition(scope_2, 'model_a')} AND #{SpatialFeatures::Utils.polymorphic_condition(scope_1, 'model_b')})
+  def self.between(scope1, scope2)
+    where condition_sql(scope1, scope2, <<~SQL.squish)
+      (#{SpatialFeatures::Utils.polymorphic_condition(scope1, 'model_a')} AND #{SpatialFeatures::Utils.polymorphic_condition(scope2, 'model_b')})
     SQL
   end
+
+  def self.condition_sql(scope1, scope2, template, pattern_a = 'model_a', pattern_b = 'model_b')
+    scope1_type = SpatialFeatures::Utils.base_class_of(scope1).to_s
+    scope2_type = SpatialFeatures::Utils.base_class_of(scope2).to_s
+
+    if scope1_type < scope2_type
+      template
+    elsif scope1_type > scope2_type
+      template.gsub(pattern_a, 'model_c').gsub(pattern_b, pattern_a).gsub('model_c', pattern_b)
+    else
+      <<~SQL.squish
+        (#{template}) OR (#{template.gsub(pattern_a, 'model_c').gsub(pattern_b, pattern_a).gsub('model_c', pattern_b)})
+      SQL
+    end
+  end
+
+  # Ensure the 'earliest' model is always model a
+  def self.normalize
+    unnormalized
+      .update_all('model_a_type = model_b_type, model_b_type = model_a_type, model_a_id = model_b_id, model_b_id = model_a_id')
+  end
+
+  def self.unnormalized
+    where('model_a_type > model_b_type OR (model_a_type = model_b_type AND model_a_id > model_b_id)')
+  end
 end

data/config/initializers/register_oids.rb

@@ -1,8 +1,12 @@
 module PostGISTypes
   def initialize_type_map(m = type_map)
     super
-    register_class_with_limit m, 'geometry', ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID::SpecializedString
-    register_class_with_limit m, 'geography', ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID::SpecializedString
+    %w[
+      geography
+      geometry
+    ].each do |geo_type|
+      m.register_type geo_type, ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID::SpecializedString.new(geo_type.to_sym)
+    end
   end
 end
 

data/lib/spatial_features/caching.rb

@@ -84,11 +84,13 @@ module SpatialFeatures
     results.each do |id, distance, area|
       klass_record.id = id
       SpatialProximity.create! do |proximity|
+        # Always make the spatial model earliest type and id be model a so we can optimize queries
+        data = [[Utils.base_class(record).to_s, record.id], [Utils.base_class(klass_record).to_s, klass_record.id]]
+        data.sort!
+
         # Set id and type instead of model to avoid autosaving the klass_record
-        proximity.model_a_id = record.id
-        proximity.model_a_type = Utils.base_class(record)
-        proximity.model_b_id = klass_record.id
-        proximity.model_b_type = Utils.base_class(klass_record)
+        proximity.model_a_type, proximity.model_a_id = data.first
+        proximity.model_b_type, proximity.model_b_id = data.second
         proximity.distance_in_meters = distance
         proximity.intersection_area_in_square_meters = area
       end

data/lib/spatial_features/download.rb

@@ -4,14 +4,14 @@ module SpatialFeatures
   module Download
     # file can be a url, path, or file, any of which can return be a zipped archive
     def self.open(file)
-      file = Kernel.open(file)
+      file = URI.open(file)
       file = normalize_file(file) if file.is_a?(StringIO)
       return file
     end
 
     # file can be a url, path, or file, any of which can return be a zipped archive
-    def self.open_each(file, unzip: nil, **unzip_options)
-      file = Download.open(file)
+    def self.open_each(path_or_url, unzip: nil, **unzip_options)
+      file = Download.open(path_or_url)
       files = if unzip && Unzip.is_zip?(file)
         find_in_zip(file, find: unzip, **unzip_options)
       else

data/lib/spatial_features/has_spatial_features/feature_import.rb

@@ -41,9 +41,9 @@ module SpatialFeatures
             update_spatial_cache(options.slice(:spatial_cache))
           end
         end
-
-        return true
       end
+
+      return true
     rescue StandardError => e
       if skip_invalid
         Rails.logger.warn "Error updating #{self.class} #{self.id}. #{e.message}"

data/lib/spatial_features/has_spatial_features.rb

@@ -13,14 +13,14 @@ module SpatialFeatures
         has_many :features, lambda { extending FeaturesAssociationExtensions }, :as => :spatial_model, :dependent => :delete_all
         has_one :aggregate_feature, lambda { extending FeaturesAssociationExtensions }, :as => :spatial_model, :dependent => :delete
 
-        scope :with_features, lambda { joins(:features).uniq }
+        scope :with_features, lambda { joins(:features).distinct }
         scope :without_features, lambda { joins("LEFT OUTER JOIN features ON features.spatial_model_type = '#{Utils.base_class(name)}' AND features.spatial_model_id = #{table_name}.id").where("features.id IS NULL") }
         scope :include_bounds, lambda { SQLHelpers.append_select(joins(:aggregate_feature), :north, :east, :south, :west) }
         scope :include_area, lambda { SQLHelpers.append_select(joins(:aggregate_feature), :area) }
 
-        scope :with_spatial_cache, lambda {|klass| joins(:spatial_caches).where(:spatial_caches => { :intersection_model_type =>  Utils.class_name_with_ancestors(klass) }).uniq }
+        scope :with_spatial_cache, lambda {|klass| joins(:spatial_caches).where(:spatial_caches => { :intersection_model_type =>  Utils.class_name_with_ancestors(klass) }).distinct }
         scope :without_spatial_cache, lambda {|klass| joins("LEFT OUTER JOIN #{SpatialCache.table_name} ON #{SpatialCache.table_name}.spatial_model_id = #{table_name}.id AND #{SpatialCache.table_name}.spatial_model_type = '#{Utils.base_class(name)}' and intersection_model_type IN ('#{Utils.class_name_with_ancestors(klass).join("','") }')").where("#{SpatialCache.table_name}.spatial_model_id IS NULL") }
-        scope :with_stale_spatial_cache, lambda { joins(:spatial_caches).where("#{table_name}.features_hash != spatial_caches.features_hash").uniq } if has_spatial_features_hash?
+        scope :with_stale_spatial_cache, lambda { has_spatial_features_hash? ? joins(:spatial_caches).where("#{table_name}.features_hash != spatial_caches.features_hash").distinct : none }
 
         has_many :spatial_caches, :as => :spatial_model, :dependent => :delete_all, :class_name => 'SpatialCache'
         has_many :model_a_spatial_proximities, :as => :model_a, :class_name => 'SpatialProximity', :dependent => :delete_all
@@ -56,7 +56,7 @@ module SpatialFeatures
       within_buffer(other, 0, options)
     end
 
-    def within_buffer(other, buffer_in_meters = 0, **options)
+    def within_buffer(other, buffer_in_meters = 0, options = {})
       return none if other.is_a?(ActiveRecord::Base) && other.new_record?
 
       # Cache only works on single records, not scopes.
@@ -136,10 +136,8 @@ module SpatialFeatures
       other_class = Utils.base_class_of(other)
       self_class = Utils.base_class_of(self)
 
-      joins <<~SQL
-        INNER JOIN spatial_proximities
-        ON (spatial_proximities.model_a_type = '#{self_class}' AND spatial_proximities.model_a_id = #{table_name}.id AND spatial_proximities.model_b_type = '#{other_class}' AND spatial_proximities.model_b_id IN (#{Utils.id_sql(other)}))
-        OR (spatial_proximities.model_b_type = '#{self_class}' AND spatial_proximities.model_b_id = #{table_name}.id AND spatial_proximities.model_a_type = '#{other_class}' AND spatial_proximities.model_a_id IN (#{Utils.id_sql(other)}))
+      joins "INNER JOIN spatial_proximities ON " + SpatialProximity.condition_sql(self, other, <<~SQL.squish)
+        (spatial_proximities.model_a_type = '#{self_class}' AND spatial_proximities.model_a_id = #{table_name}.id AND spatial_proximities.model_b_type = '#{other_class}' AND spatial_proximities.model_b_id IN (#{Utils.id_sql(other)}))
       SQL
     end
 
@@ -228,9 +226,12 @@ module SpatialFeatures
     end
 
     def total_intersection_area_percentage(klass)
-      return 0.0 unless features_area_in_square_meters > 0
+      total_area = features_area_in_square_meters
 
-      ((total_intersection_area_in_square_meters(klass) / features_area_in_square_meters) * 100).round(1)
+      return if total_area.nil?
+      return 0.0 if total_area.zero?
+
+      ((total_intersection_area_in_square_meters(klass) / total_area) * 100).round(1)
     end
 
     def features_area_in_square_meters

data/lib/spatial_features/importers/file.rb

@@ -21,7 +21,7 @@ module SpatialFeatures
       # processed.
       #
       # If no `current_file` is passed then we just take the first valid file that we find.
-      def initialize(data, *args, current_file: nil, **options)
+      def initialize(data, current_file: nil, **options)
         begin
           current_file ||= Download.open_each(data, unzip: FILE_PATTERNS, downcase: true, tmpdir: options[:tmpdir]).first
         rescue Unzip::PathNotFound
@@ -30,11 +30,11 @@ module SpatialFeatures
 
         case ::File.extname(current_file.path.downcase)
         when '.kml'
-          __setobj__(KMLFile.new(current_file, *args, **options))
+          __setobj__(KMLFile.new(current_file, **options))
         when '.shp'
-          __setobj__(Shapefile.new(current_file, *args, **options))
+          __setobj__(Shapefile.new(current_file, **options))
         when '.json', '.geojson'
-          __setobj__(ESRIGeoJSON.new(current_file.path, *args, **options))
+          __setobj__(ESRIGeoJSON.new(current_file.path, **options))
         else
           raise ImportError, "Could not import file. " + SUPPORTED_FORMATS
         end

data/lib/spatial_features/importers/geomark.rb

@@ -1,8 +1,8 @@
 module SpatialFeatures
   module Importers
     class Geomark < KMLFile
-      def initialize(geomark, *args)
-        super geomark_url(geomark), *args
+      def initialize(geomark, **options)
+        super geomark_url(geomark), **options
       end
 
       private

data/lib/spatial_features/importers/kml.rb

@@ -6,16 +6,16 @@ module SpatialFeatures
       # <SimpleData name> keys that may contain <img> tags
       IMAGE_METADATA_KEYS = %w[pdfmaps_photos].freeze
 
-      def initialize(data, base_dir: nil, **args)
+      def initialize(data, base_dir: nil, **options)
         @base_dir = base_dir
-        super data, **args
+        super data, **options
       end
 
       private
 
       def each_record(&block)
         {'Polygon' => 'POLYGON', 'LineString' => 'LINE', 'Point' => 'POINT'}.each do |kml_type, sql_type|
-          Nokogiri::XML(@data).css(kml_type).each do |feature|
+          kml_document.css(kml_type).each do |feature|
             if placemark = feature.ancestors('Placemark').first
               name = placemark.css('name').text
               metadata = extract_metadata(placemark)
@@ -35,6 +35,15 @@ module SpatialFeatures
         end
       end
 
+      def kml_document
+        @kml_document ||= begin
+          doc = Nokogiri::XML(@data)
+          raise ImportError, "Invalid KML document (root node was '#{doc.root&.name}')" unless doc.root&.name.to_s.casecmp?('kml')
+          raise ImportError, "NetworkLink elements are not supported" unless doc.search('NetworkLink').empty?
+          doc
+        end
+      end
+
       def blank_feature?(feature)
         feature.css('coordinates').text.blank?
       end

data/lib/spatial_features/importers/kml_file_arcgis.rb

@@ -3,7 +3,7 @@ require 'ostruct'
 module SpatialFeatures
   module Importers
     class KMLFileArcGIS < KMLFile
-      def initialize(data, *args)
+      def initialize(data, **options)
         super
 
       rescue SocketError, Errno::ECONNREFUSED

data/lib/spatial_features/importers/shapefile.rb

@@ -6,7 +6,7 @@ module SpatialFeatures
     class Shapefile < Base
       class_attribute :default_proj4_projection
 
-      def initialize(data, *args, proj4: nil, **options)
+      def initialize(data, proj4: nil, **options)
         super(data, **options)
         @proj4 = proj4
       end

data/lib/spatial_features/venn_polygons.rb

@@ -56,7 +56,7 @@ module SpatialFeatures
     # Instantiate objects to hold the kml and records for each venn polygon
     polygons.group_by{|row| row['kml']}.collect do |kml, rows|
       # Uniq on row id in case a single record had self intersecting multi geometry, which would cause it to appear duplicated on a single venn polygon
-      records = rows.uniq{|row| row.values_at('id', 'type') }.collect{|row| eager_load_hash.fetch(row['type']).detect{|record| record.id == row['id'].to_i } }
+      records = rows.uniq {|row| row.values_at('id', 'type') }.collect{|row| eager_load_hash.fetch(row['type']).detect{|record| record.id == row['id'].to_i } }
       OpenStruct.new(:kml => kml, :records => records)
     end
   end

data/lib/spatial_features/version.rb

@@ -1,3 +1,3 @@
 module SpatialFeatures
-  VERSION = "3.0.2"
+  VERSION = "3.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spatial_features
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.2.0
 platform: ruby
 authors:
 - Ryan Wallace
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2023-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,20 +17,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: delayed_job_active_record
   requirement: !ruby/object:Gem::Requirement
@@ -91,16 +91,16 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +129,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Adds spatial methods to a model.
 email:
 - contact@culturecode.ca
@@ -189,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.23
 signing_key: 
 specification_version: 4
 summary: Adds spatial methods to a model.