phlex-rails 2.0.0.rc2 → 2.0.0

data/lib/phlex/rails/helpers/url_to_image.rb

@@ -3,5 +3,6 @@
 module Phlex::Rails::Helpers::URLToImage
 	extend Phlex::Rails::HelperMacros
 
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-url_to_image)
 	register_value_helper def url_to_image(...) = nil
 end

data/lib/phlex/rails/helpers/url_to_javascript.rb

@@ -3,5 +3,6 @@
 module Phlex::Rails::Helpers::URLToJavascript
 	extend Phlex::Rails::HelperMacros
 
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-url_to_javascript)
 	register_value_helper def url_to_javascript(...) = nil
 end

data/lib/phlex/rails/helpers/url_to_stylesheet.rb

@@ -3,5 +3,6 @@
 module Phlex::Rails::Helpers::URLToStylesheet
 	extend Phlex::Rails::HelperMacros
 
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-url_to_stylesheet)
 	register_value_helper def url_to_stylesheet(...) = nil
 end

data/lib/phlex/rails/helpers/url_to_video.rb

@@ -3,5 +3,6 @@
 module Phlex::Rails::Helpers::URLToVideo
 	extend Phlex::Rails::HelperMacros
 
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-url_to_video)
 	register_value_helper def url_to_video(...) = nil
 end

data/lib/phlex/rails/helpers/utf8_enforcer_tag.rb

@@ -3,5 +3,6 @@
 module Phlex::Rails::Helpers::UTF8EnforcerTag
 	extend Phlex::Rails::HelperMacros
 
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-utf8_enforcer_tag)
 	register_output_helper def utf8_enforcer_tag(...) = nil
 end

data/lib/phlex/rails/helpers/video_path.rb

@@ -3,5 +3,6 @@
 module Phlex::Rails::Helpers::VideoPath
 	extend Phlex::Rails::HelperMacros
 
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-video_path)
 	register_value_helper def video_path(...) = nil
 end

data/lib/phlex/rails/helpers/video_tag.rb

@@ -3,5 +3,6 @@
 module Phlex::Rails::Helpers::VideoTag
 	extend Phlex::Rails::HelperMacros
 
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-video_tag)
 	register_output_helper def video_tag(...) = nil
 end

data/lib/phlex/rails/helpers/video_url.rb

@@ -3,5 +3,6 @@
 module Phlex::Rails::Helpers::VideoURL
 	extend Phlex::Rails::HelperMacros
 
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-video_url)
 	register_value_helper def video_url(...) = nil
 end

data/lib/phlex/rails/helpers/week_field.rb

@@ -3,5 +3,6 @@
 module Phlex::Rails::Helpers::WeekField
 	extend Phlex::Rails::HelperMacros
 
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-week_field)
 	register_output_helper def week_field(...) = nil
 end

data/lib/phlex/rails/helpers/week_field_tag.rb

@@ -3,5 +3,6 @@
 module Phlex::Rails::Helpers::WeekFieldTag
 	extend Phlex::Rails::HelperMacros
 
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-week_field_tag)
 	register_output_helper def week_field_tag(...) = nil
 end

data/lib/phlex/rails/helpers/weekday_options_for_select.rb

@@ -3,5 +3,6 @@
 module Phlex::Rails::Helpers::WeekdayOptionsForSelect
 	extend Phlex::Rails::HelperMacros
 
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-weekday_options_for_select)
 	register_output_helper def weekday_options_for_select(...) = nil
 end

data/lib/phlex/rails/helpers/weekday_select.rb

@@ -3,5 +3,6 @@
 module Phlex::Rails::Helpers::WeekdaySelect
 	extend Phlex::Rails::HelperMacros
 
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-weekday_select)
 	register_output_helper def weekday_select(...) = nil
 end

data/lib/phlex/rails/helpers/word_wrap.rb

