rgeo-activerecord 6.2.2 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0eaf7ecbe5d6d765688cd03ed0a6ce434f6b2eb7c3f8cf4f77e94cf87859e22c
-  data.tar.gz: b10e77caf7d99659469548766255177627db551fc522fa76c26d4a0a2f775e74
+  metadata.gz: 9c1442b0141a1655c582e412962a3328b702e52da302e3a4874a3d22ee3f8fbc
+  data.tar.gz: 86933cf076e3c728ea34d3918bff61f56baef30c7e31dce99e56093a2049a5cd
 SHA512:
-  metadata.gz: bbec5edddc4e64e3d9587619bb6316a71651f37806ffdc0ff73fbd595003232e5ec6f783c73eba931f148687b9d07dc245d5437403b5eb5c3583fe0ae7684fdd
-  data.tar.gz: 1f487be6304b56fb804e6a97478093351d7a86586a14b94b6ca7c2ad1d2e9b6244767830e14f63a06dd4365c2b82b387759f1f311b939d907bf9c54a4ea1f7aa
+  metadata.gz: d4b10c1f4ab732aa52545bce0f920fd36511e68c4c560b5f29f3b5907243e82cc8723bb54abd7ce1277a1857d2783749e0d1bc8a452117d4b9b7f5f6da1262ea
+  data.tar.gz: 46b20c80597ca7dd822987fcf2592c56d68c0f413684eb5e87de012a5139f77a8b6ded059553001b5791c7f6be867a9897b01b4aca4ef5dda361d4259482d79b

data/History.md

@@ -1,3 +1,8 @@
+### 7.0.0 / 2020-12-15
+
+* Update visit_* methods and Arel interface to support RGeo features.
+* Rework SpatialFactoryStore to support hierarchical matches and fallbacks.
+
 ### 6.2.2 / 2020-11-20
 
 * Removed `Arel::Visitor::DepthFirst` for ActiveRecord 6.1 compatibility (kamipo)

data/README.md

@@ -1,10 +1,10 @@
 ## RGeo::ActiveRecord
 
