Skip to content

Latest commit

 

History

History
268 lines (169 loc) · 9.65 KB

CHANGELOG.md

File metadata and controls

268 lines (169 loc) · 9.65 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[3.5.0] 2025-01-01

Added

  • render_serialized_json now works with root_key and meta #398

Improved

  • Add transform_keys caching #402

[3.4.0] 2024-12-01

Added

  • Alba.serialize now works with heterogeneous collection #396

[3.3.3] 2024-11-09

Fixed

  • TypedAttribute now respects prefer_resource_method! #391

[3.3.2] 2024-10-30

Fixed

  • Rails integration with ActionController::API

[3.3.1] 2024-10-17

Fixed

  • Add ostruct as gemspec dependency to be prepared for ruby 3.3.5. #386

[3.3.0] 2024-10-09

Added

  • Add ArrayOfString and ArrayOfInteger type #378

[3.2.0] 2024-06-21

Added

  • Rails controller integration #370
  • Modification API: transform_keys! #372

[3.1.0] 2024-03-23

Added

  • Add the ability to change key for metadata #362

[3.0.3] 2023-12-25

Fixed

  • Make as_json compatible with Rails #350
  • Fix circular association for nested_attribute #353

[3.0.2] 2023-12-05

Fixed

  • Fixed warning when location option is given to render json: in Rails #348

[3.0.1] 2023-10-13

Fixed

  • Fixed a bug where methods such as test or params cannot be used as attribute name #344
  • Remove redundant code

[3.0.0] 2023-10-11

IMPORTANT

This release contains an important bug fix that can cause data corruption. If you're using Ruby 3, it's highly recommended to upgrade to v3.0.0 If you're using Ruby 2, please upgrade to v2.4.2 that contains bug fix only as soon as possible.

Added

Changed

  • Prefer resource method #323

Fixed

  • Multithread bug No PR
    • This is a critical bug that can cause data corruption.

Removed

  • Drop support for Ruby 2 series No PR

[2.4.1] 2023-08-02

Fixed

  • Fix the bug of resource name inference for classes whose name end with "Serializer" No PR

[2.4.0] 2023-08-02

Added

  • Implement helper #322
  • Add prefer_resource_method! #323

Fixed

  • Fix the bug of resource name inference No PR

[2.3.0] 2023-04-24

Added

  • Add compatibility option for key #304
  • It now infers resource name from Serializer #309
  • Alba.serialize is easier to use for multiple root keys #311
  • Gives access to params in nested_attribute #312
    • Thank you, @GabrielErbetta

[2.2.0] 2023-02-17

Added

  • Rails integration to set default inflector #298

Fixed

  • Fix cascade not working with association and inheritance #300

Removed

  • Drop support of Ruby 2.6

[2.1.0] 2022-12-03

Added

  • Add select method for filtering attributes #270
  • Allow ConditionalAttribute with 2-arity proc to reject nil attributes #273

Fixed

  • Add support for proc resource in one polymorphic associations #281

Deprecated

  • Deprecate inference related methods in favor of a unified inflector interface. Deprecated methods are: Alba.enable_inference!, Alba.disable_inference!, and Alba.inferring. Use Alba.inflector = :active_support/:dry or Alba.inflector = SomeInflector to enable. Use Alba.inflector = nil to disable. Use Alba.inflector to check if enabled.

[2.0.1] 2022-11-02

Fix

  • the bug including key not in within #262
  • key transformation now cascades multiple levels #263

[2.0.0] 2022-10-21

Breaking changes

  • All Hash-related methods now return String keys instead of Symbol keys. This affects all users, but you can use deep_symbolize_keys in Rails environment if you prefer Symbol keys, or with_indifferent_access to support both String and Symbol keys. Some DSLs that take key argument such as on_nil and on_error, are also affected.
  • Remove deprecated methods: Resource#to_hash, Resource.ignoring, Alba.on_nil, Alba.on_error, Alba.enable_root_key_transformation! and Alba.disable_root_key_transformation!
  • If using transform_keys, the default inflector is no longer set by default d02245c8 To retain this functionality in Rails, add an initializer with the following: Alba.enable_inference!(with: :active_support)

New features

  • Passing an initial object to proc function in associations #209
  • Allow association resource to be Proc #213
  • collection_key to serialize collection into a Hash #119
  • params is now overridable #227
  • Key transformation now cascades #232
  • nested attribute #237
  • Implement as_json #249

Bugfix

  • fix the bug where nesting is empty string and invalid
  • handle_error now raises the same error
  • let Rails implicitly call to_json

[1.6.0] 2022-03-16

  • [Feat] Support instance method as an attribute
  • [Fix] Explicitly raise error when inference is disabled
  • [Improve] enable_inference! now takes inflector as argument
  • [Improve] transform_keys now accepts :snake and :none
  • [Deprecate] to_hash is special method and should not be used
  • [Deprecate] ignoring in favor of attributes overriding
  • [Deprecate] Alba.on_nil, Alba.on_error and Alba.enable_root_key_transformation!

[1.5.0] 2021-11-28

  • [Feat] Add nil handler
  • [Feat] Implement layout feature
  • [Improve] if option now works with Symbol
  • [Improve] Add an alias for serialize
  • [Improve] Deprecation warning now printed with caller

[1.4.0] 2021-06-30

  • [Feat] Add a config method to set encoder directly
  • [Feat] Implement meta method and option for metadata
  • [Feat] Add root_key option to Resource#serialize
  • [Feat] Enable setting key for collection with root_key
  • [Feat] Add Resource.root_key and Resource.root_key!
  • [Feat] Alba.serialize now infers resource class
  • [Deprecated] Resource.key and Resource.key! are deprecated

[1.3.0] 2021-05-31

  • [Perf] Improve performance for many [641d8f9]
  • [Feat] Add custom inflector feature (#126) [ad73291]
    • #126
    • Thank you @wuarmin !
  • [Feat] Support params in if condition [6e9915e]
  • [Fix] fundamentally broken "circular association control" [fbbc9a1]

[1.2.0] 2021-05-09

  • [Fix] multiple word key inference [6c18e73]
    • #120
    • Thank you @alfonsojimenez !
  • [Feat] Add Alba.enable_root_key_transformation! [f172839]
  • [Feat] Implement type validation and auto conversion [cbe00c7]

[1.1.0] - 2021-04-23

  • [Feat] Implement circular associations control [71e1543]
  • [Feat] Support :oj_rails backend [76e519e]

[1.0.1] - 2021-04-15

  • [Fix] Don't cache resource class for Alba.serialize [9ed5253]
  • [Improve] Warn when ActiveSupport or Oj are absent [d3ab3eb]
  • [Fix] Delete unreachable to_hash method on Association [1ba1f90]
  • [Fix] Stringify key before transforming [b4eb79e]
  • [Misc] Support Ruby 2.5.0 and above, not 2.5.7 and above [43f1d17]
  • [Fix] Remove accidentally added p debug [5d0324b]

[1.0.0] - 2021-04-07

This is the first major release of Alba and it includes so many features. To see all the features you can have a look at README.