spatial_features 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ba1ab9dfa18160f48292f26a63f75031187e44cc04aff73dba792832d482063
-  data.tar.gz: b25d8a6f4bd0412c3d2d9dd34a57c620a0593979304ddb9061c7f3b3e2d7f834
+  metadata.gz: 60a558353e17d6facde9b9dccccb43022f3c46af98401bf6ad4ceccee6a62b65
+  data.tar.gz: f2bfcad2b407e9b9329d79650fa3098260524b083b7031caeaa323012fb2fa60
 SHA512:
-  metadata.gz: 1be4b279b3341582262bdb8d802c0786b1eb3607cef070f2a03813b2bc987d21fb0aa92323d7b49dbec01aa8b2e128f0b9982ce356dc4836875ccd5ad89f7092
-  data.tar.gz: 8e70dfe6f6bad6545c29fc5dbf1406b308b9cb44ff48ebfc849469912af6cf30640c829c2baf363a6790e9207f78d3c039276c002a50ce6319ccf0d9450f9df7
+  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/config/initializers/mime_types.rb

@@ -3,7 +3,3 @@ Mime::Type.register "application/vnd.bounds+json", :bounds
 Mime::Type.register "application/vnd.mapbox-vector-tile", :mvt
 Mime::Type.register "application/vnd.google-earth.kml+xml", :kml
 Mime::Type.register "application/vnd.google-earth.kmz", :kmz
-Mime::Type.register "application/zip", :zip
-Mime::Type.register "application/zip", :piz
-Mime::Type.register "application/zip", :zap
-Mime::Type.register "application/zip", :shpz

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, allow_blank: false, **options)
+      def update_features!(**options)
         find_each do |record|
-          record.update_features!(skip_invalid: skip_invalid, allow_blank: allow_blank, **options)
+          record.update_features!(**options)
         end
       end
     end
 
-    def update_features!(skip_invalid: false, allow_blank: 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,7 +28,7 @@ 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
           features = import_features(imports, skip_invalid)

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

data/lib/spatial_features/importers/file.rb

@@ -3,23 +3,16 @@ require 'open-uri'
 module SpatialFeatures
   module Importers
     class File < SimpleDelegator
-      SUPPORTED_SPATIAL_FORMATS = %w(application/zip application/x-shp+zip application/vnd.google-earth.kml+xml application/vnd.google-earth.kmz application/vnd.geo+json).freeze
-      SUPPORTED_SPATIAL_FILE_EXTENSIONS = %w(.zip .zap .piz .shpz .kml .kmz .json .geojson).freeze
+      INVALID_ARCHIVE = "Archive did not contain a .kml, .shp, .json, or .geojson file.".freeze
       SUPPORTED_FORMATS = "Supported formats are KMZ, KML, zipped ArcGIS shapefiles, ESRI JSON, and GeoJSON.".freeze
 
-      def self.invalid_archive!(filename)
-        filename = ::File.basename(filename.to_s)
-        raise ImportError, "#{filename} did not contain a spatial file. #{SUPPORTED_FORMATS}"
-      end
-      delegate :invalid_archive!, :to => :class
-
       FILE_PATTERNS = [/\.kml$/, /\.shp$/, /\.json$/, /\.geojson$/]
       def self.create_all(data, **options)
         Download.open_each(data, unzip: FILE_PATTERNS, downcase: true, tmpdir: options[:tmpdir]).map do |file|
           new(data, **options, current_file: file)
         end
       rescue Unzip::PathNotFound
-        invalid_archive!(data)
+        raise ImportError, INVALID_ARCHIVE + " " + SUPPORTED_FORMATS
       end
 
       # The File importer may be initialized multiple times by `::create_all` if it
@@ -30,30 +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
-          invalid_archive!(data)
+          raise ImportError, INVALID_ARCHIVE
         end
 
-        filename = 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
-          import_error!(filename)
+          import_error
         end
       end
 
       private
 
-      def import_error!(filename)
+      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/shapefile.rb

@@ -20,7 +20,7 @@ module SpatialFeatures
           new(file, **options)
         end
       rescue Unzip::PathNotFound
-        invalid_archive!(data)
+        raise ImportError, INVALID_ARCHIVE
       end
 
       private

data/lib/spatial_features/version.rb

@@ -1,3 +1,3 @@
 module SpatialFeatures
-  VERSION = "3.3.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.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Ryan Wallace
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-13 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails