Migrate from `Virtus` to `ActiveModel::Attributes` (and get rid of `Rectify::Form`) by ahukkanen · Pull Request #8669 · decidim/decidim

ahukkanen · 2021-12-30T21:02:43Z

🎩 What? Why?

The basic idea of this PR is to refactor the Virtus models (such as all instances of Rectify::Form) in the core to the new ActiveModel::Attributes based solution as discussed at #7234. The reason for this is the discontinuation of Virtus.

This provides a compatibility layer that preserves backwards compatibility as long as possible with the Rectify::Forms API requiring little to no changes in the existing Form classes. ActiveModel::Attributes works a bit differently than Rectify::Form (e.g. no nested Forms or attributes), so we need this layer to keep functionality as-is without any major changes.

📌 Related Issues

Link your PR to an issue

Related to Discontinued Gems #7234
Fixes Migrate from Virtus to ActiveModel::Attributes API #8514

Testing

Run the specs and test the application with this implementation.

📋 Checklist

…emodel-attributes-forms

Fix several bugs in different form cases used all over the application related to both, the top-level attributes as well as nested attributes.

…esting

andreslucena

All is OK for me! 👍🏽

andreslucena · 2022-01-17T12:29:43Z

Can we merge this one @ahukkanen? Or is there anything else that you want to add to this PR?

ahukkanen · 2022-01-17T13:08:13Z

@andreslucena On my part it's ready.

@alecslupu Raised some concerns regarding compatibility with 3rd party modules. I thought I'd still test those two modules he mentioned.

I'm not expecting zero changes in these but I would expect most of the things to work fine without changes. Specs will likely need some updates, though.

ahukkanen · 2022-01-17T15:36:12Z

@alecslupu @andreslucena

I have tested both NavbarLinks and Decidim Awesome modules with the ActiveModel::Attributes changes.

Here's my findings:

NavbarLinks

Branch master, changed the version number to ~> 0.27.0.dev.

No problems identified. No changes done.

All other specs pass except this one:
https://github.com/OpenSourcePolitics/decidim-module-navbar_links/blob/6de93c18ebaa3a788b1e1ba26f1c771cc319aa51/spec/system/navbar_links/navbar_links_spec.rb#L16

This failing spec is not related to the ActiveModel::Attributes migration, it is failing because of the external link warnings added at #7397 which causes the unrecognized external URLs to be linked through /link?external_url=http....

Decidim Awesome

Branch upgrade_025, changed the version number to ~> 0.27.0.dev. Also had to add admin engines to the Awesome modules (iframe and map components) for them not to throw any exceptions in the admin panel participatory space views. For the specs to run had to change factory :editor_image to :awesome_editor_image because this factory now already exists in the core.

Working fine:

Dropping image to a WYSIWYG field (image saved as a blob)
Updating constraints for configs

Not working without changes:

Autosave for surveys (but I think this is some other problem since it should work in the front-end, right?)
Updating awesome configs -> mismatch for string keys in the attributes https://github.com/Platoniq/decidim-module-decidim_awesome/blob/8b36e35a22ca22d7ff21ef4bf6ed9afcfa47cb98/app/forms/decidim/decidim_awesome/admin/config_form.rb#L34 -- Fix: key.to_sym -> key.to_s

After the above fix, all configuration forms work normally in the admin panel.

All other non-system specs pass after this change except for the following specs:

./spec/uploaders/image_uploader_spec.rb - Needs the module to be updated to support ActiveStorage
./spec/lib/system_checker_spec.rb - Something with the checksums/decidim version changes did not check further
./spec/forms/admin/menu_form_spec.rb - Label keys need to be converted from symbols to hashes in the expectation
./spec/commands/admin/update_constraint_spec.rb - Extra id field in the constraint form attributes (spec update needed)
./spec/controllers/editor_images_controller_spec.rb - Needs the module to be updated to support ActiveStorage
./spec/controllers/admin/checks_controller_spec.rb - I believe needs some changes with the module versions (?)

I believe most of the system specs failures are caused by the missing assets (or broken front-end), as the module has not yet been updated to be compatible with Webpacker. And the uploader specs are failing because ActiveStorage is not fully updated (as far as I understood). It would make much more sense to test these after the module has been upgraded to 0.25 or 0.26.

Further notes

I am no expert in either of these modules, these were just quick tests within the UI and by running the specs.

alecslupu · 2022-01-17T15:39:33Z

This failing spec is not related to the ActiveModel::Attributes migration, it is failing because of the external link warnings added at #7397 which causes the unrecognized external URLs to be linked through /link?external_url=http....

Addressed here ... pending @armandfardeau 's input : OpenSourcePolitics/decidim-module-navbar_links#23

