mongoid_spacial 0.0.1

data/lib/mongoid_spacial/criterion/within_spacial.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+
+    # WithinSpecial criterion is used when performing #within with symbols to get
+    # get a shorthand syntax for where clauses.
+    #
+    # @example Conversion of a simple to complex criterion.
+    #   { :field => { "$within" => {'$center' => [20,30]} } }
+    #   becomes:
+    #   { :field.within(:center) => [20,30] }
+    class WithinSpacial < Complex
+
+      # Convert input to query for box, polygon, center, and centerSphere
+      #
+      # @example
+      #   within = WithinSpacial.new(opts[:key] => 'point', :operator => 'center')
+      #   within.to_mongo_query({:point => [20,30], :max => 5, :unit => :km}) #=>
+      #
+      # @param [Hash,Array] input Variable to conver to query
+      def to_mongo_query(input)
+        if ['box','polygon'].index(@operator)
+          input = input.values if input.kind_of?(Hash)
+          if input.respond_to?(:map)
+            input.map!{ |v| (v.respond_to?(:to_lng_lat)) ? v.to_lng_lat : v }
+          else
+            input
+          end
+        elsif ['center','centerSphere'].index(@operator)
+
+          if input.kind_of? Hash
+            if input[:point]
+              input[:point] = input[:point].to_lng_lat if input[:point].respond_to?(:to_lng_lat)
+              if input[:max]
+                unit = Mongoid::Spacial.earth_radius[input[:unit]]
+                input[:max] = input[:max]/unit if unit
+                input = [input[:point],input[:max]]
+              else
+                input = input[:point]
+              end
+            elsif RUBY_VERSION.to_f > 1.9
+              input = input.values
+            end
+          end
+
+          if input.kind_of? Array
+            input[0] = input[0].to_lng_lat if input[0].respond_to?(:to_lng_lat)
+          end
+
+        end
+        {'$within' => {"$#{@operator}"=>input} }
+      end
+    end
+  end
+end
+

data/lib/mongoid_spacial/extentions/hash/criteria_helpers.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Hash #:nodoc:
+      module CriteriaHelpers #:nodoc:
+        def expand_complex_criteria
+          hsh = {} 
+          each_pair do |k,v|
+            if k.respond_to?(:key) && k.respond_to?(:to_mongo_query)
+              hsh[k.key] ||= {}
+              hsh[k.key].merge!(k.to_mongo_query(v))
+            else
+              hsh[k] = v
+            end
+          end
+          hsh
+        end
+      end
+    end
+  end
+end
+

data/lib/mongoid_spacial/extentions/symbol/inflections.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Symbol #:nodoc:
+      module Inflections #:nodoc:
+
+        # return a class that will accept a value to convert the query correctly for near
+        #
+        # @param [Symbol] calc This accepts :sphere
+        #
+        # @return [Criterion::NearSpacial]
+
+        def near(calc = :flat)
+          Criterion::NearSpacial.new(:operator => get_op('near',calc), :key => self)          
+        end
+
+        # alias for self.near(:sphere)
+        #
+        # @return [Criterion::NearSpacial]
+        def near_sphere
+          self.near(:sphere)
+        end
+        
+        # @param [Symbol] shape :box,:polygon,:center,:center_sphere
+        #
+        # @return [Criterion::WithinSpacial]
+        def within(shape)
+          shape = get_op(:center,:sphere) if shape == :center_sphere
+          Criterion::WithinSpacial.new(:operator => shape.to_s , :key => self)
+        end
+
+        private
+
+        def get_op operator, calc
+          if calc.to_sym == :sphere && Mongoid.master.connection.server_version >= '1.7'
+            "#{operator}Sphere"
+          elsif calc.to_sym == :sphere
+            raise "MongoDB Server version #{Mongoid.master.connection.server_version} does not have Spherical Calculation"
+          else
+            operator.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid_spacial/field_option.rb