@@ -3,5 +3,6 @@
 module Phlex::Rails::Helpers::WordWrap
 	extend Phlex::Rails::HelperMacros
 
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-word_wrap)
 	register_value_helper def word_wrap(...) = nil
 end

data/lib/phlex/rails/helpers.rb

@@ -63,6 +63,7 @@ module Phlex::Rails::Helpers
 	autoload :Flash, "phlex/rails/helpers/flash"
 	autoload :FontPath, "phlex/rails/helpers/font_path"
 	autoload :FontURL, "phlex/rails/helpers/font_url"
+	autoload :FormAuthenticityToken, "phlex/rails/helpers/form_authenticity_token"
 	autoload :FormFor, "phlex/rails/helpers/form_for"
 	autoload :FormTag, "phlex/rails/helpers/form_tag"
 	autoload :FormWith, "phlex/rails/helpers/form_with"

data/lib/phlex/rails/html.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 module Phlex::Rails::HTML
-	module Format
-		def format
-			:html
-		end
+	def self.included(base)
+		base.include Phlex::Rails::SGML
+		super
+	end
+
+	def format
+		:html
 	end
 end

data/lib/phlex/rails/layout.rb

@@ -16,7 +16,6 @@ module Phlex::Rails
 		include Helpers::TurboRefreshScrollTag
 		include Helpers::TurboRefreshesWith
 
-		# @api private
 		module Interface
 			def render(view_context, _locals, &)
 				new.render(view_context, &)
@@ -37,19 +36,20 @@ module Phlex::Rails
 			end
 		end
 
-		def self.included(klass)
-			unless klass < Phlex::HTML
+		def self.included(base)
+			unless base < Phlex::HTML
 				raise Phlex::ArgumentError.new("👋 #{name} should only be included into Phlex::HTML classes.")
 			end
 
-			klass.extend(Interface)
+			base.extend(Interface)
+			super
 		end
 
 		def render(view_context = nil, *args, **kwargs, &block)
 			if @_state
 				super
 			else
-				call(view_context:) do |yielded|
+				call(context: { rails_view_context: view_context }) do |yielded|
 					case yielded
 					when Symbol
 						output = view_context.view_flow.get(yielded)

data/lib/phlex/rails/sgml.rb

@@ -1,92 +1,133 @@
 # frozen_string_literal: true
 
-module Phlex
-	module Rails
-		module SGML
-			module ClassMethods
-				def render_in(...)
-					new.render_in(...)
-				end
-			end
+module Phlex::Rails::SGML
+	def self.included(base)
+		base.extend ClassMethods
+		base.extend Phlex::Rails::HelperMacros
+		super
+	end
 
-			module Overrides
-				class HelpersCalledBeforeRenderError < StandardError; end
+	module ClassMethods
+		def render_in(...)
+			new.render_in(...)
+		end
+	end
 
-				def partial(*, **, &block)
-					if block
-						Phlex::Rails::Partial.new(*, **) { capture(&block) }
-					else
-						Phlex::Rails::Partial.new(*, **)
-					end
-				end
+	def method_missing(name, *args, **kwargs, &block)
+		return super unless view_context.respond_to?(name)
 
-				def helpers
-					unless @_state && (view_context = @_state.view_context)
-						raise HelpersCalledBeforeRenderError.new("Do not use rails helpers until after the view has been rendered.") unless view_context
-					end
+		const_name = name.to_s.gsub("?", "")
+		module_name = Phlex::Rails::Helpers.constants.find { |mod| mod.to_s.underscore.gsub("domid", "dom_id") == const_name }
+		return super unless module_name
 
-					if defined?(ViewComponent::Base) && ViewComponent::Base === view_context
-						view_context.helpers
-					else
-						view_context
-					end
-				end
+		raise NoMethodError.new("Try including `Phlex::Rails::Helpers::#{module_name}` in #{self.class.name}.")
+	end
 
