Add tests

Author: seisman

pygmt/src/directional_rose.py

@@ -11,7 +11,7 @@
 from pygmt.helpers import build_arg_list
 
 
-def directional_rose(  # noqa: PLR0913
+def directional_rose(
     self,
     position: Sequence[str | float] | AnchorCode,
     position_type: Literal[

pygmt/tests/baseline/test_directional_rose_complex.png.dvc

@@ -0,0 +1,5 @@
+outs:
+- md5: 9f1971f6e2b5b87d42f21d7410149793
+  size: 14718
+  hash: md5
+  path: test_directional_rose_complex.png

pygmt/tests/test_basemap.py

@@ -94,9 +94,16 @@ def test_basemap_rose():
     Create a map with a rose.
     """
     fig = Figure()
-    fig.basemap(
-        region=[127.5, 128.5, 26, 27], projection="H15c", frame=True, rose="jMC+w5c"
-    )
+    with pytest.warns(
+        UserWarning,
+        match=(
+            "The 'rose' parameter is deprecated and will be removed in a future "
+            "release. Please use the 'directional_rose' method instead."
+        ),
+    ):
+        fig.basemap(
+            region=[127.5, 128.5, 26, 27], projection="H15c", frame=True, rose="jMC+w5c"
+        )
     return fig
 
 

pygmt/tests/test_directional_rose.py

@@ -0,0 +1,36 @@
+"""
+Test Figure.directional_rose.
+"""
+
+import pytest
+from pygmt import Figure
+
+
+@pytest.mark.mpl_image_compare(filename="test_basemap_rose.png")
+def test_directional_rose():
+    """
+    Test the Figure.directional_rose method.
+    """
+    fig = Figure()
+    fig.basemap(region=[127.5, 128.5, 26, 27], projection="H15c", frame=True)
+    fig.directional_rose(position="MC", position_type="inside", width="5c")
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_directional_rose_complex():
+    """
+    Test the Figure.directional_rose method with more parameters.
+    """
+    fig = Figure()
+    fig.basemap(region=[0, 80, -30, 30], projection="M10c", frame=True)
+    fig.directional_rose(
+        position=(50, 0),
+        position_type="mapcoords",
+        width="1c",
+        label=["", "", "", "N"],
+        fancy=2,
+        anchor_offset=(1, 1),
+        justify="MC",
+    )
+    return fig

pygmt/tests/test_inset.py

@@ -29,5 +29,6 @@ def test_inset_context_manager():
     fig.basemap(region=[-74, -69.5, 41, 43], projection="M9c", frame=True)
     with fig.inset(position="jBL+w3c+o0.2c", margin=0, box="+pblack"):
         fig.basemap(region=[-80, -65, 35, 50], projection="M3c", frame="afg")
-    fig.basemap(rose="jTR+w3c")  # Pass rose argument with basemap after the inset
+    # Plot an rose after the inset
+    fig.directional_rose(position="TR", position_type="inside", width="3c")
     return fig