WIP: Introduce marker_content_factory.py

- MarkerContentFactory returns the appropriate MarkerContent implementation (i.e. either Pin or Image)
- Add unit tests

Author: argysamo

examples/simple.py

@@ -1,12 +1,19 @@
 from flask import Flask, render_template
 
 from flask_googlemaps import GoogleMaps, Map
-from flask_googlemaps.image import Image
-from flask_googlemaps.pin import Pin
 
 app = Flask(__name__)
 GoogleMaps(app)
 
+pin_content = {
+    "border_color": "",
+    "glyph_colors": "",
+    "background": "",
+    "glyph": "",
+    "scale": 2.0,
+}
+image_content = {"icon_urls": "https://img.shields.io/badge/PayPal-Donante-red.svg"}
+
 
 @app.route("/")
 def map_created_in_view():
@@ -20,13 +27,12 @@ def map_created_in_view():
                 "latitude": 37.4419,
                 "longitude": -122.1419,
                 "label": "1",
-                # 'content': Pin(border_color="blue", background="blue")
-                "content": Pin(border_color="blue", background="blue"),
+                "content": pin_content,
             },
             {
                 "latitude": 37.4519,
                 "longitude": -122.1519,
-                "content": Pin(border_color="blue", background="blue"),
+                "content": image_content,
             },
         ],
         style="height:400px;width:600px;margin:0;",

flask_googlemaps/image.py

@@ -5,13 +5,13 @@
 
 @dataclass
 class Image(MarkerContent):
-    url: str
+    icon_url: str
 
     def content(self) -> str:
         return self.name
 
     def dom_element(self) -> str:
         return (
             f"const {self.name} = document.createElement('img');\n"
-            f"{self.name}.src = '{self.url}';"
+            f"{self.name}.src = '{self.icon_url}';"
         )

flask_googlemaps/marker.py

@@ -1,41 +1,27 @@
 from typing import Optional, List, Any, Dict
 
-from flask_googlemaps.marker_content import MarkerContent
+from flask_googlemaps.marker_content_factory import MarkerContentFactory
 from flask_googlemaps.pin import Pin
 
 DEFAULT_PIN = Pin()
 
 
-# from json import JSONEncoder
-#
-#
-# def wrapped_default(self, obj):
-#     return getattr(obj.__class__, "__json__", wrapped_default.default)(obj)
-#
-#
-# wrapped_default.default = JSONEncoder().default
-#
-# # apply the patch
-# JSONEncoder.original_default = JSONEncoder.default
-# JSONEncoder.default = wrapped_default
-
-
 class Marker(dict):
 
     def __init__(
         self,
         latitude: float,
         longitude: float,
         infobox: Optional[str] = None,
-        content: Optional[MarkerContent] = None,
+        content: Optional[dict] = None,
         label: Optional[str] = None,
     ):
         self.latitude = Marker.verify_latitude(latitude)
         self.longitude = Marker.verify_longitude(longitude)
         self.infobox = infobox
-        self.marker_icon = content
-        self.content = content.content()
-        self.dom_element = content.dom_element()
+        self.marker_content = MarkerContentFactory(**content).marker_content
+        self.content = self.marker_content.content()
+        self.dom_element = self.marker_content.dom_element()
         self.label = label
 
         dict.__init__(
@@ -45,7 +31,7 @@ def __init__(
                 "longitude": self.longitude,
                 "infobox": self.infobox,
                 "content": self.content,
-                "id": self.marker_icon.name,
+                "id": self.marker_content.name,
             },
         )
 

flask_googlemaps/marker_content_factory.py

@@ -0,0 +1,46 @@
+from enum import Enum
+from typing import Optional
+
+from flask_googlemaps.image import Image
+from flask_googlemaps.marker_content import MarkerContent
+from flask_googlemaps.pin import Pin
+
+
+class MarkerContentType(Enum):
+    PIN = 1
+    IMAGE = 2
+
+
+class MarkerContentFactory:
+
+    def __init__(self, **kwargs):
+        self.kwargs = kwargs
+        if "icon_url" in kwargs:
+            self.__content_type = MarkerContentType.IMAGE
+        elif (
+            "border_color" in kwargs
+            or "glyph_color" in kwargs
+            or "background" in kwargs
+            or "glyph" in kwargs
+            or "scale" in kwargs
+        ):
+            self.__content_type = MarkerContentType.PIN
+        else:
+            self.__content_type = None
+
+    @property
+    def marker_content(self) -> Optional[MarkerContent]:
+        if self.__content_type is MarkerContentType.PIN:
+            try:
+                return Pin(**self.kwargs)
+            except TypeError as e:
+                print(e)
+                return Pin()
+        elif self.__content_type is MarkerContentType.IMAGE:
+            try:
+                return Image(**self.kwargs)
+            except TypeError as e:
+                print(e)
+                return Pin()
+        else:
+            return Pin()

flask_googlemaps/pin.py

@@ -1,23 +1,39 @@
-from dataclasses import dataclass
+from dataclasses import dataclass, fields
+from enum import Enum
 from typing import Optional
 
 from flask_googlemaps.marker_content import MarkerContent
 
+pin_property_mapping = {
+    "glyph_color": "glyphColor",
+    "background": "background",
+    "border_color": "borderColor",
+    "glyph": "glyph",
+    "scale": "scale",
+}
+
+
+class PinPropertyMapping(Enum):
+    glyph_color = "glyphColor"
+    background = "background"
+    border_color = "borderColor"
+    glyph = "glyph"
+    scale = "scale"
+
 
 @dataclass
 class Pin(MarkerContent):
 
     def __post_init__(self):
         MarkerContent.__post_init__(self)
         self.dom = []
