ocpi_tariffs/

schema.rs

//! Validate a [`json::Document`] against the OCPI schema for a given version.
//!
//! The walk checks the JSON kind, string length, array cardinality, and enum variant of
//! every field the spec defines, and reports each violation as a [`Warning`]. It also
//! builds the intermediate representation the pricing, linting, and explain features read.
//!
//! [`Warning`] is the only public item here. The intermediate representation and the
//! per-version schema tables are an implementation detail: callers reach the validated
//! data through [`cdr::from_json`](crate::cdr::from_json) and
//! [`tariff::from_json`](crate::tariff::from_json), which return the [`Warning`]s this
//! module produced alongside the object they built.

pub(crate) mod v211;
pub(crate) mod v221;

mod build;

#[cfg(test)]
mod test_walk;

use std::collections::BTreeSet;

use crate::{
    json,
    warning::{self, IntoCaveat as _},
    Caveat, Verdict,
};

/// Lower a borrowed schema IR object `Source` into a domain type.
///
/// The schema has already validated the kind, length, cardinality, and enum
/// variants. The `FromSchema` only needs to perform semantic interpretation.
pub(crate) trait FromSchema<'buf, Source>: Sized {
    /// Warning type emitted for semantic issues found while lowering.
    type Warning: warning::Warning;

    /// Convert `source` to `Self`, collecting any semantic issues as warnings.
    fn from_schema(source: &Source) -> Verdict<Self, Self::Warning>;
}

/// A schema-IR value that carries the [`json::Element`] it was built from.
///
/// Every leaf ([`Str`], [`Number`], [`Enum`]) and every object IR value that retains its
/// element implements this. It gives the lowering step a uniform way to reach a value's
/// element without naming the concrete type.
///
/// See [`warning::Set::ok_or_bail`].
pub(crate) trait HasElement<'buf> {
    /// The element this value was built from.
    fn element(&self) -> &json::Element<'buf>;
}

/// Describes the expected structure of a JSON value.
#[derive(Clone, Copy)]
enum Schema {
    /// A scalar value of a known JSON kind (see [`Scalar`]).
    Scalar(Scalar),
    /// A JSON object with a known set of fields.
    Object(&'static Object),
    /// A JSON object the spec for this version does not define, but which this layer reads
    /// anyway (see [`Presence::NonSpec`]).
    ///
    /// A field the object does not list is not reported: the object itself is already
    /// flagged as non-spec, so listing what it contains adds noise rather than
    /// information.
    NonSpecObject(&'static Object),
    /// A `Price` value, which may be either a JSON object or a bare JSON number.
    ///
    /// OCPI 2.1.1 wrote a price as a bare `number`; 2.2.1 made it a `Price` object.
    /// A JSON object is validated against the wrapped [`Object`] as usual. A bare JSON
    /// number is accepted (and flagged as a type mismatch) and lowered to a `Price`
    /// whose `excl_vat` is that number, leaving `incl_vat` absent. Any other kind is a
    /// type error.
    Price(&'static Object),
    /// A homogeneous JSON array; each element validated against `item`, with a
    /// minimum element count given by `cardinality`.
    Array {
        item: &'static Schema,
        cardinality: Cardinality,
    },
}

/// The minimum number of elements an array must contain.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) enum Cardinality {
    /// An array with zero or more element is expected. An empty array is valid.
    ZeroOrMore,
    /// An array with one or more elements is expected. An empty array is a violation.
    OneOrMore,
}

impl std::fmt::Display for Cardinality {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Cardinality::ZeroOrMore => f.write_str("zero or more"),
            Cardinality::OneOrMore => f.write_str("one or more"),
        }
    }
}

/// The expected JSON kind of a scalar field.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum Scalar {
    /// A JSON string with no length bound. Covers OCPI `DateTime`, `date`, and
    /// `time` (which are format-constrained, not length-constrained) and any
    /// string the spec defines without a declared length. Strings the spec
    /// declares as `string(n)` / `CiString(n)` use [`Scalar::StringMax`]; enum
    /// types use [`Scalar::Enum`].
    String,
    /// A JSON string with a maximum character length, per the OCPI `string(n)`
    /// or `CiString(n)` declaration. The value is checked to be a string and
    /// then its decoded character count is compared against the length bound.
    StringMax(usize),
    /// A JSON string constrained to a fixed set of enum variants as defined
    /// in the OCPI spec. Every OCPI enum serializes as a string. This table
    /// lists each permitted spec value (the spec requires uppercase). The value
    /// is matched case-insensitively and the matched spec value is stored in
    /// [`Enum`], to be resolved to a typed variant during extraction.
    Enum(&'static [&'static str]),
    /// A JSON number. Covers OCPI `number`, `int`, and `decimal`.
    Number,
    /// A JSON boolean.
    Boolean,
    /// Any value; the JSON kind is not constrained. Used for fields whose value
    /// is a nested object or array this schema layer deliberately does not
    /// model (e.g. `BusinessDetails`, `Hours`).
    Any,
}

