mongoid_geo 0.5.4.1 → 0.6.0

data/.rspec

@@ -0,0 +1 @@
+--color --format nested

data/Changelog.textile

@@ -0,0 +1,18 @@
+h3. May 19, 2011
+
+- removed date field from gemspec
+
+h3. May 17, 2011
+
+Released version 0.5.4
+
+- alias methods using underscore '_' for methods such as #near_sphere
+
+h3. May 10, 2011
+
+Released version 0.5.3 (improvements by davemitchell)
+
+- Accept hash with 0, 1 for lat,lng (support auto conversion from a multipart post as an array)
+- updated fields to support embedded location document
+- allow lat/lng to be assigned independently when location has not been initialized
+

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'
+
+gem 'mongoid',        '> 2'
+gem "bson",           '>= 1.3' # for non jruby apps, require bson_ext in your Gemfile to boost performance
+gem 'activesupport',  '> 3'
+gem 'hashie',         '>= 0.4.0'   # https://github.com/okiess/mongo-hashie ???  
+
+group :test, :development do
+  gem 'rspec',    '> 2.4'
+  gem 'bundler',  '> 1'
+  gem 'jeweler',  '> 1.5'
+  gem 'rdoc'  
+end

data/README.textile

@@ -7,11 +7,23 @@ A Geo extension for Mongoid.
 * Supports Mongo DB 1.7+ sphere distance calculations
 * Extra geo calculation methods such as #near_sphere etc.
 * Add concept of a special "geo" field (for setting the location point)
+* Configure and create geo indexes
 * Calculate locations near a given point and return as criteria, sorted by distance
 
-h2. Status update (May 18, 2011)
+h2. Status update (May 21, 2011)
 
-Created alias methods such as _#near_sphere_ for _#nearSphere_ etc. to make the DSL much more 'rubyish'!
+* Created alias methods such as _#near_sphere_ for _#nearSphere_ etc. to make the DSL much more 'rubyish'!
+* Added #create_index! method (see 'Geo index' section below).
+
+h2. You need help?
+
+Post questions in the "mongoid-geo":http://groups.google.com/group/mongoid-geo group. Here I (and other uses of mongoid-geo) will 
+try to help out and answer any questions. 
+
+h2. Suggestions, improvements and bugs?
+
+Please raise issues or suggestions for improvements in the "Issues" section on github. 
+I would recommend that you try to branch the project, try to fix it yourself and make a pull request. 
 
 h2. Mongoid 2 geo features
 
@@ -62,6 +74,23 @@ Usage example:
 
 Note: For embedded documents, you must define the index in the root collection class. (davemitchell)
 
+Calling geo_index also adds a #create_index! method to the class to enable construction of the index (on the instances/data in the DB). 
+
+<pre>
+  class Address
+    ...
+    geo_index :location
+  end
+  
+  Address.create_index!
+</pre>
+
+I also added a nice little Array macro so you can do this:
+
+<pre>
+  [Address, Location].create_geo_indexes!
+</pre>
+
 h2. Geo option for Array GPS location field
 
 Objective: When setting a geo GPS location array, the setter should try to convert the value to an array of floats
@@ -317,8 +346,8 @@ You can also use a hash to define the circle, with @:center@ and @:radius@ keys
 <pre>
   places.where(:location.within_center => {:center => [50, 40], :radius => 4})
 </pre>
