phlex-rails 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9833f000bf407634ea999f7b955fc28d07eac72c08bec5a5b24b3d130c316f7c
-  data.tar.gz: 63a7fbadbb139a20b88bb29357ce0e7de92b7fdb646e6bb5725297f9d1a4da6c
+  metadata.gz: 33adc1537a92b2170cc8040445ee7a8653bb2e47a586f0200d6e36ca20c3f128
+  data.tar.gz: 941ba8c6cd5e2282e0b06d561eaaa9821d43f79876d106f09f7f471df1573f5a
 SHA512:
-  metadata.gz: fd2f0e2c6617bbc1e8295797e3423cfa9ece08146615285a4a34d8151880eab8486c3fef8e7e95d5e00ff7cf59578a2bf10bed3b2a207a2e934d452c8afbdf82
-  data.tar.gz: 216394696ba7284cdb784b15396d320a5cbfe87c95de53eadc0d489172fd20f14a89f24c8973f892973d806370cc5510ea7de4cb314ec480d7e696b2d472d42e
+  metadata.gz: 2ff027bf6d32ec61019afcc1d6570f31fff6f03095cf03a28e9e75db60068287b8341dcab4bff69f93b085ee6f13378faa554e983b742780cec0a8c3be75386b
+  data.tar.gz: adc5f5b72b7119cd996a6d38e8dc3f3de0e08b5926d33aeb57aafa3a5d874294ac468a5f2dfa4071a1cc05236619871aac278a6cafbafcfc56689f9f87bf9d45

data/lib/generators/phlex/install/templates/base_view.rb.erb

@@ -6,4 +6,7 @@ class Views::Base < Components::Base
   # By default, it inherits from `Components::Base`, but you
   # can change that to `Phlex::HTML` if you want to keep views and
   # components independent.
+
+  # More caching options at https://www.phlex.fun/components/caching
+  def cache_store = Rails.cache
 end

data/lib/phlex/rails/buffered.rb

@@ -1,10 +1,6 @@
 # frozen_string_literal: true
 
 module Phlex::Rails
-	def Buffered(type)
-		-> (value) { Phlex::Rails::Buffered === value && type === value.unwrap }
-	end
-
 	class Buffered < BasicObject
 		def initialize(object, component:)
 			@object = object

data/lib/phlex/rails/builder.rb

@@ -7,6 +7,16 @@ class Phlex::Rails::Builder < BasicObject
 	end
 
 	define_method :send, ::Kernel.instance_method(:send)
+	define_method :class, ::Kernel.instance_method(:class)
+	define_method :is_a?, ::Kernel.instance_method(:is_a?)
+
+	def inspect
+		"Phlex::Rails::Builder(#{@object.inspect})"
+	end
+
+	def unwrap
+		@object
+	end
 
 	def respond_to_missing?(method_name, include_private = false)
 		@object.respond_to?(method_name, include_private)

data/lib/phlex/rails/helper_macros.rb

@@ -2,7 +2,7 @@
 
 module Phlex::Rails::HelperMacros
 	# Register a Rails helper that returns safe HTML to be pushed to the output buffer.
-	def register_output_helper(method_name)
+	def register_output_helper(method_name, mark_safe: false)
 		class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
 			# frozen_string_literal: true
 
@@ -13,7 +13,7 @@ module Phlex::Rails::HelperMacros
 					view_context.#{method_name}(*args, **kwargs)
 				end
 