/// The integrity of a field. Building an IR value is infallible.
/// Every field ends in one of these states rather than aborting the build.
/// The detail behind `Err` (the kind mismatch, the invalid value) is recorded
/// in the accompanying [`warning::Set`].
///
/// A field the OCPI spec defines as optional is typed `Integrity<Option<T>>`: an
/// absent optional field is `Ok(None)`, not [`Integrity::Missing`].
/// [`Integrity::Missing`] therefore only ever describes an absent (or `null`)
/// *required* field, which is also reported as a [`Warning::MissingField`].
#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) enum Integrity<T> {
    /// The field was present and built successfully.
    Ok(T),
    /// A required field was absent or `null`. This is also reported as a
    /// [`Warning::MissingField`]. The location is the containing object's, since an
    /// absent field has no element of its own.
    Missing(warning::Element),
    /// The field was present but could not be built (wrong JSON kind, or an
    /// otherwise invalid value). The location is the field's own.
    Err(warning::Element),
}

impl<T> Integrity<Option<T>> {
    /// Map the contained `Option<T>` to `Option<U>`.
    /// Return `Some(U)` if `Ok(Some(T))`.
    /// Otherwise, return `None` if `Ok(None)`, `Missing`, or `Err`.
    pub(crate) fn map_some<U, F: FnOnce(&T) -> U>(&self, op: F) -> Option<U> {
        match self {
            Integrity::Ok(Some(v)) => Some(op(v)),
            Integrity::Ok(None) | Integrity::Missing(_) | Integrity::Err(_) => None,
        }
    }
}

/// Generate an all-[`Integrity::Missing`] `new` constructor for an IR object struct.
macro_rules! ir_object {
    ($ty:ident { $($field:ident),* $(,)? }) => {
        impl<'buf> $ty<'buf> {
            /// An empty builder for the object at `elem`: every field starts `Missing`,
            /// anchored to `elem`, and is filled by the walk.
            pub(super) fn new(elem: &json::Element<'buf>) -> Self {
                Self {
                    $($field: super::Integrity::Missing(
                        $crate::warning::Element::from_json(elem),
                    ),)*
                }
            }
        }
    };
    (@keep_element $ty:ident { $($field:ident),* $(,)? }) => {
        impl<'buf> $ty<'buf> {
            /// An empty builder for the JSON object at `elem`.
            ///
            /// Most IR objects don't need to save the JSON element they were created from.
            /// But some objects are removed when empty. An element's byte span is needed
            /// for the removal. Every field starts `Missing` with an associated `elem`.
            /// Each field is then set by the IR walk.
            pub(super) fn new(elem: &json::Element<'buf>) -> Self {
                Self {
                    elem: elem.clone(),
                    $($field: super::Integrity::Missing(
                        $crate::warning::Element::from_json(elem),
                    ),)*
                }
            }
        }

        impl<'buf> super::HasElement<'buf> for $ty<'buf> {
            fn element(&self) -> &json::Element<'buf> {
                &self.elem
            }
        }
    };
}
pub(crate) use ir_object;

/// Identifies which schema intermediate-representation (IR) value an [`Object`]
/// should be mapped to during the [`walk`].
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum BuilderKind {
    /// The object is validated for warnings but not built into any IR value.
    Ignore,
    V221Tariff,
    V221Element,
    V221PriceComponent,
    V221Restrictions,
    V221Price,
    V221Cdr,
    V221CdrLocation,
    V221ChargingPeriod,
    V221CdrDimension,
    V211Tariff,
    V211Element,
    V211PriceComponent,
    V211Restrictions,
    V211Cdr,
    V211Location,
    V211ChargingPeriod,
    V211CdrDimension,
}

/// The expected fields of a JSON object.
#[derive(Clone, Copy)]
struct Object {
    fields: &'static [Field],
    /// The IR value this object is built into during the [`walk`].
    kind: BuilderKind,
}

/// One field expected in a JSON object.
#[derive(Clone, Copy)]
struct Field {
    /// JSON key name.
    ///
    /// This value is hardcoded and will never contain escapes.
    name: &'static str,
    /// Whether the field must be present.
    presence: Presence,
    /// Expected substructure of the field value.
    schema: Schema,
}

impl Field {
    /// Define a required scalar of the given JSON kind.
    const fn required(name: &'static str, scalar: Scalar) -> Self {
        Self {
            name,
            presence: Presence::Required,
            schema: Schema::Scalar(scalar),
        }
    }

    /// Define a required array (OCPI `+`: present and nonempty).
    const fn required_array(name: &'static str, item: &'static Schema) -> Self {
        Self {
            name,
            presence: Presence::Required,
            schema: Schema::Array {
                item,
                cardinality: Cardinality::OneOrMore,
            },
        }
    }

    /// Define a required object.
    const fn required_object(name: &'static str, schema: &'static Object) -> Self {
        Self {
            name,
            presence: Presence::Required,
            schema: Schema::Object(schema),
        }
    }

    /// Define a required `Price` field, which per OCPI's 2.1.1-to-2.2.1 evolution
    /// accepts either a `Price` object or a bare number.
    const fn required_price(name: &'static str, schema: &'static Object) -> Self {
        Self {
            name,
            presence: Presence::Required,
            schema: Schema::Price(schema),
        }
    }

    /// Define an optional scalar of the given JSON kind.
    const fn optional(name: &'static str, scalar: Scalar) -> Self {
        Self {
            name,
            presence: Presence::Optional,
            schema: Schema::Scalar(scalar),
        }
    }

    /// Define an optional array (OCPI `*`: may be absent or empty).
    const fn optional_array(name: &'static str, item: &'static Schema) -> Self {
        Self {
            name,
            presence: Presence::Optional,
            schema: Schema::Array {
                item,
                cardinality: Cardinality::ZeroOrMore,
            },
        }
    }

