rgeo-ar 0.6.0

data/lib/rgeo/active_record/arel_spatial_queries.rb

@@ -0,0 +1,215 @@
+# -----------------------------------------------------------------------------
+#
+# Various Arel hacks to support spatial queries
+#
+# -----------------------------------------------------------------------------
+# Copyright 2010-2012 Daniel Azuma
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the copyright holder, nor the names of any other
+#   contributors to this software, may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+;
+
+
+module RGeo
+
+  module ActiveRecord
+
+
+    # A set of common Arel visitor hacks for spatial ToSql visitors.
+    # Generally, a spatial ActiveRecord adapter should provide a custom
+    # ToSql Arel visitor that includes and customizes this module.
+    # See the existing spatial adapters (i.e. postgis, spatialite,
+    # mysqlspatial, and mysql2spatial) for usage examples.
+
+    module SpatialToSql
+
+
+      # Map a standard OGC SQL function name to the actual name used by
+      # a particular database. This method should take a name and
+      # return either the changed name or the original name.
+
+      def st_func(standard_name_)
+        standard_name_
+      end
+
+
+      # Visit the SpatialNamedFunction node. This operates similarly to
+      # the standard NamedFunction node, but it performs function name
+      # mapping for the database, and it also uses the type information
+      # in the node to determine when to cast string arguments to WKT,
+
+      def visit_RGeo_ActiveRecord_SpatialNamedFunction(node_, *args)
+        name_ = st_func(node_.name)
+        exprs_ = []
+        node_.expressions.each_with_index do |expr_, index_|
+          exprs_ << (node_.spatial_argument?(index_) ? visit_in_spatial_context(expr_, *args) : visit(expr_, *args))
+        end
+        "#{name_}(#{node_.distinct ? 'DISTINCT ' : ''}#{exprs_.join(', ')})#{node_.alias ? " AS #{visit(node_.alias, *args)}" : ''}"
+      end
+
+
+      # Generates SQL for a spatial node.
+      # 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_, *args)
+        case node_
+        when ::String
+          "#{st_func('ST_WKTToSQL')}(#{visit_String(node_, *args)})"
+        when ::RGeo::Feature::Instance
+          visit_RGeo_Feature_Instance(node_, *args)
+        when ::RGeo::Cartesian::BoundingBox
+          visit_RGeo_Cartesian_BoundingBox(node_, *args)
+        else
+          visit(node_, *args)
+        end
+      end
+
+
+    end
+
+
+    # This node wraps an RGeo feature and gives it spatial expression
+    # constructors.
+
+    class SpatialConstantNode
+
+      include ::RGeo::ActiveRecord::SpatialExpressions
+
+
+      # The delegate should be the RGeo feature.
+
+      def initialize(delegate_)
+        @delegate = delegate_
+      end
+
+
+      # Return the RGeo feature
+
+      attr_reader :delegate
+
+
+    end
+
+
+    # :stopdoc:
+
+
+    # Hack Arel Attributes dispatcher to recognize geometry columns.
+    # This is deprecated but necessary to support legacy Arel versions.
+
+    if ::Arel::Attributes.method_defined?(:for)
+      module ArelAttributesLegacyClassMethods
+        def for(column_)
+          column_.type == :spatial ? Attribute : super
+        end
+      end
+      ::Arel::Attributes.extend(ArelAttributesLegacyClassMethods)
+    end
+
+
+    # Make sure the standard Arel visitors can handle RGeo feature objects
+    # by default.
+
+    ::Arel::Visitors::Visitor.class_eval do
+      def visit_RGeo_ActiveRecord_SpatialConstantNode(node_, *args)
+        if respond_to?(:visit_in_spatial_context)
+          visit_in_spatial_context(node_.delegate, *args)
+        else
+          visit(node_.delegate, *args)
+        end
+      end
+    end
+    ::Arel::Visitors::Dot.class_eval do
+      alias :visit_RGeo_Feature_Instance :visit_String
+      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
+
+
+    # Add tools to build spatial structures in the AST.
+    # This stuff requires Arel 2.1 or later.
+
+    if defined?(::Arel::Nodes::NamedFunction)
+
+      # Allow chaining of predications from named functions
+      # (Some older versions of Arel didn't do this.)
+      ::Arel::Nodes::NamedFunction.class_eval do
+        include ::Arel::Predications unless include?(::Arel::Predications)
+      end
+
+      # Allow chaining of spatial expressions from attributes
+      ::Arel::Attribute.class_eval do
+        include ::RGeo::ActiveRecord::SpatialExpressions
+      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
+      # spatial elements.
+
+      class SpatialNamedFunction < ::Arel::Nodes::NamedFunction
+
+        include ::RGeo::ActiveRecord::SpatialExpressions
+
+        def initialize(name_, expr_, spatial_flags_=[], aliaz_=nil)
+          super(name_, expr_, aliaz_)
+          @spatial_flags = spatial_flags_
+        end
+
+        def spatial_result?
+          @spatial_flags.first
+        end
+
+        def spatial_argument?(index_)
+          @spatial_flags[index_+1]
+        end
+
+      end
+
+    else
+
+      # A dummy SpatialNamedFunction for pre-2.1 versions of Arel.
+      class SpatialNamedFunction; end
+
+    end
+
+
+    # :startdoc:
+
+
+  end
+
+end

