Rename template → view_template (#630)

This is a non-breaking rename that issues a warning whenever you define
`template`.

fixtures/layout.rb

@@ -6,7 +6,7 @@ def initialize(title: "Example")
 			@title = title
 		end
 
-		def template(&block)
+		def view_template(&block)
 			html do
 				head do
 					title { @title }

fixtures/page.rb

@@ -2,7 +2,7 @@
 
 module Example
 	class Page < Phlex::HTML
-		def template
+		def view_template
 			render LayoutComponent.new do
 				h1 { "Hi" }
 

lib/phlex/deferred_render.rb

@@ -11,7 +11,7 @@
 # 			@tabs = []
 # 		end
 #
-# 		def template
+# 		def view_template
 # 			@tabs.each { |t| a { t.name } }
 # 			@tabs.each { |t| article(&t.content) }
 # 		end

lib/phlex/elements.rb

@@ -11,7 +11,7 @@
 # 	class MyComponent < Phlex::HTML
 # 		include MyCustomElements
 #
-# 		def template
+# 		def view_template
 # 			trix_editor
 # 		end
 # 	end

lib/phlex/sgml.rb

@@ -51,24 +51,34 @@ def element_method?(method_name)
 
 		# @abstract Override to define a template for your component.
 		# @example
-		# 	def template
+		# 	def view_template
 		# 		h1 { "👋 Hello World!" }
 		# 	end
 		# @example Your template may yield a content block.
-		# 	def template
+		# 	def view_template
 		# 		main {
 		# 			h1 { "Hello World" }
 		# 			yield
 		# 		}
 		# 	end
 		# @example Alternatively, you can delegate the content block to an element.
-		# 	def template(&block)
+		# 	def view_template(&block)
 		# 		article(class: "card", &block)
 		# 	end
 		def template
 			yield
 		end
 
+		def self.method_added(method_name)
+			if method_name == :template
+				Kernel.warn "Defining the `template` method on a Phlex component is deprecated and will be unsupported in Phlex 2.0. Please define `view_template` instead."
+			end
+		end
+
+		def view_template(&block)
+			template(&block)
+		end
+
 		# @api private
 		def await(task)
 			if defined?(Concurrent::IVar) && task.is_a?(Concurrent::IVar)
@@ -106,9 +116,9 @@ def __final_call__(buffer = +"", context: Phlex::Context.new, view_context: nil,
 				if block
 					if is_a?(DeferredRender)
 						__vanish__(self, &block)
-						template
+						view_template
 					else
-						template do |*args|
+						view_template do |*args|
 							if args.length > 0
 								yield_content_with_args(*args, &block)
 							else
@@ -117,7 +127,7 @@ def __final_call__(buffer = +"", context: Phlex::Context.new, view_context: nil,
 						end
 					end
 				else
-					template
+					view_template
 				end
 			end
 

test/phlex/callbacks.rb

@@ -9,7 +9,7 @@ def before_template
 				h1 { "Hello" }
 			end
 
-			def template
+			def view_template
 				h2 { "World" }
 			end
 

test/phlex/render_enumerable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Card < Phlex::HTML
-	def template(&block)
+	def view_template(&block)
 		article(&block)
 	end
 end
@@ -14,13 +14,13 @@ def initialize
 		]
 	end
 
-	def template
+	def view_template
 		render @cards
 	end
 end
 
 class WithBlock < WithoutBlock
-	def template
+	def view_template
 		render @cards do
 			h1 { "Hi" }
 		end

test/phlex/svg.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 class Example < Phlex::SVG
-	def template
+	def view_template
 		svg do
 			path(d: "123")
 		end
 	end
 end
 
 class ExampleFromHTML < Phlex::HTML
-	def template
+	def view_template
 		svg do |s|
 			s.path(d: "321")
 		end

test/phlex/testing/view_helper.rb

@@ -3,13 +3,13 @@
 require "phlex/testing/view_helper"
 
 class ExampleHTML < Phlex::HTML
-	def template
+	def view_template
 		h1 { "👋" }
 	end
 end
 
 class ExampleSVG < Phlex::SVG
-	def template
+	def view_template
 		svg do
 			path(d: "123")
 		end

test/phlex/unbuffered.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Example < Phlex::HTML
-	def template
+	def view_template
 		yield
 	end
 

test/phlex/view/around_template.rb

@@ -11,7 +11,7 @@ def around_template
 				h3 { "After" }
 			end
 
-			def template
+			def view_template
 				h2 { "Hello" }
 			end
 		end

test/phlex/view/call.rb

@@ -4,7 +4,7 @@
 	extend ViewHelper
 
 	view do
-		def template
+		def view_template
 			plain "Hi"
 		end
 	end
@@ -17,7 +17,7 @@ def template
 
 	with "`render?` method returning false when the view context is true" do
 		view do
-			def template
+			def view_template
 				plain "Hi"
 			end
 
@@ -29,7 +29,7 @@ def render?
 
 	with "a view that yields an object" do
 		view do
-			def template
+			def view_template
 				yield(1, 2)
 			end
 		end
@@ -47,7 +47,7 @@ def template
 
 	with "a view that yields nothing" do
 		view do
-			def template
+			def view_template
 				yield
 			end
 

test/phlex/view/capture.rb

@@ -7,7 +7,7 @@
 		view do
 			attr_accessor :captured
 
-			def template
+			def view_template
 				h1 { "Before" }
 				@captured = capture { "Hello" }
 				h1 { "After" }
@@ -24,7 +24,7 @@ def template
 		view do
 			attr_accessor :captured
 
-			def template
+			def view_template
 				h1 { "Before" }
 				@captured = capture do
 					h1 { "Hello" }
@@ -43,7 +43,7 @@ def template
 		view do
 			attr_accessor :captured
 
-			def template
+			def view_template
 				h1 { "Before" }
 				@captured = capture do
 					h1 { "Hello" }
@@ -63,7 +63,7 @@ def template
 	with "a call to flush inside a component rendered in the block" do
 		let(:component) do
 			Class.new(Phlex::HTML) do
-				def template
+				def view_template
 					h1 { "Hello" }
 					flush
 					h1 { "World" }
@@ -73,7 +73,7 @@ def template
 
 		let(:previewer) do
 			Class.new(Phlex::HTML) do
-				def template
+				def view_template
 					srcdoc = capture { yield } if block_given?
 
 					iframe srcdoc: srcdoc
@@ -82,7 +82,7 @@ def template
 		end
 
 		view do
-			def template
+			def view_template
 				h1 { "Before" }
 				render @_view_context.previewer do
 					render @_view_context.component

test/phlex/view/comment.rb

@@ -5,7 +5,7 @@
 
 	with "simple comment" do
 		view do
-			def template
+			def view_template
 				comment { "This is an HTML comment" }
 			end
 		end
@@ -17,7 +17,7 @@ def template
 
 	with "empty comment" do
 		view do
-			def template
+			def view_template
 				comment
 			end
 		end
@@ -29,7 +29,7 @@ def template
 
 	with "number comment" do
 		view do
-			def template
+			def view_template
 				comment { 1 }
 			end
 		end
@@ -41,7 +41,7 @@ def template
 
 	with "escaped comment" do
 		view do
-			def template
+			def view_template
 				comment { "<b>Important</b>" }
 			end
 		end

test/phlex/view/content.rb

@@ -5,7 +5,7 @@
 
 	with "content" do
 		view do
-			def template
+			def view_template
 				h1 { "Before" }
 				yield
 				h2 { "After" }

test/phlex/view/custom_elements.rb

@@ -8,7 +8,7 @@
 			register_element :trix_editor
 			register_element :trix_toolbar
 
-			def template
+			def view_template
 				div do
 					trix_toolbar
 					trix_editor { "Hello" }

test/phlex/view/doctype.rb

@@ -5,7 +5,7 @@
 
 	with "a doctype" do
 		view do
-			def template
+			def view_template
 				html do
 					head { doctype }
 				end

test/phlex/view/format_object.rb

@@ -3,7 +3,7 @@
 require "date"
 
 class Example < Phlex::HTML
-	def template
+	def view_template
 		h1 { Date.new(2022, 11, 28) }
 	end
 

test/phlex/view/legacy_template_method.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+describe Phlex::SGML do
+	it "warns when you define a template" do
+		expect(Kernel).to receive(:warn)
+
+		example = Class.new(Phlex::HTML) do
+			def template
+				h1 { "Hello, world!" }
+			end
+		end
+
+		expect(
+			example.new.call
+		).to be == "<h1>Hello, world!</h1>"
+	end
+end