Fix equality and hashcode in identifiable collections (#132)

* Fix equality amd hashcode in identifiable collections

* Bump version

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "sargon"
-version = "0.7.9"
+version = "0.7.10"
 edition = "2021"
 build = "build.rs"
 

jvm/sargon-android/src/main/java/com/radixdlt/sargon/extensions/Accounts.kt

@@ -2,9 +2,10 @@ package com.radixdlt.sargon.extensions
 
 import com.radixdlt.sargon.Account
 import com.radixdlt.sargon.AccountAddress
+import com.radixdlt.sargon.annotation.KoverIgnore
 
 class Accounts private constructor(
-    array: IdentifiedArray<AccountAddress, Account>
+    private val array: IdentifiedArray<AccountAddress, Account>
 ) : IdentifiedArray<AccountAddress, Account> by array {
 
     constructor(accounts: List<Account>) : this(
@@ -15,5 +16,26 @@ class Accounts private constructor(
     )
 
     constructor(vararg account: Account) : this(accounts = account.asList())
+
+    @KoverIgnore // False positive in javaClass check
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as Accounts
+
+        return array == other.array
+    }
+
+    override fun hashCode(): Int {
+        return array.hashCode()
+    }
+
+    @KoverIgnore
+    override fun toString(): String {
+        return "Accounts(array=$array)"
+    }
+
 }
 
+fun List<Account>.asIdentifiable() = Accounts(accounts = this)

jvm/sargon-android/src/main/java/com/radixdlt/sargon/extensions/AssetsExceptionList.kt

@@ -2,9 +2,10 @@ package com.radixdlt.sargon.extensions
 
 import com.radixdlt.sargon.AssetException
 import com.radixdlt.sargon.ResourceAddress
+import com.radixdlt.sargon.annotation.KoverIgnore
 
 class AssetsExceptionList private constructor(
-    array: IdentifiedArray<ResourceAddress, AssetException>
+    private val array: IdentifiedArray<ResourceAddress, AssetException>
 ) : IdentifiedArray<ResourceAddress, AssetException> by array {
 
     constructor(assetExceptions: List<AssetException>) : this(
@@ -17,4 +18,26 @@ class AssetsExceptionList private constructor(
     constructor(
         vararg assetException: AssetException
     ) : this(assetExceptions = assetException.asList())
-}
+
+    @KoverIgnore // False positive in javaClass check
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as AssetsExceptionList
+
+        return array == other.array
+    }
+
+    override fun hashCode(): Int {
+        return array.hashCode()
+    }
+
+    @KoverIgnore
+    override fun toString(): String {
+        return "AssetsExceptionList(array=$array)"
+    }
+
+}
+
+fun List<AssetException>.asIdentifiable() = AssetsExceptionList(assetExceptions = this)

jvm/sargon-android/src/main/java/com/radixdlt/sargon/extensions/AuthorizedDapps.kt

@@ -2,9 +2,10 @@ package com.radixdlt.sargon.extensions
 
 import com.radixdlt.sargon.AccountAddress
 import com.radixdlt.sargon.AuthorizedDapp
+import com.radixdlt.sargon.annotation.KoverIgnore
 
 class AuthorizedDapps private constructor(
-    array: IdentifiedArray<AccountAddress, AuthorizedDapp>
+    private val array: IdentifiedArray<AccountAddress, AuthorizedDapp>
 ) : IdentifiedArray<AccountAddress, AuthorizedDapp> by array {
 
     constructor(authorizedDapps: List<AuthorizedDapp>) : this(
@@ -17,4 +18,26 @@ class AuthorizedDapps private constructor(
     constructor(
         vararg authorizedDapp: AuthorizedDapp
     ) : this(authorizedDapps = authorizedDapp.asList())
-}
+
+    @KoverIgnore // False positive in javaClass check
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as AuthorizedDapps
+
+        return array == other.array
+    }
+
+    override fun hashCode(): Int {
+        return array.hashCode()
+    }
+
+    @KoverIgnore
+    override fun toString(): String {
+        return "AuthorizedDapps(array=$array)"
+    }
+
+}
+
+fun List<AuthorizedDapp>.asIdentifiable() = AuthorizedDapps(authorizedDapps = this)

jvm/sargon-android/src/main/java/com/radixdlt/sargon/extensions/DepositorsAllowList.kt

@@ -1,9 +1,10 @@
 package com.radixdlt.sargon.extensions
 
 import com.radixdlt.sargon.ResourceOrNonFungible
+import com.radixdlt.sargon.annotation.KoverIgnore
 
 class DepositorsAllowList private constructor(
-    array: IdentifiedArray<ResourceOrNonFungible, ResourceOrNonFungible>
+    private val array: IdentifiedArray<ResourceOrNonFungible, ResourceOrNonFungible>
 ) : IdentifiedArray<ResourceOrNonFungible, ResourceOrNonFungible> by array {
 
     constructor(resourcesOrNonFungibles: List<ResourceOrNonFungible>) : this(
@@ -16,4 +17,27 @@ class DepositorsAllowList private constructor(
     constructor(vararg resourceOrNonFungible: ResourceOrNonFungible) : this(
         resourcesOrNonFungibles = resourceOrNonFungible.asList()
     )
-}
+
+    @KoverIgnore // False positive in javaClass check
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as DepositorsAllowList
+
+        return array == other.array
+    }
+
+    override fun hashCode(): Int {
+        return array.hashCode()
+    }
+
+    @KoverIgnore
+    override fun toString(): String {
+        return "DepositorsAllowList(array=$array)"
+    }
+
+}
+
+fun List<ResourceOrNonFungible>.asIdentifiable() =
+    DepositorsAllowList(resourcesOrNonFungibles = this)

jvm/sargon-android/src/main/java/com/radixdlt/sargon/extensions/EntityFlags.kt

@@ -1,9 +1,10 @@
 package com.radixdlt.sargon.extensions
 
 import com.radixdlt.sargon.EntityFlag
+import com.radixdlt.sargon.annotation.KoverIgnore
 
 class EntityFlags private constructor(
-    array: IdentifiedArray<EntityFlag, EntityFlag>
+    private val array: IdentifiedArray<EntityFlag, EntityFlag>
 ) : IdentifiedArray<EntityFlag, EntityFlag> by array {
 
     constructor(entityFlags: List<EntityFlag>) : this(
@@ -15,5 +16,25 @@ class EntityFlags private constructor(
 
     constructor(vararg entityFlag: EntityFlag) : this(entityFlags = entityFlag.asList())
 
-    companion object
-}
+    @KoverIgnore // False positive in javaClass check
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as EntityFlags
+
+        return array == other.array
+    }
+
+    override fun hashCode(): Int {
+        return array.hashCode()
+    }
+
+    @KoverIgnore
+    override fun toString(): String {
+        return "EntityFlags(array=$array)"
+    }
+
+}
+
+fun List<EntityFlag>.asIdentifiable() = EntityFlags(entityFlags = this)

jvm/sargon-android/src/main/java/com/radixdlt/sargon/extensions/FactorSources.kt

@@ -2,9 +2,10 @@ package com.radixdlt.sargon.extensions
 
 import com.radixdlt.sargon.FactorSource
 import com.radixdlt.sargon.FactorSourceId
+import com.radixdlt.sargon.annotation.KoverIgnore
 
 class FactorSources private constructor(
-    array: IdentifiedArray<FactorSourceId, FactorSource>
+    private val array: IdentifiedArray<FactorSourceId, FactorSource>
 ) : IdentifiedArray<FactorSourceId, FactorSource> by array {
 
     constructor(factorSources: List<FactorSource>) : this(
@@ -17,5 +18,26 @@ class FactorSources private constructor(
     constructor(vararg factorSource: FactorSource) : this(
         factorSources = factorSource.asList()
     )
+
+    @KoverIgnore // False positive in javaClass check
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as FactorSources
+
+        return array == other.array
+    }
+
+    override fun hashCode(): Int {
+        return array.hashCode()
+    }
+
+    @KoverIgnore
+    override fun toString(): String {
+        return "FactorSources(array=$array)"
+    }
+
 }
 
+fun List<FactorSource>.asIdentifiable() = FactorSources(factorSources = this)

jvm/sargon-android/src/main/java/com/radixdlt/sargon/extensions/Gateways.kt

@@ -2,9 +2,10 @@ package com.radixdlt.sargon.extensions
 
 import com.radixdlt.sargon.Gateway
 import com.radixdlt.sargon.Url
+import com.radixdlt.sargon.annotation.KoverIgnore
 
 class Gateways private constructor(
-    array: IdentifiedArray<Url, Gateway>
+    private val array: IdentifiedArray<Url, Gateway>
 ) : IdentifiedArray<Url, Gateway> by array {
 
     constructor(gateways: List<Gateway>) : this(
@@ -15,4 +16,27 @@ class Gateways private constructor(
     )
 
     constructor(vararg gateway: Gateway) : this(gateways = gateway.asList())
+
+    @KoverIgnore // False positive in javaClass check
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as Gateways
+
+        return array == other.array
+    }
+
+    override fun hashCode(): Int {
+        return array.hashCode()
+    }
+
+    @KoverIgnore
+    override fun toString(): String {
+        return "Gateways(array=$array)"
+    }
+
 }
+
+fun List<Gateway>.asIdentifiable() = Gateways(gateways = this)
+

jvm/sargon-android/src/main/java/com/radixdlt/sargon/extensions/IdentifiedArray.kt

@@ -1,6 +1,8 @@
 package com.radixdlt.sargon.extensions
 
-internal interface IdentifiedArray<Identifier, Element> {
+import com.radixdlt.sargon.annotation.KoverIgnore
+
+interface IdentifiedArray<Identifier, Element> {
     val size: Int
 
     fun asList(): List<Element>
@@ -17,7 +19,15 @@ internal interface IdentifiedArray<Identifier, Element> {
 
     operator fun get(index: Int): Element
 
+    operator fun contains(element: Element): Boolean
+
     fun removeBy(identifier: Identifier): IdentifiedArray<Identifier, Element>
+
+    override fun equals(other: Any?): Boolean
+
+    override fun hashCode(): Int
+
+    override fun toString(): String
 }
 
 
@@ -42,6 +52,8 @@ internal class IdentifiedArrayImpl<Identifier, Element>(
 
     override fun get(index: Int): Element = inner.values.elementAt(index)
 
+    override fun contains(element: Element): Boolean = inner.contains(identifier(element))
+
     override fun append(element: Element) = apply {
         val identifier = identifier(element)
         if (!inner.contains(identifier)) {
@@ -82,4 +94,23 @@ internal class IdentifiedArrayImpl<Identifier, Element>(
     override fun removeBy(identifier: Identifier) = apply {
         inner.remove(identifier)
     }
+
+    @KoverIgnore
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+
+        return inner == (other as? IdentifiedArrayImpl<*, *>)?.inner
+    }
+
+    @KoverIgnore
+    override fun hashCode(): Int {
+        return inner.hashCode()
+    }
+
+    @KoverIgnore
+    override fun toString(): String {
+        return "IdentifiedArrayImpl(inner=$inner)"
+    }
+
+
 }