data/lib/rgeo/active_record/common_adapter_elements.rb

@@ -0,0 +1,177 @@
+# -----------------------------------------------------------------------------
+#
+# Common tools for spatial adapters for ActiveRecord
+#
+# -----------------------------------------------------------------------------
+# Copyright 2010-2012 Daniel Azuma
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the copyright holder, nor the names of any other
+#   contributors to this software, may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+;
+
+
+require 'active_support/core_ext/class' # Workaround for a missing require in ActiveRecord 3.2.1
+require 'active_record'
+
+# Force AbstractAdapter to autoload
+if ::ActiveRecord::ConnectionAdapters::AbstractAdapter
+end
+
+
+module RGeo
+
+  module ActiveRecord
+
+
+    # Some default column constructors specifications for most spatial
+    # databases. Individual adapters may add to or override this list.
+
+    DEFAULT_SPATIAL_COLUMN_CONSTRUCTORS = {
+      :spatial => {:type => 'geometry'}.freeze,
+      :geometry => {}.freeze,
+      :point => {}.freeze,
+      :line_string => {}.freeze,
+      :polygon => {}.freeze,
+      :geometry_collection => {}.freeze,
+      :multi_line_string => {}.freeze,
+      :multi_point => {}.freeze,
+      :multi_polygon => {}.freeze,
+    }.freeze
+
+
+    # Index definition struct with a spatial flag field.
+
+    class SpatialIndexDefinition < Struct.new(:table, :name, :unique, :columns, :lengths, :orders, :where, :spatial)
+    end
+
+
+    # Returns a feature type module given a string type.
+
+    def self.geometric_type_from_name(name_)
+      case name_.to_s
+      when /^geometry/i then ::RGeo::Feature::Geometry
+      when /^point/i then ::RGeo::Feature::Point
+      when /^linestring/i then ::RGeo::Feature::LineString
+      when /^polygon/i then ::RGeo::Feature::Polygon
+      when /^geometrycollection/i then ::RGeo::Feature::GeometryCollection
+      when /^multipoint/i then ::RGeo::Feature::MultiPoint
+      when /^multilinestring/i then ::RGeo::Feature::MultiLineString
+      when /^multipolygon/i then ::RGeo::Feature::MultiPolygon
+      else nil
+      end
+    end
+
+
+    # :stopdoc:
+
+
+    # Provide methods for each geometric subtype during table definitions.
+
+    ::ActiveRecord::ConnectionAdapters::TableDefinition.class_eval do
+
+      alias_method :method_missing_without_rgeo_modification, :method_missing
+
+      def method_missing(method_name_, *args_, &block_)
+        if @base.respond_to?(:spatial_column_constructor) && (info_ = @base.spatial_column_constructor(method_name_))
+          info_ = info_.dup
+          type_ = (info_.delete(:type) || method_name_).to_s
+          opts_ = args_.extract_options!.merge(info_)
+          args_.each do |name_|
+            column(name_, type_, opts_)
+          end
+        else
+          method_missing_without_rgeo_modification(method_name_, *args_, &block_)
+        end
+      end
+
+    end
+
+
+    # Provide methods for each geometric subtype during table changes.
+
+    ::ActiveRecord::ConnectionAdapters::Table.class_eval do
+
+      alias_method :method_missing_without_rgeo_modification, :method_missing
+
+      def method_missing(method_name_, *args_, &block_)
+        if @base.respond_to?(:spatial_column_constructor) && (info_ = @base.spatial_column_constructor(method_name_))
+          info_ = info_.dup
+          type_ = (info_.delete(:type) || method_name_).to_s
+          opts_ = args_.extract_options!.merge(info_)
+          args_.each do |name_|
+            @base.add_column(@table_name, name_, type_, opts_)
+          end
+        else
+          method_missing_without_rgeo_modification(method_name_, *args_, &block_)
+        end
+      end
+
+    end
+
+
+    # Hack schema dumper to output spatial index flag
+
+    ::ActiveRecord::SchemaDumper.class_eval do
+
+      private
+
+      alias_method :_old_indexes_method, :indexes
+
+      def indexes(table_, stream_)
+        if (indexes_ = @connection.indexes(table_)).any?
+          add_index_statements_ = indexes_.map do |index_|
+            statement_parts_ = [
+              ('add_index ' + index_.table.inspect),
+              index_.columns.inspect,
+              (':name => ' + index_.name.inspect),
+            ]
+            statement_parts_ << ':unique => true' if index_.unique
+            statement_parts_ << ':spatial => true' if index_.respond_to?(:spatial) && index_.spatial
+            index_lengths_ = (index_.lengths || []).compact
+            statement_parts_ << (':length => ' + ::Hash[*index_.columns.zip(index_.lengths).flatten].inspect) unless index_lengths_.empty?
+            '  ' + statement_parts_.join(', ')
+          end
+          stream_.puts add_index_statements_.sort.join("\n")
+          stream_.puts
+        end
+      end
+
+    end
+
+
+    # Tell ActiveRecord to cache spatial attribute values so they don't get
+    # re-parsed on every access.
+
+    ::ActiveRecord::Base.attribute_types_cached_by_default << :spatial
+
+
+    # :startdoc:
+
+
+  end
+
+end

