Merge pull request #49 from disberd/small_fixes

Author: disberd

docs/src/frompackage/basic_use.md

@@ -4,10 +4,10 @@
 @frompackage target import_block
 ```
 
-The `@frompackage` macro takes a local Package (derived from the `target` path), loads it as
-a submodule of the current Pluto workspace and then process the various
-import/using statements inside `import_block` to extract varables/functions from
-the local Package into the notebook workspace.
+The `@frompackage` macro takes a local Package (derived from the `target` path),
+loads it as a submodule of the current Pluto workspace and then process the
+various import/using statements inside `import_block` to extract
+varables/functions from the local Package into the notebook workspace.
 
 !!! note
     `@fromparent` is simply a convenience synthax that uses the calling notebook file as `target`. More details on how the target path is processed are given below.\
@@ -26,9 +26,10 @@ For this reason the *reload* of local code is only triggered manually within `@f
 
 ## `target` path
 
-The first argument to `@frompackage` (`target`) has to be a String containing the path (either
-absolute or relative to the file calling the macro) that points to a local
-Package (the path can be to any file or subfolder within the Package folder).
+The first argument to `@frompackage` (`target`) has to be an AbstractString (or
+a `@raw_str`) containing the path (either absolute or relative to the file
+calling the macro) that points to a local Package (the path can be to any file
+or subfolder within the Package folder).
 
 The main module of the package identified by the `target` path will be used as the module to process and load within the calling notebook
 

src/frompackage/helpers.jl

@@ -261,4 +261,15 @@ end
 issamepath(path1::Symbol, path2::Symbol) = issamepath(String(path1), String(path2))
 
 # Create a Base.PkgId from a PkgInfo
-to_pkgid(p::PkgInfo) = Base.PkgId(p.uuid, p.name)
+to_pkgid(p::PkgInfo) = Base.PkgId(p.uuid, p.name)
+
+# This will extract the string from a raw_str macro, and will throw an error otherwise
+function extract_raw_str(ex::Expr)
+    valid = Meta.isexpr(ex, :macrocall) && ex.args[1] === Symbol("@raw_str")
+    if valid
+        return ex.args[end], true
+    else
+        return "", false
+    end
+end
+extract_raw_str(s::AbstractString) = String(s), true

src/frompackage/macro.jl

@@ -81,8 +81,6 @@ function frompackage(ex, target_file, caller, caller_module; macroname)
 	end
 	# Now we add the call to maybe load the package extensions
 	push!(args, :($load_package_extensions($dict, @__MODULE__)))
-	# Check if we are inside a direct macroexpand code, and clean the LOAD_PATH if we do as we won't be executing the retured expression
-	is_macroexpand(stacktrace(), cell_id) && clean_loadpath(proj_file)
 	# We wrap the import expressions inside a try-catch, as those also correctly work from there.
 	# This also allow us to be able to catch the error in case something happens during loading and be able to gracefully clean the work space
 	text = "Reload $macroname"
@@ -134,10 +132,11 @@ end
 """
 	@frompackage target import_block
 
-This macro takes a local Package (derived from the `target` path), loads it as
-a submodule of the current Pluto workspace and then process the various
-import/using statements inside `import_block` to extract varables/functions from
-the local Package into the notebook workspace.
+This macro takes a local Package (derived from the `target` path, which can be
+an `AbstractString` or a `@raw_str`), loads it as a submodule of the current
+Pluto workspace and then process the various import/using statements inside
+`import_block` to extract varables/functions from the local Package into the
+notebook workspace.
 
 Its main use is allowing to load a local package under development within a
 running Pluto notebook in order to facilitate prototyping and testing.
@@ -162,9 +161,11 @@ See the package [documentation](https://disberd.github.io/PlutoDevMacros.jl/dev/
 
 See also: [`@fromparent`](@ref)
 """
-macro frompackage(target::String, ex)
+macro frompackage(target::Union{AbstractString, Expr}, ex)
+    target_file, valid = extract_raw_str(target)
+    @assert valid "Only `AbstractStrings` or `Exprs` of type `raw\"...\"` are allowed as `target` in the `@frompackage` macro."
 	calling_file = String(__source__.file)
-	out = _combined(ex, target, calling_file, __module__; macroname = "@frompackage")
+	out = _combined(ex, target_file, calling_file, __module__; macroname = "@frompackage")
 	esc(out)
 end
 

test/frompackage/basics.jl

@@ -1,4 +1,4 @@
-import PlutoDevMacros.FromPackage: process_outside_pluto!, load_module_in_caller, modname_path, fromparent_module, parseinput, get_package_data, @fromparent, _combined, process_skiplines!, get_temp_module, LineNumberRange, parse_skipline, extract_module_expression, _inrange, filterednames, reconstruct_import_expr, extract_import_args
+import PlutoDevMacros.FromPackage: process_outside_pluto!, load_module_in_caller, modname_path, fromparent_module, parseinput, get_package_data, @fromparent, _combined, process_skiplines!, get_temp_module, LineNumberRange, parse_skipline, extract_module_expression, _inrange, filterednames, reconstruct_import_expr, extract_import_args, extract_raw_str, @frompackage
 import Pkg
 
 using Test
@@ -49,6 +49,22 @@ finally
     Pkg.activate(current_project)
 end
 
+# Test the macroexpand part
+@test nothing === Core.eval(@__MODULE__, :(@macroexpand @frompackage $(inpackage_target) import *))
+@test_throws "No project was found" Core.eval(@__MODULE__, :(@macroexpand @frompackage "/asd/lol" import TOML))
+@testset "raw_str" begin
+    str, valid = extract_raw_str("asd")
+    @test valid
+    @test str == "asd"
+    str, valid = extract_raw_str(:(raw"asd\lol"))
+    @test valid
+    @test str == "asd\\lol"
+    @test_throws "Only `AbstractStrings`" Core.eval(Main, :(@frompackage 3+2 import *))
+    cd(dirname(inpackage_target)) do
+        @test Core.eval(@__MODULE__, :(@frompackage raw".." import *)) === nothing
+    end
+end
+
 @testset "Outside Pluto" begin
     dict = get_package_data(inpackage_target)
     valid(ex) = nothing !== process_outside_pluto!(deepcopy(ex), dict)