view_component: Error when using `.css.erb` sidecar file for component

Steps to reproduce

  1. Generate a new component with sidecar files
  2. Add a .css.erb file to the component’s sidecar directory
  3. Attempt to view the preview of the component
  4. Result: Error “More than one template found”

Expected behavior

ViewComponent should only look for .html.erb files for templates. If more than one HTML file is found produce error, otherwise carry on.

Actual behavior

Error: “More than one template found” was received when another .erb file is in the component’s sidecar directory.

Backtrace:

[view_component (3.2.0) lib/view_component/compiler.rb:36:in `compile' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[view_component (3.2.0) lib/view_component/base.rb:479:in `compile' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[view_component (3.2.0) lib/view_component/base.rb:72:in `render_in' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/helpers/rendering_helper.rb:42:in `render' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[view_component (3.2.0) app/views/view_components/preview.html.erb:3 ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/base.rb:244:in `public_send' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/base.rb:244:in `_run' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/template.rb:157:in `block in render' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/notifications.rb:208:in `instrument' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/template.rb:361:in `instrument_render_template' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/template.rb:155:in `render' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/renderer/template_renderer.rb:65:in `block (2 levels) in render_template' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/notifications.rb:206:in `block in instrument' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/notifications/instrumenter.rb:24:in `instrument' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/notifications.rb:206:in `instrument' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/renderer/template_renderer.rb:60:in `block in render_template' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/renderer/template_renderer.rb:75:in `block in render_with_layout' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/notifications.rb:206:in `block in instrument' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/notifications/instrumenter.rb:24:in `instrument' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/notifications.rb:206:in `instrument' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/renderer/template_renderer.rb:74:in `render_with_layout' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/renderer/template_renderer.rb:59:in `render_template' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/renderer/template_renderer.rb:11:in `render' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/renderer/renderer.rb:61:in `render_template_to_object' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/renderer/renderer.rb:29:in `render_to_object' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/rendering.rb:117:in `block in _render_template' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/base.rb:270:in `in_rendering_context' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/rendering.rb:116:in `_render_template' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/streaming.rb:216:in `_render_template' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/rendering.rb:103:in `render_to_body' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/rendering.rb:158:in `render_to_body' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/renderers.rb:141:in `render_to_body' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/abstract_controller/rendering.rb:27:in `render' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/rendering.rb:139:in `render' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/instrumentation.rb:22:in `block (2 levels) in render' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[/Users/FredBoyle/.rubies/ruby-3.2.2/lib/ruby/3.2.0/benchmark.rb:311:in `realtime' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/core_ext/benchmark.rb:14:in `ms' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/instrumentation.rb:22:in `block in render' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/instrumentation.rb:91:in `cleanup_view_runtime' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activerecord (7.0.5) lib/active_record/railties/controller_runtime.rb:34:in `cleanup_view_runtime' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/instrumentation.rb:21:in `render' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[view_component (3.2.0) app/controllers/concerns/view_component/preview_actions.rb:42:in `previews' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/basic_implicit_render.rb:6:in `send_action' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/abstract_controller/base.rb:215:in `process_action' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/rendering.rb:165:in `process_action' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/abstract_controller/callbacks.rb:234:in `block in process_action' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/callbacks.rb:118:in `block in run_callbacks' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[i18n (1.14.1) lib/i18n.rb:322:in `with_locale' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[view_component (3.2.0) app/controllers/concerns/view_component/preview_actions.rb:72:in `set_locale' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/callbacks.rb:127:in `block in run_callbacks' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actiontext (7.0.5) lib/action_text/rendering.rb:20:in `with_renderer' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actiontext (7.0.5) lib/action_text/engine.rb:69:in `block (4 levels) in <class:Engine>' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/callbacks.rb:127:in `instance_exec' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/callbacks.rb:127:in `block in run_callbacks' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/callbacks.rb:138:in `run_callbacks' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/abstract_controller/callbacks.rb:233:in `process_action' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/rescue.rb:22:in `process_action' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/instrumentation.rb:67:in `block in process_action' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/notifications.rb:206:in `block in instrument' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/notifications/instrumenter.rb:24:in `instrument' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/notifications.rb:206:in `instrument' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/instrumentation.rb:66:in `process_action' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal/params_wrapper.rb:259:in `process_action' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activerecord (7.0.5) lib/active_record/railties/controller_runtime.rb:27:in `process_action' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/abstract_controller/base.rb:151:in `process' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionview (7.0.5) lib/action_view/rendering.rb:39:in `process' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal.rb:188:in `dispatch' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_controller/metal.rb:251:in `dispatch' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/routing/route_set.rb:49:in `dispatch' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/routing/route_set.rb:32:in `serve' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/journey/router.rb:50:in `block in serve' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/journey/router.rb:32:in `each' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/journey/router.rb:32:in `serve' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/routing/route_set.rb:852:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/static.rb:23:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[rack (2.2.7) lib/rack/tempfile_reaper.rb:15:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[rack (2.2.7) lib/rack/etag.rb:27:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[rack (2.2.7) lib/rack/conditional_get.rb:27:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[rack (2.2.7) lib/rack/head.rb:12:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/http/permissions_policy.rb:38:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/http/content_security_policy.rb:36:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[rack (2.2.7) lib/rack/session/abstract/id.rb:266:in `context' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[rack (2.2.7) lib/rack/session/abstract/id.rb:260:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/cookies.rb:704:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activerecord (7.0.5) lib/active_record/migration.rb:603:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/callbacks.rb:27:in `block in call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/callbacks.rb:99:in `run_callbacks' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/callbacks.rb:26:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/executor.rb:14:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/actionable_exceptions.rb:17:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/debug_exceptions.rb:28:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/show_exceptions.rb:26:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[railties (7.0.5) lib/rails/rack/logger.rb:40:in `call_app' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[railties (7.0.5) lib/rails/rack/logger.rb:25:in `block in call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/tagged_logging.rb:99:in `block in tagged' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/tagged_logging.rb:37:in `tagged' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/tagged_logging.rb:99:in `tagged' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[railties (7.0.5) lib/rails/rack/logger.rb:25:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[sprockets-rails (3.4.2) lib/sprockets/rails/quiet_assets.rb:13:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/remote_ip.rb:93:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/request_id.rb:26:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[rack (2.2.7) lib/rack/method_override.rb:24:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[rack (2.2.7) lib/rack/runtime.rb:22:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[activesupport (7.0.5) lib/active_support/cache/strategy/local_cache_middleware.rb:29:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/server_timing.rb:61:in `block in call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/server_timing.rb:26:in `collect_events' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/server_timing.rb:60:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/executor.rb:14:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/static.rb:23:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[rack (2.2.7) lib/rack/sendfile.rb:110:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[actionpack (7.0.5) lib/action_dispatch/middleware/host_authorization.rb:137:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[railties (7.0.5) lib/rails/engine.rb:530:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[puma (6.3.0) lib/puma/configuration.rb:270:in `call' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[puma (6.3.0) lib/puma/request.rb:100:in `block in handle_request' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[puma (6.3.0) lib/puma/thread_pool.rb:344:in `with_force_shutdown' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[puma (6.3.0) lib/puma/request.rb:99:in `handle_request' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[puma (6.3.0) lib/puma/server.rb:443:in `process_client' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
[puma (6.3.0) lib/puma/server.rb:245:in `block in run' ](http://127.0.0.1:3001/dev/components/zest/checkbox_component/default#)
puma (6.3.0) lib/puma/thread_pool.rb:151:in `block in spawn_thread'

System configuration

Rails version: 7.0.5

Ruby version: 3.2.2

Gem version: 3.2.0

About this issue

  • Original URL
  • State: closed
  • Created 3 years ago
  • Comments: 15 (4 by maintainers)

Most upvoted comments

Hey @reeganviljoen, @joelhawksley is away until November, but I’m happy to help with this issue. I would definitely welcome a pull request, who’d like to take it on?

The compiler identifies sidecar templates, i.e. templates that live in a directory with the same name as the component. For each sidecar template, the compiler calls the #compile_template method, which passes the contents of the template to the template handler. The handler returns a chunk of Ruby code which the compiler subsequently wraps in def call and class_evals on the component class. When #call is invoked, it renders the template to the current output buffer using a series of #append= and #safe_append= calls.

I think @fredboyle identified the right place to introduce a config option and filter out templates that shouldn’t be compiled, although ActionView::Template.template_handler_extensions does not include css or js. You’d have to first strip off the template handler extension (i.e. .erb) and then use File.extname to determine if the file should be ignored or not.

Perhaps ViewComponent should by default only seek out a .html or .html.* file as the template or templates, but also allow a user override via config to include others or alternatives.

That’s the approach I’d take.