mongoid_spacial 0.1.0 → 0.1.1

data/Gemfile

@@ -6,11 +6,11 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 gem 'mongoid'
-gem "bson",           '>= 1.3',  :platforms => [:jruby] # for non jruby apps, require bson_ext in your Gemfile to boost performance
-gem "bson_ext",       '>= 1.3',  :platforms => [:mri]
 gem 'activesupport'
 
 group :development do
+  gem "bson",           '>= 1.3',  :platforms => [:jruby] # for non jruby apps, require bson_ext in your Gemfile to boost performance
+  gem "bson_ext",       '>= 1.3',  :platforms => [:mri]
   gem "rspec", "~> 2.3.0"
   gem "yard", "~> 0.6.0"
   gem "bundler", "~> 1.0.0"
@@ -25,4 +25,6 @@ end
 
 group :test do
   gem 'mocha'
+  gem 'will_paginate'
+  gem 'kaminari'
 end

data/README.md

@@ -99,14 +99,15 @@ River.where(:name=>'hudson').geo_near({:lat => 40.73083, :lng => -73.99756})
 # :max\_distance - Integer
 # :distance\_multiplier - Integer
 # :spherical - true - To enable spherical calculations
-River.geo_near([-73.99756,40.73083], :max_distance => 4, :unit => :mi, :spherical)
-
+# :page - pagination will be enabled if set to any variable including nil, pagination will not be enabled if either :per\_page or :paginator is set
+#   :per\_page
+#   :paginator - Choose which paginator to use. [default :arrary]
+#     Prefered method to set is Mongoid::Spacial.paginator=:array
+#     Available Paginators [:kaminari, :will\_paginate, :array]
+#     The only thing this does really is configure default per\_page so it is only kind of useful
+River.geo_near([-73.99756,40.73083], :max_distance => 4, :unit => :mi, :spherical => true, :page => 1)
 ```
 
-ToDo
------------
- 1. Add pagination 
-
 Thanks
 -----------
 * Thanks to Kristian Mandrup for creating the base of the gem and a few of the tests

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/mongoid_spacial/contexts/mongo.rb

@@ -39,17 +39,19 @@ module Mongoid #:nodoc:
         if distance_multiplier = Mongoid::Spacial.earth_radius[opts.delete(:unit)]
           opts[:distance_multiplier] = distance_multiplier
         end
-
+  
+        # setup paging.
         if opts.has_key?(:page)
           opts[:page] ||= 1
-          opts[:paginator] ||= Mongoid::Spacial.paginator
-            if opts[:paginator] == :will_paginate
-              opts[:per_page] ||= klass.per_page
-            elsif opts[:paginator] == :kaminari
-              opts[:per_page] ||= Kaminari.config.default_per_page
-            else
-              opts[:per_page] ||= 25
-            end
+          opts[:paginator] ||= Mongoid::Spacial.paginator()
+
+          if opts[:paginator] == :will_paginate
+            opts[:per_page] ||= klass.per_page
+          elsif opts[:paginator] == :kaminari
+            opts[:per_page] ||= Kaminari.config.default_per_page
+          else
+            opts[:per_page] ||= Mongoid::Spacial.default_per_page
+          end
         end
         query = create_geo_near_query(center,opts)
         results = klass.db.command(query)

data/lib/mongoid_spacial/spacial.rb

@@ -36,6 +36,9 @@ module Mongoid
     @@distance_formula = :n_vector
 
     mattr_accessor :paginator
-    @@paginator = :kaminari
+    @@paginator = :array
+
+    mattr_accessor :default_per_page
+    @@default_per_page = 25
   end
 end

data/lib/mongoid_spacial/spacial/geo_near.rb

@@ -5,7 +5,9 @@ module Mongoid
 
       def initialize(klass,results,opts = {})
         raise "class must include Mongoid::Spacial::Document" unless klass.respond_to?(:spacial_fields_indexed)
-        @klass, @stats,@opts = klass,results['stats'],opts
+        @klass = klass
+        @opts = opts
+        @stats = results['stats']
 
         @_original_array = results['results'].collect do |result|
           res = Mongoid::Factory.from_db(klass, result.delete('obj'))
@@ -18,29 +20,29 @@ module Mongoid
             res.geo[key.snakecase.to_sym] = value
           end
           # dist_options[:formula] = opts[:formula] if opts[:formula]
-          opts[:calculate] = klass.spacial_fields_indexed if klass.spacial_fields_indexed.kind_of?(Array) && opts[:calculate] == true
-          if opts[:calculate]
-            opts[:calculate] = [opts[:calculate]] unless opts[:calculate].kind_of? Array
-            opts[:calculate] = opts[:calculate].map(&:to_sym) & geo_fields
+          @opts[:calculate] = klass.spacial_fields_indexed if klass.spacial_fields_indexed.kind_of?(Array) && @opts[:calculate] == true
+          if @opts[:calculate]
+            @opts[:calculate] = [@opts[:calculate]] unless @opts[:calculate].kind_of? Array
+            @opts[:calculate] = @opts[:calculate].map(&:to_sym) & geo_fields
             if klass.spacial_fields_indexed.kind_of?(Array) && klass.spacial_fields_indexed.size == 1
               primary = klass.spacial_fields_indexed.first
             end
-            opts[:calculate].each do |key|
+            @opts[:calculate].each do |key|
               key = (key.to_s+'_distance').to_sym
-              res.geo[key] = res.distance_from(key,center, opts[:distance_multiplier])
+              res.geo[key] = res.distance_from(key,center, @opts[:distance_multiplier])
               res.geo[:distance] = res.geo[key] if primary && key == primary
             end
           end
           res
         end
 
-        if opts[:page]
-          start = (opts[:page]-1)*opts[:per_page] # assuming current_page is 1 based.
-          super(@_original_array[start, opts[:per_page]])
-        elsif opts[:skip] && @_original_array.size > opts[:skip]
-          super(@_original_array[opts[:skip]..-1])
+        if @opts[:page]
+          start = (@opts[:page]-1)*@opts[:per_page] # assuming current_page is 1 based.
+          super(@_original_array[start, @opts[:per_page]] || [])
+        elsif @opts[:skip] && @_original_array.size > @opts[:skip]
+          super(@_original_array[@opts[:skip]..-1] || [])
         else
-          super(@_original_array)
+          super(@_original_array || [])
         end
       end
 

data/mongoid_spacial.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid_spacial}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Ryan Ong}]
@@ -134,9 +134,9 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<mongoid>, [">= 0"])
-      s.add_runtime_dependency(%q<bson>, [">= 1.3"])
-      s.add_runtime_dependency(%q<bson_ext>, [">= 1.3"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<bson>, [">= 1.3"])
+      s.add_development_dependency(%q<bson_ext>, [">= 1.3"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -146,9 +146,9 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
     else
       s.add_dependency(%q<mongoid>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<bson>, [">= 1.3"])
       s.add_dependency(%q<bson_ext>, [">= 1.3"])
-      s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -159,9 +159,9 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<mongoid>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<bson>, [">= 1.3"])
     s.add_dependency(%q<bson_ext>, [">= 1.3"])
-    s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     s.add_dependency(%q<yard>, ["~> 0.6.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])

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

@@ -20,48 +20,50 @@ describe Mongoid::Contexts::Mongo do
       Bar.geo_near(lax.location, :spherical => true).should == [lax, jfk]
       Bar.geo_near(jfk.location, :spherical => true).should == [jfk, lax]
     end
-
-    describe 'option :num' do
-      it "should limit number of results to 1" do
-        Bar.geo_near(jfk.location, :num => 1).size.should == 1
+    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
-    end
 
-    describe 'option :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
+      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
+      end
 
-    describe 'option :distance_multiplier' do
-      it "should multiply returned distance with multiplier" do
+      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
-    end
 
-    describe 'option :unit' do
-      it "should multiply returned distance with multiplier" do
+      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
+        end
 
-      it "should convert max_distance to radians with unit" do
+        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
 
-    end
+      end
 
-    describe 'option :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]
+      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
 
-    describe 'criteria chaining' do
+    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]
@@ -78,5 +80,32 @@ describe Mongoid::Contexts::Mongo do
     end
 
   end
+
+  context ':page' do
+    before(:all) do
+      Bar.delete_all
+      Bar.create_indexes
+
+      100.times do
+        Bar.create({:location => [rand(360)-180,rand(360)-180]})
+      end
+    end
+    context ":paginator :array" do
+      [nil,1,2,3,4].each do |page|          
+        it "page=#{page} should have 25" do
+          Bar.geo_near([1,1], :page => page).size.should == 25
+        end
+      end
+
+      it "page=20 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
+  end
+
 end
 

metadata

@@ -2,7 +2,7 @@
 name: mongoid_spacial
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Ryan Ong
@@ -24,36 +24,36 @@ dependencies:
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: bson
+  name: activesupport
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "1.3"
+        version: "0"
   type: :runtime
   prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: bson_ext
+  name: bson
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "1.3"
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: bson_ext
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
-  type: :runtime
+        version: "1.3"
+  type: :development
   prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -261,7 +261,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2362332534301507743
+      hash: 3825965172872748297
       segments: 
       - 0
       version: "0"