Merge pull request #7 from reduxkotlin/task/sample

Kotlin 1.4 + updates

Author: patjackson52

.circleci/config.yml

@@ -0,0 +1,24 @@
+name: Publish a release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Publish Release
+      env:
+        SONATYPE_NEXUS_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
+        SONATYPE_NEXUS_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
+        GPG_SECRET: ${{ secrets.GPG_SECRET }}
+        GPG_SIGNING_PASSWORD: ${{ secrets.GPG_SIGNING_PASSWORD }}
+      run: ./gradlew publish

.github/workflows/publish_release.yml

@@ -0,0 +1,56 @@
+name: Publish snapshot
+
+on:
+  push:
+    branches: [ master, feature/*, kotlin-* ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  publish-snapshot:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Publish macOS artifacts Snapshot
+      id: publish-macos
+      if: matrix.os == 'macos-latest'
+      env:
+        SONATYPE_NEXUS_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
+        SONATYPE_NEXUS_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
+        GPG_SECRET: ${{ secrets.GPG_SECRET }}
+        GPG_SIGNING_PASSWORD: ${{ secrets.GPG_SIGNING_PASSWORD }}
+        SNAPSHOT: 'TRUE'
+      run: ./gradlew publish
+
+    - name: Publish windows artifacts Snapshot
+      id: publish-win
+      if: matrix.os == 'windows-latest'
+      env:
+        SONATYPE_NEXUS_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
+        SONATYPE_NEXUS_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
+        GPG_SECRET: ${{ secrets.GPG_SECRET }}
+        GPG_SIGNING_PASSWORD: ${{ secrets.GPG_SIGNING_PASSWORD }}
+        SNAPSHOT: 'TRUE'
+      run: ./gradlew publish
+
+    - name: Publish linux artifacts Snapshot
+      id: publish-linux
+      if: matrix.os == 'ubuntu-latest'
+      env:
+        SONATYPE_NEXUS_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
+        SONATYPE_NEXUS_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
+        GPG_SECRET: ${{ secrets.GPG_SECRET }}
+        GPG_SIGNING_PASSWORD: ${{ secrets.GPG_SIGNING_PASSWORD }}
+        SNAPSHOT: 'TRUE'
+      run: ./gradlew publish
+
+    - name: Archive reselect publications dir
+      uses: actions/upload-artifact@v1
+      with:
+        name: publications-${{ matrix.os }}
+        path: reselect/build/publications

.github/workflows/publish_snapshot.yml

@@ -0,0 +1,29 @@
+name: PR
+
+on:
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - '*.md'
+
+jobs:
+  ktlint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Ktlint
+        uses: "vroy/gha-kotlin-linter@v1"
+  test:
+    needs: ktlint
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Test
+        run: ./gradlew build
+

.github/workflows/pull_request.yml

@@ -18,38 +18,53 @@ Documentation to come.
 
 Example usage:
 
+Subscribe to a single substate:
+
 ```
-val subscriber: StoreSubscriber = SelectorSubscriberFn<AppState>(store) {
-    withSingleField({ it.isLoadingItems }) {  <--  only called when isLoadingItems changes from previous state.
-        if (state.isLoadingItems) {
-                view?.showLoading()
-            } else {
-                view?.hideLoading()
-            }
-        }
+//selecting a substate subscribes to changes.  Lambda block will be executed when there is 
+//a change in value of `isLoading`
+val subscriber: StoreSubscriber = store.select({ it.isLoading }) {
+        loadingIndicator.visibility = if (store.state.isLoading) View.VISIBLE else View.GONE
+    }
 
-store.subscribe(subscriber)
+//invoking subcription unsubscribes.  Do this when appropriate for component lifecycle
+subscriber()  
+```
 
+Subscribe to multiple substates:
 ```
+val multiSubscription = store.selectors {
+            select({ it.isLoading }) {
+                loadingIndicator.visibility = if (store.state.isLoading) View.VISIBLE else View.GONE
+            }
+            select({ it.name }) {
+                nameTextView.text = store.state.name
+            }
+        }
 
+//unsubscribe when appropriate
+multiSubscription()
+```
 __How to add to project:__
 
+Requires Kotlin 1.4.0.
 Artifacts are hosted on maven central.  For multiplatform, add the following to your shared module:
 
+
 ```
 kotlin {
   sourceSets {
         commonMain { //   <---  name may vary on your project
             dependencies {
-                implementation "org.reduxkotlin:redux-kotlin-reselect:0.4.0"
+                implementation "org.reduxkotlin:redux-kotlin-reselect:0.5.5"
             }
         }
  }
 ```
 
 For JVM only:
 ```
-  implementation "org.reduxkotlin:redux-kotlin-jvm-reselect:0.4.0"
+  implementation "org.reduxkotlin:redux-kotlin-jvm-reselect:0.5.5"
 ```
 
 [badge-android]: http://img.shields.io/badge/platform-android-brightgreen.svg?style=flat

README.md

@@ -0,0 +1,37 @@
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+        maven("https://dl.bintray.com/jetbrains/kotlin-native-dependencies")
+        maven("https://plugins.gradle.org/m2/")
+        maven("https://oss.sonatype.org/content/repositories/snapshots")
+        jcenter()
+    }
+
+    dependencies {
+        classpath(Plugins.kotlin)
+        classpath(Plugins.dokka)
+        classpath(Plugins.android)
+    }
+}
+
+plugins {
+    id("de.fayard.buildSrcVersions") version "0.4.2"
+}
+
+allprojects {
+    repositories {
+        google()
+        jcenter()
+        maven("https://kotlin.bintray.com/kotlinx")
+        maven("https://oss.sonatype.org/content/repositories/snapshots")
+        mavenCentral()
+    }
+
+    group = project.properties["GROUP"]!!
+    version = project.properties["VERSION_NAME"]!!
+    if (hasProperty("SNAPSHOT") || System.getenv("SNAPSHOT") != null) {
+        version = "$version-SNAPSHOT"
+    }
+}

build.gradle

@@ -0,0 +1,2 @@
+.gradle/
+build/

build.gradle.kts

@@ -0,0 +1,7 @@
+repositories {
+    jcenter()
+}
+
+plugins {
+    `kotlin-dsl`
+}