…ectify::Form`) (#8669)

ahukkanen added 30 commits April 3, 2021 17:39

Add the attribute base objects to remove Virtus and Rectify forms

2166657

Switch the form class to use attribute object instead of rectify

ac108c6

Fix the translatable attributes after rectify -> attribute object

dcd3518

Refactor the attribute classes from Virtus to ActiveModel

3efd371

Remove unnecessary method

f2b7f83

Merge branch 'develop' into refactor/remove-virtus-and-rectify

5cf048c

Merge branch 'refactor/remove-virtus-and-rectify' into refactor/activ…

e019156

…emodel-attributes-forms

Fix bugs in actual use cases with the attirubte object

33196cb

Fix several bugs in different form cases used all over the application related to both, the top-level attributes as well as nested attributes.

Fix the organization settings default float values

c191d66

Convert the authorization form builder to ActiveModel::Attributes

8bb9bfa

Fix the recipient_id type definition for the ConversationForm

dd37b58

Fix issues in the UpdateContentBlock form with the new attributes API

c817eb1

Update the attributes specs to the new API

ffc6ebe

Fix the public attributes types in the AuthorizationFormBuilder spec

eab75e4

Fix the authorization handler for the new attributes API

8202f5c

Fix the FileUploadSettingsForm for the new attributes API

1e1faa4

Update the admin formbuilder spec for the new API

1229746

Refactor most of the Virtus.model includes to AttributeObject::Model

720d5de

Move the attributes register calls to the Attributes module

f7113c1

Add synonym for the :date_time attribute type

9ad4575

Add the symbol type

1acb25a

Define Proc as a "primitive" type

1d26ecd

Do not crash if the Decidim::Form class is not defined (yet)

79c6e6b

Make sure the attributes passed to the initializer are converted to hash

525a5b1

Require the attributes module to define the attribute types

cce0cac

Change the array default value type to Object instead of String

1106da9

Add Rails::Engine to the primitive types

d5dfcb9

Add ActiveSupport::Duration to the primitive types

9aa16a5

Do not initialize the class constant types

f5ecb74

Convert the rest of the manifest classes to AttributeObject::Model

5c0b795

ahukkanen added 7 commits January 17, 2022 11:13

Fix typo in CHANGELOG splice -> slice

53eb24e

Allow access to attribute keys through symbols (backwards compatibility)

330db22

Add spec for the attribute method testing key accessors

770ed19

Refactor: transform_keys(&:to_sym) -> symbolize_keys

a3996e7

Fix typo in CHANGELOG

9fa320c

Move the file type CHANGELOG note before the Array/Hash type defs

9715fc4

Move the note about Rails::Engine type to by the last note before t…

bb72197

…esting

andreslucena approved these changes Jan 17, 2022

View reviewed changes

andreslucena merged commit 369f293 into decidim:develop Jan 17, 2022

ahukkanen deleted the refactor/activemodel-attributes-forms branch January 17, 2022 14:26

andreslucena mentioned this pull request Jan 17, 2022

To drop the symbols compatibility in Decidim::AttributeObject::Model #8722

Closed

andreslucena pushed a commit that referenced this pull request Jan 25, 2022

Migrate from Virtus to ActiveModel::Attributes (and get rid of `R…

1f372f1

…ectify::Form`) (#8669)

alecslupu mentioned this pull request Feb 2, 2022

Virtus is still being used in application #8777

Closed

lahdeero mentioned this pull request Feb 4, 2022

Fix reminder manifest, replace virtus with attribute object #8785

Merged

This was referenced Feb 7, 2022

Fix a bug with attachment attributes caused by AttributeObject migration #8790

Merged

Fix AttributeObject changelog and few docs #8791

Merged

Fix translatable presence validator for hyphenated locales #8795

Merged

ahukkanen mentioned this pull request Jul 5, 2022

Fix nested attributes model mapping #9516

Merged

12 tasks

ahukkanen mentioned this pull request Aug 18, 2022

Remove axe-core-rspec dependency to get fully rid of virtus dependency #9758

Merged

sergei-krylov mentioned this pull request Oct 21, 2022

Fix organization SMTP password not saved (became blank) in system panel #9925

Merged

ahukkanen mentioned this pull request Jan 12, 2023

Fix an edge case with the attribute object forms with arrays/enumerables passed to non-array types #10218

Merged

andreslucena mentioned this pull request May 23, 2023

I can't access to my initiatives #10897

Closed

andreslucena mentioned this pull request Jun 14, 2023

Backport 'Change to display initiatives after creation' to v0.26 #11030

Closed

alecslupu added this to the 0.27.0 milestone Jul 14, 2023

ahukkanen mentioned this pull request Mar 29, 2024

Fix issues with the budgets proposals import #12655

Merged

andreslucena mentioned this pull request Nov 28, 2025

Drop the symbols compatibility for Decidim::AttributeObject::Model #15676

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Migrate from `Virtus` to `ActiveModel::Attributes` (and get rid of `Rectify::Form`)#8669

Migrate from `Virtus` to `ActiveModel::Attributes` (and get rid of `Rectify::Form`)#8669
andreslucena merged 149 commits intodecidim:developfrom
mainio:refactor/activemodel-attributes-forms

ahukkanen commented Dec 30, 2021 •

edited

Loading

Uh oh!

andreslucena left a comment

Uh oh!

andreslucena commented Jan 17, 2022

Uh oh!

ahukkanen commented Jan 17, 2022

Uh oh!

ahukkanen commented Jan 17, 2022 •

edited

Loading

Uh oh!

alecslupu commented Jan 17, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

ahukkanen commented Dec 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎩 What? Why?

📌 Related Issues

Testing

📋 Checklist

Uh oh!

andreslucena left a comment

Choose a reason for hiding this comment

Uh oh!

andreslucena commented Jan 17, 2022

Uh oh!

ahukkanen commented Jan 17, 2022

Uh oh!

ahukkanen commented Jan 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

NavbarLinks

Decidim Awesome

Further notes

Uh oh!

alecslupu commented Jan 17, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ahukkanen commented Dec 30, 2021 •

edited

Loading

ahukkanen commented Jan 17, 2022 •

edited

Loading