    /// Define an optional object.
    const fn optional_object(name: &'static str, schema: &'static Object) -> Self {
        Self {
            name,
            presence: Presence::Optional,
            schema: Schema::Object(schema),
        }
    }

    /// Define an optional `Price` field, which per OCPI's 2.1.1-to-2.2.1 evolution
    /// accepts either a `Price` object or a bare number.
    const fn optional_price(name: &'static str, schema: &'static Object) -> Self {
        Self {
            name,
            presence: Presence::Optional,
            schema: Schema::Price(schema),
        }
    }

    /// Define a scalar the spec for this version does not define, but which this layer
    /// reads anyway (see [`Presence::NonSpec`]).
    const fn non_spec(name: &'static str, scalar: Scalar) -> Self {
        Self {
            name,
            presence: Presence::NonSpec,
            schema: Schema::Scalar(scalar),
        }
    }

    /// Define an object the spec for this version does not define, but which this layer
    /// reads anyway (see [`Presence::NonSpec`] and [`Schema::NonSpecObject`]).
    const fn non_spec_object(name: &'static str, schema: &'static Object) -> Self {
        Self {
            name,
            presence: Presence::NonSpec,
            schema: Schema::NonSpecObject(schema),
        }
    }
}

/// Whether a field must be present in its containing object.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) enum Presence {
    /// The schema requires the field. Its absence is a violation (also reported as
    /// [`Warning::MissingField`]).
    Required,
    /// The schema permits the field to be absent.
    Optional,
    /// The spec for this version does not define the field, but this layer reads it when a
    /// document supplies it, because real-world documents carry it.
    ///
    /// Its absence is not a violation; its presence is reported as
    /// [`Warning::NonSpecField`] so the caller still learns the document is off-spec.
    NonSpec,
}

/// A structural problem found while validating a JSON document against the OCPI schema.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum Warning {
    /// A field present in the JSON that the schema does not list.
    UnexpectedField,
    /// A field the spec for this version does not define, which this layer reads anyway
    /// because real-world documents carry it. The value is still validated and retained.
    NonSpecField,
    /// A required field absent from its containing object.
    MissingField {
        /// The field name the schema expected.
        name: &'static str,
    },
    /// A field whose value is JSON `null`. `null` fields can simply be omitted.
    NullField,
    /// A value whose JSON kind does not match the schema.
    InvalidType {
        /// The JSON kind the schema expects.
        expected: json::ValueKind,
        /// The JSON kind encountered.
        actual: json::ValueKind,
    },
    /// A string longer than the maximum length the schema permits.
    StringTooLong {
        /// The maximum character length the schema allows.
        max: usize,
        /// The character length actually encountered.
        len: usize,
    },
    /// A string value that is not one of an enum field's permitted variants, read without
    /// regard to case.
    InvalidValue {
        /// The permitted spec values, in the spec's defined case.
        expected: &'static [&'static str],
        /// The value encountered, as written in the JSON (escapes not decoded).
        actual: String,
    },

    /// A string value that names one of an enum field's variants, but not in the spec's case.
    ///
    /// Both OCPI versions state that strings in messages and enumerations are case-sensitive,
    /// so the value is off-spec rather than merely unconventional. This crate reads it anyway,
    /// and says which variant it read.
    IncorrectCase {
        /// The variant the value named, in the spec's defined case.
        expected: &'static str,
        /// The value encountered, as written in the JSON (escapes not decoded).
        actual: String,
    },
    /// An empty array for a field whose schema requires one or more elements.
    ///
    /// The only cardinality the schema can violate is "one or more", and the only way to
    /// violate it is to hold nothing, so this variant carries no data.
    Cardinality,
}

impl crate::Warning for Warning {
    fn id(&self) -> warning::Id {
        match self {
            Self::UnexpectedField => warning::Id::from_static("unexpected_field"),
            Self::NonSpecField => warning::Id::from_static("non_spec_field"),
            Self::MissingField { name } => {
                warning::Id::from_string(format!("missing_field({name})"))
            }
            Self::NullField => warning::Id::from_static("null_field"),
            Self::InvalidType { actual, .. } => {
                warning::Id::from_string(format!("invalid_type({actual})"))
            }
            Self::StringTooLong { .. } => warning::Id::from_static("string_too_long"),
            Self::InvalidValue { actual, .. } => {
                warning::Id::from_string(format!("invalid_value({actual})"))
            }
            Self::IncorrectCase { .. } => warning::Id::from_static("incorrect_case"),
            Self::Cardinality => warning::Id::from_static("cardinality(one or more)"),
        }
    }
}

impl std::fmt::Display for Warning {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::UnexpectedField => f.write_str("field is not part of the schema"),
            Self::NonSpecField => f.write_str(
                "field is not defined by the OCPI version of this document; it is read anyway",
            ),
            Self::MissingField { name } => write!(f, "required field `{name}` is missing"),
            Self::NullField => f.write_str(
                "field is `null`. `null` fields have no semantic meaning for OCPI objects",
            ),
            Self::InvalidType { expected, actual } => {
                write!(f, "expected {expected} found {actual}")
            }
            Self::StringTooLong { max, len } => {
                write!(
                    f,
                    "string is `{len}` characters, but the maximum allowed is `{max}`"
                )
            }
            Self::InvalidValue { expected, actual } => {
                write!(
                    f,
                    "value `{actual}` is not one of the permitted values: {}",
                    expected.join(", ")
                )
            }
            Self::IncorrectCase { expected, actual } => {
                write!(
                    f,
                    "value `{actual}` is not written in the case the spec uses: `{expected}`"
                )
            }
            Self::Cardinality => f.write_str("expected one or more elements, found 0"),
        }
    }
}

