geokit-rails 1.1.4 → 2.0.0.rc1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjMwNjUzNmI4NzQ5M2Q2NTZiZGEwZTFkZDFlNjQ0MWE5Mzk1OGJkMQ==
+  data.tar.gz: !binary |-
+    N2E4MTgzZDk4YmVkNzIyMDg0N2RiOTMyMzdhYzgxNGVkMDZmZDgyOQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjE3ZWE2ZGY4MzkxOWFmOTc3N2RiM2U3ZTVmODdjOTQwNDgyYTQ4YjRkM2Y4
+    NmJkOWViMjUyN2I2NDcwMzBmOWUwYWE4ZmIzMGVhMGViNDFkMTRkZWI5YjNh
+    YTI4NjAyYzc4MGEwOGY2NWI1MjJhMDBkOTZiMjJkOWE4NWYxZDg=
+  data.tar.gz: !binary |-
+    MDQ1MDY2N2JjNjhkMzRiZjdhMDljMzUyNGI4NDU5YzNjMDdkNjcyNzcyN2Q2
+    YTBmODg3NWU3YzhiNWFkMjA1YzU3N2VmOTQ1MzdmNTE4M2RjZjljY2MwOTMz
+    YTQzOWY0ZGUwNDI5NWVmMjBjNjJiZmIwNjQ2MzZjNzk5NmM5NmY=

data/lib/geokit-rails.rb

@@ -1,26 +1,10 @@
-# Load modules and classes needed to automatically mix in ActiveRecord and 
-# ActionController helpers.  All other functionality must be explicitly 
-# required.
-#
-# Note that we don't explicitly require the geokit gem. 
-# You should specify gem dependencies in your config/environment.rb: config.gem "geokit"
-#
-if defined? Geokit
-  require 'geokit-rails/defaults'
-  require 'geokit-rails/adapters/abstract'
-  require 'geokit-rails/acts_as_mappable'
-  require 'geokit-rails/ip_geocode_lookup'
-  
-  # Automatically mix in distance finder support into ActiveRecord classes.
-  ActiveRecord::Base.send :include, GeoKit::ActsAsMappable
-  
-  # Automatically mix in ip geocoding helpers into ActionController classes.
-  ActionController::Base.send :include, GeoKit::IpGeocodeLookup
-else
-  message=%q(WARNING: geokit-rails requires the Geokit gem. You either don't have the gem installed,
-or you haven't told Rails to require it. If you're using a recent version of Rails: 
-  config.gem "geokit" # in config/environment.rb
-and of course install the gem: sudo gem install geokit)
-  puts message
-  Rails.logger.error message
-end
+require 'geokit'
+
+require 'geokit-rails/railtie'
+require 'geokit-rails/core_extensions'
+
+require 'geokit-rails/defaults'
+require 'geokit-rails/adapters/abstract'
+require 'geokit-rails/acts_as_mappable'
+require 'geokit-rails/geocoder_control'
+require 'geokit-rails/ip_geocode_lookup'

data/lib/geokit-rails/acts_as_mappable.rb

@@ -1,136 +1,95 @@
+require 'active_record'
+require 'active_support/concern'
+
 module Geokit
-  # Contains the class method acts_as_mappable targeted to be mixed into ActiveRecord.
-  # When mixed in, augments find services such that they provide distance calculation
-  # query services.  The find method accepts additional options:
-  #
-  # * :origin - can be 
-  #   1. a two-element array of latititude/longitude -- :origin=>[37.792,-122.393]
-  #   2. a geocodeable string -- :origin=>'100 Spear st, San Francisco, CA'
-  #   3. an object which responds to lat and lng methods, or latitude and longitude methods,
-  #      or whatever methods you have specified for lng_column_name and lat_column_name
-  #
-  # Other finder methods are provided for specific queries.  These are:
-  #
-  # * find_within (alias: find_inside)
-  # * find_beyond (alias: find_outside)
-  # * find_closest (alias: find_nearest)
-  # * find_farthest
-  #
-  # Counter methods are available and work similarly to finders.  
-  #
-  # If raw SQL is desired, the distance_sql method can be used to obtain SQL appropriate
-  # to use in a find_by_sql call.
   module ActsAsMappable
