Merge pull request #82 from yusufugurozbek/81-disabling-updated-data-source-url-notification

Make it possible to enable/disable Updated data source URL notifications

Author: yusufugurozbek

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Testcontainers Port Updater Changelog
 
 ## [Unreleased]
+- Bump dependencies to their latest versions
+- Make it possible to enable/disable 'Updated data source URL' notifications via plugin settings
 
 ## [0.1.2]
 - Improve regex pattern
@@ -42,4 +44,4 @@
 
 ## [0.0.2]
 ### Added
-- Create the plugin
+- Create the plugin

README.md

@@ -40,6 +40,14 @@ Example log;
 
 After covering these 2 requirements, the plugin automatically will catch the log and update the matched data source URL with the Testcontainers' one.
 
+### Plugin Settings
+
+To adjust Testcontainers Port Updater plugin settings, open IntelliJ preferences and navigate to **Tools | Testcontainers Port Updater**.
+
+Currently, there is only one setting is possible:
+
+- To enable/disable 'Updated data source URL' notifications, check/uncheck "Do you want to get notified from Testcontainers Port Updater?" option.
+
 ---
 Plugin based on the [IntelliJ Platform Plugin Template][template].
 

src/main/kotlin/com/github/yusufugurozbek/testcontainers/port/updater/impl/DatasourceUpdaterImpl.kt

@@ -4,6 +4,7 @@ import com.github.yusufugurozbek.testcontainers.port.updater.DatasourceUrlExtrac
 import com.github.yusufugurozbek.testcontainers.port.updater.api.DatasourceUpdater
 import com.github.yusufugurozbek.testcontainers.port.updater.common.TpuNotifier
 import com.github.yusufugurozbek.testcontainers.port.updater.common.equalsIgnoringPort
+import com.github.yusufugurozbek.testcontainers.port.updater.settings.TpuSettingsState
 import com.intellij.database.dataSource.LocalDataSource
 import com.intellij.database.psi.DbPsiFacade
 import com.intellij.database.util.DbImplUtil
@@ -24,6 +25,8 @@ class DatasourceUpdaterImpl(var project: Project) : DatasourceUpdater {
 
     private fun update(localDataSource: LocalDataSource, newUrl: String) {
         localDataSource.url = newUrl
-        TpuNotifier.notify(project, "Updated data source URL: $newUrl")
+        if (TpuSettingsState.instance.isNotificationsEnabled) {
+            TpuNotifier.notify(project, "Updated data source URL: $newUrl")
+        }
     }
 }

src/main/kotlin/com/github/yusufugurozbek/testcontainers/port/updater/settings/TpuSettingsComponent.kt

@@ -0,0 +1,27 @@
+package com.github.yusufugurozbek.testcontainers.port.updater.settings
+
+import com.github.yusufugurozbek.testcontainers.port.updater.common.TpuBundle
+import com.intellij.ui.components.JBCheckBox
+import com.intellij.util.ui.FormBuilder
+import javax.swing.JComponent
+import javax.swing.JPanel
+
+class TpuSettingsComponent {
+    val panel: JPanel
+    private val isNotificationsEnabledCheckbox = JBCheckBox(TpuBundle.message("settings.isNotificationsEnabledText"))
+
+    init {
+        panel = FormBuilder.createFormBuilder()
+            .addComponent(isNotificationsEnabledCheckbox, 1)
+            .addComponentFillVertically(JPanel(), 0)
+            .panel
+    }
+
+    val preferredFocusedComponent: JComponent
+        get() = isNotificationsEnabledCheckbox
+    var isNotificationsEnabled: Boolean
+        get() = isNotificationsEnabledCheckbox.isSelected
+        set(value) {
+            isNotificationsEnabledCheckbox.isSelected = value
+        }
+}

src/main/kotlin/com/github/yusufugurozbek/testcontainers/port/updater/settings/TpuSettingsConfigurable.kt

@@ -0,0 +1,42 @@
+package com.github.yusufugurozbek.testcontainers.port.updater.settings
+
+import com.github.yusufugurozbek.testcontainers.port.updater.common.TpuBundle
+import com.intellij.openapi.options.Configurable
+import org.jetbrains.annotations.Nls
+import javax.swing.JComponent
+
+class TpuSettingsConfigurable : Configurable {
+    private var settingsComponent: TpuSettingsComponent? = null
+
+    override fun getDisplayName(): @Nls(capitalization = Nls.Capitalization.Title) String {
+        return TpuBundle.message("name")
+    }
+
+    override fun getPreferredFocusedComponent(): JComponent {
+        return settingsComponent!!.preferredFocusedComponent
+    }
+
+    override fun createComponent(): JComponent {
+        settingsComponent = TpuSettingsComponent()
+        return settingsComponent!!.panel
+    }
+
+    override fun isModified(): Boolean {
+        val settings: TpuSettingsState = TpuSettingsState.instance
+        return settingsComponent!!.isNotificationsEnabled != settings.isNotificationsEnabled
+    }
+
+    override fun apply() {
+        val settings: TpuSettingsState = TpuSettingsState.instance
+        settings.isNotificationsEnabled = settingsComponent!!.isNotificationsEnabled
+    }
+
+    override fun reset() {
+        val settings: TpuSettingsState = TpuSettingsState.instance
+        settingsComponent!!.isNotificationsEnabled = settings.isNotificationsEnabled
+    }
+
+    override fun disposeUIResources() {
+        settingsComponent = null
+    }
+}

src/main/kotlin/com/github/yusufugurozbek/testcontainers/port/updater/settings/TpuSettingsState.kt

@@ -0,0 +1,28 @@
+package com.github.yusufugurozbek.testcontainers.port.updater.settings
+
+import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.components.PersistentStateComponent
+import com.intellij.openapi.components.State
+import com.intellij.openapi.components.Storage
+import com.intellij.util.xmlb.XmlSerializerUtil
+
+@State(
+    name = "com.github.yusufugurozbek.testcontainers.port.updater.settings.AppSettingsState",
+    storages = [Storage("TestcontainersPortUpdaterPlugin.xml")]
+)
+class TpuSettingsState : PersistentStateComponent<TpuSettingsState?> {
+    var isNotificationsEnabled = true
+
+    override fun getState(): TpuSettingsState {
+        return this
+    }
+
+    override fun loadState(state: TpuSettingsState) {
+        XmlSerializerUtil.copyBean(state, this)
+    }
+
+    companion object {
+        val instance: TpuSettingsState
+            get() = ApplicationManager.getApplication().getService(TpuSettingsState::class.java)
+    }
+}

src/main/resources/META-INF/plugin.xml

@@ -15,5 +15,13 @@
         <notificationGroup id="Testcontainers Port Updater" displayType="BALLOON"/>
         <consoleFilterProvider
                 implementation="com.github.yusufugurozbek.testcontainers.port.updater.impl.ConsoleFilterProviderImpl"/>
+        <applicationConfigurable
+                id="com.github.yusufugurozbek.testcontainers.port.updater.settings.TpuSettingsConfigurable"
+                parentId="tools"
+                instance="com.github.yusufugurozbek.testcontainers.port.updater.settings.TpuSettingsConfigurable"
+                bundle="messages.TpuBundle"
+                key="name"/>
+        <applicationService
+                serviceImplementation="com.github.yusufugurozbek.testcontainers.port.updater.settings.TpuSettingsState"/>
     </extensions>
 </idea-plugin>

src/main/resources/messages/TpuBundle.properties

@@ -1 +1,2 @@
 name=Testcontainers Port Updater
+settings.isNotificationsEnabledText=Do you want to get notified from Testcontainers Port Updater?