Merge branch 'dev'

* dev:
  Update changelog.
  Install tarpaulin in CI.
  Fix clippy warnings.
  No nightly in test.bash after all.
  Add funding.
  Update to edition 2021.
  Fix CI.
  We need feature std on futures for channel.
  Fix errors in changelog.

.github/funding.yml

@@ -0,0 +1 @@
+liberapay: najamelan

.github/workflows/ci.yml

@@ -56,8 +56,19 @@ jobs:
         run : bash ci/test.bash
 
 
-      - name: Check coverage
-        run: bash ci/coverage.bash
+      - name: Install cargo-tarpaulin binary crate
+        uses: actions-rs/[email protected]
+        with:
+          crate: cargo-tarpaulin
+          version: latest
+          use-tool-cache: true
+
+      - name: Run cargo-tarpaulin
+        run : |
+          cargo tarpaulin --out Xml
+
+      - name: Upload to codecov.io
+        uses: codecov/[email protected]
 
 
       - name: install wasm-pack

CHANGELOG.md

@@ -1,8 +1,24 @@
 # Pharos Changelog
 
+## [Unreleased]
+
+  [Unreleased]: https://github.com/najamelan/pharos/compare/0.5.3...dev
+
+
+## [Unreleased]
+
+  [0.5.3]: https://github.com/najamelan/pharos/compare/0.5.2...0.5.3
+
+### Fixed
+
+  - require std feature on futures for channel dependency
+  - improve CI.
+  - update to edition 2021
+  - clean up some rustdoc features
+
 ## [0.5.2] - 2021-06-10
 
-[0.5.2]: https://github.com/najamelan/async_executors/compare/0.5.1...0.5.2
+  [0.5.2]: https://github.com/najamelan/pharos/compare/0.5.1...0.5.2
 
 ### Fixed
 

Cargo.toml

@@ -12,6 +12,7 @@ rustc_version = "^0.4"
 [dependencies]
 [dependencies.futures]
 default-features = false
+features = ["std"]
 version = "^0.3"
 
 [dev-dependencies]
@@ -32,14 +33,14 @@ authors = ["Naja Melan <[email protected]>"]
 categories = ["asynchronous"]
 description = "Observer pattern which generates a futures 0.3 stream of events"
 documentation = "https://docs.rs/pharos"
-edition = "2018"
+edition = "2021"
 exclude = ["tests", "examples", "ci", ".travis.yml", "TODO.md", "CONTRIBUTING.md"]
 keywords = ["observer", "futures", "stream", "broadcast", "publish_subscribe"]
 license = "Unlicense"
 name = "pharos"
 readme = "README.md"
 repository = "https://github.com/najamelan/pharos"
-version = "0.5.2"
+version = "0.5.3"
 
 [package.metadata]
 [package.metadata.docs]

Cargo.yml

@@ -24,10 +24,10 @@ package:
   # - `git tag x.x.x` with version number.
   # - `git push && git push --tags`
   #
-  version       : 0.5.2
+  version       : 0.5.3
   name          : pharos
   authors       : [ Naja Melan <[email protected]> ]
-  edition       : '2018'
+  edition       : '2021'
   readme        : README.md
   license       : Unlicense
   repository    : https://github.com/najamelan/pharos
@@ -52,15 +52,15 @@ badges:
 
 dependencies:
 
-  futures: { version: ^0.3, default-features: false }
+  futures: { version: ^0.3, default-features: false, features: [std] }
 
 
 dev-dependencies:
 
   futures           : ^0.3
   assert_matches    : ^1
-  async-std         : { version: ^1  , features: [attributes] }
-  async_executors   : { version: ^0.4, features: [ async_std ] }
+  async-std         : { version: ^1  , features: [ attributes ] }
+  async_executors   : { version: ^0.4, features: [ async_std  ] }
   wasm-bindgen-test : ^0.3
 
 build-dependencies:

src/lib.rs

@@ -1,6 +1,5 @@
 #![ cfg_attr( nightly, feature( doc_cfg ) ) ]
