Merge pull request #4 from sunsided/feature/codecov

Add code coverage in GitHub Actions

Author: sunsided

.github/workflows/rust.yml

@@ -1,24 +1,69 @@
+---
 name: Rust
 
 on:
   push:
     branches: [ "main" ]
+    paths:
+      - 'Cargo.toml'
+      - 'Cargo.lock'
+      - 'src/**'
+      - 'crates/**'
+      - 'bins/**'
+      - '.github/workflows/rust.yml'
   pull_request:
     branches: [ "main" ]
+    paths:
+      - 'Cargo.toml'
+      - 'Cargo.lock'
+      - 'src/**'
+      - 'crates/**'
+      - 'bins/**'
+      - '.github/workflows/rust.yml'
 
 env:
   CARGO_TERM_COLOR: always
 
 jobs:
   build:
+    name: Build and Test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check format
+        run: cargo fmt --check
+      - name: Build
+        run: cargo build --verbose
+      - uses: taiki-e/install-action@nextest
+      - name: Run tests
+        run: cargo nextest run --verbose --all-features
+      - name: Run doctests
+        run: cargo test --doc --verbose --all-features
 
+  codecov:
+    name: Code Coverage
     runs-on: ubuntu-latest
-
+    env:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
     steps:
-    - uses: actions/checkout@v3
-    - name: Build
-      run: cargo build --verbose
-    - name: Run tests
-      run: cargo test --tests --verbose
-    - name: Run doctests
-      run: cargo test --doc --verbose
+      - uses: actions/checkout@v4
+      - name: Build
+        run: cargo build --verbose
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: llvm-tools-preview
+      - name: Install cargo-llvm-cov
+        uses: taiki-e/install-action@cargo-llvm-cov
+      - name: Install nextest
+        uses: taiki-e/install-action@nextest
+      - name: Generate code coverage
+        run: cargo llvm-cov nextest --all-features --workspace --lcov --output-path lcov.info
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4.0.1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: lcov.info
+          fail_ci_if_error: true

README.md

@@ -1,5 +1,9 @@
 # A query string builder for percent encoding key-value pairs
 
+[![Crates.io](https://img.shields.io/crates/v/query-string-builder)](https://crates.io/crates/query-string-builder)
+[![Crates.io](https://img.shields.io/crates/l/query-string-builder)](https://crates.io/crates/query-string-builder)
+[![codecov](https://codecov.io/gh/sunsided/query-string-builder/graph/badge.svg?token=HUCXM04DOG)](https://codecov.io/gh/sunsided/query-string-builder)
+
 This is a tiny helper crate for simplifying the construction of URL query strings.
 The initial `?` question mark is automatically prepended.
 

src/lib.rs

@@ -21,9 +21,10 @@
 
 #![deny(unsafe_code)]
 
-use percent_encoding::{utf8_percent_encode, AsciiSet, CONTROLS};
 use std::fmt::{Debug, Display, Formatter};
 
+use percent_encoding::{utf8_percent_encode, AsciiSet, CONTROLS};
+
 /// https://url.spec.whatwg.org/#fragment-percent-encode-set
 const FRAGMENT: &AsciiSet = &CONTROLS.add(b' ').add(b'"').add(b'<').add(b'>').add(b'`');
 
@@ -218,7 +219,7 @@ impl QueryString {
 impl Display for QueryString {
     fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
         if self.pairs.is_empty() {
-            return Ok(());
+            Ok(())
         } else {
             write!(f, "?")?;
             for (i, pair) in self.pairs.iter().enumerate() {
@@ -247,6 +248,14 @@ struct Kvp {
 mod tests {
     use super::*;
 
+    #[test]
+    fn test_empty() {
+        let qs = QueryString::new();
+        assert_eq!(qs.to_string(), "");
+        assert_eq!(qs.len(), 0);
+        assert!(qs.is_empty());
+    }
+
     #[test]
     fn test_simple() {
         let qs = QueryString::new()
@@ -256,6 +265,8 @@ mod tests {
             qs.to_string(),
             "?q=apple???&category=fruits%20and%20vegetables"
         );
+        assert_eq!(qs.len(), 2);
+        assert!(!qs.is_empty());
     }
 
     #[test]
@@ -287,5 +298,33 @@ mod tests {
             qs.to_string(),
             "?q=celery&category=fruits%20and%20vegetables"
         );
+        assert_eq!(qs.len(), 2); // not three!
+    }
+
+    #[test]
+    fn test_push_optional() {
+        let mut qs = QueryString::new();
+        qs.push("a", "apple");
+        qs.push_opt("b", None::<String>);
+        qs.push_opt("c", Some("🍎 apple"));
+
+        assert_eq!(
+            format!("https://example.com/{qs}"),
+            "https://example.com/?a=apple&c=%F0%9F%8D%8E%20apple"
+        );
+    }
+
+    #[test]
+    fn test_append() {
+        let qs = QueryString::new().with_value("q", "apple");
+        let more = QueryString::new().with_value("q", "pear");
+
+        let mut qs = qs.append_into(more);
+        qs.append(QueryString::new().with_value("answer", "42"));
+
+        assert_eq!(
+            format!("https://example.com/{qs}"),
+            "https://example.com/?q=apple&q=pear&answer=42"
+        );
     }
 }