Add GitHub Actions test workflow

.github/workflows/test.yml

@@ -0,0 +1,122 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  browser-test:
+    name: Test on ${{ matrix.browser }} (using rustc ${{ matrix.rust }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        rust:
+          - 1.63.0
+          - stable
+          - nightly
+        browser:
+          - firefox
+          - chrome
+        os:
+          - ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ matrix.rust }}
+          override: true
+
+      - name: Install wasm-pack
+        run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
+
+      - name: Cargo generate-lockfile
+        run: cargo generate-lockfile
+
+      - name: Cargo cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ matrix.rust }}-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Run headless browser tests with default features
+        run: wasm-pack test --${{ matrix.browser }} --headless
+
+      - name: Run headless browser tests with all features
+        run: wasm-pack test --${{ matrix.browser }} --headless --all-features
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    env:
+      RUSTFLAGS: -Dwarnings
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+
+      - name: Cargo generate-lockfile
+        run: cargo generate-lockfile
+
+      - name: Cargo cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Run clippy
+        run: cargo clippy
+
+  miri:
+    name: Miri
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Miri
+        run: |
+          MIRI_NIGHTLY=nightly-$(curl -s https://rust-lang.github.io/rustup-components-history/x86_64-unknown-linux-gnu/miri)
+          echo "Installing latest nightly with Miri: $MIRI_NIGHTLY"
+          rustup set profile minimal
+          rustup default "$MIRI_NIGHTLY"
+          rustup component add miri
+      - name: Cargo generate-lockfile
+        run: cargo generate-lockfile
+
+      - name: Cargo cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Run tests with all features
+        run: |
+          cargo miri test --all-features

Cargo.toml

@@ -1,7 +1,9 @@
 [package]
 name = "sycamore-state"
-version = "0.0.1"
+version = "0.1.0"
 edition = "2021"
+description = "A simple Sycamore state management library"
+license = "Apache-2.0"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -13,4 +15,4 @@ wasm-bindgen = "0.2.83"
 version = "0.8"
 
 [features]
-async = ["sycamore/suspense"]
+async = ["sycamore/suspense"]

Makefile

@@ -0,0 +1,21 @@
+# Copyright 2022 Jeremy Wall (Jeremy@marzhilsltudios.com)
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+build:
+	cargo build
+
+test: test-firefox
+
+test-%:
+	wasm-pack test --$* --headless . --features async

README.md

@@ -0,0 +1,5 @@
+# A Sycamore state management library
+
+Based on a simple messaging setup with sycamore selectors to limit superflous updates.
+
+Very minimal and simple for the moment.

src/lib.rs

@@ -65,7 +65,9 @@ where
     }
 
     /// Binds a triggering signal and associated message mapping function as
-    /// a state update for this Handler instance.
+    /// a state update for this Handler instance. This uses [`create_effect`]
+    /// so be aware that it will fire at least once when you first call it. It
+    /// is really easy to introduce an infinite signal update loop.
     pub fn bind_trigger<F, Val>(
         &'ctx self,
         cx: Scope<'ctx>,

src/tests/mod.rs

@@ -27,19 +27,6 @@ pub struct FakeState {
     value_two: i32,
 }
 
-pub enum MultiMsg {
-    Foo(Msg),
-    Bar(Msg),
-}
-
-pub struct MultiState<'ctx, D>
-where
-    D: MessageMapper<Msg, FakeState>,
-{
-    foo: &'ctx Handler<'ctx, D, FakeState, Msg>,
-    bar: &'ctx Handler<'ctx, D, FakeState, Msg>,
-}
-
 pub struct StateMachine();
 
 impl MessageMapper<Msg, FakeState> for StateMachine {