]> git.openstreetmap.org Git - rails.git/blobdiff - lib/bounding_box.rb
Add missing headers to docs
[rails.git] / lib / bounding_box.rb
index 38b994d26a6e11233983adcf6cbd730e5198af70..462f45a9f1ca329ecd7c0096557876e9f06ea724 100644 (file)
@@ -1,13 +1,11 @@
 class BoundingBox
   attr_reader :min_lon, :min_lat, :max_lon, :max_lat
 
-private
   LON_LIMIT = 180.0
   LAT_LIMIT = 90.0
-  SCALED_LON_LIMIT = LON_LIMIT *  GeoRecord::SCALE
-  SCALED_LAT_LIMIT = LAT_LIMIT *  GeoRecord::SCALE
+  SCALED_LON_LIMIT = LON_LIMIT * GeoRecord::SCALE
+  SCALED_LAT_LIMIT = LAT_LIMIT * GeoRecord::SCALE
 
-public
   def initialize(min_lon, min_lat, max_lon, max_lat)
     @min_lon = min_lon.to_f unless min_lon.nil?
     @min_lat = min_lat.to_f unless min_lat.nil?
@@ -16,31 +14,21 @@ public
   end
 
   def self.from_s(s)
-    if s.count(',') == 3
-      BoundingBox.new(*s.split(/,/))
-    else
-      nil
-    end
+    BoundingBox.new(*s.split(",")) if s.count(",") == 3
   end
 
   def self.from_bbox_params(params)
-    if params[:bbox] and params[:bbox].count(',') == 3
-      bbox_array = params[:bbox].split(',')
-    end
+    bbox_array = params[:bbox].split(",") if params[:bbox] && params[:bbox].count(",") == 3
     from_bbox_array(bbox_array)
   end
 
   def self.from_lon_lat_params(params)
-    if params[:minlon] and params[:minlat] and params[:maxlon] and params[:maxlat]
-      bbox_array = [params[:minlon], params[:minlat], params[:maxlon], params[:maxlat]]
-    end
+    bbox_array = [params[:minlon], params[:minlat], params[:maxlon], params[:maxlat]] if params[:minlon] && params[:minlat] && params[:maxlon] && params[:maxlat]
     from_bbox_array(bbox_array)
   end
 
   def self.from_lrbt_params(params)
-    if params[:l] and params[:b] and params[:t] and params[:t]
-      bbox_array = [params[:l], params[:b], params[:r], params[:t]]
-    end
+    bbox_array = [params[:l], params[:b], params[:r], params[:t]] if params[:l] && params[:b] && params[:t] && params[:t]
     from_bbox_array(bbox_array)
   end
 
@@ -49,40 +37,43 @@ public
     # only try to expand the bbox if there is a value for every coordinate
     # which there will be from the previous line as long as array does not contain a nil
     if bbox.complete?
-      @min_lon = [-SCALED_LON_LIMIT,
-                  bbox.min_lon + margin * (min_lon - max_lon)].max if bbox.min_lon < min_lon
-      @min_lat = [-SCALED_LAT_LIMIT,
-                  bbox.min_lat + margin * (min_lat - max_lat)].max if bbox.min_lat < min_lat
-      @max_lon = [+SCALED_LON_LIMIT,
-                  bbox.max_lon + margin * (max_lon - min_lon)].min if bbox.max_lon > max_lon
-      @max_lat = [+SCALED_LAT_LIMIT,
-                  bbox.max_lat + margin * (max_lat - min_lat)].min if bbox.max_lat > max_lat
+      if bbox.min_lon < min_lon
+        @min_lon = [-SCALED_LON_LIMIT,
+                    bbox.min_lon + (margin * (min_lon - max_lon))].max
+      end
+      if bbox.min_lat < min_lat
+        @min_lat = [-SCALED_LAT_LIMIT,
+                    bbox.min_lat + (margin * (min_lat - max_lat))].max
+      end
+      if bbox.max_lon > max_lon
+        @max_lon = [+SCALED_LON_LIMIT,
+                    bbox.max_lon + (margin * (max_lon - min_lon))].min
+      end
+      if bbox.max_lat > max_lat
+        @max_lat = [+SCALED_LAT_LIMIT,
+                    bbox.max_lat + (margin * (max_lat - min_lat))].min
+      end
     end
     self
   end
 
   def check_boundaries
     # check the bbox is sane
-    if min_lon > max_lon
-      raise OSM::APIBadBoundingBox.new(
-        "The minimum longitude must be less than the maximum longitude, but it wasn't")
-    end
-    if min_lat > max_lat
-      raise OSM::APIBadBoundingBox.new(
-        "The minimum latitude must be less than the maximum latitude, but it wasn't")
-    end
+    raise OSM::APIBadBoundingBox, "The minimum longitude must be less than the maximum longitude, but it wasn't" if min_lon > max_lon
+    raise OSM::APIBadBoundingBox, "The minimum latitude must be less than the maximum latitude, but it wasn't" if min_lat > max_lat
+
     if min_lon < -LON_LIMIT || min_lat < -LAT_LIMIT || max_lon > +LON_LIMIT || max_lat > +LAT_LIMIT
