rgeo-activerecord 0.6.0 → 1.0.0

data/lib/rgeo/active_record/arel_spatial_queries.rb

@@ -1,44 +1,5 @@
-# -----------------------------------------------------------------------------
-#
-# 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.
@@ -47,7 +8,6 @@ module RGeo
 
     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.
@@ -56,7 +16,6 @@ module RGeo
         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
@@ -71,11 +30,9 @@ module RGeo
         "#{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
@@ -88,50 +45,24 @@ module RGeo
           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.
 
@@ -158,58 +89,29 @@ module RGeo
     end
 
 
-    # Add tools to build spatial structures in the AST.
-    # This stuff requires Arel 2.1 or later.
-
-    if defined?(::Arel::Nodes::NamedFunction)
+    # 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
 
-      # 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)
+      def initialize(name_, expr_, spatial_flags_=[], aliaz_=nil)
+        super(name_, expr_, aliaz_)
+        @spatial_flags = spatial_flags_
       end
 
-      # Allow chaining of spatial expressions from attributes
-      ::Arel::Attribute.class_eval do
-        include ::RGeo::ActiveRecord::SpatialExpressions
+      def spatial_result?
+        @spatial_flags.first
       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
-
+      def spatial_argument?(index_)
+        @spatial_flags[index_+1]
       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

@@ -1,55 +1,10 @@
-# -----------------------------------------------------------------------------
-#
-# 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
-
+# autoload AbstractAdapter
+::ActiveRecord::ConnectionAdapters::AbstractAdapter
 
 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,
@@ -62,13 +17,11 @@ module RGeo
       :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_)
@@ -85,17 +38,18 @@ module RGeo
       end
     end
 
-
     # :stopdoc:
 
-
     # Provide methods for each geometric subtype during table definitions.
+    module GeoTableDefinitions
+      def self.included(base)
+        base.class_eval do
+          alias_method :method_missing_without_rgeo, :method_missing
+          alias_method :method_missing, :method_missing_with_rgeo
+        end
+      end
 
-    ::ActiveRecord::ConnectionAdapters::TableDefinition.class_eval do
-
-      alias_method :method_missing_without_rgeo_modification, :method_missing
-
-      def method_missing(method_name_, *args_, &block_)
+      def method_missing_with_rgeo(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
@@ -104,20 +58,24 @@ module RGeo
             column(name_, type_, opts_)
           end
         else
-          method_missing_without_rgeo_modification(method_name_, *args_, &block_)
+          method_missing_without_rgeo(method_name_, *args_, &block_)
         end
       end
-
     end
 
+    ::ActiveRecord::ConnectionAdapters::TableDefinition.send :include, GeoTableDefinitions
 
-    # Provide methods for each geometric subtype during table changes.
-
-    ::ActiveRecord::ConnectionAdapters::Table.class_eval do
 
-      alias_method :method_missing_without_rgeo_modification, :method_missing
+    # Provide methods for each geometric subtype during table changes.
+    module GeoConnectionAdapters
+      def self.included(base)
+        base.class_eval do
+          alias_method :method_missing_without_rgeo, :method_missing
+          alias_method :method_missing, :method_missing_with_rgeo
+        end
+      end
 
-      def method_missing(method_name_, *args_, &block_)
+      def method_missing_with_rgeo(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
@@ -126,22 +84,26 @@ module RGeo
             @base.add_column(@table_name, name_, type_, opts_)
           end
         else
-          method_missing_without_rgeo_modification(method_name_, *args_, &block_)
+          method_missing_without_rgeo(method_name_, *args_, &block_)
         end
       end
-
     end
 
+    ::ActiveRecord::ConnectionAdapters::Table.send :include, GeoConnectionAdapters
 
-    # Hack schema dumper to output spatial index flag
 
-    ::ActiveRecord::SchemaDumper.class_eval do
+    # Hack schema dumper to output spatial index flag
+    module GeoSchemaDumper
+      def self.included(base)
+        base.class_eval do
+          alias_method :indexes_without_rgeo, :indexes
+          alias_method :indexes, :indexes_with_rgeo
+        end
+      end
 
       private
 
-      alias_method :_old_indexes_method, :indexes
-
-      def indexes(table_, stream_)
+      def indexes_with_rgeo(table_, stream_)
         if (indexes_ = @connection.indexes(table_)).any?
           add_index_statements_ = indexes_.map do |index_|
             statement_parts_ = [
@@ -159,19 +121,15 @@ module RGeo
           stream_.puts
         end
       end
-
     end
 
+    ::ActiveRecord::SchemaDumper.send :include, GeoSchemaDumper
 
-    # 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
+    # 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

@@ -1,57 +1,15 @@
-# -----------------------------------------------------------------------------
-#
-# 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
@@ -78,7 +36,6 @@ module RGeo
         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
@@ -94,15 +51,9 @@ module RGeo
       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)