coreui / coreui-pro / 34795132933

95%

main: 94%

push

github

refactor!: config replacement is setConfig(), not update() (#1278)

* refactor(BaseComponent)!: config replacement moves to setConfig()

`update()` carried two contracts. On Combobox, List box, Transfer, Menu,
Progress, Range, Tooltip and Popup it takes no argument and recomputes from
what the component owns; on Autocomplete, Calendar, MultiSelect, OTPInput,
RangeSlider, Rating and SectionInput (DateInput/TimeInput/DateTimeInput) it
took an options object and replaced the configuration. Calling it the first
way on a component that meant the second one threw:
`multiSelect.update()` -> `TypeError: Cannot read properties of undefined
(reading 'value')`.

The seven config-taking ones now implement `setConfig(config)`, defined once
on `BaseComponent` as merge-over-current + `_getConfig()`. Two defects die
with the seven hand-rolled bodies, both measured in Chromium before the
change:

- Rating and RangeSlider resolved the argument against the defaults
  (`this._config = this._getConfig(config)`), so an option set in the
  constructor and not repeated came back as the default. Measured:
  `new Rating(el, { itemCount: 3 }); rating.update({ value: 2 })` rendered
  five items. Calendar already carried a local fix for exactly this.
- Autocomplete and MultiSelect called `_configAfterMerge()` directly, which
  skips `_typeCheckConfig()`. Measured: `ms.update({ multiple: 'yes' })`
  stored the string in silence, while the same value in the constructor
  throws.

The static and jQuery dispatchers reach `data[name]()` with no arguments, so
for these seven the documented `'update'` string either threw or silently
reset the configuration; `'setConfig'` is now a no-op re-render there.

`Toaster.update(id, options)` is unchanged - it rewrites one toast in the
store, not the component's own configuration. Internal `TimeSelection.update`
followed the rename, as did the picker call sites that drive the calendar,
the section inputs and the time selection.

Docs: method tabl... (continued)

5602 of 6245 branches covered (89.7%)

Branch coverage included in aggregate %.

24 of 25 new or added lines in 11 files covered. (96.0%)

10881 of 11282 relevant lines covered (96.45%)

468.29 hits per line