phlex 1.3.3 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1159a0896a3d636c2a5c2a9a08f33e9763378aaba3cef5ab91a0f6988c3fc13d
-  data.tar.gz: '0288a77615f58f361e0d5cbebd87b937dfd4ec040eda9d1229247168db48bc71'
+  metadata.gz: '095f1f63ec98350892c0e8602d2cdee3540c27e47535738589139b0c1bad35b3'
+  data.tar.gz: 62a32d3d94a1bb2803d48df510c0ea01a2903e047cbe6a6da76d9ceceed7004c
 SHA512:
-  metadata.gz: 8d51860ec7cf43b2071baaa32636450e1f31684ff5bef5f87352f1f2ac31fc4edd5740f0441f8a3e26469e026583be4e0bf047447226327ba981569c83cc982d
-  data.tar.gz: 82738cc1998a31e41c9d7989b77d3e90c33135b4347c6b98d1999156ac696dd3d7739623578fb4569d17776e7e40fb751aafb0e01965ae5df9cbb78d2b41c198
+  metadata.gz: 427fefde9d6bbd5af1988825dccaa78b46fa5ed507abde64695bb19b0103a0c2968f1e578232bcf4e98a308809a92c8e05ce60a9380f151de6f6af5828a7791e
+  data.tar.gz: a26a4bd4916b368590a813cf4e29d687ed93b1a086a155b349207c8de145aee22c6e03cc17f957cc859d8f7e5e030ece34de3c14aedc59c2b3fb512b10f359a2

data/.rubocop.yml

@@ -5,27 +5,5 @@ inherit_from:
 AllCops:
   TargetRubyVersion: 2.7
 
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-Layout/CaseIndentation:
-  Enabled: false
-
-Style/StringConcatenation:
-  Enabled: false
-
-Style/CaseEquality:
-  Enabled: false
-
-Security/Eval:
-  Enabled: false
-
-Style/MethodCallWithoutArgsParentheses:
-  Enabled: false
-
-Style/MixinUsage:
-  Enabled: false
-
-Style/AccessModifierDeclarations:
-  Enabled: true
-  EnforcedStyle: inline
+Style/ExplicitBlockArgument:
+  Enabled: false

data/Gemfile

@@ -10,6 +10,7 @@ gem "sus"
 gem "zeitwerk"
 gem "benchmark-ips"
 gem "erb"
+gem "ruby-lsp"
 
 group :test do
 	gem "i18n"

data/README.md