-[![Gem Version](https://badge.fury.io/rb/rgeo-activerecord.svg)](http://badge.fury.io/rb/rgeo-activerecord)
-[![Build Status](https://travis-ci.org/rgeo/rgeo-activerecord.svg?branch=master)](https://travis-ci.org/rgeo/rgeo-activerecord)
+[![Gem version](https://img.shields.io/gem/v/rgeo-activerecord)](https://rubygems.org/gems/rgeo-activerecord)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/rgeo/rgeo-activerecord/Tests)](https://github.com/rgeo/rgeo-activerecord/actions?query=workflow%3A%22Tests%22)
 [![Code Climate](https://codeclimate.com/github/rgeo/rgeo-activerecord.png)](https://codeclimate.com/github/rgeo/rgeo-activerecord)
 
-RGeo::ActiveRecord is an optional [RGeo](http://github.com/dazuma/rgeo) module
+RGeo::ActiveRecord is an optional [RGeo](http://github.com/rgeo/rgeo) module
 providing spatial extensions for ActiveRecord, as well as a set of helpers for
 writing spatial ActiveRecord adapters based on RGeo.
 
@@ -28,6 +28,7 @@ Gemfile:
 ```ruby
 gem 'rgeo-activerecord'
 ```
+
 Version `6.1` supports ActiveRecord 5.x and 6.0 with `rgeo` 1.0+.
 
 Version `6.0` supports ActiveRecord 5.x with `rgeo` 1.x.
@@ -40,32 +41,28 @@ 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
+- 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.
+**_This is an introduction. More details are available in the [wiki entry](https://github.com/rgeo/rgeo-activerecord/wiki/Spatial-Factory-Store)._**
 
-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
+Register spatial factories in the `SpatialFactoryStore` singleton class to parse spatial data. Each spatial column
+in your models will use the `SpatialFactoryStore` to parse the stored WKB into an RGeo Feature. The factory from the `SpatialFactoryStore` is chosen based on metadata from the spatial column and the attributes with which the factory was registered to the store. For example, you can set a factory for point types, for types matching a specific SRID, 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:
+The supported keys when registering a spatial type are listed here with their expected 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)
+geo_type: string  # geometry, point, polygon, line_string, geometry_collection,
+                  # multi_line_string, multi_point, multi_polygon
+has_m:    boolean # true, false
+has_z:    boolean # true, false
+sql_type: string  # geometry, geography
+srid:     int     # (any valid SRID)
 ```
 
 The default factories are `RGeo::Geographic.spherical_factory` for
@@ -73,7 +70,7 @@ geographic types, and `RGeo::Cartesian.preferred_factory` for geometric types.
 
 Here is an example setup:
 
-```ruby
+```rb
 RGeo::ActiveRecord::SpatialFactoryStore.instance.tap do |config|
   # By default, use the GEOS implementation for spatial columns.
   config.default = RGeo::Geos.factory_generator
@@ -83,6 +80,33 @@ RGeo::ActiveRecord::SpatialFactoryStore.instance.tap do |config|
 end
 ```
 
+_NOTE: `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._
+
+### Spatial Queries
+
+RGeo-ActiveRecord provides an Arel interface to use functions commonly found in spatial databases. The interface also allows for the creation of your own spatial functions if they are not defined.
+
+Here is an example using `st_contains`:
+
+```rb
+point = RGeo::Geos.factory(srid: 0).point(1,1)
+
+buildings = Building.arel_table
+containing_buiildings = Building.where(buildings[:geom].st_contains(point))
+```
+
+or using the `Arel.spatial` node:
+
+```rb
+point = "SRID=0;POINT(1,1)"
+
+buildings = Building.arel_table
+containing_buiildings = Building.where(buildings[:geom].st_contains(Arel.spatial(point)))
+```
+
+_Note: If you pass a WKT representation into an st_function, you should prepend the string with SRID=your_srid, otherwise the database will assume SRID=0 which may cause errors on certain operations._
+
 ### RGeo Dependency
 
 See the README for the [rgeo](https://github.com/rgeo/rgeo) gem, a dependency, for further
@@ -107,15 +131,17 @@ http://groups.google.com/group/rgeo-users
 ### Acknowledgments
 
 [Daniel Azuma](http://www.daniel-azuma.com) created RGeo.
-[Tee Parham](http://twitter.com/teeparham) is the current maintainer.
+[Tee Parham](http://twitter.com/teeparham) is a former maintainer.
+[Keith Doggett](http://www.github.com/keithdoggett) is a current maintainer.
+[Ulysse Buonomo](http://www.github.com/BuonOmo) is a current maintainer.
 
 Development is supported by:
 
-* [Pirq](http://pirq.com)
-* [Neighborland](https://neighborland.com)
+- [Klaxit](https://www.klaxit.com)
+- Goldfish Ads
 
 ### License
 
-Copyright 2015 Daniel Azuma, Tee Parham
+Copyright 2020 Daniel Azuma, Tee Parham
 
 https://github.com/rgeo/rgeo-activerecord/blob/master/LICENSE.txt

data/lib/rgeo/active_record/arel_spatial_queries.rb

@@ -24,14 +24,13 @@ module RGeo
 
       def visit_RGeo_ActiveRecord_SpatialNamedFunction(node, collector)
         name = st_func(node.name)
-        exprs = []
-        node.expressions.each_with_index do |expr, index|
-          exprs << (node.spatial_argument?(index) ? visit_in_spatial_context(expr, collector) : visit(expr, collector))
-        end
         collector << name
         collector << "("
         collector << "DISTINCT " if node.distinct
-        collector << exprs.join(", ")
+        node.expressions.each_with_index do |expr, index|
+          node.spatial_argument?(index) ? visit_in_spatial_context(expr, collector) : visit(expr, collector)
+          collector << ", " unless index == node.expressions.size - 1
+        end
         collector << ")"
         collector << " AS #{visit(node.alias, collector)}" if node.alias
         collector
@@ -41,13 +40,15 @@ module RGeo
       # The node must be a string (in which case it is treated as WKT),
       # an RGeo feature, or a spatial attribute.
       def visit_in_spatial_context(node, collector)
-        case node
-        when String
-          collector << "#{st_func('ST_WKTToSQL')}(#{quote(node)})"
-        when RGeo::Feature::Instance
-          collector << visit_RGeo_Feature_Instance(node, collector)
-        when RGeo::Cartesian::BoundingBox
-          collector << visit_RGeo_Cartesian_BoundingBox(node, collector)
+        if node.is_a?(String)
+          collector << "#{st_func('ST_GeomFromText')}(#{quote(node)})"
+        elsif node.is_a?(RGeo::Feature::Instance)
+          srid = node.srid
+          collector << "#{st_func('ST_GeomFromText')}(#{quote(node.to_s)}, #{srid})"
+        elsif node.is_a?(RGeo::Cartesian::BoundingBox)
+          geom = node.to_geometry
+          srid = geom.srid
+          collector << "#{st_func('ST_GeomFromText')}(#{quote(geom.to_s)}, #{srid})"
         else
           visit(node, collector)
         end
@@ -86,11 +87,6 @@ module RGeo
       alias :visit_RGeo_Cartesian_BoundingBox :visit_String
     end
 
-    Arel::Visitors::ToSql.class_eval do
-      alias :visit_RGeo_Feature_Instance :visit_String
-      alias :visit_RGeo_Cartesian_BoundingBox :visit_String
-    end
-
     # A NamedFunction subclass that keeps track of the spatial-ness of
     # the arguments and return values, so that it can provide context to
     # visitors that want to interpret syntax differently when dealing with

data/lib/rgeo/active_record/spatial_factory_store.rb

@@ -4,16 +4,17 @@ module RGeo
   module ActiveRecord
     class SpatialFactoryStore
       include Singleton
+      Entry = Struct.new(:attrs, :factory)
 
       attr_accessor :registry
 
       def initialize
-        @registry = {}
+        @registry = []
         @default = nil
       end
 
       def register(factory, attrs = {})
-        registry[key(attrs)] = factory
+        registry.push(Entry.new(filter_attrs(attrs), factory))
       end
 
       def default(attrs = {})
@@ -25,11 +26,11 @@ module RGeo
       end
 
       def factory(attrs)
-        registry[key(attrs)] || default(attrs)
+        closest_factory(attrs) || default(attrs)
       end
 
       def clear
-        @registry = {}
+        @registry = []
       end
 
       private
@@ -50,14 +51,53 @@ module RGeo
         }
       end
 
-      def key(attrs)
-        {
-          geo_type: "geometry",
-          has_m:    false,
-          has_z:    false,
-          sql_type: "geometry",
-          srid:     0,
-        }.merge(attrs).hash
+      def filter_attrs(attrs)
+        attrs.slice(:geo_type, :has_m, :has_z, :sql_type, :srid)
+      end
+
+      ##
+      # Match attrs to the closest equal to or less specific factory
+      #
+      # That means that attrs can at most be matched to an Entry with the same
+      # number of keys as it. But could match with a factory with only 1 key
+      # in its attrs.
+      #
+      # Examples:
+      #   attrs = {sql_type: "geometry" }, entry_attrs = {sql_type: "geometry", geo_type: "point"}
+      #   is not a match because the entry is more specific than attrs
+      #
+      #   attrs = {sql_type: "geometry", geo_type: "point"}, entry_attrs = {sql_type: "geometry"}
+      #   is a match because the entry is less specific than attrs and would be the fallback for all "geometry" types
+      #
+      #   attrs = {sql_type: "geometry", geo_type: "point"}, entry_attrs = {sql_type: "geometry", geo_type: "linestring"}
+      #   is not a match because there are mismatched keys
+      #
+      # If there is no match, nil is returned
+      def closest_factory(attrs)
+        max_matches = 0
+        registry.reduce(nil) do |selected_fac, entry|
+          cmp = cmp_attrs(attrs, entry.attrs)
+          if cmp > max_matches
+            max_matches = cmp
+            entry.factory
+          else
+            selected_fac
+          end
+        end
+      end
+
+      ##
+      # Returns number of common key/values
+      # or -1 if oth is bigger than attrs, or they have a mismatched key/value pair
+      def cmp_attrs(attrs, oth)
+        return -1 if oth.size > attrs.size
+        matches = 0
+        attrs.each do |k, v|
+          next if oth[k].nil?
+          return -1 unless v == oth[k]
+          matches += 1
+        end
+        matches
       end
     end
   end

data/lib/rgeo/active_record/version.rb

@@ -2,6 +2,6 @@
 
 module RGeo
   module ActiveRecord
-    VERSION = "6.2.2"
+    VERSION = "7.0.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rgeo-activerecord
 version: !ruby/object:Gem::Version
-  version: 6.2.2
+  version: 7.0.0
 platform: ruby
 authors:
 - Daniel Azuma
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-11 00:00:00.000000000 Z
+date: 2020-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -123,6 +123,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.20.0
 description: RGeo is a geospatial data library for Ruby. RGeo::ActiveRecord is an
   optional RGeo module providing some spatial extensions to ActiveRecord, as well
   as common tools used by RGeo-based spatial adapters.
@@ -164,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: An RGeo module providing spatial extensions to ActiveRecord.