Add get_bounds in (almost) each plugin test

Author: Martin Journois

folium/plugins/boat_marker.py

@@ -10,19 +10,19 @@
 import json
 from jinja2 import Template
 
-from folium.element import JavascriptLink, MacroElement, Figure
+from folium.element import JavascriptLink, Figure
+from folium.map import Marker
 
-
-class BoatMarker(MacroElement):
+class BoatMarker(Marker):
     """Adds a BoatMarker layer on the map."""
-    def __init__(self, position=None, heading=0,
-                 wind_heading=None, wind_speed=0, **kwargs):
+    def __init__(self, location, popup=None, icon=None,
+                 heading=0, wind_heading=None, wind_speed=0, **kwargs):
         """Creates a BoatMarker plugin to append into a map with
         Map.add_plugin.
 
         Parameters
         ----------
-            position: tuple of length 2, default None
+            location: tuple of length 2, default None
                 The latitude and longitude of the marker.
                 If None, then the middle of the map is used.
 
@@ -36,9 +36,8 @@ def __init__(self, position=None, heading=0,
             wind_speed: int, default 0
                 Speed of the wind in knots.
         """
-        super(BoatMarker, self).__init__()
+        super(BoatMarker, self).__init__(location, popup=popup, icon=icon)
         self._name = 'BoatMarker'
-        self.position = None if position is None else tuple(position)
         self.heading = heading
         self.wind_heading = wind_heading
         self.wind_speed = wind_speed
