improve test coverage (#26)

* add some tests

* fix doc-tests

* switch to llvm-cov

Author: danieleades

.github/workflows/coverage.yml

@@ -19,13 +19,15 @@ jobs:
           toolchain: nightly
           profile: minimal
           override: true
+          components: llvm-tools-preview
 
-      - name: Run cargo-tarpaulin
-        uses: actions-rs/[email protected]
-        with:
-          args: --all-features --tests --doc
+      - name: Install cargo-llvm-cov
+        uses: taiki-e/install-action@cargo-llvm-cov
+
+      - name: Run llvm-cov
+        run: cargo llvm-cov --all-features --doctests --workspace --lcov --output-path lcov.info
 
-      - name: Upload to codecov.io
-        uses: codecov/codecov-action@v2.1.0
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
         with:
-          token: ${{secrets.CODECOV_TOKEN}}
+          files: lcov.info

arithmetic-coding-core/src/fixed_length.rs

@@ -20,9 +20,9 @@ use crate::BitStore;
 /// ```
 /// #![feature(exclusive_range_pattern)]
 /// #![feature(never_type)]
-/// use std::ops::Range;
-///
-/// use arithmetic_coding::fixed_length;
+/// # use std::ops::Range;
+/// #
+/// # use arithmetic_coding_core::fixed_length;
 ///
 /// pub enum Symbol {
 ///     A,

arithmetic-coding-core/src/model.rs

@@ -13,9 +13,9 @@ use crate::BitStore;
 /// ```
 /// #![feature(exclusive_range_pattern)]
 /// #![feature(never_type)]
-/// use std::ops::Range;
-///
-/// use arithmetic_coding::Model;
+/// # use std::ops::Range;
+/// #
+/// # use arithmetic_coding_core::Model;
 ///
 /// pub enum Symbol {
 ///     A,

fenwick-model/src/lib.rs

@@ -79,3 +79,46 @@ impl Weights {
 #[derive(Debug, thiserror::Error)]
 #[error("invalid symbol received: {0}")]
 pub struct ValueError(pub usize);
+
+#[cfg(test)]
+mod tests {
+    use super::Weights;
+
+    #[test]
+    fn total() {
+        let weights = Weights::new(3);
+        assert_eq!(weights.total(), 4);
+    }
+
+    #[test]
+    fn range() {
+        let weights = Weights::new(3);
+        assert_eq!(weights.range(None), 0..1);
+        assert_eq!(weights.range(Some(0)), 1..2);
+        assert_eq!(weights.range(Some(1)), 2..3);
+        assert_eq!(weights.range(Some(2)), 3..4);
+    }
+
+    #[test]
+    #[should_panic]
+    fn range_out_of_bounds() {
+        let weights = Weights::new(3);
+        weights.range(Some(3));
+    }
+
+    #[test]
+    fn symbol() {
+        let weights = Weights::new(3);
+        assert_eq!(weights.symbol(0), None);
+        assert_eq!(weights.symbol(1), Some(0));
+        assert_eq!(weights.symbol(2), Some(1));
+        assert_eq!(weights.symbol(3), Some(2));
+    }
+
+    #[test]
+    #[should_panic]
+    fn symbol_out_of_bounds() {
+        let weights = Weights::new(3);
+        weights.symbol(4);
+    }
+}