rgeo-activerecord 0.4.1 → 0.4.2

data/lib/rgeo/active_record/arel_spatial_queries.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Various Arel hacks to support spatial queries
-# 
+#
 # -----------------------------------------------------------------------------
-# Copyright 2010 Daniel Azuma
-# 
+# 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -35,33 +35,33 @@
 
 
 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_)
         name_ = st_func(node_.name)
         exprs_ = []
@@ -70,12 +70,12 @@ module RGeo
         end
         "#{name_}(#{node_.distinct ? 'DISTINCT ' : ''}#{exprs_.join(', ')})#{node_.alias ? " AS #{visit node_.alias}" : ''}"
       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_)
         case node_
         when ::String
@@ -86,40 +86,40 @@ module RGeo
           visit(node_)
         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_)
@@ -128,11 +128,11 @@ module RGeo
       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_)
         if respond_to?(:visit_in_spatial_context)
@@ -151,60 +151,60 @@ module RGeo
     ::Arel::Visitors::ToSql.class_eval do
       alias :visit_RGeo_Feature_Instance :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

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Common tools for spatial adapters for ActiveRecord
-# 
+#
 # -----------------------------------------------------------------------------
-# Copyright 2010 Daniel Azuma
-# 
+# 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -40,13 +40,13 @@ require 'active_record'
 
 
 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,
@@ -58,16 +58,16 @@ module RGeo
       :multi_point => {}.freeze,
       :multi_polygon => {}.freeze,
     }.freeze
-    
-    
+
+
     # Index definition struct with a spatial flag field.
-    
+
     class SpatialIndexDefinition < ::Struct.new(:table, :name, :unique, :columns, :lengths, :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
@@ -81,13 +81,13 @@ module RGeo
       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_)
@@ -103,10 +103,10 @@ module RGeo
         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_)
@@ -122,10 +122,10 @@ module RGeo
         end
       end
     end
-    
-    
+
+
     # Hack schema dumper to output spatial index flag
-    
+
     ::ActiveRecord::SchemaDumper.class_eval do
       private
       def indexes(table_, stream_)
@@ -147,17 +147,17 @@ module RGeo
         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

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
-# Common tools for spatial adapters for ActiveRecord
-# 
+#
+# Geometry mixin for JSON serialization
+#
 # -----------------------------------------------------------------------------
-# Copyright 2010 Daniel Azuma
-# 
+# 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -35,35 +35,35 @@
 
 
 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_
@@ -77,30 +77,30 @@ module RGeo
           @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