update CRAN

Author: munoztd0

NAMESPACE

@@ -1,4 +1,8 @@
+# Generated by roxygen2: do not edit by hand
+
+export(apply_hotfix_file)
+export(dummy_child_func)
+export(dummy_parent_func)
 export(inject_patch)
 export(test_patched_dir)
 export(undo_patch)
-export(apply_hotfix_file)

NEWS.md

@@ -1,7 +1,6 @@
-# hotpatchR NEWS
+# hotpatchR
 
 ## 0.1.0
 
 - Initial package scaffold for runtime namespace hotfixing.
 - Added `inject_patch()`, `undo_patch()`, `test_patched_dir()`, and `apply_hotfix_file()`.
-- Added README, vignette, and documentation support files.

R/hotpatch.R

@@ -6,10 +6,10 @@
 #' @return Invisibly TRUE on success.
 #' @examples
 #' # Show baseline behavior with broken function
-#' baseline <- hotpatchR:::dummy_parent_func("test")
+#' baseline <- dummy_parent_func("test")
 #' print(baseline)
 #'
-#' # Inject a patched version of the internal child function
+#' # Inject a patched version of the child function
 #' inject_patch(
 #'   pkg = "hotpatchR",
 #'   patch_list = list(dummy_child_func = function(x) {
@@ -18,7 +18,7 @@
 #' )
 #'
 #' # Call the parent function again - it now uses the patched child
-#' patched_result <- hotpatchR:::dummy_parent_func("test")
+#' patched_result <- dummy_parent_func("test")
 #' print(patched_result)
 #' @export
 inject_patch <- function(pkg, patch_list, lock = TRUE) {
@@ -122,14 +122,14 @@ inject_patch <- function(pkg, patch_list, lock = TRUE) {
 #' )
 #'
 #' # Call with patched function
-#' patched <- hotpatchR:::dummy_parent_func("test")
+#' patched <- dummy_parent_func("test")
 #' print(patched)
 #'
 #' # Restore the original function
 #' undo_patch(pkg = "hotpatchR", names = "dummy_child_func")
 #'
 #' # Now it's back to the original
-#' restored <- hotpatchR:::dummy_parent_func("test")
+#' restored <- dummy_parent_func("test")
 #' print(restored)
 #' @export
 undo_patch <- function(pkg, names = NULL) {
@@ -185,17 +185,18 @@ undo_patch <- function(pkg, names = NULL) {
 #' @param reporter testthat reporter name or object.
 #' @return Result object from testthat::test_dir.
 #' @examples
-#' # Inject a patch to the package
-#' inject_patch(
-#'   pkg = "hotpatchR",
-#'   patch_list = list(dummy_child_func = function(x) {
-#'     paste("PATCHED! Input:", x)
-#'   })
-#' )
+#' \dontrun{
+#'   # Inject a patch to the package
+#'   inject_patch(
+#'     pkg = "hotpatchR",
+#'     patch_list = list(dummy_child_func = function(x) {
+#'       paste("PATCHED! Input:", x)
+#'     })
+#'   )
 #'
-#' # Run tests against the patched package
-#' # (Note: this requires tests to exist in tests/testthat directory)
-#' # test_patched_dir(pkg = "hotpatchR")
+#'   # Run tests against the patched package
+#'   test_patched_dir(pkg = "hotpatchR")
+#' }
 #' @export
 test_patched_dir <- function(pkg, test_path = "tests/testthat", reporter = "summary") {
   if (!requireNamespace("testthat", quietly = TRUE)) {
@@ -239,7 +240,7 @@ test_patched_dir <- function(pkg, test_path = "tests/testthat", reporter = "summ
 #' apply_hotfix_file(file = hotfix_file, pkg = "hotpatchR")
 #'
 #' # Verify the patch works
-#' result <- hotpatchR:::dummy_parent_func("test")
+#' result <- dummy_parent_func("test")
 #' print(result)
 #'
 #' # Clean up

R/utils.R

@@ -8,7 +8,7 @@
 #'
 #' @examples
 #' # Call the parent function which internally calls dummy_child_func
-#' result <- hotpatchR:::dummy_parent_func("sample")
+#' result <- dummy_parent_func("sample")
 #' print(result)
 #'
 #' @export
@@ -25,12 +25,12 @@ dummy_parent_func <- function(x) {
 #' @return A character string with child output
 #'
 #' @examples
-#' # This function is internal and called by dummy_parent_func
+#' # This function is called by dummy_parent_func
 #' # It serves as an example of a function that can be hotpatched
-#' result <- hotpatchR:::dummy_child_func("example")
+#' result <- dummy_child_func("example")
 #' print(result)
 #'
-#' @keywords internal
+#' @export
 dummy_child_func <- function(x) {
   return(paste("I am the BROKEN child. Input:", x))
 }

README.md

@@ -73,7 +73,7 @@ A typical test-hotfix flow looks like this:
 ```r
 library(hotpatchR)
 
-baseline <- hotpatchR:::dummy_parent_func("test")
+baseline <- dummy_parent_func("test")
 print(baseline)
 #> "Parent output -> I am the BROKEN child. Input: test"
 
@@ -84,14 +84,14 @@ inject_patch(
   })
 )
 
-patched_result <- hotpatchR:::dummy_parent_func("test")
+patched_result <- dummy_parent_func("test")
 print(patched_result)
 #> "Parent output -> I am the FIXED child! Input: test"
 
 
 #Eventually, you can reverse the patch to restore the original behavior if needed:
 undo_patch(pkg = "hotpatchR", names = "dummy_child_func")
-restored_result <- hotpatchR:::dummy_parent_func("test")
+restored_result <- dummy_parent_func("test")
 print(restored_result)
 #> "Parent output -> I am the BROKEN child. Input: test"
 ```