rails-geocoder 0.9.0 → 0.9.1

data/CHANGELOG.rdoc

@@ -2,6 +2,10 @@
 
 Per-release changes to Geocoder.
 
+== 0.9.1 (2010 May 4)
+
+* Use scope instead of named_scope in Rails 3.
+
 == 0.9.0 (2010 Apr 2)
 
 * Fix bug in PostgreSQL support (caused "PGError: ERROR:  column "distance" does not exist"), reported by developish.

data/README.rdoc

@@ -1,6 +1,6 @@
 = Geocoder
 
-Geocoder adds object geocoding and database-agnostic distance calculations to Ruby on Rails. It's as simple as calling <tt>fetch_coordinates!</tt> on your objects, and then using a named scope like <tt>Venue.near("Billings, MT")</tt>.
+Geocoder adds object geocoding and database-agnostic distance calculations to Ruby on Rails. It's as simple as calling <tt>fetch_coordinates!</tt> on your objects, and then using a scope like <tt>Venue.near("Billings, MT")</tt>.
 
 Geocoder 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.
 
@@ -9,6 +9,8 @@ Geocoder does not rely on proprietary database functions so finding geocoded obj
 
 == 1. Install
 
+=== a. Rails 2
+
 Install either as a plugin:
 
   script/plugin install git://github.com/alexreisner/geocoder.git
@@ -22,6 +24,21 @@ or as a gem:
   sudo rake gems:install
 
 
+=== b. Rails 3
+
+Install either as a plugin:
+
+  rails plugin install git://github.com/alexreisner/geocoder.git
+
+or as a gem:
+
+  # add to Gemfile:
+  gem "rails-geocoder", :require => "geocoder"
+  
+  # at command prompt:
+  bundle install
+
+
 == 2. Configure
 
 A) Get a Google Maps API key (see http://code.google.com/apis/maps/signup.html) and store it in a constant:
@@ -61,7 +78,7 @@ Once +obj+ is geocoded you can do things like this:
   obj.nearbys(30)                    # other objects within 30 miles
   obj.distance_to(40.714, -100.234)  # distance to arbitrary point
 
-To find objects by location, use the following named scopes:
+To find objects by location, use the following scopes:
 
   Venue.near('Omaha, NE, US', 20)    # venues within 20 miles of Omaha
   Venue.near([40.71, 100.23], 20)    # venues within 20 miles of a point
@@ -106,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 (named 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 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.
 
 
 === Discussion
@@ -119,7 +136,7 @@ There are few options for finding objects near a given point in SQLite without i
 
 3. If you have a large number of objects (so you can't use approach #2) and you need accurate results (better than approach #1 will give), you can use a combination of the two. Get all the objects within a square around your center point, and then eliminate the ones that are too far away using <tt>Geocoder.distance_between</tt>.
 
-Because Geocoder needs to provide this functionality as a named scope, we must go with option #1, but feel free to implement #2 or #3 if you need more accuracy.
+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.
 
 
 == To-do List

data/VERSION

@@ -1 +1 @@
-0.9.0
+0.9.1

data/lib/geocoder.rb

@@ -12,22 +12,22 @@ module Geocoder
     base.extend ClassMethods
     base.class_eval do
 
-      # named scope: geocoded objects
-      named_scope :geocoded,
+      # scope: geocoded objects
+      send(Geocoder.scope_method_name, :geocoded,
         :conditions => "#{geocoder_options[:latitude]} IS NOT NULL " +
-          "AND #{geocoder_options[:longitude]} IS NOT NULL"
+          "AND #{geocoder_options[:longitude]} IS NOT NULL")
 
-      # named scope: not-geocoded objects
-      named_scope :not_geocoded,
+      # scope: not-geocoded objects
+      send(Geocoder.scope_method_name, :not_geocoded,
         :conditions => "#{geocoder_options[:latitude]} IS NULL " +
-          "OR #{geocoder_options[:longitude]} IS NULL"
+          "OR #{geocoder_options[:longitude]} IS NULL")
       
       ##
       # Find all objects within a radius (in miles) of the given location
       # (address string). Location (the first argument) may be either a string
       # to geocode or an array of coordinates (<tt>[lat,long]</tt>).
       #
-      named_scope :near, lambda{ |location, *args|
+      send(Geocoder.scope_method_name, :near, lambda{ |location, *args|
         latitude, longitude = location.is_a?(Array) ?
           location : Geocoder.fetch_coordinates(location)
         if latitude and longitude
@@ -35,7 +35,7 @@ module Geocoder
         else
           {}
         end
-      }
+      })
     end
   end
     
@@ -65,7 +65,7 @@ module Geocoder
     private # ----------------------------------------------------------------
 
     ##
-    # Named scope options hash for use with a database that supports POWER(),
+    # Scope options hash for use with a database that supports POWER(),
     # SQRT(), PI(), and trigonometric functions (SIN(), COS(), and ASIN()).
     # 
     # Taken from the excellent tutorial at:
@@ -93,7 +93,7 @@ module Geocoder
     end
 
     ##
-    # Named scope options hash for use with a database without trigonometric
+    # Scope options hash for use with a database without trigonometric
     # functions, like SQLite. Approach is to find objects within a square
     # rather than a circle, so results are very approximate (will include
     # objects outside the given radius).
@@ -164,7 +164,7 @@ module Geocoder
   
   ##
   # Get other geocoded objects within a given radius (in miles). Takes a
-  # radius (in miles) and options for passing to the +near+ named scope
+  # radius (in miles) and options for passing to the +near+ scope
   # (<tt>:order</tt>, <tt>:limit</tt>, and <tt>:offset</tt>).
   #
   def nearbys(radius = 20, options = {})
@@ -330,6 +330,13 @@ module Geocoder
       return nil
     end
   end
+  
+  ##
+  # Name of the ActiveRecord scope method.
+  #
+  def self.scope_method_name
+    Rails.version.starts_with?("3") ? :scope : :named_scope
+  end
 end
 
 ##

data/rails-geocoder.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails-geocoder}
-  s.version = "0.9.0"
+  s.version = "0.9.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Reisner"]
-  s.date = %q{2010-04-02}
+  s.date = %q{2010-05-04}
   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
-  - 0
-  version: 0.9.0
+  - 1
+  version: 0.9.1
 platform: ruby
 authors: 
 - Alex Reisner
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-02 00:00:00 -04:00
+date: 2010-05-04 00:00:00 -04:00
 default_executable: 
 dependencies: []