tickerforge 0.1.12

Generate and parse derivatives tickers from tickerforge-spec (Rust).
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260

mod common;

use crate::common::spec_path;
use tickerforge::{
    generate_ticker_for_contract_signed, load_spec, parse_any_ticker_date, AnyParsedTicker,
    ParsedFuturesTicker, TickerForge,
};

fn as_futures(any: AnyParsedTicker) -> ParsedFuturesTicker {
    match any {
        AnyParsedTicker::Futures(f) => f,
        AnyParsedTicker::Option(o) => panic!("expected Futures but got Option: {:?}", o),
        AnyParsedTicker::Equity(e) => panic!("expected Futures but got Equity: {:?}", e),
    }
}

// ---------------------------------------------------------------------------
// Positive offsets
// ---------------------------------------------------------------------------

#[test]
fn parse_dol_offset_one_matches_generate() {
    let forge = TickerForge::with_spec_path(&spec_path()).expect("forge");
    let spec = load_spec().expect("spec");
    let contract = spec.get_contract("DOL").expect("DOL contract");

    let any = parse_any_ticker_date("DOL[1]", "2026-06-29").expect("parse");
    let parsed = as_futures(any);

    let from_signed =
        generate_ticker_for_contract_signed(contract, "2026-06-29", &spec, 1).expect("signed");
    let from_forge = forge.generate("DOL", "2026-06-29", 1).expect("forge");

    assert_eq!(parsed.ticker().expect("ticker"), "DOLQ26");
    assert_eq!(parsed.ticker().expect("ticker"), from_signed);
    assert_eq!(parsed.ticker().expect("ticker"), from_forge);
    assert_eq!(parsed.contract_offset, Some(1));
}

#[test]
fn parse_win_offset_two_matches_generate() {
    let forge = TickerForge::with_spec_path(&spec_path()).expect("forge");
    let any = parse_any_ticker_date("WIN[2]", "2026-06-29").expect("parse");
    let parsed = as_futures(any);

    assert_eq!(parsed.ticker().expect("ticker"), "WINZ26");
    assert_eq!(
        parsed.ticker().expect("ticker"),
        forge.generate("WIN", "2026-06-29", 2).expect("forge")
    );
    assert_eq!(parsed.contract_offset, Some(2));
}

#[test]
fn parse_ccm_offset_one_matches_generate() {
    let forge = TickerForge::with_spec_path(&spec_path()).expect("forge");
    let spec = load_spec().expect("spec");
    let contract = spec.get_contract("CCM").expect("CCM contract");

    let any = parse_any_ticker_date("CCM[1]", "2026-09-01").expect("parse");
    let parsed = as_futures(any);

    let from_signed =
        generate_ticker_for_contract_signed(contract, "2026-09-01", &spec, 1).expect("signed");
    let from_forge = forge.generate("CCM", "2026-09-01", 1).expect("forge");

    assert_eq!(parsed.ticker().expect("ticker"), "CCMX26");
    assert_eq!(parsed.ticker().expect("ticker"), from_signed);
    assert_eq!(parsed.ticker().expect("ticker"), from_forge);
    assert_eq!(parsed.contract_offset, Some(1));
}

#[test]
fn parse_bgi_offset_six_matches_generate() {
    let forge = TickerForge::with_spec_path(&spec_path()).expect("forge");
    let spec = load_spec().expect("spec");
    let contract = spec.get_contract("BGI").expect("BGI contract");

    let any = parse_any_ticker_date("BGI[6]", "2026-09-01").expect("parse");
    let parsed = as_futures(any);

    let from_signed =
        generate_ticker_for_contract_signed(contract, "2026-09-01", &spec, 6).expect("signed");
    let from_forge = forge.generate("BGI", "2026-09-01", 6).expect("forge");

    assert_eq!(parsed.ticker().expect("ticker"), "BGIH27");
    assert_eq!(parsed.ticker().expect("ticker"), from_signed);
    assert_eq!(parsed.ticker().expect("ticker"), from_forge);
    assert_eq!(parsed.contract_offset, Some(6));
}

#[test]
fn parse_ccm_crosses_year() {
    // September reference: CCM[3] lands in March of the next calendar year.
    let forge = TickerForge::with_spec_path(&spec_path()).expect("forge");
    let any = parse_any_ticker_date("CCM[3]", "2026-09-01").expect("parse");
    let parsed = as_futures(any);

    assert_eq!(parsed.ticker().expect("ticker"), "CCMH27");
    assert_eq!(
        parsed.ticker().expect("ticker"),
        forge.generate("CCM", "2026-09-01", 3).expect("forge")
    );
    assert_eq!(parsed.year, 2027);
    assert_eq!(parsed.month, 3);
    assert_eq!(parsed.contract_offset, Some(3));
}

#[test]
fn parse_bgi_crosses_year() {
    // Late-year reference: BGI[6] spans into the next calendar year.
    let forge = TickerForge::with_spec_path(&spec_path()).expect("forge");
    let any = parse_any_ticker_date("BGI[6]", "2026-12-31").expect("parse");
    let parsed = as_futures(any);

    assert_eq!(parsed.ticker().expect("ticker"), "BGIN27");
    assert_eq!(
        parsed.ticker().expect("ticker"),
        forge.generate("BGI", "2026-12-31", 6).expect("forge")
    );
    assert_eq!(parsed.year, 2027);
    assert_eq!(parsed.month, 7);
    assert_eq!(parsed.contract_offset, Some(6));
}

