Refactor settings related code #5325
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Senen
force-pushed
the
settings_refactor
branch
from
73317d9
to
4d4ed13
Compare
Senen
force-pushed
the
settings_refactor
branch
from
4d4ed13
to
0ea175c
Compare
Senen
force-pushed
the
settings_refactor
branch
from
0ea175c
to
6162e8c
Compare
javierm
reviewed
Dec 5, 2023
app/components/admin/settings/content_types_form_component.html.erb
Outdated
Show resolved
Hide resolved
Senen
force-pushed
the
settings_refactor
branch
from
ea822a7
to
b61e633
Compare
Senen
force-pushed
the
settings_refactor
branch
4 times, most recently
from
ac20b59
to
1f8fc95
Compare
javierm
reviewed
Jan 18, 2024
app/components/admin/settings/remote_census_tab_component.html.erb
Outdated
Show resolved
Hide resolved
Senen
force-pushed
the
settings_refactor
branch
3 times, most recently
from
18d3857
to
8f612c9
Compare
javierm
approved these changes
Jan 19, 2024
javierm
reviewed
Jan 19, 2024
Senen
force-pushed
the
settings_refactor
branch
from
8f612c9
to
58fc81f
Compare
javierm
approved these changes
Jan 22, 2024
Now, with the same template we can render all kind of settings.
Instead of using a setting nested param `setting[:tab]`. We only need the tab param when rendering settings in the administration section. This change will make it easier rendering the correct tab after updating settings.
Before this change, two important things depend on the format of each key, where to render it in the administration panel and which kind of interface to use for each setting. Following this strategy led us to a very complex code, very difficult to maintain or modify. So, we do not want to depend on the setting key structure anymore to decide how or where to render each setting. With this commit, we get rid of the key format-based rules. Now we render each setting explicitly passing to it the type and the tab where it belongs.
Otherwise administrators cannot access the settings from other tabs.
Otherwise we get a AuthenticityToken exception. I was nor able to write a test to verify this change.
javierm
force-pushed
the
settings_refactor
branch
from
58fc81f
to
ea0cede
Compare
taitus
approved these changes
Jan 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
References
Before this change, two important things depend on the format of each key, where to render it in the administration panel and which kind of interface to use for each setting.
Following this strategy led us to a very complex code, very difficult to maintain or modify. So, we no longer want to depend on the setting key structure to decide how or where to render each setting.
Objectives
Do not rely on the setting key structure to decide where to render a setting or which interface to use. Now we are doing this in the view layer by using view components.
We hope customizing the settings or adding new ones will be easier for developers, too.
Visual Changes
Without changes.
Release notes
Installations using custom settings should add them to the new views when upgrading to the release 2.1.0.