impl warning::Set<Warning> {
    /// Collect the field paths of all [`Warning::UnexpectedField`] warnings into a set of `json::Path`s.
    pub fn unexpected_fields(&self) -> json::PathSet<'_> {
        let mut paths = BTreeSet::new();

        for group in self {
            let (element, group_warnings) = group.to_parts();

            let has_unexpected_field = group_warnings
                .iter()
                .any(|warning| matches!(warning, Warning::UnexpectedField));

            if has_unexpected_field {
                paths.insert(&element.path);
            }
        }

        json::PathSet::new(paths)
    }

    /// Collect the field paths of all [`Warning::NonSpecField`] warnings into a set of `json::Path`s.
    pub fn non_spec_fields(&self) -> json::PathSet<'_> {
        let mut paths = BTreeSet::new();

        for group in self {
            let (element, group_warnings) = group.to_parts();

            let has_non_spec_field = group_warnings
                .iter()
                .any(|warning| matches!(warning, Warning::NonSpecField));

            if has_non_spec_field {
                paths.insert(&element.path);
            }
        }

        json::PathSet::new(paths)
    }

    /// Collect the field paths of all [`Warning::MissingField`] warnings into a set of `json::Path`s.
    pub fn missing_fields(&self) -> json::PathSet<'_> {
        let mut paths = BTreeSet::new();

        for group in self {
            let (element, group_warnings) = group.to_parts();

            let has_missing_field = group_warnings
                .iter()
                .any(|warning| matches!(warning, Warning::MissingField { .. }));

            if has_missing_field {
                paths.insert(&element.path);
            }
        }

        json::PathSet::new(paths)
    }

    /// Remove all [`Warning::UnexpectedField`] warnings from the set.
    pub fn remove_unexpected_fields(&mut self) {
        self.retain(|warning| !matches!(warning, Warning::UnexpectedField));
    }

    /// Remove all [`Warning::MissingField`] warnings from the set.
    pub fn remove_missing_fields(&mut self) {
        self.retain(|warning| !matches!(warning, Warning::MissingField { .. }));
    }

    /// Remove all [`Warning::InvalidType`] warnings from the set.
    pub fn remove_invalid_types(&mut self) {
        self.retain(|warning| !matches!(warning, Warning::InvalidType { .. }));
    }

    /// Remove all [`Warning::NullField`] warnings from the set.
    pub fn remove_null_fields(&mut self) {
        self.retain(|warning| !matches!(warning, Warning::NullField));
    }

    /// Remove all [`Warning::Cardinality`] warnings from the set.
    pub fn remove_cardinalities(&mut self) {
        self.retain(|warning| !matches!(warning, Warning::Cardinality));
    }

    /// Remove all [`Warning::StringTooLong`] warnings from the set.
    pub fn remove_string_too_longs(&mut self) {
        self.retain(|warning| !matches!(warning, Warning::StringTooLong { .. }));
    }
}

/// Opaque-subtree marker: a value the schema does not model. The subtree is still
/// walked so nested `null`s are reported.
static ANY: Schema = Schema::Scalar(Scalar::Any);

/// A step in the [`walk`]'s work stack.
enum Step<'a, 'buf> {
    /// Visit a node: record its warnings and build its leaf, or open its
    /// object/array builder.
    Visit {
        elem: &'a json::Element<'buf>,
        schema: &'a Schema,
        slot: Slot,
    },
    /// Finalize the builder on top of the builder stack and route it to its parent.
    Close { slot: Slot },
}

/// Where a built [`build::Node`] attaches within its parent.
#[derive(Clone, Copy)]
enum Slot {
    /// The root value of the walk.
    Root,
    /// A named field of the parent object.
    Field { name: &'static str },
    /// An item of the parent array.
    Item,
    /// A value that is discarded (an unmodeled [`Scalar::Any`] subtree).
    Ignore,
}

/// Validate `doc` against `schema` and build its intermediate representation (IR) in a
/// single pass.
///
/// The returned [`build::Node`] is the value of the root [`Object`]'s [`BuilderKind`].
/// When used through the public API the returned object will be one of the CDR or tariffs
/// root types.
///
/// Building is infallible. Problems with a field emit a [`Warning`] and are stored as
/// an [`Integrity::Err`] or [`Integrity::Missing`] on the IR object's field.
///
/// NOTE: A value whose type is invalid (a type mismatch) or whose key is
/// unexpected is recorded but not descended into. Its substructure cannot
/// be compared to the schema. Opaque [`Scalar::Any`] values are still
/// walked, so nested `null`s are still reported for the inner JSON.
fn walk<'a, 'buf>(
    doc: &'a json::Document<'buf>,
    schema: &'a Schema,
) -> Caveat<build::Node<'buf>, Warning> {
    let mut warnings = warning::Set::new();
    let mut builders: Vec<build::Node<'buf>> = Vec::new();
    let mut root = build::Node::Ignore;

    // Iteration order: an object's own problems are recorded before its descendants'
    // because its fields are scanned (emitting unexpected/missing warnings) when the
    // object is opened, before the field `Visit`s pushed here are popped.
    let mut stack = vec![Step::Visit {
        elem: doc.root(),
        schema,
        slot: Slot::Root,
    }];