+
     class UnsupportedAdapter < StandardError ; end
-    
-    # Mix below class methods into ActiveRecord.
-    def self.included(base) # :nodoc:
-      base.extend ClassMethods
-    end
-    
-    # Class method to mix into active record.
-    module ClassMethods # :nodoc:
-      
-      # Class method to bring distance query support into ActiveRecord models.  By default
-      # uses :miles for distance units and performs calculations based upon the Haversine
-      # (sphere) formula.  These can be changed by setting Geokit::default_units and
-      # Geokit::default_formula.  Also, by default, uses lat, lng, and distance for respective
-      # column names.  All of these can be overridden using the :default_units, :default_formula,
-      # :lat_column_name, :lng_column_name, and :distance_column_name hash keys.
-      # 
-      # Can also use to auto-geocode a specific column on create. Syntax;
-      #   
-      #   acts_as_mappable :auto_geocode=>true
-      # 
-      # By default, it tries to geocode the "address" field. Or, for more customized behavior:
-      #   
-      #   acts_as_mappable :auto_geocode=>{:field=>:address,:error_message=>'bad address'}
-      #   
-      # In both cases, it creates a before_validation_on_create callback to geocode the given column.
-      # For anything more customized, we recommend you forgo the auto_geocode option
-      # and create your own AR callback to handle geocoding.
-      def acts_as_mappable(options = {})
-        metaclass = (class << self; self; end)
-
-        # Mix in the module, but ensure to do so just once.
-        return if !defined?(Geokit::Mappable) || metaclass.included_modules.include?(Geokit::ActsAsMappable::SingletonMethods)
-
-        send :extend, Geokit::ActsAsMappable::SingletonMethods
-        send :include, Geokit::Mappable
-
-        cattr_accessor :through
-        self.through = options[:through]
-
-        if reflection = Geokit::ActsAsMappable.end_of_reflection_chain(self.through, self)
-          metaclass.instance_eval do
-            [ :distance_column_name, :default_units, :default_formula, :lat_column_name, :lng_column_name, :qualified_lat_column_name, :qualified_lng_column_name ].each do |method_name|
-              define_method method_name do
-                reflection.klass.send(method_name)
+
+    # Add the +acts_as_mappable+ method into ActiveRecord subclasses
+    module Glue # :nodoc:
+      extend ActiveSupport::Concern
+
+      module ClassMethods # :nodoc:
+        def acts_as_mappable(options = {})
+          metaclass = (class << self; self; end)
+
+          include Geokit::ActsAsMappable
+
+          cattr_accessor :through
+          self.through = options[:through]
+
+          if reflection = Geokit::ActsAsMappable.end_of_reflection_chain(self.through, self)
+            metaclass.instance_eval do
+              [ :distance_column_name, :default_units, :default_formula, :lat_column_name, :lng_column_name, :qualified_lat_column_name, :qualified_lng_column_name ].each do |method_name|
+                define_method method_name do
+                  reflection.klass.send(method_name)
+                end
               end
             end