-				raw(output)
+				raw(#{mark_safe ? 'safe(output)' : 'output'})
 			end
 		RUBY
 	end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::JavaScriptImportmapModulePreloadTags
+	extend Phlex::Rails::HelperMacros
+
+	# [Docs](https://www.rubydoc.info/gems/importmap-rails/Importmap%2FImportmapTagsHelper:javascript_importmap_module_preload_tags)
+	register_output_helper def javascript_importmap_module_preload_tags(...) = nil
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::JavaScriptInlineImportmapTag
+	extend Phlex::Rails::HelperMacros
+
+	# [Docs](https://www.rubydoc.info/gems/importmap-rails/Importmap%2FImportmapTagsHelper:javascript_inline_importmap_tag)
+	register_output_helper def javascript_inline_importmap_tag(...) = nil
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::PictureTag
+	extend Phlex::Rails::HelperMacros
+
+	# [Rails Docs](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-picture_tag)
+	register_output_helper def picture_tag(...) = nil
+end

data/lib/phlex/rails/layout.rb

@@ -10,8 +10,10 @@ module Phlex::Rails
 		include Helpers::ActionCableMetaTag
 		include Helpers::AutoDiscoveryLinkTag
 		include Helpers::JavaScriptIncludeTag
+		include Helpers::JavaScriptImportmapModulePreloadTags
 		include Helpers::JavaScriptImportmapTags
 		include Helpers::JavaScriptImportModuleTag
+		include Helpers::JavaScriptInlineImportmapTag
 		include Helpers::TurboRefreshMethodTag
 		include Helpers::TurboRefreshScrollTag
 		include Helpers::TurboRefreshesWith

data/lib/phlex/rails/sgml.rb

@@ -21,7 +21,10 @@ module Phlex::Rails::SGML
 			# otherwise re-raise the original error.
 			if module_name
 				raise NoMethodError.new(<<~MESSAGE)
-					Try including `Phlex::Rails::Helpers::#{module_name}` in #{self.class.name}.
+					Try including `Phlex::Rails::Helpers::#{module_name}` in #{self.class.name}, like so:
+					```ruby
+					include Phlex::Rails::Helpers::#{module_name}
+					```
 				MESSAGE
 			else
 				raise e

data/lib/phlex/rails/types.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Rails
+		module Types
+			def Buffered(type)
+				-> (value) { Phlex::Rails::Buffered === value && type === value.unwrap }
+			end
+
+			def Builder(type)
+				-> (value) { Phlex::Rails::Builder === value && type === value.unwrap }
+			end
+		end
+	end
+end

data/lib/phlex/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Phlex
 	module Rails
-		VERSION = "2.3.1"
+		VERSION = "2.4.0"
 	end
 end

data/lib/phlex/rails.rb

@@ -22,8 +22,10 @@ module Phlex
 				"font_url" => "FontURL",
 				"image_url" => "ImageURL",
 				"javascript_import_module_tag" => "JavaScriptImportModuleTag",
+				"javascript_importmap_module_preload_tags" => "JavaScriptImportmapModulePreloadTags",
 				"javascript_importmap_tags" => "JavaScriptImportmapTags",
 				"javascript_include_tag" => "JavaScriptIncludeTag",
+				"javascript_inline_importmap_tag" => "JavaScriptInlineImportmapTag",
 				"javascript_path" => "JavaScriptPath",
 				"javascript_tag" => "JavaScriptTag",
 				"javascript_url" => "JavaScriptURL",
@@ -56,6 +58,8 @@ module Phlex
 			loader.collapse("#{__dir__}/phlex/errors")
 			loader.setup
 		end
+
+		extend Phlex::Rails::Types
 	end
 
 	CSV.prepend(Phlex::Rails::CSV)

data/lib/ruby_lsp/phlex_rails/addon.rb

@@ -37,6 +37,8 @@ module RubyLsp
 							RubyIndexer::Entry::ForwardingParameter.new,
 						]),
 					], visibility: :public)
+				else
+					# no-op
 				end
 			end
 		end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlex-rails
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Joel Drapper
 - Will Cosgrove
 bindir: bin
 cert_chain: []
-date: 2025-06-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -163,8 +163,10 @@ files:
 - lib/phlex/rails/helpers/image_tag.rb
 - lib/phlex/rails/helpers/image_url.rb
 - lib/phlex/rails/helpers/javascript_import_module_tag.rb
+- lib/phlex/rails/helpers/javascript_importmap_module_preload_tags.rb
 - lib/phlex/rails/helpers/javascript_importmap_tags.rb
 - lib/phlex/rails/helpers/javascript_include_tag.rb
+- lib/phlex/rails/helpers/javascript_inline_importmap_tag.rb
 - lib/phlex/rails/helpers/javascript_path.rb
 - lib/phlex/rails/helpers/javascript_tag.rb
 - lib/phlex/rails/helpers/javascript_url.rb
@@ -205,6 +207,7 @@ files:
 - lib/phlex/rails/helpers/phone_field.rb
 - lib/phlex/rails/helpers/phone_field_tag.rb
 - lib/phlex/rails/helpers/phone_to.rb
