Merge pull request #1 from rodneylab/style__linting

style  linting

Author: rodneylab

.github/workflows/general.yml

@@ -71,7 +71,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        msrv: ["1.74.0"]
+        msrv: ["1.75.0"]
     name: ubuntu / ${{ matrix.msrv }}
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
@@ -81,6 +81,8 @@ jobs:
         uses: dtolnay/rust-toolchain@4f647fc679bcd3b11499ccb42104547c83dabe96 # stable
         with:
           toolchain: ${{ matrix.msrv }}
+      - name: generate lockfile
+        run: cargo generate-lockfile
       - name: cargo +${{ matrix.msrv }} check
         run: cargo check
   coverage:

.lycheeignore

@@ -0,0 +1 @@
+https://github.com/example/example-repo

Cargo.toml

@@ -5,8 +5,8 @@ authors = ["Rodney Johnson <[email protected]>"]
 edition = "2021"
 license = "BSD-3-Clause"
 repository = "https://github.com/rodneylab/rust-crate-diffs"
-# clap 4.5.0 raises MSRV to 1.74
-rust-version = "1.74"
+# config 0.15.4 raises MSRV to 1.75
+rust-version = "1.75"
 description = "Check Cargo.toml dependency changes against git repo head"
 
 # Faster snapshot runs

src/domain/cargo_toml/mod.rs

@@ -14,13 +14,13 @@ use serde::Deserialize;
 use super::SemverVersion;
 
 #[derive(Debug)]
