feat: add progress bar, refactor messages (APP-102) (#70)

* feat: add progress bar to commitcrawler

* wip: refactor messages

* wip: refactor messages

* fix: tests

Author: astansler

.gitignore

@@ -21,3 +21,4 @@ app.iws
 /ultimate/ideaSDK
 /ultimate/out
 /ultimate/tmp
+tmp_repo

build.gradle

@@ -49,7 +49,7 @@ buildConfig {
 
     // Logging.
     buildConfigField 'String', 'SENTRY_DSN', 'https://0263d6473bd24a9ba40e25aa5fb0a242:[email protected]/233260'
-    buildConfigField 'boolean', 'PRINT_STACK_TRACE', 'true'
+    buildConfigField 'boolean', 'PRINT_STACK_TRACE', 'false'
 
     // Models storage path.
     buildConfigField 'String', 'LIBRARY_MODELS_URL', 'https://storage.googleapis.com/sourcerer-app/library-models/v1/'

src/main/kotlin/app/Logger.kt

@@ -97,6 +97,49 @@ object Logger {
         return a.getValue(BuildConfig.LOG_LEVEL)
     }
 
+    /**
+     * Utils.
+     */
+    private fun Double.format(digits: Int, digitsFloating: Int) =
+        java.lang.String.format("%${digits}.${digitsFloating}f", this)
+
+    private fun generateIndent(num: Int): String {
+        return 0.rangeTo(num).fold("") { ind, _ -> ind + " " }
+    }
+
+    /**
+     * CLI messages and pretty printing.
+     */
+    fun print(message: Any, indentLine: Boolean = false) {
+        print(message.toString(), indentLine)
+    }
+
+    fun print(message: String, indentLine: Boolean = false) {
+        if (indentLine) {
+            println()
+        }
+        println(message)
+    }
+
+    fun printCommit(commitMessage: String, commitHash: String,
+                    percents: Double) {
+        val percentsStr = percents.format(6, 2)
+        val hash = commitHash.substring(0, 7)
+        val messageTrim = if (commitMessage.length > 59) {
+            commitMessage.substring(0, 56).plus("...")
+        } else commitMessage
+        println(" [$percentsStr%] * $hash $messageTrim")
+    }
+
+    private val commitDetailIndent = generateIndent(10) + "|" +
+        generateIndent(8)
+    fun printCommitDetail(message: String) {
+        val messageTrim = if (message.length > 59) {
+            message.substring(0, 56).plus("...")
+        } else message
+        println(commitDetailIndent + messageTrim)
+    }
+
     /**
      * Log error message with exception info.
      * Don't log private information with this method.

src/main/kotlin/app/Main.kt

@@ -81,8 +81,7 @@ class Main(argv: Array<String>) {
             localRepo.hashAllContributors = commandAdd.hashAll
             configurator.addLocalRepoPersistent(localRepo)
             configurator.saveToFile()
-            println("Added git repository at $path.")
-
+            Logger.print("Added git repository at $path.")
             Logger.info(Logger.Events.CONFIG_CHANGED) { "Config changed" }
         } else {
             Logger.warn { "No valid git repository found at specified path" }
@@ -119,11 +118,11 @@ class Main(argv: Array<String>) {
         if (path != null) {
             configurator.removeLocalRepoPersistent(LocalRepo(path))
             configurator.saveToFile()
-            println("Repository removed from tracking list.")
+            Logger.print("Repository removed from tracking list.")
 
             Logger.info(Logger.Events.CONFIG_CHANGED) { "Config changed" }
         } else {
-            println("Repository not found in tracking list.")
+            Logger.print("Repository not found in tracking list.")
         }
     }
 
@@ -138,10 +137,12 @@ class Main(argv: Array<String>) {
     }
 
     private fun showHelp(jc: JCommander) {
-        println("Sourcerer hashes your git repositories into intelligent "
-            + "engineering profiles. If you don't have an account, "
-            + "please, proceed to http://sourcerer.io/register. More info at "
-            + "http://sourcerer.io.")
+        Logger.print("Sourcerer hashes your git repositories into intelligent "
+            + "engineering profiles.")
+        Logger.print("If you don't have an account, please, proceed to " +
+            "https://sourcerer.io/join")
+        Logger.print("More info at https://sourcerer.io and " +
+            "https://github.com/sourcerer-io")
         jc.usage()  // Will show detailed info about usage based on annotations.
     }
 }

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

@@ -22,44 +22,52 @@ import org.eclipse.jgit.revwalk.RevWalk
 import org.eclipse.jgit.util.io.DisabledOutputStream
 
 object CommitCrawler {
-    fun getObservable(git: Git, repo: Repo): Observable<Commit> = Observable
-        .create<Commit> { subscriber ->
-            try {
-                val revWalk = RevWalk(git.repository)
-                val commitId = git.repository.resolve(RepoHelper.MASTER_BRANCH)
-                revWalk.markStart(revWalk.parseCommit(commitId))
-                for (revCommit in revWalk) {
-                    subscriber.onNext(Commit(revCommit))
+    fun getObservable(git: Git, repo: Repo,
+                      numCommits: Int = 0): Observable<Commit> {
+        var curNumCommits = 0
+        return Observable
+            .create<Commit> { subscriber ->
+                try {
+                    val revWalk = RevWalk(git.repository)
+                    val commitId = git.repository.resolve(RepoHelper.MASTER_BRANCH)
+                    revWalk.markStart(revWalk.parseCommit(commitId))
+                    for (revCommit in revWalk) {
+                        subscriber.onNext(Commit(revCommit))
+                    }
+                    // Commits are combined in pairs, an empty commit concatenated
+                    // to calculate the diff of the initial commit.
+                    subscriber.onNext(Commit())
+                } catch (e: Exception) {
+                    Logger.error(e, "Commit producing error")
+                    subscriber.onError(e)
                 }
-                // Commits are combined in pairs, an empty commit concatenated
-                // to calculate the diff of the initial commit.
-                subscriber.onNext(Commit())
-            } catch (e: Exception) {
-                Logger.error(e, "Commit producing error")
-                subscriber.onError(e)
-            }
-            subscriber.onComplete()
-        }  // TODO(anatoly): Rewrite diff calculation in non-weird way.
-        .pairWithNext()  // Pair commits to get diff.
-        .map { (new, old) ->
-            // Mapping and stats extraction.
-            Logger.debug {
-                "Commit: ${new.raw?.name ?: ""}: ${new.raw?.shortMessage}"
-            }
-            new.diffs = getDiffFiles(git, new, old)
-            Logger.debug { "Diff: ${new.diffs.size} entries" }
-            // Count lines on all non-binary files. This is additional
-            // statistics to CommitStats because not all file extensions
-            // may be supported.
-            new.numLinesAdded = new.diffs.fold(0) { total, file ->
-                total + file.getAllAdded().size
-            }
-            new.numLinesDeleted = new.diffs.fold(0) { total, file ->
-                total + file.getAllDeleted().size
+                subscriber.onComplete()
+            }  // TODO(anatoly): Rewrite diff calculation in non-weird way.
+            .pairWithNext()  // Pair commits to get diff.
+            .map { (new, old) ->
+                curNumCommits++
+                // Mapping and stats extraction.
+                val message = new.raw?.shortMessage ?: ""
+                val hash = new.raw?.name ?: ""
+                val perc = if (numCommits != 0) {
+                    (curNumCommits.toDouble() / numCommits) * 100
+                } else 0.0
+                Logger.printCommit(message, hash, perc)
+                new.diffs = getDiffFiles(git, new, old)
+                Logger.debug { "Diff: ${new.diffs.size} entries" }
+                // Count lines on all non-binary files. This is additional
+                // statistics to CommitStats because not all file extensions
+                // may be supported.
+                new.numLinesAdded = new.diffs.fold(0) { total, file ->
+                    total + file.getAllAdded().size
+                }
+                new.numLinesDeleted = new.diffs.fold(0) { total, file ->
+                    total + file.getAllDeleted().size
+                }
+                new.repo = repo
+                new
             }
-            new.repo = repo
-            new
-        }
+    }
 
     private fun getDiffFiles(git: Git,
                              commitNew: Commit,

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

@@ -48,7 +48,10 @@ class CommitHasher(private val serverRepo: Repo = Repo(),
 
                 // Mapping and stats extraction.
                 commit.stats = Extractor().extract(commit.diffs)
-                Logger.info { "Stats: ${commit.stats.size} entries" }
+                if (commit.stats.isNotEmpty()) {
+                    Logger.printCommitDetail("${commit.stats.size} " +
+                        "technology stats found")
+                }
                 Logger.debug { commit.stats.toString() }
 
                 commit

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

@@ -3,6 +3,7 @@
 
 package app.hashers
 
+import app.BuildConfig
 import app.Logger
 import app.api.Api
 import app.config.Configurator
@@ -31,7 +32,6 @@ class RepoHasher(private val localRepo: LocalRepo, private val api: Api,
     }
 
     fun update() {
-        println("Hashing $localRepo...")
         Logger.info { "Hashing of repo started" }
         val git = loadGit(localRepo.path)
         try {
@@ -60,8 +60,8 @@ class RepoHasher(private val localRepo: LocalRepo, private val api: Api,
             }
 
             // Hash by all plugins.
-            val observable = CommitCrawler.getObservable(git, serverRepo)
-                                          .publish()
+            val observable = CommitCrawler.getObservable(git, serverRepo,
+                rehashes.size).publish()
             CommitHasher(serverRepo, api, rehashes, filteredEmails)
                 .updateFromObservable(observable, onError)
             FactHasher(serverRepo, api, rehashes, filteredEmails)
@@ -71,19 +71,20 @@ class RepoHasher(private val localRepo: LocalRepo, private val api: Api,
             observable.connect()
 
             // TODO(anatoly): CodeLongevity hash from observable.
+            Logger.print("Code longevity calculation. May take a while...")
             try {
                 CodeLongevity(serverRepo, filteredEmails, git, onError)
                     .updateStats(api)
             }
             catch (e: Throwable) {
                 onError(e)
             }
+            Logger.print("Finished.")
 
             if (errors.isNotEmpty()) {
                 throw HashingException(errors)
             }
 
-            println("Hashing $localRepo completed.")
             Logger.info(Logger.Events.HASHING_REPO_SUCCESS)
                 { "Hashing repo completed" }
         }

src/main/kotlin/app/model/LocalRepo.kt

@@ -18,4 +18,8 @@ data class LocalRepo(var path: String = "") {
             email = config.getString("user", null, "email") ?: "")
         remoteOrigin = config.getString("remote", "origin", "url") ?: ""
     }
+
+    override fun toString(): String {
+        return path
+    }
 }

src/main/kotlin/app/ui/AddRepoState.kt

@@ -21,28 +21,29 @@ class AddRepoState constructor(private val context: Context,
         if (configurator.getLocalRepos().isNotEmpty()) return
 
         while (true) {
-            println("Type a path to repository, or hit Enter to continue.")
+            Logger.print("Type a path to repository, or hit Enter to continue.")
             val pathString = readLine() ?: ""
 
             if (pathString.isEmpty()) {
                 if (configurator.getLocalRepos().isEmpty()) {
-                    println("Add at least one valid repository.")
+                    Logger.print("Add at least one valid repository.")
                 } else {
                     break // User finished to add repos.
                 }
             } else {
                 if (RepoHelper.isValidRepo(pathString)) {
-                    println("Added git repository at $pathString.")
+                    Logger.print("Added git repository at $pathString.")
                     val localRepo = LocalRepo(pathString)
                     localRepo.hashAllContributors = UiHelper.confirm("Do you "
                         + "want to hash commits of all contributors?",
                         defaultIsYes = true)
                     configurator.addLocalRepoPersistent(localRepo)
                     configurator.saveToFile()
                 } else {
-                    println("Directory should contain valid git repository.")
-                    println("Make sure that master branch with at least one " +
-                        "commit exists.")
+                    Logger.print("Directory should contain a valid git " +
+                        "repository.")
+                    Logger.print("Make sure that master branch with at least " +
+                        "one commit exists.")
                 }
             }
         }

src/main/kotlin/app/ui/AuthState.kt

@@ -46,13 +46,13 @@ class AuthState constructor(private val context: Context,
     }
 
     fun getUsername() {
-        println("Enter username:")
+        Logger.print("Enter username:")
         username = readLine() ?: ""
         configurator.setUsernameCurrent(username)
     }
 
     fun getPassword() {
-        println("Enter password:")
+        Logger.print("Enter password:")
         password = PasswordHelper.readPassword()
         configurator.setPasswordCurrent(password)
     }
@@ -71,11 +71,11 @@ class AuthState constructor(private val context: Context,
 
     fun tryAuth(): Boolean {
         try {
-            println("Authenticating...")
+            Logger.print("Signing in...")
             val (_, error) = api.authorize()
             if (error.isWithServerCode(Api.OUT_OF_DATE)) {
-                println("App is out of date. Please get new version at " +
-                        "https://sourcerer.io")
+                Logger.print("App is out of date. Please get new version at " +
+                    "https://sourcerer.io")
                 retry = false
                 return false
             }
@@ -85,8 +85,8 @@ class AuthState constructor(private val context: Context,
             val user = api.getUser().getOrThrow()
             configurator.setUser(user)
 
-            println("You are successfully authenticated. Your profile page is "
-                    + BuildConfig.PROFILE_URL + configurator.getUsername())
+            Logger.print("Signed in successfully. Your profile page is " +
+                BuildConfig.PROFILE_URL + configurator.getUsername())
 
             saveCredentialsIfChanged()
             Logger.username = configurator.getUsername()
@@ -95,14 +95,14 @@ class AuthState constructor(private val context: Context,
             return true
         } catch (e: ApiError) {
             if (e.isAuthError) {
-                if (e.httpBodyMessage.isNotBlank()) {
-                    println(e.httpBodyMessage)
+                if(e.httpBodyMessage.isNotBlank()) {
+                    Logger.print(e.httpBodyMessage)
                 } else {
-                    println("Authentication error. Try again.")
+                    Logger.print("Authentication error. Try again.")
                 }
             } else {
+                Logger.print("Connection problems. Try again later.")
                 Logger.error(e)
-                println("Connection problems. Try again later.")
                 retry = false
             }
         }