Centralize ViewComponent::Base config #1291

boardfish · 2022-02-22T12:46:42Z

Summary

@Spone recognized that the generator options aren't available with the rest of the ViewComponent config options. This PR fixes that by having ViewComponent::Base.generate map back to config.view_component.generate.

The scope of this PR has been extended to have ViewComponent::Base.config be the new source of truth for config. It's mirrored to the ViewComponent::Base class level for backwards compatibility's sake, and also mirrored to app config via the Rails engine. Now, at all times, folks can expect for example ViewComponent::Base.generate.sidecar, Rails.application.config.view_component.generate.sidecar, and ViewComponent::Base.config.sidecar to be functionally equivalent.

Spone · 2022-02-22T12:50:34Z

Thanks for your quick diagnosis!

How come our tests did not catch this? Can we write some tests do make sure we do not break this in the future?

boardfish · 2022-02-22T12:52:37Z

I've just done a quick run-through and a lot of the config options claim to default to certain values when they're actually falsy, so I'll correct that too. And you're right that I should get some tests in place 👍

test/view_component/integration_test.rb

lib/view_component/base.rb

docs/api.md

boardfish · 2022-03-29T15:57:35Z

Besides the coverage gap, I still need to make ViewComponent::Base.config the source of truth that's mirrored by Rails.application.config.view_component. As it stands, Rails.application.config.view_component being the source of truth breaks rake docs:build, as that doesn't rely on a backing Rails app to deal with components.

boardfish · 2022-03-29T16:59:27Z

Alright, I think this is in a much better place now. The functionality is in, but I still need to:

Ensure documentation for all config options remains
Potentially add a deprecation warning for the config_accessors - ideally, we should get rid of the top-level accessors
Get test coverage back up to 100%

boardfish · 2022-03-30T13:43:17Z

Think it's good for review again now. I'm not sure we should deprecate the config_accessors until they cause a problem - it's more correct that we shouldn't pollute the class-level namespace for methods with them, but I don't think their existence hinders anything we'd otherwise try to do.

joelhawksley

👏🏻 LOVE it.

lib/view_component/config.rb

joelhawksley · 2022-03-31T19:14:04Z

lib/view_component/config.rb

+      end
+    end
+
+    def initialize(parent = nil)


In what case is this argument used? I wonder if this is a case for deprecating support for Ruby 2.6...

I think I had to keep the method signature this way for all cases. Maybe ActiveSupport::Configurable tries to use it? It might hinder composing around InheritableOptions as you mentioned elsewhere, but I'll investigate further and give it a shot.

joelhawksley · 2022-03-31T19:14:04Z

lib/view_component/config.rb

+require "view_component/deprecation"
+
+module ViewComponent
+  class Config < ActiveSupport::InheritableOptions


What do you think about composing around InheritableOptions instead of inheriting from it? It might help us avoid overwriting the initializer, etc.

Makes sense to do, but InheritableOptions is a class and not a module, so I'm not sure how I'd go about this.

@boardfish in general terms, what I mean is that we would initialize a new ActiveSupport::InheritableOptions in the Config initializer, then call methods on it in Config, instead of subclassing. Does that make sense?

