Merge pull request #14 from richierocks/master

Fixes for issues #12 and #13

NAMESPACE

@@ -2,5 +2,6 @@
 
 export(cyclocomp)
 export(cyclocomp_package)
+export(cyclocomp_q)
 importFrom(utils,head)
 importFrom(utils,tail)

R/cyclocomp.R

@@ -12,11 +12,7 @@ NULL
 
 #' Cyclomatic Complexity of R Code
 #'
-#' Cyclomatic complexity is a software metric (measurement), used to indicate
-#' the complexity of a program. It is a quantitative measure of the number of
-#' linearly independent paths through a program's source code. It was developed
-#' by Thomas J. McCabe, Sr. in 1976.
-#'
+#' Calculate the cyclomatic complexity of an R function or expression.
 #' @param expr An R function or expression.
 #' @return Integer scalar, the cyclomatic complexity of the
 #'   expression.
@@ -33,7 +29,9 @@ NULL
 #' 
 #' ## Or a quoted expression
 #' cyclocomp(quote( if (condition) "foo" else "bar" ))
-#' cyclocomp(quote( while (condition) { loop } ))
+#' 
+#' ## cyclocomp_q quotes the expression for you
+#' cyclocomp_q(while (condition) { loop })
 #'
 #' ## Complexity of individual control flow constructs
 #' cyclocomp(quote({
@@ -96,9 +94,16 @@ cyclocomp <- function(expr) {
 cyclocomp_package <- function(package) {
   names <- ls(asNamespace(package))
   cc <- vapply(names, function(n) cyclocomp(get(n, asNamespace(package))), 1L)
-  data.frame(
+  d <- data.frame(
     stringsAsFactors = FALSE,
     name = unname(names),
     cyclocomp = unname(cc)
   )
+  d[order(d$cyclocomp, decreasing = TRUE), ]
+}
+
+#' @rdname cyclocomp
+#' @export
+cyclocomp_q <- function(expr) {
+  cyclocomp(substitute(expr))
 }

tests/testthat/test-cyclocomp_q.R

@@ -0,0 +1,16 @@
+
+context("cyclocomp_q")
+
+test_that("cyclocomp_q works the same as cyclocomp + quote", {
+
+
+  expect_equal(
+    cyclocomp_q(if (TRUE) "foo" else if(FALSE) "bar" else "baz"), 
+    cyclocomp(quote(if (TRUE) "foo" else if(FALSE) "bar" else "baz")))
+
+  expect_equal(
+    cyclocomp_q(while(condition && another_condition) if(something) do_something else break), 
+    cyclocomp(quote(while(condition && another_condition) if(something) do_something else break)))
+
+})
+