bug(datasets): keychecker fails to check some wrong arguments (#193)

* semver(datasets): v0.1.1

Closes #186

* ci(sdt): add the keychecker unit test

* ci(sdt): add the test for the wrong layer argument

* bug(datasets): correctly catches keywords that are not supported

* ci(datasets): fix the unit test to catch the correct error

* bug(datasets): fix a typo in the unit test error message

SimpleSDMDatasets/Project.toml

@@ -1,7 +1,7 @@
 name = "SimpleSDMDatasets"
 uuid = "2c7d61d0-5c73-410d-85b2-d2e7fbbdcefa"
 authors = ["Timothée Poisot <timothee.poisot@umontreal.ca>"]
-version = "0.1.1"
+version = "0.1.2"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

SimpleSDMDatasets/src/keychecker.jl

@@ -39,6 +39,9 @@ function keychecker(data::R; kwargs...) where {R <: RasterData}
     # Check for allowed extra keys
     for k in keys(kwargs)
         if ~(k in [:month, :layer, :resolution])
+            if isnothing(extrakeys(data))
+                error("The keyword argument $(k) is not supported by the $(R) dataset")
+            end
             if k in keys(extrakeys(data))
                 if ~(values(kwargs)[k] in extrakeys(data)[k])
                     error(
@@ -48,44 +51,56 @@ function keychecker(data::R; kwargs...) where {R <: RasterData}
             end
         end
     end
+
     return nothing
 end
 
 function keychecker(data::R, future::F; kwargs...) where {R <: RasterData, F <: Projection}
-
     @assert SimpleSDMDatasets.provides(data, future)
 
     # Check for month
     if :month in keys(kwargs)
         if isnothing(months(data, future))
-            error("The $(R) dataset does not allow for month as a keyword argument under $(F)")
+            error(
+                "The $(R) dataset does not allow for month as a keyword argument under $(F)",
+            )
         end
         if ~(values(kwargs).month in months(data))
-            error("The month $(values(kwargs).month) is not supported by the $(R) dataset under $(F)")
+            error(
+                "The month $(values(kwargs).month) is not supported by the $(R) dataset under $(F)",
+            )
         end
     end
 
     # Check for timespan
     if :timespan in keys(kwargs)
         if isnothing(timespans(data, future))
-            error("The $(R) dataset does not allow for timespan as a keyword argument under $(F)")
+            error(
+                "The $(R) dataset does not allow for timespan as a keyword argument under $(F)",
+            )
         end
         if ~(values(kwargs).timespan in timespans(data, future))
-            error("The timespan $(values(kwargs).month) is not supported by the $(R) dataset under $(F)")
+            error(
+                "The timespan $(values(kwargs).month) is not supported by the $(R) dataset under $(F)",
+            )
         end
     end
 
     # Check for layer
     if :layer in keys(kwargs)
         if isnothing(layers(data))
-            error("The $(R) dataset does not allow for layer as a keyword argument under $(F)")
+            error(
+                "The $(R) dataset does not allow for layer as a keyword argument under $(F)",
+            )
         end
         if values(kwargs).layer isa Integer
             if ~(1 <= values(kwargs).layer <= length(layers(data)))
                 error("The $(R) dataset only has $(length(layers(data))) layers under $(F)")
             end
         elseif ~(values(kwargs).layer in layers(data))
-            error("The layer $(values(kwargs).layer) is not supported by the $(R) dataset under $(F)")
+            error(
+                "The layer $(values(kwargs).layer) is not supported by the $(R) dataset under $(F)",
+            )
         end
     end
 
@@ -104,6 +119,9 @@ function keychecker(data::R, future::F; kwargs...) where {R <: RasterData, F <:
     # Check for allowed extra keys
     for k in keys(kwargs)
         if ~(k in [:month, :layer, :resolution, :timespan])
+            if isnothing(extrakeys(data))
+                error("The keyword argument $(k) is not supported by the $(R) dataset")
+            end
             if k in keys(extrakeys(data))
                 if ~(values(kwargs)[k] in extrakeys(data)[k])
                     error(
@@ -113,5 +131,6 @@ function keychecker(data::R, future::F; kwargs...) where {R <: RasterData, F <:
             end
         end
     end
+
     return nothing
 end

test/edgecases/03_layers_keycheck.jl

@@ -0,0 +1,9 @@
+module TestThatWrongKeywordsAreCaught
+
+using SpeciesDistributionToolkit
+using Test
+
+provider = RasterData(WorldClim2, BioClim)
+@test_throws "The keyword argument layers is not" SimpleSDMPredictor(provider; layers=3)
+
+end

test/runtests.jl

@@ -7,6 +7,7 @@ tests = [
     "read/write layers" => "01_integration_read.jl",
     "EDGE: stitch bounding box" => "edgecases/01_stitch_wrong_bb.jl",
     "EDGE: clip & GDAL" => "edgecases/02_clip_gdalwarp.jl",
+    "EDGE: keychecker" => "edgecases/03_layers_keycheck.jl",
 ]
 
 for test in tests