    while let Some(step) = stack.pop() {
        match step {
            Step::Visit { elem, schema, slot } => {
                if let json::Value::Null = elem.value() {
                    warnings.insert(elem, Warning::NullField);
                    root.route_to_parent(
                        &mut builders,
                        slot,
                        Integrity::Missing(warning::Element::from_json(elem)),
                    );
                    continue;
                }
                match schema {
                    // An unmodeled subtree: walk children only to report nested nulls.
                    Schema::Scalar(Scalar::Any) => {
                        enqueue_all_children(&mut stack, elem);
                        root.route_to_parent(
                            &mut builders,
                            slot,
                            Integrity::Missing(warning::Element::from_json(elem)),
                        );
                    }
                    Schema::Scalar(scalar) => {
                        let built = check_scalar(&mut warnings, elem, *scalar);
                        root.route_to_parent(&mut builders, slot, built);
                    }
                    Schema::Array { item, cardinality } => {
                        let type_expectation = open_array(
                            &mut stack,
                            &mut builders,
                            &mut warnings,
                            elem,
                            item,
                            *cardinality,
                            slot,
                        );
                        if type_expectation.is_type_invalid() {
                            root.route_to_parent(
                                &mut builders,
                                slot,
                                Integrity::Err(warning::Element::from_json(elem)),
                            );
                        }
                    }
                    Schema::Object(object) => {
                        let type_expectation = open_object(
                            &mut stack,
                            &mut builders,
                            &mut warnings,
                            elem,
                            object,
                            slot,
                            Unlisted::Report,
                        );
                        if type_expectation.is_type_invalid() {
                            root.route_to_parent(
                                &mut builders,
                                slot,
                                Integrity::Err(warning::Element::from_json(elem)),
                            );
                        }
                    }
                    Schema::NonSpecObject(object) => {
                        let type_expectation = open_object(
                            &mut stack,
                            &mut builders,
                            &mut warnings,
                            elem,
                            object,
                            slot,
                            Unlisted::Ignore,
                        );
                        if type_expectation.is_type_invalid() {
                            root.route_to_parent(
                                &mut builders,
                                slot,
                                Integrity::Err(warning::Element::from_json(elem)),
                            );
                        }
                    }
                    Schema::Price(object) => {
                        // A bare number is the 2.1.1 price shape; accept it directly.
                        // Any other kind (including an object) is validated as an object.
                        if let Some(node) = price_from_number(&mut warnings, elem) {
                            root.route_to_parent(&mut builders, slot, Integrity::Ok(node));
                        } else {
                            let type_expectation = open_object(
                                &mut stack,
                                &mut builders,
                                &mut warnings,
                                elem,
                                object,
                                slot,
                                Unlisted::Report,
                            );
                            if type_expectation.is_type_invalid() {
                                root.route_to_parent(
                                    &mut builders,
                                    slot,
                                    Integrity::Err(warning::Element::from_json(elem)),
                                );
                            }
                        }
                    }
                }
            }
            Step::Close { slot } => {
                if let Some(node) = builders.pop() {
                    root.route_to_parent(&mut builders, slot, Integrity::Ok(node));
                }
            }
        }
    }

    root.into_caveat(warnings)
}

/// Build the leaf [`build::Node`] for a scalar, recording any kind, length, enum, or
/// string-encoded-number warning. Returns [`Integrity::Err`] for a wrong-kind value.
fn check_scalar<'buf>(
    warnings: &mut warning::Set<Warning>,
    elem: &json::Element<'buf>,
    scalar: Scalar,
) -> Integrity<build::Node<'buf>> {
    let expected = match scalar {
        // Enums serialize as JSON strings; their kind check is the same as a plain
        // string, with the value-membership check applied below.
        Scalar::String | Scalar::StringMax(_) | Scalar::Enum(_) => json::ValueKind::String,
        Scalar::Number => json::ValueKind::Number,
        Scalar::Boolean => json::ValueKind::Bool,
        // `Any` is handled by the caller; never built here.
        Scalar::Any => return Integrity::Missing(warning::Element::from_json(elem)),
    };

    let actual = elem.value().kind();

    // A `number` may be encoded as a JSON string; that is accepted but flagged below.
    let string_encoded_number =
        expected == json::ValueKind::Number && actual == json::ValueKind::String;
    if actual != expected && !string_encoded_number {
        warnings.insert(elem, Warning::InvalidType { expected, actual });
        return Integrity::Err(warning::Element::from_json(elem));
    }

    match scalar {
        Scalar::String => {
            // The kind gate above guarantees a string.
            let json::Value::String(text) = elem.value() else {
                unreachable!("kind gate guarantees a string");
            };
            Integrity::Ok(build::Node::Str(Str::new(elem.clone(), *text)))
        }
        Scalar::StringMax(max) => {
            // The kind gate above guarantees a string.
            let json::Value::String(text) = elem.value() else {
                unreachable!("kind gate guarantees a string");
            };
            let len = text.decode_escapes().ignore_warnings().chars().count();
            if len > max {
                warnings.insert(elem, Warning::StringTooLong { max, len });
            }
            Integrity::Ok(build::Node::Str(Str::new(elem.clone(), *text)))
        }
        Scalar::Enum(variants) => {
            let Some(value) = elem.value().to_raw_str() else {
                return Integrity::Err(warning::Element::from_json(elem));
            };
            let matched = variants
                .iter()
                .copied()
                .find(|&s| value.eq_any_escape_aware_ignore_ascii_case(&[s]));
            let Some(canonical) = matched else {
                warnings.insert(
                    elem,
                    Warning::InvalidValue {
                        expected: variants,
                        actual: value.as_unescaped_str().to_owned(),
                    },
                );
                return Integrity::Err(warning::Element::from_json(elem));
            };

            // The match above ignores case and decodes escapes, so a value that reaches here
            // and still differs from the variant differs in case alone.
            if !value.eq_any_escape_aware(&[canonical]) {
                warnings.insert(
                    elem,
                    Warning::IncorrectCase {
                        expected: canonical,
                        actual: value.as_unescaped_str().to_owned(),
                    },
                );
            }

            Integrity::Ok(build::Node::Enum(elem.clone(), canonical))
        }
        Scalar::Number => {
            // OCPI permits a number to be encoded as a JSON string. The value is accepted
            // either way; the linter can choose to flag the string-encoded form later. The
            // match is exhaustive in practice: the kind gate above already rejected any
            // value that is neither a JSON number nor a JSON string.
            match elem.value() {
                json::Value::Number(digits) => Integrity::Ok(build::Node::Number(Number::Number {
                    elem: elem.clone(),
                    digits,
                })),
                json::Value::String(text) => {
                    Integrity::Ok(build::Node::Number(Number::StringEncoded {
                        elem: elem.clone(),
                        value: *text,
                    }))
                }
                json::Value::Null
                | json::Value::True
                | json::Value::False
                | json::Value::Array(_)
                | json::Value::Object(_) => unreachable!(
                    "kind gate rejects any value that is neither a number nor a string"
                ),
            }
        }
        Scalar::Boolean => Integrity::Ok(build::Node::Bool),
        // Unreachable: handled above.
        Scalar::Any => Integrity::Missing(warning::Element::from_json(elem)),
    }
}

