fix: ignore missing schedule references (#26)

* fix: ignore missing schedule references

* docs: record nullable schedule fix

Author: hongyuanjia

NEWS.md

@@ -1,5 +1,7 @@
 # destep 0.0.0.9000
 
+- Ignored missing and zero-valued DeST schedule references during conversion,
+  preventing nullable reserved fields from producing invalid SQL (#26).
 - Preserved DeST enclosure geometry during EnergyPlus conversion by correcting
   surface types, outward normals, reciprocal boundary references, true-north
   rotation, EnergyPlus-tolerance vertex handling, shared-edge topology,

R/conv-schedule.R

@@ -44,8 +44,11 @@ destep_conv_schedule <- function(dest, ep) {
             }
         }
     })))
-    # TODO: what is the value of the default schedule with ID = 0 for WINDOW table?
-    ids_ref <- ids_ref[ids_ref != 0L]
+    # NULL means that the optional reference is not assigned, while zero is
+    # DeST's sentinel for a default or unused schedule. Neither value names a
+    # SCHEDULE_YEAR row, and retaining NA would emit it as a SQL identifier.
+    ids_ref <- ids_ref[!is.na(ids_ref) & ids_ref != 0L]
+    if (length(ids_ref) == 0L) return(NULL)
 
     schedule <- data.table::setDT(DBI::dbGetQuery(
         dest,

tests/testthat/test-conv-schedule.R

@@ -36,6 +36,55 @@ test_that("schedule conversion writes resolvable week day references", {
     expect_true(all(unique(week_day_names) %in% day_names))
 })
 
+test_that("schedule conversion ignores missing and zero references", {
+    ep <- ensure_empty_idf()
+    dest <- DBI::dbConnect(RSQLite::SQLite(), ":memory:")
+    on.exit(DBI::dbDisconnect(dest), add = TRUE)
+
+    DBI::dbWriteTable(dest, "SCHEDULE_YEAR", data.frame(
+        SCHEDULE_ID = 10L,
+        NAME = "Always On",
+        TYPE = 1L,
+        DATA = I(list(destep_test_schedule_blob(rep(1, 8760L))))
+    ))
+    DBI::dbWriteTable(dest, "DOOR", data.frame(
+        ID = 1:2,
+        SCHEDULE = c(NA_integer_, NA_integer_)
+    ))
+    DBI::dbWriteTable(dest, "SCHEDULE_USAGE", data.frame(
+        ID = 1:3,
+        SCHEDULE_ID = c(10L, 0L, NA_integer_)
+    ))
+
+    schedule <- destep_conv_schedule(dest, ep)
+
+    expect_type(schedule, "list")
+    expect_equal(attr(schedule, "table")$SCHEDULE_ID, 10L)
+})
+
+test_that("schedule conversion returns null without valid references", {
+    ep <- ensure_empty_idf()
+    dest <- DBI::dbConnect(RSQLite::SQLite(), ":memory:")
+    on.exit(DBI::dbDisconnect(dest), add = TRUE)
+
+    DBI::dbWriteTable(dest, "SCHEDULE_YEAR", data.frame(
+        SCHEDULE_ID = 10L,
+        NAME = "Always On",
+        TYPE = 1L,
+        DATA = I(list(destep_test_schedule_blob(rep(1, 8760L))))
+    ))
+    DBI::dbWriteTable(dest, "DOOR", data.frame(
+        ID = 1:2,
+        SCHEDULE = c(NA_integer_, NA_integer_)
+    ))
+    DBI::dbWriteTable(dest, "WINDOW", data.frame(
+        ID = 1L,
+        SCHEDULE = 0L
+    ))
+
+    expect_null(destep_conv_schedule(dest, ep))
+})
+
 test_that("real model schedule week and year references are resolvable", {
     skip_on_cran()