Allow implicit locale in component file names (#2118)

* Add failing test case for localised erb templates * Simpler example * Remove locale from format when checking default * Add changelog entry * Add to contributor list * Update docs/CHANGELOG.md * move locale removal logic to compiler --------- Co-authored-by: Joel Hawksley <[email protected]> Co-authored-by: Joel Hawksley <[email protected]>
ViewComponent · Oct 15, 2024 · 21b94a7 · 21b94a7
1 parent 212d159
commit 21b94a7
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 1 deletion.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -10,6 +10,10 @@ nav_order: 5
 
 ## main
 
+* Fix bug where implicit locales in component filenames threw a `NameError`.
+
+    *Chloe Fons*
+
 * Register ViewComponent tests directory for `rails stats`.
 
     *Javier Aranda*

diff --git a/docs/index.md b/docs/index.md
@@ -228,6 +228,7 @@ ViewComponent is built by over a hundred members of the community, including:
 <img src="https://avatars.githubusercontent.com/allan-pires?s=64" alt="allan-pires" width="32" />
 <img src="https://avatars.githubusercontent.com/jasonkim?s=64" alt="jasonkim" width="32" />
 <img src="https://avatars.githubusercontent.com/tkowalewski" alt="tkowalewski" width="32" />
+<img src="https://avatars.githubusercontent.com/chloe-meister" alt="chloe-meister" width="32" />
 <img src="https://avatars.githubusercontent.com/zaratan" alt="zaratan" width="32" />
 
 ## Who uses ViewComponent?

diff --git a/lib/view_component/compiler.rb b/lib/view_component/compiler.rb
@@ -192,7 +192,7 @@ def gather_templates
               path: path,
               lineno: 0,
               extension: path.split(".").last,
-              this_format: this_format,
+              this_format: this_format.to_s.split(".").last&.to_sym, # strip locale from this_format, see #2113
               variant: variant
             )
 

diff --git a/test/sandbox/app/components/localised_component.fr.html.erb b/test/sandbox/app/components/localised_component.fr.html.erb
@@ -0,0 +1 @@
+<div>salut,monde!</div>
diff --git a/test/sandbox/app/components/localised_component.rb b/test/sandbox/app/components/localised_component.rb
@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class LocalisedComponent < ViewComponent::Base
+end
diff --git a/test/sandbox/test/rendering_test.rb b/test/sandbox/test/rendering_test.rb
@@ -1215,4 +1215,10 @@ def test_with_format
       assert_equal(rendered_json["hello"], "world")
     end
   end
+
+  def test_localised_component
+    render_inline(LocalisedComponent.new)
+
+    assert_selector("div", text: "salut,monde!")
+  end
 end