@@ -0,0 +1,36 @@
+require 'ostruct'
+# Field changes to Fields from mongoid 2.0 to mongoid 2.1
+field = (defined?(Mongoid::Field)) ? Mongoid::Field : Mongoid::Fields
+
+field.option :spacial do |model,field,options|
+  options = {} unless options.kind_of?(Hash)
+  lat_meth = options[:lat] || "lat"
+  lng_meth = options[:lng] || "lng"
+  model.class_eval do
+    self.spacial_fields ||= []
+    self.spacial_fields << field.name.to_sym if self.spacial_fields.kind_of? Array
+
+    define_method "distance_from_#{field.name}" do |*args|
+      self.distance_from(field.name, *args)
+    end
+
+    define_method field.name do
+      output = self[field.name] || [nil,nil]
+      output = (options[:return_array]) ? lng_lat_a : {lng_meth => output[0], lat_meth => output[0]}
+      return options[:class].new(output) if options[:class]
+      output
+    end
+
+    define_method "#{field.name}=" do |arg|
+      if arg.kind_of?(Hash) && arg[lng_meth] && arg[lat_meth]
+        arg = [arg[lng_meth], arg[lat_meth]]
+      elsif arg.respond_to?(:to_lng_lat)
+        arg = arg.to_lat_lng if arg.respond_to?(:to_lat_lng)
+      end
+      self[field.name]=arg
+      return arg[0..1] if options[:return_array]
+      return h = {lng_meth => arg[0], lat_meth => arg[0]} if options[:class].blank?
+      options[:class].new(h)
+    end
+  end
+end

data/lib/mongoid_spacial/finders.rb

@@ -0,0 +1,5 @@
+module Mongoid #:nodoc:
+  module Finders
+    delegate :geo_near, :to => :criteria 
+  end
+end

data/lib/mongoid_spacial/spacial.rb

@@ -0,0 +1,37 @@
+require 'mongoid_spacial/spacial/core_ext'
+module Mongoid
+  module Spacial
+    autoload :Formulas,          'mongoid_spacial/spacial/formulas'
+    autoload :Document,          'mongoid_spacial/spacial/document'
+    
+    EARTH_RADIUS_KM = 6371 # taken directly from mongodb
+
+    EARTH_RADIUS = {
+      :km => EARTH_RADIUS_KM,
+      :m  => EARTH_RADIUS_KM*1000,
+      :mi => EARTH_RADIUS_KM*0.621371192, # taken directly from mongodb
+      :ft => EARTH_RADIUS_KM*5280*0.621371192,
+    }
+    
+    LNG_SYMBOLS = [:x, :lon, :long, :lng, :longitude]
+    LAT_SYMBOLS = [:y, :lat, :latitude]
+
+    def distance(p1,p2,unit = nil, formula = nil)
+      formula ||= self.distance_formula
+      unit = earth_radius[unit] if unit.kind_of?(Symbol) && earth_radius[unit]
+      rads = Formulas.send(formula, p1, p2)
+      (unit.kind_of?(Numeric)) ? unit*rads : rads
+    end
+    mattr_accessor :lng_symbols
+    @@lng_symbols = LNG_SYMBOLS.dup
+
+    mattr_accessor :lat_symbols
+    @@lat_symbols = LAT_SYMBOLS.dup
+
+    mattr_accessor :earth_radius
+    @@earth_radius = EARTH_RADIUS.dup
+
+    mattr_accessor :distance_formula
+    @@distance_formula = :n_vector
+  end
+end

data/lib/mongoid_spacial/spacial/core_ext.rb

@@ -0,0 +1,27 @@
+class Array
+  def to_lng_lat
+    self[0..1].map(&:to_f)
+  end
+end  
+
+class Hash
+  def to_lng_lat
+    raise "Hash must have at least 2 items" if self.size < 2
+    [to_lng, to_lat]
+  end
+
+  def to_lat
+    v = (Mongoid::Spacial.lat_symbols & self.keys).first
+    return self[v] if !v.nil? && self[v]
+    raise "Hash must contain #{Mongoid::Spacial.lat_symbols.inspect} if ruby version is less than 1.9" if RUBY_VERSION.to_f < 1.9
+    raise "Hash cannot contain #{Mongoid::Spacial.lng_symbols.inspect} as the second item if there is no #{Mongoid::Spacial.lat_symbols.inspect}" if Mongoid::Geo.lng_symbols.index(self.keys[1])    
+    self.values[1]
+  end
+
+  def to_lng
+    v = (Mongoid::Spacial.lng_symbols & self.keys).first
+    return self[v] if !v.nil? && self[v]
+    raise "Hash cannot contain #{Mongoid::Spacial.lat_symbols.inspect} as the first item if there is no #{Mongoid::Spacial.lng_symbols.inspect}" if Mongoid::Geo.lat_symbols.index(self.keys[0])
+    self.values[0]
+  end
+end 

