rgeo-activerecord 0.2.0 → 0.2.1

data/History.rdoc

@@ -1,3 +1,8 @@
+=== 0.2.1 / 2010-12-27
+
+* Support for RGeo features as nodes in the Arel AST.
+* Basic utility Arel visitor methods for handling spatial equality nodes in where-expressions.
+
 === 0.2.0 / 2010-12-07
 
 * Initial public alpha release. Spun rgeo-activerecord off from the core rgeo gem.

data/README.rdoc

@@ -15,14 +15,15 @@ along with a set of geometric analysis operations. See the README for the
 
 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.
+spatial \ActiveRecord adapters based on \RGeo. Generally, you will not
+interact directly with this library
 
 === Installation
 
 RGeo::ActiveRecord has the following requirements:
 
 * Ruby 1.8.7 or later. Ruby 1.9.2 or later preferred.
-* \RGeo 0.2.0 or later.
+* \RGeo 0.2.3 or later.
 * \ActiveRecord 3.0.3 or later. Earlier versions will not work.
 
 Generally, \ActiveRecord adapters which depend on this module should be
@@ -37,8 +38,7 @@ installation information.
 
 === To-do list
 
-* We want to investigate writing some Arel extensions for constructing
-  spatial queries.
+* Arel extensions for constructing more complex spatial queries.
 
 === Development and support
 

data/Version

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/rgeo/active_record/arel_modifications.rb

@@ -37,14 +37,39 @@
 require 'arel'
 
 
-# :stopdoc:
+# The rgeo-activerecord gem installs several hacks into Arel to support
+# geometry values and geometry-valued columns.
+# 
+# To support geometry values as nodes in the Arel AST, we need to provide
+# a way for visitors to handle nodes that are feature objects.
+# Generally, this is accomplished by writing (or aliasing) methods in the
+# visitor of the form "visit_<classname>". Arel will dispatch to a method
+# based on the class of the object in the AST. Unfortunately, RGeo feature
+# objects usually have opaque classes; plus, there are so many different
+# classes as to make it infeasible to list all of them. Therefore, we hack
+# Arel::Visitors::Visitor#visit to explicitly recognize the
+# RGeo::Feature::Instance marker module, and we define the method
+# visit_RGeo_Feature_Instance. In the various visitors (Dot, DepthFirst,
+# and ToSql), this method is aliased in the same way as the other raw
+# values. For the ToSql visitor, this means aliasing to visit_String,
+# which then depends on the quoting implemented by the connection adapter
+# to convert to a SQL literal.
+# 
+# To support geometry columns, we define Arel::Attributes::Geometry, and
+# we hack Arel::Attributes::for to map the :geometry column type to that
+# new attribute. We then add the appropriate alias for the
+# visit_Arel_Attributes_Geometry method to the visitors.
 
 module Arel
   
+  # :stopdoc:
+  
   module Attributes
     
+    # New attribute type for geometry-valued column
     class Geometry < Attribute; end
     
+    # Hack Attributes dispatcher to recognize geometry columns
     class << self
       alias_method :for_without_geometry, :for
       def for(column_)
@@ -56,18 +81,40 @@ module Arel
   
   module Visitors
     
+    # Hack visit dispatcher to recognize RGeo features as nodes.
+    # We need a special dispatcher code because the default dispatcher
+    # triggers on class name. RGeo features tend to have opaque classes.
+    class Visitor
+      alias_method :visit_without_rgeo_types, :visit
+      def visit(object_)
+        if object_.kind_of?(::RGeo::Feature::Instance) && respond_to?(:visit_RGeo_Feature_Instance)
+          visit_RGeo_Feature_Instance(object_)
+        else
+          visit_without_rgeo_types(object_)
+        end
+      end
+    end
+    
+    # Dot visitor handlers for geometry attributes and values.
     class Dot
       alias :visit_Arel_Attributes_Geometry :visit_Arel_Attribute
-      alias :visit_RGeo_Feature_Geometry :visit_String
+      alias :visit_RGeo_Feature_Instance :visit_String
     end
     
+    # DepthFirst visitor handlers for geometry attributes and values.
+    class DepthFirst
+      alias :visit_Arel_Attributes_Geometry :visit_Arel_Attribute
+      alias :visit_RGeo_Feature_Instance :terminal
+    end
+    
+    # ToSql visitor handlers for geometry attributes and values.
     class ToSql
       alias :visit_Arel_Attributes_Geometry :visit_Arel_Attributes_Attribute
-      alias :visit_RGeo_Feature_Geometry :visit_String
+      alias :visit_RGeo_Feature_Instance :visit_String
     end
     
   end
   
+  # :startdoc:
+  
 end
-
-# :startdoc:

data/lib/rgeo/active_record/common.rb

@@ -52,6 +52,47 @@ module RGeo
     end
     
     
+    # A set of common Arel visitor hacks for spatial ToSql visitors.
+    
+    module SpatialToSql
+      
+      # Map a standard OGC SQL function name to the actual name used by
+      # a particular database.
+      def st_func(standard_name_)
+        standard_name_
+      end
+      
+      def visit_Arel_Nodes_Equality(node_)  # :nodoc:
+        right_ = node_.right
+        left_ = node_.left
+        if left_.kind_of?(::Arel::Attributes::Geometry)
+          case right_
+          when ::RGeo::Feature::Instance
+            return "#{st_func('ST_Equals')}(#{visit(left_)}, #{visit(right_)})"
+          when ::String
+            return "#{st_func('ST_Equals')}(#{visit(left_)}, #{st_func('ST_WKTToSQL')}(#{visit(right_)}))"
+          end
+        end
+        super
+      end
+      
+      def visit_Arel_Nodes_NotEqual(node_)  # :nodoc:
+        right_ = node_.right
+        left_ = node_.left
+        if left_.kind_of?(::Arel::Attributes::Geometry)
+          case right_
+          when ::RGeo::Feature::Instance
+            return "NOT #{st_func('ST_Equals')}(#{visit(left_)}, #{visit(right_)})"
+          when ::String
+            return "NOT #{st_func('ST_Equals')}(#{visit(left_)}, #{st_func('ST_WKTToSQL')}(#{visit(right_)}))"
+          end
+        end
+        super
+      end
+      
+    end
+    
+    
     # Index definition struct with a spatial flag field.
     
     class SpatialIndexDefinition < ::Struct.new(:table, :name, :unique, :columns, :lengths, :spatial)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Daniel Azuma
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-07 00:00:00 -08:00
+date: 2010-12-27 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,8 +28,8 @@ dependencies:
         segments: 
         - 0
         - 2
-        - 0
-        version: 0.2.0
+        - 3
+        version: 0.2.3
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency