blockwatch 0.4.0

use serde::Serialize;

mod block_parser;
/// The `Block` type and the repository scan that turns source files into blocks to validate.
pub mod blocks;
/// Reads a unified diff into the per-file line changes that decide which blocks are checked.
pub mod diff_parser;
/// Command-line arguments and the accessors that turn them into globs, filters, and extension maps.
pub mod flags;
/// File access and path filtering behind traits, so tests can substitute fakes for the real disk.
pub mod fs;
/// One tree-sitter-backed comment parser per supported language, keyed by file extension.
pub mod language_parsers;
/// `RepoPath`: the single spelling of a repository-relative file path used as a map key.
pub mod repo_path;
/// Renders the end-of-run report describing what was scanned and checked.
pub mod report;
mod tag_parser;
/// The rules enforced on blocks (`affects`, `keep-sorted`, …) and the machinery that runs them.
pub mod validators;

/// A place in a source file.
#[derive(Serialize, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub struct Position {
    /// 1-based line number.
    pub line: usize,
    /// 1-based character (column) number.
    pub character: usize,
}

impl Position {
    /// Creates a position from a 1-based `line` and `character`.
    ///
    /// Callers converting from a 0-based source (tree-sitter rows/columns, diff offsets) must add
    /// one first.
    pub fn new(line: usize, character: usize) -> Self {
        Self { line, character }
    }
}

#[cfg(test)]
mod test_utils {
    use crate::blocks::{FileBlocks, ScanMode, parse_blocks};
    use crate::diff_parser::LineChange;
    use crate::fs::test_utils::{FakeFileSystem, FakePathChecker};
    use crate::language_parsers;
    use crate::repo_path::RepoPath;
    use crate::validators::ValidationContext;
    use std::collections::HashMap;
    use std::ops::Range;
    use std::sync::Arc;

    /// The start line of every block a validator reported checking, in the order it checked them.
    pub(crate) fn checked_lines(report: &crate::validators::ValidationReport) -> Vec<usize> {
        report
            .checked_blocks
            .iter()
            .map(|(_, position)| position.line)
            .collect()
    }

    /// How many violations a validator reported, across every file.
    pub(crate) fn violation_count(report: &crate::validators::ValidationReport) -> usize {
        report.violations.values().map(Vec::len).sum()
    }

    /// Finds the byte range of the first occurrence of a substring within a string.
    ///
    /// # Arguments
    /// * `input` - The string to search in
    /// * `substr` - The substring to find
    pub(crate) fn substr_range(input: &str, substr: &str) -> Range<usize> {
        let pos = input.find(substr).unwrap();
        pos..(pos + substr.len())
    }

    /// Creates a [`ValidationContext`] for the given `file_name` with `contents` with all lines
    /// modified.
    pub(crate) fn validation_context(file_name: &str, contents: &str) -> Arc<ValidationContext> {
        let line_changes: Vec<LineChange> = contents
            .lines()
            .enumerate()
            .map(|(line, _)| LineChange {
                line: line + 1,
                ranges: None,
            })
            .collect();
        build_validation_context(file_name, contents, line_changes)
    }

    /// Creates a [`ValidationContext`] for the given `file_name` with `contents` and specified
    /// `line_changes`, rooted at the current directory.
    pub(crate) fn validation_context_with_changes(
        file_name: &str,
        contents: &str,
        line_changes: Vec<LineChange>,
    ) -> Arc<ValidationContext> {
        build_validation_context(file_name, contents, line_changes)
    }

    fn build_validation_context(
        file_name: &str,
        contents: &str,
        line_changes: Vec<LineChange>,
    ) -> Arc<ValidationContext> {
        let file_system = FakeFileSystem::new(HashMap::from([(
            file_name.to_string(),
            contents.to_string(),
        )]));
        let line_changes_by_file =
            HashMap::from([(RepoPath::from_reference(file_name).unwrap(), line_changes)]);
        let parsers = language_parsers::language_parsers().unwrap();
        Arc::new(ValidationContext::new(
            parse_blocks(
                &line_changes_by_file,
                ScanMode::OnlyChanged,
                &file_system,
                &FakePathChecker::allow_all(),
                &parsers,
                HashMap::new(),
            )
            .unwrap()
            .blocks,
            parsers,
            line_changes_by_file,
        ))
    }

    /// Combines several single-file contexts into one, so a test can exercise a validator that
    /// resolves references across files.
    pub(crate) fn merge_validation_contexts(
        contexts: Vec<Arc<ValidationContext>>,
    ) -> Arc<ValidationContext> {
        let parsers = contexts
            .first()
            .map(|context| context.parsers.clone())
            .unwrap_or_default();
        let mut merged_modified_blocks = HashMap::new();
        let mut merged_line_changes = HashMap::new();
        for context in contexts {
            for (file_path, file_blocks) in &context.blocks {
                merged_modified_blocks
                    .entry(file_path.clone())
                    .or_insert_with(|| FileBlocks {
                        file_content: file_blocks.file_content.clone(),
                        blocks_with_context: vec![],
                    })
                    .blocks_with_context
                    .extend(file_blocks.blocks_with_context.clone());
            }
            for (file_path, line_changes) in &context.line_changes {
                merged_line_changes.insert(file_path.clone(), line_changes.to_vec());
            }
        }
        Arc::new(ValidationContext::new(
            merged_modified_blocks,
            parsers,
            merged_line_changes,
        ))
    }
}