Removed old template and added divIcon tests.

ocefpaf · ocefpaf · commit 30b9e0b5f9d6 · 2015-11-30T10:49:41.000-03:00
diff --git a/folium/features.py b/folium/features.py
@@ -381,22 +381,56 @@ def render(self, **kwargs):
 
 
 class DivIcon(MacroElement):
-    def __init__(self, width=30, height=30):
-        """TODO : docstring here"""
+    def __init__(self, html=None, icon_size=None, icon_anchor=None,
+                 popup_anchor=None, class_name='empty'):
+        """
+        Represents a lightweight icon for markers that uses a simple `div`
+        element instead of an image.
+
+        Parameters
+        ----------
+        icon_size : tuple of 2 int
+            Size of the icon image in pixels.
+        icon_anchor : tuple of 2 int
+            The coordinates of the "tip" of the icon
+            (relative to its top left corner).
+            The icon will be aligned so that this point is at the
+            marker's geographical location.
+        popup_anchor : tuple of 2 int
+            The coordinates of the point from which popups will "open",
+            relative to the icon anchor.
+        class_name : string
+            A custom class name to assign to the icon.
+            Leaflet defaults is 'leaflet-div-icon' which draws a little white
+            square with a shadow.  We set it 'empty' in folium.
+        html : string
+            A custom HTML code to put inside the div element.
+
+        For more information see:
+        http://leafletjs.com/reference.html#divicon
+
+        """
         super(DivIcon, self).__init__()
         self._name = 'DivIcon'
-        self.width = width
-        self.height = height
+        self.icon_size = icon_size
+        self.icon_anchor = icon_anchor
+        self.popup_anchor = popup_anchor
+        self.html = html
+        self.className = class_name
 
         self._template = Template(u"""
             {% macro script(this, kwargs) %}
+
                 var {{this.get_name()}} = L.divIcon({
-                    className: 'leaflet-div-icon',
-                    'iconSize': [{{ this.width }},{{ this.height }}]
+                    {% if this.icon_size %}iconSize: [{{this.icon_size[0]}},{{this.icon_size[1]}}],{% endif %}
+                    {% if this.icon_anchor %}iconAnchor: [{{this.icon_anchor[0]}},{{this.icon_anchor[1]}}],{% endif %}
+                    {% if this.popup_anchor %}popupAnchor: [{{this.popup_anchor[0]}},{{this.popup_anchor[1]}}],{% endif %}
+                    {% if this.className %}className: '{{this.className}}',{% endif %}
+                    {% if this.html %}html: '{{this.html}}',{% endif %}
                     });
                 {{this._parent.get_name()}}.setIcon({{this.get_name()}});
             {% endmacro %}
-            """)
+            """)  # noqa
 
 
 class CircleMarker(MacroElement):
diff --git a/folium/folium.py b/folium/folium.py
@@ -16,7 +16,7 @@
 from .map import Map as _Map
 from .map import Icon, Marker, Popup, FitBounds
 from .features import (WmsTileLayer, RegularPolygonMarker, Vega, GeoJson,
-                       GeoJsonStyle, DivIcon, CircleMarker, LatLngPopup,
+                       GeoJsonStyle, CircleMarker, LatLngPopup,
                        ClickForMarker, ColorScale, TopoJson, PolyLine,
                        MultiPolyLine, ImageOverlay)
 from .utilities import color_brewer, write_png
@@ -126,50 +126,6 @@ def simple_marker(self, location=None, popup=None,
                                   angle=icon_angle))
         self.add_children(marker)
 
-    def div_markers(self, locations=None, popups=None,
-                    marker_size=10, popup_width=300):
-        """Create a simple div marker on the map, with optional
-        popup text or Vincent visualization. Useful for marking points along a
-        line.
-
-        Parameters
-        ----------
-        locations: list of locations, where each location is an array
-            Latitude and Longitude of Marker (Northing, Easting)
-        popup: list of popups, each popup should be a string or tuple.
-            Default 'Pop Text'
-            Input text or visualization for object. Can pass either text,
-            or a tuple of the form (Vincent object, 'vis_path.json')
-            It is possible to adjust the width of text/HTML popups
-            using the optional keywords `popup_width`.
-            (Leaflet default is 300px.)
-        marker_size
-            default is 5
-
-        Returns
-        -------
-        Marker names and HTML in obj.template_vars
-
-        Example
-        -------
-        >>> map.div_markers(locations=[[37.421114, -122.128314],
-        ...                            [37.391637, -122.085416],
-        ...                            [37.388832, -122.087709]],
-        ...                 popups=['1437494575531',
-        ...                         '1437492135937',
-        ...                         '1437493590434'])
-
-        """
-        warnings.warn("%s is deprecated. Use %s instead" %
-                      ("div_markers", "Marker.add_children(DivIcon)"),
-                      FutureWarning, stacklevel=2)
-        for location, popup in zip(locations, popups):
-            marker = Marker(location,
-                            popup=Popup(popup),
-                            icon=DivIcon(width=marker_size,
-                                         height=marker_size))
-            self.add_children(marker)
-
     def line(self, locations,
              line_color=None, line_opacity=None, line_weight=None,
              popup=None, popup_width=300, latlon=True):
@@ -682,8 +638,8 @@ def image_overlay(self, data, opacity=0.25, min_lat=-90.0, max_lat=90.0,
         colormap : callable, used only for `mono` image.
             Function of the form [x -> (r,g,b)] or [x -> (r,g,b,a)]
             for transforming a mono image into RGB.
-            It must output iterables of length 3 or 4, with values between
-            0. and 1.  Hint : you can use colormaps from `matplotlib.cm`.
+            It must output iterables of length 3 or 4, with values
+            between 0 and 1. Hint: you can use colormaps from `matplotlib.cm`.
 
         mercator_project : bool, default False, used only for array-like image.
             Transforms the data to project (longitude,latitude) coordinates
diff --git a/folium/templates/static_div_icon.js b/folium/templates/static_div_icon.js
diff --git a/tests/test_features.py b/tests/test_features.py
@@ -1,41 +1,105 @@
 # -*- coding: utf-8 -*-
-'''
+""""
 Folium Features Tests
 ---------------------
 
-'''
+"""
+
+import os
+from folium import Map
 from folium import features
 from folium.six import text_type
+from folium.element import Element
+
+
+tmpl = """
+        <!DOCTYPE html>
+        <head>
+            <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+            <script src="https://cdnjs.cloudflare.com/ajax/libs/leaflet/0.7.3/leaflet.js"></script>
+            <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
+            <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
+            <script src="https://rawgithub.com/lvoogdt/Leaflet.awesome-markers/2.0/develop/dist/leaflet.awesome-markers.js"></script>
+            <script src="https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/leaflet.markercluster-src.js"></script>
+            <script src="https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/leaflet.markercluster.js"></script>
+            <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/leaflet/0.7.3/leaflet.css" />
+            <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css" />
+            <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap-theme.min.css" />
+            <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css" />
+            <link rel="stylesheet" href="https://rawgit.com/lvoogdt/Leaflet.awesome-markers/2.0/develop/dist/leaflet.awesome-markers.css" />
+            <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/MarkerCluster.Default.css" />
+            <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/0.4.0/MarkerCluster.css" />
+            <link rel="stylesheet" href="https://raw.githubusercontent.com/python-visualization/folium/master/folium/templates/leaflet.awesome.rotate.css" />
+            <style>
+            html, body {
+                width: 100%;
+                height: 100%;
+                margin: 0;
+                padding: 0;
+                }
+            #map {
+                position:absolute;
+                top:0;
+                bottom:0;
+                right:0;
+                left:0;
+                }
+            </style>
+        </head>
+        <body>
+        </body>
+        <script>
+        </script>
+"""  # noqa
+
+
+# Figure
+def test_figure_creation():
+    f = features.Figure()
+    assert isinstance(f, Element)
+
+
+def test_figure_rendering():
+    f = features.Figure()
+    out = f.render()
+    assert type(out) is text_type
+
+
+def test_figure_html():
+    f = features.Figure()
+    out = f.render()
+    out = os.linesep.join([s for s in out.splitlines() if s.strip()])
+    print(out)
+    assert out.strip() == tmpl.strip()
+
+
+def test_figure_double_rendering():
+    f = features.Figure()
+    out = f.render()
+    out2 = f.render()
+    assert out == out2
+
+
+# DivIcon.
+def test_divicon():
+    html = """<svg height="100" width="100">
+              <circle cx="50" cy="50" r="40" stroke="black" stroke-width="3" fill="red" />
+              </svg>"""  # noqa
+    div = features.DivIcon(html=html)
+    assert isinstance(div, Element)
+    assert div.className == 'empty'
+    assert div.html == html
 
 
-class testFeatures(object):
-    '''Test class for Folium features'''
-
-    def test_map_creation(self):
-        features.Map([40, -100], zoom_start=4)
-
-    def test_figure_creation(self):
-        features.Figure()
-
-    def test_figure_rendering(self):
-        f = features.Figure()
-        out = f.render()
-        assert type(out) is text_type
-
-    def test_figure_double_rendering(self):
-        f = features.Figure()
-        out = f.render()
-        out2 = f.render()
-        assert out == out2
-
-    def test_wms_service(self):
-        m = features.Map([40, -100], zoom_start=4)
-        url = 'http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi'
-        w = features.WmsTileLayer(url,
-                                  name='test',
-                                  format='image/png',
-                                  layers='nexrad-n0r-900913',
-                                  attribution=u"Weather data © 2012 IEM Nexrad",
-                                  transparent=True)
-        w.add_to(m)
-        m._repr_html_()
+# WmsTileLayer
+def test_wms_service():
+    m = Map([40, -100], zoom_start=4)
+    url = 'http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi'
+    w = features.WmsTileLayer(url,
+                              name='test',
+                              format='image/png',
+                              layers='nexrad-n0r-900913',
+                              attribution=u"Weather data © 2012 IEM Nexrad",
+                              transparent=True)
+    w.add_to(m)
+    m._repr_html_()
diff --git a/tests/test_folium.py b/tests/test_folium.py
@@ -20,10 +20,8 @@
 import folium
 import base64
 from folium.six import PY3
-from folium.element import Html
 from folium.map import Popup, Marker, FitBounds, FeatureGroup
-from folium.features import (DivIcon, GeoJson,
-                             ColorScale, TopoJson, PolyLine,
+from folium.features import (GeoJson, ColorScale, TopoJson, PolyLine,
                              MultiPolyLine, ImageOverlay)
 
 
@@ -211,56 +209,6 @@ def test_simple_marker(self):
         for child in list(self.map._children.values())[-1]._children.values():
             assert not isinstance(child, Popup)
 
-    def test_div_markers(self):
-        '''Test div marker list addition'''
-        self.map = folium.Map(location=[37.421114, -122.128314])
-
-        icon_templ = self.env.get_template('static_div_icon.js')
-        mark_templ = self.env.get_template('simple_marker.js')
-        popup_templ = self.env.get_template('simple_popup.js')
-
-        # Test with popups (expected use case).
-        locations = [[37.421114, -122.128314],
-                     [37.391637, -122.085416],
-                     [37.388832, -122.087709]]
-        popups = ['1437494575531', '1437492135937', '1437493590434']
-
-        self.map.div_markers(locations=locations, popups=popups)
-
-        markers = [marker for marker in self.map._children.values() if
-                   isinstance(marker, Marker)]
-        assert len(markers) == 3
-
-        for marker, location, pop in zip(markers, locations, popups):
-            icon = list(marker._children.values())[0]
-            popup = list(marker._children.values())[1]
-            html = list(popup.html._children.values())[0]
-
-            assert isinstance(icon, DivIcon)
-            assert isinstance(popup, Popup)
-            assert isinstance(html, Html)
-
-            icon_1 = icon_templ.render({'icon_name': icon.get_name(),
-                                        'size': 10})
-            mark_1 = mark_templ.render({'marker': marker.get_name(),
-                                        'lat': location[0],
-                                        'lon': location[1],
-                                        'icon': "{icon:new L.Icon.Default()}"})
-            popup_1 = popup_templ.render({'pop_name': popup.get_name(),
-                                          'html_name': html.get_name(),
-                                          'pop_txt': '{}'.format(pop),
-                                          'width': 300})
-
-            out = ''.join(self.map.get_root().render().split())
-            assert ''.join(icon_1.split())[:-1] in out
-            assert ''.join(mark_1.split())[:-1] in out
-            assert ''.join(popup_1.split())[:-1] in out
-
-        # Test no popup. If there are no popups,
-        # then we should get a RuntimeError.
-        with pytest.raises(TypeError):
-            self.map.div_markers([[45.60, -122.8]])
-
     def test_circle_marker(self):
         """Test circle marker additions."""
 
