brazilian-utils.titulo-eleitoral.core — br.com.buzzlabs/brazilian-utils 0.1.0

Core utilities for Título Eleitoral.

This module provides validation and generation utilities for Títulos Eleitorais. Validation checks mathematical correctness and structure, but does NOT verify if the ID exists in TSE's registry.

generate clj/s

(generate)

(generate {:keys [uf-code]})

Generates a valid Brazilian Voter ID (Título Eleitoral).

This function creates a random valid voter ID with correct check digits according to TSE (Tribunal Superior Eleitoral) rules. The generated ID has the format: 8 digits base + 2 check digits + 2 digit UF code = 12 digits total.

Arguments: options - Optional map with: :uf-code => UF code (string or integer, e.g., "35" or 35 for SP) When omitted, a random valid UF code is chosen When invalid, returns nil

Returns: A valid 12-digit voter ID string, or nil if generation fails

Examples: (generate) ;; => "123456780104" (random UF) (generate {:uf-code 35}) ;; => voter ID for São Paulo (UF 35) (generate {:uf-code "01"}) ;; => voter ID for Distrito Federal (UF 01) (generate {:uf-code 99}) ;; => nil (invalid UF code)

get-uf-code clj/s

(get-uf-code voter-id)

Extracts the UF code from a voter ID.

The UF code is the last 2 digits of the 12-digit voter ID and represents the Brazilian state where the voter is registered.

Arguments: voter-id - String with voter ID (may include formatting)

Returns: String with 2-digit UF code, or nil if the voter ID is invalid

Examples: (get-uf-code "123456789035") ;; => "35" (São Paulo) (get-uf-code "1234 5678 9035") ;; => "35" (get-uf-code "invalid") ;; => nil (get-uf-code "12345678") ;; => nil (too short)

is-valid? clj/s

(is-valid? voter-id)

Validates whether a given value is a well-formed Brazilian Voter ID.

The validation checks:

1. The value is a non-empty string
2. Contains exactly 12 digits after removing formatting
3. UF code (last 2 digits) is valid according to TSE rules
4. Both check digits are mathematically correct
5. Not all digits are the same

Important: This validates structure and math, NOT existence in TSE registry.

Args: voter-id - The voter ID string to validate (may include formatting)

Returns: true if the voter ID is valid; false otherwise

Examples: (is-valid? "123456789035") ;; depends on check digits (is-valid? "1234 5678 9035") ;; formatting ignored (is-valid? "") ;; => false (is-valid? nil) ;; => false

remove-symbols clj/s

(remove-symbols voter-id)

Removes all non-numeric characters from a voter ID string.

This function normalizes voter ID input by stripping formatting characters, returning only the digits.

Arguments: voter-id - String with voter ID (may include formatting); nil allowed

Returns: String with only digits, or empty string if input is nil

Examples: (remove-symbols "1234 5678 9035") ;; => "123456789035" (remove-symbols "1234-5678-9035") ;; => "123456789035" (remove-symbols "123456789035") ;; => "123456789035" (remove-symbols nil) ;; => "" (remove-symbols "") ;; => ""

validation-errors clj/s

(validation-errors voter-id)

Validates a voter ID and returns detailed error information if invalid.

Returns an empty vector for valid IDs, or a vector of error message strings for invalid IDs.

Args: voter-id - The voter ID string to validate

Returns: Empty vector if valid, or vector of error message strings if invalid

Examples: (validation-errors "1234 5678 9035") ;; [] or ["Invalid check digits"] (validation-errors "") ;; ["Voter ID must have 12 digits after cleaning"]