Separate Scheme into State and Scheme

...once again. This time to allow TemplateList to be a State but not a Scheme.

Author: fwdekker

build.gradle.kts

@@ -33,10 +33,9 @@ dependencies {
     implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
     api("org.jetbrains.kotlin:kotlin-reflect")
 
-    testImplementation("com.nhaarman.mockitokotlin2:mockito-kotlin:${properties("mockitoKotlinVersion")}")
     testImplementation("org.assertj:assertj-core:${properties("assertjVersion")}")
     testImplementation("org.assertj:assertj-swing-junit:${properties("assertjSwingVersion")}")
-    testImplementation("org.junit.platform:junit-platform-runner:${properties("junitRunnerVersion")}")
+    testRuntimeOnly("org.junit.platform:junit-platform-runner:${properties("junitRunnerVersion")}")
     testImplementation("org.junit.jupiter:junit-jupiter-api:${properties("junitVersion")}")
     testImplementation("org.junit.jupiter:junit-jupiter-engine:${properties("junitVersion")}")
     testImplementation("org.junit.vintage:junit-vintage-engine:${properties("junitVersion")}")

gradle.properties

@@ -27,7 +27,6 @@ emojiVersion          = 5.1.1
 jacocoVersion         = 0.8.7
 junitVersion          = 5.7.2
 junitRunnerVersion    = 1.7.2
-mockitoKotlinVersion  = 2.2.0
 spekVersion           = 2.0.15
 uuidGeneratorVersion  = 3.3.0
 

src/main/kotlin/com/fwdekker/randomness/Scheme.kt

@@ -1,40 +1,26 @@
 package com.fwdekker.randomness
 
 import com.fwdekker.randomness.array.ArraySchemeDecorator
-import com.intellij.util.xmlb.XmlSerializerUtil
 import com.intellij.util.xmlb.annotations.Transient
-import icons.RandomnessIcons
 import javax.swing.Icon
 import kotlin.random.Random
 
 
 /**
- * A scheme is a configurable random number generator.
+ * A scheme is a [State] that is also a configurable random number generator.
  *
  * Schemes can additionally be given [SchemeDecorator]s that extend their functionality.
  */
-abstract class Scheme {
+abstract class Scheme : State() {
     /**
      * Settings that determine whether the output should be an array of values.
      */
     abstract val decorator: ArraySchemeDecorator?
 
     /**
-     * The name of the scheme as shown to the user.
+     * The icon for this scheme; depends on whether its array decorator is enabled.
      */
-    abstract val name: String
-
-    /**
-     * The icons that represent schemes of this type.
-     */
-    @Transient
-    open val icons: RandomnessIcons? = null
-
-    /**
-     * The icon that represents this scheme instance.
-     */
-    @get:Transient
-    open val icon: Icon?
+    override val icon: Icon?
         get() =
             if (decorator?.enabled == true) icons?.Array
             else icons?.Base
@@ -78,42 +64,7 @@ abstract class Scheme {
     abstract fun generateUndecoratedStrings(count: Int = 1): List<String>
 
 
-    /**
-     * Validates the scheme, and indicates whether and why it is invalid.
-     *
-     * @return `null` if the scheme is valid, or a string explaining why the scheme is invalid
-     */
-    open fun doValidate(): String? = null
-
-    /**
-     * Copies the given scheme into this scheme.
-     *
-     * Works by copying all references in a [deepCopy] of [scheme] into `this`. Note that fields marked with [Transient]
-     * will be shallow-copied.
-     *
-     * @param scheme the scheme to copy into this scheme; should be a subclass of this scheme
-     */
-    fun copyFrom(scheme: Scheme) = XmlSerializerUtil.copyBean(scheme.deepCopy(), this)
-
-    /**
-     * Returns a deep copy of this scheme.
-     *
-     * Fields marked with [Transient] will be shallow-copied.
-     *
-     * @return a deep copy of this scheme
-     */
-    abstract fun deepCopy(): Scheme
-
-
-    /**
-     * Holds constants.
-     */
-    companion object {
-        /**
-         * The default value of the [name] field.
-         */
-        const val DEFAULT_NAME: String = "Unnamed scheme"
-    }
+    abstract override fun deepCopy(): Scheme
 }
 
 /**

src/main/kotlin/com/fwdekker/randomness/SchemeEditor.kt

@@ -6,14 +6,14 @@ import javax.swing.JComponent
 
 
 /**
- * Tells IntelliJ how to use a [SchemeEditor] in the settings dialog.
+ * Tells IntelliJ how to use a [StateEditor] in the settings dialog.
  */
 @Suppress("LateinitUsage") // `createComponent` is invoked before any of the other methods
 abstract class SettingsConfigurable : Configurable {
     /**
      * The user interface for changing the settings, displayed in IntelliJ's settings window.
      */
-    lateinit var editor: SchemeEditor<*> private set
+    lateinit var editor: StateEditor<*> private set
 
 
     /**
@@ -34,7 +34,7 @@ abstract class SettingsConfigurable : Configurable {
         if (validationInfo != null)
             throw ConfigurationException(validationInfo, "Failed to save settings")
 
-        editor.applyScheme()
+        editor.applyState()
     }
 
     /**
@@ -59,5 +59,5 @@ abstract class SettingsConfigurable : Configurable {
      *
      * @return a new editor
      */
-    abstract fun createEditor(): SchemeEditor<*>
+    abstract fun createEditor(): StateEditor<*>
 }

src/main/kotlin/com/fwdekker/randomness/SettingsConfigurable.kt

@@ -0,0 +1,68 @@
+package com.fwdekker.randomness
+
+import com.intellij.util.xmlb.XmlSerializerUtil
+import com.intellij.util.xmlb.annotations.Transient
+import icons.RandomnessIcons
+import javax.swing.Icon
+
+
+/**
+ * A state holds variables that can be configured.
+ */
+abstract class State {
+    /**
+     * The name of the scheme as shown to the user.
+     */
+    abstract val name: String
+
+    /**
+     * The icons that represent schemes of this type.
+     */
+    @Transient
+    open val icons: RandomnessIcons? = null
+
+    /**
+     * The icon that represents this scheme instance.
+     */
+    @get:Transient
+    open val icon: Icon?
+        get() = icons?.Base
+
+
+    /**
+     * Validates the scheme, and indicates whether and why it is invalid.
+     *
+     * @return `null` if the scheme is valid, or a string explaining why the scheme is invalid
+     */
+    open fun doValidate(): String? = null
+
+    /**
+     * Copies the given scheme into this scheme.
+     *
+     * Works by copying all references in a [deepCopy] of [scheme] into `this`. Note that fields marked with [Transient]
+     * will be shallow-copied.
+     *
+     * @param scheme the scheme to copy into this scheme; should be a subclass of this scheme
+     */
+    fun copyFrom(scheme: State) = XmlSerializerUtil.copyBean(scheme.deepCopy(), this)
+
+    /**
+     * Returns a deep copy of this scheme.
+     *
+     * Fields marked with [Transient] will be shallow-copied.
+     *
+     * @return a deep copy of this scheme
+     */
+    abstract fun deepCopy(): State
+
+
+    /**
+     * Holds constants.
+     */
+    companion object {
+        /**
+         * The default value of the [name] field.
+         */
+        const val DEFAULT_NAME: String = "Unnamed scheme"
+    }
+}

src/main/kotlin/com/fwdekker/randomness/State.kt

@@ -0,0 +1,77 @@
+package com.fwdekker.randomness
+
+import javax.swing.JPanel
+
+
+/**
+ * A component that can be used to edit a [State].
+ *
+ * The editor's state is initially read from [originalState]. Changes in the editor are written into [originalState]
+ * when they are applied using [applyState].
+ *
+ * @param S the type of state that is edited; should be a self-reference
+ * @property originalState the state object to write changes into
+ */
+abstract class StateEditor<S : State>(val originalState: S) {
+    /**
+     * The root component of the editor.
+     */
+    abstract val rootComponent: JPanel
+
+
+    /**
+     * Loads the given state into the editor and into [originalState].
+     *
+     * @param state the state to load
+     */
+    open fun loadState(state: S = originalState) {
+        originalState.copyFrom(state)
+    }
+
+    /**
+     * Returns the editor's current state, including potentially unsaved changes.
+     *
+     * @return the editor's current state, including potentially unsaved changes
+     */
+    abstract fun readState(): S
+
+    /**
+     * Saves the editor's state into [originalState].
+     *
+     * Does nothing if and only if [isModified] returns false.
+     */
+    fun applyState() = originalState.copyFrom(readState())
+
+
+    /**
+     * Returns true if and only if the editor contains modifications relative to the last saved state.
+     *
+     * Override this method if the default equals method of [S] is not sufficient to detect changes.
+     */
+    open fun isModified() = originalState != readState()
+
+    /**
+     * Resets the editor's state to the last saved state.
+     *
+     * Does nothing if and only if [isModified] return false.
+     */
+    open fun reset() = loadState(originalState)
+
+    /**
+     * Validates the state of the editor, i.e. of [readState], and indicates whether and why it is invalid.
+     *
+     * @return `null` if the state is valid, or a string explaining why the state is invalid
+     */
+    open fun doValidate(): String? = readState().doValidate()
+
+
+    /**
+     * Adds a listener that is invoked whenever the editor's state is modified.
+     *
+     * The editor's state is defined by [readState], such that this method is triggered when a change occurs such that
+     * [readState] returns a value that is non-equal to the value before the change was made.
+     *
+     * @param listener the listener that is invoked
+     */
+    abstract fun addChangeListener(listener: () -> Unit)
+}