RubyGems - phlex - Versions diffs - 0.4.0 → 0.5.0 - Mend

phlex 0.4.0 → 0.5.0

Potentially problematic release.

This version of phlex might be problematic. Click here for more details.

Files changed (110) hide show

checksums.yaml +4 -4
data/.rubocop.yml +21 -1
data/Gemfile +26 -13
data/README.md +1 -1
data/SECURITY.md +1 -1
data/bench.rb +7 -0
data/config/sus.rb +15 -0
data/docs/assets/application.css +6 -0
data/docs/build.rb +2 -0
data/docs/components/callout.rb +1 -1
data/docs/components/code_block.rb +2 -2
data/docs/components/code_span.rb +1 -1
data/docs/components/example.rb +4 -4
data/docs/components/heading.rb +2 -2
data/docs/components/layout.rb +55 -32
data/docs/components/markdown.rb +13 -28
data/docs/components/nav/item.rb +1 -1
data/docs/components/nav.rb +1 -1
data/docs/components/tabs/tab.rb +1 -1
data/docs/components/tabs.rb +1 -1
data/docs/components/title.rb +2 -2
data/docs/pages/application_page.rb +1 -1
data/docs/pages/helpers.rb +5 -5
data/docs/pages/library/collections.rb +4 -22
data/docs/pages/rails/getting_started.rb +1 -1
data/docs/pages/rails/helpers.rb +3 -1
data/docs/pages/rails/layouts.rb +2 -2
data/docs/pages/rails/rendering_views.rb +1 -1
data/docs/pages/templates.rb +6 -6
data/docs/pages/testing/capybara.rb +48 -0
data/docs/pages/testing/getting_started.rb +44 -0
data/docs/pages/testing/nokogiri.rb +83 -0
data/docs/pages/testing/rails.rb +17 -0
data/docs/pages/translations.rb +81 -0
data/docs/pages/views.rb +56 -8
data/fixtures/compiler_test_helpers.rb +19 -0
data/fixtures/content.rb +60 -0
data/fixtures/dummy/app/views/application_view.rb +8 -0
data/fixtures/dummy/app/views/articles/form.rb +1 -1
data/fixtures/dummy/app/views/card.rb +1 -1
data/fixtures/dummy/app/views/comments/comment.rb +1 -1
data/fixtures/dummy/app/views/comments/reaction.rb +1 -1
data/fixtures/dummy/app/views/heading.rb +1 -1
data/fixtures/layout.rb +5 -5
data/fixtures/page.rb +18 -24
data/fixtures/{test_helper.rb → rails_helper.rb} +3 -8
data/fixtures/standard_element.rb +87 -0
data/fixtures/view_helper.rb +1 -1
data/fixtures/void_element.rb +31 -0
data/lib/generators/phlex/collection/templates/collection.rb.erb +2 -1
data/lib/generators/phlex/controller/USAGE +10 -0
data/lib/generators/phlex/controller/controller_generator.rb +54 -0
data/lib/generators/phlex/controller/templates/controller.rb.erb +10 -0
data/lib/generators/phlex/controller/templates/view.rb.erb +14 -0
data/lib/generators/phlex/layout/templates/layout.rb.erb +2 -1
data/lib/generators/phlex/page/templates/page.rb.erb +3 -1
data/lib/generators/phlex/table/templates/table.rb.erb +3 -1
data/lib/generators/phlex/view/templates/view.rb.erb +7 -1
data/lib/generators/phlex/view/view_generator.rb +9 -1
data/lib/install/phlex.rb +10 -1
data/lib/phlex/block.rb +2 -4
data/lib/phlex/buffered.rb +6 -8
data/lib/phlex/callable.rb +9 -0
data/lib/phlex/collection.rb +2 -27
data/lib/phlex/compiler/elements.rb +49 -0
data/lib/phlex/compiler/generators/content.rb +103 -0
data/lib/phlex/compiler/generators/element.rb +61 -0
data/lib/phlex/compiler/nodes/base.rb +19 -0
data/lib/phlex/compiler/nodes/call.rb +9 -0
data/lib/phlex/compiler/nodes/command.rb +13 -0
data/lib/phlex/compiler/nodes/fcall.rb +18 -0
data/lib/phlex/compiler/nodes/method_add_block.rb +33 -0
data/lib/phlex/compiler/nodes/vcall.rb +9 -0
data/lib/phlex/compiler/optimizer.rb +66 -0
data/lib/phlex/compiler/visitors/base.rb +15 -0
data/lib/phlex/compiler/visitors/file.rb +23 -11
data/lib/phlex/compiler/visitors/stable_scope.rb +28 -0
data/lib/phlex/compiler/visitors/statements.rb +36 -0
data/lib/phlex/compiler/visitors/view.rb +19 -0
data/lib/phlex/compiler/visitors/view_method.rb +59 -0
data/lib/phlex/compiler.rb +23 -3
data/lib/phlex/elements.rb +57 -0
data/lib/phlex/helpers.rb +59 -0
data/lib/phlex/html/callbacks.rb +11 -0
data/lib/phlex/html.rb +208 -47
data/lib/phlex/markdown.rb +76 -0
data/lib/phlex/rails/form.rb +67 -0
data/lib/phlex/rails/helpers.rb +39 -2
data/lib/phlex/rails.rb +10 -0
data/lib/phlex/renderable.rb +9 -3
data/lib/phlex/testing/capybara.rb +25 -0
data/lib/phlex/testing/nokogiri.rb +24 -0
data/lib/phlex/testing/rails.rb +19 -0
data/lib/phlex/testing/view_helper.rb +15 -0
data/lib/phlex/translation.rb +23 -0
data/lib/phlex/turbo/frame.rb +21 -0
data/lib/phlex/turbo/stream.rb +18 -0
data/lib/phlex/version.rb +1 -1
data/lib/phlex.rb +22 -24
metadata +62 -14
data/.rspec +0 -1
data/fixtures/compilation/vcall.rb +0 -38
data/lib/phlex/compiler/generators/standard_element.rb +0 -30
data/lib/phlex/compiler/generators/void_element.rb +0 -29
data/lib/phlex/compiler/optimizers/base_optimizer.rb +0 -34
data/lib/phlex/compiler/optimizers/vcall.rb +0 -29
data/lib/phlex/compiler/visitors/base_visitor.rb +0 -19
data/lib/phlex/compiler/visitors/component.rb +0 -28
data/lib/phlex/compiler/visitors/component_method.rb +0 -28
data/lib/phlex/view.rb +0 -229

