Move extensions to better namespace

Extensions could have name collisions, adding ClimaAnalysis in front dramatically reduces the likelihood and follows conventions.
CliMA · Aug 29, 2024 · 3a36abf · 3a36abf
1 parent 3de66e8
commit 3a36abf
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 217 deletions.
diff --git a/Project.toml b/Project.toml
@@ -18,8 +18,8 @@ GeoMakie = "db073c08-6b98-4ee5-b6a4-5efafb3259c6"
 Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
 
 [extensions]
-GeoMakieExt = "GeoMakie"
-MakieExt = "Makie"
+ClimaAnalysisGeoMakieExt = "GeoMakie"
+ClimaAnalysisMakieExt = "Makie"
 
 [compat]
 Aqua = "0.8"

diff --git a/docs/make.jl b/docs/make.jl
@@ -16,8 +16,8 @@ DocMeta.setdocmeta!(
 makedocs(;
     modules = [
         ClimaAnalysis,
-        Base.get_extension(ClimaAnalysis, :MakieExt),
-        Base.get_extension(ClimaAnalysis, :GeoMakieExt),
+        Base.get_extension(ClimaAnalysis, :ClimaAnalysisMakieExt),
+        Base.get_extension(ClimaAnalysis, :ClimaAnalysisGeoMakieExt),
     ],
     authors = "Climate Modelling Alliance",
     sitename = "ClimaAnalysis.jl",

diff --git a/ext/MakieExt.jl → ext/ClimaAnalysisMakieExt.jl b/ext/MakieExt.jl → ext/ClimaAnalysisMakieExt.jl
@@ -1,4 +1,4 @@
-module MakieExt
+module ClimaAnalysisMakieExt
 
 import Makie
 import ClimaAnalysis
@@ -554,7 +554,7 @@ end
 """
     _to_unitrange(x::Number, lo::Number, hi::Number)
 
-Linearly transform x ∈ [lo, hi] to [0, 1]. 
+Linearly transform x ∈ [lo, hi] to [0, 1].
 """
 _to_unitrange(x::Number, lo::Number, hi::Number) = (x - lo) / (hi - lo)
 
@@ -581,18 +581,25 @@ symmetrically around zero maps the same color intensity to the same magnitude.
 # Returns
 - `cmap::Makie.ColorGradient`: a colormap
 """
-function _constrained_cmap(
+function Visualize._constrained_cmap(
     cols::Vector,
     lo,
     hi;
     mid = 0,
     categorical = false,
     rev = false,
 )
-    _constrained_cmap(Makie.ColorScheme(cols), lo, hi; mid, categorical, rev)
+    Visualize._constrained_cmap(
+        Makie.ColorScheme(cols),
+        lo,
+        hi;
+        mid,
+        categorical,
+        rev,
+    )
 end
 
-function _constrained_cmap(
+function Visualize._constrained_cmap(
     cols::Makie.ColorScheme,
     lo,
     hi;

diff --git a/ext/GeoMakieExt.jl b/ext/GeoMakieExt.jl
diff --git a/src/Visualize.jl b/src/Visualize.jl
@@ -2,6 +2,8 @@ module Visualize
 
 export plot!
 
+function _constrained_cmap end
+
 function heatmap2D! end
 
 function sliced_heatmap! end

diff --git a/test/test_GeoMakieExt.jl b/test/test_GeoMakieExt.jl
@@ -1,6 +1,7 @@
 using Test
 import ClimaAnalysis
 import Makie
+import CairoMakie
 import GeoMakie
 
 using OrderedCollections
@@ -39,17 +40,15 @@ using OrderedCollections
         fig2,
         var2D,
         more_kwargs = Dict(
-            :plot =>
-                ClimaAnalysis.Utils.kwargs(colormap = Makie.colorschemes[:vik]),
+            :plot => ClimaAnalysis.Utils.kwargs(colormap = :vik),
         ),
     )
 
     output_name = joinpath(tmp_dir, "test_contours2D_globe.png")
     Makie.save(output_name, fig2)
 
-    # Test cmap 
-    MakieExt = Base.get_extension(ClimaAnalysis, :MakieExt)
-    test_cmap = MakieExt._constrained_cmap(
+    # Test cmap
+    test_cmap = ClimaAnalysis.Visualize._constrained_cmap(
         Makie.colorschemes[:vik],
         0.0,
         15000.0 + (5000.0 / 3.0),
@@ -70,7 +69,7 @@ using OrderedCollections
     output_name = joinpath(tmp_dir, "test_contours2D_globe_with_test_cmap.png")
     Makie.save(output_name, fig3)
 
-    test_cmap = MakieExt._constrained_cmap(
+    test_cmap = ClimaAnalysis.Visualize._constrained_cmap(
         range(Makie.colorant"red", stop = Makie.colorant"green", length = 15),
         0.0,
         15000.0 + (5000.0 / 3.0),