fix

Author: bramtayl

src/MetaGraphs.jl

@@ -215,13 +215,13 @@ julia> using MetaGraphs
 
 julia> using LightGraphs: Edge, Graph
 
-julia> test = meta_graph(Graph(), AtEdge = Symbol);
+julia> test_graph = meta_graph(Graph(), AtEdge = Symbol);
 
-julia> push!(test, nothing); push!(test, nothing); push!(test, nothing);
+julia> push!(test_graph, nothing); push!(test_graph, nothing); push!(test_graph, nothing);
 
-julia> test[Edge(1, 2)] = :a; test[Edge(2, 3)] = :b;
+julia> test_graph[Edge(1, 2)] = :a; test_graph[Edge(2, 3)] = :b;
 
-julia> filter_edges(test, isequal(:a))
+julia> filter_edges(test_graph, isequal(:a))
 1-element Array{LightGraphs.SimpleGraphs.SimpleEdge{Int64},1}:
  Edge 1 => 2
 ```
@@ -240,11 +240,11 @@ julia> using MetaGraphs
 
 julia> using LightGraphs: Graph
 
-julia> test = meta_graph(Graph(), AtVertex = Symbol);
+julia> test_graph = meta_graph(Graph(), AtVertex = Symbol);
 
-julia> push!(test, :a); push!(test, :b);
+julia> push!(test_graph, :a); push!(test_graph, :b);
 
-julia> filter_vertices(test, isequal(:a))
+julia> filter_vertices(test_graph, isequal(:a))
 1-element Array{Int64,1}:
  1
 ```

src/metagraph.jl

@@ -37,20 +37,20 @@ metadata with multiple vertices.
 julia> push!(colors, :red)
 1
 
-julia> push!(colors, :blue)
+julia> push!(colors, :yellow)
 2
 
-julia> push!(colors, :yellow)
+julia> push!(colors, :blew)
 3
 ```
 
 You can access and change the metadata at a vertex using indexing:
 
 ```jldoctest example
-julia> colors[1] = :scarlet;
+julia> colors[3] = :blue;
 
-julia> colors[1]
-:scarlet
+julia> colors[3]
+:blue
 ```
 
 You can access and change the metadata at an edge using indexing:
@@ -78,7 +78,7 @@ julia> delete!(colors, 3)
 julia> delete!(colors, 1)
 2 => 1
 
-julia> filter_vertices(colors, isequal(:blue))
+julia> filter_vertices(colors, isequal(:yellow))
 1-element Array{Int64,1}:
  1
 ```

src/persistence.jl

@@ -10,15 +10,11 @@ julia> using MetaGraphs
 
 julia> using LightGraphs: Edge, Graph,  loadgraph, savegraph
 
-julia> colors = meta_graph(Graph(), AtVertex = Symbol, AtEdge = Symbol);
-
-julia> red = push!(colors, :red); blue = push!(colors, :blue); yellow = push!(colors, :yellow);
-
-julia> colors[Edge(red, blue)] = :purple; colors[Edge(blue, yellow)] = :green; colors[Edge(yellow, red)] = :orange;
+julia> test_graph = meta_graph(Graph());
 
 julia> mktemp() do file, io
-            savegraph(file, colors)
-            loadgraph(file, "something", MGFormat()) == colors
+            savegraph(file, test_graph)
+            loadgraph(file, "something", MGFormat()) == test_graph
         end
 true
 ```
@@ -35,43 +31,27 @@ can save `AbstractMetaGraph`s in `DOTFormat`.
 ```jldoctest DotFormat
 julia> using MetaGraphs
 
