Merge branch 'r-1.1.0' into production

krlmlr · krlmlr · commit b9dc7998442e · 2017-06-17T19:08:43.000+02:00
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -5,3 +5,4 @@
 ^\.travis\.yml$
 ^codecov\.yml$
 ^cran-comments\.md$
+^API$
diff --git a/API b/API
@@ -0,0 +1,15 @@
+# API for blob package
+
+## Exported functions
+
+as.blob(x, ...)
+blob(...)
+new_blob(x)
+
+## S3 methods
+
+as.blob.blob(x, ...)
+as.blob.character(x, ...)
+as.blob.integer(x, ...)
+as.blob.list(x, ...)
+as.blob.raw(x, ...)
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,8 +1,9 @@
 Package: blob
 Title: A Simple S3 Class for Representing Vectors of Binary Data ('BLOBS')
-Version: 1.0.0
+Version: 1.1.0
 Authors@R: c(
-    person("Hadley", "Wickham", , "hadley@rstudio.com", role = c("aut", "cre")),
+    person("Hadley", "Wickham", role = c("aut")),
+    person("Kirill", "Müller", , "krlmlr+r@mailbox.org", role = c("cre")),
     person("RStudio", role = "cph")
   )
 Description: R's raw vector is useful for storing a single binary object.
@@ -19,4 +20,5 @@ BugReports: https://github.com/hadley/blob/issues
 Suggests:
     testthat,
     covr
-RoxygenNote: 5.0.1
+Roxygen: list(markdown = TRUE, roclets = c("collate", "namespace", "rd", "pkgapi::api_roclet"))
+RoxygenNote: 6.0.1
diff --git a/NAMESPACE b/NAMESPACE
@@ -4,10 +4,12 @@ S3method("[",blob)
 S3method("[<-",blob)
 S3method("[[<-",blob)
 S3method("is.na<-",blob)
+S3method(as.blob,blob)
 S3method(as.blob,character)
 S3method(as.blob,integer)
 S3method(as.blob,list)
 S3method(as.blob,raw)
+S3method(as.data.frame,blob)
 S3method(format,blob)
 S3method(is.na,blob)
 S3method(is_vector_s3,blob)
