Module: Geokit::ActsAsMappable::ClassMethods

Defined in:
lib/geokit-rails/acts_as_mappable.rb

Overview

Class methods included in models when acts_as_mappable is called

Instance Method Summary collapse

Instance Method Details

#beyond(distance, options = {}) ⇒ Object Also known as: outside 



130
131
132
133
134
 
# File 'lib/geokit-rails/acts_as_mappable.rb', line 130

def beyond(distance, options = {})
  options[:beyond] = distance
  #geo_scope(options)
  where(distance_conditions(options))
end

#by_distance(options = {}) ⇒ Object 



151
152
153
154
155
156
157
 
# File 'lib/geokit-rails/acts_as_mappable.rb', line 151

def by_distance(options = {})
  origin  = extract_origin_from_options(options)
  units   = extract_units_from_options(options)
  formula = extract_formula_from_options(options)
  distance_column_name = distance_sql(origin, units, formula)
  with_latlng.order("#{distance_column_name} #{options[:reverse] ? 'DESC' : 'ASC'}")
end

#closest(options = {}) ⇒ Object Also known as: nearest 



163
164
165
 
# File 'lib/geokit-rails/acts_as_mappable.rb', line 163

def closest(options = {})
  by_distance(options).limit(1)
end

#distance_sql(origin, units = default_units, formula = default_formula) ⇒ Object

Returns the distance calculation to be used as a display column or a condition. This is provide for anyone wanting access to the raw SQL.



210
211
212
213
214
215
216
217
218
 
# File 'lib/geokit-rails/acts_as_mappable.rb', line 210

def distance_sql(origin, units=default_units, formula=default_formula)
  case formula
  when :sphere
    sql = sphere_distance_sql(origin, units)
  when :flat
    sql = flat_distance_sql(origin, units)
  end
  sql
end

#farthest(options = {}) ⇒ Object 



168
169
170
 
# File 'lib/geokit-rails/acts_as_mappable.rb', line 168

def farthest(options = {})
  by_distance({:reverse => true}.merge(options)).limit(1)
end

#geokit_finder_adapter ⇒ Object

A proxy to an instance of a finder adapter, inferred from the connection’s adapter.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/geokit-rails/acts_as_mappable.rb', line 97

def geokit_finder_adapter
  @geokit_finder_adapter ||= begin
    unless Adapters.const_defined?(connection.adapter_name.camelcase)
      filename = connection.adapter_name.downcase
      require File.join("geokit-rails", "adapters", filename)
    end
    klass = Adapters.const_get(connection.adapter_name.camelcase)
    if klass.class == Module
      # For some reason Mysql2 adapter was defined in Adapters.constants but was Module instead of a Class
      filename = connection.adapter_name.downcase
      require File.join("geokit-rails", "adapters", filename)
      # Re-init the klass after require
      klass = Adapters.const_get(connection.adapter_name.camelcase)
    end
    klass.load(self) unless klass.loaded || skip_loading
    klass.new(self)
  rescue LoadError
    raise UnsupportedAdapter, "`#{connection.adapter_name.downcase}` is not a supported adapter."
  end
end

#in_bounds(bounds, options = {}) ⇒ Object 



143
144
145
146
147
148
149
 
# File 'lib/geokit-rails/acts_as_mappable.rb', line 143

def in_bounds(bounds, options = {})
  options[:bounds] = bounds
  #geo_scope(options)
  #where(distance_conditions(options))
  bounds  = extract_bounds_from_options(options)
  where(bound_conditions(bounds))
end

#in_range(range, options = {}) ⇒ Object 



137
138
139
140
141
 
# File 'lib/geokit-rails/acts_as_mappable.rb', line 137

def in_range(range, options = {})
  options[:range] = range
  #geo_scope(options)
  where(distance_conditions(options))
end

#with_latlng ⇒ Object 



159
160
161
 
# File 'lib/geokit-rails/acts_as_mappable.rb', line 159

def with_latlng
  where("#{qualified_lat_column_name} IS NOT NULL AND #{qualified_lng_column_name} IS NOT NULL")
end

#within(distance, options = {}) ⇒ Object Also known as: inside 



118
119
120
121
122
123
124
125
126
127
 
# File 'lib/geokit-rails/acts_as_mappable.rb', line 118

def within(distance, options = {})
  options[:within] = distance
  # Add bounding box to speed up SQL request.
  bounds = formulate_bounds_from_distance(
    options,
    normalize_point_to_lat_lng(options[:origin]),
    options[:units] || default_units)
  with_latlng.where(bound_conditions(bounds)).
    where(distance_conditions(options))
end