ROM v6.0.0.alpha1 Release Notes

Release Date: 2022-04-15 // almost 2 years ago
  • ๐Ÿš€ This is a major release but it's backward compatible. Please see the upgrade guide as there are โฌ†๏ธ a couple of extra steps required for the upgrade.

    โž• Added

    • ๐Ÿ†• New settings API for components using dry-configurable (via #651) (@solnic)
    • ROM(...) shortcut method for setting up rom, ie ROM(:sql, "sqlite::memory") (@solnic)
    • ๐Ÿ”ง You can now configure a custom inflector via configuration (PR #591) (@flash-gordon)
    • ๐Ÿ†• New component API that replaces internal implementation of the finalization code and makes it possible to extend ROM with arbitrary component types (see #637) (@solnic)
    • Generic Component API which allows you to turn any class or object into a DSL that can define rom components (via #650) (@solnic)
    • ๐Ÿ‘Œ Support for defining abstract components via config.component.abstract in which case they won't be initialized for runtime usage (via #651) (@solnic)
    • ๐Ÿ”ง Ability to provide top-level component configuration ie default gateway, adapter, inflector etc. (via #653) (@solnic)
    • ๐Ÿ”ง Ability to configure gateways using configuration DSL (via #653) (@solnic)
    • Ability to define schemas without relations (via #653) (@solnic)
    • Relation view schemas that are defined via Relation.view DSL are now registered too, which makes them more accessible/reusable (via #653) (@solnic)
    • ๐Ÿ”ง Global configuration that can provide default settings for all your components. ie a default adapter, gateway etc. (via #654) (@solnic)
    • ๐Ÿ‘Œ Support for custom namespaces under which commands and mappers can be registered (via #654) (@solnic)
    • Top-level associations DSL (via #656) (@solnic)
    • Support for configuring plugins on a per-component instance basis, which means that implementing plugins is now simpler and more powerful (via #656) (@solnic)
    • New relation setting: component.infer_id_from_class (via #661) (@solnic)
    • [experimental] New ROM.components API for registering custom component types (via #654) (@solnic)
    • 0๏ธโƒฃ .transaction methods now accept keyword arguments. Repository#transaction accepts gateway to use. Repository::Root#transaction uses a gateway of the root relation by default (#620 closed by #621) (@flash-gordon)
    • Backward-compatibility extension that you can load via require "rom/compat" (via #634 refs #607) (@solnic)

    ๐Ÿ›  Fixed

    • ๐Ÿ›  Setup works under MRI 3.0.0 (issue #622 fixed via #623) (@v-kolesnikov)

    ๐Ÿ”„ Changed

    • ๐Ÿ”€ [BREAKING] rom-core, rom-changeset and rom-repository have been merged into rom gem (@solnic)
    • [BREAKING] Setup#auto_registration was renamed to Setup#auto_register. You can restore the original method via rom/compat extension (via #634 refs #607) (@solnic)
    • ๐Ÿ”ง [BREAKING] Configuration#method_missing no longer resolves gateways by default. This functionality was moved to rom/compat (@solnic)
    • ๐Ÿ”ง [BREAKING] ROM::Configuration is deprecated and it was replaced by ROM::Setup. It can be restored via rom/compat (via #653) (@solnic)
    • ๐Ÿ—„ ROM.container is deprecated and it was replaced by ROM.runtime (via #653) (@solnic)
    • ๐Ÿ›  Schema#[] and Relation#[] now raise an error if a given attribute is not unique (issue #529 fixed via #543) (@waiting-for-dev)
    • ๐Ÿ”ง Configuration values are no longer being frozen during setup process (issue #616 fixed via #617) (@v-kolesnikov)
    • Custom commands are now lazily-resolved at runtime, which simplifies and speeds up setup and finalization (via #641) (@solnic)
    • Mappers are now lazy-resolved at runtime which speeds up setup and finalization (via #642) (@solnic)
    • Schemas are now 1st class components accessible via runtime container and decoupled from relations (via #644) (@solnic)
    • Relation.dataset receives canonical schema object now, rather than relation class (via #644) (@solnic)
    • Relation classes no holder hold their schemas as class variables (via #644) (@solnic)
    • Gateways are now lazy-loadable (via #645) (@solnic)
    • Associations are now decoupled from schemas and lazy-loaded (via #646) (@solnic)
    • ๐Ÿ”Œ Plugin API is now internally simplified which resulted in faster runtime. It's also no longer required to register plugin types upfront (via #648) (@solnic)
    • Configuring auto_register stores its config under config.auto_register (via #650) (@solnic)
    • [internal] auto registration is now powered by Zeitwerk (via #634 refs #607) (@solnic)
    • ๐Ÿ”Œ Plugin event listeners are no longer global which makes it possible to have plugin with different configs in a single process (via #639) (@solnic)
    • [internal] Command compiler is no longer coupled to gateway and notifications (via #640) (@solnic)
    • Plugin configurations are no longer global which means that you can configure the same plugin with different default settings for different component groups or different runtimes in the same Ruby process (via #654) (@solnic)
    • ๐Ÿ—„ Schema::DSL is now deprecated. Adapters that need customized schema DSL behavior can provide plugins instead (via #656) (@solnic)
    • ๐Ÿ”Œ ROM.plugins returns global plugin registry when called without a block (via #660) (@solnic)
    • โช [internal] ROM::Container is deprecated and it was replaced by ROM::Registries::Root. It can be restored via rom/compat (via #653) (@solnic)
    • [internal] Commands that are compiled at runtime are now cached in the runtime registry (via #653) (@solnic)
    • ๐Ÿ—„ [internal] ROM.plugin_registry is deprecated, use ROM.plugins instead (via #660) (@solnic)
    • [REVISIT] configuring custom gateway for a relation via DSL requires passing it as an option rather than specifying it within the block. It kinda-worked previously because the adapter was defaulting to the first one found. I'm quite sure this was more like a bug than a feature. This behavior could be restored in rom/compat though - it's a matter of defaulting to the first adapter found when gateway was not explicitly specified, meaning the new default should be set to Undefined rather than :default so that we can detect when it was not specified and act accordingly. This will only make sense when there's just one adapter available (via bedb330f0ec195d9acacf4481dad3a705e8a36af) (@solnic)

    Compare v5.2.4...v6.0.0.alpha1

Previous changes from v5.2.4