-        if self.glyph_color:
-            self.dom.append(f"\tglyphColor: '{self.glyph_color}',")
-        if self.background:
-            self.dom.append(f"\tbackground: '{self.background}',")
-        if self.border_color:
-            self.dom.append(f"\tborderColor: '{self.border_color}',")
-        if self.glyph:
-            self.dom.append(f"\tglyph: '{self.glyph}',")
+        for field in fields(Pin):
+            if self.__getattribute__(field.name):
+                self.dom.append(
+                    f"\t{PinPropertyMapping.__getitem__(field.name).value}: "
+                    f"'{self.__getattribute__(field.name)}',"
+                )
+
         if self.dom:
             self.dom.insert(0, f"const {self.name} = new PinElement({{")
             self.dom.append("\t\t});\n")
@@ -32,7 +48,7 @@ def dom_element(self) -> Optional[str]:
     glyph_color: str = ""
     background: str = ""
     glyph: Optional[str] = ""
-    scale: float = 1.0
+    scale: Optional[float] = None
 
     def content(self) -> str:
         if self.dom:

tests/test_image.py

@@ -6,7 +6,7 @@
 @pytest.fixture
 def image():
     return Image(
-        url="https://developers.google.com/maps/documentation/"
+        icon_url="https://developers.google.com/maps/documentation/"
         "javascript/examples/full/images/beachflag.png"
     )
 
@@ -20,4 +20,4 @@ def test_content(image):
 def test_dom_image_element(image):
     variable, url_set = image.dom_element().split("\n")
     assert variable == f"const {image.name} = document.createElement('img');"
-    assert url_set == f"{image.name}.src = '{image.url}';"
+    assert url_set == f"{image.name}.src = '{image.icon_url}';"

tests/test_marker.py

@@ -11,7 +11,7 @@ def marker_pin_object() -> Marker:
     return Marker(
         latitude=37.4419,
         longitude=-122.1419,
-        pin=Pin(border_color="", glyph_color="", background=""),
+        content=dict(border_color="", glyph_color="", background=""),
         infobox="<b>Hello World</b>",
     )
 
@@ -21,9 +21,11 @@ def marker_pin_url() -> Marker:
     return Marker(
         latitude=37.4419,
         longitude=-122.1419,
-        pin="https://developers.google.com/maps/"
-        "documentation/javascript/examples/"
-        "full/images/beachflag.png",
+        content={
+            "icon_url": "https://developers.google.com/maps/"
+            "documentation/javascript/examples/"
+            "full/images/beachflag.png"
+        },
         infobox="<b>Hello World</b>",
     )
 
@@ -68,4 +70,4 @@ def test_marker_with_wrong_longitude():
 
 
 def test_marker_with_pin_object(marker_pin_object):
-    assert isinstance(marker_pin_object.pin, Pin)
+    assert isinstance(marker_pin_object.marker_content, Pin)

tests/test_marker_content_factory.py

@@ -0,0 +1,18 @@
+from flask_googlemaps.marker_content_factory import MarkerContentFactory
+from flask_googlemaps.pin import Pin
+
+
+def test_marker_content_unknown_keys():
+    marker_content_factory = MarkerContentFactory(**{"bla": "bla"})
+    marker_content = marker_content_factory.marker_content
+    assert isinstance(marker_content, Pin)
+    assert marker_content.dom_element() is None
+
+
+def test_marker_content_unknown():
+    marker_content_factory = MarkerContentFactory(
+        **{"background": "", "glyph_colors": ""}
+    )
+    marker_content = marker_content_factory.marker_content
+    assert isinstance(marker_content, Pin)
+    assert marker_content.dom_element() is None

tests/test_pin.py

@@ -1,13 +1,63 @@
+import json
+
 import pytest
 
-from flask_googlemaps.pin import Pin
+from flask_googlemaps.pin import Pin, PinPropertyMapping
 
 
 @pytest.fixture
-def pin():
+def empty_pin():
     return Pin()
 
 
+@pytest.fixture
+def pin():
+    return Pin(border_color="red", scale=2.0)
+
+
+def test_content_empty(empty_pin):
+    content = empty_pin.content()
+    assert content == ""
+
+
 def test_content(pin):
     content = pin.content()
-    assert False
+    assert content.startswith("var_")
+    assert len(content) == 20
+
+
+@pytest.mark.parametrize(
+    "p",
+    [
+        Pin(border_color="blue", scale=3.0),
+        Pin(background="red", glyph_color="black", scale=2.0),
+        Pin(glyph="Test", border_color="red"),
+    ],
+)
+def test_dom_element(p):
+    dom_element = p.dom_element()
+    _, js_element = dom_element.split(" = ")
+
+    js_element = js_element_to_dict(js_element)
+    reversed_dict = {item.value: item.name for item in list(PinPropertyMapping)}
+
+    for property_name, value in js_element.items():
+        if property_name == "scale":
+            value = float(value)
+        assert value == p.__getattribute__(reversed_dict[property_name])
+
+
+def js_element_to_dict(js_element: str) -> dict:
+    js_element = (
+        js_element.strip("new PinElement(")
+        .strip(");\n")
+        .replace("\n", "")
+        .replace("\t", "")
+        .replace("'", '"')
+        .replace("{", '{"')
+        .replace(",}", "}")
+        .replace(",", ',"')
+        .replace(":", '":')
+    )
+
+    return json.loads(js_element)

tests/test_version.py

@@ -2,4 +2,4 @@
 
 
 def test_version():
-    assert __version__ == "0.4.1"
+    assert __version__ == "0.5.0"