spatial_features 3.2.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fabdd3f0f73eb21327f8e3deb1b7dda5969d97bdb7c053c60199a63fe5cd04b1
-  data.tar.gz: 777c5dc188ba968ab4cba25e58fa2f361c9d3814781ecfb9e751cf0fc1b40b0e
+  metadata.gz: 60a558353e17d6facde9b9dccccb43022f3c46af98401bf6ad4ceccee6a62b65
+  data.tar.gz: f2bfcad2b407e9b9329d79650fa3098260524b083b7031caeaa323012fb2fa60
 SHA512:
-  metadata.gz: e3f28e99e814f1fcc2ba49edf8a59ff957b9f92c9e0d990f93409c61f00d4c496e7ac5f60eb3616660df720c615033f62dbe02d707c1584cc4cee7d9cb88067c
-  data.tar.gz: 18e776f2d1bc792e7a0313d5742345e93adca24f060472bb10a36611eb3e62cf7fe8fcf2d7d520db16cd9b1755e85b4e40e75cabcb4110e25c397e42087fd9e0
+  metadata.gz: 065fa148ffcdd4e221f9aa117117302aa51d805e3b5d0b984d76bae81cd163681a428dec37adf9c51e993065ac93c88c75487545ac353b309ff321b3934a3b62
+  data.tar.gz: 0ffb13eae72eacdc0a96ec06da6e1e4ee1ffd304f36f80f72fdadebb54269ed8e208b66279c3325217729b36d14727fef03246a989ab5172625fdd3f5694e7fb

data/README.md