-				def render(*args, **kwargs, &block)
-					renderable = args[0]
-
-					case renderable
-					when Phlex::SGML, Proc, Method, String
-						return super
-					when Class
-						return super if renderable < Phlex::SGML
-					when Enumerable
-						return super unless ActiveRecord::Relation === renderable
-					when nil
-						return super if kwargs.length == 0
-					end
+	def partial(*, **, &block)
+		if block
+			Phlex::Rails::Partial.new(*, **) { capture(&block) }
+		else
+			Phlex::Rails::Partial.new(*, **)
+		end
+	end
 
-					return super if args.length == 0 && kwargs.length == 0
+	def helpers
+		warn <<~MESSAGE
+			The `helpers` method is deprecated and will be removed in the next
+			minor version of phlex-rails.
 
-					output = if block
-						@_state.view_context.render(*args, **kwargs) do |*yielded_args|
-							if yielded_args.length == 1 && defined?(ViewComponent::Base) && ViewComponent::Base === yielded_args[0]
-								capture(Phlex::Rails::Buffered.new(yielded_args[0], view: self), &block)
-							else
-								capture(*yielded_args, &block)
-							end
-						end
-					else
-						@_state.view_context.render(*args, **kwargs)
-					end
+			If you absolutely need to access the underlying Rails view context,
+			you can do that via the `view_context` method, though this is
+			not recommended.
 
-					raw(output)
-				end
+			It is much safer to use one of the built-in helper adapters or to
+			register your own adapter via `register_output_helper` or
+			`register_value_helper`.
 
-				def render_in(view_context, &erb)
-					if erb
-						call(view_context:) { |*args|
-							if args.length == 1 && Phlex::SGML === args[0] && !erb.source_location&.[](0)&.end_with?(".rb")
-								unbuffered = Phlex::Rails::Unbuffered.new(args[0])
-								raw(helpers.capture(unbuffered, &erb))
-							else
-								raw(helpers.capture(*args, &erb))
-							end
-						}.html_safe
+			See https://beta.phlex.fun/rails/helpers.html
+		MESSAGE
+
+		view_context
+	end
+
+	def view_context
+		context[:rails_view_context] || (
+			raise Phlex::Rails::HelpersCalledBeforeRenderError.new(
+				"Do not use rails helpers until after the view has been rendered."
+			)
+		)
+	end
+
+	# If we’re rendered from view_component, we need to capture on the view_component context.
+	def capture_context
+		context[:view_component_context] || view_context
+	end
+
+	def render(renderable = nil, &block)
+		case renderable
+		when Phlex::SGML, Proc, Method, String
+			return super
+		when Class
+			return super if renderable < Phlex::SGML
+		when Enumerable
+			return super unless ActiveRecord::Relation === renderable
+		when nil
+			return super
+		end
+
+		if renderable.respond_to?(:render_in) || renderable.respond_to?(:to_partial_path)
+			output = if block
+				view_context.render(renderable) do |*yielded_args|
+					if yielded_args.length == 1 && defined?(ViewComponent::Base) && ViewComponent::Base === yielded_args[0]
+						capture(Phlex::Rails::Buffered.new(yielded_args[0], component: self), &block)
 					else
-						call(view_context:).html_safe
+						capture(*yielded_args, &block)
 					end
 				end
+			else
+				view_context.render(renderable)
+			end
 
-				def capture(...)
-					super&.html_safe
-				end
+			raw(output)
+		else
+			super
+		end
+	end
+
+	def render_in(view_context, &erb)
+		case view_context
+		when defined?(ViewComponent::Base) && ViewComponent::Base
+			context = {
+				rails_view_context: view_context.helpers,
+				view_component_context: view_context,
+			}
+		else
+			context = { rails_view_context: view_context }
+		end
 
