clean up

Author: rafaqz

src/optics.jl

@@ -249,8 +249,36 @@ function modify(f, obj, w::If)
     end
 end
 
+abstract type ObjectMap end
+
+OpticStyle(::Type{<:ObjectMap}) = ModifyBased()
+modify(f, o, optic::ObjectMap) = mapobject(f, o, optic, Construct, nothing)
+
+"""
+    Properties()
+
+Access all properties of an objects.
+
+```jldoctest
+julia> using Accessors
+
+julia> obj = (a=1, b=2, c=3)
+(a = 1, b = 2, c = 3)
+
+julia> set(obj, Properties(), "hi")
+(a = "hi", b = "hi", c = "hi")
+
+julia> modify(x -> 2x, obj, Properties())
+(a = 2, b = 4, c = 6)
+```
+Based on [`mapobject`](@ref).
+
+$EXPERIMENTAL
+"""
+struct Properties <: ObjectMap end
+
 """
-    mapproperties(f, obj)
+    mapobject(f, obj)
 
 Construct a copy of `obj`, with each property replaced by
 the result of applying `f` to it.
@@ -260,82 +288,63 @@ julia> using Accessors
 
 julia> obj = (a=1, b=2);
 
-julia> Accessors.mapproperties(x -> x+1, obj)
+julia> Accessors.mapobject(x -> x+1, obj)
 (a = 2, b = 3)
 ```
 $EXPERIMENTAL
 """
-function mapproperties(f, obj::O, handler=Construct(), itr::Nothing=nothing) where O
+function mapobject(f, obj::O, ::Properties, handler, itr::Nothing) where O
     # TODO move this helper elsewhere?
     pnames = propertynames(obj)
     if isempty(pnames)
         return obj
     else
-        ctor = constructorof(typeof(obj))
         new_props = map(pnames) do p
             f(getproperty(obj, p))
         end
         ctr = _constructor(handler, O)
         return ctr(new_props...)
     end
 end
-function mapproperties(f, obj::O, handler, itr::Int) where O
+function mapobject(f, obj::O, ::Properties, handler, itr::Int) where O
     pnames = propertynames(obj)
     if isempty(pnames)
-        return _maybeitr(obj, itr)
+        return obj, itr
     else
         # TODO: this is too slow
         new_props, itr = reduce(pnames; init=((), itr)) do (vals, itr), p
             val, itr = f(getproperty(obj, p), itr)
             (vals..., val), itr
         end
         ctr = _constructor(handler, O)
-        return _maybeitr(ctr(new_props...), itr)
+        return ctr(new_props...), itr
     end
 end
 
 """
-    Properties()
+    Fields()
 
-Access all properties of an objects.
+Access all fields of an objects.
 
 ```jldoctest
 julia> using Accessors
 
 julia> obj = (a=1, b=2, c=3)
 (a = 1, b = 2, c = 3)
 
-julia> set(obj, Properties(), "hi")
+julia> set(obj, Fields(), "hi")
 (a = "hi", b = "hi", c = "hi")
 
-julia> modify(x -> 2x, obj, Properties())
+julia> modify(x -> 2x, obj, Fields())
 (a = 2, b = 4, c = 6)
 ```
-Based on [`mapproperties`](@ref).
+Based on [`mapfields`](@ref).
 
 $EXPERIMENTAL
 """
-struct Properties end
-OpticStyle(::Type{<:Properties}) = ModifyBased()
-modify(f, o, ::Properties) = mapproperties(f, o)
-
-"""
-    mapfields(f, obj)
-
-Construct a copy of `obj`, with each fields replaced by
-the result of applying `f` to it.
-
-```jldoctest
-julia> using Accessors
-
-julia> obj = (a=1, b=2);
+struct Fields <: ObjectMap end
 
-julia> Accessors.mapfields(x -> x+1, obj)
-(a = 2, b = 3)
-```
-$EXPERIMENTAL
-"""
-@generated function mapfields(f, obj::O, handler::H=Construct(), itr::I=nothing) where {O,H,I}
+@generated function mapobject(f, obj::O, ::Fields, handler::H=Construct(), itr::I=nothing) where {O,H,I}
     # TODO: This is how Flatten.jl works, but it's not really 
     # correct use of ConstructionBase as it assumers properties=fields
     fnames = fieldnames(O)
@@ -385,31 +394,6 @@ end
 _maybeitr(x, ::Nothing) = x
 _maybeitr(x, itr) = x, itr
 