-          end
-        else
-          cattr_accessor :distance_column_name, :default_units, :default_formula, :lat_column_name, :lng_column_name, :qualified_lat_column_name, :qualified_lng_column_name
-
-          self.distance_column_name = options[:distance_column_name]  || 'distance'
-          self.default_units = options[:default_units] || Geokit::default_units
-          self.default_formula = options[:default_formula] || Geokit::default_formula
-          self.lat_column_name = options[:lat_column_name] || 'lat'
-          self.lng_column_name = options[:lng_column_name] || 'lng'
-          self.qualified_lat_column_name = "#{table_name}.#{lat_column_name}"
-          self.qualified_lng_column_name = "#{table_name}.#{lng_column_name}"
-
-          if options.include?(:auto_geocode) && options[:auto_geocode]
-            # if the form auto_geocode=>true is used, let the defaults take over by suppling an empty hash
-            options[:auto_geocode] = {} if options[:auto_geocode] == true 
-            cattr_accessor :auto_geocode_field, :auto_geocode_error_message
-            self.auto_geocode_field = options[:auto_geocode][:field] || 'address'
-            self.auto_geocode_error_message = options[:auto_geocode][:error_message] || 'could not locate address'
-
-            # set the actual callback here
-            before_validation_on_create :auto_geocode_address
+          else
+            cattr_accessor :distance_column_name, :default_units, :default_formula, :lat_column_name, :lng_column_name, :qualified_lat_column_name, :qualified_lng_column_name
+
+            self.distance_column_name = options[:distance_column_name]  || 'distance'
+            self.default_units = options[:default_units] || Geokit::default_units
+            self.default_formula = options[:default_formula] || Geokit::default_formula
+            self.lat_column_name = options[:lat_column_name] || 'lat'
+            self.lng_column_name = options[:lng_column_name] || 'lng'
+            self.qualified_lat_column_name = "#{table_name}.#{lat_column_name}"
+            self.qualified_lng_column_name = "#{table_name}.#{lng_column_name}"
+
+            if options.include?(:auto_geocode) && options[:auto_geocode]
+              # if the form auto_geocode=>true is used, let the defaults take over by suppling an empty hash
+              options[:auto_geocode] = {} if options[:auto_geocode] == true
+              cattr_accessor :auto_geocode_field, :auto_geocode_error_message
+              self.auto_geocode_field = options[:auto_geocode][:field] || 'address'
+              self.auto_geocode_error_message = options[:auto_geocode][:error_message] || 'could not locate address'
+
+              # set the actual callback here
+              before_validation :auto_geocode_address, :on => :create
+            end
           end
         end
       end
-    end
+    end # Glue
 
-    # this is the callback for auto_geocoding
-    def auto_geocode_address
-      address=self.send(auto_geocode_field).to_s
-      geo=Geokit::Geocoders::MultiGeocoder.geocode(address)
+    class Relation < ActiveRecord::Relation
+      attr_accessor :distance_formula
 
-      if geo.success
-        self.send("#{lat_column_name}=", geo.lat)
-        self.send("#{lng_column_name}=", geo.lng)
-      else
-        errors.add(auto_geocode_field, auto_geocode_error_message) 
+      def where(opts, *rest)
+        return self if opts.blank?
+        relation = clone
+        where_values = build_where(opts, rest)
+        relation.where_values += substitute_distance_in_values(where_values)
+        relation
       end
 
-      geo.success
-    end
-
-    def self.end_of_reflection_chain(through, klass)
-      while through
-        reflection = nil
-        if through.is_a?(Hash)
-          association, through = through.to_a.first
-        else
-          association, through = through, nil
-        end
+      def order(*args)
+        return self if args.blank?
+        relation = clone
+        order_values = args.flatten
+        relation.order_values += substitute_distance_in_values(order_values)
+        relation
+      end
 
-        if reflection = klass.reflect_on_association(association)
-          klass = reflection.klass
-        else
-          raise ArgumentError, "You gave #{association} in :through, but I could not find it on #{klass}."
-        end
+    private
+      def substitute_distance_in_values(values)
+        return values unless @distance_formula
+        # substitute distance with the actual distance equation
+        pattern = Regexp.new("\\b#{@klass.distance_column_name}\\b")
+        values.map {|value| value.is_a?(String) ? value.gsub(pattern, @distance_formula) : value }
       end
+    end
 
-      reflection
+    extend ActiveSupport::Concern
+
+    included do
+      include Geokit::Mappable
     end
 
-    # Instance methods to mix into ActiveRecord.
-    module SingletonMethods #:nodoc:
-      
+    # Class methods included in models when +acts_as_mappable+ is called
+    module ClassMethods
+
       # A proxy to an instance of a finder adapter, inferred from the connection's adapter.
       def adapter
         @adapter ||= begin
@@ -142,87 +101,76 @@ module Geokit
           raise UnsupportedAdapter, "`#{connection.adapter_name.downcase}` is not a supported adapter."
         end
       end
