Fixes R6 warnings when loading package (#658)

# Pull Request

- Fixes #657

### Changes description

- Move `finalize()` methods
- Create public `destroy()` methods as these methods are called
recursively

---------

Signed-off-by: André Veríssimo <[email protected]>
Co-authored-by: Lluís Revilla <[email protected]>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

Author: 3 people

NEWS.md

@@ -1,5 +1,9 @@
 # teal.slice 0.6.0.9008
 
+### Miscellaneous
+
+* In R6 classes `finalize()` method is moved to private and is replaced in public API by `destroy()` (#658).
+
 # teal.slice 0.6.0
 
 ### Enhancements

R/FilterState.R

@@ -113,6 +113,9 @@ FilterState <- R6::R6Class( # nolint
       })
     },
 
+    #' @description Destroys a `FilterState` object.
+    destroy = function() private$finalize(),
+
     #' @description
     #' Returns a formatted string representing this `FilterState` object.
     #'
@@ -385,17 +388,6 @@ FilterState <- R6::R6Class( # nolint
           )
         )
       )
-    },
-
-    #' @description
-    #' Destroy inputs and observers stored in `private$session_bindings`.
-    #'
-    #'
-    #' @return `NULL`, invisibly.
-    #'
-    finalize = function() {
-      .finalize_session_bindings(self, private)
-      invisible(NULL)
     }
   ),
 
@@ -793,6 +785,16 @@ FilterState <- R6::R6Class( # nolint
         )
         invisible(NULL)
       })
+    },
+
+    #' @description
+    #' Destroy inputs and observers stored in `private$session_bindings`.
+    #'
+    #'
+    #' @return `NULL`, invisibly.
+    #'
+    finalize = function() {
+      .finalize_session_bindings(self, private)
     }
   )
 )

R/FilterStateExpr.R

@@ -78,6 +78,9 @@ FilterStateExpr <- R6::R6Class( # nolint
       invisible(self)
     },
 
+    #' @description Destroys a `FilterStateExpr` object.
+    destroy = function() private$finalize(),
+
     #' @description
     #' Returns a formatted string representing this `FilterStateExpr` object.
     #'
@@ -140,16 +143,6 @@ FilterStateExpr <- R6::R6Class( # nolint
       isolate(str2lang(private$teal_slice$expr))
     },
 
-    #' @description
-    #' Destroy inputs and observers stored in `private$session_bindings`.
-    #'
-    #' @return `NULL`, invisibly.
-    #'
-    finalize = function() {
-      .finalize_session_bindings(self, private)
-      invisible(NULL)
-    },
-
     # public shiny modules ----
 
     #' @description
@@ -276,6 +269,15 @@ FilterStateExpr <- R6::R6Class( # nolint
     },
     content_summary = function() {
       isolate(private$teal_slice$expr)
+    },
+
+    #' @description
+    #' Destroy inputs and observers stored in `private$session_bindings`.
+    #'
+    #' @return `NULL`, invisibly.
+    #'
+    finalize = function() {
+      .finalize_session_bindings(self, private)
     }
   )
 )

R/FilterStates.R

@@ -77,6 +77,9 @@ FilterStates <- R6::R6Class( # nolint
       invisible(self)
     },
 
+    #' @description Destroys a `FilterStates` object.
+    destroy = function() private$finalize(),
+
     #' @description
     #' Returns a formatted string representing this `FilterStates` object.
     #'
@@ -507,19 +510,6 @@ FilterStates <- R6::R6Class( # nolint
           NULL
         }
       )
