Fix most auto-correctable rubocop issues
[rails.git] / lib / bounding_box.rb
1 class BoundingBox
2   attr_reader :min_lon, :min_lat, :max_lon, :max_lat
3
4   private
5
6   LON_LIMIT = 180.0
7   LAT_LIMIT = 90.0
8   SCALED_LON_LIMIT = LON_LIMIT *  GeoRecord::SCALE
9   SCALED_LAT_LIMIT = LAT_LIMIT *  GeoRecord::SCALE
10
11   public
12
13   def initialize(min_lon, min_lat, max_lon, max_lat)
14     @min_lon = min_lon.to_f unless min_lon.nil?
15     @min_lat = min_lat.to_f unless min_lat.nil?
16     @max_lon = max_lon.to_f unless max_lon.nil?
17     @max_lat = max_lat.to_f unless max_lat.nil?
18   end
19
20   def self.from_s(s)
21     if s.count(',') == 3
22       BoundingBox.new(*s.split(/,/))
23     else
24       nil
25     end
26   end
27
28   def self.from_bbox_params(params)
29     if params[:bbox] && params[:bbox].count(',') == 3
30       bbox_array = params[:bbox].split(',')
31     end
32     from_bbox_array(bbox_array)
33   end
34
35   def self.from_lon_lat_params(params)
36     if params[:minlon] && params[:minlat] && params[:maxlon] && params[:maxlat]
37       bbox_array = [params[:minlon], params[:minlat], params[:maxlon], params[:maxlat]]
38     end
39     from_bbox_array(bbox_array)
40   end
41
42   def self.from_lrbt_params(params)
43     if params[:l] && params[:b] && params[:t] && params[:t]
44       bbox_array = [params[:l], params[:b], params[:r], params[:t]]
45     end
46     from_bbox_array(bbox_array)
47   end
48
49   def expand!(bbox, margin = 0)
50     update!(bbox) unless complete?
51     # only try to expand the bbox if there is a value for every coordinate
52     # which there will be from the previous line as long as array does not contain a nil
53     if bbox.complete?
54       @min_lon = [-SCALED_LON_LIMIT,
55                   bbox.min_lon + margin * (min_lon - max_lon)].max if bbox.min_lon < min_lon
56       @min_lat = [-SCALED_LAT_LIMIT,
57                   bbox.min_lat + margin * (min_lat - max_lat)].max if bbox.min_lat < min_lat
58       @max_lon = [+SCALED_LON_LIMIT,
59                   bbox.max_lon + margin * (max_lon - min_lon)].min if bbox.max_lon > max_lon
60       @max_lat = [+SCALED_LAT_LIMIT,
61                   bbox.max_lat + margin * (max_lat - min_lat)].min if bbox.max_lat > max_lat
62     end
63     self
64   end
65
66   def check_boundaries
67     # check the bbox is sane
68     if min_lon > max_lon
69       fail OSM::APIBadBoundingBox.new(
70         "The minimum longitude must be less than the maximum longitude, but it wasn't")
71     end
72     if min_lat > max_lat
73       fail OSM::APIBadBoundingBox.new(
74         "The minimum latitude must be less than the maximum latitude, but it wasn't")
75     end
76     if min_lon < -LON_LIMIT || min_lat < -LAT_LIMIT || max_lon > +LON_LIMIT || max_lat > +LAT_LIMIT
77       fail OSM::APIBadBoundingBox.new("The latitudes must be between #{-LAT_LIMIT} and #{LAT_LIMIT}," +
78                                        " and longitudes between #{-LON_LIMIT} and #{LON_LIMIT}")
79     end
80     self
81   end
82
83   def check_size(max_area = MAX_REQUEST_AREA)
84     # check the bbox isn't too large
85     if area > max_area
86       fail OSM::APIBadBoundingBox.new("The maximum bbox size is " + max_area.to_s +
87         ", and your request was too large. Either request a smaller area, or use planet.osm")
88     end
89     self
90   end
91
92   ##
93   # returns area of the bbox as a rough comparative quantity
94   def area
95     if complete?
96       (max_lon - min_lon) * (max_lat - min_lat)
97     else
98       0
99     end
100   end
101
102   def complete?
103     !to_a.include?(nil)
104   end
105
106   def centre_lon
107     (min_lon + max_lon) / 2.0
108   end
109
110   def centre_lat
111     (min_lat + max_lat) / 2.0
112   end
113
114   def width
115     max_lon - min_lon
116   end
117
118   def height
119     max_lat - min_lat
120   end
121
122   def slippy_width(zoom)
123     width * 256.0 * 2.0**zoom / 360.0
124   end
125
126   def slippy_height(zoom)
127     min = min_lat * Math::PI / 180.0
128     max = max_lat * Math::PI / 180.0
129
130     Math.log((Math.tan(max) + 1.0 / Math.cos(max)) /
131              (Math.tan(min) + 1.0 / Math.cos(min))) *
132       (128.0 * 2.0**zoom / Math::PI)
133   end
134
135   # there are two forms used for bounds with and without an underscore,
136   # cater for both forms eg minlon and min_lon
137   def add_bounds_to(hash, underscore = "")
138     hash["min#{underscore}lat"] = min_lat.to_s
139     hash["min#{underscore}lon"] = min_lon.to_s
140     hash["max#{underscore}lat"] = max_lat.to_s
141     hash["max#{underscore}lon"] = max_lon.to_s
142     hash
143   end
144
145   def to_scaled
146     BoundingBox.new((min_lon * GeoRecord::SCALE),
147                     (min_lat * GeoRecord::SCALE),
148                     (max_lon * GeoRecord::SCALE),
149                     (max_lat * GeoRecord::SCALE))
150   end
151
152   def to_unscaled
153     BoundingBox.new((min_lon / GeoRecord::SCALE),
154                     (min_lat / GeoRecord::SCALE),
155                     (max_lon / GeoRecord::SCALE),
156                     (max_lat / GeoRecord::SCALE))
157   end
158
159   def to_a
160     [min_lon, min_lat, max_lon, max_lat]
161   end
162
163   def to_s
164     "#{min_lon},#{min_lat},#{max_lon},#{max_lat}"
165   end
166
167   private
168
169   def self.from_bbox_array(bbox_array)
170     unless bbox_array
171       fail OSM::APIBadUserInput.new(
172         "The parameter bbox is required, and must be of the form min_lon,min_lat,max_lon,max_lat")
173     end
174     # Take an array of length 4, create a bounding box with min_lon, min_lat, max_lon and
175     # max_lat within their respective boundaries.
176     min_lon = [[bbox_array[0].to_f, -LON_LIMIT].max, +LON_LIMIT].min
177     min_lat = [[bbox_array[1].to_f, -LAT_LIMIT].max, +LAT_LIMIT].min
178     max_lon = [[bbox_array[2].to_f, +LON_LIMIT].min, -LON_LIMIT].max
179     max_lat = [[bbox_array[3].to_f, +LAT_LIMIT].min, -LAT_LIMIT].max
180     BoundingBox.new(min_lon, min_lat, max_lon, max_lat)
181   end
182
183   def update!(bbox)
184     # ensure that bbox has no nils in it. if there are any
185     # nils, just use the bounding box update to write over them.
186     @min_lon = bbox.min_lon if min_lon.nil?
187     @min_lat = bbox.min_lat if min_lat.nil?
188     @max_lon = bbox.max_lon if max_lon.nil?
189     @max_lat = bbox.max_lat if max_lat.nil?
190   end
191 end