@@ -43,3 +43,4 @@ Thanks [Logology](https://www.logology.co) for sponsoring our logo.
 - [hoshi](https://github.com/pete/hoshi)
 - [hyperstack](https://github.com/hyperstack-org/hyperstack)
 - [clearwater](https://github.com/clearwater-rb/clearwater)
+- [paggio](https://github.com/opal/paggio)

data/fixtures/view_helper.rb

@@ -13,4 +13,10 @@ module ViewHelper
 			Class.new(Phlex::HTML, &block)
 		end
 	end
+
+	def svg_view(&block)
+		let :view do
+			Class.new(Phlex::SVG, &block)
+		end
+	end
 end

data/lib/phlex/black_hole.rb

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
 
-module Phlex
-	module BlackHole
-		extend self
+module Phlex::BlackHole
+	extend self
 
-		def <<(anything)
-			self
-		end
+	def <<(anything)
+		self
+	end
 
-		def length
-			0
-		end
+	def length
+		0
 	end
 end

data/lib/phlex/callable.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-module Phlex
-	module Callable
-		def to_proc
-			method(:call).to_proc
-		end
+module Phlex::Callable
+	def to_proc
+		method(:call).to_proc
 	end
 end

data/lib/phlex/deferred_render.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-module Phlex
-	module DeferredRender
-		# This module doesn't do anything. Phlex::HTML#call checks for its inclusion in the ancestry instead.
-	end
+module Phlex::DeferredRender
+	# This module doesn't do anything. Phlex::HTML#call checks for its inclusion in the ancestry instead.
 end

data/lib/phlex/elements.rb

@@ -1,61 +1,63 @@
 # frozen_string_literal: true
 
 if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.0")
-	using Overrides::Symbol::Name
+	using Phlex::Overrides::Symbol::Name
 end
 
-module Phlex
-	module Elements
-		def register_element(element, tag: element.name.tr("_", "-"))
-			class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-        # frozen_string_literal: true
-
-        def #{element}(**attributes, &block)
-          if attributes.length > 0
-            if block_given?
-              @_target << "<#{tag}" << (Phlex::ATTRIBUTE_CACHE[attributes.hash] || __attributes__(**attributes)) << ">"
-              yield_content(&block)
-              @_target << "</#{tag}>"
-            else
-              @_target << "<#{tag}" << (Phlex::ATTRIBUTE_CACHE[attributes.hash] || __attributes__(**attributes)) << "></#{tag}>"
-            end
-          else
-            if block_given?
-              @_target << "<#{tag}>"
-              yield_content(&block)
-              @_target << "</#{tag}>"
-            else
-              @_target << "<#{tag}></#{tag}>"
-            end
-          end
-
-          nil
-        end
-
-				alias_method :_#{element}, :#{element}
-			RUBY
-
-			Phlex::HTML::STANDARD_ELEMENTS[element] = tag
-		end
-
-		def register_void_element(element, tag: element.name.tr("_", "-"))
-			class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-        # frozen_string_literal: true
-
-        def #{element}(**attributes)
-          if attributes.length > 0
-            @_target << "<#{tag}" << (Phlex::ATTRIBUTE_CACHE[attributes.hash] || __attributes__(**attributes)) << ">"
-          else
-            @_target << "<#{tag}>"
-          end
-
-          nil
-        end
-
-				alias_method :_#{element}, :#{element}
-			RUBY
-
-			Phlex::HTML::VOID_ELEMENTS[element] = tag
-		end
+module Phlex::Elements
+	def register_element(element, tag: element.name.tr("_", "-"))
+		class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+			# frozen_string_literal: true
+
+			def #{element}(**attributes, &block)
+				if attributes.length > 0
+					if block_given?
+						@_target << "<#{tag}" << (Phlex::ATTRIBUTE_CACHE[attributes.hash] || __attributes__(**attributes)) << ">"
+						yield_content(&block)
+						@_target << "</#{tag}>"
+					else
+						@_target << "<#{tag}" << (Phlex::ATTRIBUTE_CACHE[attributes.hash] || __attributes__(**attributes)) << "></#{tag}>"
+					end
+				else
+					if block_given?
+						@_target << "<#{tag}>"
+						yield_content(&block)
+						@_target << "</#{tag}>"
+					else
+						@_target << "<#{tag}></#{tag}>"
+					end
+				end
+
+				nil
+			end
+
+			alias_method :_#{element}, :#{element}
+		RUBY
+
+		self::REGISTERED_ELEMENTS[element] = tag
+
+		element
+	end
+
+	def register_void_element(element, tag: element.name.tr("_", "-"))
+		class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+			# frozen_string_literal: true
+
+			def #{element}(**attributes)
+				if attributes.length > 0
+					@_target << "<#{tag}" << (Phlex::ATTRIBUTE_CACHE[attributes.hash] || __attributes__(**attributes)) << ">"
+				else
+					@_target << "<#{tag}>"
+				end
+
+				nil
+			end
+
+			alias_method :_#{element}, :#{element}
+		RUBY
+
+		self::REGISTERED_ELEMENTS[element] = tag
+
+		element
 	end
 end

data/lib/phlex/helpers.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.0")
-	using Overrides::Symbol::Name
+	using Phlex::Overrides::Symbol::Name
 end
 
 module Phlex::Helpers
@@ -25,7 +25,10 @@ module Phlex::Helpers
 			end
 		end
 
-		tokens.join(" ")
+		tokens = tokens.select(&:itself).join(" ")
+		tokens.strip!
+		tokens.gsub!(/\s+/, " ")
+		tokens
 	end
 
 	private def __append_token__(tokens, token)

data/lib/phlex/html/standard_elements.rb

@@ -3,6 +3,8 @@
 module Phlex::HTML::StandardElements
 	extend Phlex::Elements
 
+	REGISTERED_ELEMENTS = Concurrent::Map.new
+
 	# @!method a(**attributes, &content)
 	# 	Outputs an <code>a</code> tag
 	# 	@return [nil]
@@ -189,13 +191,6 @@ module Phlex::HTML::StandardElements
 	# 	@see https://developer.mozilla.org/docs/Web/HTML/Element/form
 	register_element :form, tag: "form"
 
-	# @!method g(**attributes, &content)
-	# 	Outputs a <code>g</code> tag
-	# 	@return [nil]
-	# 	@see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/g
-	# 	@todo move this to SVG
-	register_element :g, tag: "g"
-
 	# @!method h1(**attributes, &content)
 	# 	Outputs an <code>h1</code> tag
 	# 	@return [nil]
@@ -377,13 +372,6 @@ module Phlex::HTML::StandardElements
 	# 	@see https://developer.mozilla.org/docs/Web/HTML/Element/p
 	register_element :p, tag: "p"
 
-	# @!method path(**attributes, &content)
-	# 	Outputs a <code>path</code> tag
-	# 	@return [nil]
-	# 	@see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/path
-	# 	@todo move this to SVG
-	register_element :path, tag: "path"
-
 	# @!method picture(**attributes, &content)
 	# 	Outputs a <code>picture</code> tag
 	# 	@return [nil]

data/lib/phlex/html/void_elements.rb

@@ -3,6 +3,8 @@
 module Phlex::HTML::VoidElements
 	extend Phlex::Elements
 
+	REGISTERED_ELEMENTS = Concurrent::Map.new
+
 	# @!method area(**attributes, &content)
 	# 	Outputs an <code>area</code> tag
 	# 	@return [nil]

data/lib/phlex/html.rb

@@ -1,47 +1,14 @@
 # frozen_string_literal: true
 
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.0")
-	using Overrides::Symbol::Name
-end
-
 module Phlex
-	class HTML
-		DOCTYPE = "<!DOCTYPE html>"
-
-		STANDARD_ELEMENTS = Concurrent::Map.new
-		VOID_ELEMENTS = Concurrent::Map.new
-
+	class HTML < SGML
+		# A list of HTML attributes that have the potential to execute unsafe JavaScript.
 		EVENT_ATTRIBUTES = %w[onabort onafterprint onbeforeprint onbeforeunload onblur oncanplay oncanplaythrough onchange onclick oncontextmenu oncopy oncuechange oncut ondblclick ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop ondurationchange onemptied onended onerror onfocus onhashchange oninput oninvalid onkeydown onkeypress onkeyup onload onloadeddata onloadedmetadata onloadstart onmessage onmousedown onmousemove onmouseout onmouseover onmouseup onmousewheel onoffline ononline onpagehide onpageshow onpaste onpause onplay onplaying onpopstate onprogress onratechange onreset onresize onscroll onsearch onseeked onseeking onselect onstalled onstorage onsubmit onsuspend ontimeupdate ontoggle onunload onvolumechange onwaiting onwheel].to_h { [_1, true] }.freeze
 
 		UNBUFFERED_MUTEX = Mutex.new
 
-		extend Elements
-
-		include Helpers
-		include VoidElements
-		include StandardElements
-
 		class << self
-			def call(...)
-				new(...).call
-			end
-			alias_method :render, :call
-
-			def new(*args, **kwargs, &block)
-				if block
-					object = super(*args, **kwargs, &nil)
-					object.instance_variable_set(:@_content_block, block)
-					object
-				else
-					super
-				end
-			end
-
-			def rendered_at_least_once!
-				alias_method :__attributes__, :__final_attributes__
-				alias_method :call, :__final_call__
-			end
-
+			# @api private
 			def __unbuffered_class__
 				UNBUFFERED_MUTEX.synchronize do
 					if defined? @unbuffered_class
@@ -53,268 +20,28 @@ module Phlex
 			end
 		end
 
-		def call(...)
-			__final_call__(...).tap do
-				self.class.rendered_at_least_once!
-			end
-		end
-
-		def __final_call__(buffer = +"", view_context: nil, parent: nil, &block)
-			@_target = buffer
-			@_view_context = view_context
-			@_parent = parent
-
-			block ||= @_content_block
-
-			return buffer unless render?
-
-			around_template do
-				if block
-					if DeferredRender === self
-						__vanish__(self, &block)
-						template
-					else
-						template do |*args|
-							if args.length > 0
-								yield_content_with_args(*args, &block)
-							else
-								yield_content(&block)
-							end
-						end
-					end
-				else
-					template
-				end
-			end
-
-			buffer
-		end
-
-		def render(renderable, &block)
-			case renderable
-			when Phlex::HTML
-				renderable.call(@_target, view_context: @_view_context, parent: self, &block)
-			when Class
-				if renderable < Phlex::HTML
-					renderable.new.call(@_target, view_context: @_view_context, parent: self, &block)
-				end
-			else
-				raise ArgumentError, "You can't render a #{renderable}."
-			end
+		extend Elements
+		include Helpers, VoidElements, StandardElements
 
+		# Output an HTML doctype.
+		def doctype
+			@_target << "<!DOCTYPE html>"
 			nil
 		end
 
-		def format
-			:html
-		end
-
-		def text(content)
-			@_target << ERB::Util.html_escape(
-				case content
-					when String then content
-					when Symbol then content.name
-					when Integer then content.to_s
-					else format_object(content) || content.to_s
+		def svg(...)
+			super do
+				render Phlex::SVG.new do |svg|
+					yield(svg)
 				end
-			)
-
-			nil
-		end
-
-		def whitespace
-			@_target << " "
-
-			if block_given?
-				yield
-				@_target << " "
 			end
-
-			nil
-		end
-
-		def comment(&block)
-			@_target << "<!-- "
-			yield_content(&block)
-			@_target << " -->"
-
-			nil
-		end
-
-		def doctype
-			@_target << DOCTYPE
-			nil
-		end
-
-		def unsafe_raw(content = nil)
-			return nil unless content
-
-			@_target << content
-		end
-
-		def capture(&block)
-			return unless block_given?
-
-			original_buffer = @_target
-			new_buffer = +""
-			@_target = new_buffer
-
-			yield_content(&block)
-
-			new_buffer
-		ensure
-			@_target = original_buffer
 		end
 
+		# @api private
 		def unbuffered
 			self.class.__unbuffered_class__.new(self)
 		end
 
-		# Like `capture` but the output is vanished into a BlackHole buffer.
-		# Becuase the BlackHole does nothing with the output, this should be faster.
-		private def __vanish__(*args)
-			return unless block_given?
-
-			original_buffer = @_target
-			@_target = BlackHole
-
-			yield(*args)
-			nil
-		ensure
-			@_target = original_buffer
-		end
-
-		# Default render predicate can be overridden to prevent rendering
-		private def render?
-			true
-		end
-
-		private def format_object(object)
-			case object
-			when Float
-				object.to_s
-			end
-		end
-
-		private def around_template
-			before_template
-			yield
-			after_template
-		end
-
-		private def before_template
-			nil
-		end
-
-		private def after_template
-			nil
-		end
-
-		private def yield_content
-			return unless block_given?
-
-			original_length = @_target.length
-			content = yield(self)
-			unchanged = (original_length == @_target.length)
-
-			if unchanged
-				case content
-				when String
-					@_target << ERB::Util.html_escape(content)
-				when Symbol
-					@_target << ERB::Util.html_escape(content.name)
-				when Integer
-					@_target << ERB::Util.html_escape(content.to_s)
-				else
-					if (formatted_object = format_object(content))
-						@_target << ERB::Util.html_escape(formatted_object)
-					end
-				end
-			end
-
-			nil
-		end
-
-		private def yield_content_with_args(*args)
-			return unless block_given?
-
-			original_length = @_target.length
-			content = yield(*args)
-			unchanged = (original_length == @_target.length)
-
-			if unchanged
-				case content
-				when String
-					@_target << ERB::Util.html_escape(content)
-				when Symbol
-					@_target << ERB::Util.html_escape(content.name)
-				when Integer, Float
-					@_target << ERB::Util.html_escape(content.to_s)
-				else
-					if (formatted_object = format_object(content))
-						@_target << ERB::Util.html_escape(formatted_object)
-					end
-				end
-			end
-
-			nil
-		end
-
-		private def __attributes__(**attributes)
-			__final_attributes__(**attributes).tap do |buffer|
-				Phlex::ATTRIBUTE_CACHE[attributes.hash] = buffer.freeze
-			end
-		end
-
-		private def __final_attributes__(**attributes)
-			buffer = +""
-			__build_attributes__(attributes, buffer: buffer)
-
-			buffer
-		end
-
-		private def __build_attributes__(attributes, buffer:)
-			attributes.each do |k, v|
-				next unless v
-
-				name = case k
-					when String then k
-					when Symbol then k.name.tr("_", "-")
-					else k.to_s
-				end
-
-				lower_name = name.downcase
-				next if lower_name == "href" && v.start_with?(/\s*javascript:/i)
-
-				# Detect unsafe attribute names. Attribute names are considered unsafe if they match an event attribute or include unsafe characters.
-				if HTML::EVENT_ATTRIBUTES[lower_name] || name.match?(/[<>&"']/)
-					raise ArgumentError, "Unsafe attribute name detected: #{k}."
-				end
-
-				case v
-				when true
-					buffer << " " << name
-				when String
-					buffer << " " << name << '="' << ERB::Util.html_escape(v) << '"'
-				when Symbol
-					buffer << " " << name << '="' << ERB::Util.html_escape(v.name) << '"'
-				when Hash
-					__build_attributes__(
-						v.transform_keys { |subkey|
-							case subkey
-								when Symbol then"#{k}-#{subkey.name.tr('_', '-')}"
-								else "#{k}-#{subkey}"
-							end
-						}, buffer: buffer
-					)
-				else
-					buffer << " " << name << '="' << ERB::Util.html_escape(v.to_s) << '"'
-				end
-			end
-
-			buffer
-		end
-
 		# This should be the last method defined
 		def self.method_added(method_name)
 			if method_name[0] == "_" && Phlex::HTML.instance_methods.include?(method_name) && instance_method(method_name).owner != Phlex::HTML

data/lib/{overrides → phlex/overrides}/symbol/name.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Overrides::Symbol::Name
+module Phlex::Overrides::Symbol::Name
 	refine(Symbol) { alias_method :name, :to_s }
 end