Antpath plugin and vector path options refactor (#1016)

* add AntPath plugin
* refactor parse options and don't validated the kw
* add test utility to compare rendered maps

https://github.com/rubenspgcavalcante/leaflet-ant-path

Author: ocefpaf

examples/PolyLineTextPath_AntPath.ipynb

@@ -10,6 +10,7 @@
 
 from __future__ import (absolute_import, division, print_function)
 
+from folium.plugins.antpath import AntPath
 from folium.plugins.beautify_icon import BeautifyIcon
 from folium.plugins.boat_marker import BoatMarker
 from folium.plugins.draw import Draw
@@ -32,6 +33,7 @@
 from folium.plugins.timestamped_wmstilelayer import TimestampedWmsTileLayers
 
 __all__ = [
+    'AntPath',
     'BeautifyIcon',
     'BoatMarker',
     'Draw',

examples/Polyline_text_path.ipynb

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import (absolute_import, division, print_function)
+
+import json
+
+from branca.element import Figure, JavascriptLink
+
+from folium import Marker
+from folium.vector_layers import path_options
+
+from jinja2 import Template
+
+
+class AntPath(Marker):
+    """
+    Class for drawing AntPath polyline overlays on a map.
+
+    See :func:`folium.vector_layers.path_options` for the `Path` options.
+
+    Parameters
+    ----------
+    locations: list of points (latitude, longitude)
+        Latitude and Longitude of line (Northing, Easting)
+    popup: str or folium.Popup, default None
+        Input text or visualization for object displayed when clicking.
+     tooltip: str or folium.Tooltip, optional
+        Display a text when hovering over the object.
+    **kwargs:
+        Polyline and AntPath options. See their Github page for the
+        available parameters.
+
+    https://github.com/rubenspgcavalcante/leaflet-ant-path/
+
+    """
+    _template = Template(u"""
+            {% macro script(this, kwargs) %}
+                {{this.get_name()}} = L.polyline.antPath(
+                  {{this.location}},
+                  {{ this.options }}
+                )
+                .addTo({{this._parent.get_name()}});
+            {% endmacro %}
+            """)  # noqa
+
+    def __init__(self, locations, popup=None, tooltip=None, **kwargs):
+        super(AntPath, self).__init__(
+            location=locations,
+            popup=popup,
+            tooltip=tooltip,
+        )
+
+        self._name = 'AntPath'
+        # Polyline + AntPath defaults.
+        options = path_options(line=True, **kwargs)
+        options.update({
+            'paused': kwargs.pop('paused', False),
+            'reverse': kwargs.pop('reverse', False),
+            'hardwareAcceleration': kwargs.pop('hardware_acceleration', False),
+            'delay': kwargs.pop('delay', 400),
+            'dashArray': kwargs.pop('dash_array', [10, 20]),
+            'weight': kwargs.pop('weight', 5),
+            'opacity': kwargs.pop('opacity', 0.5),
+            'color': kwargs.pop('color', '#0000FF'),
+            'pulseColor': kwargs.pop('pulse_color', '#FFFFFF'),
+        })
+        self.options = json.dumps(options, sort_keys=True, indent=2)
+
+    def render(self, **kwargs):
+        super(AntPath, self).render()
+
+        figure = self.get_root()
+        assert isinstance(figure, Figure), ('You cannot render this Element '
+                                            'if it is not in a Figure.')
+
+        figure.header.add_child(
+            JavascriptLink('https://cdn.jsdelivr.net/npm/[email protected]/dist/leaflet-ant-path.min.js'),  # noqa
+            name='antpath',
+        )

folium/plugins/__init__.py

@@ -389,6 +389,20 @@ def iter_points(x):
         return []
 
 
+def compare_rendered(obj1, obj2):
+    """
+    Return True/False if the normalized rendered version of
+    two folium map objects are the equal or not.
+
+    """
+    return _normalize(obj1) == _normalize(obj2)
+
+
+def _normalize(rendered):
+    """Return the input string as a list of stripped lines."""
+    return [line.strip() for line in rendered.splitlines() if line.strip()]
+
+
 @contextmanager
 def _tmp_html(data):
     """Yields the path of a temporary HTML file containing data."""