Fix UnitfulExt for PGFPlotsX take 2 (#4747)

* tests and migrate unitformat

* fix tests

* format

* fix tests

* adjust empty label case

* add imports

* add compat

* ditch 1.6

* Revert "ditch 1.6"

This reverts commit 1f0ce95.

* change imports

* fix ci config

Author: BeastyBlacksmith

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
     branches: [master]
   pull_request:
 
-concurrency: 
+concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
@@ -29,18 +29,21 @@ jobs:
       matrix:
         version:
           - '1.6' # LTS (minimal declared julia compat in `Project.toml`)
-          - '1.8' # latest stable
+          - '1.9' # latest stable
         os: [ubuntu-latest, windows-latest, macos-latest]
         arch: [x64]
         include:
           - os: ubuntu-latest
             prefix: xvfb-run  # julia-actions/julia-runtest/blob/master/README.md
           - os: ubuntu-latest
             prefix: xvfb-run
-            version: '1.7'  # only test intermediate release on `ubuntu` to spare resources
+            version:  '1.7' # only test intermediate release on `ubuntu` to spare resources
           - os: ubuntu-latest
             prefix: xvfb-run
-            version: '~1.9.0-0'  # upcoming julia version, next `rc`
+            version:  '1.8' # only test intermediate release on `ubuntu` to spare resources
+          # - os: ubuntu-latest
+          #   prefix: xvfb-run
+          #   version: '~1.9.0-0'  # upcoming julia version, next `rc`
           - os: ubuntu-latest
             prefix: xvfb-run
             version: 'nightly'

Project.toml

@@ -21,6 +21,7 @@ NaNMath = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 PlotThemes = "ccf2f8ad-2431-5c83-bf29-c5338b663b6a"
 PlotUtils = "995b91a9-d308-5afd-9ec6-746e21dbc043"
+PrecompileTools = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
 Preferences = "21216c6a-2e73-6563-6e65-726566657250"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
@@ -32,14 +33,28 @@ RelocatableFolders = "05181044-ff0b-4ac5-8273-598c1e38db00"
 Requires = "ae029012-a4dd-5104-9daa-d747884805df"
 Scratch = "6c6a2e73-6563-6170-7368-637461726353"
 Showoff = "992d4aef-0814-514b-bc4d-f2e9a6c4116f"
-PrecompileTools = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
 UnicodeFun = "1cfade01-22cf-5700-b092-accc4b62d6e1"
+UnitfulLatexify = "45397f5d-5981-4c77-b2b3-fc36d6e9b728"
 Unzip = "41fe7b60-77ed-43a1-b4f0-825fd5a5650d"
 
+[weakdeps]
+FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
+GeometryBasics = "5c1252a2-5f33-56bf-86c9-59e7332b4326"
+IJulia = "7073ff75-c697-5162-941a-fcdaad2a7d2a"
+ImageInTerminal = "d8c32880-2388-543b-8c61-d9f865259254"
+Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
+
+[extensions]
+FileIOExt = "FileIO"
+GeometryBasicsExt = "GeometryBasics"
+IJuliaExt = "IJulia"
+ImageInTerminalExt = "ImageInTerminal"
+UnitfulExt = "Unitful"
+
 [compat]
 Contour = "0.5 - 0.6"
 FFMPEG = "0.2 - 0.4"
@@ -61,6 +76,7 @@ PlotUtils = "1"
 PlotlyBase = "0.7 - 0.8"
 PlotlyJS = "0.18"
 PlotlyKaleido = "1"
+PrecompileTools = "1"
 Preferences = "1"
 PyPlot = "2"
 PythonPlot = "1"
@@ -71,20 +87,13 @@ RelocatableFolders = "0.3, 1"
 Requires = "1"
 Scratch = "1"
 Showoff = "0.3.1, 1"
-PrecompileTools = "1"
 StatsBase = "0.33"
 UnicodeFun = "0.4"
 UnicodePlots = "3.4"
+UnitfulLatexify = "1"
 Unzip = "0.1 - 0.2"
 julia = "1.6"
 
-[extensions]
-FileIOExt = "FileIO"
-GeometryBasicsExt = "GeometryBasics"
-IJuliaExt = "IJulia"
-ImageInTerminalExt = "ImageInTerminal"
-UnitfulExt = "Unitful"
-
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
@@ -121,10 +130,3 @@ VisualRegressionTests = "34922c18-7c2a-561c-bac1-01e79b2c4c92"
 
 [targets]
 test = ["Aqua", "Colors", "Distributions", "FileIO", "FilePathsBase", "FreeType", "Gaston", "GeometryBasics", "Gtk", "ImageMagick", "Images", "InspectDR", "LibGit2", "OffsetArrays", "PGFPlotsX", "PlotlyJS", "PlotlyBase", "PyPlot", "PythonPlot", "PlotlyKaleido", "HDF5", "RDatasets", "SentinelArrays", "StableRNGs", "StaticArrays", "StatsPlots", "Test", "TestImages", "UnicodePlots", "Unitful", "VisualRegressionTests"]
-
-[weakdeps]
-FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
-GeometryBasics = "5c1252a2-5f33-56bf-86c9-59e7332b4326"
-IJulia = "7073ff75-c697-5162-941a-fcdaad2a7d2a"
-ImageInTerminal = "d8c32880-2388-543b-8c61-d9f865259254"
-Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"

ext/UnitfulExt.jl

@@ -6,6 +6,9 @@ module UnitfulExt
 import Plots: Plots, @ext_imp_use, @recipe, PlotText, Subplot, AVec, AMat, Axis
 import RecipesBase
 @ext_imp_use :import Unitful Quantity unit ustrip Unitful dimension Units NoUnits LogScaled logunit MixedUnits Level Gain uconvert
+import LaTeXStrings: LaTeXString
+import Latexify: latexify
+using UnitfulLatexify
 
 const MissingOrQuantity = Union{Missing,<:Quantity,<:LogScaled}
 
@@ -214,12 +217,38 @@ append_unit_if_needed!(attr, key, u) =
 # dispatch on the type of `label`
 append_unit_if_needed!(attr, key, label::ProtectedString, u) = nothing
 append_unit_if_needed!(attr, key, label::UnitfulString, u) = nothing
-append_unit_if_needed!(attr, key, label::Nothing, u) =
-    (attr[key] = UnitfulString(string(u), u))
+function append_unit_if_needed!(attr, key, label::Nothing, u)
+    attr[key] = if attr[:plot_object].backend == Plots.PGFPlotsXBackend()
+        UnitfulString(LaTeXString(latexify(u)), u)
+    else
+        UnitfulString(string(u), u)
+    end
+end
 function append_unit_if_needed!(attr, key, label::S, u) where {S<:AbstractString}
     isempty(label) && return attr[key] = UnitfulString(label, u)
-    attr[key] =
-        UnitfulString(S(format_unit_label(label, u, get(attr, :unitformat, :round))), u)
+    if attr[:plot_object].backend == Plots.PGFPlotsXBackend()
+        attr[key] = UnitfulString(
+            LaTeXString(
+                format_unit_label(
+                    label,
+                    latexify(u),
+                    get(attr, Symbol(attr[:letter], :unitformat), :round),
+                ),
+            ),
+            u,
+        )
+    else
+        attr[key] = UnitfulString(
+            S(
+                format_unit_label(
+                    label,
+                    u,
+                    get(attr, Symbol(attr[:letter], :unitformat), :round),
+                ),
+            ),
+            u,
+        )
+    end
 end
 
 #=============================================
@@ -237,6 +266,7 @@ const UNIT_FORMATS = Dict(
     :slashcurly => (" / {", "}"),
     :slashangle => (" / <", ">"),
     :verbose => " in units of ",
+    :none => nothing,
 )
 
 format_unit_label(l, u, f::Nothing)                    = string(l, ' ', u)
@@ -293,17 +323,8 @@ function _unit(x)
     unit(x)
 end
 
-Plots.pgfx_sanitize_string(s::UnitfulString) = begin
-    tex_str = if (str_unit = string(s.unit)) == s.content
-        ""
-    else
-        Plots.pgfx_sanitize_string(s.content)
-    end
-    tex_unit = replace(Plots.wrap_power_label(str_unit), ' ' => '~')
-    if !Plots.pgfx_is_inline_math(tex_unit)
-        tex_unit = "\\($tex_unit\\)"  # force inline math mode
-    end
-    isempty(tex_str) ? tex_unit : tex_str * ' ' * tex_unit
+function Plots.pgfx_sanitize_string(s::UnitfulString)
+    UnitfulString(Plots.pgfx_sanitize_string(s.content), s.unit)
 end
 
 end  # module

src/arg_desc.jl

@@ -195,9 +195,10 @@ const _arg_desc = KW(
     :showaxis                    => (Union{Bool,Symbol,AStr}, "Show the axis. `true`, `false`, `:show`, `:hide`, `:yes`, `:no`, `:x`, `:y`, `:z`, `:xy`, ..., `:all`, `:off`."),
     :widen                       => (Union{Bool,Real,Symbol}, """
                                     Widen the axis limits by a small factor to avoid cut-off markers and lines at the borders.
-                                    If set to `true`, scale the axis limits by the default factor of $(default_widen_factor). 
+                                    If set to `true`, scale the axis limits by the default factor of $(default_widen_factor).
                                     A different factor may be specified by setting `widen` to a number.
                                     Defaults to `:auto`, which widens by the default factor unless limits were manually set.
                                     See also the `scale_limits!` function for scaling axis limits in an existing plot."""),
     :draw_arrow                  => (Bool, "Draw arrow at the end of the axis."),
+    :unitformat                  => (Union{Bool,Nothing,Symbol,Char,String,NTuple{<:Union{Char,String}},Function}, """Check examples in https://docs.juliaplots.org/stable/generated/unitfulext_examples/#Unit-formatting"""),
 )

src/args.jl

@@ -519,6 +519,7 @@ const _axis_defaults = KW(
     :showaxis                    => true,
     :widen                       => :auto,
     :draw_arrow                  => false,
+    :unitformat                  => :round,
 )
 
 const _suppress_warnings = Set{Symbol}([

test/test_pgfplotsx.jl

@@ -1,3 +1,5 @@
+using Test, Plots, Unitful, LaTeXStrings
+
 function create_plot(args...; kwargs...)
     pl = plot(args...; kwargs...)
     return pl, repr("application/x-tex", pl)
@@ -119,7 +121,7 @@ with(:pgfplotsx) do
             bg = :linen,
             xlim = (0, 10),
             ylim = (0, 10),
-        ) isa Plot
+        ) isa Plots.Plot
     end
 
     @testset "Layout" begin
@@ -128,13 +130,13 @@ with(:pgfplotsx) do
             layout = 4,
             palette = [:grays :blues :hot :rainbow],
             bg_inside = [:orange :pink :darkblue :black],
-        ) isa Plot
+        ) isa Plots.Plot
     end
 
     @testset "Polar plots" begin
         Θ = range(0, stop = 1.5π, length = 100)
         r = abs.(0.1 * randn(100) + sin.(3Θ))
