Merge pull request #175 from github/loc-summary-queries-1

alexrford · web-flow · commit 6bd2e4e4b76b · 2021-05-14T15:51:45.000+01:00
Summary queries for total LOC and user-code LOC
diff --git a/ql/src/codeql/files/FileSystem.qll b/ql/src/codeql/files/FileSystem.qll
@@ -190,4 +190,7 @@ class File extends Container, @file {
 
   /** Gets the number of lines of comments in this file. */
   int getNumberOfLinesOfComments() { result = count(int line | this.line(line, true)) }
+
+  /** Holds if this file was extracted from ordinary source code. */
+  predicate fromSource() { files(this, _, _, _, 1) }
 }
diff --git a/ql/src/queries/summary/LinesOfCode.ql b/ql/src/queries/summary/LinesOfCode.ql
@@ -0,0 +1,13 @@
+/**
+ * @id rb/summary/lines-of-code
+ * @name Total lines of Ruby code in the database
+ * @description The total number of lines of Ruby code across all files,
+ *   including vendored code, tests. This query counts the lines of code,
+ *   excluding whitespace or comments.
+ * @kind metric
+ * @tags summary
+ */
+
+import ruby
+
+select sum(File f | | f.getNumberOfLinesOfCode())
diff --git a/ql/src/queries/summary/LinesOfUserCode.ql b/ql/src/queries/summary/LinesOfUserCode.ql
@@ -0,0 +1,17 @@
+/**
+ * @id rb/summary/lines-of-user-code
+ * @name Lines of authored Ruby code in the database
+ * @description The total number of lines of Ruby code across files, excluding library and generated code.
+ * @kind metric
+ * @tags summary
+ */
+
+import ruby
+
+select sum(File f |
+    f.fromSource() and
+    exists(f.getRelativePath()) and
+    not f.getAbsolutePath().matches("%/vendor/%")
+  |
+    f.getNumberOfLinesOfCode()
+  )
diff --git a/ql/test/query-tests/summary/LinesOfCode.expected b/ql/test/query-tests/summary/LinesOfCode.expected
@@ -0,0 +1 @@
+| 9 |
diff --git a/ql/test/query-tests/summary/LinesOfCode.qlref b/ql/test/query-tests/summary/LinesOfCode.qlref
@@ -0,0 +1 @@
+queries/summary/LinesOfCode.ql
diff --git a/ql/test/query-tests/summary/LinesOfUserCode.expected b/ql/test/query-tests/summary/LinesOfUserCode.expected
@@ -0,0 +1 @@
+| 5 |
diff --git a/ql/test/query-tests/summary/LinesOfUserCode.qlref b/ql/test/query-tests/summary/LinesOfUserCode.qlref
@@ -0,0 +1 @@
+queries/summary/LinesOfUserCode.ql
diff --git a/ql/test/query-tests/summary/src/foo.rb b/ql/test/query-tests/summary/src/foo.rb
@@ -0,0 +1,11 @@
+# comment
+
+def hello
+  p "hello foo"
+end
+
+# another one
+
+hello
+
+p "more code here"
diff --git a/ql/test/query-tests/summary/src/vendor/cache/lib.rb b/ql/test/query-tests/summary/src/vendor/cache/lib.rb
@@ -0,0 +1,9 @@
+# comment
+
+def hello
+  p "hello lib"
+end
+
+# another one
+
+hello

Original file line number	Diff line number	Diff line change
`@@ -190,4 +190,7 @@ class File extends Container, @file {`
`190`	`190`
`191`	`191`	`/** Gets the number of lines of comments in this file. */`
`192`	`192`	`int getNumberOfLinesOfComments() { result = count(int line \| this.line(line, true)) }`
	`193`	`+`
	`194`	`+ /** Holds if this file was extracted from ordinary source code. */`
	`195`	`+ predicate fromSource() { files(this, _, _, _, 1) }`
`193`	`196`	`}`