data/lib/mongoid_spacial/spacial/document.rb

@@ -0,0 +1,31 @@
+module Mongoid
+  module Spacial
+    module Document 
+      extend ActiveSupport::Concern
+
+      included do
+        attr_accessor :geo
+        cattr_accessor :spacial_fields, :spacial_fields_indexed
+        @@spacial_fields = []
+        @@spacial_fields_indexed = []
+      end
+
+      module ClassMethods #:nodoc:
+        # create spacial index for given field
+        # @param [String,Symbol] name
+        # @param [Hash] options options for spacial_index
+        def spacial_index name, *options
+          self.spacial_fields_indexed << name
+          index [[ name, Mongo::GEO2D ]], *options
+        end
+      end
+
+      module InstanceMethods #:nodoc:
+        def distance_from(key,center, unit = nil, formula = nil)
+          loc = res.send(key)
+          Mongoid::Spacial.distance(center, loc, unit, formula = nil)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid_spacial/spacial/formulas.rb

@@ -0,0 +1,47 @@
+module Mongoid
+  module Spacial
+    module Formulas
+      RAD_PER_DEG = 0.017453293
+
+      def n_vector(p1,p2)
+        sin_x1 = Math.sin(p1[0])
+        cos_x1 = Math.cos(p1[0])
+
+        sin_y1 = Math.sin(p1[1])
+        cos_y1 = Math.cos(p1[1])
+
+        sin_x2 = Math.sin(p2[0])
+        cos_x2 = Math.cos(p2[0])
+
+        sin_y2 = Math.sin(p2[1])
+        cos_y2 = Math.cos(p2[1])
+
+        cross_prod =  (cos_y1*cos_x1 * cos_y2*cos_x2) +
+          (cos_y1*sin_x1 * cos_y2*sin_x2) +
+          (sin_y1        * sin_y2)
+        Math.acos(cross_prod)
+      end
+
+      def haversine(p1,p2)
+        lon1,lat1=p1
+        lon2,lat2=p2
+
+        dlon = lon2 - lon1
+        dlat = lat2 - lat1
+
+        dlon_rad = dlon * RAD_PER_DEG
+        dlat_rad = dlat * RAD_PER_DEG
+
+        lat1_rad = lat1 * RAD_PER_DEG
+        lon1_rad = lon1 * RAD_PER_DEG
+
+        lat2_rad = lat2 * RAD_PER_DEG
+        lon2_rad = lon2 * RAD_PER_DEG
+
+        a = (Math.sin(dlat_rad/2))**2 + Math.cos(lat1_rad) * Math.cos(lat2_rad) * (Math.sin(dlon_rad/2))**2
+
+        2 * Math.atan2( Math.sqrt(a), Math.sqrt(1-a))
+      end
+    end
+  end
+end

data/mongoid_spacial.gemspec

