Update macro docstrings, error message and add tests

Author: Mal Miller

src/StructTypes.jl

@@ -2,8 +2,6 @@ module StructTypes
 
 using UUIDs, Dates
 
-include("macros.jl")
-
 "Abstract super type of various `StructType`s; see `StructTypes.DataType`, `StructTypes.CustomType`, `StructTypes.InterfaceType`, and `StructTypes.AbstractType` for more specific kinds of `StructType`s"
 abstract type StructType end
 
@@ -1068,4 +1066,6 @@ function constructfrom(::AbstractType, ::Type{T}, obj::S) where {T, S}
     return constructfrom(TT, obj)
 end
 
+include("macros.jl")
+
 end # module

src/macros.jl

@@ -1,24 +1,26 @@
+isolate_name(name) = split(string(name), '.')[end]
+
 for struct_type in (:Struct, :Mutable, :CustomStruct, :OrderedStruct, :AbstractType, :DictType, :ArrayType, :StringType, :NumberType, :BoolType, :NullType)
     @eval begin
-        @doc """
-            @$($struct_type)(expr::Expr)
-            @$($struct_type)(expr::Symbol)
+        """
+            @$(isolate_name($struct_type))(expr::Expr)
+            @$(isolate_name($struct_type))(expr::Symbol)
         
         If `expr` is a struct definition, sets the `StructType` of the defined struct to
-        $($struct_type)(). If `expr` is the name of a `Type`, sets the `StructType` of that
-        type to $($struct_type)().
+        `$(isolate_name($struct_type))()`. If `expr` is the name of a `Type`, sets the `StructType` of that
+        type to `$(isolate_name($struct_type))()`.
 
         # Examples
         ```julia
-        @$($struct_type) MyStruct
+        @$(isolate_name($struct_type)) MyStruct
         ```
         is equivalent to
         ```julia
         StructTypes.StructType(::Type{MyStruct}) = StructType.Struct()
         ```
         and 
         ```julia
-        @$($struct_type) struct MyStruct
+        @$(isolate_name($struct_type)) struct MyStruct
             val::Int
         end
         ```
@@ -42,15 +44,15 @@ function macro_constructor(expr::Expr, structtype)
             StructTypes.StructType(::Type{$(expr.args[2])}) = $structtype()
         end)
     else
-        return :(throw(ArgumentError("Macro constructors can only be used with a struct definition or a Type")))
+        return :(throw(ArgumentError("StructType macros can only be used with a struct definition or a Type")))
     end
 end
 function macro_constructor(expr::Symbol, structtype)
     return esc(quote
         if $(expr) isa Type
             StructTypes.StructType(::Type{$(expr)}) = $structtype()
         else
-            throw(ArgumentError("Macro constructors can only be used with a struct definition or a Type"))
+            throw(ArgumentError("StructType macros can only be used with a struct definition or a Type"))
         end
     end)
 end

test/runtests.jl

@@ -562,3 +562,32 @@ StructTypes.StructType(::Type{C2}) = StructTypes.Mutable()
         end
     end
 end
+
+@testset "Macros" begin
+    struct MyStruct1
+        val::Int
+    end
+    StructTypes.@Struct MyStruct1
+    @test StructTypes.StructType(MyStruct1) isa StructTypes.Struct
+
+    StructTypes.@NullType struct MyStruct2
+        val::Int
+    end
+    @test StructTypes.StructType(MyStruct2) isa StructTypes.NullType
+
+    StructTypes.@Mutable mutable struct MyStruct3
+        val::Int
+    end
+    @test StructTypes.StructType(MyStruct3) isa StructTypes.Mutable
+
+    # Test an expression that is not a struct def
+    expr = StructTypes.macro_constructor(Expr(:a), StructTypes.Struct)
+    @test_throws ArgumentError eval(expr)
+
+    # Test a symbol that is not a type
+    expr = StructTypes.macro_constructor(:var, StructTypes.Struct)
+    eval(quote
+        var = 1
+    end)
+    @test_throws ArgumentError eval(expr.args[1]) # Extract body from within escape
+end