data/lib/phlex/html.rb CHANGED Viewed

@@ -5,7 +5,7 @@ if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.0")
 end
 module Phlex
-	module HTML
+	class HTML
 		DOCTYPE = "<!DOCTYPE html>"
 		STANDARD_ELEMENTS = {
@@ -126,52 +126,213 @@ module Phlex
 		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 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
-		def register_element(element, tag: element.name.tr("_", "-"))
-			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
-          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
-			RUBY
-		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
-			RUBY
+		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)
+			return buffer unless render?
+			raise "The same view instance shouldn't be rendered twice" if rendered?
+			@_rendered = true
+			@_target = buffer
+			@_view_context = view_context
+			@_parent = parent
+			@output_buffer = self
+			template(&block)
+			self.class.rendered_at_least_once ||= true
+			buffer
+		end
+		def rendered?
+			@_rendered ||= false
+		end
+		def render?
+			true
+		end
+		STANDARD_ELEMENTS.each do |method_name, tag|
+			register_element(method_name, tag: tag)
+		end
+		VOID_ELEMENTS.each do |method_name, tag|
+			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)
+			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 << " "
+			if block_given?
+				yield
+				@_target << " "
+			end
+			nil
+		end
+		def comment(content = "")
+			@_target << "<!-- " << Hescape.escape_html(content.to_s) << " -->"
+			nil
+		end
+		def doctype
+			@_target << DOCTYPE
+			nil
+		end
+		def unsafe_raw(content = nil, &block)
+			@_target << (content || instance_exec(&block))
+			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?
+			original_buffer = @_target
+			new_buffer = +""
+			@_target = new_buffer
+			yield
+			@_target = original_buffer
+			new_buffer.html_safe
+		end
+		def helpers
+			@_view_context
+		end
+		def _attributes(**attributes)
+			if attributes[:href]&.start_with?(/\s*javascript/)
+				attributes[:href] = attributes[:href].sub(/^\s*(javascript:)+/, "")
+			end
+			buffer = +""
+			_build_attributes(attributes, buffer: buffer)
+			unless self.class.rendered_at_least_once
+				Phlex::ATTRIBUTE_CACHE[attributes.hash] = buffer.freeze
+			end
+			buffer
+		end
+		def _build_attributes(attributes, buffer:)
+			attributes.each do |k, v|
+				next unless v
+				name = case k
+				when String
+					k
+				when Symbol
+					k.name.tr("_", "-")
+				else
+					k.to_s
+				end
+				if HTML::EVENT_ATTRIBUTES[name] || name.match?(/[<>&"']/)
+					raise ArgumentError, "Unsafe attribute name detected: #{k}."
+				end
+				case v
+				when true
+					buffer << " " << name
+				when String
+					buffer << " " << name << '="' << Hescape.escape_html(v) << '"'
+				when Symbol
+					buffer << " " << name << '="' << Hescape.escape_html(v.name) << '"'
+				when Hash
+					_build_attributes(v.transform_keys { "#{k}-#{_1.name.tr('_', '-')}" }, buffer: buffer)
+				else
+					buffer << " " << name << '="' << Hescape.escape_html(v.to_s) << '"'
+				end
+			end
+			buffer
 		end
 	end
 end

data/lib/phlex/markdown.rb ADDED Viewed

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+require "commonmarker"
+module Phlex
+	class Markdown < Phlex::HTML
+		def initialize(content)
+			@content = content
+		end
+		def template
+			visit(doc)
+		end
+		private
+		def doc
+			CommonMarker.render_doc(@content)
+		end
+		def visit(node)
+			return if node.nil?
+			case node.type
+			in :document | :softbreak
+				visit_children(node)
+			in :text
+				text(node.string_content)
+			in :header
+				case node.header_level
+					in 1 then h1 { visit_children(node) }
+					in 2 then h2 { visit_children(node) }
+					in 3 then h3 { visit_children(node) }
+					in 4 then h4 { visit_children(node) }
+					in 5 then h5 { visit_children(node) }
+					in 6 then h6 { visit_children(node) }
+				end
+			in :paragraph
+				grandparent = node.parent&.parent
+				if grandparent&.type == :list && grandparent&.list_tight
+					visit_children(node)
+				else
+					p { visit_children(node) }
+				end
+			in :link
+				a(href: node.url) { visit_children(node) }
+			in :emph
+				em { visit_children(node) }
+			in :strong
+				strong { visit_children(node) }
+			in :list
+				case node.list_type
+					in :ordered_list then ol { visit_children(node) }
+					in :bullet_list then ul { visit_children(node) }
+				end
+			in :list_item
+				li { visit_children(node) }
+			in :code
+				whitespace { code { text(node.string_content) } }
+			in :code_block
+				code_block(node.string_content, language: node.fence_info) do |**attributes|
+					pre(**attributes) { text(node.string_content) }
+				end
+			end
+		end
+		def code_block(code, language:)
+			yield
+		end
+		def visit_children(node)
+			node.each { |c| visit(c) }
+		end
+	end
+end

data/lib/phlex/rails/form.rb ADDED Viewed

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+module Phlex
+	module Rails
+		class Form < Phlex::HTML
+			def initialize(model)
+				@model = model
+			end
+			def self.input_field(method_name, type:)
+				define_method method_name do |field, value: @model.attributes[field.to_s], **attributes|
+					input(
+						name: field_name(field),
+						type: type,
+						value: value,
+						**attributes
+					)
+				end
+			end
+			def template(&block)
+				form action: @url, method: @method do
+					authenticity_token_field
+					yield_content(&block)
+				end
+			end
+			def authenticity_token_field
+				input(
+					name: "authenticity_token",
+					type: "hidden",
+					value: @_view_context.form_authenticity_token
+				)
+			end
+			def submit(value)
+				input(
+					name: "commit",
+					type: "submit",
+					value: value
+				)
+			end
+			def url
+				@_view_context.url_for(@model)
+			end
+			def field_name(*field)
+				@_view_context.field_name(ActiveModel::Naming.param_key(@model.class), *field)
+			end
+			input_field :url_field, type: "url"
+			input_field :text_field, type: "text"
+			input_field :date_field, type: "date"
+			input_field :time_field, type: "time"
+			input_field :week_field, type: "week"
+			input_field :month_field, type: "month"
+			input_field :email_field, type: "email"
+			input_field :color_field, type: "color"
+			input_field :hidden_field, type: "hidden"
+			input_field :search_field, type: "search"
+			input_field :password_field, type: "password"
+			input_field :telephone_field, type: "tel"
+			input_field :datetime_local_field, type: "datetime-local"
+		end
+	end
+end

data/lib/phlex/rails/helpers.rb CHANGED Viewed

@@ -28,11 +28,48 @@ module Phlex
 			end
 			module FormWith
+				class BufferedFormWith < Phlex::Buffered
+					alias_method :check_box, :__output_method__
+					alias_method :collection_check_boxes, :__output_method__
+					alias_method :collection_radio_buttons, :__output_method__
+					alias_method :collection_select, :__output_method__
+					alias_method :color_field, :__output_method__
+					alias_method :date_field, :__output_method__
+					alias_method :date_select, :__output_method__
+					alias_method :datetime_field, :__output_method__
+					alias_method :datetime_local_field, :__output_method__
+					alias_method :datetime_select, :__output_method__
+					alias_method :email_field, :__output_method__
+					alias_method :file_field, :__output_method__
+					alias_method :grouped_collection_select, :__output_method__
+					alias_method :hidden_field, :__output_method__
+					alias_method :label, :__output_method__
+					alias_method :month_field, :__output_method__
+					alias_method :number_field, :__output_method__
+					alias_method :password_field, :__output_method__
+					alias_method :phone_field, :__output_method__
+					alias_method :radio_button, :__output_method__
+					alias_method :range_field, :__output_method__
+					alias_method :search_field, :__output_method__
+					alias_method :select, :__output_method__
+					alias_method :submit, :__output_method__
+					alias_method :telephone_field, :__output_method__
+					alias_method :text_area, :__output_method__
+					alias_method :text_field, :__output_method__
+					alias_method :time_field, :__output_method__
+					alias_method :time_select, :__output_method__
+					alias_method :time_zone_select, :__output_method__
+					alias_method :url_field, :__output_method__
+					alias_method :week_field, :__output_method__
+					alias_method :weekday_select, :__output_method__
+					alias_method :button, :__output_method__
+				end
 				def form_with(*args, **kwargs, &block)
-					raw @_view_context.form_with(*args, **kwargs) { |form|
+					@_target << @_view_context.form_with(*args, **kwargs) { |form|
 						capture do
 							yield(
-								Phlex::Buffered.new(form, buffer: @_target)
+								BufferedFormWith.new(form, buffer: @_target)
 							)
 						end
 					}

data/lib/phlex/rails.rb ADDED Viewed

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require "phlex"
+module Phlex::Rails
+	Loader = Zeitwerk::Loader.new.tap do |loader|
+		loader.push_dir("#{__dir__}/rails", namespace: Phlex::Rails)
+		loader.setup
+	end
+end

data/lib/phlex/renderable.rb CHANGED Viewed

@@ -3,13 +3,13 @@
 module Phlex
 	module Renderable
 		def render(renderable, *args, **kwargs, &block)
-			if renderable.is_a?(View)
+			if renderable.is_a?(HTML)
 				if block_given? && !block.binding.receiver.is_a?(Phlex::Block)
 					block = Phlex::Block.new(self, &block)
 				end
 				renderable.call(@_target, view_context: @_view_context, parent: self, &block)
-			elsif renderable.is_a?(Class) && renderable < View
+			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
 				@_target << @_view_context.render(renderable, *args, **kwargs, &block)
@@ -26,7 +26,13 @@ module Phlex
 						output = yield(*args, **kwargs)
 						unchanged = (original_length == @_target.length)
-						text(output) if unchanged && output.is_a?(String)
+						if unchanged
+							if defined?(ActiveSupport::SafeBuffer) && output.is_a?(ActiveSupport::SafeBuffer)
+								unsafe_raw(output)
+							else
+								text(output)
+							end
+						end
 					end
 				end.html_safe
 			else

data/lib/phlex/testing/capybara.rb ADDED Viewed

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require "capybara"
+require_relative "view_helper"
+module Phlex::Testing
+	module Capybara
+		module ViewHelper
+			include Phlex::Testing::ViewHelper
+			def self.included(klass)
+				if defined?(Minitest::Test) && klass < Minitest::Test
+					require "capybara/minitest"
+					include ::Capybara::Minitest::Assertions
+				end
+			end
+			attr_accessor :page
+			def render(view, &block)
+				@page = ::Capybara::Node::Simple.new(super)
+			end
+		end
+	end
+end

data/lib/phlex/testing/nokogiri.rb ADDED Viewed

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require "nokogiri"
+require_relative "view_helper"
+module Phlex::Testing
+	module Nokogiri
+		module DocumentHelper
+			include Phlex::Testing::ViewHelper
+			def render(view, &block)
+				::Nokogiri::HTML5(super)
+			end
+		end
+		module FragmentHelper
+			include Phlex::Testing::ViewHelper
+			def render(view, &block)
+				::Nokogiri::HTML5.fragment(super)
+			end
+		end
+	end
+end

data/lib/phlex/testing/rails.rb ADDED Viewed

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require_relative "view_helper"
+module Phlex::Testing
+	module Rails
+		module ViewHelper
+			include Phlex::Testing::ViewHelper
+			def view_context
+				controller.view_context
+			end
+			def controller
+				@controller ||= ActionView::TestCase::TestController.new
+			end
+		end
+	end
+end

data/lib/phlex/testing/view_helper.rb ADDED Viewed

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Phlex
+	module Testing
+		module ViewHelper
+			def render(view, &block)
+				view.call(view_context: view_context, &block)
+			end
+			def view_context
+				nil
+			end
+		end
+	end
+end

data/lib/phlex/translation.rb ADDED Viewed

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module Phlex
+	module Translation
+		def self.included(view)
+			view.extend(ClassMethods)
+		end
+		module ClassMethods
+			attr_writer :translation_path
+			def translation_path
+				@translation_path ||= name&.split("::")&.join(".")&.downcase.to_s
+			end
+		end
+		def translate(key, **options)
+			key = "#{self.class.translation_path}#{key}" if key.start_with?(".")
+			::I18n.translate(key, **options)
+		end
+	end
+end

data/lib/phlex/turbo/frame.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Phlex
+	module Turbo
+		class Frame < Phlex::HTML
+			register_element :turbo_frame
+			def initialize(src:, loading:, disabled:, target:, autoscroll:)
+				@src = src
+				@loading = loading
+				@disabled = disabled
+				@target = target
+				@autoscroll = autoscroll
+			end
+			def template(&content)
+				turbo_frame(src: @src, loading: @loading, disabled: @disabled, target: @target, autoscroll: @autoscroll, &content)
+			end
+		end
+	end
+end

data/lib/phlex/turbo/stream.rb ADDED Viewed

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Phlex
+	module Turbo
+		class Stream < Phlex::HTML
+			register_element :turbo_stream
+			def initialize(action:, target:)
+				@action = action
+				@target = target
+			end
+			def template(&content)
+				turbo_stream(action: @action, target: @target, &content)
+			end
+		end
+	end
+end

data/lib/phlex/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Phlex
-	VERSION = "0.4.0"
+	VERSION = "0.5.0"
 end