-				# Trick ViewComponent into thinking we're a ViewComponent to fix rendering output
-				# @api private
-				def set_original_view_context(view_context)
+		if erb
+			call(context:) { |*args|
+				if args.length == 1 && Phlex::SGML === args[0] && !erb.source_location&.[](0)&.end_with?(".rb")
+					unbuffered = Phlex::Rails::Unbuffered.new(args[0])
+					raw(view_context.capture(unbuffered, &erb))
+				else
+					raw(view_context.capture(*args, &erb))
 				end
-			end
+			}.html_safe
+		else
+			call(context:).html_safe
 		end
 	end
+
+	def set_original_view_context(view_context)
+		# no-op (see https://github.com/ViewComponent/view_component/issues/2207)
+	end
+
+	def capture(...)
+		super&.html_safe
+	end
+
+	def enable_cache_reloading?
+		Rails.env.development?
+	end
 end

data/lib/phlex/rails/streaming.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# @api private
 module Phlex::Rails::Streaming
 	include ActionController::Live
 
@@ -32,7 +31,7 @@ module Phlex::Rails::Streaming
 		headers["Content-Disposition"] = "attachment; filename=\"#{filename || view.filename}\""
 
 		self.response_body = Enumerator.new do |buffer|
-			view.call(buffer, view_context:)
+			view.call(buffer, context: { rails_view_context: view_context })
 		end
 	end
 
@@ -47,7 +46,7 @@ module Phlex::Rails::Streaming
 		end
 
 		self.response_body = Enumerator.new do |buffer|
-			view.call(buffer, view_context:)
+			view.call(buffer, context: { rails_view_context: view_context })
 		rescue => e
 			raise(e) if Rails.env.test?
 

data/lib/phlex/rails/svg.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::SVG
+	def self.included(base)
+		base.include Phlex::Rails::SGML
+		super
+	end
+
+	def format
+		:svg
+	end
+end

data/lib/phlex/rails/unbuffered.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# @api private
 class Phlex::Rails::Unbuffered
 	def initialize(component)
 		@component = component