@@ -47,7 +46,7 @@ def __init__(self, position=None, heading=0,
         self._template = Template(u"""
             {% macro script(this, kwargs) %}
                 var {{this.get_name()}} = L.boatMarker(
-                    [{{this.position[0]}},{{this.position[1]}}],
+                    [{{this.location[0]}},{{this.location[1]}}],
                     {{this.kwargs}}).addTo({{this._parent.get_name()}});
                 {{this.get_name()}}.setHeadingWind({{this.heading}}, {{this.wind_speed}}, {{this.wind_heading}});
             {% endmacro %}

folium/plugins/heat_map.py

@@ -11,7 +11,7 @@
 
 from folium.element import JavascriptLink, Figure
 from folium.map import TileLayer
-
+from folium.utilities import none_min, none_max
 
 class HeatMap(TileLayer):
     def __init__(self, data, name=None, min_opacity=0.5, max_zoom=18,
@@ -79,3 +79,21 @@ def render(self, **kwargs):
         figure.header.add_children(
             JavascriptLink("https://leaflet.github.io/Leaflet.heat/dist/leaflet-heat.js"),  # noqa
             name='leaflet-heat.js')
+
+    def _get_self_bounds(self):
+        """Computes the bounds of the object itself (not including it's children)
+        in the form [[lat_min, lon_min], [lat_max, lon_max]]
+        """
+        bounds = [[None,None],[None,None]]
+        for point in self.data:
+            bounds = [
+                [
+                    none_min(bounds[0][0], point[1]),
+                    none_min(bounds[0][1], point[0]),
+                ],
+                [
+                    none_max(bounds[1][0], point[1]),
+                    none_max(bounds[1][1], point[0]),
+                ],
+            ]
+        return bounds

folium/plugins/image_overlay.py

@@ -136,3 +136,9 @@ def __init__(self, image, bounds, opacity=1., attr=None,
                     ).addTo({{this._parent.get_name()}});
             {% endmacro %}
             """)
+
+    def _get_self_bounds(self):
+        """Computes the bounds of the object itself (not including it's children)
+        in the form [[lat_min, lon_min], [lat_max, lon_max]]
+        """
+        return self.bounds

folium/plugins/timestamped_geo_json.py

@@ -23,7 +23,7 @@
 from jinja2 import Template
 
 from folium.element import MacroElement, Figure, JavascriptLink, CssLink
-
+from folium.utilities import none_min, none_max, iter_points
 
 class TimestampedGeoJson(MacroElement):
     def __init__(self, data, transition_time=200, loop=True, auto_play=True):
@@ -87,10 +87,13 @@ def __init__(self, data, transition_time=200, loop=True, auto_play=True):
 
         # self.template = self.env.get_template('timestamped_geo_json.tpl')
         if 'read' in dir(data):
+            self.embed = True
             self.data = data.read()
         elif type(data) is dict:
+            self.embed = True
             self.data = json.dumps(data)
         else:
+            self.embed = False
             self.data = data
         self.transition_time = int(transition_time)
         self.loop = bool(loop)
@@ -145,3 +148,33 @@ def render(self, **kwargs):
         figure.header.add_children(
             CssLink("http://apps.socib.es/Leaflet.TimeDimension/dist/leaflet.timedimension.control.min.css"),  # noqa
             name='leaflet.timedimension_css')
+
+    def _get_self_bounds(self):
+        """Computes the bounds of the object itself (not including it's children)
+        in the form [[lat_min, lon_min], [lat_max, lon_max]]
+        """
+        if not self.embed:
+            raise ValueError('Cannot compute bounds of non-embedded GeoJSON.')
+
+        data = json.loads(self.data)
+        if 'features' not in data.keys():
+            # Catch case when GeoJSON is just a single Feature or a geometry.
+            if not (isinstance(data, dict) and 'geometry' in data.keys()):
+                # Catch case when GeoJSON is just a geometry.
+                data = {'type' : 'Feature', 'geometry' : data}
+            data = {'type' : 'FeatureCollection', 'features' : [data]}
+
+        bounds = [[None,None],[None,None]]
+        for feature in data['features']:
+            for point in iter_points(feature.get('geometry',{}).get('coordinates',{})):
+                bounds = [
+                    [
+                        none_min(bounds[0][0], point[1]),
+                        none_min(bounds[0][1], point[0]),
+                        ],
+                    [
+                        none_max(bounds[1][0], point[1]),
+                        none_max(bounds[1][1], point[0]),
+                        ],
+                    ]
+        return bounds

tests/plugins/test_boat_marker.py

@@ -38,10 +38,13 @@ def test_boat_marker():
     # We verify that the script part is correct
     tmpl = Template("""
                 var {{this.get_name()}} = L.boatMarker(
-                    [{{this.position[0]}},{{this.position[1]}}],
+                    [{{this.location[0]}},{{this.location[1]}}],
                     {{this.kwargs}}).addTo({{this._parent.get_name()}});
                 {{this.get_name()}}.setHeadingWind({{this.heading}}, {{this.wind_speed}}, {{this.wind_heading}});
     """)
 
     assert tmpl.render(this=bm1) in out
     assert tmpl.render(this=bm2) in out
+
+    bounds = m.get_bounds()
+    assert bounds == [[34, -43], [46, -30]], bounds

tests/plugins/test_heat_map.py

@@ -11,6 +11,7 @@
 from folium import plugins
 
 def test_heat_map():
+    np.random.seed(3141592)
     data = (np.random.normal(size=(100, 2)) * np.array([[1, 1]]) +
             np.array([[48, 5]])).tolist()
     m = folium.Map([48., 5.], tiles='stamentoner', zoom_start=6)
@@ -39,3 +40,7 @@ def test_heat_map():
     """)
 
     assert tmpl.render(this=hm)
+
+    bounds = m.get_bounds()
+    assert bounds == [[3.0302801394447734, 46.218566840847025],
+                      [7.132453997672826, 50.75345011431167]], bounds

tests/plugins/test_image_overlay.py

@@ -35,3 +35,6 @@ def test_image_overlay():
                     ).addTo({{this._parent.get_name()}});
     """)
     assert tmpl.render(this=io) in out
+
+    bounds = m.get_bounds()
+    assert bounds == [[0, -180], [90, 180]], bounds

tests/plugins/test_marker_cluster.py

@@ -12,6 +12,7 @@
 
 def test_marker_cluster():
     N = 100
+    np.random.seed(seed=26082009)
     data = np.array([
         np.random.uniform(low=35, high=60, size=N),   # Random latitudes.
         np.random.uniform(low=-12, high=30, size=N),  # Random longitudes.
@@ -49,3 +50,7 @@ def test_marker_cluster():
         {% endfor %}
     """)
     assert ''.join(tmpl.render(this=mc).split()) in ''.join(out.split())
+
+    bounds = m.get_bounds()
+    assert bounds == [[35.147332572663785, -11.520684337300109],
+                      [59.839718052359274, 29.94931046497927]], bounds

tests/plugins/test_scroll_zoom_toggler.py

@@ -60,4 +60,7 @@ def test_scroll_zoom_toggler():
 
         {{this._parent.get_name()}}.toggleScroll();
     """)
-    assert ''.join(tmpl.render(this=szt).split()) in ''.join(out.split())
+    assert ''.join(tmpl.render(this=szt).split()) in ''.join(out.split())
+
+    bounds = m.get_bounds()
+    assert bounds == [[None, None], [None, None]], bounds

tests/plugins/test_terminator.py

@@ -20,3 +20,6 @@ def test_terminator():
     # Verify that the script is okay.
     tmpl = Template('L.terminator().addTo({{this._parent.get_name()}});')
     assert ''.join(tmpl.render(this=t).split()) in ''.join(out.split())
+
+    bounds = m.get_bounds()
+    assert bounds == [[None, None], [None, None]], bounds