diff --git a/NEWS.md b/NEWS.md
@@ -0,0 +1,12 @@
+# blob 1.1.0 (2017-06-17)
+
+- New maintainer: Kirill Müller.
+
+- Added `as.blob.blob()`and `as.data.frame.blob()` methods (#3).
+
+- Size of very large blobs is displayed correctly.
+
+
+# blob 1.0.0
+
+- Initial release.
diff --git a/R/blob.R b/R/blob.R
@@ -34,6 +34,11 @@ as.blob <- function(x, ...) {
   UseMethod("as.blob")
 }
 
+#' @export
+as.blob.blob <- function(x, ...) {
+  x
+}
+
 #' @export
 as.blob.list <- function(x, ...) {
   new_blob(x)
@@ -53,3 +58,6 @@ as.blob.character <- function(x, ...) {
 as.blob.integer <- function(x, ...) {
   new_blob(lapply(x, as.raw))
 }
+
+#' @export
+as.data.frame.blob <- as.data.frame.difftime
diff --git a/R/format.R b/R/format.R
@@ -32,13 +32,14 @@ obj_sum.blob <- function(x) {
 is_vector_s3.blob <- function(x) TRUE
 
 blob_size <- function(x, digits = 3, trim = TRUE, ...) {
-  x <- vapply(x, length, integer(1))
+  x <- vapply(x, length, numeric(1))
 
-  power <- min(floor(log(abs(x), 1000)), 4)
+  units <- c("kb", "Mb", "Gb", "Tb")
+  power <- min(floor(log(abs(x), 1000)), length(units))
   if (power < 1) {
     unit <- "B"
   } else {
-    unit <- c("kb", "Mb", "Gb", "Tb")[[power]]
+    unit <- units[[power]]
     x <- x / (1024 ^ power)
   }
 
diff --git a/README.Rmd b/README.Rmd
@@ -1,10 +1,12 @@
 ---
-output: github_document
+output:
+  github_document:
+    html_preview: false
 ---
 
-[![Travis-CI Build Status](https://travis-ci.org/rstats-db/blob.svg?branch=master)](https://travis-ci.org/rstats-db/blob)
+[![Travis-CI Build Status](https://travis-ci.org/tidyverse/blob.svg?branch=master)](https://travis-ci.org/tidyverse/blob)
 [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/blob)](https://cran.r-project.org/package=blob)
-[![Coverage Status](https://img.shields.io/codecov/c/github/rstats-db/blob/master.svg)](https://codecov.io/github/rstats-db/blob?branch=master)
+[![Coverage Status](https://codecov.io/gh/tidyverse/blob/branch/master/graph/badge.svg)](https://codecov.io/github/tidyverse/blob?branch=master)
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
@@ -29,7 +31,7 @@ You can install blob from github with:
 
 ```{r gh-installation, eval = FALSE}
 # install.packages("devtools")
-devtools::install_github("rstats-db/blob")
+devtools::install_github("tidyverse/blob")
 ```
 
 ## Example
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 
-[![Travis-CI Build Status](https://travis-ci.org/rstats-db/blob.svg?branch=master)](https://travis-ci.org/rstats-db/blob) [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/blob)](https://cran.r-project.org/package=blob) [![Coverage Status](https://img.shields.io/codecov/c/github/rstats-db/blob/master.svg)](https://codecov.io/github/rstats-db/blob?branch=master)
+[![Travis-CI Build Status](https://travis-ci.org/tidyverse/blob.svg?branch=master)](https://travis-ci.org/tidyverse/blob) [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/blob)](https://cran.r-project.org/package=blob) [![Coverage Status](https://codecov.io/gh/tidyverse/blob/branch/master/graph/badge.svg)](https://codecov.io/github/tidyverse/blob?branch=master)
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 blob
@@ -16,7 +16,7 @@ You can install blob from github with:
 
 ``` r
 # install.packages("devtools")
-devtools::install_github("rstats-db/blob")
+devtools::install_github("tidyverse/blob")
 ```
 
 Example
diff --git a/cran-comments.md b/cran-comments.md
@@ -1,20 +1,15 @@
 ## Test environments
-* local OS X install, R 3.3.2
-* ubuntu 12.04 (on travis-ci), R 3.3.2
+* local Ubuntu 17.04 install, R 3.4.0
+* ubuntu 12.04 (on travis-ci), R 3.4.0
 * win-builder (devel and release)
 
 ## R CMD check results
 
 0 errors | 0 warnings | 1 note
 
-* This is a new release.
-
-* Found the following (possibly) invalid URLs:
-  URL: https://cran.r-project.org/package=blob
-  From: README.md
-  
-  This will work if this package is accepted :)
+* Change of package maintainer, see https://github.com/tidyverse/blob/pull/6
+  for consent of previous maintainer.
 
 ## Reverse dependencies
 
-This is a new release, so there are no reverse dependencies.
+Checked the only dependency 'odbc'.
diff --git a/man/blob.Rd b/man/blob.Rd
diff --git a/tests/testthat/test-format.R b/tests/testthat/test-format.R
@@ -0,0 +1,43 @@
+context("format")
+
+expect_format_equal <- function(formatted, result) {
+  expect_equal(
+    paste(formatted, collapse = "\n"),
+    paste(result, collapse = "\n")
+  )
+}
+
+test_that("unequal sizes", {
+  x <- blob(raw(2 ** 2), raw(2 ** 11), raw(2 ** 20))
+
+  expect_format_equal(
+    format(x),
+    c(
+      "blob[4 B]",
+      "blob[2,050 B]",
+      "blob[1,050,000 B]"
+    )
+  )
+
+  expect_format_equal(
+    format(x, trim = FALSE),
+    c(
+      "blob[        4 B]",
+      "blob[    2,050 B]",
+      "blob[1,050,000 B]"
+    )
+  )
+})
+
+test_that("similar sizes", {
+  x <- blob(raw(2 ** 10), raw(2 ** 11), raw(2 ** 12))
+
+  expect_format_equal(
+    format(x),
+    c(
+      "blob[1 kb]",
+      "blob[2 kb]",
+      "blob[4 kb]"
+    )
+  )
+})
