Add reference tests

Author: adrhill

.gitignore

@@ -2,6 +2,7 @@
 *.jl.cov
 *.jl.mem
 /Manifest.toml
+/test/Manifest.toml
 /docs/Manifest.toml
 /docs/build/
 /.vscode/

src/heatmap.jl

@@ -23,7 +23,7 @@ end
 # such that we can show the heatmap both in the terminal and as HTML output in notebooks.
 
 struct TextHeatmap{
-    V<:AbstractArray{<:Real},W<:AbstractArray{<:AbstractString},C<:AbstractArray{<:Colorant}
+    V<:AbstractArray{<:Real},W<:AbstractArray{<:AbstractString},C<:AbstractArray{<:RGB}
 }
     val::V
     words::W
@@ -32,7 +32,7 @@ struct TextHeatmap{
         if size(words) != size(val) || size(words) != size(colors)
             throw(ArgumentError("Sizes of values, words and colors don't match"))
         end
-        colors = convert.(RGB{N0f8}, colors)
+        colors = convert.(RGB, colors)
         return new{typeof(val),typeof(words),typeof(colors)}(val, words, colors)
     end
 end

test/Project.toml

@@ -2,11 +2,13 @@
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
+FixedPointNumbers = "53c48c17-4a7d-5ca2-90c5-79b7896eea93"
 ReferenceTests = "324d217c-45ce-50fc-942e-d289b448e8cf"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
 Aqua = "0.7"
 ColorSchemes = "3"
 Colors = "0.12"
+FixedPointNumbers = "0.8"
 ReferenceTests = "0.10"

test/references/inferno_centered.txt

@@ -0,0 +1 @@
+Test TextHeatmaps 

test/references/inferno_extrema.txt

@@ -0,0 +1 @@
+Test TextHeatmaps 

test/references/seismic_centered.txt

@@ -0,0 +1 @@
+Test TextHeatmaps 

test/references/seismic_extrema.txt

@@ -0,0 +1 @@
+Test TextHeatmaps 

test/runtests.jl

@@ -1,10 +1,46 @@
 using TextHeatmaps
+using ColorSchemes
+using Colors
+using FixedPointNumbers
+
 using Test
+using ReferenceTests
 using Aqua
 
 @testset "TextHeatmaps.jl" begin
     @testset "Aqua.jl" begin
         @info "Running Aqua.jl's auto quality assurance tests. These might print warnings from dependencies."
         Aqua.test_all(TextHeatmaps)
     end
+    @testset "Heatmap" begin
+        words = ["Test", "TextHeatmaps"]
+        val = [4.2, -1.0]
+
+        cs = TextHeatmaps.seismic
+        cmin = get(cs, 0) # red
+        cmax = get(cs, 1) # blue
+
+        # Test default ColorScheme seismic
+        h = heatmap(val, words)
+        @test h.colors[1] ≈ cmax
+        @test h.colors[2] != cmin
+        @test_reference "references/seismic_centered.txt" repr("text/plain", h)
+
+        h = heatmap(val, words; rangescale=:extrema)
+        @test h.colors[1] ≈ cmax
+        @test h.colors[2] ≈ cmin
+        @test_reference "references/seismic_extrema.txt" repr("text/plain", h)
+
+        # Test other colorschemes
+        cs = ColorSchemes.inferno
+        h = heatmap(val, words; cs=cs, rangescale=:centered)
+        @test_reference "references/inferno_centered.txt" repr("text/plain", h)
+        h = heatmap(val, words; cs=cs, rangescale=:extrema)
+        @test_reference "references/inferno_extrema.txt" repr("text/plain", h)
+
+        # Test errors
+        @test_throws ArgumentError heatmap(val, ["Test", "Text", "Heatmaps"])
+        # Test inner constructor
+        @test_throws ArgumentError TextHeatmaps.TextHeatmap(val, words, [cmin, cmax, cmax])
+    end
 end