-      raise OSM::APIBadBoundingBox.new("The latitudes must be between #{-LAT_LIMIT} and #{LAT_LIMIT}," +
-                                       " and longitudes between #{-LON_LIMIT} and #{LON_LIMIT}")
+      raise OSM::APIBadBoundingBox, "The latitudes must be between #{-LAT_LIMIT} and #{LAT_LIMIT}, " \
+                                    "and longitudes between #{-LON_LIMIT} and #{LON_LIMIT}"
     end
     self
   end
 
-  def check_size(max_area = MAX_REQUEST_AREA)
+  def check_size(max_area = Settings.max_request_area)
     # check the bbox isn't too large
     if area > max_area
-      raise OSM::APIBadBoundingBox.new("The maximum bbox size is " + max_area.to_s +
-        ", and your request was too large. Either request a smaller area, or use planet.osm")
+      raise OSM::APIBadBoundingBox, "The maximum bbox size is #{max_area}" \
+                                    ", and your request was too large. Either request a smaller area, or use planet.osm"
     end
     self
   end
@@ -97,8 +88,16 @@ public
     end
   end
 
+  def linear_size
+    if complete?
+      (max_lon - min_lon) + (max_lat - min_lat)
+    else
+      0
+    end
+  end
+
   def complete?
-    not to_a.include?(nil)
+    to_a.exclude?(nil)
   end
 
   def centre_lon
@@ -118,25 +117,25 @@ public
   end
 
   def slippy_width(zoom)
-    width * 256.0 * 2.0 ** zoom / 360.0
+    width * 256.0 * (2.0**zoom) / 360.0
   end
 
   def slippy_height(zoom)
     min = min_lat * Math::PI / 180.0
     max = max_lat * Math::PI / 180.0
 
-    Math.log((Math.tan(max) + 1.0 / Math.cos(max)) /
-             (Math.tan(min) + 1.0 / Math.cos(min))) *
-             (128.0 * 2.0 ** zoom / Math::PI)
+    Math.log((Math.tan(max) + (1.0 / Math.cos(max))) /
+             (Math.tan(min) + (1.0 / Math.cos(min)))) *
+      (128.0 * (2.0**zoom) / Math::PI)
   end
 
   # there are two forms used for bounds with and without an underscore,
   # cater for both forms eg minlon and min_lon
   def add_bounds_to(hash, underscore = "")
-    hash["min#{underscore}lat"] = min_lat.to_s
-    hash["min#{underscore}lon"] = min_lon.to_s
-    hash["max#{underscore}lat"] = max_lat.to_s
-    hash["max#{underscore}lon"] = max_lon.to_s
+    hash["min#{underscore}lat"] = format("%<lat>.7f", :lat => min_lat)
+    hash["min#{underscore}lon"] = format("%<lon>.7f", :lon => min_lon)
+    hash["max#{underscore}lat"] = format("%<lat>.7f", :lat => max_lat)
+    hash["max#{underscore}lon"] = format("%<lon>.7f", :lon => max_lon)
     hash
   end
 
@@ -162,19 +161,20 @@ public
     "#{min_lon},#{min_lat},#{max_lon},#{max_lat}"
   end
 
-  private
-  def self.from_bbox_array(bbox_array)
-    unless bbox_array
-      raise OSM::APIBadUserInput.new(
-        "The parameter bbox is required, and must be of the form min_lon,min_lat,max_lon,max_lat")
+  class << self
+    private
+
+    def from_bbox_array(bbox_array)
+      raise OSM::APIBadUserInput, "The parameter bbox must be of the form min_lon,min_lat,max_lon,max_lat" unless bbox_array
+
+      # Take an array of length 4, create a bounding box with min_lon, min_lat, max_lon and
+      # max_lat within their respective boundaries.
+      min_lon = bbox_array[0].to_f.clamp(-LON_LIMIT, +LON_LIMIT)
+      min_lat = bbox_array[1].to_f.clamp(-LAT_LIMIT, +LAT_LIMIT)
+      max_lon = bbox_array[2].to_f.clamp(-LON_LIMIT, +LON_LIMIT)
+      max_lat = bbox_array[3].to_f.clamp(-LAT_LIMIT, +LAT_LIMIT)
+      BoundingBox.new(min_lon, min_lat, max_lon, max_lat)
     end
-    # Take an array of length 4, create a bounding box with min_lon, min_lat, max_lon and
-    # max_lat within their respective boundaries.
-    min_lon = [[bbox_array[0].to_f, -LON_LIMIT].max, +LON_LIMIT].min
-    min_lat = [[bbox_array[1].to_f, -LAT_LIMIT].max, +LAT_LIMIT].min
-    max_lon = [[bbox_array[2].to_f, +LON_LIMIT].min, -LON_LIMIT].max
-    max_lat = [[bbox_array[3].to_f, +LAT_LIMIT].min, -LAT_LIMIT].max
-    BoundingBox.new(min_lon, min_lat, max_lon, max_lat)
   end
 
   def update!(bbox)