Removing double prefixes bug in produce_or_load (#393)

* Removing double prefixes bug in produce_or_load * correcting test when default_prefix was modified * Correcting produce_or_load: filename as function * Update Project.toml * Update CHANGELOG.md --------- Co-authored-by: George Datseris <[email protected]>
JuliaDynamics · Jul 3, 2023 · 506109c · 506109c
1 parent ab87902
commit 506109c
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+# 2.12.6
+- Crucial bugfix to `produce_or_load`. When used with a prefix, it attached double prefix to the file (one coming as a duplicate from `savename`). This is now fixed, but it means that some files produced with prefix and `produce_or_load` in v2.12 may be re-produced after this update.
+
 # 2.12.0
 - Arbitrary functions extracting strings from data can be used in `produce_or_load` instead of `savename`. `hash` is the most useful function here. An example in Real World Examples highlights this.
 - Additional keywords in `produce_or_load` propagated to `savename` are deprecated.

diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "DrWatson"
 uuid = "634d3b9d-ee7a-5ddf-bec9-22491ea816e1"
 repo = "https://github.com/JuliaDynamics/DrWatson.jl.git"
-version = "2.12.5"
+version = "2.12.6"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

diff --git a/src/saving_files.jl b/src/saving_files.jl
@@ -79,16 +79,16 @@ function produce_or_load(f::Function, config, path::String = "";
         for the keyword `filename` as `filename = config -> savename(config; kwargs...)`
         """
     end
-    if filename === nothing
-        filename = config -> savename(config; kwargs...)
-    end
     # Prepare absolute file name
-    if filename isa AbstractString
-        name = filename
-    else
+    if filename === nothing
+        filename = config -> savename(prefix, config, suffix; kwargs...)
+        name = filename(config)
+    elseif filename isa AbstractString
+        name = append_prefix_suffix(filename, prefix, suffix)
+    else #if filename isa Function
         name = string(filename(config))
+        name = append_prefix_suffix(name, prefix, suffix)
     end
-    name = append_prefix_suffix(name, prefix, suffix)
     file = joinpath(path, name)
     # Run the remaining logic on whether to produce or load
     if !force && isfile(file)

diff --git a/test/savefiles_tests.jl b/test/savefiles_tests.jl
@@ -307,6 +307,23 @@ end
     rm(path; recursive = true, force = true)
 end
 
+# Testing proper filenames when default_prefix was modified. See https://github.com/JuliaDynamics/DrWatson.jl/issues/392
+@testset "@produce_or_load with default_prefix modified" begin
+    path = mktempdir()
+
+    struct Dummy
+        x
+        y
+    end
+    simulation = Dummy(1,2)
+    DrWatson.default_prefix(d::Dummy) = "Prefix_"
+
+    sim, path = produce_or_load(f, simulation, "")
+    @test path == savename(simulation, "jld2")
+
+    rm(path)
+    DrWatson.default_prefix(ntuple::NamedTuple) = ""
+end
 
 
 ################################################################################