cargo-rail: docs cleaning; test cleaning

Author: loadingalias

src/cargo/manifest.rs

@@ -26,6 +26,7 @@ pub struct CargoTransform {
 }
 
 impl CargoTransform {
+  /// Create a new CargoTransform from workspace metadata
   pub fn new(workspace_metadata: WorkspaceMetadata) -> Self {
     let mut workspace_versions = HashMap::new();
     let mut workspace_paths = HashMap::new();
@@ -205,6 +206,9 @@ impl CargoTransform {
 }
 
 impl CargoTransform {
+  /// Transform a Cargo.toml for split repository
+  ///
+  /// Converts workspace inheritance and path dependencies to standalone format
   pub fn transform_to_split(&self, content: &str, _context: &TransformContext) -> RailResult<String> {
     let mut doc: DocumentMut = content.parse().context("Failed to parse Cargo.toml")?;
 
@@ -220,6 +224,9 @@ impl CargoTransform {
     Ok(doc.to_string())
   }
 
+  /// Transform a Cargo.toml back to monorepo format
+  ///
+  /// Converts version dependencies to path dependencies for workspace members
   pub fn transform_to_mono(&self, content: &str, _context: &TransformContext) -> RailResult<String> {
     let mut doc: DocumentMut = content.parse().context("Failed to parse Cargo.toml")?;
 

src/cargo/metadata.rs

@@ -55,10 +55,12 @@ impl WorkspaceMetadata {
   // Basic Package Access
   // ============================================================================
 
+  /// Get all workspace member packages
   pub fn list_crates(&self) -> Vec<&Package> {
     self.metadata.workspace_packages()
   }
 
+  /// Find a package by name in the workspace
   pub fn get_package(&self, name: &str) -> Option<&Package> {
     self
       .metadata
@@ -67,6 +69,7 @@ impl WorkspaceMetadata {
       .find(|pkg| pkg.name == name)
   }
 
+  /// Get the workspace root directory path
   pub fn workspace_root(&self) -> &std::path::Path {
     self.metadata.workspace_root.as_std_path()
   }
@@ -202,19 +205,6 @@ mod tests {
     assert!(missing.is_none(), "Non-existent package should be None");
   }
 
-  #[test]
-  fn test_workspace_root() {
-    let metadata = create_test_metadata();
-    let root = metadata.workspace_root();
-
-    // Should return valid path
-    assert!(root.exists(), "Workspace root should exist");
-    assert!(root.is_dir(), "Workspace root should be directory");
-
-    // Should contain Cargo.toml
-    assert!(root.join("Cargo.toml").exists(), "Should have Cargo.toml");
-  }
-
   // ============================================================================
   // Tier 2: Feature & Target Analysis
   // ============================================================================
@@ -272,43 +262,10 @@ mod tests {
     assert!(empty_features.is_ok(), "Should load with empty features list");
   }
 
-  #[test]
-  fn test_metadata_json() {
-    let metadata = create_test_metadata();
-    let raw = metadata.metadata_json();
-
-    // Should have access to raw metadata
-    assert!(!raw.packages.is_empty(), "Raw metadata should have packages");
-  }
-
   // ============================================================================
   // Feature Unification Tests
   // ============================================================================
 
-  #[test]
-  fn test_get_resolved_features_for_package() {
-    let metadata = create_test_metadata();
-
-    // Test with a known external dependency (serde)
-    // We know cargo-rail depends on serde
-    if let Some(features) = metadata.get_resolved_features_for_package("serde") {
-      // Resolved features should be a set
-      assert!(
-        !features.is_empty() || features.is_empty(),
-        "Features set should be valid"
-      );
-
-      // serde commonly has these features in resolved graph
-      // (may vary based on what other crates enable)
-      // Just verify we got a valid HashSet
-      let _features_vec: Vec<String> = features.into_iter().collect();
-    } else {
-      // It's ok if serde doesn't have resolved features in test context
-      // (might not be in resolve graph if running with limited metadata)
-      println!("Note: serde not found in resolved graph (test may need full metadata)");
-    }
-  }
-
   #[test]
   fn test_get_resolved_features_returns_none_for_workspace_members() {
     let metadata = create_test_metadata();

src/cargo/mod.rs

@@ -13,9 +13,13 @@
 //! - `unify` - Workspace dependency unification engine (replaces cargo-hakari)
 //! - `validate` - Optional per-target validation with Rayon parallelism
 
+/// Lossless Cargo.toml transformation
 pub mod manifest;
+/// Comprehensive cargo_metadata wrapper
 pub mod metadata;
+/// Workspace dependency unification engine
 pub mod unify;
+/// Per-target validation with parallel execution
 pub mod validate;
 
 pub use manifest::{CargoTransform, TransformContext};

src/cargo/unify/mod.rs

@@ -276,15 +276,6 @@ mod tests {
     WorkspaceMetadata::load(&current_dir).unwrap()
   }
 
-  #[test]
-  fn test_unify_config_default() {
-    let config = UnifyConfig::default();
-    assert!(matches!(config.strategy, UnifyStrategy::All));
-    assert!(!config.allow_renamed); // Renamed deps not allowed by default
-    assert!(config.exclude.is_empty());
-    assert!(config.include.is_empty());
-  }
-
   #[test]
   fn test_analyze_workspace() {
     let metadata = create_test_metadata();

src/cargo/unify/types.rs

@@ -96,7 +96,12 @@ pub struct UnificationPlan {
 #[derive(Debug, Clone)]
 pub enum MemberEdit {
   /// Convert dependency to workspace = true
-  UseWorkspace { dep_name: String, kind: DependencyKind },
+  UseWorkspace {
+    /// Dependency name
+    dep_name: String,
+    /// Dependency kind
+    kind: DependencyKind,
+  },
 }
 
 /// Severity of a unification issue

src/cargo/validate.rs

@@ -13,18 +13,26 @@ use std::sync::{Arc, Mutex};
 /// Result of validating a single target
 #[derive(Debug, Clone)]
 pub struct TargetValidationResult {
+  /// Target triple being validated
   pub target: String,
+  /// Whether validation succeeded
   pub success: bool,
+  /// Error message if validation failed
   pub error: Option<String>,
+  /// Warning messages from cargo metadata
   pub warnings: Vec<String>,
 }
 
 /// Summary of all target validations
 #[derive(Debug)]
 pub struct ValidationSummary {
+  /// Individual validation results for each target
   pub results: Vec<TargetValidationResult>,
+  /// Total number of targets validated
   pub total_targets: usize,
+  /// Number of successful validations
   pub successful: usize,
+  /// Number of failed validations
   pub failed: usize,
 }
 
@@ -225,56 +233,4 @@ mod tests {
     assert!(!result.success, "Invalid target should fail");
     assert!(result.error.is_some(), "Should have an error message");
   }
-
-  #[test]
-  fn test_validation_summary_all_passed() {
-    let summary = ValidationSummary {
-      results: vec![
-        TargetValidationResult {
-          target: "target1".to_string(),
-          success: true,
-          error: None,
-          warnings: vec![],
-        },
-        TargetValidationResult {
-          target: "target2".to_string(),
-          success: true,
-          error: None,
-          warnings: vec![],
-        },
-      ],
-      total_targets: 2,
-      successful: 2,
-      failed: 0,
-    };
-
-    assert!(summary.all_passed());
-    assert!(summary.failed_targets().is_empty());
-  }
-
-  #[test]
-  fn test_validation_summary_some_failed() {
-    let summary = ValidationSummary {
-      results: vec![
-        TargetValidationResult {
-          target: "target1".to_string(),
-          success: true,
-          error: None,
-          warnings: vec![],
-        },
-        TargetValidationResult {
-          target: "target2".to_string(),
-          success: false,
-          error: Some("Failed".to_string()),
-          warnings: vec![],
-        },
-      ],
-      total_targets: 2,
-      successful: 1,
-      failed: 1,
-    };
-
-    assert!(!summary.all_passed());
-    assert_eq!(summary.failed_targets(), vec!["target2"]);
-  }
 }

src/change_detection/classify.rs

@@ -17,7 +17,10 @@ pub enum ChangeKind {
   },
 
   /// Test code (does not affect downstream crates)
-  Test { kind: TestKind },
+  Test {
+    /// Type of test
+    kind: TestKind,
+  },
 
   /// Examples (compile but don't affect dependencies)
   Example,
@@ -26,7 +29,10 @@ pub enum ChangeKind {
   BuildScript,
 
   /// Configuration files
-  Config { kind: ConfigKind },
+  Config {
+    /// Type of configuration file
+    kind: ConfigKind,
+  },
 
   /// Documentation only (no rebuild/retest needed)
   Documentation,

src/commands/init.rs

@@ -661,37 +661,6 @@ pub fn run_init_standalone(
 #[cfg(test)]
 mod tests {
   use super::*;
-  use std::fs;
-  use tempfile::TempDir;
-
-  #[test]
-  fn test_check_existing_config() {
-    let temp_dir = TempDir::new().unwrap();
-
-    // No config exists
-    assert!(check_existing_config(temp_dir.path()).is_none());
-
-    // Create config at .config/rail.toml
-    let config_dir = temp_dir.path().join(".config");
-    fs::create_dir(&config_dir).unwrap();
-    fs::write(config_dir.join("rail.toml"), "").unwrap();
-
-    assert!(check_existing_config(temp_dir.path()).is_some());
-  }
-
-  #[test]
-  fn test_ensure_output_dir() {
-    let temp_dir = TempDir::new().unwrap();
-    let output_path = temp_dir.path().join(".config/rail.toml");
-
-    // Directory doesn't exist yet
-    assert!(!output_path.parent().unwrap().exists());
-
-    ensure_output_dir(&output_path).unwrap();
-
-    // Directory should now exist
-    assert!(output_path.parent().unwrap().exists());
-  }
 
   #[test]
   fn test_serialize_config_with_comments() {

src/commands/mod.rs

@@ -19,15 +19,25 @@
 //!
 //! All commands accept `&WorkspaceContext` to avoid redundant workspace loads.
 
+/// Find crates affected by changes
 pub mod affected;
+/// Common utilities for command implementations
 pub mod common;
+/// Initialize cargo-rail configuration
 pub mod init;
+/// Release planning and publishing
 pub mod release;
+/// Split crates into standalone repositories
 pub mod split;
+/// Show split/sync status for all crates
 pub mod status;
+/// Bidirectional sync between monorepo and split repos
 pub mod sync;
+/// Smart test runner for affected crates
 pub mod test;
+/// Workspace dependency unification commands
 pub mod unify;
+/// Watch mode for continuous testing
 pub mod watch;
 
 pub use affected::run_affected;

src/commands/status.rs

@@ -24,11 +24,22 @@ pub enum SyncStatus {
   /// Up to date
   UpToDate,
   /// Ahead of remote (N commits)
-  Ahead { commits: u64 },
+  Ahead {
+    /// Number of commits ahead
+    commits: u64,
+  },
   /// Behind remote (N commits)
-  Behind { commits: u64 },
+  Behind {
+    /// Number of commits behind
+    commits: u64,
+  },
   /// Diverged (ahead and behind)
-  Diverged { ahead: u64, behind: u64 },
+  Diverged {
+    /// Number of commits ahead
+    ahead: u64,
+    /// Number of commits behind
+    behind: u64,
+  },
 }
 
 /// Status information for a single crate