spatial_features 2.1.7 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86ef03aa25c8f1b883c2dfc313ca200eb26f22b0
-  data.tar.gz: 25b5c3887d7b9cf1cb560d7b0baf38cc4fdd6f73
+  metadata.gz: 1def32770d636b7b99b5922ad45b94476ee8297b
+  data.tar.gz: ee9cde1574fbb7b24011ddc0a92c97ae12843214
 SHA512:
-  metadata.gz: c437c6f85a9bf15ecd88637d09a348a92498a9e450a4885731e4daedff1c04fbcd626a9ffd4e6ac1430da612b794fc4b8f5ecff62a7c1039c295bab8f39ddbf7
-  data.tar.gz: 503b88e79c31b67c0069b5cb1346b26879f782227234e82e4bdcfc0b080ea920418767a333b6a1f5b9d30f43375bf3e5a666e0c2915505d8fbf38097e486839e
+  metadata.gz: dd2474c0f6c3b0d4d888f9c3e1357072c71db5c5c610d0cbf56a4721879acc421a5ffa934f2fa4c471903c63bade65f5e41321f58c3404114e5b624e3b672e6a
+  data.tar.gz: aeb3d1fdd3bec3caebaf74067c059d8303cefb7d77d51bd08e4bb3078a8ef9628f7ba3b32d7e573217298a974a5e3f23c583d4231813922aeb1ae335986b632b

data/README.md

@@ -2,52 +2,66 @@
 
 Adds spatial methods to a model.
 
-## Migration
-```ruby
-execute("
-  CREATE TABLE features (
-      id integer NOT NULL,
-      spatial_model_type character varying(255),
-      spatial_model_id integer,
-      name character varying(255),
-      feature_type character varying(255),
-      geog geography,
-      geom geometry(Geometry,3005),
-      geom_lowres geometry(Geometry,3005),
-      kml text,
-      kml_lowres text,
-      metadata hstore,
-      area double precision,
-      north numeric(9,6),
-      east numeric(9,6),
-      south numeric(9,6),
-      west numeric(9,6),
-      centroid geography,
-      kml_centroid text
-  );
-
-  CREATE TABLE spatial_caches (
-      id integer NOT NULL,
-      intersection_model_type character varying(255),
-      spatial_model_type character varying(255),
-      spatial_model_id integer,
-      created_at timestamp without time zone,
-      updated_at timestamp without time zone,
-      intersection_cache_distance double precision,
-      features_hash character varying(255)
-  );
-
-  CREATE TABLE spatial_proximities (
-      id integer NOT NULL,
-      model_a_type character varying(255),
-      model_a_id integer,
-      model_b_type character varying(255),
-      model_b_id integer,
-      distance_in_meters double precision,
-      intersection_area_in_square_meters double precision
-  );
-")
-```
+## Installation
+
+1. Install libraries
+  - PostGIS
+  - libgeos and gdal (optional libraries required for Shapefile import)
+
+    ```bash
+    # Ubuntu Installation instructions. Source: https://github.com/rgeo/rgeo/issues/26#issuecomment-106059741
+    sudo apt-get -y install libgeos-3.4.2 libgeos-dev libproj0 libproj-dev gdal-bin
+    sudo ln -s /usr/lib/libgeos-3.4.2.so /usr/lib/libgeos.so
+    sudo ln -s /usr/lib/libgeos-3.4.2.so /usr/lib/libgeos.so.1
+    ```
+
+2. Create spatial tables
+
+  ```ruby
+  execute("
+    CREATE TABLE features (
+        id integer NOT NULL,
+        spatial_model_type character varying(255),
+        spatial_model_id integer,
+        name character varying(255),
+        feature_type character varying(255),
+        geog geography,
+        geom geometry(Geometry,3005),
+        geom_lowres geometry(Geometry,3005),
+        kml text,
+        kml_lowres text,
+        metadata hstore,
+        area double precision,
+        north numeric(9,6),
+        east numeric(9,6),
+        south numeric(9,6),
+        west numeric(9,6),
+        centroid geography,
+        kml_centroid text
+    );
+
+    CREATE TABLE spatial_caches (
+        id integer NOT NULL,
+        intersection_model_type character varying(255),
+        spatial_model_type character varying(255),
+        spatial_model_id integer,
+        created_at timestamp without time zone,
+        updated_at timestamp without time zone,
+        intersection_cache_distance double precision,
+        features_hash character varying(255)
+    );
+
+    CREATE TABLE spatial_proximities (
+        id integer NOT NULL,
+        model_a_type character varying(255),
+        model_a_id integer,
+        model_b_type character varying(255),
+        model_b_id integer,
+        distance_in_meters double precision,
+        intersection_area_in_square_meters double precision
+    );
+  ")
+  ```
 
 ## Usage
 

data/app/models/feature.rb

@@ -48,8 +48,8 @@ class Feature < ActiveRecord::Base
     join_other_features(other).where('ST_Intersects(features.geom_lowres, other_features.geom_lowres)').uniq
   end
 
