Merge branch 'dbrgn:main' into io-mock

Author: Artur-Romaniuk

.github/workflows/ci.yml

@@ -52,7 +52,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@stable
+      - uses: dtolnay/rust-toolchain@nightly
         with:
           components: rustfmt
-      - run: cargo fmt --all -- --check
+      - run: cargo +nightly fmt --all -- --check

.rustfmt.toml

@@ -14,56 +14,37 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Changed
 
-- Updated `embedded-hal` to `1.0.0`.
-- Changed the `embedded-hal` version 1 SPI implementation to be generic over
-  word size.
 
-## 0.10.0-rc.4 - 2023-12-14
-
-### Changed
-
-- Updated `embedded-hal` to `1.0.0-rc.3`.
-
-
-## 0.10.0-rc.3 - 2023-11-29
-
-### Changed
-
-- Updated `embedded-hal` to `1.0.0-rc.2`.
-
-
-## 0.10.0-rc.2 - 2023-11-23
-
-### Added
-
-- Implement mock for `eh1::pwm::SetDutyCycle`
-
-### Changed
-
-- Renamed `.expect(...)` method to `.update_expectations(...)` to avoid
-  confusion with the expect method in `Option` and `Result` (#63)
-- When updating expectations on a mock by calling `.expect(...)` /
-  `.update_expectations(...)` on it, assert that previous expectations have
-  been consumed (#63)
-
-
-## 0.10.0-rc.1 - 2023-11-01
+## 0.10.0 - 2024-01-10
 
 This release contains a big change: `embedded-hal-mock` now supports both
-`embedded-hal` 0.x and 1.x (currently at version `1.0.0-rc.1`)! Please test it,
-and if there are any issues, leave feedback in the GitHub issue tracker.
+`embedded-hal` 0.x and 1.x! The two variants are accessible through
+`embedded_hal_mock::eh0::*` and `embedded_hal_mock::eh1::*`. If there are any
+issues, leave feedback in the GitHub issue tracker.
 
 Additionally, tests now fail if you forgot to call `.done()`. This should
 reduce the chance of accidentally writing a broken test.
 
-This release contains commits by 10 different people, thanks a lot for the
+This release contains commits by 12 different people, thanks a lot for the
 contributions!
 
+### Migrating to 0.10.0
+
+- Update your imports: Change `use embedded_hal_mock::*` to
+  `use embedded_hal_mock::eh0::*`
+- Rename all `.expect(...)` calls on mocks to `.update_expectations(...)`
+- Rename all `eh0::delay::MockNoop` usages to `eh0::delay::NoopDelay`
+- Run your tests to ensure that you don't have any missing `.done()` calls in
+  your code
+- Look through the rest of the changes below and check if they might affect
+  your code
+
 ### Added
 
 - Support for both `embedded-hal` 0.x and 1.x in the same crate (#75)
 - Print a warning to stderr and fail test if a mock is dropped without having
   calling `.done()` on it, or if `.done()` is called twice (#59, #61)
+- Implement mock for `eh1::pwm::SetDutyCycle`
 
 ### Fixed
 
@@ -74,8 +55,16 @@ contributions!
 
 ### Changed
 
+- Renamed `.expect(...)` method to `.update_expectations(...)` to avoid
+  confusion with the expect method in `Option` and `Result` (#63)
+- When updating expectations on a mock by calling `.expect(...)` /
+  `.update_expectations(...)` on it, assert that previous expectations have
+  been consumed (#63)
 - Rename `delay::MockNoop` to `delay::NoopDelay`.
-- Bump minimal supported Rust version (MSRV) to 1.63
+- Changed the eh1 SPI implementation to be generic over word size
+- Updated `nb` dependency from 0.1 to 1.1 (#107)
+- Bump minimal supported Rust version (MSRV) to 1.63 (or 1.75 if you use
+  embedded-hal 1.0)
 - The minimal supported Rust version (MSRV) is specified in the `Cargo.toml` to
   offer clearer error messages to consumers with outdated Rust versions
 

CHANGELOG.md

@@ -1,4 +1,4 @@
-Copyright (C) 2018-2023 Danilo Bargen and contributors
+Copyright (C) 2018-2024 Danilo Bargen and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

LICENSE-MIT

@@ -1 +1,2 @@
-# Empty file, use defaults and disregard global settings
+imports_granularity = "Crate"
+group_imports = "StdExternalCrate"

rustfmt.toml

@@ -5,9 +5,7 @@
 //! ```
 //! # use eh0 as embedded_hal;
 //! use embedded_hal::adc::OneShot;
-//! use embedded_hal_mock::eh0::adc::Mock;
-//! use embedded_hal_mock::eh0::adc::Transaction;
-//! use embedded_hal_mock::eh0::adc::{MockChan0, MockChan1};
+//! use embedded_hal_mock::eh0::adc::{Mock, MockChan0, MockChan1, Transaction};
 //!
 //! // Configure expectations: expected input channel numbers and values returned by read operations
 //! let expectations = [
@@ -30,13 +28,13 @@
 //!
 //! ```
 //! # use eh0 as embedded_hal;
-//! use embedded_hal::adc::OneShot;
-//! use embedded_hal_mock::eh0::adc::Mock;
-//! use embedded_hal_mock::eh0::adc::Transaction;
-//! use embedded_hal_mock::eh0::adc::MockChan1;
-//! use embedded_hal_mock::eh0::MockError;
 //! use std::io::ErrorKind;
 //!
+//! use embedded_hal::adc::OneShot;
+//! use embedded_hal_mock::eh0::{
+//!     adc::{Mock, MockChan1, Transaction},
+//!     MockError,
+//! };
 //!
 //! // Configure expectations
 //! let expectations = [
@@ -45,17 +43,18 @@
 //! let mut adc = Mock::new(&expectations);
 //!
 //! // Reading returns an error
-//! adc.read(&mut MockChan1 {}).expect_err("expected error return");
+//! adc.read(&mut MockChan1 {})
+//!     .expect_err("expected error return");
 //!
 //! // Finalise expectations
 //! adc.done();
 //! ```
 
+use std::fmt::Debug;
+
 use eh0 as embedded_hal;
-use embedded_hal::adc::Channel;
-use embedded_hal::adc::OneShot;
+use embedded_hal::adc::{Channel, OneShot};
 use nb;
-use std::fmt::Debug;
 
 use super::error::MockError;
 use crate::common::Generic;
@@ -141,13 +140,12 @@ where
 
 #[cfg(test)]
 mod test {
-    use super::super::error::MockError;
-    use super::*;
+    use std::io::ErrorKind;
 
     use eh0 as embedded_hal;
     use embedded_hal::adc::OneShot;
 
-    use std::io::ErrorKind;
+    use super::{super::error::MockError, *};
 
     #[test]
     fn test_adc_single_read16() {

src/eh0/adc.rs

@@ -12,8 +12,7 @@
 //! [`std::thread::sleep`](https://doc.rust-lang.org/std/thread/fn.sleep.html)
 //! to implement the delay.
 
-use std::thread;
-use std::time::Duration;
+use std::{thread, time::Duration};
 
 use eh0 as embedded_hal;
 use embedded_hal::blocking::delay;

src/eh0/delay.rs

@@ -4,8 +4,10 @@
 //!
 //! ```
 //! # use eh0 as embedded_hal;
-//! use embedded_hal::prelude::*;
-//! use embedded_hal::blocking::i2c::{Read, Write, WriteRead};
+//! use embedded_hal::{
+//!     blocking::i2c::{Read, Write, WriteRead},
+//!     prelude::*,
+//! };
 //! use embedded_hal_mock::eh0::i2c::{Mock as I2cMock, Transaction as I2cTransaction};
 //!
 //! // Configure expectations
@@ -47,6 +49,7 @@
 //! # use embedded_hal::blocking::i2c::{Read, Write, WriteRead};
 //! # use embedded_hal_mock::eh0::i2c::{Mock as I2cMock, Transaction as I2cTransaction};
 //! use std::io::ErrorKind;
+//!
 //! use embedded_hal_mock::eh0::MockError;
 //!
 //! // Configure expectations
@@ -277,14 +280,13 @@ impl i2c::WriteIter for Mock {
 
 #[cfg(test)]
 mod test {
-    use super::super::error::MockError;
-    use super::*;
-
     use std::{io::ErrorKind as IoErrorKind, time::SystemTime};
 
     use eh0 as embedded_hal;
     use embedded_hal::blocking::i2c::{Read, Write, WriteRead};
 
+    use super::{super::error::MockError, *};
+
     #[test]
     fn write() {
         let expectations = [Transaction::write(0xaa, vec![10, 12])];

src/eh0/i2c.rs

@@ -7,9 +7,11 @@
 //! # use eh0 as embedded_hal;
 //! use std::io::ErrorKind;
 //!
-//! use embedded_hal_mock::eh0::MockError;
-//! use embedded_hal_mock::eh0::pin::{Transaction as PinTransaction, Mock as PinMock, State as PinState};
 //! use embedded_hal::digital::v2::{InputPin, OutputPin};
+//! use embedded_hal_mock::eh0::{
+//!     pin::{Mock as PinMock, State as PinState, Transaction as PinTransaction},
+//!     MockError,
+//! };
 //!
 //! let err = MockError::Io(ErrorKind::NotConnected);
 //!
@@ -37,16 +39,17 @@
 //! pin.update_expectations(&[]);
 //! // ...
 //! pin.done();
-//!
 //! ```
 
+use eh0 as embedded_hal;
+use embedded_hal::{
+    digital::v2::{InputPin, OutputPin},
+    PwmPin,
+};
+
 use super::error::MockError;
 use crate::common::Generic;
 
-use eh0 as embedded_hal;
-use embedded_hal::digital::v2::{InputPin, OutputPin};
-use embedded_hal::PwmPin;
-
 /// The type used for the duty of the [`PwmPin`] mock.
 pub type PwmDuty = u16;
 
@@ -300,15 +303,15 @@ impl PwmPin for Mock {
 
 #[cfg(test)]
 mod test {
-    use super::super::error::MockError;
-    use super::TransactionKind::*;
-    use super::*;
-
     use std::io::ErrorKind;
 
     use eh0 as embedded_hal;
-    use embedded_hal::digital::v2::{InputPin, OutputPin};
-    use embedded_hal::PwmPin;
+    use embedded_hal::{
+        digital::v2::{InputPin, OutputPin},
+        PwmPin,
+    };
+
+    use super::{super::error::MockError, TransactionKind::*, *};
 
     #[test]
     fn test_input_pin() {

src/eh0/pin.rs

@@ -12,10 +12,7 @@
 //! # use eh0 as embedded_hal;
 //! // Note that we're using the non-blocking serial traits
 //! use embedded_hal::serial::{Read, Write};
-//! use embedded_hal_mock::eh0::serial::{
-//!     Mock as SerialMock,
-//!     Transaction as SerialTransaction,
-//! };
+//! use embedded_hal_mock::eh0::serial::{Mock as SerialMock, Transaction as SerialTransaction};
 //!
 //! // Configure expectations
 //! let expectations = [
@@ -51,12 +48,8 @@
 //! ```
 //! # use eh0 as embedded_hal;
 //! // Note that we're using the blocking serial write trait
-//! use embedded_hal::blocking::serial::Write;
-//! use embedded_hal::serial::Read;
-//! use embedded_hal_mock::eh0::serial::{
-//!     Mock as SerialMock,
-//!     Transaction as SerialTransaction,
-//! };
+//! use embedded_hal::{blocking::serial::Write, serial::Read};
+//! use embedded_hal_mock::eh0::serial::{Mock as SerialMock, Transaction as SerialTransaction};
 //!
 //! // Configure expectations
 //! let expectations = [
@@ -99,6 +92,7 @@
 //! #     Transaction as SerialTransaction,
 //! # };
 //! use std::io::ErrorKind;
+//!
 //! use embedded_hal_mock::eh0::MockError;
 //!
 //! // Configure expectations
@@ -192,8 +186,7 @@ enum Mode<Word> {
 /// # Example
 ///
 /// ```no_run
-/// use embedded_hal_mock::eh0::serial::Transaction;
-/// use embedded_hal_mock::eh0::serial::Mock;
+/// use embedded_hal_mock::eh0::serial::{Mock, Transaction};
 ///
 /// // We expect, in order,
 /// // 1. A read that returns 0x23,
@@ -202,7 +195,7 @@ enum Mode<Word> {
 /// let transactions = [
 ///     Transaction::read(0x23),
 ///     Transaction::write_many([0x55, 0xAA]),
-///     Transaction::flush()
+///     Transaction::flush(),
 /// ];
 ///
 /// let mut serial = Mock::new(&transactions);
@@ -463,9 +456,6 @@ impl<Word> write::Default<Word> for Mock<Word> where Word: PartialEq + std::fmt:
 
 #[cfg(test)]
 mod test {
-    use super::super::error::MockError;
-    use super::*;
-
     use std::io;
 
     use eh0 as embedded_hal;
@@ -474,6 +464,8 @@ mod test {
         serial::{Read, Write},
     };
 
+    use super::{super::error::MockError, *};
+
     #[test]
     fn test_serial_mock_read() {
         let ts = [Transaction::read(0x54)];