rgeo-activerecord 6.1.0 → 7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10cec86fb0fe82c2495de189762e89b07e8cb7128d778ba41c882d7d7954dece
-  data.tar.gz: 8c2f7e726217eb8d4261b2b25427b789701d10552a23b0bd00d7cb5fb3ec0c73
+  metadata.gz: 32e44e9ec5d1c3416c4acddd27a1abbf2eb1e7d60e1d3bffa32576b16c1c1cc7
+  data.tar.gz: 109a5c4b94e7a770ec55125ac19f810441c19cd97ba1a580c90114025d0a8dcf
 SHA512:
-  metadata.gz: d49c78a9f23c7d30625bb9114c7a25e7248aa9376f4f309097556fcc8f29f35466b00f9f132b9868b5f7c3c99779e7292151ae984fdecf71e940b8d137734160
-  data.tar.gz: 02f84c73e57d1e179b5f7aed60e0f18e6ccb743ad123e5f929c1d312d9ad00bf4e65c1aed2535cd0530b30cf914290d27d318e1174ba329d5c5905ec2cf89848
+  metadata.gz: fe3abd106906d2e1882f3bd23e19f6d31d75df521ea5f00f5024070590739cf478b2acc8cad400f4c6908f879b29dfad94076d53dcec87268bdd25898147a81e
+  data.tar.gz: 461b289050ed2a49013609ec71a06e3e1326fad4464e62adb06808e7ec6415cb140889afef68ebbad27c3ec664c65270b0a922f4063bdc7c853c0c48b2ce86d6

data/History.md

@@ -1,3 +1,26 @@
+### 7.0.1 / 2021-02-23
+
+* Fix malformed Arel queries using `as` (ugisozols)
+
+### 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)
+
+### 6.2.1 / 2019-07-01
+
+* Include GeometryMixin in Cartesian modules (#52, andreasknoepfle)
+
+
+### 6.2.0 / 2019-05-09
+
+* Allow ActiveRecord 6.0 (#50, corneverbruggen)
+
+
 ### 6.1.0 / 2018-12-01
 
 * Allow rgeo 2.0

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,9 +28,12 @@ Gemfile:
 ```ruby
 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 `6.2+` supports ActiveRecord 5.x and 6.x with `rgeo` 1.0+
+
+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.
 
 Version `5.0` supports ActiveRecord 5.0 and 5.1, with `rgeo` 0.6.
 
@@ -40,32 +43,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 +72,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 +82,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 +133,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,16 +24,18 @@ 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
+        if node.alias
+          collector << " AS "
+          visit node.alias, collector
+        end
         collector
       end
 
@@ -41,13 +43,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,16 +90,6 @@ module RGeo
       alias :visit_RGeo_Cartesian_BoundingBox :visit_String
     end
 
-    Arel::Visitors::DepthFirst.class_eval do
-      alias :visit_RGeo_Feature_Instance :terminal
-      alias :visit_RGeo_Cartesian_BoundingBox :terminal
-    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/geometry_mixin.rb

@@ -82,6 +82,16 @@ module RGeo
       Geos::ZMMultiPolygonImpl,
       Geos::ZMPointImpl,
       Geos::ZMPolygonImpl,
+
+      Cartesian::GeometryCollectionImpl,
+      Cartesian::LinearRingImpl,
+      Cartesian::LineImpl,
+      Cartesian::LineStringImpl,
+      Cartesian::MultiLineStringImpl,
+      Cartesian::MultiPointImpl,
+      Cartesian::MultiPolygonImpl,
+      Cartesian::PointImpl,
+      Cartesian::PolygonImpl
     ].each { |klass| klass.include(GeometryMixin) }
 
     if RGeo::Geos.capi_supported?

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.1.0"
+    VERSION = "7.0.1"
   end
 end

metadata

@@ -1,27 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: rgeo-activerecord
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 7.0.1
 platform: ruby
 authors:
-- Daniel Azuma, Tee Parham
+- Daniel Azuma
+- Tee Parham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-01 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
@@ -122,10 +123,27 @@ 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.
-email: dazuma@gmail.com, parhameter@gmail.com
+email:
+- dazuma@gmail.com
+- parhameter@gmail.com
+- kfdoggett@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -142,7 +160,8 @@ files:
 - lib/rgeo/active_record/spatial_factory_store.rb
 - lib/rgeo/active_record/version.rb
 homepage: https://github.com/rgeo/rgeo-activerecord
-licenses: []
+licenses:
+- BSD-3-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -152,15 +171,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: An RGeo module providing spatial extensions to ActiveRecord.