-    },
-
-    #' @description
-    #' Object cleanup.
-    #'
-    #' - Destroy inputs and observers stored in `private$session_bindings`
-    #' - Clean `state_list`
-    #'
-    #' @return `NULL`, invisibly.
-    #'
-    finalize = function() {
-      .finalize_session_bindings(self, private)
-      invisible(NULL)
     }
   ),
   private = list(
@@ -662,7 +652,7 @@ FilterStates <- R6::R6Class( # nolint
                 if (state$get_state()$anchored && !force) {
                   TRUE
                 } else {
-                  state$finalize()
+                  state$destroy()
                   FALSE
                 }
               } else {
@@ -768,6 +758,18 @@ FilterStates <- R6::R6Class( # nolint
 
         invisible(NULL)
       })
+    },
+
+    #' @description
+    #' Object cleanup.
+    #'
+    #' - Destroy inputs and observers stored in `private$session_bindings`
+    #' - Clean `state_list`
+    #'
+    #' @return `NULL`, invisibly.
+    #'
+    finalize = function() {
+      .finalize_session_bindings(self, private)
     }
   )
 )

R/FilteredData.R

@@ -134,6 +134,9 @@ FilteredData <- R6::R6Class( # nolint
       invisible(self)
     },
 
+    #' @description Destroys a `FilteredData` object.
+    destroy = function() private$finalize(),
+
     #' @description
     #' Gets `datanames`.
     #' @details
@@ -829,19 +832,6 @@ FilteredData <- R6::R6Class( # nolint
           NULL
         }
       )
-    },
-
-    #' @description
-    #' Object and dependencies cleanup.
-    #'
-    #' - Destroy inputs and observers stored in `private$session_bindings`
-    #' - Finalize `FilteredData` stored in `private$filtered_datasets`
-    #'
-    #' @return `NULL`, invisibly.
-    finalize = function() {
-      .finalize_session_bindings(self, private)
-      lapply(private$filtered_datasets, function(x) x$finalize())
-      invisible(NULL)
     }
   ),
 
@@ -1031,6 +1021,19 @@ FilteredData <- R6::R6Class( # nolint
           }
         )
       })
+    },
+
+    #' @description
+    #' Object and dependencies cleanup.
+    #'
+    #' - Destroy inputs and observers stored in `private$session_bindings`
+    #' - Finalize `FilteredData` stored in `private$filtered_datasets`
+    #'
+    #' @return `NULL`, invisibly.
+    finalize = function() {
+      .finalize_session_bindings(self, private)
+      lapply(private$filtered_datasets, function(x) x$destroy())
+      invisible(NULL)
     }
   )
 )

R/FilteredDataset.R

@@ -59,6 +59,10 @@ FilteredDataset <- R6::R6Class( # nolint
       invisible(self)
     },
 
+    #' @description Destroys a `FilteredDataset` object.
+    destroy = function() private$finalize(),
+
+
     #' @description
     #' Returns a formatted string representing this `FilteredDataset` object.
     #'
@@ -459,19 +463,6 @@ FilteredDataset <- R6::R6Class( # nolint
           NULL
         }
       )
-    },
-
-    #' @description
-    #' Object and dependencies cleanup.
-    #'
-    #' - Destroy inputs and observers stored in `private$session_bindings`
-    #' - Finalize `FilterStates` stored in `private$filter_states`
-    #'
-    #' @return `NULL`, invisibly.
-    finalize = function() {
-      .finalize_session_bindings(self, private)
-      lapply(private$filter_states, function(x) x$finalize())
-      invisible(NULL)
     }
   ),
   # private fields ----
@@ -502,6 +493,19 @@ FilteredDataset <- R6::R6Class( # nolint
     # @return list of `FilterStates` objects.
     get_filter_states = function() {
       private$filter_states
+    },
+
+    #' @description
+    #' Object and dependencies cleanup.
+    #'
+    #' - Destroy inputs and observers stored in `private$session_bindings`
+    #' - Finalize `FilterStates` stored in `private$filter_states`
+    #'
+    #' @return `NULL`, invisibly.
+    finalize = function() {
+      .finalize_session_bindings(self, private)
+      lapply(private$filter_states, function(x) x$destroy())
+      invisible(NULL)
     }
   )
 )