mongoid_spacial 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,28 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# 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 "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end
+
+group :test, :development do
+  gem 'linecache19'
+  gem 'ruby-debug19'
+end
+
+group :test do
+  gem 'mocha'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ryan Ong
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,126 @@
+Mongoid Spacial
+============
+
+A Mongoid Extention that simplifies and adds support for MongoDB Geo Spacial Calculations.
+
+Quick Start
+-----------
+Add mongoid_spacial to your Gemfile:
+
+```ruby
+gem 'mongoid_spacial'
+```
+
+Set up some slugs:
+
+```ruby
+class River
+  include Mongoid::Document
+  include Mongoid::Spacial::Document
+
+  field :name,              type: String
+  field :length,            type: Integer
+  field :average_discharge, type: Integer
+  field :source,            type: Array,    spacial: true
+  # if you want something besides the defaults {bit: 24, min: -180, max: 180} just set index to the options on the index
+  # field :source,            type: Array,    spacial: true
+  # try not set index for this field manually as we record what spacial fields are index for some handy fields later
+
+  # set return_array to true if you do not want a hash returned all the time
+  field :mouth,             type: Array,    spacial: {lat: 'latitude', lng: 'longitude', return_array: true }
+
+  # simplified spacial indexing
+  # you can only index one
+  spacial_index :source
+  # alternative 
+end
+```
+
+Before we manipulate the data mongoid_spacial handles is what we call points.
+Points can be:
+* an unordered hash with the lat long string keys defined when setting the field (only applies for setting the field)
+* longitude latitude array in that order - [long,lat]
+* an unordered hash with latitude key(:lat, :latitude) and a longitude key(:lon, :long, :lng, :longitude)
+* an ordered hash with longitude as the first item and latitude as the second item
+  This hash does not have include the latitude and longitude keys
+  \*only works in ruby 1.9 and up because hashes below ruby 1.9 because they are not ordered
+* anything with the method to_lng_lat that converts it to a [long,lat]
+We store data in the DB as a [lng,lat] array then reformat when it is returned to you
+
+```ruby
+hudson = River.create(
+  name: 'Hudson',
+  length: 315,
+  average_discharge: 21_400,
+  # when setting array LONGITUDE MUST BE FIRST LATITUDE MUST BE SECOND
+  # source: [-73.935833,44.106667],
+  # but we can use hash in any order,
+  # the default keys for latitude and longitude are 'lat' and 'lng' respectively
+  source: {'lat' => 44.106667, 'lng' => -73.935833},
+  # remember keys must be strings
+  mouth: {'latitude' => 40.703056, 'longitude' => -74.026667}
+)
+
+# now to access this spacial information we can now do this
+hudson.source #=> {'lng' => -73.935833, 'lat' => 44.106667}
+hudson.mouth  #=> [-74.026667, 40.703056] # notice how this returned as a lng,lat array because return_array was true
+# notice how the order of lng and lat were switched. it will always come out like this when using spacial.
+```
+Mongoid Geo has extended all built in spacial symbol extentions
+* near
+    River.where(:source.near => [-73.98, 40.77])
+    River.where(:source.near => [[-73.98, 40.77],5]) # sets max distance of 5
+    River.where(:source.near => {:point => [-73.98, 40.77], :max => 5}) # sets max distance of 5
+    River.where(:source.near(:sphere) => [[-73.98, 40.77],5]) # sets max distance of 5 radians
+    River.where(:source.near(:sphere) => {:point => [-73.98, 40.77], :max => 5, :unit => :km}) # sets max distance of 5 km    
+    River.where(:source.near(:sphere) => [-73.98, 40.77])
+* within
+    River.where(:source.within(:box) => [[-73.99756,40.73083], [-73.988135,40.741404]])
+    River.where(:source.within(:box) => [ {:lat => 40.73083, :lng => -73.99756}, [-73.988135,40.741404]])
+    River.where(:source.within(:polygon) => [ [ 10, 20 ], [ 10, 40 ], [ 30, 40 ], [ 30, 20 ] ]
+    River.where(:source.within(:polygon) => { a : { x : 10, y : 20 }, b : { x : 15, y : 25 }, c : { x : 20, y : 20 } })
+    River.where(:source.within(:center) => [[-73.98, 40.77],5])         # same format as near
+    River.where(:source.within(:center_sphere) => [[-73.98, 40.77],5])  # same format as near(:sphere)
+
+One of the most handy features we have added is geo_near finder
+
+```ruby
+# accepts all criteria chains except without, only, asc, desc, order\_by
+# pagination does not work yet but will be added in the next version
+River.where(:name=>'hudson').geo_near({:lat => 40.73083, :lng => -73.99756})
+
+# geo\_near accepts a few parameters besides a point
+# :num = limit
+# :query = where
+# :unit - [:km, :m, :mi, :ft] - converts :max\_distance to appropriate values and automatically sets :distance\_multiplier. accepts 
+# :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)
+
+```
+
+ToDo
+-----------
+ 1. Add pagination 
+
+Thanks
+-----------
+* Thanks to Kristian Mandrup for creating the base of the gem and a few of the tests
+* Thanks to CarZen LLC. for letting me release the code we are using
+
+Contributing to mongoid_ranges
+-----------
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+-----------
+Copyright (c) 2011 Ryan Ong. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  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 '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_spacial"
+  gem.homepage = "http://github.com/ryanong/mongoid_spacial"
+  gem.license = "MIT"
+  gem.summary = %Q{A Mongoid Extention that simplifies and adds support for MongoDB Geo Spacial Calculations.}
+  gem.description = %Q{A Mongoid Extention that simplifies and adds support for MongoDB Geo Spacial Calculations.}
+  gem.email = "ryanong@gmail.com"
+  gem.authors = ["Ryan Ong"]
+  # dependencies defined in Gemfile
+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(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/mongoid_spacial.rb

@@ -0,0 +1,11 @@
+require 'mongoid'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/concern'
+require 'mongoid_spacial/contexts/mongo'
+require 'mongoid_spacial/criteria'
+require 'mongoid_spacial/criterion'
+require 'mongoid_spacial/extentions/hash/criteria_helpers'
+require 'mongoid_spacial/extentions/symbol/inflections'
+require 'mongoid_spacial/field_option'
+require 'mongoid_spacial/finders'
+require 'mongoid_spacial/spacial'

data/lib/mongoid_spacial/contexts/mongo.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Contexts #:nodoc:
+    class Mongo #:nodoc:
+      
+      # Fetches rows from the data base sorted by distance.
+      # In MongoDB versions 1.7 and above it returns a distance.
+      # Uses all criteria chains except without, only, asc, desc, order_by
+      #
+      # @example Minimal Query
+      #   
+      #   Address.geo_near([70,40])
+      #
+      # @example Chained Query
+      #   
+      #   Address.where(:state => 'ny').geo_near([70,40])
+      #
+      # @example Calc Distances Query
+      #   
+      #   Address.geo_near([70,40], :max_distance => 5, :unit => 5)
+      #
+      # @param [ Array, Hash, #to_lng_lat ] center The center of where to calculate distance from
+      # @param [ Hash ] opts the options to query with
+      # @options opts [Integer] :num The number of rows to fetch
+      # @options opts [Hash] :query The query to filter the rows by, accepts
+      # @options opts [Numeric] :distance_multiplier this is multiplied against the calculated distance
+      # @options opts [Numeric] :max_distance The max distance of a row that should be returned in :unit(s)
+      # @options opts [Numeric, :km, :k, :mi, :ft] :unit automatically sets :distance_multiplier and converts :max_distance
+      # @options opts [true,false] :spherical Will determine the distance either by spherical calculation or flat calculation
+      # @options opts [TrueClass,Array<Symbol>] :calculate Which extra fields to calculate distance for in ruby, if set to TrueClass it will calculate all spacial fields
+      #
+      # @return [ Array ] Sorted Rows
+      def geo_near(center, opts = {})
+        center = center.to_lng_lat if center.respond_to?(:to_lng_lat)
+
+        if distance_multiplier = Mongoid::Spacial.earth_radius[opts.delete(:unit)]
+          opts[:distance_multiplier] = distance_multiplier
+        end
+
+        query = create_geo_near_query(center,opts)
+        results = klass.db.command(query)
+        if results['results'].kind_of?(Array) && results['results'].size > 0
+          rows = results['results'].collect do |result|
+            res = Mongoid::Factory.from_db(klass, result.delete('obj'))
+            res.geo = {}
+            # camel case is awkward in ruby when using variables...
+            if result['dis']
+              res.geo[:distance] = result.delete('dis').to_f
+            end
+            result.each do |key,value|
+              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
+              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|
+                key = (key.to_s+'_distance').to_s
+                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
+        else
+          rows = []
+        end
+        # if opts.has_key?(:page) || opts[:paginator]
+        #   opts[:paginator] ||= Mongoid::Spacial::Config.paginator
+        #   if opts[:paginator] == :kaminari
+
+        #   elsif opts[:paginator] == :will_paginate
+        #   end
+        # end
+
+        if self.options[:skip] && rows.size > self.options[:skip]
+          rows[self.options[:skip]..rows.size-1]
+        else
+          rows
+        end
+      end
+
+      private
+
+      def create_geo_near_query(center,opts)
+        # minimum query
+        query = {
+          :geoNear  => klass.to_s.tableize,
+          :near     => center, 
+        }
+
+        # create limit and use skip
+        if opts[:num] 
+          query['num']         = (self.options[:skip] || 0) + opts[:num].to_i          
+        elsif self.options[:limit]
+          query['num']         = (self.options[:skip] || 0) + self.options[:limit]
+        end
+
+        # allow the use of complex werieis
+        if opts[:query]
+          query['query']         = self.criteria.where(opts[:query]).selector
+        elsif self.selector != {}
+          query['query']         = self.selector
+        end
+
+        if opts[:max_distance]
+          query['maxDistance'] = opts[:max_distance]
+          query['maxDistance'] = query['maxDistance']/opts[:distance_multiplier] if opts[:distance_multiplier]
+        end
+
+        if klass.db.connection.server_version >= '1.7'          
+          query['spherical']  = true if opts[:spherical]
+
+          # mongodb < 1.7 returns degrees but with earth flat. in Mongodb 1.7 you can set sphere and let mongodb calculate the distance in Miles or KM
+          # for mongodb < 1.7 we need to run Haversine first before calculating degrees to Km or Miles. See below.
+          query['distanceMultiplier'] = opts[:distance_multiplier] if opts[:distance_multiplier]
+        end
+        query
+      end
+    end
+  end
+end

data/lib/mongoid_spacial/criteria.rb

@@ -0,0 +1,5 @@
+module Mongoid #:nodoc:
+  class Criteria
+    delegate :geo_near, :to => :context 
+  end
+end

data/lib/mongoid_spacial/criterion.rb

@@ -0,0 +1,8 @@
+require 'mongoid_spacial/criterion/complex'
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+    autoload :NearSpacial,     'mongoid_spacial/criterion/near_spacial'
+    autoload :WithinSpacial,    'mongoid_spacial/criterion/within_spacial'
+  end
+end

data/lib/mongoid_spacial/criterion/complex.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+    # Complex criterion are used when performing operations on symbols to get
+    # get a shorthand syntax for where clauses.
+    #
+    # Example:
+    #
+    # <tt>{ :field => { "$lt" => "value" } }</tt>
+    # becomes:
+    # <tt> { :field.lt => "value }</tt>
+    class Complex
+      
+      def to_mongo_query v
+        {"$#{operator}" => v}
+      end
+    end
+  end
+end

data/lib/mongoid_spacial/criterion/inclusion.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+    module Inclusion
+      def near(attributes = {})
+        update_selector(attributes, "$near")
+      end
+
+      def near_sphere(attributes = {})
+        update_selector(attributes, "$near")
+      end
+    end
+  end
+end

data/lib/mongoid_spacial/criterion/near_spacial.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+
+    # NearSpecial criterion is used when performing #near with symbols to get
+    # get a shorthand syntax for where clauses. 
+    #
+    # @example Conversion of a simple to complex criterion.
+    #   { :field => { "$nearSphere" => => [20,30]}, '$maxDistance' => 5 } 
+    #   becomes:
+    #   { :field.near(:sphere) => {:point => [20,30], :max => 5, :unit => :km} }
+    class NearSpacial < Complex
+      
+      # Convert input to query for near or nearSphere
+      #
+      # @example
+      #   near = NearSpacial.new(:key => :field, :operator => "near")
+      #   near.to_mongo_query({:point => [:50,50], :max_distance => 5, :unit => :km}) => { '$near : [50,50]' , '$maxDistance' : 5 }
+      #
+      # @param [Hash,Array] v input to conver to query
+      def to_mongo_query(v)
+        if v.kind_of? Hash
+          v[:point] = v[:point].to_lng_lat if v[:point].respond_to?(:to_lng_lat)
+          query = {"$#{operator}" => v[:point] }
+          if v[:max]
+            unit = Mongoid::Spacial.earth_radius[v[:unit]]
+            query['$maxDistance'] = (unit) ? v[:max]/unit : v[:max] 
+          end
+          query
+        elsif v.kind_of? Array
+          if v.first.kind_of? Numeric
+            {"$#{operator}" => v }
+          else
+            v[0] = v[0].to_lng_lat if v[0].respond_to?(:to_lng_lat)
+            {"$#{operator}" => v[0], '$maxDistance' => v[1] }
+          end
+        end
+      end
+
+    end
+  end
+end
+