@@ -26,7 +25,7 @@ class Phlex::Rails::Unbuffered
 				if erb
 					component.public_send(method_name, *, **) do |*a, **kw|
 						component.raw(
-							component.helpers.capture(
+							component.capture_context.capture(
 								*a,
 								**kw,
 								&erb

data/lib/phlex/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Phlex
 	module Rails
-		VERSION = "2.0.0.rc2"
+		VERSION = "2.0.0"
 	end
 end

data/lib/phlex/rails.rb

@@ -4,33 +4,35 @@ require "phlex"
 
 module Phlex
 	module Rails
+		class HelpersCalledBeforeRenderError < StandardError; end
+
 		autoload :Buffered, "phlex/rails/buffered"
+		autoload :Unbuffered, "phlex/rails/unbuffered"
+
 		autoload :BufferedCheckboxBuilder, "phlex/rails/buffered_checkbox_builder"
 		autoload :BufferedFormBuilder, "phlex/rails/buffered_form_builder"
 		autoload :BufferedLabelBuilder, "phlex/rails/buffered_label_builder"
 		autoload :BufferedRadioButtonBuilder, "phlex/rails/buffered_radio_button_builder"
-		autoload :CSV, "phlex/rails/csv"
+
+		autoload :SGML, "phlex/rails/sgml"
 		autoload :HTML, "phlex/rails/html"
-		autoload :HelperFinder, "phlex/rails/helper_finder"
-		autoload :HelperMacros, "phlex/rails/helper_macros"
+		autoload :SVG, "phlex/rails/svg"
+
+		autoload :CSV, "phlex/rails/csv"
+
 		autoload :Helpers, "phlex/rails/helpers"
+		autoload :HelperMacros, "phlex/rails/helper_macros"
+
 		autoload :Layout, "phlex/rails/layout"
 		autoload :Partial, "phlex/rails/partial"
-		autoload :SGML, "phlex/rails/sgml"
 		autoload :Streaming, "phlex/rails/streaming"
-		autoload :Unbuffered, "phlex/rails/unbuffered"
 	end
 
-	CSV.extend Phlex::Rails::HelperMacros
-	CSV.prepend Phlex::Rails::CSV::Overrides
-
-	SGML.extend Phlex::Rails::SGML::ClassMethods
-	SGML.extend Phlex::Rails::HelperMacros
-	SGML.prepend Phlex::Rails::SGML::Overrides
-	SGML.include Phlex::Rails::HelperFinder
+	CSV.include(Phlex::Rails::CSV)
+	CSV.extend(Phlex::Rails::HelperMacros)
 
-	HTML.extend Phlex::Rails::HTML::Format
-	HTML.include Phlex::Rails::HTML::Format
+	HTML.include(Phlex::Rails::HTML)
+	SVG.include(Phlex::Rails::SVG)
 
 	ActiveSupport::SafeBuffer.include(Phlex::SGML::SafeObject)
 end

metadata

@@ -1,29 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: phlex-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc2
+  version: 2.0.0
 platform: ruby
 authors:
 - Joel Drapper
+- Will Cosgrove
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.rc2
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.rc2
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -44,7 +45,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
-description: A high-performance view framework optimised for fun.
+description: Object-oriented views in pure Ruby.
 email:
 - joel@drapper.me
 executables: []
@@ -72,7 +73,6 @@ files:
 - lib/phlex/rails/buffered_label_builder.rb
 - lib/phlex/rails/buffered_radio_button_builder.rb
 - lib/phlex/rails/csv.rb
-- lib/phlex/rails/helper_finder.rb
 - lib/phlex/rails/helper_macros.rb
 - lib/phlex/rails/helpers.rb
 - lib/phlex/rails/helpers/action_cable_meta_tag.rb
@@ -137,6 +137,7 @@ files:
 - lib/phlex/rails/helpers/flash.rb
 - lib/phlex/rails/helpers/font_path.rb
 - lib/phlex/rails/helpers/font_url.rb
+- lib/phlex/rails/helpers/form_authenticity_token.rb
 - lib/phlex/rails/helpers/form_for.rb
 - lib/phlex/rails/helpers/form_tag.rb
 - lib/phlex/rails/helpers/form_with.rb
@@ -278,7 +279,7 @@ files:
 - lib/phlex/rails/partial.rb
 - lib/phlex/rails/sgml.rb
 - lib/phlex/rails/streaming.rb
-- lib/phlex/rails/testing.rb
+- lib/phlex/rails/svg.rb
 - lib/phlex/rails/unbuffered.rb
 - lib/phlex/rails/version.rb
 homepage: https://www.phlex.fun
@@ -287,7 +288,7 @@ licenses:
 metadata:
   homepage_uri: https://www.phlex.fun
   source_code_uri: https://github.com/phlex-ruby/phlex-rails
-  changelog_uri: https://github.com/phlex-ruby/phlex-rails/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/phlex-ruby/phlex-rails/releases
   funding_uri: https://github.com/sponsors/joeldrapper
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -298,7 +299,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.3.1
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/phlex/rails/helper_finder.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Phlex::Rails::HelperFinder
-	def method_missing(name, *args, **kwargs, &block)
-		return super unless helpers.respond_to?(name)
-
-		const_name = name.to_s.gsub("?", "")
-		module_name = Phlex::Rails::Helpers.constants.find { |mod| mod.to_s.underscore.gsub("domid", "dom_id") == const_name }
-		return super unless module_name
-
-		raise NoMethodError.new("Try including `Phlex::Rails::Helpers::#{module_name}` in #{self.class.name}.")
-	end
-end

data/lib/phlex/rails/testing.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "phlex/rails"
-require "phlex/testing"
-
-module Phlex::Testing::RailsContext
-	def view_context
-		controller.view_context
-	end
-
-	def controller
-		@controller ||= ActionView::TestCase::TestController.new
-	end
-end
-
-Phlex::Testing::SGML.prepend(
-	Phlex::Testing::RailsContext,
-)