wboayue / rust-ibapi / 26247346782

92%

Build Type

push

github

Committed by web-flow

Commit Message

historical: HistoricalScheduleBuilder replaces historical_schedules pair (#612)

* historical: HistoricalScheduleBuilder replaces historical_schedules pair

Collapses `historical_schedules(contract, end_date, duration)` +
`historical_schedules_ending_now(contract, duration)` into a single
builder: `client.historical_schedules(&contract, duration).fetch()`
with optional `.ending(end_date)` to anchor at a specific date.

Mirrors RealtimeBarsBuilder shape (per-feature impl blocks, defaults
in `new()`, `#[must_use]` on struct, sibling _tests.rs).

Private `historical_schedule` helper renamed to `pub(crate)
fetch_historical_schedule` so the builder terminal can call it. No
dead duplicate behind the deleted public methods.

Plan: plans/historical-data-builders.md PR 1 of 3. Migration §24.
The PR #573 split (avoiding magic-`None`) was the documented
intermediate; this builder is the next step in that 3-step evolution
per feedback_magic_none_split_to_builder.

* historical: tighten schedule builder (/simplify)

- Rename `fetch_historical_schedule` → `historical_schedule` to match
  the `pub(crate) fn realtime_bars` precedent (helper named after the
  API verb, no `fetch_` prefix). Update builder terminal callers.
- Replace hand-rolled `stub_client()` helpers in `schedule_tests.rs`
  with the shared `create_test_client_with_responses_and_version` /
  `create_blocking_test_client_with_responses_and_version` from
  `common::test_utils::helpers` (matches `RealtimeBarsBuilder` tests).
- Drop "Default: ending = None" line from struct doc — the field +
  the `.ending()` setter doc already say it.
- Drop top-of-file comment in `schedule_tests.rs` — narrates intent
  obvious from the const name + usage.
- Drop trailing paragraph from migration §24 about "documented
  intermediate / 3-step evolution" — meta-commentary; §22/§23 don't
  carry equivalent narration.

Coverage Stats

34 of 34 new or added lines in 3 files covered. (100.0%)

1 existing line in 1 file now uncovered.

19032 of 20652 relevant lines covered (92.16%)

28.22 hits per line