feat: naming convention fact (APP-43) (#91)

* feat: naming convention fact (APP-43)

* wip: fix pr

Author: yaronskaya

src/main/kotlin/app/FactCodes.kt

@@ -1,11 +1,13 @@
 // Copyright 2017 Sourcerer Inc. All Rights Reserved.
 // Author: Anatoly Kislov ([email protected])
+// Author: Liubov Yaronskaya ([email protected])
 
 package app
 
 object FactCodes {
     val COMMIT_DAY_WEEK = 1  // Day of week fun fact and graph.
     val COMMIT_DAY_TIME = 2  // Day time fun fact.
+
     val COMMIT_LINE_NUM_AVG = 8  // Average number of lines per commit fun fact.
     val COMMIT_NUM = 9  // Used for averaging COMMIT_LINE_NUM_AVG between repos.
     // A map of line numbers to commits number. Used in a commit histogram.
@@ -17,4 +19,8 @@ object FactCodes {
     val REPO_DATE_START = 5  // Repo summary info. Date of first contribution.
     val REPO_DATE_END = 6  // Repo summary info. Date of last contribution.
     val REPO_TEAM_SIZE = 7  // Repo summary info. Number of contributors.
+    val VARIABLE_NAMING = 13 // Variables naming fun fact.
+    val VARIABLE_NAMING_SNAKE_CASE = 0
+    val VARIABLE_NAMING_CAMEL_CASE = 1
+    val VARIABLE_NAMING_OTHER = 2
 }

src/main/kotlin/app/extractors/GoExtractor.kt

@@ -37,9 +37,10 @@ class GoExtractor : ExtractorInterface {
         val contentJoined = fileContent.joinToString(separator = "")
         multipleImportRegex.findAll(contentJoined).forEach { matchResult ->
             imports.addAll(matchResult.groupValues.last()
-                .split(Regex("""(\t+|\n+|\s+)"""))
+                .split(Regex("""(\t+|\n+|\s+|")"""))
                 .filter { it.isNotEmpty() }
-                .map { it -> it.replace("\"", "") })
+                .map { it -> it.replace("\"", "") }
+                .map { it ->  if (it.contains("github.com")) it.split("/")[2] else it})
         }
 
         return imports.toList()

src/main/kotlin/app/hashers/FactHasher.kt

@@ -1,11 +1,13 @@
 // Copyright 2017 Sourcerer Inc. All Rights Reserved.
 // Author: Anatoly Kislov ([email protected])
+// Author: Liubov Yaronskaya ([email protected])
 
 package app.hashers
 
 import app.FactCodes
 import app.Logger
 import app.api.Api
+import app.extractors.Extractor
 import app.model.Author
 import app.model.Commit
 import app.model.Fact
@@ -30,6 +32,7 @@ class FactHasher(private val serverRepo: Repo = Repo(),
     private val fsLineLenAvg = hashMapOf<String, Double>()
     private val fsLineNum = hashMapOf<String, Long>()
     private val fsLinesPerCommits = hashMapOf<String, Array<Int>>()
+    private val fsVariableNaming = hashMapOf<String, Array<Int>>()
 
     init {
         for (author in emails) {
@@ -43,6 +46,7 @@ class FactHasher(private val serverRepo: Repo = Repo(),
             fsLineNum.put(author, 0)
             // TODO(anatoly): Do the bin computations on the go.
             fsLinesPerCommits.put(author, Array(rehashes.size) {0})
+            fsVariableNaming.put(author, Array(3) { 0 })
         }
     }
 
@@ -102,6 +106,21 @@ class FactHasher(private val serverRepo: Repo = Repo(),
         fsLineNum[email] = fsLineNum[email]!! + lines.size
 
         fsLinesPerCommits[email]!![numCommits - 1] += lines.size
+
+        lines.forEach { line ->
+            val tokens = Extractor().tokenize(line)
+            val underscores = tokens.count { it.contains('_') }
+            val camelCases = tokens.count {
+                !it.contains('_') && it.contains(Regex("[a-z][A-Z]"))
+            }
+            val others = tokens.size - underscores - camelCases
+            fsVariableNaming[email]!![FactCodes.VARIABLE_NAMING_SNAKE_CASE] +=
+                underscores
+            fsVariableNaming[email]!![FactCodes.VARIABLE_NAMING_CAMEL_CASE] +=
+                camelCases
+            fsVariableNaming[email]!![FactCodes.VARIABLE_NAMING_OTHER] +=
+                others
+        }
     }
 
     private fun createFacts(): List<Fact> {
@@ -116,6 +135,11 @@ class FactHasher(private val serverRepo: Repo = Repo(),
                 fs.add(Fact(serverRepo, FactCodes.COMMIT_DAY_WEEK, day,
                             count.toString(), author))
             }}
+            fsVariableNaming[email]?.forEachIndexed { naming, count -> if (count > 0) {
+                fs.add(Fact(serverRepo, FactCodes.VARIABLE_NAMING, naming,
+                        count.toString(), author))
+            }}
+
             fs.add(Fact(serverRepo, FactCodes.REPO_DATE_START, 0,
                         fsRepoDateStart[email].toString(), author))
             fs.add(Fact(serverRepo, FactCodes.REPO_DATE_END, 0,

src/test/kotlin/test/tests/extractors/ExtractorTest.kt

@@ -188,4 +188,36 @@ class ExtractorTest : Spek({
             assertExtractsImport(lib, line2, PythonExtractor())
         }
     }
+
+    given("one line import in go file") {
+        it("extracts library name") {
+            val lib = "macagon"
+            val line = "import \"macagon\""
+            assertExtractsImport(lib, line, GoExtractor())
+        }
+    }
+
+    given("multiline import in go file") {
+        it("extracts library name") {
+            val lib = "macagon"
+            val lines = listOf("import (",
+                               "\"macagon\"",
+                               "\"github.com/astaxie/beego\"",
+                               ")")
+            val actualLineImports = GoExtractor().extractImports(lines)
+            assertTrue(lib in actualLineImports)
+        }
+    }
+
+    given("github  url as import in go file") {
+        it("extracts library name") {
+            val lib = "beego"
+            val lines = listOf("import (",
+                    "\"macagon\"",
+                    "\"github.com/astaxie/beego\"",
+                    ")")
+            val actualLineImports = GoExtractor().extractImports(lines)
+            assertTrue(lib in actualLineImports)
+        }
+    }
 })

src/test/kotlin/test/tests/hashers/FactHasherTest.kt

@@ -1,5 +1,6 @@
 // Copyright 2017 Sourcerer Inc. All Rights Reserved.
 // Author: Anatoly Kislov ([email protected])
+// Author: Liubov Yaronskaya ([email protected])
 
 package test.tests.hashers
 
@@ -282,4 +283,48 @@ class FactHasherTest : Spek({
             testRepo.destroy()
         }
     }
+
+    given("commits for naming convention facts") {
+        val testRepo = TestRepo(repoPath + "file-facts")
+        val emails = hashSetOf(authorEmail1)
+        val mockApi = MockApi(mockRepo = repo)
+        val facts = mockApi.receivedFacts
+
+        afterEachTest {
+            facts.clear()
+        }
+
+        val lines = listOf("camelCase1", "camelCase2", "snake_case", "fn()")
+
+        it("sends facts") {
+            for (i in 0..lines.size - 1) {
+                val line = lines[i]
+                val fileName = "file$i.txt"
+                testRepo.createFile(fileName, listOf(line))
+                testRepo.commit(message = "$line in $fileName", author = author1)
+            }
+
+            val errors = mutableListOf<Throwable>()
+            val observable = CommitCrawler.getObservable(testRepo.git, repo)
+            val rehashes = (0..lines.size - 1).map { "r$it" }
+
+            FactHasher(repo, mockApi, rehashes, emails)
+                    .updateFromObservable(observable, { e -> errors.add(e) })
+            if (errors.size > 0) {
+                println(errors[0].message)
+            }
+            assertEquals(0, errors.size)
+
+            assertFactInt(FactCodes.VARIABLE_NAMING,
+                FactCodes.VARIABLE_NAMING_SNAKE_CASE, 1, author1, facts)
+            assertFactInt(FactCodes.VARIABLE_NAMING,
+                FactCodes.VARIABLE_NAMING_CAMEL_CASE, 2, author1, facts)
+            assertFactInt(FactCodes.VARIABLE_NAMING,
+                FactCodes.VARIABLE_NAMING_OTHER, 1, author1, facts)
+        }
+
+        afterGroup {
+            testRepo.destroy()
+        }
+    }
 })