Merge pull request #59 from trappitsch/imports_and_doctest_cleanup

Clean up imports, fix doc lints, get doctests to pass

Author: thejpster

.github/workflows/build.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         rust: [stable]
-        FEATURES: ['', 'from_str', 'std']
+        FEATURES: ['', 'from_str', 'std', 'serde']
 
         include:
           # Test nightly but don't fail
@@ -89,7 +89,7 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: 1.52.1 # clippy is too much of a moving target at the moment
+          toolchain: 1.76 # clippy is too much of a moving target at the moment
           override: true
           components: clippy
       - uses: actions-rs/clippy-check@v1

Cargo.toml

@@ -13,6 +13,7 @@ keywords = ["measurements", "lengths", "weights", "temperatures", "volumes"]
 description = "Handle metric, imperial, and other measurements with ease! Types: Length, Temperature, Weight, Volume, Pressure"
 license = "MIT"
 readme = "README.md"
+edition = "2018"
 
 [features]
 std = []

README.md

@@ -52,8 +52,6 @@ measurements = "0.11"
 In your code...
 
 ```rust
-extern crate measurements;
-
 use measurements::{Length, Pressure, Temperature, Volume, Mass};
 
 fn main() {

examples/engine.rs

@@ -1,4 +1,3 @@
-extern crate measurements;
 use measurements::{AngularVelocity, Power};
 
 fn main() {

examples/format_test.rs

@@ -1,4 +1,3 @@
-extern crate measurements;
 use measurements::*;
 
 fn main() {

examples/frequency.rs

@@ -1,5 +1,3 @@
-extern crate measurements;
-
 fn main() {
     // Sinusiodal Oscilator moves at 5 Hz across 50 mm
     let f = measurements::Frequency::from_hertz(5.0);

src/acceleration.rs

@@ -1,7 +1,6 @@
 //! Types and constants for handling acceleration.
 
-use super::length;
-use super::measurement::*;
+use crate::{length, measurement::*};
 #[cfg(feature = "from_str")]
 use regex::Regex;
 #[cfg(feature = "from_str")]
@@ -13,7 +12,6 @@ use std::str::FromStr;
 /// # Example
 ///
 /// ```
-/// extern crate measurements;
 /// use measurements::{Acceleration, Length, Speed};
 /// use std::time::Duration;
 ///
@@ -26,7 +24,7 @@ use std::str::FromStr;
 ///     println!("You accelerated over {} at an average of {}", track, accel);
 ///}
 /// ```
-#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Copy, Clone, Debug, Default)]
 pub struct Acceleration {
     meters_per_second_per_second: f64,
@@ -120,15 +118,16 @@ implement_measurement! { Acceleration }
 #[cfg(test)]
 mod test {
 
-    use super::*;
-    use speed::Speed;
-    use test_utils::assert_almost_eq;
+    use crate::{speed::Speed, test_utils::assert_almost_eq, *};
+
+    #[cfg(feature = "from_str")]
+    use std::str::FromStr;
 
     // Metric
     #[test]
     fn speed_over_time() {
         let s1 = Speed::from_meters_per_second(10.0);
-        let t1 = ::time::Duration::new(5, 0);
+        let t1 = crate::time::Duration::new(5, 0);
         let i1 = s1 / t1;
         let r1 = i1.as_meters_per_second_per_second();
         assert_almost_eq(r1, 2.0);

src/angle.rs

@@ -19,7 +19,7 @@ use std::str::FromStr;
 /// let slice = whole_cake / pieces;
 /// println!("Each slice will be {} degrees", slice.as_degrees());
 /// ```
-#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Copy, Clone, Debug, Default)]
 pub struct Angle {
     radians: f64,
@@ -28,7 +28,7 @@ pub struct Angle {
 impl Angle {
     /// Create a new Angle from a floating point value in degrees
     pub fn from_degrees(degrees: f64) -> Self {
-        Angle::from_radians(degrees * ::PI / 180.0)
+        Angle::from_radians(degrees * crate::PI / 180.0)
     }
 
     /// Create a new Angle from a floating point value in radians
@@ -38,7 +38,7 @@ impl Angle {
 
     /// Convert this Angle to a floating point value in degrees
     pub fn as_degrees(&self) -> f64 {
-        self.radians * 180.0 / ::PI
+        self.radians * 180.0 / crate::PI
     }
 
     /// Convert this Angle to a floating point value in radians
@@ -134,9 +134,7 @@ implement_measurement! { Angle }
 
 #[cfg(test)]
 mod test {
-    use angle::*;
-    use std::f64::consts::PI;
-    use test_utils::assert_almost_eq;
+    use crate::{angle::*, test_utils::assert_almost_eq, PI};
 
     #[test]
     fn radians() {

src/angular_velocity.rs

@@ -1,11 +1,11 @@
 //! Types and constants for handling speed of rotation (angular velocity)
 
 use super::measurement::*;
+use crate::PI;
 #[cfg(feature = "from_str")]
 use regex::Regex;
 #[cfg(feature = "from_str")]
 use std::str::FromStr;
-use PI;
 
 /// The 'AngularVelocity' struct can be used to deal with angular velocities in a common way.
 ///
@@ -18,7 +18,7 @@ use PI;
 /// let engine_speed = AngularVelocity::from_rpm(9000.0);
 /// let sparks_per_second = (engine_speed.as_hertz() / 2.0) * cylinders;
 /// ```
-#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Copy, Clone, Debug, Default)]
 pub struct AngularVelocity {
     radians_per_second: f64,
@@ -106,7 +106,7 @@ implement_measurement! { AngularVelocity }
 #[cfg(test)]
 mod test {
     use super::*;
-    use test_utils::assert_almost_eq;
+    use crate::test_utils::assert_almost_eq;
 
     #[test]
     fn rpm() {

src/area.rs

@@ -22,7 +22,7 @@ const SQUARE_METER_ACRE_FACTOR: f64 = 1.0 / 4046.86;
 /// let acres = football_field.as_acres();
 /// println!("There are {} acres in a football field.", acres);
 /// ```
-#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Copy, Clone, Debug, Default)]
 pub struct Area {
     square_meters: f64,
@@ -318,7 +318,7 @@ impl FromStr for Area {
 
         let re = Regex::new(r"(?i)\s*([0-9.]*)\s?([a-z2\u{00B2}\u{00B5} ]{1,5})\s*$").unwrap();
         if let Some(caps) = re.captures(val) {
-            println!("{:?}", caps);
+            println!("{caps:?}");
             let float_val = caps.get(1).unwrap().as_str();
             return Ok(
                 match caps.get(2).unwrap().as_str().trim().to_lowercase().as_str() {
@@ -359,8 +359,7 @@ implement_measurement! { Area }
 
 #[cfg(test)]
 mod test {
-    use area::*;
-    use test_utils::assert_almost_eq;
+    use crate::{area::*, test_utils::assert_almost_eq};
 
     #[test]
     fn square_meters() {