remove infinite spam from QUACKTIVATE and add @quickactivate (#110)

* remove infinite spam

* docstring typo

* version up

* Add quickactivate macro

* update docs and versions

Author: Datseris

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.6.0
+* `quickactivate` doesn't do anything anymore if you try to activate to already active project.
+* New macro `@quickactivate`
+
 # 1.5.0
 * Started to add support for overloading save/load for custom files. See the updated docs around `wsave` and `wload`.
 

Project.toml

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

docs/src/project.md

@@ -63,16 +63,9 @@ This can be done in multiple ways:
 
 We recommend the fourth approach, although it does come with a caveat (see the docstring of [`quickactivate`](@ref)).
 
-Here is how it works: the function [`quickactivate`](@ref) activates a project given some path by recursively searching the path and its parents for a valid `Project.toml` file. Typically you put this function in your script files like so:
-```julia
-using DrWatson # DONT USE OTHER PACKAGES HERE!
-quickactivate(@__DIR__, "Best project in the WORLLDD")
-# Now you should start using other packages
-```
-where the second optional argument can assert if the activated project matches the name you provided. If not the function will throw an error.
-
 ```@docs
 quickactivate
+@quickactivate
 findproject
 ```
 

src/project_setup.jl

@@ -3,7 +3,7 @@
 ##########################################################################################
 export projectdir, datadir, srcdir, plotsdir, scriptsdir, papersdir
 export projectname
-export findproject, quickactivate
+export findproject, quickactivate, @quickactivate
 
 @deprecate scriptdir scriptsdir #TODO: remove in next release
 
@@ -91,14 +91,20 @@ end
 
 """
     quickactivate(path [, name::String])
-Activate the project found by [`findproject`](@ref) of the `path`, which
-recursively searches the `path` and its parents for a valid Julia
-project file.
-
+Activate the project found by recursively searching the `path`
+and its parents for a valid Julia project file.
 Optionally check if `name` is the same as the activated project's name.
-If it is not, throw an error.
+If it is not, throw an error. See also [`@quickactivate`].
+Do nothing if the project found is already active, or if no
+project file is found.
 
-This function is _first_ activating the project and _then_ checking if
+Example:
+```julia
+using DrWatson
+quickactivate("path/to/project", "Best project in the WOLRLDD")
+```
+
+Notice that this function is _first_ activating the project and _then_ checking if
 it matches the `name`.
 
 !!! warning
@@ -108,17 +114,17 @@ it matches the `name`.
     will be the one of the global environment, and not of the activated project.
     To avoid unexpected behavior take care so that these two versions coincide.
 
-    **In addition please be very careful to not write:**
+    **In addition please be very careful to write:**
     ```julia
-    using DrWatson, Package1, Package2
+    using DrWatson
     quickactivate(@__DIR__)
+    using Package1, Package2
     # do stuff
     ```
-    **but instead load packages after activating the project:**
+    **instead of the erroneous:**
     ```julia
-    using DrWatson
+    using DrWatson, Package1, Package2
     quickactivate(@__DIR__)
-    using Package1, Package2
     # do stuff
     ```
     This ensures that the packages you use will all have the versions dictated
@@ -127,7 +133,9 @@ it matches the `name`.
 """
 function quickactivate(path, name = nothing)
     projectpath = findproject(path)
-    projectpath === nothing && return nothing
+    if projectpath === nothing || projectpath == dirname(Base.active_project())
+        return nothing
+    end
     Pkg.activate(projectpath)
     if !(name === nothing) && projectname() != name
         error(
@@ -138,8 +146,22 @@ function quickactivate(path, name = nothing)
     return nothing
 end
 
+"""
+    @quickactivate
+Equivalent with `quickactivate(@__DIR__)`.
 
-
+    @quickactivate name
+Equivalent with `quickactivate(@__DIR__, name)`.
+"""
+macro quickactivate(name = nothing)
+    if __source__.file === nothing
+        dir = nothing
+    else
+        _dirname = dirname(String(__source__.file))
+        dir = isempty(_dirname) ? pwd() : abspath(_dirname)
+    end
+    :(quickactivate($dir,$name))
+end
 
 ##########################################################################################
 # Project setup
@@ -213,7 +235,7 @@ function initialize_project(path, name = basename(path);
     # chmod is needed, as the file permissions are not set correctly when adding the package with `add`.
     cp(joinpath(@__DIR__, "defaults", "gitignore.txt"), joinpath(path, ".gitignore"))
     chmod(joinpath(path, ".gitignore"),0o644)
-    
+
     cp(joinpath(@__DIR__, "defaults", "intro.jl"), joinpath(path, "scripts", "intro.jl"))
     chmod(joinpath(path, "scripts", "intro.jl"),0o644)
 

test/update_results_tests.jl

@@ -98,9 +98,22 @@ subfolders = true, special_list=special_list, black_list = black_list)
 @test sort(names(cres3)) == sort(names(cres2))
 @test size(cres3) == size(cres2)
 
+###############################################################################
+#                              Quickactivate macro                            #
+###############################################################################
+
+cd(@__DIR__)
+isdir("testdir") && rm("testdir", recursive=true)
+initialize_project("testdir"; git = false)
+open(joinpath("testdir","testinclude.jl"),"w") do f
+    write(f,"@quickactivate\n")
+end
+include(joinpath("testdir", "testinclude.jl"))
+@test Base.active_project() == abspath(joinpath("testdir","Project.toml"))
+
 ###############################################################################
 #                                 Delete Folders                              #
 ###############################################################################
 
 cd(@__DIR__)
-rm("testdir", recursive=true)
+rm("testdir", recursive=true)