Merge pull request #112 from sebastianpech/fix#111

Fix#111

Author: Datseris

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.6.2
+* `@tag!` and `@tagsave` now support using `;` as keywords separator (#111)
+
 # 1.6.0
 * `quickactivate` doesn't do anything anymore if you try to activate to already active project.
 * New macro `@quickactivate`

Project.toml

@@ -1,7 +1,7 @@
 name = "DrWatson"
 uuid = "634d3b9d-ee7a-5ddf-bec9-22491ea816e1"
 repo = "https://github.com/JuliaDynamics/DrWatson.jl.git"
-version = "1.6.1"
+version = "1.6.2"
 
 
 

src/DrWatson.jl

@@ -6,8 +6,7 @@ const PATH_SEPARATOR = joinpath("_", "_")[2]
 
 # Misc functions for kw-macros
 convert_to_kw(ex::Expr) = Expr(:kw,ex.args...)
-iskwdefinition(ex) = false
-iskwdefinition(ex::Expr) = ex.head == Symbol("=")
+convert_to_kw(ex) = error("invalid keyword argument syntax \"$ex\"")
 
 # Pure Julia implementation
 include("project_setup.jl")

src/project_setup.jl

@@ -5,8 +5,6 @@ export projectdir, datadir, srcdir, plotsdir, scriptsdir, papersdir
 export projectname
 export findproject, quickactivate, @quickactivate
 
-@deprecate scriptdir scriptsdir #TODO: remove in next release
-
 """
     function is_standard_julia_project()
 

src/saving_files.jl

@@ -99,21 +99,19 @@ Same as [`tagsave`](@ref) but one more field `:script` is added that records
 the local path of the script and line number that called `@tagsave`, see [`@tag!`](@ref).
 """
 macro tagsave(file,d,args...)
+    args = Any[args...]
+    # Keywords added after a ; are moved to the front of the expression
+    # that is passed to the macro. So instead of getting the filename in file
+    # an Expr is passed.
+    if file isa Expr && file.head == :parameters
+        length(args) > 0 || return :(throw(MethodError(@tagsave,$(esc(file)),$(esc(d)),$(esc.(args)...))))
+        extra_kw_def = file.args
+        file = d
+        d = popfirst!(args)
+        append!(args,extra_kw_def)
+    end
     s = QuoteNode(__source__)
-    N = length(args)
-    (N == 0 || all(iskwdefinition.(args))) &&
-        return :(tagsave($(esc(file)), $(esc(d)),$(esc.(convert_to_kw.(args))...),source=$s))
-    # First optional arg. is not needed as if it's not provided dispatch
-    # is done through the kw-version of the function (ie. this line is
-    # never reached)
-    default = [
-        :(projectdir()), #gitpath
-        :(true),         #storepatch
-    ]
-    :(tagsave($(esc(file)),$(esc(d)), $(esc.(args)...), $(esc.(default[N:end])...), $s))
-    # Use this code after the deprecation warning for the non-kw version
-    # is removed.
-    # throw(MethodError(@tagsave,args...))
+    return :(tagsave($(esc(file)), $(esc(d)), $(esc.(convert_to_kw.(args))...),source=$s))
 end
 
 ################################################################################
@@ -204,10 +202,4 @@ function tmpsave(dicts, tmp = projectdir("_research", "tmp");
         wsave(joinpath(tmp, x), copy(dicts[i]))
     end
     r
-end
-
-@deprecate tagsave(file, d, p::String) tagsave(file, d, gitpath=p)
-@deprecate tagsave(file, d, safe::Bool, gitpath = projectdir(), storepatch = true, source = nothing) tagsave(file,d,safe=safe,gitpath=gitpath,storepatch=storepatch,source=source)
-# TODO: When removing the deprecation warning, the tests must be adapted
-# to only use the kw-version of this function. Also the code from the
-# macro version for parsing the non-kw arguments can be replaced.
+end

src/saving_tools.jl

@@ -199,20 +199,18 @@ Dict{Symbol,Any} with 3 entries:
 ```
 """
 macro tag!(d,args...)
+    args = Any[args...]
+    # Keywords added after a ; are moved to the front of the expression
+    # that is passed to the macro. So instead of getting the dict in d
+    # an Expr is passed.
+    if d isa Expr && d.head == :parameters
+        length(args) > 0 || return :(throw(MethodError(@tag!,$(esc(d)),$(esc.(args)...))))
+        extra_kw_def = d.args
+        d = popfirst!(args)
+        append!(args,extra_kw_def)
+    end
     s = QuoteNode(__source__)
-    N = length(args)
-    (N == 0 || all(iskwdefinition.(args))) &&
-        return :(tag!($(esc(d)),$(esc.(convert_to_kw.(args))...),source=$s))
-    # First optional arg. is not needed as if it's not provided dispatch
-    # is done through the kw-version of the function (ie. this line is
-    # never reached)
-    default = [
-        :(true), #storepatch
-    ]
-    :(tag!($(esc(d)), $(esc.(args)...), $(esc.(default[N:end])...), $s))
-    # Use this code after the deprecation warning for the non-kw version
-    # is removed.
-    # throw(MethodError(@tag!,args...))
+    return :(tag!($(esc(d)),$(esc.(convert_to_kw.(args))...),source=$s))
 end
 
 """
@@ -303,9 +301,4 @@ tagsave(savename(s), struct2dict(s))
 """
 function struct2dict(s)
     Dict(x => getfield(s, x) for x in fieldnames(typeof(s)))
-end
-
-@deprecate tag!(d::Dict, gitpath, storepatch = true, source = nothing) tag!(d,gitpath=gitpath,storepatch=storepatch,source=source)
-# TODO: When removing the deprecation warning, the tests must be adapted
-# to only use the kw-version of this function. Also the code from the
-# macro version for parsing the non-kw arguments can be replaced.
+end

test/savefiles_tests.jl

@@ -19,14 +19,14 @@ end
 #                                 tagsave                                      #
 ################################################################################
 t = f(simulation)
-tagsave(savename(simulation, "bson"), t, findproject())
+tagsave(savename(simulation, "bson"), t, gitpath=findproject())
 file = load(savename(simulation, "bson"))
 @test "gitcommit" ∈ keys(file)
 @test file["gitcommit"] |> typeof == String
 rm(savename(simulation, "bson"))
 
 t = f(simulation)
-@tagsave(savename(simulation, "bson"), t, false, findproject())
+@tagsave(savename(simulation, "bson"), t, safe=false, gitpath=findproject())
 file = load(savename(simulation, "bson"))
 @test "gitcommit" ∈ keys(file)
 @test file["gitcommit"] |> typeof == String
@@ -35,7 +35,7 @@ file = load(savename(simulation, "bson"))
 @test file["script"] == joinpath("test", "savefiles_tests.jl#29")
 
 t = f(simulation)
-@tagsave(savename(simulation, "bson"), t, true, findproject())
+@tagsave(savename(simulation, "bson"), t, safe=true, gitpath=findproject())
 sn = savename(simulation, "bson")[1:end-5]*"_#1"*".bson"
 @test isfile(sn)
 rm(sn)
@@ -58,13 +58,9 @@ rm(sn)
 rm(savename(simulation, "bson"))
 @test !isfile(savename(simulation, "bson"))
 
-ex = @macroexpand @tagsave("name",d,false)
-@test ex.args[1].name == :tagsave
-@test ex.args[2] == "name"
-@test ex.args[3] == :d
-@test ex.args[4] == false
-@test ex.args[5] == :(projectdir())
-@test ex.args[6] == true
+ex = @macroexpand @tagsave("testname.bson", (@dict a b c ), storepatch=false; safe=true)
+ex2 = @macroexpand @tagsave("testname.bson", @dict a b c; storepatch=false, safe=true)
+@test ex.args[1:end-1] == ex2.args[1:end-1]
 
 # Remove leftover
 
@@ -110,4 +106,4 @@ end
 @test data[3] == load("test.#backup.jld2")
 rm("test.#backup.jld2")
 rm("test.#backup_#1.jld2")
-rm("test.#backup_#2.jld2")
+rm("test.#backup_#2.jld2")

test/stools_tests.jl

@@ -12,15 +12,15 @@ com = gitdescribe(dirname(@__DIR__))
 d1 = Dict(:x => 3, :y => 4)
 d2 = Dict("x" => 3, "y" => 4)
 for d in (d1, d2)
-    d = tag!(d, @__DIR__)
+    d = tag!(d, gitpath=@__DIR__)
 
     @test haskey(d, keytype(d)(:gitcommit))
     @test d[keytype(d)(:gitcommit)] |> typeof <: String
 end
 
 # @tag!
 for d in (d1, d2)
-    d = @tag!(d, @__DIR__)
+    d = @tag!(d, gitpath=@__DIR__)
     @test haskey(d, keytype(d)(:gitcommit))
     @test d[keytype(d)(:gitcommit)] |> typeof <: String
     @test split(d[keytype(d)(:script)], '#')[1] == basename(@__FILE__)
@@ -39,26 +39,6 @@ d_new = tag!(d,gitpath=@__DIR__,source="foo")
 d_new = @tag!(d,gitpath=@__DIR__)
 @test split(d_new[keytype(d_new)(:script)], '#')[1] == basename(@__FILE__)
 
-ex = @macroexpand @tag!(d)
-
-@test ex.args[1].name == :tag!
-@test ex.args[2] == :d
-@test ex.args[3].head == :kw
-
-ex = @macroexpand @tag!(d,"path")
-
-@test ex.args[1].name == :tag!
-@test ex.args[2] == :d
-@test ex.args[3] == "path"
-@test ex.args[4] == true
-
-ex = @macroexpand @tag!(d,"path",false)
-
-@test ex.args[1].name == :tag!
-@test ex.args[2] == :d
-@test ex.args[3] == "path"
-@test ex.args[4] == false
-
 ex = @macroexpand @tag!(d,gitpath="path")
 
 @test ex.args[1].name == :tag!