/// If `elem` is a bare JSON number, build the [`v221::Price`] node it stands for: the
/// number becomes `excl_vat` and `incl_vat` is left absent. The bare-number form is
/// flagged as a type mismatch (an object is the 2.2.1 shape) but still accepted, per
/// OCPI's evolution from a `number` price in 2.1.1. Returns `None` for any other kind,
/// which the caller then validates as an object.
fn price_from_number<'buf>(
    warnings: &mut warning::Set<Warning>,
    elem: &json::Element<'buf>,
) -> Option<build::Node<'buf>> {
    let json::Value::Number(digits) = elem.value() else {
        return None;
    };

    warnings.insert(
        elem,
        Warning::InvalidType {
            expected: json::ValueKind::Object,
            actual: json::ValueKind::Number,
        },
    );

    Some(build::Node::Price(v221::Price::from_number(
        elem.clone(),
        digits,
    )))
}

/// The [`open_array`] and [`open_object`] return whether the type they expected is
/// the type they encountered.
#[derive(Copy, Clone)]
enum TypeExpectation {
    Satisfied,
    Invalid,
}

impl TypeExpectation {
    fn is_type_invalid(self) -> bool {
        matches!(self, Self::Invalid)
    }
}

/// Whether [`open_object`] reports a field the object's schema does not list.
#[derive(Copy, Clone)]
enum Unlisted {
    /// Report it as a [`Warning::UnexpectedField`].
    Report,
    /// Say nothing. Used for a [`Schema::NonSpecObject`], which is already reported as a
    /// whole.
    Ignore,
}

/// Open an object: push its builder and a [`Step::Close`], then queue its
/// schema-matched fields. Records unexpected and missing-required-field warnings.
/// Returns `false` (and opens nothing) if `elem` is not a JSON object.
fn open_object<'a, 'buf>(
    stack: &mut Vec<Step<'a, 'buf>>,
    builders: &mut Vec<build::Node<'buf>>,
    warnings: &mut warning::Set<Warning>,
    elem: &'a json::Element<'buf>,
    object: &'a Object,
    slot: Slot,
    unlisted: Unlisted,
) -> TypeExpectation {
    // `fields` are sorted alphabetically by `Field::name` so the `binary_search_by_key`
    // below is valid; the `debug_assert` guards that against an out-of-order schema.
    debug_assert!(
        object
            .fields
            .windows(2)
            .all(|pair| matches!(pair, [a, b] if a.name <= b.name)),
        "Object::fields must be sorted alphabetically by name"
    );
    let json::Value::Object(fields) = elem.value() else {
        warnings.insert(
            elem,
            Warning::InvalidType {
                expected: json::ValueKind::Object,
                actual: elem.value().kind(),
            },
        );
        return TypeExpectation::Invalid;
    };

    builders.push(build::empty(object.kind, elem));
    stack.push(Step::Close { slot });

    // Mark, by schema-field position, which fields the document supplies. Reusing each
    // binary-search hit here lets the missing-field scan below be a single indexed pass
    // instead of a linear `contains` per schema field.
    let mut seen = vec![false; object.fields.len()];
    for field in fields {
        let key = field.key().as_unescaped_str();
        let Ok(idx) = object.fields.binary_search_by_key(&key, |fd| fd.name) else {
            // Not in the schema: record it and do not walk its subtree.
            if let Unlisted::Report = unlisted {
                warnings.insert(field.element(), Warning::UnexpectedField);
            }
            continue;
        };
        if let Some(flag) = seen.get_mut(idx) {
            *flag = true;
        }
        if let Some(fd) = object.fields.get(idx) {
            // A field the spec does not define is read anyway, but the document is still
            // off-spec for supplying it.
            if let Presence::NonSpec = fd.presence {
                warnings.insert(field.element(), Warning::NonSpecField);
            }
            stack.push(Step::Visit {
                elem: field.element(),
                schema: &fd.schema,
                slot: Slot::Field { name: fd.name },
            });
        }
    }

    // An absent field has no element of its own to `Visit`, so it is recorded here.
    // Every absent field is set to `Integrity::Missing`; the field's extractor then
    // interprets that per the field's optionality (an optional field becomes
    // `Integrity::Ok(None)`, a required field stays `Integrity::Missing`). A required
    // field additionally records a `MissingField` warning against the parent, so its
    // absence is visible in both the IR and the warnings.
    for (field, &present) in object.fields.iter().zip(seen.iter()) {
        if present {
            continue;
        }

        // An absent `NonSpec` field is not a violation; the spec does not define it.
        if let Presence::Required = field.presence {
            warnings.insert(elem, Warning::MissingField { name: field.name });
        }
        build::set_top_field(
            builders,
            field.name,
            Integrity::Missing(warning::Element::from_json(elem)),
        );
    }

    TypeExpectation::Satisfied
}