-      
-      # Extends the existing find method in potentially two ways:
-      # - If a mappable instance exists in the options, adds a distance column.
-      # - If a mappable instance exists in the options and the distance column exists in the
-      #   conditions, substitutes the distance sql for the distance column -- this saves
-      #   having to write the gory SQL.
-      def find(*args)
-        prepare_for_find_or_count(:find, args)
-        super(*args)
-      end
 
-      # Extends the existing count method by:
-      # - If a mappable instance exists in the options and the distance column exists in the
-      #   conditions, substitutes the distance sql for the distance column -- this saves
-      #   having to write the gory SQL.
-      def count(*args)
-        prepare_for_find_or_count(:count, args)
-        super(*args)
-      end
-
-      # Finds within a distance radius.
-      def find_within(distance, options={})
+      def within(distance, options = {})
         options[:within] = distance
-        find(:all, options)
+        geo_scope(options)
       end
-      alias find_inside find_within
+      alias inside within
 
-      # Finds beyond a distance radius.
-      def find_beyond(distance, options={})
+      def beyond(distance, options = {})
         options[:beyond] = distance
-        find(:all, options)
+        geo_scope(options)
       end
-      alias find_outside find_beyond
+      alias outside beyond
 
-      # Finds according to a range.  Accepts inclusive or exclusive ranges.
-      def find_by_range(range, options={})
+      def in_range(range, options = {})
         options[:range] = range
-        find(:all, options)
+        geo_scope(options)
       end
 
-      # Finds the closest to the origin.
-      def find_closest(options={})
-        find(:nearest, options)
+      def in_bounds(bounds, options = {})
+        options[:bounds] = bounds
+        geo_scope(options)
       end
-      alias find_nearest find_closest
 
-      # Finds the farthest from the origin.
-      def find_farthest(options={})
-        find(:farthest, options)
+      def by_distance(options = {})
+        geo_scope(options).order("#{distance_column_name} asc")
       end
 
-      # Finds within rectangular bounds (sw,ne).
-      def find_within_bounds(bounds, options={})
-        options[:bounds] = bounds
-        find(:all, options)
+      def closest(options = {})
+        by_distance(options).first(1)
       end
+      alias nearest closest
 
-      # counts within a distance radius.
-      def count_within(distance, options={})
-        options[:within] = distance
-        count(options)
+      def farthest(options = {})
+        by_distance(options).last(1)
       end
-      alias count_inside count_within
 
-      # Counts beyond a distance radius.
-      def count_beyond(distance, options={})
-        options[:beyond] = distance
-        count(options)
-      end
-      alias count_outside count_beyond
+      def geo_scope(options = {})
+        arel = self.is_a?(ActiveRecord::Relation) ? self : self.scoped
 
-      # Counts according to a range.  Accepts inclusive or exclusive ranges.
-      def count_by_range(range, options={})
-        options[:range] = range
-        count(options)
-      end
+        origin  = extract_origin_from_options(options)
+        units   = extract_units_from_options(options)
+        formula = extract_formula_from_options(options)
+        bounds  = extract_bounds_from_options(options)
 
-      # Finds within rectangular bounds (sw,ne).
-      def count_within_bounds(bounds, options={})
-        options[:bounds] = bounds
-        count(options)
+        if origin || bounds
+          bounds = formulate_bounds_from_distance(options, origin, units) unless bounds
+
+          if origin
+            arel.distance_formula = distance_sql(origin, units, formula)
+            
+            if arel.select_values.blank?
+              star_select = Arel::SqlLiteral.new(arel.quoted_table_name + '.*')
+              arel = arel.select(star_select)
+            end
+          end
+
+          if bounds
+            bound_conditions = bound_conditions(bounds)
+            arel = arel.where(bound_conditions) if bound_conditions
+          end
+
+          distance_conditions = distance_conditions(options)
+          arel = arel.where(distance_conditions) if distance_conditions
+
+          if self.through
+            arel = arel.includes(self.through)
+          end
+        end
+
+        arel
       end
 
       # Returns the distance calculation to be used as a display column or a condition.  This