data/lib/rgeo/active_record/geometry_mixin.rb

@@ -0,0 +1,108 @@
+# -----------------------------------------------------------------------------
+#
+# Geometry mixin for JSON serialization
+#
+# -----------------------------------------------------------------------------
+# Copyright 2010-2012 Daniel Azuma
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the copyright holder, nor the names of any other
+#   contributors to this software, may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+;
+
+
+module RGeo
+
+  module ActiveRecord
+
+
+    # This module is mixed into all geometry objects. It provides an
+    # as_json method so that ActiveRecord knows how to generate JSON
+    # for a geometry-valued field.
+
+    module GeometryMixin
+
+
+      # The default JSON generator Proc. Renders geometry fields as WKT.
+      DEFAULT_JSON_GENERATOR = ::Proc.new{ |geom_| geom_.to_s }
+
+      @json_generator = DEFAULT_JSON_GENERATOR
+
+
+      # Set the style of JSON generation used for geometry fields in an
+      # ActiveRecord model by default. You may pass nil to use
+      # DEFAULT_JSON_GENERATOR, a proc that takes a geometry as the
+      # argument and returns an object that can be converted to JSON
+      # (i.e. usually a hash or string), or one of the following symbolic
+      # values:
+      #
+      # <tt>:wkt</tt>::
+      #   Well-known text format. (Same as DEFAULT_JSON_GENERATOR.)
+      # <tt>:geojson</tt>::
+      #   GeoJSON format. Requires the rgeo-geojson gem.
+
+      def self.set_json_generator(value_=nil, &block_)
+        if block_ && !value_
+          value_ = block_
+        elsif value_ == :geojson
+          require 'rgeo/geo_json'
+          value_ = ::Proc.new{ |geom_| ::RGeo::GeoJSON.encode(geom_) }
+        end
+        if value_.is_a?(::Proc)
+          @json_generator = value_
+        else
+          @json_generator = DEFAULT_JSON_GENERATOR
+        end
+      end
+
+
+      # Given a feature, returns an object that can be serialized as JSON
+      # (i.e. usually a hash or string), using the current json_generator.
+      # This is used to generate JSON for geometry-valued ActiveRecord
+      # fields by default.
+
+      def self.generate_json(geom_)
+        @json_generator.call(geom_)
+      end
+
+
+      # Serializes this object as JSON for ActiveRecord.
+
+      def as_json(opts_=nil)
+        GeometryMixin.generate_json(self)
+      end
+
+
+    end
+
+
+  end
+
+end
+
+
+::RGeo::Feature::MixinCollection::GLOBAL.for_type(::RGeo::Feature::Geometry).
+  add(::RGeo::ActiveRecord::GeometryMixin)