-pub struct CargoTomlFile {
+pub struct File {
     dependencies: BTreeMap<String, CargoDependencyValue>,
     build_dependencies: Option<BTreeMap<String, CargoDependencyValue>>,
     dev_dependencies: Option<BTreeMap<String, CargoDependencyValue>>,
 }
 
-impl CargoTomlFile {
+impl File {
     pub fn new(path: &str) -> anyhow::Result<Self> {
         let current_cargo = Config::builder()
             .add_source(config::File::with_name(path))
@@ -292,28 +292,33 @@ Ok(value) => value,
 #[derive(Debug, Deserialize, PartialEq)]
 #[cfg_attr(test, derive(serde::Serialize))]
 pub struct DetailedCargoDependency {
-    #[allow(dead_code, reason = "Field needed for deserialisation")]
+    // #[allow(dead_code, reason = "Field needed for deserialisation")]
+    #[allow(dead_code)]
     version: String,
 }
 
 #[derive(Debug, Deserialize, PartialEq)]
 #[cfg_attr(test, derive(serde::Serialize))]
 pub struct GitCargoDependency {
-    #[allow(dead_code, reason = "Field needed for deserialisation")]
+    // #[allow(dead_code, reason = "Field needed for deserialisation")]
+    #[allow(dead_code)]
     git: String,
 }
 
 #[derive(Debug, Deserialize, PartialEq)]
 #[cfg_attr(test, derive(serde::Serialize))]
 #[serde(untagged)]
 pub enum CargoDependencyValue {
-    #[allow(dead_code, reason = "Field needed for deserialisation")]
+    // #[allow(dead_code, reason = "Field needed for deserialisation")]
+    #[allow(dead_code)]
     Simple(String),
 
-    #[allow(dead_code, reason = "Field needed for deserialisation")]
+    // #[allow(dead_code, reason = "Field needed for deserialisation")]
+    #[allow(dead_code)]
     Detailed(DetailedCargoDependency),
 
-    #[allow(dead_code, reason = "Field needed for deserialisation")]
+    // #[allow(dead_code, reason = "Field needed for deserialisation")]
+    #[allow(dead_code)]
     Git(GitCargoDependency),
 }
 

src/domain/cargo_toml/snapshots/rust_crate_diffs__domain__cargo_toml__tests__new_from_buffer_creates_expected_config.snap

@@ -3,4 +3,4 @@ source: src/domain/cargo_toml/tests.rs
 expression: "format!(\"{outcome:?}\")"
 snapshot_kind: text
 ---
-CargoTomlFile { dependencies: {"ahash": Simple("0.8.11"), "clap": Detailed(DetailedCargoDependency { version: "4.5.23" }), "clap-verbosity-flag": Simple("3.0.1"), "config": Simple("0.14.1"), "env_logger": Simple("0.11.5"), "git2": Simple("0.19.0"), "log": Simple("0.4.22"), "serde": Detailed(DetailedCargoDependency { version: "1.0.215" }), "sqlx": Detailed(DetailedCargoDependency { version: "0.8.2" })}, build_dependencies: None, dev_dependencies: Some({"assert_fs": Simple("1.1.2"), "trycmd": Simple("0.15.8")}) }
+File { dependencies: {"ahash": Simple("0.8.11"), "clap": Detailed(DetailedCargoDependency { version: "4.5.23" }), "clap-verbosity-flag": Simple("3.0.1"), "config": Simple("0.14.1"), "env_logger": Simple("0.11.5"), "git2": Simple("0.19.0"), "log": Simple("0.4.22"), "serde": Detailed(DetailedCargoDependency { version: "1.0.215" }), "sqlx": Detailed(DetailedCargoDependency { version: "0.8.2" })}, build_dependencies: None, dev_dependencies: Some({"assert_fs": Simple("1.1.2"), "trycmd": Simple("0.15.8")}) }

src/domain/cargo_toml/tests.rs

@@ -7,7 +7,7 @@ use assert_fs::{
 
 use crate::domain::cargo_toml::{CargoDependencyValue, DetailedCargoDependency};
 
-use super::CargoTomlFile;
+use super::File;
 
 fn get_temporary_cargo_toml_path(temp_dir: &TempDir) -> PathBuf {
     let cargo_toml_content = r#"[package]
@@ -50,8 +50,7 @@ fn new_successfully_parses_valid_cargo_toml_dependencies() {
     let temporary_cargo_toml_path = get_temporary_cargo_toml_path(&temp_dir);
 
     // act
-    let CargoTomlFile { dependencies, .. } =
-        CargoTomlFile::new(temporary_cargo_toml_path.to_str().unwrap()).unwrap();
+    let File { dependencies, .. } = File::new(temporary_cargo_toml_path.to_str().unwrap()).unwrap();
 
     // assert
     assert_eq!(dependencies.len(), 9);
@@ -83,7 +82,7 @@ fn new_handles_missing_cargo_toml() {
     let temporary_cargo_toml_path = temp_dir.join("Cargoooo.toml");
 
     // act
-    let outcome = CargoTomlFile::new(temporary_cargo_toml_path.to_str().unwrap()).unwrap_err();
+    let outcome = File::new(temporary_cargo_toml_path.to_str().unwrap()).unwrap_err();
 
     // assert
     assert_eq!(
@@ -132,7 +131,7 @@ trycmd = "0.15.8"
     let temporary_cargo_toml_path = temp_dir.join("Cargo.toml");
 
     // act
-    let outcome = CargoTomlFile::new(temporary_cargo_toml_path.to_str().unwrap()).unwrap_err();
+    let outcome = File::new(temporary_cargo_toml_path.to_str().unwrap()).unwrap_err();
 
     // assert
     assert_eq!(
@@ -157,7 +156,7 @@ trycmd = "0.15.8"
 fn print_changes_versus_previous_version_advises_when_there_are_no_changes() {
     let temp_dir = assert_fs::TempDir::new().unwrap();
     let temporary_cargo_toml_path = get_temporary_cargo_toml_path(&temp_dir);
-    let cargo_toml_file = CargoTomlFile::new(temporary_cargo_toml_path.to_str().unwrap()).unwrap();
+    let cargo_toml_file = File::new(temporary_cargo_toml_path.to_str().unwrap()).unwrap();
 
     // act
     let output = cargo_toml_file
@@ -230,8 +229,8 @@ assert_fs = "1.1.2"
 trycmd = "0.15.8"
 "#;
 
-    let updated_cargo_toml = CargoTomlFile::new_from_str(updated_cargo_toml_content).unwrap();
-    let earlier_cargo_toml = CargoTomlFile::new_from_str(earlier_cargo_toml_content).unwrap();
+    let updated_cargo_toml = File::new_from_str(updated_cargo_toml_content).unwrap();
+    let earlier_cargo_toml = File::new_from_str(earlier_cargo_toml_content).unwrap();
     // act
     let output = updated_cargo_toml
         .print_changes_versus_previous_version(&earlier_cargo_toml)
@@ -310,8 +309,8 @@ assert_fs = "1.1.2"
 trycmd = "0.15.8"
 "#;
 
-    let updated_cargo_toml = CargoTomlFile::new_from_str(updated_cargo_toml_content).unwrap();
-    let earlier_cargo_toml = CargoTomlFile::new_from_str(earlier_cargo_toml_content).unwrap();
+    let updated_cargo_toml = File::new_from_str(updated_cargo_toml_content).unwrap();
+    let earlier_cargo_toml = File::new_from_str(earlier_cargo_toml_content).unwrap();
 
     // act
     let output = updated_cargo_toml
@@ -389,8 +388,8 @@ assert_fs = "1.1.2"
 trycmd = "0.15.8"
 "#;
 
-    let updated_cargo_toml = CargoTomlFile::new_from_str(updated_cargo_toml_content).unwrap();
-    let earlier_cargo_toml = CargoTomlFile::new_from_str(earlier_cargo_toml_content).unwrap();
+    let updated_cargo_toml = File::new_from_str(updated_cargo_toml_content).unwrap();
+    let earlier_cargo_toml = File::new_from_str(earlier_cargo_toml_content).unwrap();
 
     // act
     let output = updated_cargo_toml
@@ -475,8 +474,8 @@ trycmd = "0.15.8"
 wiremock = "0.6.2"
 "#;
 
-    let updated_cargo_toml = CargoTomlFile::new_from_str(updated_cargo_toml_content).unwrap();
-    let earlier_cargo_toml = CargoTomlFile::new_from_str(earlier_cargo_toml_content).unwrap();
+    let updated_cargo_toml = File::new_from_str(updated_cargo_toml_content).unwrap();
+    let earlier_cargo_toml = File::new_from_str(earlier_cargo_toml_content).unwrap();
 
     // act
     let output = updated_cargo_toml
@@ -562,8 +561,8 @@ fs_extra = "1.3.0"
 glob = "0.3.1"
 "#;
 
-    let updated_cargo_toml = CargoTomlFile::new_from_str(updated_cargo_toml_content).unwrap();
-    let earlier_cargo_toml = CargoTomlFile::new_from_str(earlier_cargo_toml_content).unwrap();
+    let updated_cargo_toml = File::new_from_str(updated_cargo_toml_content).unwrap();
+    let earlier_cargo_toml = File::new_from_str(earlier_cargo_toml_content).unwrap();
 
     // act
     let output = updated_cargo_toml
@@ -624,7 +623,7 @@ fn new_from_buffer_creates_expected_config() {
     ];
 
     // act
-    let outcome = CargoTomlFile::new_from_buffer(&buffer).unwrap();
+    let outcome = File::new_from_buffer(&buffer).unwrap();
 
     // assert
     insta::assert_snapshot!(format!("{outcome:?}"));

src/domain/mod.rs

@@ -3,6 +3,6 @@ pub mod cargo_toml;
 pub mod repo;
 pub mod semver;
 
-pub use cargo_toml::CargoTomlFile;
+pub use cargo_toml::File as CargoTomlFile;
 pub use repo::Repo;
-pub use semver::SemverVersion;
+pub use semver::Version as SemverVersion;