Module: SpatialFeatures::InstanceMethods

Defined in:
lib/spatial_features/has_spatial_features.rb

Instance Method Summary collapse

Instance Method Details

#acts_like_spatial_features? ⇒ Boolean

Returns:

  • (Boolean) 


186
187
188
 
# File 'lib/spatial_features/has_spatial_features.rb', line 186

def acts_like_spatial_features?
  true
end

#aggregate_features ⇒ Object

Scope to perform SQL-only calculations on a record’s aggregate feature. This avoids loading the large data payload if all that is needed is metadata



266
267
268
 
# File 'lib/spatial_features/has_spatial_features.rb', line 266

def aggregate_features
  self.class.where(id: id).aggregate_features
end

#bounds ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/spatial_features/has_spatial_features.rb', line 218

def bounds
  @bounds ||=
    if has_attribute?(:north) && has_attribute?(:east) && has_attribute?(:south) && has_attribute?(:west)
      slice(:north, :east, :south, :west).with_indifferent_access.transform_values!(&:to_f)
    elsif association(:aggregate_feature).loaded?
      # Aggregate features can be very large and take a while to load. Avoid loading one just to load the bounds.
      aggregate_feature&.bounds
    else
      aggregate_features.bounds
    end
end

#features? ⇒ Boolean

Returns:

  • (Boolean) 


206
207
208
209
210
211
212
 
# File 'lib/spatial_features/has_spatial_features.rb', line 206

def features?
  if features.loaded?
    features.present?
  else
    features.exists?
  end
end

#features_area_in_square_meters ⇒ Object 



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/spatial_features/has_spatial_features.rb', line 236

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
end

#features_cache_key ⇒ Object 



190
191
192
 
# File 'lib/spatial_features/has_spatial_features.rb', line 190

def features_cache_key
  "#{self.class.name}/#{id}-#{has_spatial_features_hash? ? features_hash : (aggregate_feature || features).cache_key}"
end

#intersects?(other) ⇒ Boolean

Returns:

  • (Boolean) 


214
215
216
 
# File 'lib/spatial_features/has_spatial_features.rb', line 214

def intersects?(other)
  self.class.unscoped { self.class.intersecting(other).exists?(id) }
end

#lines? ⇒ Boolean

Returns:

  • (Boolean) 


198
199
200
 
# File 'lib/spatial_features/has_spatial_features.rb', line 198

def lines?
  !features.lines.empty?
end

#points? ⇒ Boolean

Returns:

  • (Boolean) 


202
203
204
 
# File 'lib/spatial_features/has_spatial_features.rb', line 202

def points?
  !features.points.empty?
end

#polygons? ⇒ Boolean

Returns:

  • (Boolean) 


194
195
196
 
# File 'lib/spatial_features/has_spatial_features.rb', line 194

def polygons?
  !features.polygons.empty?
end

#spatial_cache_for?(other, buffer_in_meters) ⇒ Boolean

Returns:

  • (Boolean) 


253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/spatial_features/has_spatial_features.rb', line 253

def spatial_cache_for?(other, buffer_in_meters)
  if cache = spatial_caches.between(self, Utils.class_of(other)).first
    return cache.intersection_cache_distance.nil? if buffer_in_meters.nil? # cache must be total if no buffer_in_meters
    return false if cache.stale? # cache must be for current features
    return true if cache.intersection_cache_distance.nil? # always good if cache is total

    return buffer_in_meters <= cache.intersection_cache_distance
  else
    return false
  end
end

#total_intersection_area_in_square_meters(other) ⇒ Object 



247
248
249
250
251
 
# File 'lib/spatial_features/has_spatial_features.rb', line 247

def total_intersection_area_in_square_meters(other)
  other = other.intersecting(self) unless other.is_a?(ActiveRecord::Base)
  return features.area if spatial_cache_for?(other, 0) && SpatialProximity.between(self, other).where('intersection_area_in_square_meters >= ?', features.area).exists?
  return features.total_intersection_area_in_square_meters(other.features)
end

#total_intersection_area_percentage(klass) ⇒ Object 



230
231
232
233
234
 
# File 'lib/spatial_features/has_spatial_features.rb', line 230

def total_intersection_area_percentage(klass)
  return 0.0 unless features_area_in_square_meters > 0

  ((total_intersection_area_in_square_meters(klass) / features_area_in_square_meters) * 100).round(1)
end