Merge Feature/1 collection assertions (#8)

* move readme to package directory

* move class files to package directory

* Move collection condition to dedicated file

* Move map conditions to dedicated file

* move scenario test to package directory

* Add collections and map condition empty unit tests

* replace assert/assume functions with synthetic vals

* Add assert/assume documentation

* inherit FailedAssumption from Exception not Throwable

* replace assume function with val

* Fix package and imports

* remove implied throwable

* Add statement evaluation function in statement scope

* create assert/assumeThat convenience functions

* rename statement definition file

* Add assertThat and assumeThat docs

* replace result condition with ResultStatements

* replace stringCondition with StringStatements

* replace collectionCondition with CollectionStatements

* replace NumberCondition with NumberStatements

* Move isIn and notIn condition functions to CollectionStatements

* update scenario test

* remove assume/assert properties

* remove unused statement scope

* Move object conditions to ObjectStatements

* optimize imports

* replace map conditions with map statements

* Replace Condition.and with statement combiner and function

* remove condition tests

* Add failureMessage separate from evaluation function in Statement subclasses

* Fix and with wrong failure message

* abstract shared behavior between assertThat and assumeThat

* Add statement unit test

* Copy multiplatform workflow

* publish only select packages to github packages

Author: TSampley

.github/workflows/distribute.yml

@@ -24,7 +24,9 @@ jobs:
           git push origin $versionString
       - name: Publish
         run: |
-          ./gradlew publishAllPublicationsToGitHubPackagesRepository \
+          ./gradlew publishKotlinMultiplatformPublicationToGitHubPackagesRepository \
+            publishJvmPublicationToGitHubPackagesRepository \
+            publishAndroidDebugPublicationToGitHubPackagesRepository \
+            publishAndroidReleasePublicationToGitHubPackagesRepository \
             -Pgithub.user=${{ secrets.BUILD_USER }} \
             -Pgithub.token=${{ secrets.BUILD_TOKEN }}
-

.github/workflows/main-pr-checks.yml

@@ -0,0 +1,59 @@
+name: Main PR Checks
+run-name: Verify `${{ github.head_ref }}` before merge to `main` by @${{ github.actor }}
+
+on:
+  pull_request:
+    types:
+      - opened        # initially opened
+      - reopened      # closed then opened again
+      - synchronize   # any changes pushed
+    branches:
+      - main
+    paths-ignore: # Only run checks on changes to code
+      - "**/docs/*"
+      - "**/README.md"
+
+jobs:
+  build-app-android:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Setup
+        uses: Pointyware/.github/.github/actions/checkout-java-gradle@b70bbae19637171d6cf9311f06a59f1c15e2598b
+      - name: Build Android
+        run: ./gradlew :assertions:assembleDebug :assertions:assembleRelease -Pgithub.user=${{ secrets.BUILD_USER }} -Pgithub.token=${{ secrets.BUILD_TOKEN }}
+      - name: Android Debug Unit Tests
+        run: ./gradlew :assertions:testDebugUnitTest -Pgithub.user=${{ secrets.BUILD_USER }} -Pgithub.token=${{ secrets.BUILD_TOKEN }}
+
+  build-app-ios:
+    if: github.event.pull_request.draft == false && false
+    runs-on: macos-14
+    steps:
+      - name: Setup
+        uses: Pointyware/.github/.github/actions/checkout-java-gradle@b70bbae19637171d6cf9311f06a59f1c15e2598b
+      - name: Build iOS
+        run: ./gradlew :assertions:iosX64Binaries -Pgithub.user=${{ secrets.BUILD_USER }} -Pgithub.token=${{ secrets.BUILD_TOKEN }}
+      - name: Test iOS
+        run: ./gradlew :assertions:iosX64Test -Pgithub.user=${{ secrets.BUILD_USER }} -Pgithub.token=${{ secrets.BUILD_TOKEN }}
+    
+  build-app-desktop:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Setup
+        uses: Pointyware/.github/.github/actions/checkout-java-gradle@b70bbae19637171d6cf9311f06a59f1c15e2598b
+      - name: Build Desktop
+        run: ./gradlew :assertions:assembleJvm -Pgithub.user=${{ secrets.BUILD_USER }} -Pgithub.token=${{ secrets.BUILD_TOKEN }}
+      - name: Test Desktop
+        run: ./gradlew :assertions:jvmTest -Pgithub.user=${{ secrets.BUILD_USER }} -Pgithub.token=${{ secrets.BUILD_TOKEN }}
+    
+  build-app-browser:
+    if: github.event.pull_request.draft == false && false
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Setup
+        uses: Pointyware/.github/.github/actions/checkout-java-gradle@b70bbae19637171d6cf9311f06a59f1c15e2598b
+      - name: Build Browser
+        run: ./gradlew :assertions:assembleBrowser -Pgithub.user=${{ secrets.BUILD_USER }} -Pgithub.token=${{ secrets.BUILD_TOKEN }}
+      - name: Test Browser
+        run: ./gradlew :assertions:jsTest -Pgithub.user=${{ secrets.BUILD_USER }} -Pgithub.token=${{ secrets.BUILD_TOKEN }}

assertions/src/commonMain/kotlin/Condition.kt

@@ -0,0 +1,59 @@
+package org.pointyware.kass.assertions
+
+import kotlin.test.Asserter
+import kotlin.test.asserter
+
+/**
+ * Represents a statement that can be evaluated against a subject. The statement also provides a
+ * [failureMessage] in case the evaluation returns false.
+ */
+interface Statement<T> {
+    fun evaluate(subject: T): Boolean
+    val failureMessage: String
+}
+
+/**
+ * Combines the receiver statement with [other] to create a new statement that evaluates both.
+ */
+fun <T> Statement<T>.and(other: Statement<T>) = object: Statement<T> {
+
+    override fun evaluate(subject: T): Boolean {
+        return this@and.evaluate(subject) && other.evaluate(subject)
+    }
+
+    override val failureMessage: String
+        get() = this@and.failureMessage + " or " + other.failureMessage
+}
+
+private inline fun <T> throwOnEvaluationFail(subject: T, statement: Statement<T>, asserter: Asserter) {
+    if (statement.evaluate(subject).not()) {
+        asserter.fail(statement.failureMessage)
+    }
+}
+
+/**
+ * Evaluates the given [statement] with the given [subject] and the default asserter.
+ */
+fun <T:Any?> assertThat(subject: T, statement: Statement<T>) {
+    throwOnEvaluationFail(subject, statement, asserter)
+}
+
+/**
+ * Evaluates the given [statement] with the given [subject] and a presumptuous asserter. When the
+ * statement fails, it will throw a [FailedAssumption].
+ */
+fun <T:Any?> assumeThat(subject: T, statement: Statement<T>) {
+    throwOnEvaluationFail(subject, statement, presumptuousAsserter)
+}
+
+private val presumptuousAsserter = object: Asserter {
+    override fun fail(message: String?): Nothing {
+        throw FailedAssumption("Assumption failed - $message", null)
+    }
+
+    override fun fail(message: String?, cause: Throwable?): Nothing {
+        throw FailedAssumption("Assumption failed - $message", cause)
+    }
+}
+
+class FailedAssumption(msg: String?, cause: Throwable?): Exception(msg, cause)

assertions/src/commonMain/kotlin/Statements.kt

@@ -0,0 +1,44 @@
+package org.pointyware.kass.assertions.collections
+
+import org.pointyware.kass.assertions.Statement
+
+/**
+ *
+ */
+object CollectionStatements {
+    fun <T> contains(item: T) = object: Statement<Collection<T>> {
+        override fun evaluate(subject: Collection<T>): Boolean {
+            return item in subject
+        }
+
+        override val failureMessage: String
+            get() = "The collection does not contain $item"
+    }
+
+    fun <T> doesNotContain(item: T) = object: Statement<Collection<T>> {
+        override fun evaluate(subject: Collection<T>): Boolean {
+            return item !in subject
+        }
+
+        override val failureMessage: String
+            get() = "The collection contains $item"
+    }
+
+    fun <T> isIn(items: Collection<T>) = object: Statement<T> {
+        override fun evaluate(subject: T): Boolean {
+            return subject in items
+        }
+
+        override val failureMessage: String
+            get() = "The item is not in $items"
+    }
+
+    fun <T> isNotIn(items: Collection<T>) = object: Statement<T> {
+        override fun evaluate(subject: T): Boolean {
+            return subject !in items
+        }
+
+        override val failureMessage: String
+            get() = "The subject is in $items"
+    }
+}

assertions/src/commonMain/kotlin/README.md renamed to assertions/src/commonMain/kotlin/org/pointyware/kass/assertions/README.md

@@ -0,0 +1,26 @@
+package org.pointyware.kass.assertions.collections
+
+import org.pointyware.kass.assertions.Statement
+
+/**
+ *
+ */
+object MapStatements {
+    fun <K, V> containsKey(key: K) = object: Statement<Map<K, V>> {
+        override fun evaluate(subject: Map<K, V>): Boolean {
+            return key in subject
+        }
+
+        override val failureMessage: String
+            get() = "The subject does not contain key $key"
+    }
+
+    fun <K, V> doesNotContainKey(key: K) = object: Statement<Map<K, V>> {
+        override fun evaluate(subject: Map<K, V>): Boolean {
+            return key !in subject
+        }
+
+        override val failureMessage: String
+            get() = "The subject contains key $key"
+    }
+}