cb_mongoid_spacial 0.2.16

data/lib/mongoid_spacial/spacial/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Spacial
+    VERSION = "0.2.16"
+  end
+end

data/mongoid_spacial.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mongoid_spacial/spacial/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ryan Ong"]
+  gem.email         = ["ryanong@gmail.com"]
+  gem.description   = %q{mongoid_spacial simplifies spacial calculations. Adds integration into mongoid so pagination and other function continue to work. It adds symbol extentions to simplify query creation.}
+  gem.summary       = %q{A Mongoid Extention that simplifies and adds support for MongoDB Geo Spacial Calculations.}
+  gem.homepage      = "https://github.com/ryanong/mongoid_spacial"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "cb_mongoid_spacial"
+  gem.require_paths = ["lib"]
+  gem.version       = Mongoid::Spacial::VERSION
+
+  gem.add_dependency("mongoid", ['>= 2.1.0'])
+  gem.add_dependency('activesupport', ["~> 3.0"])
+  gem.add_development_dependency('yard', ["~>0.6.0"])
+  gem.add_development_dependency('rspec', ['~>2.3'])
+  gem.add_development_dependency('simplecov', ['>= 0'])
+  gem.add_development_dependency('mocha', ['>= 0'])
+  gem.add_development_dependency('will_paginate', ['>= 0'])
+  gem.add_development_dependency('kaminari', ['>= 0'])
+
+end

data/spec/config/mongod.conf

@@ -0,0 +1,3 @@
+dbpath = /usr/local/var/mongodb
+master = true
+bind_ip = 127.0.0.1

data/spec/config/mongoid.yml

@@ -0,0 +1,18 @@
+test:
+  database: mongoid_config_test
+  host: localhost
+  slaves:
+    # - host: localhost
+      # port: 27018
+    # - host: localhost
+      # port: 27019
+  allow_dynamic_fields: false
+  include_root_in_json: true
+  parameterize_keys: false
+  persist_in_safe_mode: false
+  raise_not_found_error: false
+  reconnect_time: 5
+  autocreate_indexes: false
+  persist_types: false
+  option_no_exist: false
+  skip_version_check: false

data/spec/functional/mongoid/contexts/mongo_spec.rb