@@ -239,218 +187,170 @@ module Geokit
 
       private
 
-        # Prepares either a find or a count action by parsing through the options and
-        # conditionally adding to the select clause for finders.
-        def prepare_for_find_or_count(action, args)
-          options = args.extract_options!
-          #options = defined?(args.extract_options!) ? args.extract_options! : extract_options_from_args!(args)
-          # Obtain items affecting distance condition.
-          origin = extract_origin_from_options(options)
-          units = extract_units_from_options(options)
-          formula = extract_formula_from_options(options)
-          bounds = extract_bounds_from_options(options)
-
-          # Only proceed if this is a geokit-related query
-          if origin || bounds
-            # if no explicit bounds were given, try formulating them from the point and distance given
-            bounds = formulate_bounds_from_distance(options, origin, units) unless bounds
-            # Apply select adjustments based upon action.
-            add_distance_to_select(options, origin, units, formula) if origin && action == :find
-            # Apply the conditions for a bounding rectangle if applicable
-            apply_bounds_conditions(options,bounds) if bounds
-            # Apply distance scoping and perform substitutions.
-            apply_distance_scope(options)
-            substitute_distance_in_conditions(options, origin, units, formula) if origin && options.has_key?(:conditions)
-            # Order by scoping for find action.
-            apply_find_scope(args, options) if action == :find
-            # Handle :through
-            apply_include_for_through(options)
-            # Unfortunatley, we need to do extra work if you use an :include. See the method for more info.
-            handle_order_with_include(options,origin,units,formula) if options.include?(:include) && options.include?(:order) && origin
-          end
+      # Override ActiveRecord::Base.relation to return an instance of Geokit::ActsAsMappable::Relation.
+      # TODO: Do we need to override JoinDependency#relation too?
+      def relation
+        # NOTE: This cannot be @relation as ActiveRecord already uses this to
+        # cache *its* Relation object
+        @_geokit_relation ||= Relation.new(self, arel_table)
+        finder_needs_type_condition? ? @_geokit_relation.where(type_condition) : @_geokit_relation
+      end
 
-          # Restore options minus the extra options that we used for the
-          # Geokit API.
-          args.push(options)
+      # If it's a :within query, add a bounding box to improve performance.
+      # This only gets called if a :bounds argument is not otherwise supplied.
+      def formulate_bounds_from_distance(options, origin, units)
+        distance = options[:within] if options.has_key?(:within)
+        distance = options[:range].last-(options[:range].exclude_end?? 1 : 0) if options.has_key?(:range)
+        if distance
+          res=Geokit::Bounds.from_point_and_radius(origin,distance,:units=>units)
+        else
+          nil
         end
+      end
 
-        def apply_include_for_through(options)
-          if self.through
-            case options[:include]
-            when Array
-              options[:include] << self.through
-            when Hash, String, Symbol
-              options[:include] = [ self.through, options[:include] ]
-            else
-              options[:include] = [ self.through ]
-            end
-          end
+      def distance_conditions(options)
+        res = if options.has_key?(:within)
+          "#{distance_column_name} <= #{options[:within]}"
+        elsif options.has_key?(:beyond)
+          "#{distance_column_name} > #{options[:beyond]}"
+        elsif options.has_key?(:range)
+          "#{distance_column_name} >= #{options[:range].first} AND #{distance_column_name} <#{'=' unless options[:range].exclude_end?} #{options[:range].last}"
         end
+        Arel::SqlLiteral.new("(#{res})") if res.present?
+      end
 
-        # If we're here, it means that 1) an origin argument, 2) an :include, 3) an :order clause were supplied.
-        # Now we have to sub some SQL into the :order clause. The reason is that when you do an :include,
-        # ActiveRecord drops the psuedo-column (specificically, distance) which we supplied for :select. 
-        # So, the 'distance' column isn't available for the :order clause to reference when we use :include.
-        def handle_order_with_include(options, origin, units, formula)
-          # replace the distance_column_name with the distance sql in order clause
-          options[:order].sub!(distance_column_name, distance_sql(origin, units, formula))
-        end
+      def bound_conditions(bounds)
+        sw,ne = bounds.sw, bounds.ne
+        lng_sql = bounds.crosses_meridian? ? "(#{qualified_lng_column_name}<#{ne.lng} OR #{qualified_lng_column_name}>#{sw.lng})" : "#{qualified_lng_column_name}>#{sw.lng} AND #{qualified_lng_column_name}<#{ne.lng}"
+        res = "#{qualified_lat_column_name}>#{sw.lat} AND #{qualified_lat_column_name}<#{ne.lat} AND #{lng_sql}"
+        Arel::SqlLiteral.new("(#{res})") if res.present?
+      end
 