/// Open an array: push its accumulator builder and a [`Step::Close`], then queue its
/// items in document order. Records a cardinality warning for an empty `OneOrMore`
/// array.
///
/// Returns `false` (and opens nothing) if `elem` is not a JSON array.
fn open_array<'a, 'buf>(
    stack: &mut Vec<Step<'a, 'buf>>,
    builders: &mut Vec<build::Node<'buf>>,
    warnings: &mut warning::Set<Warning>,
    elem: &'a json::Element<'buf>,
    item: &'a Schema,
    cardinality: Cardinality,
    slot: Slot,
) -> TypeExpectation {
    let json::Value::Array(items) = elem.value() else {
        warnings.insert(
            elem,
            Warning::InvalidType {
                expected: json::ValueKind::Array,
                actual: elem.value().kind(),
            },
        );
        return TypeExpectation::Invalid;
    };

    if cardinality == Cardinality::OneOrMore && items.is_empty() {
        warnings.insert(elem, Warning::Cardinality);
    }

    builders.push(build::Node::Array(
        elem.clone(),
        Vec::with_capacity(items.len()),
    ));
    stack.push(Step::Close { slot });

    // Push in reverse so items are visited, and accumulated, in document order.
    for child in items.iter().rev() {
        stack.push(Step::Visit {
            elem: child,
            schema: item,
            slot: Slot::Item,
        });
    }

    TypeExpectation::Satisfied
}

/// Queue the children of an opaque [`Scalar::Any`] element so nested `null`s are
/// still reported. Their values are discarded.
fn enqueue_all_children<'a, 'buf>(stack: &mut Vec<Step<'a, 'buf>>, elem: &'a json::Element<'buf>) {
    match elem.value() {
        json::Value::Array(items) => {
            for child in items.iter().rev() {
                stack.push(Step::Visit {
                    elem: child,
                    schema: &ANY,
                    slot: Slot::Ignore,
                });
            }
        }
        json::Value::Object(fields) => {
            for field in fields.iter().rev() {
                stack.push(Step::Visit {
                    elem: field.element(),
                    schema: &ANY,
                    slot: Slot::Ignore,
                });
            }
        }
        json::Value::Null
        | json::Value::True
        | json::Value::False
        | json::Value::String(_)
        | json::Value::Number(_) => {}
    }
}

// Constrained leaf types for the schema intermediate representation (IR).
//
// A leaf wraps a [`json::Element`] that the IR builder has already confirmed to be
// the right JSON kind. Downstream lowering (the `FromSchema` impls) therefore does
// not repeat the kind check; it only does semantic interpretation (parsing a number
// into a `Decimal`, validating an ISO currency code, and so on).
//
// The leaves keep a (cheap, reference-counted) clone of their [`json::Element`] so
// the lowering step can still attach its semantic warnings to the right path.

/// A JSON array the builder walked, retaining the element it was built from.
///
/// The items are kept as `Integrity` values so one unreadable entry does not cost the
/// others. The element is what a warning about the array *as a whole* anchors to - an empty
/// list, or a list whose contents are individually fine but collectively wrong - which no
/// item can stand in for.
#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct List<'buf, T> {
    elem: json::Element<'buf>,
    items: Vec<Integrity<T>>,
}

impl<'buf, T> List<'buf, T> {
    pub(super) fn new(elem: json::Element<'buf>, items: Vec<Integrity<T>>) -> Self {
        Self { elem, items }
    }

    /// The number of items in the array, readable or not.
    pub fn len(&self) -> usize {
        self.items.len()
    }

    /// True if the array holds no items at all.
    pub fn is_empty(&self) -> bool {
        self.items.is_empty()
    }
}

impl<'a, T> IntoIterator for &'a List<'_, T> {
    type Item = &'a Integrity<T>;
    type IntoIter = std::slice::Iter<'a, Integrity<T>>;

    fn into_iter(self) -> Self::IntoIter {
        self.items.iter()
    }
}