-        @test plot(Θ, r, proj = :polar, m = 2) isa Plot
+        @test plot(Θ, r, proj = :polar, m = 2) isa Plots.Plot
     end
 
     @testset "Drawing shapes" begin
@@ -170,11 +172,11 @@ with(:pgfplotsx) do
             xlim = (0, 1),
             ylim = (0, 1),
             leg = false,
-        ) isa Plot
+        ) isa Plots.Plot
     end
 
     @testset "Histogram 2D" begin
-        @test histogram2d(randn(10_000), randn(10_000), nbins = 20) isa Plot
+        @test histogram2d(randn(10_000), randn(10_000), nbins = 20) isa Plots.Plot
     end
 
     @testset "Heatmap-like" begin
@@ -188,7 +190,7 @@ with(:pgfplotsx) do
             @test axis["colormap name"] == "plots1"
         end
 
-        @test wireframe(xs, ys, z, aspect_ratio = 1) isa Plot
+        @test wireframe(xs, ys, z, aspect_ratio = 1) isa Plots.Plot
         # TODO: clims are wrong
     end
 
@@ -202,7 +204,7 @@ with(:pgfplotsx) do
         p2 = contour(x, y, Z)
         p1 = contour(x, y, f, fill = true)
         p3 = contour3d(x, y, Z)
