תבנית Builder

חלק מהיחידה תכנות מונחה עצמים במסלול ה-R של Coddy. שיעור 47 מתוך 57.

בונה מרכיב אובייקט מורכב צעד אחר צעד ויוצר אותו בסוף באמצעות build(). בונה מבוסס סגירות שומר את החלקים במשתנים פרטיים; כל שלב מחזיר את הבונה עצמו באמצעות invisible(self), כך שאפשר לשרשר את השלבים, ושלב שמפעילים בפני עצמו אינו מדפיס דבר:

pizza_builder <- function() {
  size <- "medium"
  toppings <- character(0)
  self <- list(
    size = function(s) { size <<- s; invisible(self) },
    add = function(t) { toppings <<- c(toppings, t); invisible(self) },
    build = function() structure(list(size = size, toppings = toppings), class = "pizza")
  )
  self
}
p <- pizza_builder()$size("large")$add("olives")$add("basil")$build()
cat(p$size, "with", paste(p$toppings, collapse = " and "))

פלט:

large with olives and basil

build() הוא המקום לבדוק שהאובייקט שלם. חלקים חסרים עוצרים את התהליך ומציגים הודעה במקום ליצור אובייקט לא שלם:

email_builder <- function() {
  to <- NULL
  subject <- ""
  self <- list(
    to = function(x) { to <<- x; invisible(self) },
    subject = function(x) { subject <<- x; invisible(self) },
    build = function() {
      if (is.null(to)) stop("an email needs a recipient", call. = FALSE)
      paste0("To: ", to, " | Subject: ", subject)
    }
  )
  self
}
print(email_builder()$to("ada@x.org")$subject("Hi")$build())
print(tryCatch(email_builder()$subject("Hi")$build(), error = function(e) conditionMessage(e)))

פלט:

[1] "To: ada@x.org | Subject: Hi"
[1] "an email needs a recipient"

אותו רעיון עובד עם ערכים רגילים ועם הצינור |>. כל שלב הוא פונקציה שמקבלת את התיאור עד כה ומחזירה עותק מעודכן, והשלב האחרון בונה את התוצאה:

request <- function(url) list(url = url, method = "GET", headers = character(0))
with_method <- function(req, m) { req$method <- m; req }
with_header <- function(req, name, value) { req$headers[name] <- value; req }
build_request <- function(req) {
  c(paste(req$method, req$url), paste0(names(req$headers), ": ", req$headers))
}
r <- request("/users") |> with_method("POST") |> with_header("Accept", "json") |> build_request()
cat(r, sep = "\n")

פלט:

POST /users
Accept: json

בונה מחליף בנאי עם ארגומנטים אופציונליים רבים. כל שלב מציין מה הוא מגדיר, וחלקים שלא מוזכרים שומרים על ערכי ברירת המחדל שלהם:

# קשה לקרוא: מה המשמעות של TRUE, ומה המשמעות של 3?
make_report("sales", TRUE, FALSE, 3, "pdf")

# builder מבהיר מה המשמעות של כל ערך
report_builder("sales")$with_totals()$top(3)$format("pdf")$build()

אתגר

קל

השלימו את query_builder(table) המבוססת על סגירה. השלבים שלה מחזירים את בונה השאילתות כדי שאפשר יהיה לשרשר אותם:

select(cols): העמודות להצגה (ברירת המחדל היא *);
where(cond): מוסיפה תנאי; כמה תנאים מחוברים באמצעות AND ;
order_by(col) ו־limit(n);
build(): מחזירה את השאילתה, למשל SELECT name, age FROM users WHERE age > 30 AND city = 'Rome' ORDER BY name LIMIT 5, ומשמיטה את החלקים שלא הוגדרו.

הקוד שסופק קורא את הטבלה, ולאחר מכן שורות כמו select name age, where age > 30, order name או limit 5, ומדפיס את השאילתה שנבנתה. לאחר מכן הוא בונה שאילתה שנייה בשרשור אחד.

כתבו את הקוד שלכם ב־QueryBuilder.R. הקובץ main.R מכיל את קוד הקלט/פלט שסופק, ואי אפשר לערוך אותו.

נסו בעצמכם

source("QueryBuilder.R")

# קוד הקלט/פלט שסופק: יש להשאיר אותו כפי שהוא
input <- suppressWarnings(readLines(file("stdin")))
q <- query_builder(input[1])
for (line in input[-1]) {
  p <- strsplit(line, " ")[[1]]
  rest <- paste(p[-1], collapse = " ")
  if (p[1] == "select") q <- q$select(p[-1])
  if (p[1] == "where") q <- q$where(rest)
  if (p[1] == "order") q <- q$order_by(p[2])
  if (p[1] == "limit") q <- q$limit(as.numeric(p[2]))
}
cat(q$build(), "\n", sep = "")
cat(query_builder("logs")$select("msg")$limit(1)$build(), "\n", sep = "")