mmz 0.10.0

//! The mmz manifest (`.mmz/config.yaml`): named input scopes and the command
//! rules that reference them.

use std::collections::BTreeMap;
use std::path::{Path, PathBuf};

use serde::{Deserialize, Deserializer};

use crate::error::{Error, Result};
use crate::probe::Probe;
use crate::resolve::GlobGroup;

/// Directory holding mmz's per-project state, found by walking upward. The
/// config lives inside it so a project gains one entry, not two.
pub const CONFIG_DIR: &str = ".mmz";

/// Config file names within [`CONFIG_DIR`], tried in order during discovery.
const CONFIG_NAMES: [&str; 2] = ["config.yaml", "config.yml"];

/// Default for [`Manifest::gitignore`]. `pub(crate)` so [`crate::compose`] can
/// apply the same default when a root manifest omits the key.
pub(crate) const fn default_gitignore() -> bool {
    true
}

/// Default for [`Manifest::cache_dir`] — the gitignored state directory, nested
/// under [`CONFIG_DIR`] so a single `.mmz/.gitignore` can cover it.
/// `pub(crate)` so [`crate::compose`] can apply the same default when a root
/// manifest omits the key.
pub(crate) fn default_cache_dir() -> String {
    ".mmz/cache".to_owned()
}

/// Default for [`Manifest::probe_shell`] — `sh -c`, the shell every probe ran
/// under before the key existed. `pub(crate)` so [`crate::compose`] can apply
/// the same default when a root manifest omits the key.
pub(crate) fn default_probe_shell() -> Vec<String> {
    crate::probe::DEFAULT_SHELL
        .iter()
        .map(|part| (*part).to_owned())
        .collect()
}

/// Trims each declared tag and drops the ones left blank, so a stray
/// whitespace-only entry can never silently fail to match `--tag`. Case is
/// left untouched — tags compare exactly.
fn normalize_tags<'de, D>(deserializer: D) -> std::result::Result<Vec<String>, D::Error>
where
    D: Deserializer<'de>,
{
    let raw = Vec::<String>::deserialize(deserializer)?;
    Ok(raw
        .into_iter()
        .map(|tag| tag.trim().to_owned())
        .filter(|tag| !tag.is_empty())
        .collect())
}

/// A named input scope: the patterns it contributes, plus an optional
/// per-scope override of the manifest's `gitignore` filter.
///
/// The array form is the common spelling and inherits the manifest-level
/// setting:
///
/// ```yaml
/// scopes:
///   src: ["src/**"]
/// ```
///
/// The object form names the patterns under `globs` and may pin `gitignore` for
/// this scope alone. That is the escape hatch for a scope naming build
/// artifacts: they live in git-ignored paths by definition, so under the
/// default filter the scope resolves empty and every rule referencing it is
/// fresh forever.
///
/// ```yaml
/// scopes:
///   lcov:
///     gitignore: false
///     globs: ["target/coverage/lcov.info"]
/// ```
#[derive(Debug, Clone, Deserialize)]
#[serde(try_from = "ScopeSpelling")]
pub struct Scope {
    /// Glob patterns and literal paths this scope contributes.
    pub globs: Vec<String>,
    /// Per-scope override of [`Manifest::gitignore`]; `None` inherits it.
    pub gitignore: Option<bool>,
}

impl Scope {
    /// Whether this scope's globs skip git-ignored paths: its own `gitignore`
    /// when set, else the manifest-level `inherited` value.
    #[must_use]
    pub fn honours_gitignore(&self, inherited: bool) -> bool {
        self.gitignore.unwrap_or(inherited)
    }
}

/// The two manifest spellings of a scope value, normalized into [`Scope`].
#[derive(Debug, Clone, Deserialize)]
#[serde(untagged)]
enum ScopeSpelling {
    /// The array form — patterns only, inheriting the manifest's `gitignore`.
    Patterns(Vec<String>),
    /// The object form — `globs` plus an optional per-scope `gitignore`.
    Object(ScopeObject),
}

/// The object spelling's fields. `globs` is optional here only so that omitting
/// it is reported against the object rather than as a failure to match either
/// spelling; [`Scope`]'s conversion rejects both a missing and an empty list.
#[derive(Debug, Clone, Deserialize)]
#[serde(deny_unknown_fields)]
struct ScopeObject {
    #[serde(default)]
    globs: Option<Vec<String>>,
    #[serde(default)]
    gitignore: Option<bool>,
}

impl TryFrom<ScopeSpelling> for Scope {
    type Error = String;

