Merge pull request #81 from AeroRust/ci-improvements

Ci improvements

Author: elpiel

.github/workflows/ci.yml

@@ -4,11 +4,13 @@ on:
   push:
     branches:
       - main
+    tags:
+      - "v*"
   pull_request:
     branches:
       - main
   schedule:
-    - cron: '00 01 * * *'
+    - cron: "00 01 * * *"
 
 # Stops the running workflow of previous pushes
 concurrency:
@@ -22,33 +24,25 @@ jobs:
     name: Rustfmt & Clippy lints
 
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
+    # strategy:
+    #   fail-fast: false
     env:
       RUSTUP_MAX_RETRIES: 10
       CARGO_NET_RETRY: 10
     steps:
       - uses: actions/checkout@v3
 
+      # use nightly for rustfmt & clippy checks
       - name: Install Rust nightly toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@nightly
         with:
-          toolchain: nightly
-          profile: default
-          override: true
           components: rustfmt, clippy
 
       - name: Rust format
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --check
+        run: cargo fmt --check
 
       - name: Clippy lints
-        uses: actions-rs/cargo@v1
-        with:
-          command: clippy
-          args: --no-deps -- -D warnings
+        run: cargo clippy --no-deps -- -D warnings
   test:
     name: Test
 
@@ -65,50 +59,26 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      # We need to disable the existing toolchain to avoid updating rust-docs
-      # which takes a long time. The fastest way to do this is to rename the
-      # existing folder, as deleting it takes about as much time as not doing
-      # anything and just updating rust-docs.
-      - name: Rename existing rust toolchain (Windows)
-        if: matrix.os == 'windows-latest'
-        run: Rename-Item C:\Users\runneradmin\.rustup\toolchains\stable-x86_64-pc-windows-msvc C:\Users\runneradmin\.rustup\toolchains\stable-x86_64-pc-windows-msvc.old
-
       - name: Install Rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: ${{ matrix.rust }}
-          profile: minimal
-          override: true
           components: rust-src
+          toolchain: ${{ matrix.rust }}
 
       - name: Build
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
+        run: cargo build
 
       - name: Test --no-default-features
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --no-default-features
+        run: cargo test --no-default-features
 
       - name: Test --all-features
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --all-features
+        run: cargo test --all-features
 
       - name: Test (Release)
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --release --no-default-features
-      
+        run: cargo test --release --no-default-features
+
       - name: Test (Release) all-features
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --release --all-features
+        run: cargo test --release --all-features
 
   # Detect cases where documentation links don't resolve and such.
   doc:
@@ -118,37 +88,31 @@ jobs:
       RUSTDOCFLAGS: "-D warnings"
     steps:
       - uses: actions/checkout@v3
-      - uses: actions-rs/toolchain@v1
+      # Docs.rs uses nightly, which allows for easier syntax for linking to functions.
+      - uses: dtolnay/rust-toolchain@nightly
         with:
-          profile: minimal
-          # Docs.rs uses nightly, which allows for easier syntax for linking to functions.
-          toolchain: nightly
-          override: true
+          components: rust-docs
 
       - name: Docs --all-features
-        uses: actions-rs/cargo@v1
-        with:
-          command: doc
-          args: --all-features --no-deps
+        run: cargo doc --all-features --no-deps
 
       - name: Docs --no-default-features
-        uses: actions-rs/cargo@v1
-        with:
-          command: doc
-          args: --no-default-features --no-deps
-
+        run: cargo doc --no-default-features --no-deps
   codecov:
     name: Generate code coverage
     runs-on: ubuntu-latest
+    container:
+      image: xd009642/tarpaulin:develop-nightly
+      options: --security-opt seccomp=unconfined
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          override: true
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-      - name: Run cargo-tarpaulin
-        uses: actions-rs/tarpaulin@v0.1
+      - name: Generate code coverage
+        run: |
+          cargo +nightly tarpaulin --verbose --all-features --workspace --timeout 120 --out Xml
 
       - name: Upload to codecov.io
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v2
+        with:
+          fail_ci_if_error: true

Cargo.toml

@@ -40,6 +40,7 @@ approx = "0.5.1"
 doc-comment = "0.3"
 pretty_assertions = "1"
 quickcheck = { version = "1.0.3", default-features = false }
+# Criterion 0.4 will force us to use MSRV of 1.57!
 criterion = "0.3"
 
 [features]

README.md

@@ -13,26 +13,30 @@ Supported sentences:
 NMEA Standard Sentences
 - AAM
 - ALM
-- BOD (not supported by `Nmea::parse()`)
-- BWC (not supported by `Nmea::parse()`)
-- GBS (not supported by `Nmea::parse()`)
-- GGA
-- GLL
-- GNS
-- GSA
-- GSV
+- BOD
+- BWC
+- GBS
+- GGA *
+- GLL *
+- GNS *
+- GSA *
+- GSV *
 - MDA
 - MTW
 - MWV
-- RMC
-- VTG
+- RMC *
+- VTG *
 
 Other Sentences
-- TXT
+- TXT *
 
 Vendor Extensions
 - PGRMZ
 