@@ -0,0 +1,125 @@
+require "spec_helper"
+
+describe Mongoid::Contexts::Mongo do
+  describe "#geo_near" do
+
+    before do
+      Bar.delete_all
+      Bar.create_indexes
+    end
+
+    let!(:jfk) do
+      Bar.create(:name => 'jfk', :location => [-73.77694444, 40.63861111 ])
+    end
+
+    let!(:lax) do
+      Bar.create(:name => 'lax', :location => [-118.40, 33.94])
+    end
+
+    it "should work with specifying specific center and different location attribute on collction" do
+      Bar.geo_near(lax.location, :spherical => true).should == [lax, jfk]
+      Bar.geo_near(jfk.location, :spherical => true).should == [jfk, lax]
+    end
+    context 'option' do
+      context ':num' do
+        it "should limit number of results to 1" do
+          Bar.geo_near(jfk.location, :num => 1).size.should == 1
+        end
+      end
+
+      context ':maxDistance' do
+        it "should get 1 item" do
+          Bar.geo_near(lax.location, :spherical => true, :max_distance => 2465/Mongoid::Spacial.earth_radius[:mi]).size.should == 1
+        end
+        it "should get 2 items" do
+          Bar.geo_near(lax.location, :spherical => true, :max_distance => 2480/Mongoid::Spacial.earth_radius[:mi]).size.should == 2
+        end
+
+      end
+
+      context ':distance_multiplier' do
+        it "should multiply returned distance with multiplier" do
+          Bar.geo_near(lax.location, :spherical => true, :distance_multiplier=> Mongoid::Spacial.earth_radius[:mi]).second.geo[:distance].to_i.should be_within(1).of(2469)
+        end
+      end
+
+      context ':unit' do
+        it "should multiply returned distance with multiplier" do
+          Bar.geo_near(lax.location, :spherical => true, :unit => :mi).second.geo[:distance].to_i.should be_within(1).of(2469)
+        end
+
+        it "should convert max_distance to radians with unit" do
+          Bar.geo_near(lax.location, :spherical => true, :max_distance => 2465, :unit => :mi).size.should == 1
+        end
+
+      end
+
+      context ':query' do
+        it "should filter using extra query option" do
+          # two record in the collection, only one's name is Munich
+          Bar.geo_near(jfk.location, :query => {:name => jfk.name}).should == [jfk]
+        end
+      end
+
+    end
+
+    context 'criteria chaining' do
+      it "should filter by where" do
+        Bar.where(:name => jfk.name).geo_near(jfk.location).should == [jfk]
+        Bar.any_of({:name => jfk.name},{:name => lax.name}).geo_near(jfk.location).should == [jfk,lax]
+      end
+
+      it 'should skip 1' do
+        Bar.skip(1).geo_near(jfk.location).size.should == 1
+      end
+
+      it 'should limit 1' do
+        Bar.limit(1).geo_near(jfk.location).size.should == 1
+      end
+
+    end
+
+  end
+
+  context ':page' do
+    before(:all) do
+      Bar.delete_all
+      Bar.create_indexes
+
+      50.times do
+        Bar.create({:location => [rand(360)-180,rand(360)-180]})
+      end
+    end
+    context ":paginator :array" do
+      [nil,1,2].each do |page|          
+        it "page=#{page} should have 25" do
+          Bar.geo_near([1,1], :page => page).size.should == 25
+        end
+      end
+
+      it "page=3 should have 0" do
+        Bar.geo_near([1,1], :page => 20).size.should == 0
+      end
+      
+      it "per_page=5" do
+        Bar.geo_near([1,1], :page => 1, :per_page => 5).size.should == 5
+      end
+    end
+
+    context ":paginator :kaminari" do 
+      let(:near) {Bar.geo_near([1,1], :page => 1)}
+      it "should have current_page" do
+        near.current_page.should == 1
+      end
+
+      it "should have num_pages" do
+        near.num_pages.should == 2
+      end
+
+      it "should have limit_value" do
+        near.limit_value.should == 25
+      end
+    end      
+  end
+
+end

data/spec/functional/mongoid/criterion/inclusion_spec.rb