+- lib/phlex/rails/helpers/picture_tag.rb
 - lib/phlex/rails/helpers/pluralize.rb
 - lib/phlex/rails/helpers/preload_link_tag.rb
 - lib/phlex/rails/helpers/provide.rb
@@ -291,7 +294,7 @@ files:
 - lib/phlex/rails/partial.rb
 - lib/phlex/rails/sgml.rb
 - lib/phlex/rails/sgml/state.rb
-- lib/phlex/rails/streaming.rb
+- lib/phlex/rails/types.rb
 - lib/phlex/rails/version.rb
 - lib/ruby_lsp/phlex_rails/addon.rb
 homepage: https://www.phlex.fun
@@ -317,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A Phlex adapter for Rails
 test_files: []

data/lib/phlex/rails/streaming.rb

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-module Phlex::Rails::Streaming
-	include ActionController::Live
-
-	private def stream(view, last_modified: Time.now.httpdate, filename: nil)
-		__phlex_set_stream_headers__(last_modified:)
-
-		case view
-		when Phlex::HTML
-			__phlex_stream_html__(view)
-		when Phlex::CSV
-			__phlex_stream_csv__(view, filename:)
-		else
-			raise Phlex::ArgumentError
-		end
-	end
-
-	private def __phlex_set_stream_headers__(last_modified:)
-		headers.delete("Content-Length")
-
-		headers["X-Accel-Buffering"] = "no"
-		headers["Cache-Control"] = "no-transform"
-		headers["Last-Modified"] = last_modified
-	end
-
-	private def __phlex_stream_csv__(view, filename:)
-		headers["Content-Type"] = "text/csv; charset=utf-8"
-		headers["Content-Disposition"] = "attachment; filename=\"#{filename || view.filename}\""
-
-		self.response_body = Enumerator.new do |buffer|
-			view.call(buffer, context: { rails_view_context: view_context })
-		end
-	end
-
-	private def __phlex_stream_html__(view)
-		headers["Content-Type"] = "text/html; charset=utf-8"
-
-		# Ensure we have a session id.
-		# See https://github.com/rails/rails/issues/51424
-		if session.id.nil?
-			session[:phlex_init_session] = 1
-			session.delete(:phlex_init_session)
-		end
-
-		self.response_body = Enumerator.new do |buffer|
-			view.call(buffer, context: { rails_view_context: view_context })
-		rescue => e
-			raise(e) if Rails.env.test?
-
-			debug_middleware = ActionDispatch::DebugExceptions.new(
-				proc { |_env| raise(e) },
-				response_format: :html,
-			)
-
-			_debug_status, _debug_headers, debug_body = debug_middleware.call(request.env)
-
-			if Rails.env.development?
-				js = <<~JAVASCRIPT
-					document.documentElement.innerHTML = "#{view_context.j(debug_body.join)}";
-
-					// Re-evaluate all script tags
-					document.querySelectorAll("script").forEach((script) => {
-						const newScript = document.createElement("script");
-						newScript.text = script.text;
-						newScript.nonce = "#{view_context.content_security_policy_nonce}";
-						script.replaceWith(newScript);
-					});
-
-					// Re-evaluate all style tags
-					document.querySelectorAll("style").forEach((style) => {
-						const newStyle = document.createElement("style");
-						newStyle.textContent = style.textContent;
-						newStyle.nonce = "#{view_context.content_security_policy_nonce}";
-						style.replaceWith(newStyle);
-					});
-
-					// Map onclick events to event listeners
-					document.querySelectorAll("[onclick]").forEach((element) => {
-						const action = element.getAttribute("onclick");
-						const newScript = document.createElement("script")
-
-						element.dataset.onclick = action;
-						element.removeAttribute("onclick");
-
-						newScript.text = `
-							(function() {
-								const action = () => { ${action} };
-								document.addEventListener("click", (event) => {
-									const element = event.target;
-
-									if (element.dataset.onclick === "${action}") {
-										action.bind(element)();
-									};
-								});
-							})();
-						`;
-
-						newScript.nonce = "#{view_context.content_security_policy_nonce}";
-						document.body.appendChild(newScript);
-					});
-				JAVASCRIPT
-			else
-				js = <<~JAVASCRIPT
-					window.location = "/500.html";
-				JAVASCRIPT
-			end
-
-			buffer << %(-->"'>)
-			buffer << view_context.javascript_tag(js, nonce: true)
-		end
-	end
-end