-#![ cfg_attr( nightly, cfg_attr( nightly, doc = include_str!("../README.md") ) )]
-#![ doc = "" ] // empty doc line to handle missing doc warning when the feature is missing.
+#![ doc = include_str!( "../README.md" ) ]
 
 #![ doc    ( html_root_url = "https://docs.rs/pharos" ) ]
 #![ deny   ( missing_docs                             ) ]

src/pharos.rs

@@ -521,18 +521,18 @@ mod tests
 		let mut full = ph.observe( Channel::Bounded  ( 1  ).into() ).await.expect( "observe" );
 		let _unbound = ph.observe( Channel::Unbounded      .into() ).await.expect( "observe" );
 
-		poll_fn( move |mut cx|
+		poll_fn( move |cx|
 		{
 			let mut ph = Pin::new( &mut ph );
 
-				crate::assert_matches!( ph.as_mut().poll_ready( &mut cx ), Poll::Ready( Ok(_) ) );
+				crate::assert_matches!( ph.as_mut().poll_ready( cx ), Poll::Ready( Ok(_) ) );
 				assert!( ph.as_mut().start_send( true ).is_ok() );
 
-				crate::assert_matches!( ph.as_mut().poll_ready( &mut cx ), Poll::Pending );
+				crate::assert_matches!( ph.as_mut().poll_ready( cx ), Poll::Pending );
 
 				assert_eq!( Pin::new( &mut full ).poll_next(cx), Poll::Ready(Some(true)));
 
-				crate::assert_matches!( ph.as_mut().poll_ready( &mut cx ), Poll::Ready( Ok(_) ) );
+				crate::assert_matches!( ph.as_mut().poll_ready( cx ), Poll::Ready( Ok(_) ) );
 
 			().into()
 
@@ -558,9 +558,9 @@ mod tests
 		drop( full );
 
 
-		poll_fn( move |mut cx|
+		poll_fn( move |cx|
 		{
-			crate::assert_matches!( ph.as_mut().poll_ready( &mut cx ), Poll::Ready( Ok(_) ) );
+			crate::assert_matches!( ph.as_mut().poll_ready( cx ), Poll::Ready( Ok(_) ) );
 
 			assert!( ph.observers[1].is_none() );
 
@@ -577,15 +577,15 @@ mod tests
 	//
 	fn poll_ready_closed()
 	{
-		block_on( poll_fn( move |mut cx|
+		block_on( poll_fn( move |cx|
 		{
 			let mut ph = Pharos::<bool>::default();
 
 			let mut ph = Pin::new( &mut ph );
 
 				crate::assert_matches!( ph.as_mut().poll_close( cx ), Poll::Ready(Ok(())) );
 
-			let res = ph.as_mut().poll_ready( &mut cx );
+			let res = ph.as_mut().poll_ready( cx );
 
 				crate::assert_matches!( res, Poll::Ready( Err(_) ) );
 
@@ -614,11 +614,11 @@ mod tests
 		let mut full = ph.observe( Channel::Bounded  ( 1  ).into() ).await.expect( "observe" );
 		let _unbound = ph.observe( Channel::Unbounded      .into() ).await.expect( "observe" );
 
-		poll_fn( move |mut cx|
+		poll_fn( move |cx|
 		{
 			let mut ph = Pin::new( &mut ph );
 
-			crate::assert_matches!( ph.as_mut().poll_ready( &mut cx ), Poll::Ready( Ok(_) ) );
+			crate::assert_matches!( ph.as_mut().poll_ready( cx ), Poll::Ready( Ok(_) ) );
 			assert!( ph.as_mut().start_send( 3 ).is_ok() );
 
 			assert_eq!( Pin::new( &mut full ).poll_next(cx), Poll::Ready(Some(3)));
@@ -646,9 +646,9 @@ mod tests
 
 		drop( full );
 
-		poll_fn( move |mut cx|
+		poll_fn( move |cx|
 		{
-			crate::assert_matches!( ph.as_mut().poll_flush( &mut cx ), Poll::Ready( Ok(_) ) );
+			crate::assert_matches!( ph.as_mut().poll_flush( cx ), Poll::Ready( Ok(_) ) );
 
 			assert!( ph.observers[1].is_none() );
 			().into()