@@ -0,0 +1,172 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mongoid_spacial}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Ryan Ong}]
+  s.date = %q{2011-06-22}
+  s.description = %q{A Mongoid Extention that simplifies and adds support for MongoDB Geo Spacial Calculations.}
+  s.email = %q{ryanong@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/mongoid_spacial.rb",
+    "lib/mongoid_spacial/contexts/mongo.rb",
+    "lib/mongoid_spacial/criteria.rb",
+    "lib/mongoid_spacial/criterion.rb",
+    "lib/mongoid_spacial/criterion/complex.rb",
+    "lib/mongoid_spacial/criterion/inclusion.rb",
+    "lib/mongoid_spacial/criterion/near_spacial.rb",
+    "lib/mongoid_spacial/criterion/within_spacial.rb",
+    "lib/mongoid_spacial/extentions/hash/criteria_helpers.rb",
+    "lib/mongoid_spacial/extentions/symbol/inflections.rb",
+    "lib/mongoid_spacial/field_option.rb",
+    "lib/mongoid_spacial/finders.rb",
+    "lib/mongoid_spacial/spacial.rb",
+    "lib/mongoid_spacial/spacial/core_ext.rb",
+    "lib/mongoid_spacial/spacial/document.rb",
+    "lib/mongoid_spacial/spacial/formulas.rb",
+    "mongoid_spacial.gemspec",
+    "spec/config/mongod.conf",
+    "spec/config/mongoid.yml",
+    "spec/functional/mongoid/contexts/mongo_spec.rb",
+    "spec/functional/mongoid/criterion/inclusion_spec.rb",
+    "spec/models/account.rb",
+    "spec/models/acolyte.rb",
+    "spec/models/address.rb",
+    "spec/models/address_component.rb",
+    "spec/models/agent.rb",
+    "spec/models/alert.rb",
+    "spec/models/animal.rb",
+    "spec/models/answer.rb",
+    "spec/models/bar.rb",
+    "spec/models/birthday.rb",
+    "spec/models/book.rb",
+    "spec/models/business.rb",
+    "spec/models/callbacks.rb",
+    "spec/models/category.rb",
+    "spec/models/circus.rb",
+    "spec/models/comment.rb",
+    "spec/models/country_code.rb",
+    "spec/models/description.rb",
+    "spec/models/division.rb",
+    "spec/models/drug.rb",
+    "spec/models/employer.rb",
+    "spec/models/entry.rb",
+    "spec/models/event.rb",
+    "spec/models/favorite.rb",
+    "spec/models/fruits.rb",
+    "spec/models/game.rb",
+    "spec/models/ghost.rb",
+    "spec/models/house.rb",
+    "spec/models/inheritance.rb",
+    "spec/models/league.rb",
+    "spec/models/location.rb",
+    "spec/models/login.rb",
+    "spec/models/membership.rb",
+    "spec/models/mixed_drink.rb",
+    "spec/models/name.rb",
+    "spec/models/namespacing.rb",
+    "spec/models/observed.rb",
+    "spec/models/override.rb",
+    "spec/models/owner.rb",
+    "spec/models/page.rb",
+    "spec/models/page_question.rb",
+    "spec/models/paranoid_post.rb",
+    "spec/models/parents.rb",
+    "spec/models/patient.rb",
+    "spec/models/person.rb",
+    "spec/models/pet.rb",
+    "spec/models/pet_owner.rb",
+    "spec/models/phone.rb",
+    "spec/models/player.rb",
+    "spec/models/post.rb",
+    "spec/models/preference.rb",
+    "spec/models/question.rb",
+    "spec/models/quiz.rb",
+    "spec/models/rating.rb",
+    "spec/models/river.rb",
+    "spec/models/role.rb",
+    "spec/models/service.rb",
+    "spec/models/shelf.rb",
+    "spec/models/slave_address_numbers.rb",
+    "spec/models/survey.rb",
+    "spec/models/tag.rb",
+    "spec/models/tracking_id_validation_history.rb",
+    "spec/models/translation.rb",
+    "spec/models/tree.rb",
+    "spec/models/user.rb",
+    "spec/models/user_account.rb",
+    "spec/models/vet_visit.rb",
+    "spec/models/video.rb",
+    "spec/models/wiki_page.rb",
+    "spec/spec_helper.rb",
+    "spec/support/authentication.rb",
+    "spec/unit/mongoid_spacial/criterion/complex_spec.rb",
+    "spec/unit/mongoid_spacial/criterion/inclusion_spec.rb",
+    "spec/unit/mongoid_spacial/criterion/near_spacial_spec.rb",
+    "spec/unit/mongoid_spacial/criterion/within_spacial_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/ryanong/mongoid_spacial}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{A Mongoid Extention that simplifies and adds support for MongoDB Geo Spacial Calculations.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    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<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.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_development_dependency(%q<linecache19>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
+    else
+      s.add_dependency(%q<mongoid>, [">= 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"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<linecache19>, [">= 0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mongoid>, [">= 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"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<linecache19>, [">= 0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
+  end
+end
+