// ---------------------------------------------------------------------------
// Negative offsets
// ---------------------------------------------------------------------------

#[test]
fn parse_ind_negative_one_is_previous_contract() {
    // On 2026-06-18 the IND front month is INDQ26 (rolls after expiry),
    // so IND[-1] must be the most-recently-expired contract: INDM26.
    let any = parse_any_ticker_date("IND[-1]", "2026-06-18").expect("parse");
    let parsed = as_futures(any);
    assert_eq!(parsed.ticker().expect("ticker"), "INDM26");
    assert_eq!(parsed.contract_offset, Some(-1));
}

#[test]
fn generate_signed_negative_one_returns_previous_dol() {
    let spec = load_spec().expect("spec");
    let contract = spec.get_contract("DOL").expect("DOL contract");
    let ticker =
        generate_ticker_for_contract_signed(contract, "2026-06-29", &spec, -1).expect("signed");
    assert_eq!(ticker, "DOLM26");
}

#[test]
fn generate_signed_negative_two_returns_prior_dol() {
    let spec = load_spec().expect("spec");
    let contract = spec.get_contract("DOL").expect("DOL contract");
    let ticker =
        generate_ticker_for_contract_signed(contract, "2026-06-29", &spec, -2).expect("signed");
    assert_eq!(ticker, "DOLK26");
}

// ---------------------------------------------------------------------------
// DOL[0] vs plain DOL
// ---------------------------------------------------------------------------

#[test]
fn dol_offset_zero_equals_plain_dol_ticker() {
    let tagged = as_futures(parse_any_ticker_date("DOL[0]", "2026-06-29").expect("tagged"));
    let plain = as_futures(parse_any_ticker_date("DOL", "2026-06-29").expect("plain"));

    assert_eq!(tagged.ticker().expect("ticker"), "DOLN26");
    assert_eq!(
        tagged.ticker().expect("ticker"),
        plain.ticker().expect("ticker")
    );

    assert_eq!(tagged.contract_offset, Some(0));
    assert_eq!(plain.contract_offset, None);
}

// ---------------------------------------------------------------------------
// contract_offset field semantics
// ---------------------------------------------------------------------------

#[test]
fn contract_offset_some_for_tagged_none_for_full() {
    let tagged = as_futures(parse_any_ticker_date("DOL[1]", "2026-06-29").expect("tagged"));
    assert_eq!(tagged.contract_offset, Some(1));

    let full = as_futures(parse_any_ticker_date("INDM26", "2026-06-18").expect("full"));
    assert_eq!(full.contract_offset, None);
}

// ---------------------------------------------------------------------------
// Error cases
// ---------------------------------------------------------------------------

#[test]
fn out_of_range_positive_errors() {
    let err = parse_any_ticker_date("DOL[999]", "2026-06-29").unwrap_err();
    assert!(err.contains("out of range"));
}

#[test]
fn out_of_range_negative_errors() {
    let err = parse_any_ticker_date("DOL[-999]", "2026-06-29").unwrap_err();
    assert!(err.contains("out of range"));
}

#[test]
fn unknown_root_errors() {
    let err = parse_any_ticker_date("ZZZ[1]", "2026-06-29").unwrap_err();
    assert!(err.contains("Unable to parse ticker"));
}

#[test]
fn generate_signed_out_of_range_positive_errors() {
    let spec = load_spec().expect("spec");
    let contract = spec.get_contract("DOL").expect("DOL contract");
    let err = generate_ticker_for_contract_signed(contract, "2026-06-29", &spec, 999).unwrap_err();
    assert!(err.contains("out of range"));
}

#[test]
fn generate_signed_out_of_range_negative_errors() {
    let spec = load_spec().expect("spec");
    let contract = spec.get_contract("DOL").expect("DOL contract");
    let err = generate_ticker_for_contract_signed(contract, "2026-06-29", &spec, -999).unwrap_err();
    assert!(err.contains("out of range"));
}

// ---------------------------------------------------------------------------
// TickerForge::gen_signed (today)
// ---------------------------------------------------------------------------

#[test]
fn gen_signed_today_matches_generate_today() {
    let forge = TickerForge::with_spec_path(&spec_path()).expect("forge");
    let today = chrono::Local::now()
        .date_naive()
        .format("%Y-%m-%d")
        .to_string();

    assert_eq!(
        forge.gen_signed("DOL", 1).expect("gen_signed"),
        forge.generate("DOL", &today, 1).expect("generate"),
    );
}

// ---------------------------------------------------------------------------
// reference_date / is_trading_session stamping for tagged roots
// ---------------------------------------------------------------------------

#[test]
fn tagged_root_stamps_reference_date_and_session() {
    // 2026-04-15 is a Wednesday — B3 trading session.
    let parsed = as_futures(parse_any_ticker_date("DOL[1]", "2026-04-15").expect("parse"));
    assert_eq!(
        parsed.reference_date,
        Some(chrono::NaiveDate::from_ymd_opt(2026, 4, 15).unwrap()),
    );
    assert_eq!(parsed.is_trading_session, Some(true));
    assert_eq!(parsed.contract_offset, Some(1));
}