-        # Looks for mapping-specific tokens and makes appropriate translations so that the 
-        # original finder has its expected arguments.  Resets the the scope argument to 
-        # :first and ensures the limit is set to one.
-        def apply_find_scope(args, options)
-          case args.first
-            when :nearest, :closest
-              args[0] = :first
-              options[:limit] = 1
-              options[:order] = "#{distance_column_name} ASC"
-            when :farthest
-              args[0] = :first
-              options[:limit] = 1
-              options[:order] = "#{distance_column_name} DESC"
-          end
-        end
+      # Extracts the origin instance out of the options if it exists and returns
+      # it.  If there is no origin, looks for latitude and longitude values to
+      # create an origin.  The side-effect of the method is to remove these
+      # option keys from the hash.
+      def extract_origin_from_options(options)
+        origin = options.delete(:origin)
+        res = normalize_point_to_lat_lng(origin) if origin
+        res
+      end
 
-        # If it's a :within query, add a bounding box to improve performance.
-        # This only gets called if a :bounds argument is not otherwise supplied. 
-        def formulate_bounds_from_distance(options, origin, units)
-          distance = options[:within] if options.has_key?(:within)
-          distance = options[:range].last-(options[:range].exclude_end?? 1 : 0) if options.has_key?(:range)
-          if distance
-            res=Geokit::Bounds.from_point_and_radius(origin,distance,:units=>units)
-          else 
-            nil
-          end
-        end
+      # Extract the units out of the options if it exists and returns it.  If
+      # there is no :units key, it uses the default.  The side effect of the
+      # method is to remove the :units key from the options hash.
+      def extract_units_from_options(options)
+        units = options[:units] || default_units
+        options.delete(:units)
+        units
+      end
 
-        # Replace :within, :beyond and :range distance tokens with the appropriate distance 
-        # where clauses.  Removes these tokens from the options hash.
-        def apply_distance_scope(options)
-          distance_condition = if options.has_key?(:within)
-            "#{distance_column_name} <= #{options[:within]}"
-          elsif options.has_key?(:beyond)
-            "#{distance_column_name} > #{options[:beyond]}"
-          elsif options.has_key?(:range)
-            "#{distance_column_name} >= #{options[:range].first} AND #{distance_column_name} <#{'=' unless options[:range].exclude_end?} #{options[:range].last}"
-          end
+      # Extract the formula out of the options if it exists and returns it.  If
+      # there is no :formula key, it uses the default.  The side effect of the
+      # method is to remove the :formula key from the options hash.
+      def extract_formula_from_options(options)
+        formula = options[:formula] || default_formula
+        options.delete(:formula)
+        formula
+      end
 
-          if distance_condition
-            [:within, :beyond, :range].each { |option| options.delete(option) }
-            options[:conditions] = merge_conditions(options[:conditions], distance_condition)
-          end
-        end
+      def extract_bounds_from_options(options)
+        bounds = options.delete(:bounds)
+        bounds = Geokit::Bounds.normalize(bounds) if bounds
+      end
 