    fn try_from(spelling: ScopeSpelling) -> std::result::Result<Self, Self::Error> {
        let object = match spelling {
            ScopeSpelling::Patterns(globs) => {
                return Ok(Self {
                    globs,
                    gitignore: None,
                });
            }
            ScopeSpelling::Object(object) => object,
        };
        let globs = object
            .globs
            .ok_or_else(|| "a scope object must list its patterns under `globs`".to_owned())?;
        if globs.is_empty() {
            return Err("a scope object's `globs` must list at least one pattern".to_owned());
        }
        Ok(Self {
            globs,
            gitignore: object.gitignore,
        })
    }
}

/// How a rule's `name` is matched against an invoked command.
///
/// Both modes split `name` on whitespace into tokens. The difference is whether
/// trailing argv beyond those tokens is allowed.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum MatchMode {
    /// The tokens are a leading slice of argv, so `cargo test` matches
    /// `cargo test` and `cargo test --workspace`. The default.
    #[default]
    Prefix,
    /// The tokens equal argv exactly, so `cargo test` matches only the bare
    /// `cargo test`. Narrowing only — never causes a wrongful skip.
    Exact,
}

/// The `strict` policy's two types, split out once this file reached its line
/// cap. Re-exported so every `manifest::StrictCase` / `manifest::StrictPolicy`
/// path outside this module keeps working without knowing the split happened.
#[path = "manifest_strict.rs"]
mod strict;
pub use strict::{StrictCase, StrictPolicy};

/// A declared set of command rules and the input scopes they draw on.
///
/// # Adding a key here is not a one-file change
///
/// `deny_unknown_fields` means this struct is the manifest's whole surface,
/// and several things downstream are derived from that surface rather than
/// discovering it — so a field added here and nowhere else fails a gate rather
/// than shipping half-wired. Every site below is enforced by a test or a gate,
/// which is deliberate: the list rots, the failures do not. It is here rather
/// than in a contributing doc because this is the struct you are editing when
/// you need it.
///
/// 1. The field, with `#[serde(default …)]` and a doc comment. A default that
///    is not a literal needs a `default_*` helper above, and `pub(crate)` on it
///    so [`crate::compose`] can apply the same one.
/// 2. `schema/mmz.schema.json`, with a `description`. `src/schema.rs`'s
///    `schema_documents_every_manifest_field` fails without it, and the
///    fragment schema is derived by removing the policy keys — so a non-policy
///    key needs nothing there, and a policy key needs the removal to still
///    hold.
/// 3. `www/utils/config-notes.typ`, keyed exactly as the reference renders it
///    (bare at top level, `commands[].`/`probes[].`/`scopes[].` below).
///    `just check-doc-facts` asserts the schema's key set and the notes' key
///    set match in *both* directions.
/// 4. If it can be validated, [`Manifest::validate`] — and the error in
///    [`crate::error::Error`] plus its arm in `main.rs`'s `exit_for`, which is
///    non-exhaustive and will not compile without one. Prefer an existing exit
///    code; a new one is a documented CLI surface (`www/utils/exit-code-notes.typ`).
///
/// A key that governs the whole run is additionally a *policy* key, which is a
/// second wiring path: add it to [`crate::compose::POLICY_KEYS`] (a fixed-size
/// array, so the destructurings in `compose_policy.rs` fail to compile until
/// updated), resolve it in `compose_policy::resolve`, add it to
/// [`crate::compose::Document`] as `Option<Option<T>>` so an explicit `null` is
/// caught, and render it in `dump.rs`'s `Policy` and `render_policy` — which is
/// what makes `mmz --dump-config` able to say whether it was written or
/// defaulted.
///
/// Editing any of `src/manifest.rs`, `src/probe.rs` or `src/main.rs` also puts
/// an `outdatty` group out of date. That is the gate asking you to confirm you
/// looked at the dependents, not a failure to fix — `outdatty update --group
/// <name>` after reviewing them.
#[derive(Debug, Clone, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Manifest {
    /// Reusable named glob sets. A scope is defined once and referenced by any
    /// number of commands, so a shared input path is declared in one place.
    /// Each value is either an array of patterns or an object carrying a
    /// per-scope `gitignore` override (see [`Scope`]).
    #[serde(default)]
    pub scopes: BTreeMap<String, Scope>,

    /// Named commands whose stdout is an input. A rule's `inputs:` references a
    /// probe by name exactly as it references a scope, and the probe's stdout
    /// hash joins that rule's input digest — which is how a rule depends on
    /// part of a file, or on something that is not a file at all. One
    /// namespace: a probe sharing a name with a scope is a load error. See
    /// [`crate::probe`], including what a probe can get wrong that a file hash
    /// cannot.
    #[serde(default)]
    pub probes: BTreeMap<String, Probe>,

    /// Ordered command rules. The first rule whose `name` is a token-prefix of
    /// the invoked command wins; its inputs determine the cache.
    #[serde(default)]
    pub commands: Vec<Command>,

    /// When true (the default), glob expansion skips paths ignored by git, so
    /// build artifacts never enter an input set. Set false to match every file
    /// on disk. A scope may override this for itself (see [`Scope`]).
    #[serde(default = "default_gitignore")]
    pub gitignore: bool,

    /// Directory for throwaway cache records, relative to the project root —
    /// the directory holding `.mmz` (an absolute path is used as-is). Must be
    /// git-ignored. Defaults to `.mmz/cache`.
    #[serde(default = "default_cache_dir")]
    pub cache_dir: String,

    /// Runtime cases mmz errors on instead of falling back to passthrough.
    /// Omitted means all cases (the default); see [`StrictPolicy`].
    #[serde(default = "StrictPolicy::all")]
    pub strict: StrictPolicy,

    /// The argv a probe's `run` line is executed by, with the line appended as
    /// one final argument. Defaults to `["sh", "-c"]`, which is what every
    /// probe ran under before the key existed.
    ///
    /// A probe measures whatever the ambient `PATH` resolves, so a manifest
    /// whose probes read project tooling can pin the environment they are
    /// measured in — `["direnv", "exec", ".", "sh", "-c"]`, or
    /// `["nix", "develop", "--command", "sh", "-c"]` — instead of inheriting
    /// whichever shell the caller happened to be in. The `run:` lines are
    /// untouched by this: only the process interpreting them changes.
    ///
    /// Must name at least a program; an empty list is a load error, since
    /// there would be nothing to spawn. See [`crate::probe`].
    #[serde(default = "default_probe_shell")]
    pub probe_shell: Vec<String>,

    /// Message printed to stderr when a command is skipped (a cache hit).
    /// `{cache:<field>}` macros substitute a field from the matched rule's
    /// cache record (e.g. `command`, `ran_at`, `input_digest`). An empty string
    /// prints nothing. A command's own `on_hit` overrides this. Default: none.
    #[serde(default)]
    pub on_hit: Option<String>,
}