(I'd also be open to some pairing time if you'd like! We're overdue as it is ❤️ )

Ah, I see what you mean now - I'll give it a rejig and see where we get to.

And it might also be good to pair to really wrap this up! I'll be in touch at some point.

@boardfish would you like to pair on this?

test/test_helper.rb

boardfish · 2022-04-11T08:52:13Z

Think this is ready for another pass.

docs/CHANGELOG.md

ALl it did was make preview-related config accessible on ViewComponent::Base

The pieces are in place, but I think the final aim is that everything for which there's a default and/or a reader is documented

Co-authored-by: Joel Hawksley <joel@hawksley.org>

boardfish reviewed Feb 22, 2022

View changes

test/view_component/integration_test.rb Outdated Show resolved Hide resolved

Spone reviewed Feb 22, 2022

View changes

lib/view_component/base.rb Outdated Show resolved Hide resolved

boardfish force-pushed the generate-options-in-config-namespace branch from 21ef508 to 3c9b994 Compare Feb 23, 2022

boardfish marked this pull request as ready for review Feb 23, 2022

boardfish requested review from juanmanuelramallo and as code owners Feb 23, 2022

boardfish force-pushed the generate-options-in-config-namespace branch from 3c9b994 to 05fdf79 Compare Feb 24, 2022

boardfish force-pushed the generate-options-in-config-namespace branch 2 times, most recently from b4d5497 to 5298d3c Compare Mar 29, 2022

Spone reviewed Mar 29, 2022

View changes

docs/api.md Outdated Show resolved Hide resolved

boardfish marked this pull request as draft Mar 29, 2022

boardfish changed the title ~~Add generate options to ViewComponent engine config~~ Centralize ViewComponent::Base config Mar 29, 2022

boardfish marked this pull request as ready for review Mar 30, 2022

boardfish marked this pull request as draft Mar 30, 2022

boardfish marked this pull request as ready for review Mar 30, 2022

boardfish requested review from Spone and joelhawksley and removed request for Mar 30, 2022

joelhawksley reviewed Mar 31, 2022

View changes

boardfish force-pushed the generate-options-in-config-namespace branch from 8ddf6e6 to c7eed01 Compare Apr 5, 2022

boardfish requested a review from joelhawksley Apr 11, 2022

joelhawksley reviewed Apr 12, 2022

View changes

docs/CHANGELOG.md Outdated Show resolved Hide resolved

boardfish mentioned this pull request May 20, 2022

Generator config is not working from development.rb #1362

Open

boardfish force-pushed the generate-options-in-config-namespace branch from 7893e28 to 430d80b Compare May 20, 2022

boardfish and others added 24 commits Jun 3, 2022

Remove the Previewable module

680c08f

ALl it did was make preview-related config accessible on ViewComponent::Base

Add default_preview_layout to global config

19de4c1

Run bundle update

aa5a46d

Make ViewComponent::Base the source of truth for config

046f817

Add backwards compatibility for config_accessor defaults

91cdc4b

Restore documentation for config options

f0e1600

Improve test coverage

ffcde2b

Directly require ViewComponent::Base to fix Primer CI

397b53b

Directly require ViewComponent::Config to fix Primer CI

f1c6e88

Move config require to ViewComponent::Base

4e50539

Require ViewComponent::Deprecation in Config

7ba7710

Add missing defaults

0572665

Reset default_preview_layout to nil

da45e75

Remove all changes to docs/api.md

93b907d

Remove old top-level config documentation

8df8992

Add code ownership

165accb

s/with_generate/with_generate_option/

88b12e3

Explain alias between .default and .new

5a4e15b

Draft test to ensure all config options are documented

55e8a3a

The pieces are in place, but I think the final aim is that everything for which there's a default and/or a reader is documented

Ensure accessors defined in public methods are considered too

a4b287e

Coerce to string for backwards compatibility

d5d2a13

Lint

44565a0

Use Ruby 3.0.3

ea3a42a

Add missing require for translatable

04f603e

boardfish force-pushed the generate-options-in-config-namespace branch from 0e1e9d7 to 04f603e Compare Jun 3, 2022

Spone and others added 2 commits Jun 3, 2022

Merge branch 'main' into generate-options-in-config-namespace

bfcf490

Add more detailed changelog message

d345f0e

Co-authored-by: Joel Hawksley <joel@hawksley.org>

boardfish requested a review from joelhawksley Jun 7, 2022

Spone mentioned this pull request Jun 15, 2022

Component generator is failing due ViewComponent::Base.generate being nil #1397

Open

Spone linked an issue Jun 15, 2022 that may be closed by this pull request

Component generator is failing due ViewComponent::Base.generate being nil #1397

Open

Centralize ViewComponent::Base config #1291

Centralize ViewComponent::Base config #1291

boardfish commented Feb 22, 2022 •

edited

Spone commented Feb 22, 2022

boardfish commented Feb 22, 2022

boardfish commented Mar 29, 2022

boardfish commented Mar 29, 2022 •

edited

boardfish commented Mar 30, 2022

joelhawksley left a comment

joelhawksley Mar 31, 2022

boardfish Apr 1, 2022

joelhawksley Mar 31, 2022

boardfish Apr 8, 2022

joelhawksley Apr 12, 2022

joelhawksley Apr 12, 2022

boardfish Apr 12, 2022

boardfish Apr 12, 2022

joelhawksley Jun 8, 2022

boardfish commented Apr 11, 2022

Centralize ViewComponent::Base config #1291

Are you sure you want to change the base?

Centralize ViewComponent::Base config #1291

Conversation

boardfish commented Feb 22, 2022 • edited

Summary

Spone commented Feb 22, 2022

boardfish commented Feb 22, 2022

boardfish commented Mar 29, 2022

boardfish commented Mar 29, 2022 • edited

boardfish commented Mar 30, 2022

joelhawksley left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

boardfish commented Apr 11, 2022

boardfish commented Feb 22, 2022 •

edited

boardfish commented Mar 29, 2022 •

edited