copiousfreetime/rgeo-activerecord

RGeo::ActiveRecord

RGeo::ActiveRecord is an optional RGeo module providing spatial extensions for ActiveRecord, as well as a set of helpers for writing spatial ActiveRecord adapters based on RGeo.

Summary

RGeo is a key component for writing location-aware applications in the Ruby programming language. At its core is an implementation of the industry standard OGC Simple Features Specification, which provides data representations of geometric objects such as points, lines, and polygons, along with a set of geometric analysis operations. See the README for the "rgeo" gem for more information.

RGeo::ActiveRecord is an optional RGeo add-on module providing spatial extensions for ActiveRecord, as well as a set of helpers for writing spatial ActiveRecord adapters based on RGeo.

Installation

Gemfile:

gem 'rgeo-activerecord'

Version 6.1 supports ActiveRecord 5.0, 5.1, and 5.2 with rgeo 1.0+.

Version 6.0 supports ActiveRecord 5.0, 5.1, and 5.2 with rgeo 1.x.

Version 5.0 supports ActiveRecord 5.0 and 5.1, with rgeo 0.6.

Version 4.0 supports ActiveRecord 4.2.

Version 1.1.0 supports ActiveRecord 4.0 and 4.1

Version 0.6.0 supports earlier versions of ruby and ActiveRecord:

Ruby 1.8.7 or later
ActiveRecord 3.0.3 - 3.2.x
rgeo 0.3.20 or later
arel 2.0.6 or later

Spatial Factories for Columns

rgeo_factory_generator and related methods were removed in version 4.0, since column types are no longer tied to their database column in ActiveRecord 4.2.

Register spatial factories in the SpatialFactoryStore singleton class. Each spatial type in your ActiveRecord models will use the SpatialFactoryStore to retrieve a factory matching the properties of its type. For example, you can set a different spatial factory for point types, or for types matching a specific SRID, or having a Z coordinate, or any combination of attributes.

The supported keys when registering a spatial type are listed here with their default values and other allowed values:

geo_type: "geometry", # point, polygon, line_string, geometry_collection,
                      # multi_line_string, multi_point, multi_polygon
has_m:    false,      # true
has_z:    false,      # true
sql_type: "geometry", # geography
srid:     0,          # (any valid SRID)

The default factories are RGeo::Geographic.spherical_factory for geographic types, and RGeo::Cartesian.preferred_factory for geometric types.

Here is an example setup:

RGeo::ActiveRecord::SpatialFactoryStore.instance.tap do |config|
  # By default, use the GEOS implementation for spatial columns.
  config.default = RGeo::Geos.factory_generator

  # But use a geographic implementation for point columns.
  config.register(RGeo::Geographic.spherical_factory(srid: 4326), geo_type: "point")
end