acts_as_geocodable 2.0.2 → 2.0.3

data/README.textile

@@ -0,0 +1,129 @@
+h1. acts_as_geocodable
+
+acts_as_geocodable helps you build geo-aware applications. It automatically geocodes your models when they are saved, giving you the ability to search by location and calculate distances between records.
+
+*Beginning with version 2, we require Rails 3.  Use one of the 1.0.x tags to work with Rails 2.3.*
+
+We've adopted the ARel style syntax for finding records.
+
+h2. Usage
+
+<pre><code>event = Event.create :street => "777 NE Martin Luther King, Jr. Blvd.",
+  :locality => "Portland", :region => "Oregon", :postal_code => 97232
+
+event.geocode.latitude                                #=> 45.529100000000
+event.geocode.longitude                               #=> -122.644200000000
+
+event.distance_to "49423"                             #=> 1807.66560483205
+
+Event.origin("97232", :within => 50)
+
+Event.origin("Portland, OR").nearest</code></pre>
+
+h2. Installation
+
+Install as a gem
+
+<pre><code>gem install acts_as_geocodable</code></pre>
+
+or add it to your Gemfile
+
+<pre><code>gem 'acts_as_geocodable'</code></pre>
+
+"Graticule":http://github.com/collectiveidea/graticule is used for all the heavy lifting and will be installed too.
+
+h2. Upgrading
+
+Before October 2008, precision wasn't included in the @Geocode@ model. Make sure you add a string precision column to your geocode table if you're upgrading from an older version, and update Graticule.
+
+Also, if you're upgrading from a previous version of this plugin, note that @:city@ has been renamed to @:locality@ to be consistent with Graticule 0.2.  Create a migration that has:
+
+<pre><code>rename_column :geocodes, :city, :locality</code></pre>
+
+Also remember to change your mapping in your geocodable classes to use the @:locality@ key instead of @:city@:
+
+<pre><code>class Event < ActiveRecord::Base
+  acts_as_geocodable :address => {:street => :address1, :locality => :city,
+    :region => :state, :postal_code => :zip}
+end</code></pre>
+
+h2. Configuration
+
+Create the required tables
+
+<pre><code>rails generate acts_as_geocodable
+rake db:migrate</code></pre>
+
+Set the default geocoder in your environment.rb file.
+
+<pre><code>Geocode.geocoder = Graticule.service(:yahoo).new 'your_api_key'</code></pre>
+
+Then, in each model you want to make geocodable, add @acts_as_geocodable@.
+
+<pre><code>class Event < ActiveRecord::Base
+  acts_as_geocodable
+end</code></pre>
+
+The only requirement is that your model must have address fields. By default, acts_as_geocodable looks for attributes called +street+, +locality+, +region+, +postal_code+, and +country+.  To change these, you can provide a mapping in the @:address@ option:
+
+<pre><code>class Event < ActiveRecord::Base
+  acts_as_geocodable :address => {:street => :address1, :locality => :city, :region => :state, :postal_code => :zip}
+end</code></pre>
+
+If that doesn't meet your needs, simply override the default @to_location@ method in your model, and return a @Graticule::Location@ with those attributes set.
+
+acts_as_geocodable can also update your address fields with the data returned from the geocoding service:
+
+<pre><code>class Event < ActiveRecord::Base
+  acts_as_geocodable :normalize_address => true
+end</code></pre>
+
+h2. IP-based Geocoding
+
+acts_as_geocodable adds a @remote_location@ method in your controllers that uses http://hostip.info to guess remote users location based on their IP address.
+
+<pre><code>def index
+  @nearest = Store.origin(remote_location).nearest if remote_location
+  @stores = Store.all
+end</code></pre>
+
+Keep in mind that IP-based geocoding is not always accurate, and often will not return any results.
+
+h2. Contributing
+
+In the spirit of "free software":http://www.fsf.org/licensing/essays/free-sw.html, **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* using alpha, beta, and prerelease versions
+* reporting bugs
+* suggesting new features
+* writing or editing documentation
+* writing specifications
+* writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* refactoring code
+* closing "issues":https://github.com/collectiveidea/acts_as_geocodable/issues/
+* reviewing patches
+
+h2. Submitting an Issue
+
+We use the "GitHub issue tracker":https://github.com/collectiveidea/acts_as_geocodable/issues/ to track bugs
+and features. Before submitting a bug report or feature request, check to make sure it hasn't already
+been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
+bug report, please include a "Gist":https://gist.github.com/ that includes a stack trace and any
+details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
+operating system. Ideally, a bug report should include a pull request with failing specs.
+
+h2. Submitting a Pull Request
+
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add specs for your feature or bug fix.
+5. Run @bundle exec rake@. If your changes are not 100% covered and passing, go back to step 4.
+6. Commit and push your changes.
+7. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+h3. To Do
+
+* configurable formulas

data/lib/acts_as_geocodable.rb

@@ -37,8 +37,13 @@ module ActsAsGeocodable #:nodoc:
       :units => :miles
     }.merge(options)
 
-    write_inheritable_attribute :acts_as_geocodable_options, options
-    class_inheritable_reader :acts_as_geocodable_options
+    if ActiveRecord::VERSION::MAJOR >= 3
+      class_attribute :acts_as_geocodable_options
+      self.acts_as_geocodable_options = options
+    else
+      write_inheritable_attribute :acts_as_geocodable_options, options
+      class_inheritable_reader :acts_as_geocodable_options
+    end
 
     define_callbacks :geocoding
 