@@ -0,0 +1,356 @@
+require "spec_helper"
+
+describe Mongoid::Criterion::Inclusion do
+
+  before do
+    Person.delete_all
+  end
+
+  describe "#where" do
+
+    let(:dob) do
+      33.years.ago.to_date
+    end
+
+    let(:lunch_time) do
+      30.minutes.ago
+    end
+
+    let!(:person) do
+      Person.create(
+        :title => "Sir",
+        :dob => dob,
+        :lunch_time => lunch_time,
+        :age => 33,
+        :aliases => [ "D", "Durran" ],
+        :things => [ { :phone => 'HTC Incredible' } ]
+      )
+    end
+
+    context "when providing 24 character strings" do
+
+      context "when the field is not an id field" do
+
+        let(:string) do
+          BSON::ObjectId.new.to_s
+        end
+
+        let!(:person) do
+          Person.create(:title => string)
+        end
+
+        let(:from_db) do
+          Person.where(:title => string)
+        end
+
+        it "does not convert the field to a bson id" do
+          from_db.should == [ person ]
+        end
+      end
+    end
+
+    context "when providing string object ids" do
+
+      context "when providing a single id" do
+
+        let(:from_db) do
+          Person.where(:_id => person.id.to_s).first
+        end
+
+        it "returns the matching documents" do
+          from_db.should == person
+        end
+      end
+    end
+
+    context "chaining multiple wheres" do
+
+      context "when chaining on the same key" do
+
+        let(:from_db) do
+          Person.where(:title => "Maam").where(:title => "Sir")
+        end
+
+        it "overrides the previous key" do
+          from_db.should == [ person ]
+        end
+      end
+
+      context "with different criteria on the same key" do
+
+        it "merges criteria" do
+          Person.where(:age.gt => 30).where(:age.lt => 40).should == [person]
+        end
+
+        it "typecasts criteria" do
+          before_dob = (dob - 1.month).to_s
+          after_dob = (dob + 1.month).to_s
+          Person.where(:dob.gt => before_dob).and(:dob.lt => after_dob).should == [person]
+        end
+
+      end
+    end
+
+    context "with untyped criteria" do
+
+      it "typecasts integers" do
+        Person.where(:age => "33").should == [ person ]
+      end
+
+      it "typecasts datetimes" do
+        Person.where(:lunch_time => lunch_time.to_s).should == [ person ]
+      end
+
+      it "typecasts dates" do
+        Person.where({:dob => dob.to_s}).should == [ person ]
+      end
+
+      it "typecasts times with zones" do
+        time = lunch_time.in_time_zone("Alaska")
+        Person.where(:lunch_time => time).should == [ person ]
+      end
+
+      it "typecasts array elements" do
+        Person.where(:age.in => [17, "33"]).should == [ person ]
+      end
+
+      it "typecasts size criterion to integer" do
+        Person.where(:aliases.size => "2").should == [ person ]
+      end
+
+      it "typecasts exists criterion to boolean" do
+        Person.where(:score.exists => "f").should == [ person ]
+      end
+    end
+
+    context "with multiple complex criteria" do
+
+      before do
+        Person.create(:title => "Mrs", :age => 29)
+        Person.create(:title => "Ms", :age => 41)
+      end
+
+      it "returns those matching both criteria" do
+        Person.where(:age.gt => 30, :age.lt => 40).should == [person]
+      end
+
+      it "returns nothing if in and nin clauses cancel each other out" do
+        Person.any_in(:title => ["Sir"]).not_in(:title => ["Sir"]).should == []
+      end
+
+      it "returns nothing if in and nin clauses cancel each other out ordered the other way" do
+        Person.not_in(:title => ["Sir"]).any_in(:title => ["Sir"]).should == []
+      end
+
+      it "returns the intersection of in and nin clauses" do
+        Person.any_in(:title => ["Sir", "Mrs"]).not_in(:title => ["Mrs"]).should == [person]
+      end
+
+      it "returns the intersection of two in clauses" do
+        Person.where(:title.in => ["Sir", "Mrs"]).where(:title.in => ["Sir", "Ms"]).should == [person]
+      end
+    end
+
+    context "with complex criterion" do
+
+      context "#all" do
+
+        it "returns those matching an all clause" do
+          Person.where(:aliases.all => ["D", "Durran"]).should == [person]
+        end
+      end
+
+      context "#exists" do
+
+        it "returns those matching an exists clause" do
+          Person.where(:title.exists => true).should == [person]
+        end
+      end
+
+      context "#gt" do
+
+        it "returns those matching a gt clause" do
+          Person.where(:age.gt => 30).should == [person]
+        end
+      end
+
+      context "#gte" do
+
+        it "returns those matching a gte clause" do
+          Person.where(:age.gte => 33).should == [person]
+        end
+      end
+
+      context "#in" do
+
+        it "returns those matching an in clause" do
+          Person.where(:title.in => ["Sir", "Madam"]).should == [person]
+        end
+
+        it "allows nil" do
+          Person.where(:ssn.in => [nil]).should == [person]
+        end
+      end
+
+      context "#lt" do
+
+        it "returns those matching a lt clause" do
+          Person.where(:age.lt => 34).should == [person]
+        end
+      end
+
+      context "#lte" do
+
+        it "returns those matching a lte clause" do
+          Person.where(:age.lte => 33).should == [person]
+        end
+      end
+
+      context "#ne" do
+
+        it "returns those matching a ne clause" do
+          Person.where(:age.ne => 50).should == [person]
+        end
+      end
+
+      context "#nin" do
+
+        it "returns those matching a nin clause" do
+          Person.where(:title.nin => ["Esquire", "Congressman"]).should == [person]
+        end
+      end
+
+      context "#size" do
+
+        it "returns those matching a size clause" do
+          Person.where(:aliases.size => 2).should == [person]
+        end
+      end
+
+      context "#match" do
+
+        it "returns those matching a partial element in a list" do
+          Person.where(:things.matches => { :phone => "HTC Incredible" }).should == [person]
+        end
+      end
+
+    end
+
+    context "Geo Spacial Complex Where" do
+
+      let!(:home) do
+        [-73.98,40.77]
+      end
+
+      describe "#near" do
+        before do
+          Bar.delete_all
+          Bar.create_indexes
+        end
+
+        let!(:berlin) do
+          Bar.create(:location => [ 52.30, 13.25 ])
+        end
+
+        let!(:prague) do
+          Bar.create(:location => [ 50.5, 14.26 ])
+        end
+
+        let!(:paris) do
+          Bar.create(:location => [ 48.48, 2.20 ])
+        end
+
+        it "returns the documents sorted closest to furthest" do
+          Bar.where(:location.near => [ 41.23, 2.9 ]).should == [ paris, prague, berlin ]
+        end
+
+        it "returns the documents sorted closest to furthest" do
+          Bar.where(:location.near => {:point=>[ 41.23, 2.9 ],:max => 20}).should == [ paris, prague, berlin ]
+        end
+
+        it "returns the documents sorted closest to furthest" do
+          Bar.where(:location.near_sphere => [ 41.23, 2.9 ]).should == [ paris, prague, berlin ]
+        end
+
+      end
+
+      context "#within" do
+
+        context ":box, :polygon" do
+          before do
+            Bar.delete_all
+            Bar.create_indexes
+          end
+
+          let!(:berlin) do
+            Bar.create(:name => 'berlin', :location => [ 52.30, 13.25 ])
+          end
+
+          let!(:prague) do
+            Bar.create(:name => 'prague',:location => [ 50.5, 14.26 ])
+          end
+
+          let!(:paris) do
+            Bar.create(:name => 'prague',:location => [ 48.48, 2.20 ])
+          end
+
+          it "returns the documents within a box" do
+            Bar.where(:location.within(:box) => [[ 47, 1 ],[ 49, 3 ]]).should == [ paris ]
+          end
+
+          it "returns the documents within a polygon", :if => (Mongoid.master.connection.server_version >= '1.9') do
+            Bar.where(:location.within(:polygon) => [[ 47, 1 ],[49,1.5],[ 49, 3 ],[46,5]]).should == [ paris ]
+          end
+
+          it "returns the documents within a center" do
+            Bar.where(:location.within(:center) => [[ 47, 1 ],4]).should == [ paris ]
+          end
+
+          it "returns the documents within a center_sphere" do
+            Bar.where(:location.within(:center_sphere) => [[ 48, 2 ],0.1]).should == [ paris ]
+          end
+
+        end
+        context ":circle :center_sphere" do
+          before do
+            Bar.delete_all
+            Bar.create_indexes
+          end
+          let!(:mile1) do
+            Bar.create(:name => 'mile1', :location => [-73.997345, 40.759382])
+          end
+
+          let!(:mile3) do 
+            Bar.create(:name => 'mile2', :location => [-73.927088, 40.752151])            
+          end
+
+          let!(:mile7) do 
+            Bar.create(:name => 'mile3', :location => [-74.0954913, 40.7161472])            
+          end
+
+          let!(:mile11) do 
+            Bar.create(:name => 'mile4', :location => [-74.0604951, 40.9178011])            
+          end
+
+          it "returns the documents within a center_sphere" do
+            Bar.where(:location.within(:center_sphere) => {:point => home,:max => 2, :unit => :mi}).should == [ mile1 ]
+          end
+
+          it "returns the documents within a center_sphere" do
+            Bar.where(:location.within(:center_sphere) => {:point => home,:max => 4, :unit => :mi}).should include(mile3) 
+          end
+
+          it "returns the documents within a center_sphere" do
+            Bar.where(:location.within(:center_sphere) => {:point => home,:max => 8, :unit => :mi}).should include(mile7) 
+          end
+
+          it "returns the documents within a center_sphere" do
+            Bar.where(:location.within(:center_sphere) => {:point => home,:max => 12, :unit => :mi}).should include(mile11) 
+          end
+        end
+      end
+    end
+
+  end
+
+end