Include InlineTemplate by default in Base (#1779)

* Include InlineTemplate by default in Base * handle uninitialized ivar * do not worry about coverage of codestats rake task * Update docs/guide/templates.md
ViewComponent · Jun 23, 2023 · 364dcbe · 364dcbe
1 parent ca8e25f
commit 364dcbe
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 15 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -10,6 +10,10 @@ nav_order: 5
 
 ## main
 
+* Include InlineTemplate by default in Base. **Note:** It's no longer necessary to include `ViewComponent::InlineTemplate` to use inline templates.
+
+    *Joel Hawksley*
+
 * Allow Setting host when using the `with_request_url` test helper.
 
      *Daniel Alfaro*

diff --git a/docs/guide/templates.md b/docs/guide/templates.md
@@ -87,12 +87,10 @@ _**Note**: `call_*` methods must be public._
 Since 3.0.0
 {: .label }
 
-To define a template inside a component, include the experimental `ViewComponent::InlineTemplate` module and call the `.TEMPLATE_HANDLER_template` macro:
+To define a template inside a component, call the `.TEMPLATE_HANDLER_template` macro:
 
 ```ruby
 class InlineErbComponent < ViewComponent::Base
-  include ViewComponent::InlineTemplate
-
   attr_reader :name
 
   erb_template <<~ERB

diff --git a/lib/view_component/base.rb b/lib/view_component/base.rb
@@ -7,6 +7,7 @@
 require "view_component/compiler"
 require "view_component/config"
 require "view_component/errors"
+require "view_component/inline_template"
 require "view_component/preview"
 require "view_component/slotable"
 require "view_component/translatable"
@@ -29,6 +30,7 @@ def config
       attr_writer :config
     end
 
+    include ViewComponent::InlineTemplate
     include ViewComponent::Slotable
     include ViewComponent::Translatable
     include ViewComponent::WithContentHelper

diff --git a/lib/view_component/inline_template.rb b/lib/view_component/inline_template.rb
@@ -39,7 +39,7 @@ def respond_to_missing?(method, include_all = false)
       end
 
       def inline_template
-        @__vc_inline_template
+        @__vc_inline_template if defined?(@__vc_inline_template)
       end
 
       def inline_template_language

diff --git a/lib/view_component/rails/tasks/view_component.rake b/lib/view_component/rails/tasks/view_component.rake
@@ -4,8 +4,10 @@ task stats: "view_component:statsetup"
 
 namespace :view_component do
   task :statsetup do
+    # :nocov:
     require "rails/code_statistics"
 
     ::STATS_DIRECTORIES << ["ViewComponents", ViewComponent::Base.view_component_path]
+    # :nocov:
   end
 end
diff --git a/test/sandbox/test/inline_template_test.rb b/test/sandbox/test/inline_template_test.rb
@@ -4,8 +4,6 @@
 
 class InlineErbTest < ViewComponent::TestCase
   class InlineErbComponent < ViewComponent::Base
-    include ViewComponent::InlineTemplate
-
     attr_reader :name
 
     erb_template <<~ERB
@@ -18,8 +16,6 @@ def initialize(name)
   end
 
   class InlineRaiseErbComponent < ViewComponent::Base
-    include ViewComponent::InlineTemplate
-
     attr_reader :name
 
     erb_template <<~ERB
@@ -38,8 +34,6 @@ class InlineErbSubclassComponent < InlineErbComponent
   end
 
   class InlineSlimComponent < ViewComponent::Base
-    include ViewComponent::InlineTemplate
-
     attr_reader :name
 
     slim_template <<~SLIM
@@ -58,8 +52,6 @@ class InheritedInlineSlimComponent < InlineSlimComponent
   end
 
   class SlotsInlineComponent < ViewComponent::Base
-    include ViewComponent::InlineTemplate
-
     renders_one :greeting, InlineErbComponent
 
     erb_template <<~ERB
@@ -73,8 +65,6 @@ class ParentBaseComponent < ViewComponent::Base
   end
 
   class InlineErbChildComponent < ParentBaseComponent
-    include ViewComponent::InlineTemplate
-
     attr_reader :name
 
     erb_template <<~ERB
@@ -103,7 +93,7 @@ def initialize(name)
       render_inline(InlineRaiseErbComponent.new("Fox Mulder"))
     end
 
-    assert_match %r{test/sandbox/test/inline_template_test.rb:26}, error.backtrace[0]
+    assert_match %r{test/sandbox/test/inline_template_test.rb:22}, error.backtrace[0]
   end
 
   test "renders inline slim templates" do