data/lib/acts_as_geocodable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsGeocodable
-  VERSION = '2.0.2' unless defined?(::ActsAsGeocodable::VERSION)
+  VERSION = '2.0.3' unless defined?(::ActsAsGeocodable::VERSION)
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_geocodable
 version: !ruby/object:Gem::Version 
-  hash: 11
-  prerelease: false
+  hash: 9
+  prerelease: 
   segments: 
   - 2
   - 0
-  - 2
-  version: 2.0.2
+  - 3
+  version: 2.0.3
 platform: ruby
 authors: 
 - Daniel Morrison
@@ -17,8 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-06 00:00:00 -05:00
-default_executable: 
+date: 2011-11-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -34,121 +33,16 @@ dependencies:
         version: 2.0.0
   requirement: *id001
   type: :runtime
-  name: graticule
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id002
-  type: :development
-  name: rails
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 2
-        - 5
-        version: 1.2.5
-  requirement: *id003
-  type: :development
-  name: sqlite3-ruby
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 45
-        segments: 
-        - 2
-        - 8
-        - 1
-        version: 2.8.1
-  requirement: *id004
-  type: :development
-  name: mysql
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31098209
-        segments: 
-        - 2
-        - 0
-        - 0
-        - beta
-        version: 2.0.0.beta
-  requirement: *id005
-  type: :development
-  name: rspec
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id006
-  type: :development
-  name: factory_girl
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id007
-  type: :development
-  name: database_cleaner
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id008
-  type: :development
-  name: ruby-debug
   prerelease: false
+  name: graticule
 description: Simple geocoding for Rails ActiveRecord models. See the README for more details.
 email: info@collectiveidea.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+
 files: 
 - lib/acts_as_geocodable/geocode.rb
 - lib/acts_as_geocodable/geocoding.rb
@@ -160,8 +54,7 @@ files:
 - lib/generators/acts_as_geocodable/USAGE
 - CHANGELOG
 - MIT-LICENSE
-- README
-has_rdoc: true
+- README.textile
 homepage: http://github.com/collectiveidea/acts_as_geocodable
 licenses: []
 
@@ -191,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Simple geocoding for Rails ActiveRecord models

data/README

@@ -1,98 +0,0 @@
-= acts_as_geocodable
-
-acts_as_geocodable helps you build geo-aware applications. It automatically geocodes your models when they are saved, giving you the ability to search by location and calculate distances between records.
-
-Beginning with version 2, we require Rails 3.  Use one of the 1.0.x tags to work with Rails 2.3.
-
-Also, we've adopted the ARel style syntax for finding records.
-
-== Usage
-
-  event = Event.create :street => "777 NE Martin Luther King, Jr. Blvd.",
-    :locality => "Portland", :region => "Oregon", :postal_code => 97232
-
-  event.geocode.latitude                                #=> 45.529100000000
-  event.geocode.longitude                               #=> -122.644200000000
-
-  event.distance_to "49423"                             #=> 1807.66560483205
-
-  Event.origin("97232", :within => 50)
-
-  Event.origin("Portland, OR").nearest
-
-== Installation
-
-Install as a gem
-
-  gem install acts_as_geocodable
-
-Graticule[link:http://rubyforge.org/projects/graticule] is used for all the heavy lifting and will be installed too.
-
-== Upgrading
-
-Before October 2008, precision wasn't included in the Geocode model. Make sure you add a string precision column to your geocode table if you're upgrading from an older version, and update Graticule.
-
-Also, if you're upgrading from a previous version of this plugin, note that :city has been renamed to :locality to be consistent with Graticule 0.2.  Create a migration that has:
-
-  rename_column :geocodes, :city, :locality
-
-Also remember to change your mapping in your geocodable classes to use the :locality key instead of :city:
-
-class Event < ActiveRecord::Base
-  acts_as_geocodable :address => {:street => :address1, :locality => :city,
-    :region => :state, :postal_code => :zip}
-end
-
-== Configuration
-
-Create the required tables
-
-  rails generate acts_as_geocodable
-  rake db:migrate
-
-Set the default geocoder in your environment.rb file.
-
-  Geocode.geocoder = Graticule.service(:yahoo).new 'your_api_key'
-
-Then, in each model you want to make geocodable, add acts_as_geocodable.
-
-  class Event < ActiveRecord::Base
-    acts_as_geocodable
-  end
-
-The only requirement is that your model must have address fields. By default, acts_as_geocodable looks for attributes called +street+, +locality+, +region+, +postal_code+, and +country+.  To change these, you can provide a mapping in the <tt>:address</tt> option:
-
-  class Event < ActiveRecord::Base
-    acts_as_geocodable :address => {:street => :address1, :locality => :city, :region => :state, :postal_code => :zip}
-  end
-
-If that doesn't meet your needs, simply override the default +to_location+ method in your model, and return a Graticule::Location with those attributes set.
-
-acts_as_geocodable can also update your address fields with the data returned from the geocoding service:
-
-  class Event < ActiveRecord::Base
-    acts_as_geocodable :normalize_address => true
-  end
-
-== IP-based Geocoding
-
-acts_as_geocodable adds a remote_location method in your controllers that uses http://hostip.info to guess remote users location based on their IP address.
-
-  def index
-    @nearest = Store.origin(remote_location).nearest if remote_location
-    @stores = Store.all
-  end
-
-Keep in mind that IP-based geocoding is not always accurate, and often will not return any results.
-
-== Development
-
-The source code is available at:
-   http://github.com/collectiveidea/acts_as_geocodable
-   git://github.com/collectiveidea/acts_as_geocodable.git
-
-Patches and suggestions are welcome!
-
-== To Do
-
-* configurable formulas