-        @test plot(p1, p2) isa Plot
+        @test plot(p1, p2) isa Plots.Plot
         @test_nowarn Plots._update_plot_object(p3)
         # TODO: colorbar for filled contours
     end
@@ -214,7 +216,7 @@ with(:pgfplotsx) do
         y = t .* sin.(θ)
         p1 = plot(x, y, line_z = t, linewidth = 3, legend = false)
         p2 = scatter(x, y, marker_z = (x, y) -> x + y, color = :bwr, legend = false)
-        @test plot(p1, p2) isa Plot
+        @test plot(p1, p2) isa Plots.Plot
     end
 
     @testset "Framestyles" begin
@@ -250,7 +252,7 @@ with(:pgfplotsx) do
         u = ones(length(x))
         v = cos.(x)
         pl = plot(x, y, quiver = (u, v), arrow = true)
-        @test pl isa Plot
+        @test pl isa Plots.Plot
         # TODO: could adjust limits to fit arrows if too long, but how ?
         # mktempdir() do path
         #    @test_nowarn savefig(pl, path*"arrow.pdf")
@@ -461,4 +463,15 @@ with(:pgfplotsx) do
             @test isfile(fn)
         end
     end
+
+    @testset "Unitful interaction" begin
+        yreg = r"ylabel=\{((?:[^{}]*\{[^{}]*\})*[^{}]*?)\}"
+        pl1 = plot([1u"s", 2u"s"], [1u"m", 2u"m"], xlabel = "t", ylabel = "diameter")
+        pl2 = plot([1u"s", 2u"s"], [1u"m/s^2", 2u"m/s^2"])
+        pl1_tex = String(repr("application/x-tex", pl1))
+        pl2_tex = String(repr("application/x-tex", pl2))
+        @test pl1_tex[findfirst(yreg, pl1_tex)] == "ylabel={diameter (\$\\mathrm{m}\$)}"
+        @test pl2_tex[findfirst(yreg, pl2_tex)] ==
+              "ylabel={\$\\mathrm{m}\\,\\mathrm{s}^{-2}\$}"
+    end
 end

test/test_quality.jl

@@ -5,7 +5,15 @@
     Aqua.test_all(
         Plots;
         stale_deps = (;
-            ignore = [:GR, :CondaPkg, :Contour, :Latexify, :LaTeXStrings, :Requires]
+            ignore = [
+                :GR,
+                :CondaPkg,
+                :Contour,
+                :Latexify,
+                :LaTeXStrings,
+                :Requires,
+                :UnitfulLatexify,
+            ]
         ),
         project_toml_formatting = false,  # issues since weak deps
         ambiguities = false,