refactor: rename CCDefaultTokensService to CCTokensService and clean it up a bit

Author: lppedd

src/main/java/com/github/lppedd/cc/configuration/CCMainConfigurableGui.java

@@ -14,7 +14,7 @@
 
 import com.github.lppedd.cc.CCBundle;
 import com.github.lppedd.cc.configuration.CCConfigService.CompletionType;
-import com.github.lppedd.cc.configuration.CCDefaultTokensService.JsonCommitType;
+import com.github.lppedd.cc.configuration.CCTokensService.CommitTypeModel;
 import com.github.lppedd.cc.configuration.component.CoAuthorsFilePickerPanel;
 import com.github.lppedd.cc.configuration.component.DefaultTokensFileExportPanel;
 import com.github.lppedd.cc.configuration.component.DefaultTokensFilePickerPanel;
@@ -144,7 +144,7 @@ public void setCustomTokensFilePath(@Nullable final String path) {
     defaultTokensFilePickerPanel.setCustomFilePath(path);
   }
 
-  public void setTokens(@NotNull final Map<String, JsonCommitType> tokens) {
+  public void setTokens(@NotNull final Map<String, CommitTypeModel> tokens) {
     defaultTokensPanel.setTokens(tokens);
   }
 
@@ -158,7 +158,7 @@ public void revalidate() {
     defaultTokensFilePickerPanel.revalidateComponent();
   }
 
-  @SuppressWarnings({"ConstantExpression", "InstanceVariableUsedBeforeInitialized"})
+  @SuppressWarnings("ConstantExpression")
   private void finishUpComponents(
       @NotNull final Project project,
       @NotNull final Disposable disposable) {

src/main/kotlin/com/github/lppedd/cc/api/impl/InternalCommitTokenProvider.kt

@@ -4,8 +4,7 @@ import com.github.lppedd.cc.CC
 import com.github.lppedd.cc.CCBundle
 import com.github.lppedd.cc.CCNotification
 import com.github.lppedd.cc.api.*
-import com.github.lppedd.cc.configuration.CCConfigService
-import com.github.lppedd.cc.configuration.CCDefaultTokensService
+import com.github.lppedd.cc.configuration.CCTokensService
 import com.github.lppedd.cc.configuration.SchemaValidationException
 import com.intellij.openapi.components.service
 import com.intellij.openapi.diagnostic.logger
@@ -26,17 +25,16 @@ internal class InternalCommitTokenProvider(private val project: Project) :
     private val logger = logger<InternalCommitTokenProvider>()
   }
 
-  private val configService = project.service<CCConfigService>()
-  private val defaultsService = project.service<CCDefaultTokensService>()
+  private val tokensService = project.service<CCTokensService>()
   private val defaults
     get() = try {
-      defaultsService.getDefaultsFromCustomFile(configService.customFilePath)
+      tokensService.getTokens()
     } catch (e: ProcessCanceledException) {
       throw e
     } catch (e: Exception) {
       logger.debug("Error while reading the custom tokens file", e)
       notifyErrorToUser(e)
-      defaultsService.getBuiltInDefaults()
+      tokensService.getBundledTokens()
     }
 
   override fun getId(): String =
@@ -63,7 +61,7 @@ internal class InternalCommitTokenProvider(private val project: Project) :
       subject: String?,
   ): Collection<CommitFooterValue> {
     if ("co-authored-by".equals(footerType, true)) {
-      return defaultsService.getCoAuthors()
+      return tokensService.getCoAuthors()
         .asSequence()
         .take(3)
         .map { DefaultCommitToken(it, "", true) }

src/main/kotlin/com/github/lppedd/cc/configuration/CCMainConfigurable.kt

@@ -12,7 +12,7 @@ import javax.swing.JComponent
  * @author Edoardo Luppi
  */
 internal class CCMainConfigurable(private val project: Project) : SearchableConfigurable {
-  private val defaultsService = project.service<CCDefaultTokensService>()
+  private val tokensService = project.service<CCTokensService>()
   private val configService = project.service<CCConfigService>()
   private val disposable = Disposer.newDisposable("CCMainConfigurable")
   private lateinit var gui: CCMainConfigurableGui
@@ -33,9 +33,9 @@ internal class CCMainConfigurable(private val project: Project) : SearchableConf
     gui.customCoAuthorsFilePath = configService.customCoAuthorsFilePath
 
     val tokens = try {
-      defaultsService.getDefaultsFromCustomFile(configService.customFilePath)
+      tokensService.getTokens()
     } catch (_: Exception) {
-      defaultsService.getBuiltInDefaults()
+      tokensService.getBundledTokens()
     }
 
     gui.setTokens(tokens.types)
@@ -60,7 +60,7 @@ internal class CCMainConfigurable(private val project: Project) : SearchableConf
     configService.customFilePath = gui.customTokensFilePath
 
     try {
-      val tokens = defaultsService.getDefaultsFromCustomFile(configService.customFilePath)
+      val tokens = tokensService.getTokens()
       gui.setTokens(tokens.types)
     } catch (_: Exception) {
       gui.revalidate()

…/configuration/CCDefaultTokensService.kt …pedd/cc/configuration/CCTokensService.ktsrc/main/kotlin/com/github/lppedd/cc/configuration/CCDefaultTokensService.kt renamed to src/main/kotlin/com/github/lppedd/cc/configuration/CCTokensService.kt src/main/kotlin/com/github/lppedd/cc/configuration/CCDefaultTokensService.kt renamed to src/main/kotlin/com/github/lppedd/cc/configuration/CCTokensService.kt

@@ -19,22 +19,22 @@ import java.nio.file.NoSuchFileException
 import kotlin.io.path.bufferedReader
 
 /**
- * Manages default commit types and scopes.
+ * Manages bundled and custom commit message tokens.
  *
  * @author Edoardo Luppi
  */
 @Suppress("LightServiceMigrationCode")
-internal class CCDefaultTokensService(private val project: Project) {
+internal class CCTokensService(private val project: Project) {
   private companion object {
-    private val logger = logger<CCDefaultTokensService>()
+    private val logger = logger<CCTokensService>()
   }
 
   private val configService = project.service<CCConfigService>()
 
   /**
    * JSON Schema used to validate the default commit types and scopes JSON file.
    */
-  private val defaultsSchema: Schema by lazy {
+  private val tokensSchema: Schema by lazy {
     val bufferedReader = getResourceAsStream("/defaults/${CC.File.Schema}").bufferedReader()
     val schemaJson = bufferedReader.use {
       JsonParser(bufferedReader).parse()
@@ -44,53 +44,56 @@ internal class CCDefaultTokensService(private val project: Project) {
   }
 
   /**
-   * Built-in default commit types and scopes.
-   *
-   * @throws SchemaValidationException When the JSON object does not respect the schema
+   * Bundled commit message tokens.
    */
-  private val builtInDefaultTokens: JsonDefaults by lazy {
+  private val bundledTokensModel: TokensModel by lazy {
     val jsonStr = getResourceAsStream("/defaults/${CC.File.Defaults}").bufferedReader().use(Reader::readText)
     parseJsonStr(jsonStr)
   }
 
-  fun getDefaultsFromCustomFile(filePath: String? = null): JsonDefaults {
-    val path = filePath ?: findDefaultFilePathFromProjectRoot()
-    return path?.let(::readDefaultsFromFile) ?: builtInDefaultTokens
+  /**
+   * Returns commit message tokens defined in a custom `conventionalcommit.json` file,
+   * or falls back to the bundled defaults if no custom file is specified.
+   *
+   * @see getBundledTokens
+   */
+  fun getTokens(): TokensModel {
+    val path = configService.customFilePath ?: findTokensFileInProjectRoot()
+    return path?.let(::readTokensFromFile) ?: getBundledTokens()
   }
 
   /**
-   * Returns the built-in commit types and scopes.
+   * Returns commit message tokens defined in the bundled `conventionalcommit.json` file.
    */
-  fun getBuiltInDefaults(): JsonDefaults =
-    builtInDefaultTokens
+  fun getBundledTokens(): TokensModel =
+    bundledTokensModel
 
   /**
    * Validates a file via the inputted absolute path.
    *
    * @throws SchemaValidationException When the JSON object does not respect the schema
    */
-  fun validateDefaultsFile(filePath: String) {
+  fun validateTokensFile(filePath: String) {
     val path = FileSystems.getDefault().getPath(filePath)
 
     if (Files.notExists(path)) {
       throw NoSuchFileException(filePath)
     }
 
     val jsonStr = path.bufferedReader().use(Reader::readText)
-    defaultsSchema.validateJson(jsonStr)
+    tokensSchema.validateJson(jsonStr)
   }
 
   /**
    * Returns the user-defined co-authors.
    */
   fun getCoAuthors(): Collection<String> {
     val customCoAuthorsFilePath = configService.customCoAuthorsFilePath
-    val fileSystem = FileSystems.getDefault()
     val filePath = if (customCoAuthorsFilePath == null) {
       val projectBasePath = project.basePath ?: return emptySet()
-      fileSystem.getPath(projectBasePath, CC.File.CoAuthors)
+      FileSystems.getDefault().getPath(projectBasePath, CC.File.CoAuthors)
     } else {
-      fileSystem.getPath(customCoAuthorsFilePath)
+      FileSystems.getDefault().getPath(customCoAuthorsFilePath)
     }
 
     try {
@@ -132,10 +135,9 @@ internal class CCDefaultTokensService(private val project: Project) {
   }
 
   /**
-   * Returns the full path of the default tokens file located
-   * in the project root directory, or `null`.
+   * Returns the path of the tokens file in the project root directory, or `null` if there is not.
    */
-  private fun findDefaultFilePathFromProjectRoot(): String? {
+  private fun findTokensFileInProjectRoot(): String? {
     val projectBasePath = project.basePath ?: return null
     return LocalFileSystem.getInstance().refreshAndFindFileByPath(projectBasePath)
       ?.findChild(CC.File.Defaults)
@@ -147,7 +149,7 @@ internal class CCDefaultTokensService(private val project: Project) {
    *
    * @throws SchemaValidationException When the JSON object does not respect the schema
    */
-  private fun readDefaultsFromFile(filePath: String): JsonDefaults {
+  private fun readTokensFromFile(filePath: String): TokensModel {
     val path = FileSystems.getDefault().getPath(filePath)
     val jsonStr = path.bufferedReader().use(Reader::readText)
     return parseJsonStr(jsonStr)
@@ -156,10 +158,10 @@ internal class CCDefaultTokensService(private val project: Project) {
   /**
    * @throws SchemaValidationException When the JSON object does not respect the schema
    */
-  private fun parseJsonStr(jsonStr: String): JsonDefaults {
+  private fun parseJsonStr(jsonStr: String): TokensModel {
     // If the inputted JSON isn't valid, an exception is thrown.
     // The exception contains the validation errors which can be used to notify the user
-    defaultsSchema.validateJson(jsonStr)
+    tokensSchema.validateJson(jsonStr)
 
     val rootJsonObject = JSONObject(jsonStr)
     val commonScopes = buildScopes(rootJsonObject.optJSONObject("commonScopes") ?: JSONObject())
@@ -171,63 +173,63 @@ internal class CCDefaultTokensService(private val project: Project) {
       else -> error("Should never get here")
     }
 
-    return JsonDefaults(types = types, footerTypes = footerTypes)
+    return TokensModel(types = types, footerTypes = footerTypes)
   }
 
-  private fun buildTypes(jsonObject: JSONObject, commonScopes: List<JsonCommitScope>): Map<String, JsonCommitType> =
+  private fun buildTypes(jsonObject: JSONObject, commonScopes: List<CommitScopeModel>): Map<String, CommitTypeModel> =
     jsonObject.keySet().associateWith {
       val descriptor = jsonObject.getJSONObject(it)
       val description = descriptor.optString("description", "")
       val scopes = buildScopes(descriptor.optJSONObject("scopes") ?: JSONObject())
-      JsonCommitType(
+      CommitTypeModel(
         name = it,
         description = description,
         scopes = scopes + commonScopes,
       )
     }
 
-  private fun buildScopes(jsonObject: JSONObject): List<JsonCommitScope> =
+  private fun buildScopes(jsonObject: JSONObject): List<CommitScopeModel> =
     jsonObject.keySet().map {
       val descriptor = jsonObject.getJSONObject(it)
       val description = descriptor.optString("description", "")
-      JsonCommitScope(
+      CommitScopeModel(
         name = it,
         description = description,
       )
     }
 
-  private fun buildFooterTypes(jsonObject: JSONObject): Map<String, JsonCommitFooterType> =
+  private fun buildFooterTypes(jsonObject: JSONObject): Map<String, CommitFooterTypeModel> =
     jsonObject.keySet().associateWith {
       val descriptor = jsonObject.getJSONObject(it)
       val description = descriptor.optString("description", "")
       val values = buildFooterValues(descriptor.optJSONObject("values") ?: JSONObject())
-      JsonCommitFooterType(
+      CommitFooterTypeModel(
         name = it,
         description = description,
         values = values,
       )
     }
 
-  private fun buildFooterValues(jsonObject: JSONObject): List<JsonCommitFooterValue> =
+  private fun buildFooterValues(jsonObject: JSONObject): List<CommitFooterValueModel> =
     jsonObject.keySet().map {
       val descriptor = jsonObject.getJSONObject(it)
       val description = descriptor.optString("description", "")
-      JsonCommitFooterValue(
+      CommitFooterValueModel(
         name = it,
         description = description,
       )
     }
 
   // TODO(Edoardo): will have to remove it as point, as keeping footer values
   //  as an array does not make sense anymore
-  private fun buildFooterTypesArray(jsonArray: JSONArray): Map<String, JsonCommitFooterType> {
-    val map = LinkedHashMap<String, JsonCommitFooterType>()
+  private fun buildFooterTypesArray(jsonArray: JSONArray): Map<String, CommitFooterTypeModel> {
+    val map = LinkedHashMap<String, CommitFooterTypeModel>()
 
     for (i in 0..<jsonArray.length()) {
       val descriptor = jsonArray.getJSONObject(i)
       val name = descriptor.optString("name")
       val description = descriptor.optString("description", "")
-      map[name] = JsonCommitFooterType(
+      map[name] = CommitFooterTypeModel(
         name = name,
         description = description,
         values = emptyList(),
@@ -237,29 +239,29 @@ internal class CCDefaultTokensService(private val project: Project) {
     return map
   }
 
-  class JsonDefaults(
-    val types: Map<String, JsonCommitType>,
-    val footerTypes: Map<String, JsonCommitFooterType>,
+  class TokensModel(
+    val types: Map<String, CommitTypeModel>,
+    val footerTypes: Map<String, CommitFooterTypeModel>,
   )
 
-  class JsonCommitType(
+  class CommitTypeModel(
     val name: String,
     val description: String,
-    val scopes: List<JsonCommitScope>,
+    val scopes: List<CommitScopeModel>,
   )
 
-  class JsonCommitScope(
+  class CommitScopeModel(
     val name: String,
     val description: String,
   )
 
-  class JsonCommitFooterType(
+  class CommitFooterTypeModel(
     val name: String,
     val description: String,
-    val values: List<JsonCommitFooterValue>,
+    val values: List<CommitFooterValueModel>,
   )
 
-  class JsonCommitFooterValue(
+  class CommitFooterValueModel(
     val name: String,
     val description: String,
   )

src/main/kotlin/com/github/lppedd/cc/configuration/component/CoAuthorsDialog.kt

@@ -1,7 +1,7 @@
 package com.github.lppedd.cc.configuration.component
 
 import com.github.lppedd.cc.CCBundle
-import com.github.lppedd.cc.configuration.CCDefaultTokensService
+import com.github.lppedd.cc.configuration.CCTokensService
 import com.github.lppedd.cc.configuration.holders.CoAuthorsTableHolder
 import com.github.lppedd.cc.readableMessage
 import com.intellij.openapi.components.service
@@ -19,8 +19,8 @@ import javax.swing.JPanel
  * @author Edoardo Luppi
  */
 internal class CoAuthorsDialog(project: Project) : DialogWrapper(project) {
-  private val defaultsService = project.service<CCDefaultTokensService>()
-  private val coAuthorsTableHolder = CoAuthorsTableHolder(defaultsService)
+  private val tokensService = project.service<CCTokensService>()
+  private val coAuthorsTableHolder = CoAuthorsTableHolder(tokensService)
 
   init {
     init()
@@ -41,7 +41,7 @@ internal class CoAuthorsDialog(project: Project) : DialogWrapper(project) {
 
   override fun doOKAction() {
     try {
-      defaultsService.setCoAuthors(coAuthorsTableHolder.tableModel.coAuthors)
+      tokensService.setCoAuthors(coAuthorsTableHolder.tableModel.coAuthors)
       super.doOKAction()
     } catch (e: Exception) {
       setErrorText(CCBundle["cc.config.coAuthorsDialog.saveError", e.readableMessage()])