Refactor - [:core:logs] Apply & Fix Ktlint & Detekt Rules

Jira tasks - [MM-59](https://mifosforge.jira.com/browse/MM-59)
openMF · Aug 27, 2024 · cacc532 · cacc532
1 parent 400a334
commit cacc532
Show file tree

Hide file tree

Showing 8 changed files with 59 additions and 48 deletions.
diff --git a/core/logs/build.gradle.kts b/core/logs/build.gradle.kts
@@ -1,3 +1,12 @@
+/*
+ * Copyright 2024 Mifos Initiative
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * See https://github.com/openMF/mobile-mobile/blob/master/LICENSE.md
+ */
 plugins {
     alias(libs.plugins.mifos.android.library)
     alias(libs.plugins.mifos.android.library.compose)

diff --git a/core/logs/src/androidTest/java/org/mifos/mobile/core/logs/ExampleInstrumentedTest.kt b/core/logs/src/androidTest/java/org/mifos/mobile/core/logs/ExampleInstrumentedTest.kt
diff --git a/core/logs/src/main/AndroidManifest.xml b/core/logs/src/main/AndroidManifest.xml
@@ -1,4 +1,13 @@
 <?xml version="1.0" encoding="utf-8"?>
-<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+<!--
+    Copyright 2024 Mifos Initiative
+
+    This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+    If a copy of the MPL was not distributed with this file,
+    You can obtain one at https://mozilla.org/MPL/2.0/.
+
+    See https://github.com/openMF/mobile-mobile/blob/master/LICENSE.md
+-->
+<manifest>
 
 </manifest>
diff --git a/core/logs/src/main/java/org/mifos/mobile/core/logs/AnalyticsEvent.kt b/core/logs/src/main/java/org/mifos/mobile/core/logs/AnalyticsEvent.kt
@@ -1,3 +1,12 @@
+/*
+ * Copyright 2024 Mifos Initiative
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * See https://github.com/openMF/mobile-mobile/blob/master/LICENSE.md
+ */
 package org.mifos.mobile.core.logs
 
 /**
@@ -16,10 +25,9 @@ data class AnalyticsEvent(
 ) {
     // Standard analytics types.
     enum class AnalyticsEventTypes(val type: String) {
-        EXCEPTION(type = "Exception")
+        EXCEPTION(type = "Exception"),
     }
 
-
     /**
      * A key-value pair used to supply extra context to an analytics event.
      *
@@ -33,9 +41,7 @@ data class AnalyticsEvent(
     data class Param(val key: String, val value: String)
 
     // Standard parameter keys.
-    class ParamKeys {
-        companion object {
-            const val SCREEN_NAME = "screen_name"
-        }
+    object ParamKeys {
+        const val SCREEN_NAME = "screen_name"
     }
 }
diff --git a/core/logs/src/main/java/org/mifos/mobile/core/logs/AnalyticsHelper.kt b/core/logs/src/main/java/org/mifos/mobile/core/logs/AnalyticsHelper.kt
@@ -1,10 +1,18 @@
+/*
+ * Copyright 2024 Mifos Initiative
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * See https://github.com/openMF/mobile-mobile/blob/master/LICENSE.md
+ */
 package org.mifos.mobile.core.logs
 
-
 /**
  * Interface for logging analytics events. See `FirebaseAnalyticsHelper` and
  * `StubAnalyticsHelper` for implementations.
  */
 interface AnalyticsHelper {
     fun logEvent(event: AnalyticsEvent)
-}
+}
diff --git a/core/logs/src/main/java/org/mifos/mobile/core/logs/di/AnalyticsModule.kt b/core/logs/src/main/java/org/mifos/mobile/core/logs/di/AnalyticsModule.kt
@@ -1,3 +1,12 @@
+/*
+ * Copyright 2024 Mifos Initiative
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * See https://github.com/openMF/mobile-mobile/blob/master/LICENSE.md
+ */
 package org.mifos.mobile.core.logs.di
 
 import com.google.firebase.analytics.FirebaseAnalytics

diff --git a/core/logs/src/main/java/org/mifos/mobile/core/logs/di/FirebaseAnalyticsHelper.kt b/core/logs/src/main/java/org/mifos/mobile/core/logs/di/FirebaseAnalyticsHelper.kt
@@ -1,3 +1,12 @@
+/*
+ * Copyright 2024 Mifos Initiative
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * See https://github.com/openMF/mobile-mobile/blob/master/LICENSE.md
+ */
 package org.mifos.mobile.core.logs.di
 
 import com.google.firebase.analytics.FirebaseAnalytics

diff --git a/core/logs/src/test/java/org/mifos/mobile/core/logs/ExampleUnitTest.kt b/core/logs/src/test/java/org/mifos/mobile/core/logs/ExampleUnitTest.kt