remove all the Observable conversion clutter (#315)

SimonDanisch · asinghvi17 · web-flow · commit ac259a7e8ab8 · 2020-02-25T12:54:56.000+01:00
* remove all the node conversion bullshit * test against observables#master * fixes * get READY * import from Observables that which is observable (#328) * move imports Co-authored-by: Anshul Singhvi <asinghvi17@simons-rock.edu>
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -17,7 +17,7 @@ test:
       - mkdir $JULIA_DEPOT_PATH # Pkg.jl#325
       - julia -e 'using InteractiveUtils; versioninfo()'
       - mkdir temporary_for_project
-      - julia --project=temporary_for_project -e 'using Pkg; Pkg.pkg"dev --local .; add StatsMakie#master MakieGallery#master GLMakie#master FFMPEG@0.3; test AbstractPlotting"'
+      - julia --project=temporary_for_project -e 'using Pkg; Pkg.pkg"dev --local .; add Observables#master StatsMakie#master MakieGallery#master GLMakie#master; test AbstractPlotting"'
 
     artifacts:
         when: on_failure
diff --git a/Project.toml b/Project.toml
@@ -50,7 +50,7 @@ FreeTypeAbstraction = "0.6"
 GeometryTypes = "0.7.2"
 ImageMagick = "0.7, 1.0"
 IntervalSets = "0.3, 0.4"
-Observables = "0.2.0"
+Observables = "0.3.0"
 Packing = "0.3"
 PlotUtils = "0.6.2"
 Showoff = "0.3"
diff --git a/src/AbstractPlotting.jl b/src/AbstractPlotting.jl
@@ -14,9 +14,14 @@ import ImageMagick, FileIO, SparseArrays
 import FileIO: save
 using Printf: @sprintf
 
+# Imports from Base which we don't want to have to qualify
 using Base: RefValue
 using Base.Iterators: repeated, drop
 import Base: getindex, setindex!, push!, append!, parent, get, get!, delete!, haskey
+using Observables: listeners, notify!, to_value
+
+# Imports from Observables which we use a lot
+using Observables: notify!, listeners
 
 module ContoursHygiene
     import Contour
@@ -94,7 +99,7 @@ export xtickrotation, ytickrotation, ztickrotation
 export xtickrotation!, ytickrotation!, ztickrotation!
 
 # Node/Signal related
-export Node, node, lift, map_once, to_value, on, @lift
+export Node, lift, map_once, to_value, on, @lift
 
 # utilities and macros
 export @recipe, @extract, @extractvalue, @key_str, @get_attribute
diff --git a/src/basic_recipes/axis.jl b/src/basic_recipes/axis.jl
@@ -556,32 +556,24 @@ function plot!(scene::SceneLike, ::Type{<: Axis2D}, attributes::Attributes, args
 
     textbuffer = TextBuffer(cplot, Point{2})
 
-    grid_linebuffer = to_node((
-        LinesegmentBuffer(
-            cplot, Point{2}, transparency = true,
-            linestyle = lift(first, cplot[:grid, :linestyle])
-        ),
-        LinesegmentBuffer(
-            cplot, Point{2}, transparency = true,
-            linestyle = lift(last, cplot[:grid, :linestyle])
-        )
+    grid_linebuffer = Node((
+        LinesegmentBuffer(cplot, Point{2}, transparency=true,
+                          linestyle=lift(first, cplot[:grid, :linestyle])),
+        LinesegmentBuffer(cplot, Point{2}; transparency=true,
+                          linestyle=lift(last, cplot[:grid, :linestyle]))
     ))
-    frame_linebuffer = to_node(LinesegmentBuffer(
-        cplot, Point{2}, transparency = true, linestyle = cplot.frame.linestyle
-    ))
-    tickmarks_linebuffer = to_node((
-                    LinesegmentBuffer(
-                              cplot, Point{2}, transparency = true,
-                              linestyle=lift(first, cplot[:tickmarks, :linestyle])
-                              ),
-                    LinesegmentBuffer(
-                              cplot, Point{2}, transparency = true,
-                              linestyle = lift(last, cplot[:tickmarks, :linestyle])
-                              )
+
+    frame_linebuffer = Node(LinesegmentBuffer(cplot, Point{2}; transparency=true,
+                                                    linestyle=cplot.frame.linestyle))
+    tickmarks_linebuffer = Node((
+        LinesegmentBuffer(cplot, Point{2}; transparency=true,
+                          linestyle=lift(first, cplot[:tickmarks, :linestyle])),
+        LinesegmentBuffer(cplot, Point{2}; transparency=true,
+                          linestyle=lift(last, cplot[:tickmarks, :linestyle]))
     ))
     map_once(
         draw_axis2d,
-        to_node(textbuffer),
+        Node(textbuffer),
         frame_linebuffer, grid_linebuffer,tickmarks_linebuffer,
         transformationmatrix(scene),
         cplot.padding, cplot[1], cplot.ticks.ranges_labels,
diff --git a/src/basic_recipes/basic_recipes.jl b/src/basic_recipes/basic_recipes.jl
@@ -78,7 +78,7 @@ function plot!(plot::Poly{<: Tuple{<: AbstractVector{P}}}) where P <: AbstractVe
             push!(line, poly[1])
             push!(line, Point2f0(NaN))
         end
-        line
+        return line
     end
     lines!(
         plot, outline, visible = plot.visible,
@@ -852,7 +852,7 @@ function plot!(vs::VolumeSlices)
     hattributes = vs[:heatmap]
     sliders = map(zip(planes, (x, y, z))) do plane_r
         plane, r = plane_r
-        idx = node(plane, Node(1))
+        idx = Node(1)
         vs[plane] = idx
         hmap = heatmap!(vs, hattributes, x, y, zeros(length(x[]), length(y[]))).plots[end]
         on(idx) do i
diff --git a/src/basic_recipes/multiple.jl b/src/basic_recipes/multiple.jl
@@ -45,8 +45,8 @@ combine(val1, val2; palette = nothing) = val2
 function combine!(theme1::Theme, theme2::Theme)
     palette = get(theme1, :palette, current_default_theme()[:palette])
     for (key, val) in theme2
-        tv = get(theme1, key, nothing) |> to_node
-        pv = get(palette, key, nothing) |> to_node
+        tv = convert(Node, get(theme1, key, nothing))
+        pv = convert(Node, get(palette, key, nothing))
         theme1[key] = lift((t, p, v) -> combine(t, v, palette = p), tv, pv, val)
     end
     theme1
diff --git a/src/basic_recipes/title.jl b/src/basic_recipes/title.jl
@@ -9,9 +9,9 @@ Add a title with content `string` to `scene`.  Pass a `Function` to the `formatt
 if the value passed to `string` isn't actually a String.
 """
 function title(scene, tstring; align = (:center, :bottom), textsize = 30, parent = Scene(), formatter = string, kw...)
-    
-    string = to_node(tstring)
-    
+
+    string = convert(Node, tstring)
+
     pos = lift(pixelarea(scene)) do area
         x = widths(area)[1] ./ 2
         Vec2f0(x, 10) # offset 10px, to give it some space
@@ -24,7 +24,7 @@ function title(scene, tstring; align = (:center, :bottom), textsize = 30, parent
         textsize = textsize;
         kw...
     )
-    hbox(scene, t; parent = parent)
+    return hbox(scene, t; parent = parent)
 end
 
 function title(string; kw...)
diff --git a/src/camera/camera.jl b/src/camera/camera.jl
@@ -50,7 +50,7 @@ function Observables.on(f, c::Camera, nodes::Node...)
         on(cl, n)
     end
     push!(c.steering_nodes, nodes...)
-    node
+    return f
 end
 
 function Camera(px_area)
diff --git a/src/camera/camera2d.jl b/src/camera/camera2d.jl
@@ -16,7 +16,7 @@ Creates a 2D camera for the given Scene.
 function cam2d!(scene::SceneLike; kw_args...)
     cam_attributes = merged_get!(:cam2d, scene, Attributes(kw_args)) do
         Theme(
-            area = node(:area, FRect(0, 0, 1, 1)),
+            area = Node(FRect(0, 0, 1, 1)),
             zoomspeed = 0.10f0,
             zoombutton = nothing,
             panbutton = Mouse.right,
diff --git a/src/interaction/gui.jl b/src/interaction/gui.jl
@@ -99,7 +99,7 @@ function plot!(slider::Slider)
     val = slider[:value]
     p2f0 = lift(Point2f0, position)
     startval = start[] === automatic ? first(range[]) : start[]
-    push!(val, startval)
+    val[] = startval
     label = lift((v, f)-> f(v), val, valueprinter)
     lplot = text!(
         slider, label,
@@ -128,7 +128,7 @@ function plot!(slider::Slider)
     ).plots[end]
     dragslider(slider, button)
     move!(slider, find_closest(range[], startval))
-    slider
+    return slider
 end
 
 function dragslider(slider, button)
diff --git a/src/interaction/nodes.jl b/src/interaction/nodes.jl
@@ -1,4 +1,3 @@
-
 # I don't want to use map anymore, it's so ambigious, especially to newcomers.
 # TODO should this become it's own function?
 function lift(
@@ -11,23 +10,11 @@ function lift(
 end
 
 # TODO remove this and play by Observables rules
-Base.push!(x::Node, value) = (x[] = value)
-Base.copy(x::Node{T}) where T = lift(identity, x, typ = T)
-to_value(x::Node) = x[]
-to_value(x) = x
-
-to_node(::Type{T1}, x::Node{T2}, name = :node) where {T1, T2} = signal_convert(Node{T1}, x, name)
-to_node(x::T, name = :node) where T = to_node(T, x)
-to_node(::Type{T}, x, name = :node) where T = to_node(T, Node{T}(x))
-to_node(x::Node) = x
-
-signal_convert(::Type{Node{T1}}, x::Node{T1}, name = :node) where T1 = x
-signal_convert(::Type{Node{T1}}, x::Node{T2}, name = :node) where {T1, T2} = lift(convert, Node(T1), x, typ = T1)
-signal_convert(::Type{Node{T1}}, x::T2, name = :node) where {T1, T2} = Node{T1}(convert(T1, x))
-signal_convert(t, x, name = :node) = x
+function Base.push!(x::Node, value)
+    @warn "`push!(x::Union{Node, Observable}, value)`` is deprecated. Use: `x[] = value` instead"
+    x[] = value
+end
 
-node(name, node) = Node(node)
-node(name, node::Node) = lift(identity, node)
 Base.close(node::Node) = empty!(node.listeners)
 function close_all_nodes(any::T) where T
     for field in fieldnames(T)
@@ -36,12 +23,10 @@ function close_all_nodes(any::T) where T
     end
 end
 
-
 function disconnect!(s::Node)
     # empty!(Observables.listeners(s))
     return
 end
-using Observables: listeners
 
 """
 Observables.off but without throwing an error
@@ -85,116 +70,3 @@ function map_once(
     end
     lift(f, input, inputrest..., init = init, typ = typ)
 end
-
-"""
-Pushes an updates to all listeners of `node`
-"""
-function notify!(node::Node)
-    node[] = node[]
-end
-#
-# call_count = Ref(1)
-# io = IOBuffer()
-# noyield_println(x...) = println(io, x...)
-# function example1(s1)
-#     # only works with closure, which will have it's unique,
-#     # which stays consistent per call
-#     cc = call_count[]
-#     s2 = map_once(v-> noyield_println("func 1 call $cc :", v), s1)
-#     push!(s1, 22)
-#     # this is a unique closure, so it won't disconnect s2
-#     s3 = map_once(v-> noyield_println("func 2 call $cc :", v), s1)
-#     push!(s1, 33)
-#     call_count[] = call_count[] + 1
-#     s2, s3
-# end
-# s1 = Node(1)
-# call_count[] = 1
-# s2 = example1(s1)
-# yield() # give a chance to run event loop
-# println(String(take!(io)))
-# func 1 call 1 :1
-# func 2 call 1 :1
-# func 1 call 1 :22
-# func 2 call 1 :22
-# func 1 call 1 :33
-# func 2 call 1 :33
-# s2 = example1(s1)
-# func 1 call 2 :33 # first call to maponce
-# func 2 call 2 :33 # first call to maponce
-# func 2 call 1 :22 # first call to push!, func 2 from call 1 is still registered
-# func 1 call 2 :22 # first call to push!, call 2
-# func 1 call 2 :33 # second call to push!, call 1 is gone now!
-# func 2 call 2 :33
-#
-# function no_closure(v)
-#     println("func 1 ", v)
-# end
-# function example2(s1)
-#     # println is a function which will stay the same
-#     s2 = map_once(no_closure, s1)
-#     push!(s1, 22)
-#     # so it will globally replace any map_once(println, call, s1)
-#     # (need to be those exact signals)
-#     s3 = map_once(no_closure, s1)
-#     push!(s1, 33)
-#     s2
-# end
-#
-# s1 = Node(1)
-# s2 = example2(s1)
-#
-# function example3(s1, call)
-#     # normal behaviour doesn't disconnect (with map instead of foreach it will disconnect )
-#     # whenever gc thinks it should
-#     s2 = foreach(println, call, s1)
-#     push!(s1, 22)
-#     s2
-# end
-# s1 = Node(1)
-# c = Node("call 1 value: ")
-# s2 = example1(c, s1)
-# call 1 value: 1 # from init 1
-# call 1 value: 1 # from init 2
-# call 1 value: 22 # from first push
-# call 1 value: 33 # from second push call 1
-# call 1 value: 33 # from second push call 2
-#
-# s3 = example1(c, s1)
-#     call 1 value: 22
-#     call 1 value: 22
-#     call 1 value: 22
-#     call 1 value: 22
-#     call 1 value: 22
-#     call 1 value: 22
-#
-# s1 = Node(1)
-# c  = Node("call 1, value ")
-# s2 = example2(s1, c)
-# >call 1, value 1
-# >call 1, value 22
-# s3 = example2(s1, 2)
-# >call 2, value 22
-# >call 1, value 22 # old signal still firing
-# >call 2, value 22
-# # same as above
-# s1 = Node(1)
-# c = Node("call 1, value ")
-# s2 = example3(s1, c)
-# s3 = example3(s1, c)
-# >call 2, value 22
-# >call 1, value 22 # old signal still firing
-# >call 2, value 22
-# get_children(c)[1] == s2
-# get_children(s1)[1] == s2
-# s2.parents  == (c, s1)
-# c.id
-# s1.id
-# s2.parents[2].id
-#
-# s1 = Node(1)
-# s2 = Node("sada")
-# s1.id
-# s2.id
-# s3 = map(string, s1, s2)
-# s3.parents == (s1, s2)
diff --git a/src/interfaces.jl b/src/interfaces.jl
@@ -405,7 +405,7 @@ function seperate_tuple(args::Node{<: NTuple{N, Any}}) where N
 end
 
 function (PlotType::Type{<: AbstractPlot{Typ}})(scene::SceneLike, attributes::Attributes, args) where Typ
-    input = to_node.(args)
+    input = convert.(Node, args)
     argnodes = lift(input...) do args...
         convert_arguments(PlotType, args...)
     end
@@ -546,7 +546,7 @@ function plot!(scene::SceneLike, P::PlotFunc, attributes::Attributes, args...; k
 
     FinalType, argsconverted = apply_convert!(PreType, attributes, converted)
     converted_node = Node(argsconverted)
-    input_nodes =  to_node.(args)
+    input_nodes =  convert.(Node, args)
     onany(kw_signal, lift(tuple, input_nodes...)) do kwargs, args
         # do the argument conversion inside a lift
         result = convert_arguments(FinalType, args...; kwargs...)
diff --git a/src/layouting/transformation.jl b/src/layouting/transformation.jl
diff --git a/src/scenes.jl b/src/scenes.jl
diff --git a/src/types.jl b/src/types.jl
diff --git a/src/utilities/utilities.jl b/src/utilities/utilities.jl
