Merge pull request #138 from JuliaRobotics/feature/137_remove_metasymbolexports

Removing MetaGraphsDFG and SymbolDFG exports, adding test

Author: GearsAD

src/DFGPlots/DFGPlots.jl

@@ -32,7 +32,7 @@ DFGPlotProps() = DFGPlotProps(  (var=colorant"seagreen", fac=colorant"cyan3"),
 
 """
     $(SIGNATURES)
-Plots the structure of the factor graph. GraphPlot must be imported before DistributedFactoGraphs for these functions to be available.
+Plots the structure of the factor graph. GraphPlot must be imported before DistributedFactorGraphs for these functions to be available.
 Returns the plot context.
 
 E.g.
@@ -86,8 +86,8 @@ draw(PDF("/tmp/graph.pdf", 16cm, 16cm), dfgplot(fg))
 
 More information at [GraphPlot.jl](https://github.com/JuliaGraphs/GraphPlot.jl)
 """
-function dfgplot(dfg::MetaGraphsDFG, p::DFGPlotProps = DFGPlotProps())
-
+function dfgplot(dfg::DistributedFactorGraphs.MetaGraphsDFG, p::DFGPlotProps = DFGPlotProps())
+    @info "Deprecated, please use GraphsDFG or LightDFG."
     nodesize = [has_prop(dfg.g,i,:factor) ?  p.nodesize.fac : p.nodesize.var for i=vertices(dfg.g)]
     if p.drawlabels
         nodelabel = [has_prop(dfg.g,i,:factor) ? "" : string(get_prop(dfg.g,i,:label)) for i=vertices(dfg.g)]
@@ -122,13 +122,14 @@ More information at [GraphPlot.jl](https://github.com/JuliaGraphs/GraphPlot.jl)
 function dfgplot(dfg::AbstractDFG, p::DFGPlotProps = DFGPlotProps())
     # TODO implement convert functions
     @warn "TODO Implement convert"
-    ldfg = MetaGraphsDFG{AbstractParams}()
+    ldfg = LightDFG{AbstractParams}()
     DistributedFactorGraphs._copyIntoGraph!(dfg, ldfg, union(getVariableIds(dfg), getFactorIds(dfg)), true)
 
     dfgplot(ldfg, p)
 end
 
-function gplot(dfg::MetaGraphsDFG; keyargs...)
+function gplot(dfg::DistributedFactorGraphs.MetaGraphsDFG; keyargs...)
+    @info "Deprecated, please use GraphsDFG or LightDFG."
     gplot(dfg.g; keyargs...)
 end
 

src/DistributedFactorGraphs.jl

@@ -61,7 +61,7 @@ include("FileDFG/FileDFG.jl")
 include("MetaGraphsDFG/MetaGraphsDFG.jl")
 
 include("SymbolDFG/SymbolDFG.jl")
-@reexport using .SymbolDFGs
+# @reexport using .SymbolDFGs
 
 include("LightDFG/LightDFG.jl")
 @reexport using .LightDFGs

src/LightDFG/services/LightDFG.jl

@@ -240,7 +240,7 @@ end
 Checks if the graph is fully connected, returns true if so.
 """
 function isFullyConnected(dfg::LightDFG)::Bool
-    return length(connected_components(dfg.g)) == 1
+    return length(LightGraphs.connected_components(dfg.g)) == 1
 end
 
 function _isready(dfg::LightDFG, label::Symbol, ready::Int)::Bool

src/MetaGraphsDFG/MetaGraphsDFG.jl

@@ -6,7 +6,8 @@ include("entities/MetaGraphsDFG.jl")
 include("services/MetaGraphsDFG.jl")
 
 # Exports
-export MetaGraphsDFG
+# Deprecated - 
+# export MetaGraphsDFG
 export exists
 export getLabelDict, getDescription, setDescription, getInnerGraph, getAddHistory, getSolverParams, setSolverParams
 #

src/SymbolDFG/SymbolDFG.jl

@@ -1,4 +1,4 @@
-module SymbolDFGs
+# module SymbolDFGs
 
 using LightGraphs
 using SparseArrays
@@ -45,7 +45,7 @@ include("entities/SymbolDFG.jl")
 include("services/SymbolDFG.jl")
 
 # Exports
-export SymbolDFG
+# export SymbolDFG
 
 
-end
+# end

src/SymbolDFG/services/SymbolDFG.jl

@@ -264,7 +264,7 @@ end
 Checks if the graph is fully connected, returns true if so.
 """
 function isFullyConnected(dfg::SymbolDFG)::Bool
-    return length(connected_components(dfg.g)) == 1
+    return length(LightGraphs.connected_components(dfg.g)) == 1
 end
 
 #Alias

test/runtests.jl

@@ -3,7 +3,12 @@ using GraphPlot # For plotting tests
 using DistributedFactorGraphs
 
 # Test each interface
-apis = [GraphsDFG, MetaGraphsDFG, SymbolDFG, LightDFG]
+# Still test LightDFG and MetaGraphsDFG for the moment until we remove in 0.4.2
+apis = [
+    GraphsDFG,
+    DistributedFactorGraphs.MetaGraphsDFG,
+    DistributedFactorGraphs.SymbolDFG,
+    LightDFG]
 for api in apis
     @testset "Testing Driver: $(api)" begin
         @info "Testing Driver: $(api)"
@@ -12,6 +17,12 @@ for api in apis
     end
 end
 
+# Test that we don't export LightDFG and MetaGraphsDFG
+@testset "Deprecated Drivers Test" begin
+    @test_throws UndefVarError SymbolDFG{NoSolverParams}()
+    @test_throws UndefVarError MetaGraphsDFG{NoSolverParams}()
+end
+
 # Test special cases
 
 @testset "Plotting Tests" begin