hunch 2.0.2

A media filename parser for movies, TV, and anime — built in Rust, inspired by guessit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! Bonus content detection.
//!
//! Detects bonus/extras markers: x01, x02 (used for bonus features).
//!
//! ## Why this lives in Rust (not `src/rules/`)
//!
//! Capture-group title extraction (`x01-Title_Here` → bonus_number=1 +
//! bonus_title="Title Here") emits multiple properties from one match
//! and requires span deduplication against neighboring episode/season
//! patterns. See DESIGN.md D2 decision table → "cross-pattern
//! coordination".

use regex::Regex;

use crate::matcher::regex_utils::{BoundarySpec, CharClass, check_boundary};
use crate::matcher::span::{MatchSpan, Property};
use std::sync::LazyLock;

/// Bonus number: x01, x02, x09.
static BONUS_PATTERN: LazyLock<Regex> =
    LazyLock::new(|| Regex::new(r"(?i)[xX](?P<num>0[0-9]|[1-9][0-9]?)").unwrap());

static BONUS_BOUNDARY: BoundarySpec = BoundarySpec {
    left: Some(CharClass::AlphaDigit),  // (?<![a-z0-9])
    right: Some(CharClass::AlphaDigit), // (?![a-z0-9])
};

/// Bonus title after the bonus number: x01-Title_Here.
static BONUS_TITLE_PATTERN: LazyLock<Regex> = LazyLock::new(|| {
    Regex::new(
    r"(?i)[xX](?:0[0-9]|[1-9][0-9]?)[-. ](?P<title>[A-Za-z][A-Za-z0-9_ .',-]+?)(?:\.(?:mkv|avi|mp4|srt|sub|ass|ssa|idx|m4v|wmv|flv|webm|ts|m2ts|vob|divx|ogm|rmvb)$|$|-[a-zA-Z0-9]+$)"
    ).unwrap()
});

/// Scan for bonus content markers (e.g., `-x02`) and return matches.
pub fn find_matches(input: &str) -> Vec<MatchSpan> {
    let bytes = input.as_bytes();
    let mut matches = Vec::new();

    if let Some(cap) = BONUS_PATTERN.captures(input)
        && let Some(num) = cap.name("num")
    {
        let full = cap.get(0).unwrap();
        if check_boundary(bytes, full.start(), full.end(), &BONUS_BOUNDARY) {
            let n: u32 = num.as_str().parse().unwrap_or(0);
            if n > 0 {
                matches.push(
                    MatchSpan::new(full.start(), full.end(), Property::Bonus, n.to_string())
                        .with_priority(crate::priority::DEFAULT),
                );
            }
        }
    }

    // Extract bonus title if present.
    if let Some(cap) = BONUS_TITLE_PATTERN.captures(input)
        && let Some(title) = cap.name("title")
    {
        let cleaned = title.as_str().replace('_', " ").trim().to_string();
        if !cleaned.is_empty() {
            matches.push(
                MatchSpan::new(title.start(), title.end(), Property::BonusTitle, cleaned)
                    .with_priority(crate::priority::DEFAULT),
            );
        }
    }

    matches
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_bonus_number() {
        let m = find_matches("Movie-x01-Behind_the_Scenes.mkv");
        assert!(
            m.iter()
                .any(|x| x.property == Property::Bonus && x.value == "1")
        );
    }

    #[test]
    fn test_bonus_title() {
        let m = find_matches("Movie-x01-Behind_the_Scenes.mkv");
        assert!(m.iter().any(|x| x.property == Property::BonusTitle));
    }
}