R/nodeset-processing.R

In bkkkk/omnifocusR: Retrieve Task and Project Data from your OmniFocus Database

#' Retrieve projects from OmniFocus database file
#'
#' @param x the XML document in xml2 document format
#' @param filter a function that takes an xml_document and returns an xml_nodeset, used to filter for xml tags
#' @param parser a function which takes an xml_node and returns a list, used to parse an xml node into a list
#'
#' @return data frame containing project information
#'
#' @importFrom xml2 xml_find_all xml_ns
#' @importFrom dplyr bind_rows
parse_items <- function(x, filter, parser) {
  nodes <- filter(x)
  
  bind_rows(lapply(nodes, parser, ns = xml_ns(x)))
}

#' Retrieve projects from OmniFocus database file
#'
#' @param x the XML document in xml2 document format
#'
#' @return data frame containing project information
#' @export
parse_projects <- function(x) {
  parse_items(x, filter_projects, parse_project_node)
}

#' Retrieve tasks from OmniFocus database file
#'
#' @param x the XML document in xml2 document format
#'
#' @return data frame in raw format containing task information
#' @export
parse_tasks <- function(x) {
  parse_items(x, filter_tasks, parse_task_node)
}

#' Retrieve contexts from OmniFocus database file
#'
#' @param x the XML document in xml2 document format
#'
#' @return data frame in raw format containing context information
#' @export
parse_contexts <- function(x) {
  parse_items(x, filter_contexts, parse_context_node)
}

#' Retrieve task-to-tag nodes from OmniFocus database file
#'
#' @param x the XML document in xml2 document format
#'
#' @return data frame in raw format containing task-to-tag associations
#' @export
parse_task_to_tags <- function(x) {
  parse_items(x, filter_task_to_tag, parse_task_to_tag_node)
}