Merge branch 'master' of https://github.com/GenieFramework/Stipple.jl

# Conflicts:
#	Project.toml

README.md

@@ -152,8 +152,10 @@ end
 Genie.isrunning(:webserver) || up()
 ```
 <img src="docs/content/img/Example2.png">
+
 ## Choosing the transport layer: WebSockets or HTTP
 
+
 By default Stipple will attempt to use WebSockets for real time data sync between backend and frontend.
 However, in some cases WebSockets support might not be available on the host. In this case, Stipple can be
 switched to use regular HTTP for data sync, using frontend polling with AJAX (1s polling interval by default).

src/ReactiveTools.jl

@@ -16,6 +16,9 @@ export @onchange, @onbutton, @event, @notify
 # definition of dependencies
 export @deps, @clear_deps
 
+# definition of field-specific debounce times
+export @debounce, @clear_debounce
+
 # deletion
 export @clear, @clear_vars, @clear_handlers
 
@@ -269,6 +272,142 @@ macro clear_route()
   :(Stipple.clear_route(Stipple.@type)) |> esc
 end
 
+function _prepare(fieldname)
+  if fieldname isa Symbol
+    fieldname = QuoteNode(fieldname)
+  else
+    if fieldname isa Expr && fieldname.head == :tuple
+      for (i, x) in enumerate(fieldname.args)
+        x isa Symbol && (fieldname.args[i] = QuoteNode(x))
+      end
+    end
+  end
+  fieldname
+end
+
+"""
+    @debounce fieldname ms
+
+    @debounce App fieldname ms
+
+Set field-specific debounce time in ms.
+### Parameters
+
+- `APP`: a subtype of ReactiveModel, e.g. `MyApp`
+- `fieldname`: fieldname òr fieldnames as written in the declaration, e.g. `x`, `(x, y, z)`
+- `ms`: debounce time in ms
+
+### Example
+#### Implicit apps
+```
+@app begin
+  @out quick = 12
+  @out slow = 12
+  @in s = "Hello"
+end
+
+# no debouncing for fast messaging
+@debounce quick 0
+
+# long debouncing for long-running tasks
+@debounce (slow1, slow2) 1000
+```
+#### Explicit apps
+
+```
+@app MyApp begin
+  @out quick = 12
+  @out slow = 12
+  @in s = "Hello"
+end
+
+# no debouncing for fast messaging
+@debounce MyApp quick 0
+
+# long debouncing for long-running tasks
+@debounce MyApp slow 1000
+```
+"""
+macro debounce(M, fieldname, ms)
+  fieldname = _prepare(fieldname)
+  :(Stipple.debounce($M, $fieldname, $ms)) |> esc
+end
+
+macro debounce(fieldname, ms)
+  fieldname = _prepare(fieldname)
+  :(Stipple.debounce(Stipple.@type(),$fieldname, $ms)) |> esc
+end
+
+"""
+    @clear_debounce 
+
+    @clear_debounce fieldname
+    
+    @clear_debounce App
+    
+    @clear_debounce App fieldname
+
+Clear field-specific debounce time, for setting see `@debounce`.
+After calling `@clear debounce` the field will be debounced by the value given in the
+`@init` macro.
+
+
+### Example
+#### Implicit apps
+```
+@app begin
+  @out quick = 12
+  @out slow = 12
+  @in s = "Hello"
+end
+
+# no debouncing for fast messaging
+@debounce quick 0
+@debounce slow 1000
+
+# reset to standard value of the app
+@clear_debounce quick
+
+# clear all field-specific debounce times
+@clear_debounce
+```
+#### Explicit apps
+
+```
+@app MyApp begin
+  @out quick = 12
+  @out slow = 12
+  @in s = "Hello"
+end
+
+# no debouncing for fast messaging
+@debounce MyApp quick 0
+
+@clear_debounce MyApp quick
+
+# clear all field-specific debounce times
+@clear_debounce MyApp
+```
+"""
+macro clear_debounce(M, fieldname)
+  fieldname = _prepare(fieldname)
+  :(Stipple.debounce($M, $fieldname, nothing)) |> esc
+end
+
+macro clear_debounce(expr)
+  quote
+    if $expr isa DataType && $expr <: Stipple.ReactiveModel
+      Stipple.debounce($expr, nothing)
+    else
+      Stipple.debounce(Stipple.@type(), $(_prepare(expr)), nothing)
+    end
+  end |> esc
+end
+
+macro clear_debounce()
+  :(Stipple.debounce(Stipple.@type(), nothing)) |> esc
+end
+
 function update_storage(m::Module)
   clear_type(m)
   # isempty(Stipple.Pages._pages) && return

src/Stipple.jl

@@ -124,6 +124,40 @@ const PURGE_TIME_LIMIT = Ref{Period}(Day(1))
 const PURGE_NUMBER_LIMIT = Ref(1000)
 const PURGE_CHECK_DELAY = Ref(60)
 
+const DEBOUNCE = LittleDict{Type{<:ReactiveModel}, LittleDict{Symbol, Any}}()
+
+"""
+    debounce(M::Type{<:ReactiveModel}, fieldnames::Union{Symbol, Vector{Symbol}}, debounce::Union{Int, Nothing} = nothing)
+
+Add field-specific debounce times.
+"""
+function debounce(M::Type{<:ReactiveModel}, fieldnames::Union{Symbol, Vector{Symbol}, NTuple{N, Symbol} where N}, debounce::Union{Int, Nothing} = nothing)
+  if debounce === nothing
+    haskey(DEBOUNCE, M) || return
+    d = DEBOUNCE[M]
+    if fieldnames isa Symbol
+      delete!(d, fieldnames)
+    else
+      for v in fieldnames
+        delete!(d, v)
+      end
+    end
+    isempty(d) && delete!(DEBOUNCE, M)
+  else
+    d = get!(LittleDict{Symbol, Any}, DEBOUNCE, M)
+    if fieldnames isa Symbol
+      d[fieldnames] = debounce
+    else
+      for v in fieldnames
+        d[v] = debounce
+      end
+    end
+  end
+  return
+end
+
+debounce(M::Type{<:ReactiveModel}, ::Nothing) = delete!(DEBOUNCE, M)
+
 """
 `function sorted_channels()`
 
@@ -311,20 +345,29 @@ function watch(vue_app_name::String, fieldname::Symbol, channel::String, debounc
   isempty(jsfunction) &&
     (jsfunction = "Genie.WebChannels.sendMessageTo($js_channel, 'watchers', {'payload': {'field':'$fieldname', 'newval': newVal, 'oldval': oldVal, 'sesstoken': document.querySelector(\"meta[name='sesstoken']\")?.getAttribute('content')}});")
 
+  output = IOBuffer()
   if fieldname == :isready
-    output = """
+    print(output, """
       $vue_app_name.\$watch(function(){return this.$fieldname}, function(newVal, oldVal){$jsfunction}, {deep: true});
-    """
+    """)
   else
-    output = """
-      $vue_app_name.\$watch(function(){return this.$fieldname}, _.debounce(function(newVal, oldVal){$jsfunction}, $debounce), {deep: true});
-    """
+    AM = get_abstract_type(M)
+    debounce = get(get(DEBOUNCE, AM, Dict{Symbol, Any}()), fieldname, debounce)
+    print(output, debounce == 0 ?
+      """
+        $vue_app_name.\$watch(function(){return this.$fieldname}, function(newVal, oldVal){$jsfunction}, {deep: true});
+      """ : 
+      """
+        $vue_app_name.\$watch(function(){return this.$fieldname}, _.debounce(function(newVal, oldVal){$jsfunction}, $debounce), {deep: true});
+      """
+    )
   end
   # in production mode vue does not fill `this.expression` in the watcher, so we do it manually
   Genie.Configuration.isprod() &&
-    (output *= "$vue_app_name._watchers[$vue_app_name._watchers.length - 1].expression = 'function(){return this.$fieldname}'")
+    print(output, "$vue_app_name._watchers[$vue_app_name._watchers.length - 1].expression = 'function(){return this.$fieldname}'")
 
-  output *= "\n\n"
+  print(output, "\n\n")
+  String(take!(output))
 end
 
 #===#

src/stipple/print.jl

@@ -1,15 +1,5 @@
-function print_object(io, obj::T, omit = nothing, compact = false) where T
-    # currently no different printing for compact = true ...
-    fields = [p for p in propertynames(obj)]
-    omit !== nothing && setdiff!(fields, omit)
-
-    println(io, match(r"^#*([^!]+)", String(T.name.name)).captures[1])
-    for field in fields
-        println(io, "    $field: ", Observables.to_value(getproperty(obj, field)))
-    end
-end
-
 function print_object(io, obj::T, omit = nothing, compact = false) where T <: ReactiveModel
+    # currently no different printing for compact = true ...
     fields = [p for p in propertynames(obj)]
     omit !== nothing && setdiff!(fields, omit)
     internal_or_auto = true

test/runtests.jl

@@ -118,6 +118,13 @@ end
     # check reactivity
     @eval model.i[] = 20
     @test model.s[] == "20"
+
+    @eval @debounce TestApp i 101
+    @eval @debounce TestApp (a, b, c) 101
+    @test Stipple.DEBOUNCE[TestApp][:i] == 101
+
+    @eval @clear_debounce TestApp
+    @test haskey(Stipple.DEBOUNCE, TestApp) == false
 end
 
 @testset "Reactive API (implicit)" begin
@@ -142,6 +149,14 @@ end
     # check reactivity
     @eval model.i2[] = 20
     @test model.s2[] == "20"
+
+    # check field-specific debouncing
+    @eval @debounce i3 101
+    @eval @debounce (a, b, c) 101
+    @test Stipple.DEBOUNCE[Stipple.@type()][:i3] == 101
+
+    @eval @clear_debounce
+    @test haskey(Stipple.DEBOUNCE, Stipple.@type()) == false
 end
 
 @testset "Reactive API (implicit) with mixins and handlers" begin