fallow-cli 2.77.0

use std::path::Path;

/// Encoding shape of a source file, captured at read time so the matching
/// write call can round-trip the same shape: same line ending, BOM preserved
/// if the input had one. See issue #475.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(super) struct EncodingMetadata {
    /// Detected line ending (`"\r\n"` or `"\n"`). Pure CRLF and pure LF
    /// files are both supported; mixed files are surfaced via
    /// [`EncodingError::MixedLineEndings`] before this struct is built.
    pub line_ending: &'static str,
    /// True when the input file started with a UTF-8 BOM (`\u{FEFF}`).
    /// `stage_fixed_content` re-prepends the BOM bytes when this flag is
    /// set so `fallow fix` does not silently re-encode a Windows-authored
    /// file.
    pub had_bom: bool,
}

/// Errors that block a file from being fixed safely. Today there is one
/// variant; we keep the enum shape so future encoding checks (e.g. invalid
/// UTF-8 bytes, lone-CR Mac-classic files) can land additively.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(super) enum EncodingError {
    /// The file contains both CRLF and bare-LF line endings. The fix
    /// pipeline detects line endings by presence check then splits / joins
    /// on the detected style; on a mixed file that would silently rewrite
    /// to the wrong offsets. Skipping is safer than a destructive guess.
    MixedLineEndings {
        crlf_count: usize,
        lf_only_count: usize,
    },
}

/// Read a source file, validate it is within the project root, strip an
/// optional UTF-8 BOM, detect line endings, and reject mixed CRLF/LF
/// content.
///
/// Returns:
/// - `Ok(Some((content_post_bom, metadata)))` on success.
/// - `Ok(None)` when the path is outside the project root or unreadable
///   (existing skip-with-warn semantics preserved).
/// - `Err(EncodingError::MixedLineEndings { .. })` when the file mixes CRLF
///   and bare-LF line endings; the caller translates this into a per-file
///   skip with a clear remediation message.
pub(super) fn read_source(
    root: &Path,
    path: &Path,
) -> Result<Option<(String, EncodingMetadata)>, EncodingError> {
    if !path.starts_with(root) {
        tracing::warn!(path = %path.display(), "Skipping fix for path outside project root");
        return Ok(None);
    }
    let Ok(raw) = std::fs::read_to_string(path) else {
        return Ok(None);
    };
    classify_source(&raw).map(|(content, metadata)| Some((content, metadata)))
}

/// Pure shape-classification helper: strip BOM, detect mixed CRLF/LF, and
/// pick the line-ending style. Factored out of `read_source` so the staged
/// fast path in `plan.rs` (cross-fixer composition) can reuse the same
/// classifier on in-memory bytes without a disk round-trip.
pub(super) fn classify_source(raw: &str) -> Result<(String, EncodingMetadata), EncodingError> {
    let had_bom = raw.starts_with('\u{FEFF}');
    // `strip_prefix` returns the original slice when the prefix is absent, so
    // `unwrap_or(raw)` is identical to a branched `if had_bom { strip } else
    // { raw }` without leaving an `.expect()` panic in production code.
    let content = raw.strip_prefix('\u{FEFF}').unwrap_or(raw).to_owned();

    let crlf_count = content.matches("\r\n").count();
    let lf_total = content.matches('\n').count();
    let lf_only_count = lf_total.saturating_sub(crlf_count);
    if crlf_count > 0 && lf_only_count > 0 {
        return Err(EncodingError::MixedLineEndings {
            crlf_count,
            lf_only_count,
        });
    }

    let line_ending = if crlf_count > 0 { "\r\n" } else { "\n" };
    Ok((
        content,
        EncodingMetadata {
            line_ending,
            had_bom,
        },
    ))
}

/// Convert `body` into wire bytes, re-prepending the UTF-8 BOM when
/// `meta.had_bom` is true. Used by fixers that build their own whole-file
/// rewrite as a `String` (catalog YAML writer) and stage the resulting
/// `Vec<u8>` directly on the plan, in place of `stage_fixed_content`. The
/// BOM is structurally legal in YAML (the parser tolerates it) but rare in
/// practice; preserving it matters for symmetry with the source-code path.
/// Issue #475.
pub(super) fn bytes_with_optional_bom(body: String, meta: &EncodingMetadata) -> Vec<u8> {
    if meta.had_bom {
        let bom_bytes = "\u{FEFF}".as_bytes();
        let mut buf = Vec::with_capacity(body.len() + bom_bytes.len());
        buf.extend_from_slice(bom_bytes);
        buf.extend_from_slice(body.as_bytes());
        buf
    } else {
        body.into_bytes()
    }
}