/// A single command rule: a matcher plus the scopes that feed its cache.
#[derive(Debug, Clone, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Command {
    /// Matcher and the cache identity. `cargo test` matches any invocation
    /// beginning with the tokens `cargo test` (see [`Command::match_mode`]).
    pub name: String,

    /// Input names, each either a scope (whose globs union into this command's
    /// file set) or a probe (whose stdout hash joins its digest). One
    /// namespace, so the two kinds are written identically here.
    #[serde(default)]
    pub inputs: Vec<String>,

    /// Literal paths a successful run of this command is expected to produce,
    /// relative to the project root. The rule is fresh only when its inputs
    /// still hash the same AND every declared output exists, so an artifact
    /// deleted out from under a record (a `cargo clean`, a fresh clone, a
    /// pruned `target/`) voids that record instead of leaving the rule fresh
    /// with nothing to show for it.
    ///
    /// Existence only — an output is never hashed — and each path is stat-ed,
    /// never walked, so the `gitignore` filter never applies to it. Patterns
    /// are rejected at load; see [`crate::outputs`].
    #[serde(default)]
    pub outputs: Vec<PathBuf>,

    /// How `name` matches argv: token-prefix (default) or exact. Spelled
    /// `match` in the manifest.
    #[serde(rename = "match", default)]
    pub match_mode: MatchMode,

    /// Free-form labels filtered by `mmz --is-fresh --tag <tag>` (and
    /// `--status --tag <tag>`); a rule with no tags never matches a `--tag`
    /// filter. Case-faithful; each entry is trimmed and blanks are dropped
    /// (see [`normalize_tags`]). Duplicates within one rule are rejected by
    /// [`Manifest::validate`].
    #[serde(default, deserialize_with = "normalize_tags")]
    pub tags: Vec<String>,

    /// Overrides the manifest-level `on_hit` for this rule; an empty string
    /// suppresses the notice. Default: inherit the manifest's `on_hit`.
    #[serde(default)]
    pub on_hit: Option<String>,
}

impl Manifest {
    /// Loads and validates a manifest from `path`, following its `imports:`
    /// chain (if any) and merging every fragment it names into one model. See
    /// [`crate::compose`] for the merge rules; [`Manifest::locate`] is the
    /// entry point that also keeps the provenance this discards.
    ///
    /// # Errors
    ///
    /// Same as [`Located::at`], whose result this discards all but the merged
    /// manifest of.
    pub fn load(path: &Path) -> Result<Self> {
        Ok(Located::at(path)?.manifest)
    }