-  def self.invalid
-    select('features.*, ST_IsValidReason(geog::geometry) AS invalid_geometry_message').where.not('ST_IsValid(geog::geometry)')
+  def self.invalid(column = 'geog::geometry')
+    select("features.*, ST_IsValidReason(#{column}) AS invalid_geometry_message").where.not("ST_IsValid(#{column})")
   end
 
   def self.valid
@@ -78,6 +78,10 @@ class Feature < ActiveRecord::Base
       centroid     = ST_PointOnSurface(geog::geometry)
     SQL
 
+    invalid('geom').update_all <<-SQL
+      geom = ST_Buffer(geom, 0)
+    SQL
+
     update_all <<-SQL.squish
       geom_lowres  = ST_SimplifyPreserveTopology(geom, #{options[:lowres_simplification]})
     SQL
@@ -118,8 +122,9 @@ class Feature < ActiveRecord::Base
     self.geog = ActiveRecord::Base.connection.select_value("SELECT ST_Force2D('#{geog}')")
   end
 
+  SRID_CACHE = {}
   def self.detect_srid(column_name)
-    connection.select_value("SELECT Find_SRID('public', '#{table_name}', '#{column_name}')")
+    SRID_CACHE[column_name] ||= connection.select_value("SELECT Find_SRID('public', '#{table_name}', '#{column_name}')")
   end
 
   def self.join_other_features(other)

data/lib/spatial_features/has_spatial_features.rb

@@ -2,13 +2,13 @@ module SpatialFeatures
   module ActMethod
     def has_spatial_features(options = {})
       unless acts_like?(:spatial_features)
+        class_attribute :spatial_features_options
+        self.spatial_features_options = {:make_valid => true}
+
         extend ClassMethods
         include InstanceMethods
         include DelayedFeatureImport
 
-        class_attribute :spatial_features_options
-        self.spatial_features_options = {:make_valid => true}
-
         has_many :features, lambda { extending FeaturesAssociationExtensions }, :as => :spatial_model, :dependent => :delete_all
 
         scope :with_features, lambda { joins(:features).uniq }
@@ -60,13 +60,6 @@ module SpatialFeatures
       end
     end
 
-    def covering(other)
-      scope = joins_features_for(other).select("#{table_name}.*").group("#{table_name}.#{primary_key}")
-      scope = scope.where('ST_Covers(features.geom, features_for_other.geom)')
-
-      return scope
-    end
-
     def polygons
       features.polygons
     end
@@ -87,18 +80,6 @@ module SpatialFeatures
       end
     end
 
-    # Returns a scope that includes the features for this record as the table_alias and the features for other as #{table_alias}_other
-    # Can be used to perform spatial calculations on the relationship between the two sets of features
-    def joins_features_for(other, table_alias = 'features_for')
-      joins(:features).joins(%Q(INNER JOIN (#{other_features_union(other).to_sql}) AS "#{table_alias}_other" ON true))
-    end
-
-    def other_features_union(other)
-      scope = Feature.select('ST_Union(geom) AS geom').where(:spatial_model_type => class_for(other))
-      scope = scope.where(:spatial_model_id => other) unless class_for(other) == other
-      return scope
-    end
-
     # Returns true if the model stores a hash of the features so we don't need to process the features if they haven't changed
     def has_spatial_features_hash?
       column_names.include? 'features_hash'
@@ -126,10 +107,20 @@ module SpatialFeatures
       return scope
     end
 
+    def cached_spatial_join(other)
+      other_class = class_for(other)
+
+      raise "Cannot use cached spatial join for the same class" if self == other_class
+
+      other_column = other_class.name < self.name ? :model_a : :model_b
+      self_column = other_column == :model_a ? :model_b : :model_a
+
+      joins("INNER JOIN spatial_proximities ON spatial_proximities.#{self_column}_type = '#{self}' AND spatial_proximities.#{self_column}_id = #{table_name}.id AND spatial_proximities.#{other_column}_type = '#{other_class}' AND spatial_proximities.#{other_column}_id IN (#{ids_sql_for(other)})")
+    end
+
     def uncached_within_buffer_scope(other, buffer_in_meters, options)
-      scope = joins_features_for(other).select("#{table_name}.*")
-      scope = scope.where('ST_Intersects(features.geom, features_for_other.geom)') if buffer_in_meters == 0 # Optimize the 0 buffer case, ST_DWithin was slower in testing
-      scope = scope.where('ST_DWithin(features.geom, features_for_other.geom, ?)', buffer_in_meters) if buffer_in_meters.to_f > 0
+      scope = spatial_join(other, buffer_in_meters)
+      scope = scope.select("#{table_name}.*")
 
       # Ensure records with multiple features don't appear multiple times
       if options[:distance] || options[:intersection_area]
@@ -138,20 +129,28 @@ module SpatialFeatures
         scope = scope.distinct
       end
 
-      scope = scope.select("MIN(ST_Distance(features.geom, features_for_other.geom)) AS distance_in_meters") if options[:distance]
-      scope = scope.select("ST_Area(ST_UNION(ST_Intersection(features.geom, features_for_other.geom))) AS intersection_area_in_square_meters") if options[:intersection_area]
+      scope = scope.select("MIN(ST_Distance(features.geom, other_features.geom)) AS distance_in_meters") if options[:distance]
+      scope = scope.select("ST_Area(ST_UNION(ST_Intersection(features.geom, other_features.geom))) AS intersection_area_in_square_meters") if options[:intersection_area]
       return scope
     end
 
-    def cached_spatial_join(other)
-      other_class = class_for(other)
+    # Returns a scope that includes the features for this record as the table_alias and the features for other as other_alias
+    # Performs a spatial intersection between the two sets of features, within the buffer distance given in meters
+    def spatial_join(other, buffer = 0, table_alias = 'features', other_alias = 'other_features', geom = 'geom_lowres')
+      scope = features_scope(self).select("#{geom} AS geom").select(:spatial_model_id)
 
-      raise "Cannot use cached spatial join for the same class" if self == other_class
+      other_scope = features_scope(other)
+      other_scope = other_scope.select("ST_Union(#{geom}) AS geom").select("ST_Buffer(ST_Union(#{geom}), #{buffer.to_i}) AS buffered_geom")
 
-      other_column = other_class.name < self.name ? :model_a : :model_b
-      self_column = other_column == :model_a ? :model_b : :model_a
+      return joins(%Q(INNER JOIN (#{scope.to_sql}) AS #{table_alias} ON #{table_alias}.spatial_model_id = #{table_name}.id))
+            .joins(%Q(INNER JOIN (#{other_scope.to_sql}) AS #{other_alias} ON ST_Intersects(#{table_alias}.geom, #{other_alias}.buffered_geom)))
+    end
 
-      joins("INNER JOIN spatial_proximities ON spatial_proximities.#{self_column}_type = '#{self}' AND spatial_proximities.#{self_column}_id = #{table_name}.id AND spatial_proximities.#{other_column}_type = '#{other_class}' AND spatial_proximities.#{other_column}_id IN (#{ids_sql_for(other)})")
+    def features_scope(other)
+      scope = Feature
+      scope = scope.where(:spatial_model_type => class_for(other))
+      scope = scope.where(:spatial_model_id => other) unless class_for(other) == other
+      return scope
     end
 
     # Returns the class for the given, class, scope, or record
@@ -201,10 +200,6 @@ module SpatialFeatures
       features.present?
     end
 
-    def covers?(other)
-      self.class.covering(other).exists?(self)
-    end
-
     def intersects?(other)
       self.class.intersecting(other).exists?(self)
     end

data/lib/spatial_features/has_spatial_features/feature_import.rb

@@ -7,10 +7,11 @@ module SpatialFeatures
     included do
       extend ActiveModel::Callbacks
       define_model_callbacks :update_features
+      spatial_features_options.reverse_merge!(:import => {})
     end
 
     def update_features!(skip_invalid: false, options: {})
-      options = options.reverse_merge(spatial_features_options).reverse_merge(:import => {})
+      options = options.reverse_merge(spatial_features_options)
 
       ActiveRecord::Base.transaction do
         imports = spatial_feature_imports(options[:import], options[:make_valid])
@@ -32,10 +33,14 @@ module SpatialFeatures
     def spatial_feature_imports(import_options, make_valid)
       import_options.collect do |data_method, importer_name|
         data = send(data_method)
-        "SpatialFeatures::Importers::#{importer_name}".constantize.new(data, :make_valid => make_valid) if data.present?
+        spatial_importer_from_name(importer_name).new(data, :make_valid => make_valid) if data.present?
       end.compact
     end
 
+    def spatial_importer_from_name(importer_name)
+      "SpatialFeatures::Importers::#{importer_name}".constantize
+    end
+
     def import_features(imports, skip_invalid)
       self.features.delete_all
       valid, invalid = imports.flat_map(&:features).partition do |feature|

data/lib/spatial_features/importers/shapefile.rb

@@ -21,7 +21,8 @@ module SpatialFeatures
       end
 
       def proj4_from_file(file)
-        `gdalsrsinfo "#{file.path}" -o proj4`[/'(.+)'/,1] # Sanitize "'+proj=utm +zone=11 +datum=NAD83 +units=m +no_defs '\n"
+        # Sanitize "'+proj=utm +zone=11 +datum=NAD83 +units=m +no_defs '\n"
+        `gdalsrsinfo "#{file.path}" -o proj4`[/'(.+)'/,1].presence || raise('Could not determine shapefile projection. Check that `gdalsrsinfo` is installed.')
       end
 
       def data_from_wkt(wkt, proj4)

data/lib/spatial_features/version.rb

@@ -1,3 +1,3 @@
 module SpatialFeatures
-  VERSION = "2.1.7"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spatial_features
 version: !ruby/object:Gem::Version
-  version: 2.1.7
+  version: 2.2.0
 platform: ruby
 authors:
 - Ryan Wallace
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2016-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails