Fix a couple of bugs

.Rbuildignore

@@ -7,6 +7,7 @@ noto.style
 rule_ideas.rst
 html
 others
+^pkgdown$
 raw-data
 tmp
 .*.epub

DESCRIPTION

@@ -2,7 +2,7 @@ Encoding: UTF-8
 Package: ppcli
 Type: Package
 Title: Plaintext Board Game Visualizations
-Version: 0.2.0-2
+Version: 0.2.0-3
 Authors@R: c(person("Trevor L.", "Davis", role=c("aut", "cre"),
              email="trevor.l.davis@gmail.com",
              comment = c(ORCID = "0000-0001-6341-4639")))

NEWS.md

@@ -1,25 +1,37 @@
 ppcli 0.2.0 (development)
 =========================
 
+New features
+------------
+
 * `cat_piece()` and `str_piece()` adds support for the following game pieces (#4):
 
   + "alquerque" bit and board pieces.
   + "marbles" bit and board pieces.
 
     - However we currently do not distinguish between the nine marble bit ranks.
 
+* `cat_piece()` and `str_piece()` gain arguments `xbreaks` and `ybreaks`
+  to provide a subset (of integers) to provide axis labels for if `annotate` is `TRUE` (#17).
+
+Bug fixes and minor improvements
+--------------------------------
+
 * "white" `go` and `checkers` bits should now render the same
   whether `piece_side` is `"bit_back"` or `"bit_face"`.
 
-* `cat_piece()` and `str_piece()` gain arguments `xbreaks` and `ybreaks`
-  to provide a subset (of integers) to provide axis labels for if `annotate` is `TRUE` (#17).
+* `cat_piece()` and `str_piece()` now expand the drawing range for longer
+  (piecepack) matchsticks if necessary (#14).
+
+* `str_piece()`'s `color` argument if `NULL` now falls back to `FALSE`
+  (instead of throwing an error).
 
 ppcli 0.1.1
 ===========
 
 * ``cat_piece()`` prints out Unicode plaintext boardgame diagrams.
 
-  + It supports the same data frame arguments also supported by 
+  + It supports the same data frame arguments also supported by
     ``piecepackr::pmap_piece()`` / ``piecepackr::render_piece()``
     as well as the board game setup functions in `{ppdf}`.
   + It is an extraction and refinement of ``ppgames::cat_piece()``.

R/cat_piece.r

@@ -12,6 +12,20 @@
 #' @return String of text diagram (returned invisibly).
 #'         As a side effect prints out the text diagram using [cat()].
 #' @seealso [str_piece()] for just the character vector.  See <https://github.com/trevorld/game-bit-font> for more information about the \dQuote{Game Bit} family of fonts.
+#' @examples
+#' dfb <- data.frame(piece_side = "board_face", x= 3, y = 3, suit = 3)
+#' dfsw <- data.frame(piece_side = "bit_back",
+#'                    x = c(1:5, 1:5, 4:5),
+#'                    y = rep.int(1:3, c(5L, 5L, 2L)),
+#'                    suit = 6L)
+#' dfsb <- data.frame(piece_side = "bit_back",
+#'                    x = c(1:5, 1:5, 1:2),
+#'                    y = rep.int(5:3, c(5L, 5L, 2L)),
+#'                    suit = 2L)
+#' df <- rbind(dfb, dfsw, dfsb)
+#' df$cfg <- "alquerque"
+#' cat_piece(df)
+#' cat_piece(df, annotate = TRUE)
 #' @export
 cat_piece <- function(df, color = NULL, reorient = "none", annotate = FALSE, ...,
                       file = "", annotation_scale = NULL,

R/range.r

@@ -37,5 +37,25 @@ range_heuristic <- function(df) {
     ybot <- ifelse(is_board2, df$y-df$rank, ybot)
     ytop <- ifelse(is_board2, df$y+df$rank, ytop)
 
+    # matchsticks
+    m_offset <- pmax(floor(df$rank / 2) - 1, 0) / 2 # 1:6 -> 0, 0, 0, 0.5, 0.5, 1
+    is_matchsticks_horizontal <- grepl("matchstick", df$piece_side) &
+        (df$angle == 90 | df$angle == 270)
+    xleft <- ifelse(is_matchsticks_horizontal, df$x - m_offset, xleft)
+    xright <- ifelse(is_matchsticks_horizontal, df$x + m_offset, xright)
+
+    is_matchsticks_vertical <- grepl("matchstick", df$piece_side) &
+        (df$angle == 0 | df$angle == 180)
+    ybot <- ifelse(is_matchsticks_vertical, df$y - m_offset, ybot)
+    ytop <- ifelse(is_matchsticks_vertical, df$y + m_offset, ytop)
+
+    m_offset_d <- floor(df$rank / 4) # 1:6 -> 0, 0, 0, 1, 1, 1
+    is_matchsticks_diagonal <- grepl("matchstick", df$piece_side) &
+        !is_matchsticks_horizontal & !is_matchsticks_vertical
+    xleft <- ifelse(is_matchsticks_diagonal, df$x - m_offset_d, xleft)
+    xright <- ifelse(is_matchsticks_diagonal, df$x + m_offset_d, xright)
+    ybot <- ifelse(is_matchsticks_diagonal, df$y - m_offset_d, ybot)
+    ytop <- ifelse(is_matchsticks_diagonal, df$y + m_offset_d, ytop)
+
     list(xmin = min(xleft), xmax = max(xright), ymin = min(ybot), ymax = max(ytop))
 }

R/str_piece.r

@@ -29,6 +29,21 @@
 #' @return Character vector for text diagram.
 #' @seealso [cat_piece()] for printing to the terminal.
 #'          See <https://github.com/trevorld/game-bit-font> for more information about the \dQuote{Game Bit} family of fonts.
+#' @examples
+#' dfb <- data.frame(piece_side = "board_face", x= 3, y = 3, suit = 3)
+#' dfsw <- data.frame(piece_side = "bit_back",
+#'                    x = c(1:5, 1:5, 4:5),
+#'                    y = rep.int(1:3, c(5L, 5L, 2L)),
+#'                    suit = 6L)
+#' dfsb <- data.frame(piece_side = "bit_back",
+#'                    x = c(1:5, 1:5, 1:2),
+#'                    y = rep.int(5:3, c(5L, 5L, 2L)),
+#'                    suit = 2L)
+#' df <- rbind(dfb, dfsw, dfsb)
+#' df$cfg <- "alquerque"
+#' s <- str_piece(df)
+#' is.character(s)
+#' cat(s, sep = "\n")
 #' @export
 str_piece <- function(df, color = NULL, reorient = "none", annotate = FALSE, ...,
                       annotation_scale = NULL,
@@ -43,6 +58,7 @@ str_piece_helper <- function(df, color = NULL, reorient = "none", annotate = FAL
                              annotation_scale = NULL,
                              style = "Unicode", xbreaks = NULL, ybreaks = NULL) {
     annotation_scale <- annotation_scale %||% attr(df, "scale_factor") %||% 1
+    color <- color %||% FALSE
     if (nrow(df) == 0) {
         return(character(0))
     }
@@ -521,6 +537,7 @@ add_matchstick_face4 <- function(cm, x, y, angle, fg) {
     cm
 }
 add_matchstick_face5 <- add_matchstick_face4
+
 add_matchstick_face6 <- function(cm, x, y, angle, fg) {
     if (angle %in% c(0, 180)) {
         cm$char[y+-2:2, x] <- "\u2503"

pkgdown/extra.css

@@ -0,0 +1,5 @@
+pre {
+    font-family: Dejavu Sans Mono,FreeMono,monospace;
+    line-height: 1.0;
+    font-size: 100%;
+}