add some tests

Author: cpsievert

NEWS.md

@@ -14,7 +14,7 @@
 
 ## CHANGES
 
-* The `name` attribute is now a "special `plot_ly()` argument" and behaves similar to `split` (it ensures a different trace for every unique value supplied). Although this leads to a breaking change (`name` was previously appended to an automatically generated trace name), it leads to a better and more flexible API. Those that wish to have the old behavior back should provide relevant mappings to the `name` attributes (e.g. `plot_ly(mtcars, x = ~wt, y = ~mpg, color = ~factor(vs), name = "a")` would become `plot_ly(mtcars, x = ~wt, y = ~mpg, color = ~factor(vs), name = ~paste(vs, "\na"))`)
+* The `name` attribute is now a "special `plot_ly()` argument" and behaves similar to `split` (it ensures a different trace for every unique value supplied). Although this leads to a breaking change (`name` was previously appended to an automatically generated trace name), it leads to a more flexible and transparent API. Those that wish to have the old behavior back should provide relevant mappings to the `name` attributes (e.g. `plot_ly(mtcars, x = ~wt, y = ~mpg, color = ~factor(vs), name = "a")` would become `plot_ly(mtcars, x = ~wt, y = ~mpg, color = ~factor(vs), name = ~paste(vs, "\na"))`)
 * The `color` argument now maps to `fillcolor`, making it much easier to use polygon fills to encode data values (e.g., choropleth maps). For backwards-compatibilty reasons, when `color` maps to `fillcolor`, `alpha` defaults to 0.5 (instead of 1). For an example, `plot_mapbox(mn_res, color = ~INDRESNAME)` or `plot_mapbox(mn_res, split = ~INDRESNAME, color = ~AREA, showlegend = FALSE, stroke = I("black"))`.
 * The `color` argument no longer automatically add `"markers"` to the `mode` attribute for scatter/scattergl trace types. Those who wish to have the old behavior back, should add `"markers"` to the `mode` explicity (e.g., change `plot_ly(economics, x = ~pce, y = ~pop, color = ~as.numeric(date), mode = "lines")` to `plot_ly(economics, x = ~pce, y = ~pop, color = ~as.numeric(date), mode = "lines+markers")`).
 * The `size` argument now informs a default [error_[x/y].width](https://plot.ly/r/reference/#scatter-error_x-width) (and `span` informs [error_[x/y].thickness](https://plot.ly/r/reference/#scatter-error_x-thickness)). Note you can override the default by specifying directly (e.g. `plot_ly(x = 1:10, y = 1:10, size = I(10), error_x = list(value = 5, width = 0))`).

tests/testthat/test-plotly-name.R

@@ -0,0 +1,50 @@
+context("name-mapping")
+
+test_that("can create multiple traces from name argument", {
+  l <- plot_ly() %>% 
+    add_markers(x = 1:10, y = 1:10, name = rep(c("a", "b"), 5)) %>%
+    plotly_build()
+  
+  expect_length(l$x$data, 2)
+  expect_equal(l$x$data[[1]]$name, "a")
+  expect_equal(l$x$data[[2]]$name, "b")
+})
+
+
+test_that("can override name argument", {
+  l <- plot_ly() %>% 
+    add_markers(x = 1:10, y = 1:10, split = rep(c("a", "b"), 5), name = "z") %>%
+    plotly_build()
+
+  expect_length(l$x$data, 2)
+  expect_equal(l$x$data[[1]]$name, "z")
+  expect_equal(l$x$data[[2]]$name, "z")
+  
+  # can get back old behvaior
+  l2 <- plot_ly() %>% 
+    add_markers(x = 1:10, y = 1:10, split = rep(c("a", "b"), 5), name = paste0(rep(c("a", "b"), 5), "<br>z")) %>%
+    plotly_build()
+  
+  expect_length(l2$x$data, 2)
+  expect_equal(l2$x$data[[1]]$name, "a<br>z")
+  expect_equal(l2$x$data[[2]]$name, "b<br>z")
+  
+})
+
+
+test_that("doesn't break old behavior", {
+  # from https://community.plot.ly/t/manual-color-bug/10479
+  density1 <- density(diamonds[diamonds$cut %in% "Fair",])
+  density2 <- density(diamonds[diamonds$cut %in% "Ideal",])
+  
+  l <- plot_ly(x = ~density1$x, y = ~density1$y, type = 'scatter', mode = 'lines', name = 'Fair cut', fill = 'tozeroy',
+          fillcolor = 'rgba(168, 216, 234, 0.5)',
+          line = list(width = 0.5)) %>%
+    add_trace(x = ~density2$x, y = ~density2$y, name = 'Ideal cut', fill = 'tozeroy',
+              fillcolor = 'rgba(255, 212, 96, 0.5)') %>%
+    plotly_build()
+  
+  
+  expect_equal(l$x$data[[1]]$name, "Fair cut")
+  expect_equal(l$x$data[[2]]$name, "Ideal cut")
+})