-        # Alters the conditions to include rectangular bounds conditions.
-        def apply_bounds_conditions(options,bounds)
-          sw,ne = bounds.sw, bounds.ne
-          lng_sql = bounds.crosses_meridian? ? "(#{qualified_lng_column_name}<#{ne.lng} OR #{qualified_lng_column_name}>#{sw.lng})" : "#{qualified_lng_column_name}>#{sw.lng} AND #{qualified_lng_column_name}<#{ne.lng}"
-          bounds_sql = "#{qualified_lat_column_name}>#{sw.lat} AND #{qualified_lat_column_name}<#{ne.lat} AND #{lng_sql}"
-          options[:conditions] = merge_conditions(options[:conditions], bounds_sql)
-        end
+      # Geocode IP address.
+      def geocode_ip_address(origin)
+        geo_location = Geokit::Geocoders::MultiGeocoder.geocode(origin)
+        return geo_location if geo_location.success
+        raise Geokit::Geocoders::GeocodeError
+      end
 
-        # Extracts the origin instance out of the options if it exists and returns
-        # it.  If there is no origin, looks for latitude and longitude values to 
-        # create an origin.  The side-effect of the method is to remove these 
-        # option keys from the hash.
-        def extract_origin_from_options(options)
-          origin = options.delete(:origin)
-          res = normalize_point_to_lat_lng(origin) if origin
-          res
-        end
-        
-        # Extract the units out of the options if it exists and returns it.  If
-        # there is no :units key, it uses the default.  The side effect of the 
-        # method is to remove the :units key from the options hash.
-        def extract_units_from_options(options)
-          units = options[:units] || default_units
-          options.delete(:units)
-          units
-        end
+      # Given a point in a variety of (an address to geocode,
+      # an array of [lat,lng], or an object with appropriate lat/lng methods, an IP addres)
+      # this method will normalize it into a Geokit::LatLng instance. The only thing this
+      # method adds on top of LatLng#normalize is handling of IP addresses
+      def normalize_point_to_lat_lng(point)
+        res = geocode_ip_address(point) if point.is_a?(String) && /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})?$/.match(point)
+        res = Geokit::LatLng.normalize(point) unless res
+        res
+      end
 
-        # Extract the formula out of the options if it exists and returns it.  If
-        # there is no :formula key, it uses the default.  The side effect of the 
-        # method is to remove the :formula key from the options hash.
-        def extract_formula_from_options(options)
-          formula = options[:formula] || default_formula
-          options.delete(:formula)
-          formula
+      # Looks for the distance column and replaces it with the distance sql. If an origin was not
+      # passed in and the distance column exists, we leave it to be flagged as bad SQL by the database.
+      # Conditions are either a string or an array.  In the case of an array, the first entry contains
+      # the condition.
+      def substitute_distance_in_where_values(arel, origin, units=default_units, formula=default_formula)
+        pattern = Regexp.new("\\b#{distance_column_name}\\b")
+        value   = distance_sql(origin, units, formula)
+        arel.where_values.map! do |where_value|
+          if where_value.is_a?(String)
+            where_value.gsub(pattern, value)
+          else
+            where_value
+          end
         end
+        arel
+      end
 
-        def extract_bounds_from_options(options)
-          bounds = options.delete(:bounds)
-          bounds = Geokit::Bounds.normalize(bounds) if bounds
-        end
+      # Returns the distance SQL using the spherical world formula (Haversine).  The SQL is tuned
+      # to the database in use.
+      def sphere_distance_sql(origin, units)
+        lat = deg2rad(origin.lat)
+        lng = deg2rad(origin.lng)
+        multiplier = units_sphere_multiplier(units)
 
-        # Geocode IP address.
-        def geocode_ip_address(origin)
-          geo_location = Geokit::Geocoders::MultiGeocoder.geocode(origin)
-          return geo_location if geo_location.success
-          raise Geokit::Geocoders::GeocodeError
-        end
+        adapter.sphere_distance_sql(lat, lng, multiplier) if adapter
+      end
 
-        # Given a point in a variety of (an address to geocode,
-        # an array of [lat,lng], or an object with appropriate lat/lng methods, an IP addres)
-        # this method will normalize it into a Geokit::LatLng instance. The only thing this
-        # method adds on top of LatLng#normalize is handling of IP addresses
-        def normalize_point_to_lat_lng(point)
-          res = geocode_ip_address(point) if point.is_a?(String) && /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})?$/.match(point)
-          res = Geokit::LatLng.normalize(point) unless res
-          res
-        end
+      # Returns the distance SQL using the flat-world formula (Phythagorean Theory).  The SQL is tuned
+      # to the database in use.
+      def flat_distance_sql(origin, units)
+        lat_degree_units = units_per_latitude_degree(units)
+        lng_degree_units = units_per_longitude_degree(origin.lat, units)
 
