Files
purchases-ios/Sources/RulesEngine/CustomOperators/LengthOperator.swift
T
Antonio PallaresandCursor bc1186542e Refresh two doc comments that outlived their examples (#7498)
rc.length justifies throwing with a missing var, which cannot reach the
operator any more: the lookup raises first, as
length_missing_variable_fails_at_the_lookup pins. The reason now rests on
a key that is present but holds null, the case that does reach it.

objectList tells providers a record must carry everything a predicate
about it needs. rc.rootVar reaches the snapshot from inside an iteration
scope, so that is no longer the only option.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-08-25 11:41:23 +02:00

50 lines
1.8 KiB
Swift

//
// LengthOperator.swift
//
// Created by Antonio Pallares.
//
import Foundation
extension RulesEngine {
/// `rc.length` — element count for arrays, UTF-16 code-unit count for
/// strings (JS `String.length` parity).
enum LengthOperator {
/// `{"rc.length": value}` — returns a numeric length suitable for
/// arithmetic and comparisons.
///
/// - **String**: length in **UTF-16 code units**, not Swift grapheme
/// clusters — matches JS `String.length` and the same choice in
/// `AccessorOperators.opMissingSome` (`string.utf16.count`).
/// - **Array**: element count (`.count`).
/// - **Anything else**: throws `EvaluationError.typeMismatch`.
///
/// Non-string/non-array inputs throw rather than defaulting to `0`.
/// A silent zero would make `{"==": [{"rc.length": {"var": "note"}},
/// 0]}` quietly true for a key that is present but holds `null`.
///
/// Uses `Operators.firstArgEvaluated` spread semantics; extra arguments
/// are silently ignored. Literal array operands must be wrapped
/// (e.g. `{"rc.length": [[1, 2, 3]]}`), not passed as a multi-element
/// arg list.
static func opLength(args: Value, vars: Scope) throws -> Value {
let input = try Operators.firstArgEvaluated(args, vars: vars)
switch input {
case .string(let string):
return .int(Int64(string.utf16.count))
case .array(let items):
return .int(Int64(items.count))
default:
throw EvaluationError.typeMismatch(
message: "operator 'rc.length' expected string or array, got \(input)"
)
}
}
}
}