impl<T> std::ops::Index<usize> for List<'_, T> {
    type Output = Integrity<T>;

    /// # Panics
    ///
    /// Panics if `index` is out of bounds, as every `Index` implementation does. Use
    /// `IntoIterator` to walk the items without naming a position.
    #[expect(
        clippy::indexing_slicing,
        reason = "an `Index` impl is a bounds-checked panic by definition"
    )]
    fn index(&self, index: usize) -> &Self::Output {
        &self.items[index]
    }
}

impl<'buf, T> HasElement<'buf> for List<'buf, T> {
    fn element(&self) -> &json::Element<'buf> {
        &self.elem
    }
}

/// A JSON value the builder confirmed to be a string.
///
/// `text` is the confirmed string content (escapes not yet decoded), borrowed from the
/// source buffer; the builder proved its kind, so the lowering step reads it without
/// rechecking. Length and other lexical checks are applied by the builder when the leaf
/// is constructed; see [`crate::schema::build`].
#[derive(Clone, Debug)]
pub(crate) struct Str<'buf> {
    elem: json::Element<'buf>,
    value: json::RawStr<'buf>,
}

impl<'buf> Str<'buf> {
    pub(super) fn new(elem: json::Element<'buf>, value: json::RawStr<'buf>) -> Self {
        Self { elem, value }
    }

    /// The confirmed string content (escapes not yet decoded).
    pub fn value(&self) -> json::RawStr<'buf> {
        self.value
    }
}

impl<'buf> HasElement<'buf> for Str<'buf> {
    fn element(&self) -> &json::Element<'buf> {
        &self.elem
    }
}

/// A JSON value the builder confirmed to be a number, remembering whether it was
/// written as a JSON number or encoded as a JSON string.
///
/// OCPI allows a `number` to be encoded as a string; the [`Number::StringEncoded`]
/// variant records that so the builder can flag it and the lowering step can still
/// read the digits.
#[derive(Clone, Debug)]
pub(crate) enum Number<'buf> {
    /// A syntactically valid RFC 8259 JSON number.
    ///
    /// `digits` is the validated number text, borrowed from the source buffer. The
    /// builder proved its shape, so the lowering step reads it without rechecking.
    Number {
        elem: json::Element<'buf>,
        digits: &'buf str,
    },
    /// A number encoded as a JSON string.
    ///
    /// There are no guarantees made about the contents of the string; `text` may, for
    /// example, contain escape sequences the lowering step must still decode.
    StringEncoded {
        elem: json::Element<'buf>,
        value: json::RawStr<'buf>,
    },
}

impl<'buf> HasElement<'buf> for Number<'buf> {
    fn element(&self) -> &json::Element<'buf> {
        match self {
            Self::Number { elem, .. } | Self::StringEncoded { elem, .. } => elem,
        }
    }
}

/// A JSON string the builder confirmed to be one of an enum's permitted variants,
/// carrying the typed OCPI enum `T` it resolved to.
///
/// The builder resolves the string to its typed variant during extraction (the
/// schema field's concrete `T` is known there), so the lowering step reads a typed
/// Rust enum directly and never re-parses the string or repeats the membership check.
///
/// Only the resolved variant is kept. The case a value was written in is the walk's
/// business, which reports on it from the element before an `Enum` exists.
#[derive(Clone, Debug)]
pub(crate) struct Enum<'buf, T> {
    elem: json::Element<'buf>,
    value: T,
}

impl<'buf, T: OcpiEnum> Enum<'buf, T> {
    pub fn new(elem: json::Element<'buf>, value: T) -> Self {
        Self { elem, value }
    }

    /// The typed OCPI enum the value resolved to.
    pub fn value(&self) -> T {
        self.value
    }
}

impl<'buf, T> HasElement<'buf> for Enum<'buf, T> {
    fn element(&self) -> &json::Element<'buf> {
        &self.elem
    }
}

/// A single OCPI enum, as modeled by the schema layer. Implemented (via the
/// [`ocpi_enum!`] macro) by each version-specific OCPI enum so a generic
/// [`Enum<T>`] can be resolved and rendered without naming the concrete type.
pub(crate) trait OcpiEnum: Copy {
    /// Resolve a canonical spec value (one of the schema's permitted variants) to
    /// its typed variant. Returns `None` for a value outside this enum's set.
    fn from_canonical(value: &str) -> Option<Self>;
}

/// Define an OCPI enum: its Rust type, the variant table used by [`Scalar::Enum`],
/// and the [`OcpiEnum`] impl that maps between the typed variant and its spec value.
///
/// The body lists each Rust variant with the exact spec value it serializes to.
/// `VARIANTS` (the permitted spec values) and [`OcpiEnum::from_canonical`]
/// (value-to-variant) are both generated from that single list, so the two
/// cannot drift.
macro_rules! ocpi_enum {
    ($kind:ident { $($variant:ident = $value:literal),+ $(,)? }) => {
        #[derive(Clone, Copy, Debug, PartialEq, Eq)]
        pub(crate) enum $kind {
            $($variant),+
        }

        impl $kind {
            /// The permitted spec values, in the case the spec writes them. Used as the
            /// `Scalar::Enum` table.
            const VARIANTS: &'static [&'static str] = &[$($value),+];
        }

        impl super::OcpiEnum for $kind {
            fn from_canonical(value: &str) -> Option<Self> {
                match value {
                    $($value => Some(Self::$variant),)+
                    _ => None,
                }
            }
        }
    };
}
pub(crate) use ocpi_enum;