-        # Augments the select with the distance SQL.
-        def add_distance_to_select(options, origin, units=default_units, formula=default_formula)
-          if origin
-            distance_selector = distance_sql(origin, units, formula) + " AS #{distance_column_name}"
-            selector = options.has_key?(:select) && options[:select] ? options[:select] : "*"
-            options[:select] = "#{selector}, #{distance_selector}"  
-          end
-        end
+        adapter.flat_distance_sql(origin, lat_degree_units, lng_degree_units)
+      end
 
-        # Looks for the distance column and replaces it with the distance sql. If an origin was not 
-        # passed in and the distance column exists, we leave it to be flagged as bad SQL by the database.
-        # Conditions are either a string or an array.  In the case of an array, the first entry contains
-        # the condition.
-        def substitute_distance_in_conditions(options, origin, units=default_units, formula=default_formula)
-          condition = options[:conditions].is_a?(String) ? options[:conditions] : options[:conditions].first
-          pattern = Regexp.new("\\b#{distance_column_name}\\b")
-          condition.gsub!(pattern, distance_sql(origin, units, formula))
-        end
+    end # ClassMethods
 
-        # Returns the distance SQL using the spherical world formula (Haversine).  The SQL is tuned
-        # to the database in use.
-        def sphere_distance_sql(origin, units)
-          lat = deg2rad(origin.lat)
-          lng = deg2rad(origin.lng)
-          multiplier = units_sphere_multiplier(units)
+    # this is the callback for auto_geocoding
+    def auto_geocode_address
+      address=self.send(auto_geocode_field).to_s
+      geo=Geokit::Geocoders::MultiGeocoder.geocode(address)
 
-          adapter.sphere_distance_sql(lat, lng, multiplier) if adapter
+      if geo.success
+        self.send("#{lat_column_name}=", geo.lat)
+        self.send("#{lng_column_name}=", geo.lng)
+      else
+        errors.add(auto_geocode_field, auto_geocode_error_message)
+      end
+
+      geo.success
+    end
+
+    def self.end_of_reflection_chain(through, klass)
+      while through
+        reflection = nil
+        if through.is_a?(Hash)
+          association, through = through.to_a.first
+        else
+          association, through = through, nil
         end
-        
-        # Returns the distance SQL using the flat-world formula (Phythagorean Theory).  The SQL is tuned
-        # to the database in use.
-        def flat_distance_sql(origin, units)
-          lat_degree_units = units_per_latitude_degree(units)
-          lng_degree_units = units_per_longitude_degree(origin.lat, units)
-          
-          adapter.flat_distance_sql(origin, lat_degree_units, lng_degree_units)
+
+        if reflection = klass.reflect_on_association(association)
+          klass = reflection.klass
+        else
+          raise ArgumentError, "You gave #{association} in :through, but I could not find it on #{klass}."
         end
+      end
+
+      reflection
     end
-  end
-end
-
-# Extend Array with a sort_by_distance method.
-class Array
-  # This method creates a "distance" attribute on each object, calculates the
-  # distance from the passed origin, and finally sorts the array by the
-  # resulting distance.
-  def sort_by_distance_from(origin, opts={})
-    distance_attribute_name = opts.delete(:distance_attribute_name) || 'distance'
-    self.each do |e|
-      e.class.send(:attr_accessor, distance_attribute_name) if !e.respond_to?("#{distance_attribute_name}=")
-      e.send("#{distance_attribute_name}=", e.distance_to(origin,opts))
-    end
-    self.sort!{|a,b|a.send(distance_attribute_name) <=> b.send(distance_attribute_name)}
-  end
-end
+
+  end # ActsAsMappable
+end # Geokit
+
+
+
+# ActiveRecord::Base.extend Geokit::ActsAsMappable