+**\* [`Nmea::parse()`] supported sentences**
+
+[`Nmea::parse()`]: https://docs.rs/nmea/latest/nmea/struct.Nmea.html#method.parse
+
 ## How to contribute
 
 We have an ongoing effort to support as many sentences from `NMEA 0183` as possible,
@@ -60,7 +64,7 @@ Add the `nmea` dependency in your `Cargo.toml`:
 
 ```toml
 [dependencies]
-nmea = "0.3"
+nmea = "0.4"
 ```
 
 ### For `no_std`
@@ -70,7 +74,7 @@ just add the `nmea` crate without the default features:
 
 ```toml
 [dependencies]
-nmea = {version = "0.3", default-features = false}
+nmea = {version = "0.4", default-features = false}
 ```
 
 ### For Rust edition 2015

src/lib.rs

@@ -4,32 +4,35 @@
 //! to preserve state between receiving new NMEA sentence,
 //! and [`parse_str()`] or [`parse_bytes()`] to parse sentences without state.
 //!
-//! Units used: **degrees**, **knots**, **meters** for altitude
+//! Units used: **celsius**, **degrees**, **knots**, **meters** for altitude
 //!
 //! # Supported sentences:
 //!
 //! NMEA Standard Sentences
 //! - AAM
 //! - ALM
-//! - BOD (not supported by [`Nmea::parse()`])
-//! - BWC (not supported by `Nmea::parse()`)
-//! - GBS (not supported by [`Nmea::parse()`])
-//! - GGA
-//! - GLL
-//! - GNS
-//! - GSA
-//! - GSV
+//! - BOD
+//! - BWC
+//! - GBS
+//! - GGA *
+//! - GLL *
+//! - GNS *
+//! - GSA *
+//! - GSV *
 //! - MDA
 //! - MWV
-//! - RMC
-//! - VTG
+//! - RMC *
+//! - VTG *
 //!
 //! Other Sentences
-//! - TXT
+//! - TXT *
 //!
 //! Vendor Extension
 //! - PGRMZ
 //!
+//! **\* [`Nmea::parse()`] supported sentences**
+//!
+//!
 //! # Crate features
 //!
 //! - `default` features - `std`

src/parse.rs

@@ -118,6 +118,31 @@ pub enum ParseResult {
     Unsupported(SentenceType),
 }
 
+impl From<&ParseResult> for SentenceType {
+    fn from(parse_result: &ParseResult) -> Self {
+        match parse_result {
+            ParseResult::AAM(_) => SentenceType::AAM,
+            ParseResult::ALM(_) => SentenceType::ALM,
+            ParseResult::BOD(_) => SentenceType::BOD,
+            ParseResult::BWC(_) => SentenceType::BWC,
+            ParseResult::GBS(_) => SentenceType::GBS,
+            ParseResult::GGA(_) => SentenceType::GGA,
+            ParseResult::GLL(_) => SentenceType::GLL,
+            ParseResult::GNS(_) => SentenceType::GNS,
+            ParseResult::GSA(_) => SentenceType::GSA,
+            ParseResult::GSV(_) => SentenceType::GSV,
+            ParseResult::MDA(_) => SentenceType::MDA,
+            ParseResult::MTW(_) => SentenceType::MTW,
+            ParseResult::MWV(_) => SentenceType::MWV,
+            ParseResult::RMC(_) => SentenceType::RMC,
+            ParseResult::TXT(_) => SentenceType::TXT,
+            ParseResult::VTG(_) => SentenceType::VTG,
+            ParseResult::PGRMZ(_) => SentenceType::RMZ,
+            ParseResult::Unsupported(sentence_type) => *sentence_type,
+        }
+    }
+}
+
 /// Parse a NMEA 0183 sentence from bytes and extract data from it.
 ///
 /// # Errors

src/parser.rs

@@ -262,11 +262,10 @@ impl<'a> Nmea {
                 self.merge_txt_data(txt);
                 Ok(SentenceType::TXT)
             }
-            // ParseResult::BWC(_) | ParseResult::BOD(_) | ParseResult::GBS(_) => {
-            //     Err(Error::Unsupported(SentenceType::BWC))
-            // }
             ParseResult::Unsupported(sentence_type) => Err(Error::Unsupported(sentence_type)),
-            _ => Err(Error::Unsupported(SentenceType::BWC)),
+            // any other implemented sentence which is not part of the `Nmea` parsing is unsupported
+            // at this time being
+            ref parse_result => Err(Error::Unsupported(parse_result.into())),
         }
     }
 

src/sentences/alm.rs

@@ -44,7 +44,7 @@ use super::utils::number;
 /// 16. Checksum
 ///  
 ///  Fields 5 through 15 are dumped as raw hex.
-#[derive(Debug, Clone, Copy, PartialEq)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub struct AlmData {
     pub total_number_of_messages: Option<u16>,
     pub sentence_number: Option<u16>,

src/sentences/rmz.rs

@@ -29,7 +29,7 @@ pub enum PgrmzFixType {
 /// 4. Checksum
 ///
 /// Example: `$PGRMZ,2282,f,3*21`
-#[derive(Debug, Clone, Copy, PartialEq)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub struct PgrmzData {
     /// Current altitude in feet
     pub altitude: u32,