Fixed serious bug in asn_table_to_trie introduced after removing tidy…

…verse deps (Fixes #36)

DESCRIPTION

@@ -28,6 +28,7 @@ Imports:
     stats,
     AsioHeaders,
     stringi,
+    readr,
     triebeard
 Encoding: UTF-8
 LinkingTo: BH, Rcpp, AsioHeaders

NAMESPACE

@@ -39,4 +39,5 @@ import(stringi)
 import(triebeard)
 import(utils)
 importFrom(Rcpp,sourceCpp)
+importFrom(readr,read_tsv)
 useDynLib(iptools)

NEWS.md

@@ -1,6 +1,10 @@
 iptools 0.6.1
 =============
 * Fixed serious bug in `ips_in_cidrs()` introduced after removing tidyverse deps
+* Fixed serious bug in `asn_table_to_trie()` introduced after removing
+  tidyverse deps (Fixes #36)
+* Added tests & examples for all CIDR ops
+* Added test data file for ASN trie ops
 
 iptools 0.6.0
 =============

R/cidr.r

@@ -2,20 +2,21 @@
 #'
 #' @param asn_table_file filename of dat file (can be gzip'd)
 #' @export
+#' @examples
+#' asn_table_to_trie(system.file("test", "rib.tst.gz", package="iptools"))
 asn_table_to_trie <- function(asn_table_file) {
 
-  read.csv(
+  readr::read_tsv(
     file = asn_table_file,
-    sep = "\t",
-    comment.char = ";",
-    col.names = c("cidr", "asn")
+    comment = ";",
+    col_names = c("cidr", "asn")
   ) -> rip
 
   cidr_split <- stri_split_fixed(rip$cidr, "/", 2, simplify = TRUE)
 
   ip <- cidr_split[,1]
-  mask <- cidr_split[,1]
-  prefix = stri_sub(ip_to_binary_string(ip), 1, mask)
+  mask <- cidr_split[,2]
+  prefix <- stri_sub(ip_to_binary_string(ip), 1, mask)
 
   triebeard::trie(prefix, rip$asn)
 
@@ -26,6 +27,9 @@ asn_table_to_trie <- function(asn_table_file) {
 #' @param cidr_trie trie created with \code{asn_table_to_trie()}
 #' @param ip character vector or numeric vector of IPv4 addresses
 #' @export
+#' @examples
+#' tbl <- asn_table_to_trie(system.file("test", "rib.tst.gz", package="iptools"))
+#' ip_to_asn(tbl, "5.192.0.1")
 ip_to_asn <- function(cidr_trie, ip) {
 
   if (inherits(ip, "numeric")) {
@@ -45,6 +49,11 @@ ip_to_asn <- function(cidr_trie, ip) {
 #' @note auto-appends \code{/32} if a bare IPv4 is detected
 #' @return \code{data_frame} with \code{ips} column and a logical \code{in_cdir} column
 #' @export
+#' @examples
+#' ips_in_cidrs(
+#'   c("4.3.2.1", "1.2.3.4", "1.20.113.10", "5.190.145.5"),
+#'   c("5.190.144.0/21", "1.20.113.0/24")
+#' )
 ips_in_cidrs <- function(ips, cidrs) {
 
   cidrs[!stri_detect_fixed(cidrs, "/")] <- sprintf("%s/32", cidrs[!stri_detect_fixed(cidrs, "/")])
@@ -75,6 +84,8 @@ ips_in_cidrs <- function(ips, cidrs) {
 #'
 #' @param cidrs character vector of IPv4 CIDRs
 #' @export
+#' @examples
+#' host_count("1.52.0.0/14")
 host_count <- function(cidrs) {
 
   is_cidr <- stri_detect_fixed(cidrs, "/")

R/iptools-package.R

@@ -14,4 +14,5 @@
 #' @import utils
 #' @import stats
 #' @import AsioHeaders
+#' @importFrom readr read_tsv
 NULL

tests/testthat/test-cidr-ops.R

@@ -0,0 +1,22 @@
+context("Test CIDR Operations")
+
+test_that("asn table ops work",{
+
+  asn_table_to_trie(
+    system.file("test", "rib.tst.gz", package="iptools")
+  ) -> asntbl
+
+  expect_equal(dim(asntbl), 9994)
+
+  expect_equal(ip_to_asn(asntbl, "5.192.0.1"), 5384)
+
+  ips_in_cidrs(
+    c("4.3.2.1", "1.2.3.4", "1.20.113.10", "5.190.145.5"),
+    c("5.190.144.0/21", "1.20.113.0/24")
+  ) -> res
+
+  expect_equal(res$in_cidr, c(FALSE, FALSE, TRUE, TRUE))
+
+  expect_equal(host_count("1.52.0.0/14"), 262144)
+
+})