@@ -31,6 +31,7 @@ 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,
@@ -49,6 +50,7 @@ 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 (
@@ -188,6 +190,16 @@ queries can be optimized. Migrate existing SpatialProximity rows to this new sch
 SpatialProximity.normalize
 ```
 
+## Upgrading From 3.2/3.3 to 3.4
+Features now record the source they were imported from in the new `source_identifier` column. This column is indexed and
+can be used filter features by source.
+
+```ruby
+add_column :features, :source_identifier, :string
+add_index :features, :source_identifier
+MyModel.update_features!(:force => true) # Force an `update_features!` will populate the source_identifier column.
+```
+
 ## Testing
 
 Create a postgres database:

data/app/models/abstract_feature.rb

@@ -49,8 +49,14 @@ class AbstractFeature < ActiveRecord::Base
     where(:feature_type => 'point')
   end
 
-  def self.within_distance_of_point(lat, lng, distance_in_meters)
-    where("ST_DWithin(features.geog, ST_Point(:lng, :lat), :distance)", :lat => lat, :lng => lng, :distance => distance_in_meters)
+  def self.within_distance_of_point(lat, lng, distance_in_meters, geom = 'geom_lowres')
+    point_sql =
+      case geom.to_s
+      when 'geog' then 'ST_Point(:lng, :lat)'
+      else "ST_Transform(ST_SetSRID(ST_Point(:lng, :lat), 4326), #{detect_srid(geom)})"
+      end
+
+    where("ST_DWithin(features.#{geom}, #{point_sql}, :distance)", :lat => lat, :lng => lng, :distance => distance_in_meters)
   end
 
   def self.area_in_square_meters(geom = 'geom_lowres')
@@ -248,7 +254,7 @@ class AbstractFeature < ActiveRecord::Base
     self.geog = SpatialFeatures::Utils.select_db_value("SELECT ST_Force2D('#{geog}')")
   end
 
-  SRID_CACHE = {}
+  SRID_CACHE = HashWithIndifferentAccess.new
   def self.detect_srid(column_name)
     SRID_CACHE[column_name] ||= SpatialFeatures::Utils.select_db_value("SELECT Find_SRID('public', '#{table_name}', '#{column_name}')")
   end

data/lib/spatial_features/has_spatial_features/feature_import.rb

@@ -13,14 +13,14 @@ module SpatialFeatures
     end
 
     module ClassMethods
-      def update_features!(skip_invalid: false, **options)
+      def update_features!(**options)
         find_each do |record|
-          record.update_features!(skip_invalid: skip_invalid, **options)
+          record.update_features!(**options)
         end
       end
     end
 
-    def update_features!(skip_invalid: false, **options)
+    def update_features!(skip_invalid: false, allow_blank: false, force: false, **options)
       options = options.reverse_merge(spatial_features_options)
       tmpdir = options.fetch(:tmpdir) { Dir.mktmpdir("ruby_spatial_features") }
 
@@ -28,10 +28,10 @@ module SpatialFeatures
         imports = spatial_feature_imports(options[:import], options[:make_valid], options[:tmpdir])
         cache_key = Digest::MD5.hexdigest(imports.collect(&:cache_key).join)
 
-        return if features_cache_key_matches?(cache_key)
+        return if !force && features_cache_key_matches?(cache_key)
 
         run_callbacks :update_features do
-          import_features(imports, skip_invalid)
+          features = import_features(imports, skip_invalid)
           update_features_cache_key(cache_key)
           update_features_area
 
@@ -40,11 +40,17 @@ module SpatialFeatures
           else
             update_spatial_cache(options.slice(:spatial_cache))
           end
+
+          if imports.present? && features.compact_blank.empty? && !allow_blank
+            raise EmptyImportError, "No spatial features were found when updating"
+          end
         end
       end
 
       return true
     rescue StandardError => e
+      raise e if e.is_a?(EmptyImportError)
+
       if skip_invalid
         Rails.logger.warn "Error updating #{self.class} #{self.id}. #{e.message}"
         return nil
@@ -137,7 +143,7 @@ module SpatialFeatures
         raise ImportError, "Error updating #{self.class} #{self.id}. #{errors.to_sentence}"
       end
 
-      return features
+      valid
     end
 
     def features_cache_key_matches?(cache_key)

data/lib/spatial_features/has_spatial_features.rb

@@ -235,14 +235,10 @@ module SpatialFeatures
     end
 
     def features_area_in_square_meters
-      @features_area_in_square_meters ||=
-        if has_attribute?(:area)
-          area
-        elsif association(:aggregate_feature).loaded?
-          aggregate_feature&.area
-        else
-          aggregate_features.pluck(:area).first
-        end
+      @features_area_in_square_meters ||= area if has_attribute?(:area) # Calculated area column
+      @features_area_in_square_meters ||= features_area if has_attribute?(:features_area) # Cached area column
+      @features_area_in_square_meters ||= aggregate_feature&.area if association(:aggregate_feature).loaded?
+      @features_area_in_square_meters ||= aggregate_features.pluck(:area).first
     end
 
     def total_intersection_area_in_square_meters(other)

data/lib/spatial_features/importers/base.rb

@@ -4,12 +4,14 @@ module SpatialFeatures
   module Importers
     class Base
       attr_reader :errors
+      attr_accessor :source_identifier # An identifier for the source of the features. Used to differentiate groups of features on the spatial model.
 
-      def initialize(data, make_valid: false, tmpdir: nil)
+      def initialize(data, make_valid: false, tmpdir: nil, source_identifier: nil)
         @make_valid = make_valid
         @data = data
         @errors = []
         @tmpdir = tmpdir
+        @source_identifier = source_identifier
       end
 
       def features
@@ -48,7 +50,15 @@ module SpatialFeatures
 
       def build_feature(record)
         importable_image_paths = record.importable_image_paths if record.respond_to?(:importable_image_paths)
-        Feature.new(:name => record.name, :metadata => record.metadata, :feature_type => record.feature_type, :geog => record.geog, :importable_image_paths => importable_image_paths, :make_valid => @make_valid)
+        Feature.new do |feature|
+          feature.name = record.name
+          feature.metadata = record.metadata
+          feature.feature_type = record.feature_type
+          feature.geog = record.geog
+          feature.importable_image_paths = importable_image_paths
+          feature.make_valid = @make_valid
+          feature.source_identifier = source_identifier
+        end
       end
     end
   end
@@ -56,4 +66,5 @@ module SpatialFeatures
   # EXCEPTIONS
 
   class ImportError < StandardError; end
+  class EmptyImportError < ImportError; end
 end

data/lib/spatial_features/importers/file.rb

@@ -23,22 +23,39 @@ module SpatialFeatures
       # If no `current_file` is passed then we just take the first valid file that we find.
       def initialize(data, current_file: nil, **options)
         begin
-          current_file ||= Download.open_each(data, unzip: FILE_PATTERNS, downcase: true, tmpdir: options[:tmpdir]).first
+          @current_file = current_file || Download.open_each(data, unzip: FILE_PATTERNS, downcase: true, tmpdir: options[:tmpdir]).first
         rescue Unzip::PathNotFound
           raise ImportError, INVALID_ARCHIVE
         end
 
-        case ::File.extname(current_file.path.downcase)
+        case ::File.extname(data).downcase
+        when '.kmz' # KMZ always has a single kml in it, so no need to show mention it
+          options[:source_identifier] = ::File.basename(data)
+        else
+          options[:source_identifier] = [::File.basename(data), ::File.basename(@current_file.path)].uniq.join('/')
+        end
+
+        case ::File.extname(filename)
         when '.kml'
-          __setobj__(KMLFile.new(current_file, **options))
+          __setobj__(KMLFile.new(@current_file, **options))
         when '.shp'
-          __setobj__(Shapefile.new(current_file, **options))
+          __setobj__(Shapefile.new(@current_file, **options))
         when '.json', '.geojson'
-          __setobj__(ESRIGeoJSON.new(current_file.path, **options))
+          __setobj__(ESRIGeoJSON.new(@current_file.path, **options))
         else
-          raise ImportError, "Could not import file. " + SUPPORTED_FORMATS
+          import_error
         end
       end
+
+      private
+
+      def import_error!
+        raise ImportError, "Could not import #{filename}. " + SUPPORTED_FORMATS
+      end
+
+      def filename
+        @filename ||= @current_file.path.downcase
+      end
     end
   end
 end

data/lib/spatial_features/importers/kml.rb

@@ -6,6 +6,12 @@ module SpatialFeatures
       # <SimpleData name> keys that may contain <img> tags
       IMAGE_METADATA_KEYS = %w[pdfmaps_photos].freeze
 
+      # matches a coordinate pair with an optional altitude, including invalid altitudes like NaN
+      #   -118.1,50.9,NaN
+      #   -118.1,50.9,0
+      #   -118.1,50.9
+      COORDINATES_WITH_ALTITUDE = /((-?\d+\.\d+,-?\d+\.\d+)(,-?[a-zA-Z\d\.]+))/.freeze
+
       def initialize(data, base_dir: nil, **options)
         @base_dir = base_dir
         super data, **options
@@ -52,6 +58,8 @@ module SpatialFeatures
         geom = nil
         conn = nil
 
+        strip_altitude(kml)
+
         # Do query in a new thread so we use a new connection (if the query fails it will poison the transaction of the current connection)
         #
         # We manually checkout a new connection since Rails re-uses DB connections across threads.
@@ -106,6 +114,13 @@ module SpatialFeatures
         end
         return metadata
       end
+
+      def strip_altitude(kml)
+        kml.css('coordinates').each do |coordinates|
+          next unless COORDINATES_WITH_ALTITUDE.match?(coordinates.content)
+          coordinates.content = coordinates.content.gsub(COORDINATES_WITH_ALTITUDE, '\2')
+        end
+      end
     end
   end
 end

data/lib/spatial_features/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spatial_features
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Ryan Wallace
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-12 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails