phlex 0.5.3 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bd2b79d18bf802486addb4c486e3200b260248245a4ade7f1d0e3f4e56ecdab
-  data.tar.gz: c27f8e8d3b6ab1d63ab28cd472873cbae295641e252c757230f684b79b17eb75
+  metadata.gz: 72f6baa9bd23ce981517a40897f2bb63a1cbd60fbc87bb127883e8eeb36cc302
+  data.tar.gz: 5abc8c59a81cdff51f5da9250a28d9cc42308b467aa662b155fb1d28eca4a1c2
 SHA512:
-  metadata.gz: 140f1b74b07334bb469020e940955dd319f9622d372841d260f8fe283278259cae4e8f4f3f875815e6bbee56b4f6b9e49fcdd42f6dcb7e8e9eb3ef83bb0487f1
-  data.tar.gz: 8124ba9fe2bc9adaa9aadcb1d23c3942ffab886cfe0c74993515abb36d07ba07a4198cfaa4550375fa8de81d3701cd8994947bc2bf5703f17cfec86573bd2481
+  metadata.gz: 8db8f9df3da1f218bd2029ea22414ea53a910de8b1810d71c70a0e9022a1353dd69557c91eb1ffee5355733c0d8d6878aae9379a75ee0eaa76d05c6ee20abb8e
+  data.tar.gz: 8027722c6fd1592c86f5fa6150814206a007c12a810985c72231195dcb0089aa34fd91a5addbeb9c14a8137a5a2f3fe984c07f554ee6504a4b4c25d6dd216046

data/Gemfile

@@ -5,32 +5,14 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gemspec
 
-gem "benchmark-ips"
-gem "benchmark-memory"
-gem "capybara"
-gem "rails"
 gem "rubocop"
-gem "solargraph"
 gem "sus"
 gem "syntax_suggest"
 gem "zeitwerk"
+gem "benchmark-ips"
+gem "erb"
 
 group :test do
 	gem "i18n"
 	gem "memory_profiler"
-	gem "covered"
-end
-
-group :rails do
-	gem "combustion"
-end
-
-group :docs do
-	gem "filewatcher"
-	gem "htmlbeautifier"
-	gem "redcarpet"
-	gem "markly"
-	gem "webrick"
-	gem "rouge"
-	gem "kramdown"
 end

data/config/sus.rb

@@ -1,15 +1,10 @@
 # frozen_string_literal: true
 
-require "covered/sus"
-include Covered::Sus
-
 require "phlex"
 require "bundler"
-require "view_component"
 
 Bundler.require :test
 
 require_relative "../fixtures/view_helper"
-require_relative "../fixtures/compiler_test_helpers"
 
 Zeitwerk::Loader.eager_load_all

data/lib/phlex/buffered.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "delegate"
+
 module Phlex
 	class Buffered < SimpleDelegator
 		def initialize(object, buffer:)

data/lib/phlex/collection.rb

@@ -2,6 +2,8 @@
 
 module Phlex
 	module Collection
+		include Experimental
+
 		def initialize(collection: nil, item: nil)
 			unless collection || item
 				raise ArgumentError, "You must pass a collection or an item as a keyword argument."

data/lib/phlex/elements.rb

@@ -10,11 +10,7 @@ module Phlex
 			class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
         # frozen_string_literal: true
 
-        def #{element}(content = nil, **attributes, &block)
-					if content
-						raise ArgumentError, %(👋 You can no longer pass content to #{element} as a positional argument.\n Instead, you can pass it as a block, e.g. #{element} { "Hello" })
-					end
-
+        def #{element}(**attributes, &block)
           if attributes.length > 0
             if block_given?
               @_target << "<#{tag}" << (Phlex::ATTRIBUTE_CACHE[attributes.hash] || _attributes(**attributes)) << ">"

data/lib/phlex/experimental.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Experimental
+		def before_template
+			puts "Warning: #{self.class.name} is experimental and subject to change."
+			super
+		end
+	end
+end

data/lib/phlex/helpers.rb

@@ -7,23 +7,36 @@ end
 module Phlex::Helpers
 	def tokens(*tokens, **conditional_tokens)
 		conditional_tokens.each do |condition, token|
-			case condition
-			when Symbol then next unless send(condition)
-			when Proc then next unless condition.call
-			else raise ArgumentError,
-				"The class condition must be a Symbol or a Proc."
+			truthy = case condition
+				when Symbol then send(condition)
+				when Proc then condition.call
+				else raise ArgumentError, "The class condition must be a Symbol or a Proc."
 			end
 
-			case token
-			when Symbol then tokens << token.name
+			if truthy
+				case token
+					when Hash then _append_token(tokens, token[:then])
+					else _append_token(tokens, token)
+				end
+			else
+				case token
+					when Hash then _append_token(tokens, token[:else])
+				end
+			end
+		end
+
+		tokens.join(" ")
+	end
+
+	def _append_token(tokens, token)
+		case token
+			when nil then nil
 			when String then tokens << token
+			when Symbol then tokens << token.name
 			when Array then tokens.concat(token)
 			else raise ArgumentError,
 				"Conditional classes must be Symbols, Strings, or Arrays of Symbols or Strings."
-			end
 		end
-
-		tokens.compact.join(" ")
 	end
 
 	def classes(*tokens, **conditional_tokens)

data/lib/phlex/html.rb

@@ -128,25 +128,9 @@ module Phlex
 
 		extend Elements
 		include Helpers
-		include Callable
-		include Renderable
 
 		class << self
 			attr_accessor :rendered_at_least_once
-
-			# 			def compile
-			# 				return if @compiled
-			# 				return unless name
-			# 				return if name.start_with? "#"
-			#
-			# 				Compiler.new(self).call
-			#
-			# 				@compiled = true
-			# 			end
-			#
-			# 			def compiled?
-			# 				!!@compiled
-			# 			end
 		end
 
 		def call(buffer = +"", view_context: nil, parent: nil, &block)
@@ -158,15 +142,30 @@ module Phlex
 			@_target = buffer
 			@_view_context = view_context
 			@_parent = parent
-			@output_buffer = self
 
-			template(&block)
+			around_template { template { yield_content(&block) } }
 
 			self.class.rendered_at_least_once ||= true
 
 			buffer
 		end
 
+		def render(renderable, *args, **kwargs, &block)
+			if renderable.is_a?(Phlex::HTML)
+				renderable.call(@_target, view_context: @_view_context, parent: self, &block)
+			elsif renderable.is_a?(Class) && renderable < Phlex::HTML
+				raise ArgumentError, "You tried to render the Phlex view class: #{renderable.name} but you probably meant to render an instance of that class instead."
+			else
+				raise ArgumentError, "You can't render a #{renderable}."
+			end
+
+			nil
+		end
+
+		def format
+			:html
+		end
+
 		def rendered?
 			@_rendered ||= false
 		end
@@ -183,37 +182,18 @@ module Phlex
 			register_void_element(method_name, tag: tag)
 		end
 
-		def yield_content(&block)
-			return unless block_given?
-
-			original_length = @_target.length
-			output = yield(self)
-			unchanged = (original_length == @_target.length)
-
-			if unchanged
-				case output
-				when String, Symbol, Integer, Float
-					text(output)
-				end
-			end
-
-			nil
-		end
-
 		def text(content)
-			@_target << _output(content)
+			@_target << ERB::Util.html_escape(
+				case content
+					when String then content
+					when Symbol then content.name
+					else content.to_s
+				end
+			)
 
 			nil
 		end
 
-		def _output(content)
-			case content
-			when String then Hescape.escape_html(content)
-			when Symbol then Hescape.escape_html(content.name)
-			else Hescape.escape_html(content.to_s)
-			end
-		end
-
 		def whitespace
 			@_target << " "
 
@@ -225,8 +205,11 @@ module Phlex
 			nil
 		end
 
-		def comment(content = "")
-			@_target << "<!-- " << Hescape.escape_html(content.to_s) << " -->"
+		def comment(&block)
+			@_target << "<!-- "
+			yield_content(&block)
+			@_target << " -->"
+
 			nil
 		end
 
@@ -240,34 +223,6 @@ module Phlex
 			nil
 		end
 
-		def html_safe?
-			true
-		end
-
-		def safe_append=(value)
-			return unless value
-
-			@_target << case value
-			when String then value
-			when Symbol then value.name
-			else value.to_s
-			end
-		end
-
-		def append=(value)
-			return unless value
-
-			if value.html_safe?
-				self.safe_append = value
-			else
-				@_target << case value
-				when String then Hescape.escape_html(value)
-				when Symbol then Hescape.escape_html(value.name)
-				else Hescape.escape_html(value.to_s)
-				end
-			end
-		end
-
 		def capture(&block)
 			return unless block_given?
 
@@ -279,11 +234,44 @@ module Phlex
 
 			@_target = original_buffer
 
-			new_buffer.html_safe
+			new_buffer
 		end
 
-		def helpers
-			@_view_context
+		private
+
+		def around_template
+			before_template
+			yield
+			after_template
+		end
+
+		def before_template
+			nil
+		end
+
+		def after_template
+			nil
+		end
+
+		def yield_content(&block)
+			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, Float
+					@_target << ERB::Util.html_escape(content.to_s)
+				end
+			end
+
+			nil
 		end
 
 		def _attributes(**attributes)
@@ -306,14 +294,12 @@ module Phlex
 				next unless v
 
 				name = case k
-				when String
-					k
-				when Symbol
-					k.name.tr("_", "-")
-				else
-					k.to_s
+					when String then k
+					when Symbol then k.name.tr("_", "-")
+					else k.to_s
 				end
 
+				# Detect unsafe attribute names. Attribute names are considered unsafe if they match an event attribute or include unsafe characters.
 				if HTML::EVENT_ATTRIBUTES[name] || name.match?(/[<>&"']/)
 					raise ArgumentError, "Unsafe attribute name detected: #{k}."
 				end
@@ -322,13 +308,13 @@ module Phlex
 				when true
 					buffer << " " << name
 				when String
-					buffer << " " << name << '="' << Hescape.escape_html(v) << '"'
+					buffer << " " << name << '="' << ERB::Util.html_escape(v) << '"'
 				when Symbol
-					buffer << " " << name << '="' << Hescape.escape_html(v.name) << '"'
+					buffer << " " << name << '="' << ERB::Util.html_escape(v.name) << '"'
 				when Hash
 					_build_attributes(v.transform_keys { "#{k}-#{_1.name.tr('_', '-')}" }, buffer: buffer)
 				else
-					buffer << " " << name << '="' << Hescape.escape_html(v.to_s) << '"'
+					buffer << " " << name << '="' << ERB::Util.html_escape(v.to_s) << '"'
 				end
 			end
 

data/lib/phlex/table.rb

@@ -2,6 +2,7 @@
 
 module Phlex
 	module Table
+		include Experimental
 		include Collection
 
 		module ClassMethods

data/lib/phlex/turbo/frame.rb

@@ -3,6 +3,8 @@
 module Phlex
 	module Turbo
 		class Frame < Phlex::HTML
+			include Experimental
+
 			register_element :turbo_frame
 
 			def initialize(src:, loading:, disabled:, target:, autoscroll:)

data/lib/phlex/turbo/stream.rb

@@ -3,6 +3,8 @@
 module Phlex
 	module Turbo
 		class Stream < Phlex::HTML
+			include Experimental
+
 			register_element :turbo_stream
 
 			def initialize(action:, **attributes)

data/lib/phlex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Phlex
-	VERSION = "0.5.3"
+	VERSION = "1.0.0.rc2"
 end

data/lib/phlex.rb

@@ -1,23 +1,12 @@
 # frozen_string_literal: true
 
-require "hescape"
+require "erb"
 require "zeitwerk"
-require "syntax_tree"
 
 module Phlex
 	Loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false).tap do |loader|
-		loader.ignore("#{__dir__}/generators")
-		loader.ignore("#{__dir__}/install")
-
-		loader.ignore("#{__dir__}/phlex/testing")
-		loader.ignore("#{__dir__}/phlex/markdown.rb")
-
-		loader.ignore("#{__dir__}/phlex/rails.rb")
-		loader.ignore("#{__dir__}/phlex/rails")
-
 		loader.inflector.inflect("html" => "HTML")
-		loader.inflector.inflect("vcall" => "VCall")
-		loader.inflector.inflect("fcall" => "FCall")
+		loader.ignore("#{__dir__}/phlex/testing")
 		loader.setup
 	end
 
@@ -25,12 +14,6 @@ module Phlex
 	ArgumentError = Class.new(ArgumentError) { include Error }
 	NameError = Class.new(NameError) { include Error }
 
-	def self.const_missing(name)
-		if name == :View
-			raise NameError, "👋 Phlex::View has been renamed (again 🙄) to Phlex::HTML."
-		end
-	end
-
 	extend self
 
 	ATTRIBUTE_CACHE = {}