🎉 Initial commit

Author: Peter Bryant

.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: Test
+on:
+  pull_request:
+  push:
+    branches:
+      - develop
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build
+        run: ./gradlew build

.gitignore

@@ -0,0 +1,15 @@
+*.iml
+.gradle
+/local.properties
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+local.properties

.idea/.gitignore

@@ -0,0 +1,6 @@
+# Kotlin Bloc
+
+An implementation of
+the [Bloc pattern](https://www.didierboelens.com/2018/08/reactive-programming---streams---bloc) for
+Kotlin and Jetpack Compose.
+

.idea/.name

@@ -0,0 +1,32 @@
+buildscript {
+    ext {
+        kotlin_version = '1.5.21'
+        compose_version = '1.0.2'
+
+    }
+    repositories {
+        google()
+        mavenCentral()
+        maven {
+            url "https://plugins.gradle.org/m2/"
+        }
+    }
+    dependencies {
+        classpath "com.android.tools.build:gradle:7.0.2"
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+        classpath 'org.jlleitschuh.gradle:ktlint-gradle:10.2.0'
+        classpath "org.jetbrains.dokka:dokka-gradle-plugin:1.5.30"
+    }
+}
+
+plugins {
+    id("org.jetbrains.dokka") version "1.5.30"
+}
+
+subprojects {
+    apply plugin: 'org.jlleitschuh.gradle.ktlint'
+}
+
+task clean(type: Delete) {
+    delete rootProject.buildDir
+}

.idea/compiler.xml

@@ -0,0 +1 @@
+/build

.idea/deploymentTargetDropDown.xml

@@ -0,0 +1,96 @@
+plugins {
+    id 'com.android.library'
+    id 'kotlin-android'
+    id 'org.jetbrains.dokka'
+    id 'maven-publish'
+}
+
+publishing {
+    publications {
+        release(MavenPublication) {
+            groupId = "com.ptrbrynt.kotlin-bloc"
+            artifactId = "compose"
+        }
+    }
+}
+
+android {
+    compileSdk 30
+
+    defaultConfig {
+        minSdk 21
+        targetSdk 30
+        versionCode 1
+        versionName "1.0"
+
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+        consumerProguardFiles "consumer-rules.pro"
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+    }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = '1.8'
+    }
+
+    packagingOptions {
+        resources {
+            excludes += '/META-INF/{AL2.0,LGPL2.1}'
+        }
+    }
+
+    buildFeatures {
+        compose true
+    }
+
+    composeOptions {
+        kotlinCompilerExtensionVersion compose_version
+    }
+
+    testOptions {
+        unitTests {
+            includeAndroidResources = true
+        }
+    }
+}
+
+ktlint {
+    android = true
+}
+
+dependencies {
+    implementation 'androidx.core:core-ktx:1.6.0'
+    implementation 'androidx.appcompat:appcompat:1.3.1'
+    implementation 'com.google.android.material:material:1.4.0'
+
+    implementation "androidx.compose.ui:ui:$compose_version"
+    api project(path: ':core')
+
+    testImplementation 'junit:junit:4.13.2'
+    testImplementation 'org.robolectric:robolectric:4.6.1'
+
+    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
+
+    testImplementation "androidx.compose.material:material:$compose_version"
+    testImplementation "androidx.compose.ui:ui-test-junit4:$compose_version"
+
+    debugImplementation "androidx.compose.ui:ui-test-manifest:$compose_version"
+}
+
+gradle.taskGraph.useFilter { task ->
+    if (task.name.startsWith("test") && task.name.contains("ReleaseUnitTest")) {
+        return false;
+    }
+    return true;
+}

.idea/gradle.xml

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest package="com.ptrbrynt.kotlin_bloc.compose" />

.idea/misc.xml

@@ -0,0 +1,40 @@
+package com.ptrbrynt.kotlin_bloc.compose
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.collectAsState
+import androidx.compose.runtime.getValue
+import com.ptrbrynt.kotlin_bloc.core.BlocBase
+import kotlinx.coroutines.flow.filter
+
+/**
+ * [BlocComposer] handles re-composition of its [content] in response to new [State]s.
+ *
+ * Please use [BlocListener] if you want to *do* anything in response to [State] changes
+ * e.g. display a Snackbar.
+ *
+ * ```kotlin
+ * BlocBuilder(myBloc) { state ->
+ *   // Add your composables here
+ * }
+ * ```
+ *
+ * An optional [composeWhen] can be implemented for more granular control over
+ * how often [BlocComposer] re-composes.
+ * [composeWhen] will be invoked whenever the [bloc] state changes.
+ * [composeWhen] is optional and, when omitted, will default to `true`.
+ *
+ * @param bloc The bloc or cubit that the [BlocComposer] will interact with.
+ * @param content The composable function which is re-composed on each new [bloc] state.
+ * @param composeWhen Provides more granular control over how often [BlocComposer] re-composes.
+ * @see BlocListener
+ */
+@Composable
+fun <B : BlocBase<State>, State> BlocComposer(
+    bloc: B,
+    composeWhen: (State) -> Boolean = { true },
+    content: @Composable (State) -> Unit,
+) {
+    val state by bloc.stateFlow.filter { composeWhen(it) }.collectAsState(initial = bloc.state)
+
+    content(state)
+}

README.md

@@ -0,0 +1,48 @@
+package com.ptrbrynt.kotlin_bloc.compose
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.collectAsState
+import androidx.compose.runtime.getValue
+import com.ptrbrynt.kotlin_bloc.core.BlocBase
+import kotlinx.coroutines.flow.filter
+
+/**
+ * Takes a [bloc] and an [onState] callback and invokes [onState] in response to `state` changes
+ * in the [bloc].
+ *
+ * It should be used for side-effects resulting from new `state`s being emitted by the [bloc] e.g.
+ * navigation, showing a snackbar etc.
+ *
+ * If you want to build composables in response to new states, use [BlocComposer]
+ *
+ * ```kotlin
+ * BlocListener(bloc) { state ->
+ *   // React to the new state here
+ * }
+ * ```
+ *
+ * An optional [reactWhen] can be implemented for more granular control over when [onState] is
+ * called.
+ * [reactWhen] will be invoked on every [bloc] state change.
+ * [reactWhen] is optional and, when omitted, will default to `true`.
+ *
+ * @param bloc The bloc or cubit that the [BlocListener] will interact with.
+ * @param onState The callback function which will be invoked whenever a new `state` is emitted by the [bloc].
+ * @param reactWhen Provides more granular control over when [onState] is invoked.
+ * @see BlocComposer
+ */
+@Composable
+fun <B : BlocBase<State>, State> BlocListener(
+    bloc: B,
+    reactWhen: (State) -> Boolean = { true },
+    onState: suspend (State) -> Unit,
+) {
+    val state by bloc.stateFlow.filter { reactWhen(it) }.collectAsState(initial = null)
+
+    state?.let {
+        LaunchedEffect(it) {
+            onState(it)
+        }
+    }
+}