pub(super) use fallow_config::atomic_write;

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn atomic_write_creates_file_with_content() {
        let dir = tempfile::tempdir().unwrap();
        let path = dir.path().join("test.ts");
        atomic_write(&path, b"hello world").unwrap();
        assert_eq!(std::fs::read_to_string(&path).unwrap(), "hello world");
    }

    #[test]
    fn atomic_write_overwrites_existing_file() {
        let dir = tempfile::tempdir().unwrap();
        let path = dir.path().join("test.ts");
        std::fs::write(&path, "old content").unwrap();
        atomic_write(&path, b"new content").unwrap();
        assert_eq!(std::fs::read_to_string(&path).unwrap(), "new content");
    }

    #[test]
    fn atomic_write_no_leftover_temp_on_success() {
        let dir = tempfile::tempdir().unwrap();
        let path = dir.path().join("test.ts");
        atomic_write(&path, b"data").unwrap();
        // Only the target file should exist; no stray temp files
        let entries: Vec<_> = std::fs::read_dir(dir.path())
            .unwrap()
            .filter_map(Result::ok)
            .collect();
        assert_eq!(entries.len(), 1);
        assert_eq!(entries[0].file_name(), "test.ts");
    }

    #[test]
    fn atomic_write_to_nonexistent_dir_fails() {
        let dir = tempfile::tempdir().unwrap();
        let path = dir.path().join("nonexistent_dir").join("file.ts");
        let result = atomic_write(&path, b"content");
        assert!(result.is_err());
    }

    #[test]
    fn atomic_write_empty_content() {
        let dir = tempfile::tempdir().unwrap();
        let path = dir.path().join("empty.ts");
        atomic_write(&path, b"").unwrap();
        assert_eq!(std::fs::read_to_string(&path).unwrap(), "");
    }

    #[test]
    fn atomic_write_binary_content() {
        let dir = tempfile::tempdir().unwrap();
        let path = dir.path().join("binary.dat");
        let data: Vec<u8> = (0..=255).collect();
        atomic_write(&path, &data).unwrap();
        assert_eq!(std::fs::read(&path).unwrap(), data);
    }

    // -- read_source tests ---------------------------------------------------

    #[test]
    fn read_source_returns_none_for_path_outside_root() {
        let dir = tempfile::tempdir().unwrap();
        let root = dir.path().join("project");
        std::fs::create_dir_all(&root).unwrap();
        let outside = dir.path().join("outside.ts");
        std::fs::write(&outside, "content").unwrap();

        let result = read_source(&root, &outside).unwrap();
        assert!(result.is_none());
    }

    #[test]
    fn read_source_returns_none_for_nonexistent_file() {
        let dir = tempfile::tempdir().unwrap();
        let root = dir.path();
        let missing = root.join("missing.ts");

        let result = read_source(root, &missing).unwrap();
        assert!(result.is_none());
    }

    #[test]
    fn read_source_detects_lf_line_ending() {
        let dir = tempfile::tempdir().unwrap();
        let root = dir.path();
        let file = root.join("lf.ts");
        std::fs::write(&file, "line1\nline2\n").unwrap();

        let (content, meta) = read_source(root, &file).unwrap().unwrap();
        assert_eq!(meta.line_ending, "\n");
        assert!(!meta.had_bom);
        assert_eq!(content, "line1\nline2\n");
    }

    #[test]
    fn read_source_detects_crlf_line_ending() {
        let dir = tempfile::tempdir().unwrap();
        let root = dir.path();
        let file = root.join("crlf.ts");
        std::fs::write(&file, "line1\r\nline2\r\n").unwrap();

        let (content, meta) = read_source(root, &file).unwrap().unwrap();
        assert_eq!(meta.line_ending, "\r\n");
        assert!(!meta.had_bom);
        assert_eq!(content, "line1\r\nline2\r\n");
    }

    #[test]
    fn read_source_empty_file() {
        let dir = tempfile::tempdir().unwrap();
        let root = dir.path();
        let file = root.join("empty.ts");
        std::fs::write(&file, "").unwrap();

        let (content, meta) = read_source(root, &file).unwrap().unwrap();
        assert_eq!(content, "");
        assert_eq!(meta.line_ending, "\n"); // defaults to LF when no line endings found
        assert!(!meta.had_bom);
    }

    // -- BOM + mixed-EOL tests (issue #475) ---------------------------------

    #[test]
    fn read_source_strips_utf8_bom_and_flags_metadata() {
        let dir = tempfile::tempdir().unwrap();
        let root = dir.path();
        let file = root.join("bom.ts");
        // EF BB BF + "export const x = 1;\nexport const y = 2;\n"
        std::fs::write(&file, "\u{FEFF}export const x = 1;\nexport const y = 2;\n").unwrap();

        let (content, meta) = read_source(root, &file).unwrap().unwrap();
        assert!(meta.had_bom, "BOM presence must be flagged on metadata");
        assert!(
            !content.starts_with('\u{FEFF}'),
            "returned content must have the BOM stripped",
        );
        assert_eq!(content, "export const x = 1;\nexport const y = 2;\n");
        assert_eq!(meta.line_ending, "\n");
    }

    #[test]
    fn read_source_detects_pure_crlf_with_bom() {
        let dir = tempfile::tempdir().unwrap();
        let root = dir.path();
        let file = root.join("bom-crlf.ts");
        std::fs::write(&file, "\u{FEFF}line1\r\nline2\r\n").unwrap();

        let (content, meta) = read_source(root, &file).unwrap().unwrap();
        assert!(meta.had_bom);
        assert_eq!(meta.line_ending, "\r\n");
        assert_eq!(content, "line1\r\nline2\r\n");
    }

    #[test]
    fn read_source_detects_mixed_crlf_lf_and_returns_err() {
        let dir = tempfile::tempdir().unwrap();
        let root = dir.path();
        let file = root.join("mixed.ts");
        // CRLF on line 1, LF on lines 2 and 3.
        std::fs::write(
            &file,
            "export const a = 1;\r\nexport const b = 2;\nexport const c = 3;\r\n",
        )
        .unwrap();

        let err = read_source(root, &file).unwrap_err();
        match err {
            EncodingError::MixedLineEndings {
                crlf_count,
                lf_only_count,
            } => {
                assert_eq!(crlf_count, 2, "two CRLF lines");
                assert_eq!(lf_only_count, 1, "one bare-LF line");
            }
        }
    }

    #[test]
    fn read_source_mixed_with_bom_is_still_mixed_after_strip() {
        // The BOM strip happens first; mixed-EOL detection runs on the
        // post-strip view. A BOM-bearing file with mixed line endings is
        // still mixed and must surface the same error.
        let dir = tempfile::tempdir().unwrap();
        let root = dir.path();
        let file = root.join("bom-mixed.ts");
        std::fs::write(&file, "\u{FEFF}a\r\nb\nc\r\n").unwrap();

        let err = read_source(root, &file).unwrap_err();
        assert!(matches!(err, EncodingError::MixedLineEndings { .. }));
    }

    #[test]
    fn classify_source_pure_lf_no_bom_round_trips() {
        // Sanity check on the classifier directly: pure LF, no BOM is the
        // happy path that pre-#475 code optimized for.
        let (content, meta) = classify_source("a\nb\nc\n").unwrap();
        assert_eq!(content, "a\nb\nc\n");
        assert_eq!(meta.line_ending, "\n");
        assert!(!meta.had_bom);
    }

    #[test]
    fn classify_source_single_line_no_newline_defaults_to_lf() {
        let (_, meta) = classify_source("single line").unwrap();
        assert_eq!(meta.line_ending, "\n");
        assert!(!meta.had_bom);
    }

    // The line-ending-preserving join logic that used to live in this
    // module is now covered by plan.rs::stage_fixed_content + the
    // per-fixer round-trip integration tests under crates/cli/tests/.
}