Add custom macro example to docs

Author: jw3126

docs/Project.toml

@@ -1,3 +1,4 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"

docs/make.jl

@@ -1,11 +1,20 @@
-using Setfield, Documenter
+using Setfield, Documenter, Literate
+
+inputdir = joinpath(@__DIR__, "..", "examples")
+outputdir = joinpath(@__DIR__, "src", "examples")
+mkpath(outputdir)
+for filename in readdir(inputdir)
+    inpath = joinpath(inputdir, filename)
+    Literate.markdown(inpath, outputdir; documenter=true)
+end
 
 makedocs(
          modules = [Setfield],
          sitename = "Setfield.jl",
          pages = [
             "Introduction" => "intro.md",
             "Docstrings" => "index.md",
+            "Custom Macros" => "examples/custom_macros.md",
             ],
         strict = true,  # to exit with non-zero code on error
         )

docs/src/examples/.gitignore

@@ -0,0 +1 @@
+*.md

docs/src/intro.md

@@ -40,7 +40,7 @@ SpaceShip(Person(:JULIA, 2009), [0.0, 0.0, 0.0], [0.0, 0.0, 0.0])
 julia> s = @set s.velocity[1] += 999999
 SpaceShip(Person(:JULIA, 2009), [999999.0, 0.0, 0.0], [0.0, 0.0, 0.0])
 
-julia> s = @set s.velocity[1] += 999999
+julia> s = @set s.velocity[1] += 1000001
 SpaceShip(Person(:JULIA, 2009), [2.0e6, 0.0, 0.0], [0.0, 0.0, 0.0])
 
 julia> @set s.position[2] = 20

test/test_custom_macros.jl renamed to examples/custom_macros.jl

@@ -1,4 +1,3 @@
-module CustomMacros
 # # Extending `@set` and `@lens`
 # This code demonstrates how to extend the `@set` and `@lens` mechanism with custom
 # lenses.
@@ -74,5 +73,3 @@ set(o, l, 100)
 @test o == (foo=[100,2,3], bar=:bar)
 
 # Everything works, we can do arbitrary nesting and also use `+=` syntax etc.
-
-end#module

test/runtests.jl

@@ -1,6 +1,7 @@
 module TestSetfield
+
+include("test_examples.jl")
 include("test_setmacro.jl")
-include("test_custom_macros.jl")
 include("test_core.jl")
 include("test_functionlenses.jl")
 include("test_settable.jl")

test/test_examples.jl

@@ -0,0 +1,8 @@
+module TestExamples
+using Test
+dir = joinpath("..", "examples")
+@testset "example $filename" for filename in readdir(dir)
+    path = joinpath(dir, filename)
+    include(path)
+end
+end#module

test/test_setmacro.jl

@@ -22,25 +22,27 @@ using StaticArrays: @SMatrix
 @testset "setmacro, lensmacro isolation" begin
 
     # test that no symbols like `IndexLens` are needed:
-    index = 1
-    @test Clone.@lens( _) isa Setfield.Lens
-    @test Clone.@lens( _.a) isa Setfield.Lens
-    @test Clone.@lens( _[end]) isa Setfield.Lens
-    @test Clone.@lens( _[$index]) isa Setfield.Lens
-    @test Clone.@lens( _.a[1][end, end-2].b[$index, $index]) isa Setfield.Lens
+    @test Clone.@lens(_                                   ) isa Setfield.Lens
+    @test Clone.@lens(_.a                                 ) isa Setfield.Lens
+    @test Clone.@lens(_[1]                                ) isa Setfield.Lens
+    @test Clone.@lens(first(_)                            ) isa Setfield.Lens
+    @test Clone.@lens(_[end]                              ) isa Setfield.Lens
+    @test Clone.@lens(_[$1]                           ) isa Setfield.Lens
+    @test Clone.@lens(_.a[1][end, end-2].b[$1, $1]) isa Setfield.Lens
 
     @test Setfield.@lens(_.a) === Clone.@lens(_.a)
     @test Setfield.@lens(_.a.b) === Clone.@lens(_.a.b)
     @test Setfield.@lens(_.a.b[1,2]) === Clone.@lens(_.a.b[1,2])
-    
+
     o = (a=1, b=2)
-    
     @test Clone.@set(o.a = 2) === Setfield.@set(o.a = 2)
     @test Clone.@set(o.a += 2) === Setfield.@set(o.a += 2)
 
     m = @SMatrix [0 0; 0 0]
     m2 = Clone.@set m[end-1, end] = 1
     @test m2 === @SMatrix [0 1; 0 0]
+    m3 = Clone.@set(first(m) = 1)
+    @test m3 === @SMatrix[1 0; 0 0]
 end
 
 end#module