-"""
-    Fields()
-
-Access all fields of an objects.
-
-```jldoctest
-julia> using Accessors
-
-julia> obj = (a=1, b=2, c=3)
-(a = 1, b = 2, c = 3)
-
-julia> set(obj, Fields(), "hi")
-(a = "hi", b = "hi", c = "hi")
-
-julia> modify(x -> 2x, obj, Fields())
-(a = 2, b = 4, c = 6)
-```
-Based on [`mapfields`](@ref).
-
-$EXPERIMENTAL
-"""
-struct Fields end
-OpticStyle(::Type{<:Fields}) = ModifyBased()
-modify(f, o, ::Fields) = mapfields(f, o)
-
 """
     Recursive(descent_condition, optic)
 
@@ -484,11 +468,10 @@ Base.@propagate_inbounds function set(obj, lens::DynamicIndexLens, val)
 end
 
 """
-    Query(select, ignore)
+    Query(select, descend)
 
-Query an object recursively, choosing fields based on the single-argument
-function `select` and ignoring objects based on another single-argument 
-function `ignore`.
+Query an object recursively, choosing fields when `select` 
+returns `true`, and descending when `descend`.
 
 ```jldoctest
 julia> using Accessors
@@ -515,43 +498,37 @@ end
 Query(select, descend = x -> true) = Query(select, descend, Fields())
 Query(; select=Any, descend=x -> true, optic=Fields()) = Query(select, descend, optic)
 
-_inner(optic::ComposedOptic) = optic.inner
-_inner(optic::Fields) = optic
-_inner(optic::Properties) = optic
-
 function (q::Query)(obj)
-    _query(obj, _inner(q.optic), Splat(), nothing) do o
+    mapobject(obj, _inner(q.optic), Splat(), nothing) do o
         if q.select_condition(o)
             (_getouter(o, q.optic),)
         elseif q.descent_condition(o)
-            q(o)
+            q(o) # also a tuple
         else
             ()
         end
     end
 end
 
-_getouter(o, optic::ComposedOptic) = optic.outer(o)
-_getouter(o, optic) = o
-
-_set(obj, q::Query, val, ::SetBased) = _setquery(obj, q::Query, (val, 1))[1]
+set(obj, q::Query, vals) = _set(obj, q::Query, (vals, 1))[1]
 
-function _setquery(obj, q::Query, (val, itr))
-    _query(obj, _inner(q.optic), Construct(), itr) do o, itr
+function _set(obj, q::Query, (vals, itr))
+    mapobject(obj, _inner(q.optic), Construct(), itr) do o, itr
         if q.select_condition(o)
-            _setouter(o, q.optic, val[itr]), itr + 1
+            _setouter(o, q.optic, vals[itr]), itr + 1
         elseif q.descent_condition(o)
-            _setquery(o, q, (val, itr))
+            _set(o, q, (vals, itr))
         else
             o, itr
         end
     end
 end
 
-_setouter(o, optic::ComposedOptic, v) = set(o, optic.outer, v)
-_setouter(o, optic, v) = v
-
 modify(f, obj, q::Query) = set(obj, q, map(f, q(obj)))
 
-_query(f, o, ::Fields, handler, itr) = mapfields(f, o, handler, itr)
-_query(f, o, ::Properties, handler, itr) = mapproperties(f, o, handler, itr)
+_inner(optic::ComposedOptic) = optic.inner
+_inner(optic) = optic
+_getouter(o, optic::ComposedOptic) = optic.outer(o)
+_getouter(o, optic) = o
+_setouter(o, optic::ComposedOptic, v) = set(o, optic.outer, v)
+_setouter(o, optic, v) = v

test/test_queries.jl

@@ -29,14 +29,14 @@ println("get")
 println("set")
 # Need a wrapper so we don't have to pass in the starting iterator
 @btime Accessors.set($obj, $lens, $vals)
+@btime Accessors._set($obj, $lens, ($vals, 1))[1]
 @btime Accessors.set($obj, $slowlens, $vals)
 Accessors.set(obj, lens, vals) 
 @test Accessors.set(obj, lens, vals) == 
     Accessors.set(obj, lens, vals) == 
     (7, (a=1.0, b=2.0f0), ("3", 4, 5.0), ((a=2.0,), [1]))
 
-# using ProfileView
-# @profview for i in 1:1000000 Accessors.set(obj, lens, vals) end
+@code_warntype Accessors.set(obj, lens, vals) 
 
 println("unstable set")
 unstable_lens = Accessors.Query(select=x -> x isa Float64 && x > 2, descend=x -> x isa NamedTuple)