-
-Or use an object (which must have the methods #lower_left and #upper_right that return the points of the bounding box)
+                                              
+Or use an object (which must have the methods #center and #radius that return the center and radius of the circle))
 
 <pre>
   circle = (Struct.new :center, :radius).new
@@ -327,3 +356,15 @@ Or use an object (which must have the methods #lower_left and #upper_right that
 
   places.where(:location.within_center => circle)
 </pre>
+               
+h2. Note on the specs
+
+The specs still use the old "Javascript" like method convention, such as _#nearSphere_ 
+Don't let that fool you ;)
+
+h2. Contribute
+
+*Please feel free to contribute to the project!*
+
+I aim to deliver a complete *geo* package for use with _Mongoid_. This gem should work nicely with _geo_calc_ and _geo_vectors_ that I'm also working on.
+Please help me with these gems also and help make sure they all play nice and work together!

data/Rakefile

@@ -1,25 +1,55 @@
-# encoding: UTF-8
+# encoding: utf-8
+
 require 'rubygems'
+require 'bundler'
 begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
 end
-
 require 'rake'
-require 'rake/rdoctask'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mongoid_geo"
+  gem.homepage = "http://github.com/kristianmandrup/mongoid_geo"
+  gem.license = "MIT"
+  gem.summary = %Q{Mongoid geo extensions with support for native Mongo DB calculations}
+  gem.description = %Q{Makes it easy to use geo calculations with Mongoid}
+  gem.email = "kmandrup@gmail.com"
+  gem.authors = ["Kristian Mandrup"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency      'mongoid',        '> 2'
+  gem.add_runtime_dependency      'bson',           '>= 1.3' 
+  gem.add_runtime_dependency      'activesupport',  '> 3'
+  gem.add_runtime_dependency      'hashie',         '>= 0.4.0'   # https://github.com/okiess/mongo-hashie ???  
+  gem.add_development_dependency  'rspec',          '> 2.4'
+end
+Jeweler::RubygemsDotOrgTasks.new
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
 
 task :default => :spec
 
-Rake::RDocTask.new(:rdoc) do |rdoc|
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Mongoid Geo'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.title = "mongoid_geo #{version}"
+  rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -0,0 +1 @@
+0.6.0

data/lib/mongoid/geo/index.rb

@@ -1,9 +1,21 @@
 module Mongoid #:nodoc
   module Indexes #:nodoc
     module ClassMethods #:nodoc
-      def geo_index name
-        index [[ name, Mongo::GEO2D ]], :min => -180, :max => 180
+      def geo_index name, options = {}
+        min = options[:min] || -180
+        max = options[:max] || 180
+        index [[ name, Mongo::GEO2D ]], :min => min, :max => max
+
+        define_singleton_method :create_index! do
+          collection.create_index([[name, Mongo::GEO2D]], :min => min, :max => max)
+        end
       end
     end
   end
 end
+
+class Array
+  def create_geo_indexes!
+    self.each {|clazz| clazz.create_index! }
+  end
+end

data/sandbox/haversine.rb

@@ -0,0 +1,17 @@
+class Haversine
+  #EARTH_RADIUS = 3963.19 # miles
+  EARTH_RADIUS = 6371 # kilometers
+  RADIAN_PER_DEGREE = Math::PI / 180.0
+
+  def self.distance(lat1, lng1, lat2, lng2)
+     lat1_radians = lat1 * RADIAN_PER_DEGREE
+     lat2_radians = lat2 * RADIAN_PER_DEGREE
+
+     distance_lat = (lat2-lat1) * RADIAN_PER_DEGREE
+     distance_lng = (lng2-lng1) * RADIAN_PER_DEGREE
+
+     a = Math.sin(distance_lat/2)**2 + Math.cos(lat1_radians) * Math.cos(lat2_radians) * Math.sin(distance_lng/2) ** 2
+     c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1-a))
+     EARTH_RADIUS * c
+  end
+end

data/sandbox/location.rb

@@ -0,0 +1,38 @@
+require 'mongoid'
+require 'mongoid_geo'
+require 'net/http'
+require 'active_support'
+require 'haversine'
+require 'rack'
+require 'hashie'
+                 
+Mongoid.configure.master = Mongo::Connection.new.db('mongoid-geo')
+
+Mongoid.database.collections.each do |coll|
+  coll.remove
+end
+
+class Location
+  include Mongoid::Document
+
+  field :lon_lat, :type => Array
+
+  extend Mongoid::Geo::Near
+
+  geo_index :lon_lat, :create
+
+  def self.search(loc)
+    country = "The Netherlands"
+    location = [loc, country].compact.join(', ')
+    response = ::Net::HTTP.get_response(URI.parse("http://maps.googleapis.com/maps/api/geocode/json?address=#{Rack::Utils.escape(location)}&sensor=false"))
+    json = ActiveSupport::JSON.decode(response.body)
+
+    if json["status"] == "OK"
+      lon_lat = json["results"][0]["geometry"]["location"]["lng"], json["results"][0]["geometry"]["location"]["lat"]
+    else
+      return false
+    end
+    geoNear(lon_lat, :lon_lat)        
+  end
+end
+

data/sandbox/test.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'location'
+
+Location.create(:lon_lat => [45, 11])
+Location.create(:lon_lat => [46, 12])
+
+# Location.collection.create_index([['lon_lat', Mongo::GEO2D]], :min => -180, :max => 180)
+
+Location.create_index!
+
+puts Location.search('Amsterdam')  

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "mongoid_geo"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,26 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,49 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end