Merge pull request #215 from KristofferC/fe/no-forward

Make push! and append! return the original object

Project.toml

@@ -1,6 +1,6 @@
 name = "PGFPlotsX"
 uuid = "8314cec4-20b6-5062-9cdb-752b83310925"
-version = "1.2.2"
+version = "1.2.3"
 
 [deps]
 ArgCheck = "dce04be8-c92d-5529-be00-80e4d2c0e197"

src/PGFPlotsX.jl

@@ -5,7 +5,7 @@ using Dates
 using DataStructures: OrderedDict
 using DefaultApplication: DefaultApplication
 using DocStringExtensions: SIGNATURES, TYPEDEF
-using MacroTools: prewalk, @capture, @forward
+using MacroTools: prewalk, @capture
 using Parameters: @unpack
 using Requires: @require
 using StatsBase: midpoints

src/axiselements.jl

@@ -553,7 +553,8 @@ end
 Plot(is3d::Bool, incremental::Bool, options::Options, data::PlotData,
      trailing::Tuple) = Plot(is3d, incremental, options, data, collect(trailing))
 
-@forward Plot.trailing Base.push!, Base.append!
+Base.push!(p::Plot, args...; kwargs...) = (push!(p.trailing, args...; kwargs...); p)
+Base.append!(p::Plot, args...; kwargs...) = (append!(p.trailing, args...; kwargs...); p)
 
 """
     Plot([options::Options], data, trailing...)

src/axislike.jl

@@ -23,7 +23,8 @@ Return the corresponding LaTeX environment name.
 """
 function axislike_environment end
 
-@forward AxisLike.contents Base.push!, Base.append!
+Base.push!(a::AxisLike, args...; kwargs...) = (push!(a.contents, args...; kwargs...); a)
+Base.append!(a::AxisLike, args...; kwargs...) = (append!(a.contents, args...; kwargs...); a)
 
 (T::Type{<:AxisLike})(contents...) = T(Options(), contents...)
 

src/options.jl

@@ -17,7 +17,9 @@ When `print_empty = false` (the default), empty options are not printed. Use
 Options(pairs::Pair...; print_empty::Bool = false) =
     Options(OrderedDict(pairs), print_empty)
 
-@forward Options.dict Base.getindex, Base.setindex!, Base.delete!
+Base.getindex(o::Options, args...; kwargs...) = getindex(o.dict, args...; kwargs...)
+Base.setindex!(o::Options, args...; kwargs...) = (setindex!(o.dict, args...; kwargs...); o)
+Base.delete!(o::Options, args...; kwargs...) = (delete!(o.dict, args...; kwargs...); o)
 
 Base.copy(options::Options) = deepcopy(options)
 
@@ -95,7 +97,9 @@ Subtypes have an `options::Options` field.
 """
 abstract type OptionType end
 
-@forward OptionType.options Base.getindex, Base.setindex!, Base.delete!
+Base.getindex(o::OptionType, args...; kwargs...) = getindex(o.options, args...; kwargs...)
+Base.setindex!(o::OptionType, args...; kwargs...) = (setindex!(o.options, args...; kwargs...); o)
+Base.delete!(o::OptionType, args...; kwargs...) = (delete!(o.options, args...; kwargs...); o)
 
 Base.copy(a::OptionType) = deepcopy(a)
 

src/tikzdocument.jl

@@ -22,7 +22,8 @@ struct TikzDocument
     end
 end
 
-@forward TikzDocument.elements Base.push!, Base.append!
+Base.push!(t::TikzDocument, args...; kwargs...) = (push!(t.elements, args...; kwargs...); t)
+Base.append!(t::TikzDocument, args...; kwargs...) = (append!(t.elements, args...; kwargs...); t)
 
 """
     $SIGNATURES

src/tikzpicture.jl

@@ -17,7 +17,8 @@ end
 
 TikzPicture(elements::TikzElementOrStr...) = TikzPicture(Options(), elements...)
 
-@forward TikzPicture.elements Base.push!, Base.append!
+Base.push!(t::TikzPicture, args...; kwargs...) = (push!(t.elements, args...; kwargs...); t)
+Base.append!(t::TikzPicture, args...; kwargs...) = (append!(t.elements, args...; kwargs...); t)
 
 function print_tex(io::IO, tp::TikzPicture)
     @unpack options, elements = tp

test/test_elements.jl

@@ -186,20 +186,20 @@ end
 
 @testset "push! and append!" begin
     plot = Plot(Expression("x"))
-    push!(plot, "a")
-    append!(plot, ["b", "c"])
+    push!(plot, "a")::Plot
+    append!(plot, ["b", "c"])::Plot
     @test plot.trailing == ["a", "b", "c"]
     axis = Axis()
-    push!(axis, plot)
-    append!(axis, ["non", "sense"])
+    push!(axis, plot)::Axis
+    append!(axis, ["non", "sense"])::Axis
     @test axis.contents == [plot, "non", "sense"]
     picture = TikzPicture()
-    push!(picture, axis)
-    append!(picture, ["some", "thing"])
+    push!(picture, axis)::TikzPicture
+    append!(picture, ["some", "thing"])::TikzPicture
     @test picture.elements == [axis, "some", "thing"]
     document = TikzDocument()
-    push!(document, picture)
-    append!(document, ["stuff"])
+    push!(document, picture)::TikzDocument
+    append!(document, ["stuff"])::TikzDocument
     @test document.elements == [picture, "stuff"]
 end
 

test/test_options.jl

@@ -34,6 +34,6 @@ end
 @testset "options push! and append!" begin
     opt1 = "color" => "red"
     opt2 = "dashed"
-    @test @pgf(push!({}, opt1, opt2)).dict == Dict([opt1, opt2 => nothing])
-    @test @pgf(append!({}, [opt1, opt2])).dict == Dict([opt1, opt2 => nothing])
+    @test @pgf(push!({}, opt1, opt2)::Options).dict == Dict([opt1, opt2 => nothing])
+    @test @pgf(append!({}, [opt1, opt2])::Options).dict == Dict([opt1, opt2 => nothing])
 end