rails-geocoder 0.9.2 → 0.9.3

data/CHANGELOG.rdoc

@@ -2,6 +2,12 @@
 
 Per-release changes to Geocoder.
 
+== 0.9.3 (2010 Aug 2)
+
+* Fix incompatibility with Rails 3 RC 1.
+* Deprecate 'options' argument to 'nearbys' method.
+* Allow inclusion of 'nearbys' in Arel method chains.
+
 == 0.9.2 (2010 Jun 3)
 
 * Fix LIMIT clause bug in PostgreSQL (reported by kenzie).

data/README.rdoc

@@ -123,7 +123,7 @@ Please see the code for more methods and detailed information about arguments (e
 
 == SQLite
 
-SQLite's lack of trigonometric functions means Geocoder's default implementation of the +near+ method (scope) does not work. When using SQLite, Geocoder will automatically use a less accurate algorithm for finding objects near a given point. Results of this algorithm should not be trusted too much as it will return objects that are outside the given radius.
+SQLite's lack of trigonometric functions requires an alternate implementation of the +near+ method (scope). When using SQLite, Geocoder will automatically use a less accurate algorithm for finding objects near a given point. Results of this algorithm should not be trusted too much as it will return objects that are outside the given radius.
 
 
 === Discussion
@@ -139,8 +139,21 @@ There are few options for finding objects near a given point in SQLite without i
 Because Geocoder needs to provide this functionality as a scope, we must go with option #1, but feel free to implement #2 or #3 if you need more accuracy.
 
 
+== Known Issue
+
+You cannot use the +near+ scope with another scope that provides an +includes+ option because the +SELECT+ clause generated by +near+ will overwrite it (or vice versa). Instead, try using +joins+ and pass a <tt>:select</tt> option to the +near+ scope to get the columns you want. For example, in Rails 2 syntax:
+
+  # instead of :includes => :venues:
+  City.near("Omaha, NE", 20, :select => "venues.*").all(:joins => :venues)
+
+If anyone has a more elegant solution to this problem I am very interested in seeing it.
+
+
 == To-do List
 
+* make 'near' scope work with 'select' options
+* prepend table names to column names in SQL distance expression (required
+  to do joins on another geocoded model)
 * prevent NameError when GOOGLE_MAPS_API_KEY is missing: show nice msg
 * <tt>install.rb</tt> should do some setup when installed as a plugin
   * create initializer with GOOGLE_MAPS_API_KEY?

data/VERSION

@@ -1 +1 @@
-0.9.2
+0.9.3

data/lib/geocoder.rb

@@ -52,6 +52,7 @@ module Geocoder
     # +order+     :: column(s) for ORDER BY SQL clause
     # +limit+     :: number of records to return (for LIMIT SQL clause)
     # +offset+    :: number of records to skip (for OFFSET SQL clause)
+    # +select+    :: string with the SELECT SQL fragment (e.g. “id, name”)
     #
     def near_scope_options(latitude, longitude, radius = 20, options = {})
       if ActiveRecord::Base.connection.adapter_name == "SQLite"
@@ -82,10 +83,7 @@ module Geocoder
         "POWER(SIN((#{longitude} - #{lon_attr}) * " +
         "PI() / 180 / 2), 2) ))"
       default_near_scope_options(latitude, longitude, radius, options).merge(
-        :select => "*, #{distance} AS distance",
-        :conditions => \
-          ["#{lat_attr} BETWEEN ? AND ? AND #{lon_attr} BETWEEN ? AND ?"] +
-          coordinate_bounds(latitude, longitude, radius),
+        :select => "#{options[:select] || '*'}, #{distance} AS distance",
         :having => "#{distance} <= #{radius}"
       )
     end
@@ -97,12 +95,8 @@ module Geocoder
     # objects outside the given radius).
     #
     def approx_near_scope_options(latitude, longitude, radius, options)
-      lat_attr = geocoder_options[:latitude]
-      lon_attr = geocoder_options[:longitude]
       default_near_scope_options(latitude, longitude, radius, options).merge(
-        :conditions => \
-          ["#{lat_attr} BETWEEN ? AND ? AND #{lon_attr} BETWEEN ? AND ?"] +
-          coordinate_bounds(latitude, longitude, radius)
+        :select => options[:select] || nil
       )
     end
     
@@ -110,10 +104,29 @@ module Geocoder
     # Options used for any near-like scope.
     #
     def default_near_scope_options(latitude, longitude, radius, options)
+      lat_attr = geocoder_options[:latitude]
+      lon_attr = geocoder_options[:longitude]
+      conditions = \
+        ["#{lat_attr} BETWEEN ? AND ? AND #{lon_attr} BETWEEN ? AND ?"] +
+        coordinate_bounds(latitude, longitude, radius)
+      
+      # Handle conditions. Passing of conditions by developers is deprecated
+      # but we will still need to handle conditions so, for example, we can
+      # exclude objects by ID from the nearbys method. This is incredibly
+      # ugly and doesn't work for a conditions hash: try using Arel?
+      if options[:conditions].is_a?(String)
+        options[:conditions] = [options[:conditions]]
+      end
+      if options[:conditions].is_a?(Array)
+        conditions[0] = "(#{conditions[0]}) AND #{options[:conditions][0]}"
+        conditions << options[:conditions][1]
+      end
+      
       {
         :order  => options[:order],
         :limit  => options[:limit],
-        :offset => options[:offset]
+        :offset => options[:offset],
+        :conditions => conditions
       }
     end
     
@@ -165,9 +178,17 @@ module Geocoder
   # (<tt>:order</tt>, <tt>:limit</tt>, and <tt>:offset</tt>).
   #
   def nearbys(radius = 20, options = {})
+    if options != {}
+      warn "DEPRECATION WARNING: The 'options' argument to the nearbys " +
+        "method is deprecated and will be removed from rails-geocoder in " +
+        "version 0.9.4. Nearbys now returns a scope so you should specify " +
+        "more scopes and/or conditions via chaining. For example: " +
+        "city.nearbys(20).order('name').limit(10). Support for Rails 2.x " +
+        "will be discontinued after rails-geocoder 0.9.3."
+    end
     return [] unless geocoded?
-    options = {:conditions => ["id != ?", id]}.merge(options)
-    self.class.near(read_coordinates, radius, options) - [self]
+    options.reverse_merge!(:conditions => ["id != ?", id])
+    self.class.near(read_coordinates, radius, options)
   end
   
   ##
@@ -175,14 +196,15 @@ module Geocoder
   # coordinates as an array: <tt>[lat, lon]</tt>.
   #
   def fetch_coordinates(save = false)
-    location = send(self.class.geocoder_options[:method_name])
-    returning Geocoder.fetch_coordinates(location) do |c|
-      unless c.blank?
-        method = (save ? "update" : "write") + "_attribute"
-        send method, self.class.geocoder_options[:latitude], c[0]
-        send method, self.class.geocoder_options[:longitude], c[1]
-      end
+    coords = Geocoder.fetch_coordinates(
+      send(self.class.geocoder_options[:method_name])
+    )
+    unless coords.blank?
+      method = (save ? "update" : "write") + "_attribute"
+      send method, self.class.geocoder_options[:latitude],  coords[0]
+      send method, self.class.geocoder_options[:longitude], coords[1]
     end
+    coords
   end
 
   ##

data/rails-geocoder.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails-geocoder}
-  s.version = "0.9.2"
+  s.version = "0.9.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Reisner"]
-  s.date = %q{2010-06-03}
+  s.date = %q{2010-08-02}
   s.description = %q{Geocoder adds object geocoding and database-agnostic distance calculations to Ruby on Rails. It does not rely on proprietary database functions so finding geocoded objects in a given area is easily done using out-of-the-box MySQL or even SQLite.}
   s.email = %q{alex@alexreisner.com}
   s.extra_rdoc_files = [

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 9
-  - 2
-  version: 0.9.2
+  - 3
+  version: 0.9.3
 platform: ruby
 authors: 
 - Alex Reisner
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-03 00:00:00 -04:00
+date: 2010-08-02 00:00:00 -04:00
 default_executable: 
 dependencies: []