activerecord-postgres-earthdistance 0.1.0 → 0.2.0

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format d

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+
+branches:
+  only:
+    - master

data/Gemfile

@@ -1,11 +1,5 @@
-source :gemcutter
+source "http://rubygems.org"
 
-gem 'rails', '>= 3.0.0'
-gem 'pg', '>= 0.11'
-
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.2"
-  gem "rcov", ">= 0"
-end
+# specify gem dependencies in activerecord-postgres-earthdistance.gemspec
+# except the platform-specific dependencies below
+gemspec

data/Gemfile.lock

@@ -1,84 +1,107 @@
+PATH
+  remote: .
+  specs:
+    activerecord-postgres-earthdistance (0.2.0)
+      pg
+      rails (>= 3.1)
+      rake
+
 GEM
   remote: http://rubygems.org/
   specs:
-    abstract (1.0.0)
-    actionmailer (3.0.7)
-      actionpack (= 3.0.7)
-      mail (~> 2.2.15)
-    actionpack (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.5.0)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.14)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.7)
-      activesupport (= 3.0.7)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activerecord (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-    activesupport (3.0.7)
-    arel (2.0.10)
-    builder (2.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    git (1.2.5)
-    i18n (0.5.0)
-    jeweler (1.6.2)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-    mail (2.2.19)
-      activesupport (>= 2.3.6)
+    actionmailer (3.2.11)
+      actionpack (= 3.2.11)
+      mail (~> 2.4.4)
+    actionpack (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+    activerecord (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.6)
+    mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
-    pg (0.11.0)
-    polyglot (0.3.1)
-    rack (1.2.3)
-    rack-mount (0.6.14)
-      rack (>= 1.0.0)
-    rack-test (0.5.7)
+    mime-types (1.20.1)
+    multi_json (1.5.0)
+    pg (0.14.1)
+    polyglot (0.3.3)
+    rack (1.4.4)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
       rack (>= 1.0)
-    rails (3.0.7)
-      actionmailer (= 3.0.7)
-      actionpack (= 3.0.7)
-      activerecord (= 3.0.7)
-      activeresource (= 3.0.7)
-      activesupport (= 3.0.7)
+    rails (3.2.11)
+      actionmailer (= 3.2.11)
+      actionpack (= 3.2.11)
+      activerecord (= 3.2.11)
+      activeresource (= 3.2.11)
+      activesupport (= 3.2.11)
       bundler (~> 1.0)
-      railties (= 3.0.7)
-    railties (3.0.7)
-      actionpack (= 3.0.7)
-      activesupport (= 3.0.7)
+      railties (= 3.2.11)
+    railties (3.2.11)
+      actionpack (= 3.2.11)
+      activesupport (= 3.2.11)
+      rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
-      thor (~> 0.14.4)
-    rake (0.9.2)
-    rcov (0.9.9)
-    shoulda (2.11.3)
-    thor (0.14.6)
-    treetop (1.4.9)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.17.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.27)
+    tzinfo (0.3.35)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.6.2)
-  pg (>= 0.11)
-  rails (>= 3.0.0)
-  rcov
-  shoulda
+  activerecord-postgres-earthdistance!
+  bundler
+  rdoc
+  rspec (~> 2.11)

data/README.md

@@ -0,0 +1,124 @@
+#ActiveRecord + PostgreSQL Earthdistance [![Build Status](https://secure.travis-ci.org/softa/activerecord-postgres-earthdistance.png?branch=master)](http://travis-ci.org/softa/activerecord-postgres-earthdistance)
+
+Check distances with latitude and longitude using PostgreSQL special indexes.
+This gem enables your model to query the database using the earthdistance extension. This should be much faster than using trigonometry functions over standart indexs.
+
+##Requirements
+
+Postgresql 9.1+ with contrib and Rails 3.1+
+On Ubuntu, this is easy: `sudo apt-get install postgresql-contrib-9.1`
+
+On Mac you have a couple of options:
+
+* [the binary package kindly provided by EnterpriseDB](http://www.enterprisedb.com/products-services-training/pgdownload#osx)
+* [Homebrew’s](https://github.com/mxcl/homebrew) Postgres installation also includes the contrib packages: `brew install postgres`
+* [Postgres.app](http://postgresapp.com/)
+
+##Install
+
+
+Earthdistance is a PostgreSQL contrib module, [check it out first](http://www.postgresql.org/docs/9.2/static/earthdistance.html).
+
+Then, just add this to your Gemfile:
+
+`gem 'activerecord-postgres-earthdistance'`
+
+And run your bundler:
+
+`bundle install`
+
+Now you need to create a migration that adds earthdistance support for your
+PostgreSQL database:
+
+`rails g earthdistance:setup`
+
+Run it:
+
+`rake db:migrate`
+
+Now let's add some gist indexes to make queries ultra-fast.
+For the model Place we could create an index over the lat and lng fields:
+
+`rails g migration add_index_to_places`
+
+Edit the created migration:
+
+```ruby
+class AddIndexToPlaces < ActiveRecord::Migration
+  def change
+    add_earthdistance_index :places
+  end 
+end
+```
+
+This will create the index with a SQL like this:
+```sql
+CREATE INDEX places_earthdistance_ix ON places USING GIST (ll_to_earth(lat, lng));
+```
+
+##Usage
+
+This gem only provides a custom serialization coder.
+If you want to use it just put in your Gemfile:
+
+    gem 'activerecord-postgres-earthdistance'
+
+Now add a line (for each earthdistance column) on the model you have your earthdistance columns.
+Assuming a model called **Person**, with a **data** field on it, the
+code should look like:
+
+```ruby
+class Place < ActiveRecord::Base
+  acts_as_geolocated
+end
+```
+
+This way, you will automatically look for columns with names such as lat/latitude and lng/longitude.
+But you can use alternative names passing them as:
+
+```ruby
+class Place < ActiveRecord::Base
+  acts_as_geolocated lat: 'latitude_column_name', lng: 'longitude_column_name'
+end
+```
+
+###Querying the database
+
+To query for all places within a given radius of 100 meters from the origin 30,50 just use:
+```ruby
+Place.within_radius(500, 30, 50).all
+```
+
+##Test Database
+
+To have earthdistance enabled when you load your database schema (as happens in rake db:test:prepare), you
+have two options.
+
+The first option is creating a template database with earthdistance installed and set the template option
+in database.yml to that database.
+
+The second option is to uncomment or add the following line in config/application.rb
+
+    config.active_record.schema_format = :sql
+
+This will change your schema dumps from Ruby to SQL. If you're
+unsure about the implications of this change, we suggest reading this
+[Rails Guide](http://guides.rubyonrails.org/migrations.html#schema-dumping-and-you).
+
+##Help
+
+You can use issues in github for that. Or else you can reach us at
+twitter: [@dbiazus](https://twitter.com/#!/dbiazus) 
+
+##Note on Patches/Pull Requests
+
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don’t break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+##Copyright
+
+Copyright © 2010 Diogo Biazus. See LICENSE for details.

data/Rakefile

@@ -1,7 +1,12 @@
-# encoding: utf-8
-
+# -*- encoding: utf-8 -*-
+$:.unshift File.expand_path("../lib", __FILE__)
+require 'bundler/gem_tasks'
 require 'rubygems'
-require 'bundler'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+task :default => :spec
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -9,47 +14,14 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  gem.name = "activerecord-postgres-earthdistance"
-  gem.license = "MIT"
-  gem.name = "activerecord-postgres-earthdistance"
-  gem.summary = %Q{Now you can filter records within a radius}
-  gem.description = %Q{I'll write it tomorrow}
-  gem.email = "diogob@gmail.com"
-  gem.homepage = "http://github.com/softa/activerecord-postgres-earthdistance"
-  gem.authors = ["Juan Maiz", "Diogo Biazus"]
-  gem.add_dependency "pg"
-  gem.add_dependency "rails"
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+RSpec::Core::RakeTask.new(:spec)
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
-end
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
+RDoc::Task.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "activerecord-postgres-earthdistance #{version}"
+  rdoc.title = "activerecord-postgres-hstore #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+

data/activerecord-postgres-earthdistance.gemspec

@@ -1,124 +1,31 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
-  s.name = %q{activerecord-postgres-earthdistance}
-  s.version = "0.1.0"
+  s.name = "activerecord-postgres-earthdistance"
+  s.version = "0.2.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Juan Maiz", "Diogo Biazus"]
-  s.date = %q{2011-06-23}
-  s.description = %q{I'll write it tomorrow}
-  s.email = %q{diogob@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "activerecord-postgres-earthdistance.gemspec",
-    "lib/activerecord-postgres-earthdistance.rb",
-    "lib/activerecord-postgres-earthdistance/activerecord.rb",
-    "lib/templates/cube.sql",
-    "lib/templates/earthdistance.sql",
-    "lib/templates/setup_earthdistance.rb",
-    "test/app/.gitignore",
-    "test/app/Gemfile",
-    "test/app/Gemfile.lock",
-    "test/app/README",
-    "test/app/Rakefile",
-    "test/app/app/controllers/application_controller.rb",
-    "test/app/app/helpers/application_helper.rb",
-    "test/app/app/models/place.rb",
-    "test/app/app/views/layouts/application.html.erb",
-    "test/app/config.ru",
-    "test/app/config/application.rb",
-    "test/app/config/boot.rb",
-    "test/app/config/database.yml",
-    "test/app/config/environment.rb",
-    "test/app/config/environments/development.rb",
-    "test/app/config/environments/production.rb",
-    "test/app/config/environments/test.rb",
-    "test/app/config/initializers/backtrace_silencers.rb",
-    "test/app/config/initializers/inflections.rb",
-    "test/app/config/initializers/mime_types.rb",
-    "test/app/config/initializers/secret_token.rb",
-    "test/app/config/initializers/session_store.rb",
-    "test/app/config/initializers/use_sql_schema.rb",
-    "test/app/config/locales/en.yml",
-    "test/app/config/routes.rb",
-    "test/app/db/development_structure.sql",
-    "test/app/db/migrate/20110225205046_setup_earthdistance.rb",
-    "test/app/db/migrate/20110225205131_create_places.rb",
-    "test/app/db/schema.rb",
-    "test/app/db/seeds.rb",
-    "test/app/doc/README_FOR_APP",
-    "test/app/lib/tasks/.gitkeep",
-    "test/app/public/404.html",
-    "test/app/public/422.html",
-    "test/app/public/500.html",
-    "test/app/public/favicon.ico",
-    "test/app/public/images/rails.png",
-    "test/app/public/index.html",
-    "test/app/public/javascripts/application.js",
-    "test/app/public/javascripts/controls.js",
-    "test/app/public/javascripts/dragdrop.js",
-    "test/app/public/javascripts/effects.js",
-    "test/app/public/javascripts/prototype.js",
-    "test/app/public/javascripts/rails.js",
-    "test/app/public/robots.txt",
-    "test/app/public/stylesheets/.gitkeep",
-    "test/app/script/rails",
-    "test/app/test/performance/browsing_test.rb",
-    "test/app/test/test_helper.rb",
-    "test/app/test/unit/place_test.rb",
-    "test/app/vendor/plugins/.gitkeep"
-  ]
-  s.homepage = %q{http://github.com/softa/activerecord-postgres-earthdistance}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Now you can filter records within a radius}
+  s.platform    = Gem::Platform::RUBY
+  s.license     = "MIT"
+  s.authors     = ["Diogo Biazus"]
+  s.email       = "diogo@biazus.me"
+  s.homepage    = "http://github.com/diogob/activerecord-postgres-earthdistance"
+  s.summary     = "Check distances with latitude and longitude using PostgreSQL special indexes"
+  s.description = "This gem enables your model to query the database using the earthdistance extension. This should be much faster than using trigonometry functions over standart indexs."
+  s.required_ruby_version     = ">= 1.8.7"
+  s.required_rubygems_version = ">= 1.3.6"
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.add_dependency "rails", ">= 3.1"
+  s.add_dependency "rake"
+  s.add_dependency "pg"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rdoc"
+  s.add_development_dependency "rspec", "~> 2.11"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rails>, [">= 3.0.0"])
-      s.add_runtime_dependency(%q<pg>, [">= 0.11"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_runtime_dependency(%q<pg>, [">= 0"])
-      s.add_runtime_dependency(%q<rails>, [">= 0"])
-    else
-      s.add_dependency(%q<rails>, [">= 3.0.0"])
-      s.add_dependency(%q<pg>, [">= 0.11"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<pg>, [">= 0"])
-      s.add_dependency(%q<rails>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rails>, [">= 3.0.0"])
-    s.add_dependency(%q<pg>, [">= 0.11"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<pg>, [">= 0"])
-    s.add_dependency(%q<rails>, [">= 0"])
-  end
+  git_files            = `git ls-files`.split("\n") rescue ''
+  s.files              = git_files
+  s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables        = []
+  s.require_paths      = %w(lib)
 end
-