    /// Checks invariants the schema cannot express: no probe shadows a scope;
    /// command names are present, unique, and reference only declared inputs;
    /// tags are unique per command; declared outputs are literal paths.
    ///
    /// # Errors
    ///
    /// Returns [`Error::NameCollision`], [`Error::EmptyCommandName`],
    /// [`Error::DuplicateCommand`], [`Error::UnknownScope`],
    /// [`Error::UnknownInput`], [`Error::DuplicateTag`], or
    /// [`Error::InvalidOutput`].
    pub fn validate(&self) -> Result<()> {
        crate::probe::validate(&self.probes, &self.scopes, &self.probe_shell)?;
        let mut seen: Vec<&str> = Vec::new();
        for (index, command) in self.commands.iter().enumerate() {
            if command.name.trim().is_empty() {
                return Err(Error::EmptyCommandName(index + 1));
            }
            if seen.contains(&command.name.as_str()) {
                return Err(Error::DuplicateCommand(command.name.clone()));
            }
            seen.push(command.name.as_str());
            if let Some(mac) = crate::parametric::parse(&command.name)? {
                if !self.scopes.contains_key(&mac.scope) {
                    return Err(Error::UnknownScope {
                        command: command.name.clone(),
                        scope: mac.scope,
                    });
                }
            }
            for input in &command.inputs {
                if !self.scopes.contains_key(input) && !self.probes.contains_key(input) {
                    return Err(Error::UnknownInput {
                        command: command.name.clone(),
                        input: input.clone(),
                    });
                }
            }
            crate::outputs::validate(&command.name, &command.outputs)?;
            let mut seen_tags: Vec<&str> = Vec::new();
            for tag in &command.tags {
                if seen_tags.contains(&tag.as_str()) {
                    return Err(Error::DuplicateTag {
                        command: command.name.clone(),
                        tag: tag.clone(),
                    });
                }
                seen_tags.push(tag.as_str());
            }
        }
        Ok(())
    }

    /// Returns the glob patterns a command draws from, bucketed by the
    /// gitignore setting they expand under: one group for the scopes honouring
    /// the filter and one for the scopes that opted out, each deduplicated and
    /// omitted when no scope feeds it.
    ///
    /// Bucketing rather than one group per scope keeps the filesystem walk
    /// count at two in the worst case, however many scopes a rule references.
    ///
    /// An `inputs` entry naming a probe contributes no patterns and is skipped
    /// here; [`crate::probe::Resolver`] owns that half of the input set.
    ///
    /// # Errors
    ///
    /// Returns [`Error::UnknownInput`] if an entry is neither a declared scope
    /// nor a declared probe.
    pub fn glob_groups(&self, command: &Command) -> Result<Vec<GlobGroup>> {
        let mut honoured: Vec<String> = Vec::new();
        let mut opted_out: Vec<String> = Vec::new();
        for name in &command.inputs {
            let Some(scope) = self.scopes.get(name) else {
                if self.probes.contains_key(name) {
                    continue;
                }
                return Err(Error::UnknownInput {
                    command: command.name.clone(),
                    input: name.clone(),
                });
            };
            let bucket = if scope.honours_gitignore(self.gitignore) {
                &mut honoured
            } else {
                &mut opted_out
            };
            for glob in &scope.globs {
                if !bucket.contains(glob) {
                    bucket.push(glob.clone());
                }
            }
        }
        Ok([(true, honoured), (false, opted_out)]
            .into_iter()
            .filter(|(_, globs)| !globs.is_empty())
            .map(|(gitignore, globs)| GlobGroup { globs, gitignore })
            .collect())
    }

    /// Walks up from `start` to the filesystem root, returning the first
    /// `.mmz/config.yaml` (or `.yml`) found.
    #[must_use]
    pub fn discover(start: &Path) -> Option<PathBuf> {
        let mut dir = Some(start);
        while let Some(current) = dir {
            for name in CONFIG_NAMES {
                let candidate = current.join(CONFIG_DIR).join(name);
                if candidate.is_file() {
                    return Some(candidate);
                }
            }
            dir = current.parent();
        }
        None
    }

    /// Discovers, loads, and validates the nearest manifest above `cwd`, pairing
    /// it with the project root its relative paths resolve against and the
    /// provenance of every scope, probe and command in the merged model.
    ///
    /// # Errors
    ///
    /// Returns [`Error::NoManifest`] when none is found, plus anything
    /// [`Located::at`] returns for the manifest it found.
    pub fn locate(cwd: &Path) -> Result<Located> {
        let discovered = Self::discover(cwd).ok_or_else(|| Error::NoManifest {
            start: cwd.to_path_buf(),
        })?;
        Located::at(&discovered)
    }
}

/// The discovered manifest and the root it is anchored to — the pairing every
/// entry point above hands back, split out to `manifest_located.rs` once this
/// file reached its own line cap. [`Located`] keeps its original
/// `crate::manifest::Located` path via the re-export below, so nothing outside
/// this module has to know the split happened.
#[path = "manifest_located.rs"]
mod located;
pub use located::Located;

#[cfg(test)]
#[path = "manifest_tests.rs"]
mod tests;