Merge pull request #46 from MikeInnes/teh/pc

RFC: test, fix, and redesign Requires

Author: MikeInnes

README.md

@@ -1,3 +1,13 @@
+### Note: changes in v0.7
+
+Requires now needs a UUID, and must be called from within your packages `__init__` function. For example:
+
+```julia
+function __init__()
+    @require JSON="682c06a0-de6a-54ab-a142-c8b1cf79cde6" do_stuff()
+end
+```
+
 # Requires.jl
 
 [![Build Status](https://travis-ci.org/MikeInnes/Requires.jl.svg?branch=master)](https://travis-ci.org/MikeInnes/Requires.jl)

src/Requires.jl

@@ -3,7 +3,10 @@ __precompile__()
 module Requires
 
 include("init.jl")
-include("getthing.jl")
 include("require.jl")
 
+function __init__()
+    push!(package_callbacks, loadpkg)
+end
+
 end # module

src/getthing.jl

@@ -22,8 +22,3 @@ end
 macro init(args...)
   initm(args...)
 end
-
-"Prevent init fns being called multiple times during precompilation."
-macro guard(ex)
-  :(!isprecompiling() && $(esc(ex)))
-end

src/init.jl

@@ -5,10 +5,6 @@ export @require
 
 isprecompiling() = ccall(:jl_generating_output, Cint, ()) == 1
 
-@init begin
-  push!(package_callbacks, loadpkg)
-end
-
 loaded(pkg) = haskey(Base.loaded_modules, pkg)
 
 const _callbacks = Dict{PkgId, Vector{Function}}()
@@ -52,33 +48,28 @@ function parsepkg(ex)
   isexpr(ex, :(=)) || @goto fail
   mod, id = ex.args
   (mod isa Symbol && id isa String) || @goto fail
-  return Base.PkgId(Base.UUID(id), String(mod))
+  return id, String(mod)
   @label fail
   error("Requires syntax is: `@require Pkg=\"uuid\"`")
 end
 
 macro require(pkg, expr)
   pkg isa Symbol &&
     return Expr(:macrocall, Symbol("@warn"), __source__,
-                "Requires now needs a UUID: `@require $pkg=\"uuid\"`")
-  pkg = parsepkg(pkg)
-  ex = quote
-    listenpkg($pkg) do
-      withpath(@__FILE__) do
-        err($__module__, $(pkg.name)) do
-          $(esc(:(eval($(Expr(:quote, Expr(:block,
-                                           :(const $(Symbol(pkg.name)) = Base.require($pkg)),
-                                           expr)))))))
+                "Requires now needs a UUID; please see the readme for changes in 0.7.")
+  id, modname = parsepkg(pkg)
+  pkg = Base.PkgId(Base.UUID(id), modname)
+  quote
+    if !isprecompiling()
+      listenpkg(Base.PkgId(Base.UUID($id), $modname)) do
+        withpath($(string(__source__.file))) do
+          err($__module__, $(pkg.name)) do
+            $(esc(:(eval($(Expr(:quote, Expr(:block,
+                                            :(const $(Symbol(pkg.name)) = Base.require($pkg)),
+                                            expr)))))))
+          end
         end
       end
     end
   end
-  quote
-    if isprecompiling()
-      @init @guard $(ex)
-    else
-      $(ex)
-    end
-    nothing
-  end
 end

src/require.jl

@@ -1,18 +1,67 @@
-module Foo
+using Test
 
-using Requires, Test
+function writepkg(name, precomp::Bool)
+    open("$name.jl", "w") do io
+        println(io, """
+__precompile__($precomp)
 
-beforeflag = false
-afterflag = false
+module $name
 
-@require JSON="682c06a0-de6a-54ab-a142-c8b1cf79cde6" global beforeflag = true
+using Requires
 
-@test !beforeflag
-using JSON
-@test beforeflag
+flag = false
 
-@require JSON="682c06a0-de6a-54ab-a142-c8b1cf79cde6" global afterflag = true
+function __init__()
+    @require JSON="682c06a0-de6a-54ab-a142-c8b1cf79cde6" global flag = true
+end
+
+end
+""")
+    end
+end
+
+@testset "Requires" begin
+    mktempdir() do pkgsdir
+        cd(pkgsdir) do
+            npcdir = joinpath("FooNPC", "src")
+            mkpath(npcdir)
+            cd(npcdir) do
+                writepkg("FooNPC", false)
+            end
+            npcdir = joinpath("FooPC", "src")
+            mkpath(npcdir)
+            cd(npcdir) do
+                writepkg("FooPC", true)
+            end
+        end
+        push!(LOAD_PATH, pkgsdir)
+
+        @eval using FooNPC
+        @test !FooNPC.flag
+        @eval using FooPC
+        @test !FooPC.flag
+
+        @eval using JSON
+
+        @test FooNPC.flag
+        @test FooPC.flag
 
-@test afterflag
+        cd(pkgsdir) do
+            npcdir = joinpath("FooAfterNPC", "src")
+            mkpath(npcdir)
+            cd(npcdir) do
+                writepkg("FooAfterNPC", false)
+            end
+            pcidr = joinpath("FooAfterPC", "src")
+            mkpath(pcidr)
+            cd(pcidr) do
+                writepkg("FooAfterPC", true)
+            end
+        end
 
+        @eval using FooAfterNPC
+        @eval using FooAfterPC
+        @test FooAfterNPC.flag
+        @test FooAfterPC.flag
+    end
 end