-julia> using LightGraphs: Edge, DiGraph, Graph, savegraph, loadgraph
-
-julia> test1 = meta_graph(DiGraph(), AtVertex = Dict{Symbol, String}, AtEdge = Dict{Symbol, String});
-
-julia> a = push!(test1, Dict(:name => "a")); b = push!(test1, Dict(:name => "b"));
-
-julia> test1[Edge(a, b)] = Dict(:name => "ab");
-
-julia> mktemp() do file, io
-            savegraph(file, test1, DOTFormat())
-            print(read(file, String))
-        end
-digraph {
-    1 [name = \"a\"]
-    2 [name = \"b\"]
-    1 -> 2 [name = \"ab\"]
-}
+julia> using LightGraphs
 
-julia> test2 = meta_graph(Graph(), AtEdge = Dict{Symbol, Any},
-            graph_meta = (sugar = true, spice = true, everything_nice = true)
+julia> test_graph = meta_graph(DiGraph(),
+            AtVertex = Dict{Symbol, String},
+            AtEdge = Dict{Symbol, String},
+            graph_meta = (tagged = true,)
         );
 
-julia> a = push!(test2, nothing); b = push!(test2, nothing);
+julia> a = push!(test_graph, Dict(:name => "a")); b = push!(test_graph, Dict(:name => "b"));
 
-julia> test2[Edge(a, b)] = Dict(:name => "ab", :in_order => true);
+julia> test_graph[Edge(a, b)] = Dict(:name => "ab");
 
 julia> mktemp() do file, io
-            savegraph(file, test2, DOTFormat(), )
+            savegraph(file, test_graph, DOTFormat())
             print(read(file, String))
         end
-graph {
-    sugar = true
-    spice = true
-    everything_nice = true
-    1
-    2
-    1 -- 2 [name = "ab", in_order = true]
+digraph {
+    tagged = true
+    1 [name = "a"]
+    2 [name = "b"]
+    1 -> 2 [name = "ab"]
 }
 ```
 """
@@ -87,9 +67,8 @@ function savegraph(filename::AbstractString, meta::AbstractMetaGraph)
     return 1
 end
 
-show_meta_list(io::IO, meta::Nothing) = nothing
-function show_meta_list(io::IO, meta::Union{AbstractDict, NamedTuple})
-    if !isempty(meta)
+function show_meta_list(io::IO, meta)
+    if meta !== nothing && !isempty(meta)
         print(io, " [")
         first_one = true
         for (key, value) in pairs(meta)
@@ -107,18 +86,6 @@ function show_meta_list(io::IO, meta::Union{AbstractDict, NamedTuple})
     return nothing
 end
 
-show_meta(io::IO, meta::Nothing) = nothing
-function show_meta(io::IO, meta::Union{AbstractDict, NamedTuple})
-    for (key, value) in pairs(meta)
-        print(io, "    ")
-        print(io, key)
-        print(io, " = ")
-        show(io, value)
-        print(io, '\n')
-    end
-    return nothing
-end
-
 function savedot(io::IO, meta::AbstractMetaGraph)
     dash = if is_directed(meta)
         print(io, "digraph {\n")
@@ -128,7 +95,16 @@ function savedot(io::IO, meta::AbstractMetaGraph)
         "--"
     end
 
-    show_meta(io, meta.graph_meta)
+    graph_meta = meta.graph_meta
+    if graph_meta !== nothing
+        for (key, value) in pairs(graph_meta)
+            print(io, "    ")
+            print(io, key)
+            print(io, " = ")
+            show(io, value)
+            print(io, '\n')
+        end
+    end
 
     for vertex in vertices(meta)
         print(io, "    ")

test/runtests.jl

@@ -6,69 +6,66 @@ import Test: @testset, @test
 
 doctest(MetaGraphs)
 
-test = meta_graph(DiGraph(), AtVertex = Symbol, AtEdge = Symbol)
-rock = push!(test, :rock)
-scissors = push!(test, :scissors)
-paper = push!(test, :paper)
+rock_paper_scissors = meta_graph(DiGraph(), AtVertex = Symbol, AtEdge = Symbol)
+rock = push!(rock_paper_scissors, :rock)
+paper = push!(rock_paper_scissors, :paper)
+scissors = push!(rock_paper_scissors, :scissors)
 
-test[Edge(rock, scissors)] = :rock_beats_scissors
-test[Edge(scissors, paper)] = :scissors_beats_paper
-test[Edge(paper, rock)] = :paper_beats_rock
+rock_paper_scissors[Edge(rock, scissors)] = :rock_beats_scissors
+rock_paper_scissors[Edge(scissors, paper)] = :scissors_beats_paper
+rock_paper_scissors[Edge(paper, rock)] = :paper_beats_rock
 
-test2 = induced_subgraph(test, [1, 2])
+rock_paper = induced_subgraph(rock_paper_scissors, [1, 2])
 
 @testset "Miscellaneous" begin
-    @test haskey(reverse(test), Edge(scissors, rock))
-    @test nv(test2) == 2
-    @test ne(test2) == 1
-    @test haskey(test2, Edge(rock, scissors))
+    @test haskey(reverse(rock_paper_scissors), Edge(scissors, rock))
+    @test nv(rock_paper) == 2
+    @test ne(rock_paper) == 1
+    @test haskey(rock_paper, Edge(paper, rock))
+    @test SimpleGraph(meta_graph(Graph())) isa SimpleGraph
 end
 
+rock_paper_scissors_copy = copy(rock_paper_scissors)
+
 @testset "Inheritance" begin
-    @test copy(test) == test
-    @test nv(zero(test)) == 0
-    @test ne(test) == 3
-    @test fadj(test, rock) == [scissors]
-    @test badj(test, rock) == [paper]
-    @test typeof(rock) == eltype(test)
-    @test edgetype(test) == Edge{Int}
-    @test vertices(test) == Base.OneTo(3)
-    @test weight_type(test) == Float64
-    @test has_edge(test, Edge(rock, scissors))
-    @test has_vertex(test, rock)
-    @test issubset(test2, test)
-    @test SimpleDiGraph(test) isa SimpleDiGraph
+    @test rock_paper_scissors_copy == rock_paper_scissors
+    @test nv(zero(rock_paper_scissors)) == 0
+    @test ne(rock_paper_scissors) == 3
+    @test fadj(rock_paper_scissors, rock) == [scissors]
+    @test badj(rock_paper_scissors, rock) == [paper]
+    @test typeof(rock) == eltype(rock_paper_scissors)
+    @test edgetype(rock_paper_scissors) == Edge{Int}
+    @test vertices(rock_paper_scissors) == Base.OneTo(3)
+    @test weight_type(rock_paper_scissors) == Float64
+    @test has_edge(rock_paper_scissors, Edge(rock, scissors))
+    @test has_vertex(rock_paper_scissors, rock)
+    @test issubset(rock_paper, rock_paper_scissors)
+    @test SimpleDiGraph(rock_paper_scissors) isa SimpleDiGraph
 end
 
-test2 = copy(test)
-
 @testset "Double check deletion" begin
-    delete!(test, rock)
-    @test ne(test) == 1
-    @test filter_edges(test, isequal(:scissors_beats_paper)) == [Edge(2, 1)]
-    delete!(test2, scissors)
-    @test ne(test2) == 1
-    @test filter_edges(test2, isequal(:paper_beats_rock)) == [Edge(2, 1)]
-    rem_edge!(test, Edge(2, 1))
-    @test ne(test) == 0
-    rem_vertex!(test, 2)
-    @test nv(test) == 1
+    delete!(rock_paper_scissors, rock)
+    @test ne(rock_paper_scissors) == 1
+    @test filter_edges(rock_paper_scissors, isequal(:scissors_beats_paper)) == [Edge(1, 2)]
+    delete!(rock_paper_scissors_copy, paper)
+    @test ne(rock_paper_scissors_copy) == 1
+    @test filter_edges(rock_paper_scissors_copy, isequal(:rock_beats_scissors)) == [Edge(1, 2)]
+    rem_edge!(rock_paper_scissors, Edge(1, 2))
+    @test ne(rock_paper_scissors) == 0
+    rem_vertex!(rock_paper_scissors, 2)
+    @test nv(rock_paper_scissors) == 1
 end
 
-test = meta_graph(DiGraph(), AtVertex = Symbol, AtEdge = Float64, weight_function = identity)
-rock = push!(test, :rock)
-scissors = push!(test, :scissors)
-paper = push!(test, :paper)
-
-test[Edge(rock, scissors)] = 1
-test[Edge(scissors, paper)] = 2
-w = weights(test)
+weighted_graph = meta_graph(DiGraph(), AtEdge = Float64, weight_function = identity)
+push!(weighted_graph, nothing)
+push!(weighted_graph, nothing)
+push!(weighted_graph, nothing)
+weighted_graph[Edge(1, 2)] = 1
+weighted_graph[Edge(2, 3)] = 2
+graph_weights = weights(weighted_graph)
 
 @testset "Weights" begin
-    @test string(w) == "metaweights"
-    @test w[rock, paper] == 1.0
-    @test size(w) == (3, 3)
+    @test string(graph_weights) == "metaweights"
+    @test graph_weights[rock, paper] == 1.0
+    @test size(graph_weights) == (3, 3)
 end
-
-test = meta_graph(Graph())
-@test SimpleGraph(test) isa SimpleGraph