phlex 1.9.3 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9626f57bb65b8406db379a0ec004a4be1328638cf2ae3049189456b1fcf9c84f
-  data.tar.gz: 830bb2616cb9fd38dea2e301e2d28eaad7ac17692b69e29dcdcbcd9a3d0e363e
+  metadata.gz: 6cb979c6d7c51d88b32f291de0ca3133594a03e70615b17c7fe7bff3b4b3e8c6
+  data.tar.gz: 4649c3a4526638bbbde4c627c70d57e969e9924cf4d2fac9706ab01d1283faa0
 SHA512:
-  metadata.gz: c53416162addce8669ae69b925859f6be21d2ca4d081e44aa7b0fbba2184f2f58ff543b6032f1c102a0c12bf442df58ce8c46d3000f40563d21dee15449172b3
-  data.tar.gz: 0d3b36d039ab0efb7e172633994d8432342759f367ebf2d9e414f3cd99adc8ea2cd6ae0a1579c6945828c5b86ab236ff4f09a062d4670ac71be0e2dbdfe3684c
+  metadata.gz: aaf25254c000f2bc39fb949427bfcced283df5c0dd4b44284ae30ba830d8141d6789adde5548911cb4b381ff096a7a31cc5d877d55cc7d48dfaf650670f08232
+  data.tar.gz: f8714c5084425f13c1ebcc7fcdf1e436a6a4ce501568dcf6522e7fd10279dd2902242e3b38ef4d1d1499d316237483eadf65f143718161676677d54c1c8ff65f

data/.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[*.erb]
+indent_style = space
+indent_size = 2

data/.rubocop.yml

@@ -0,0 +1,27 @@
+inherit_from:
+  - "https://www.goodcop.style/rubocop.yml"
+  - "https://www.goodcop.style/tabs.yml"
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/ExplicitBlockArgument:
+  Enabled: false
+
+Style/MixinUsage:
+  Enabled: false
+
+Style/RedundantDoubleSplatHashBraces:
+  Enabled: false
+
+Style/OptionalArguments:
+  Enabled: false
+
+Naming/AsciiIdentifiers:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Style/ReturnNilInPredicateMethodDefinition:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/.solargraph.yml

@@ -0,0 +1,11 @@
+include:
+  - "**/*.rb"
+exclude:
+  - test/**/*
+require: []
+domains: []
+reporters:
+  - rubocop
+  - require_not_found
+  - typecheck
+max_files: 0

data/.yardopts

@@ -0,0 +1 @@
+--private --hide-api private --markup markdown

data/CHANGELOG.md

@@ -0,0 +1,62 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.10.0] 2024-04-05
+
+- [Added] new `Phlex::CSV` class for streaming CSV views
+- [Added] new (experimental) `Phlex::Kit` for collections of components
+- [Added] support for selective rendering
+- [Changed] `mix` does a better job when mixing different types of attributes
+- [Changed] Phlex will now try to call `to_s` on attribute values
+- [Changed] No runtime dependencies
+- [Deprecated] `Phlex::HTML#param`, (`<param>`) tags have been deprecated
+- [Deprecated] Defining the `template` method is now deprecated. You should define `view_template` instead. In Phlex 2.0, the `template` method will render a `<template>` tag.
+
+# [1.9.1] 2024-03-11
+
+- Security update
+
+## [1.9.0] 2024-11-24
+
+- Improved documentation
+- Fixed an issue with flushing to the buffer while capturing
+- Added `<canvas>` element
+- Very minor performance improvements by using `block` instead of `block_given?` where a block has already been captured
+- `Integer` objects are now handled by the `format_object` method, which you can override to customise how various objects are rendered
+- You can now use `render` with `String` and `Method` objects
+
+## [1.8.1] 2023-04-19
+
+### Fixed
+
+- Rendering a component with a false `render?` predicate should return an empty String rather than `nil`.
+
+## [1.8.0] 2023-04-19
+
+### Changed
+
+- Support `Integer` and `Float` attribute values, and fall back to calling `to_str` on other objects.
+
+## [1.7.0] 2023-04-18
+
+### Added
+
+- Experimental Smart chunking.
+
+### Changed
+
+- Improved YARD documentation, which is now available here https://rubydoc.info/gems/phlex
+- `SGML#render` can now render lambdas with zero or one arguments. Previously, it could only render lambdas with exactly one argument, although it could always render Procs with any number of arguments. When an argument is accepted, the `self` of the component rendering it is yielded to the Proc.
+- Raise an error when outputting an unknown object using `SGML#plain`.
+- Raise an error when using attribute keys that aren't Strings or Symbols.
+- Support Array and Set values for HTML/SVG attributes.
+
+### Removed
+
+- Removed the `menuitem` element as it's a deprecated HTML element.
+- Removed the `SGML#text` method. This has been replaced with `SGML#plain`.
+
+---
+
+Before this changelog was introduced, changes were logged in the [release notes](https://github.com/phlex-ruby/phlex/releases).

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at joel@drapper.me. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing to Phlex
+
+## Priorities
+
+We’re trying to provide the best possible developer experience for the people using Phlex in their apps and the best possible performance for the users of those apps.
+
+Phlex is incredibly complex and requires a lot of meta-programming but when you use it, it feels simple. Phlex views feel like plain old Ruby objects. You just subclass and define a couple of methods. That’s it. That’s how it should be.
+
+## Setup
+
+- Install dependencies `bundle install`
+- Run the tests `bundle exec sus`
+- Run Rubocop and auto-correct `bundle exec rubocop -A`
+
+## Tests
+
+New tests should be written using [GreenDots](https://github.com/joeldrapper/green_dots) and placed in the `gd` folder. You can run these tests with:
+
+```
+bundle exec gd gd
+```
+
+Joel maintains GreenDots itself, so if you run into any issues, please reach out to him by creating an issue in the GreenDots repo so he can improve the framework.
+
+Previously, we used **[Sus](https://github.com/ioquatix/sus)**. Sus tests are in the `test` folder and can be run with:
+
+```
+bundle exec sus
+```
+
+## Documentation
+
+Documentation is deployed when it’s merged into the `latest` branch with a release. But you can build and preview the docs locally by running `bin/docs`.

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec
+
+group :test do
+	gem "sus"
+	if RUBY_ENGINE == "ruby" && RUBY_VERSION[0] > "3"
+		gem "async"
+	end
+	gem "concurrent-ruby"
+end
+
+group :development do
+	gem "rubocop"
+	gem "solargraph"
+	gem "yard"
+	gem "benchmark-ips"
+end

data/README.md

@@ -1,7 +1,9 @@
-<a href="https://www.phlex.fun"><img alt="Phlex logo" src="https://www.phlex.fun/assets/logo.png" width="180" /></a>
+<a href="https://www.phlex.fun/"><img alt="Phlex logo" src="https://www.phlex.fun/assets/logo.png" width="180" /></a>
 
 Phlex lets you compose web views in pure Ruby — kind of like JSX, but not really anything like JSX. It’s super-fast, thread-safe and supports TruffleRuby v22.2+, JRuby v9.2+ and MRI v2.7+. Phlex currently supports [HTML](https://rubydoc.info/gems/phlex/Phlex/HTML) and [SVG](https://rubydoc.info/gems/phlex/Phlex/SVG) views, and we’re exploring JSON and XML.
 
+Docs and more at [Phlex.fun](https://www.phlex.fun/)
+
 ### Prior Art 🎨
 
 - [markaby](https://github.com/markaby/markaby)

data/SECURITY.md

@@ -0,0 +1,14 @@
+# Security
+
+If you find a possible security vulnerability, please [send us a private advisory](https://github.com/phlex-ruby/phlex/security/advisories/new). 
+
+> [!WARNING]
+> Please do not open a public Issue or Pull Request.
+
+## Bug bounty
+
+There is currently a bounty of $100 USD, kindly sponsored by [Seth Horsley](https://twitter.com/SethHorsley), for the next serious vulnerability responsibly disclosed to us.
+
+## Bug bounty pot
+
+If you wish to sponsor a bug bounty for Phlex, please get in touch with Joel at [joel@drapper.me](mailto:joel@drapper.me).

data/bench.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "phlex"
+require "benchmark/ips"
+
+require_relative "fixtures/page"
+require_relative "fixtures/layout"
+
+puts RUBY_DESCRIPTION
+
+a = Example::Page.new.call
+# Example::Page.compile
+# Example::LayoutComponent.compile
+b = Example::Page.new.call
+
+raise unless a == b
+
+Benchmark.ips do |x|
+	x.report("Page") { Example::Page.new.call }
+end

data/config/sus.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "phlex"
+require "bundler"
+
+Bundler.require :test
+
+require_relative "../fixtures/view_helper"

data/fixtures/components/say_hi.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Components::SayHi < Phlex::HTML
+	def initialize(name, times: 1)
+		@name = name
+		@times = times
+	end
+
+	def template
+		article {
+			@times.times { h1 { "Hi #{@name}" } }
+			yield
+		}
+	end
+end

data/fixtures/components.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Components
+	extend Phlex::Kit
+
+	autoload :SayHi, "components/say_hi"
+end

data/fixtures/layout.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Example
+	class LayoutComponent < Phlex::HTML
+		def initialize(title: "Example")
+			@title = title
+		end
+
+		def view_template(&block)
+			html do
+				head do
+					title { @title }
+					meta name: "viewport", content: "width=device-width,initial-scale=1"
+					link href: "/assets/tailwind.css", rel: "stylesheet"
+				end
+
+				body class: "bg-zinc-100" do
+					nav class: "p-5", id: "main_nav" do
+						ul do
+							li(class: "p-5") { a(href: "/") { "Home" } }
+							li(class: "p-5") { a(href: "/about") { "About" } }
+							li(class: "p-5") { a(href: "/contact") { "Contact" } }
+						end
+					end
+
+					div class: "container mx-auto p-5", &block
+				end
+			end
+		end
+	end
+end

data/fixtures/page.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Example
+	class Page < Phlex::HTML
+		def view_template
+			render LayoutComponent.new do
+				h1 { "Hi" }
+
+				100.times do
+					table id: "test", class: "a b c d e f g" do
+						tr do
+							td id: "test", class: "a b c d e f g" do
+								span { "Hi" }
+							end
+
+							td id: "test", class: "a b c d e f g" do
+								span { "Hi" }
+							end
+
+							td id: "test", class: "a b c d e f g" do
+								span { "Hi" }
+							end
+
+							td id: "test", class: "a b c d e f g" do
+								span { "Hi" }
+							end
+
+							td id: "test", class: "a b c d e f g" do
+								span { "Hi" }
+							end
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/fixtures/view_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ViewHelper
+	def self.extended(parent)
+		parent.class_exec do
+			let(:output) { example.call }
+			let(:example) { view.new }
+		end
+	end
+
+	def view(&block)
+		let :view do
+			Class.new(Phlex::HTML, &block)
+		end
+	end
+
+	def svg_view(&block)
+		let :view do
+			Class.new(Phlex::SVG, &block)
+		end
+	end
+end

data/gd/phlex/callable.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Example
+	include Phlex::Callable
+
+	def call
+		"Hello, world!"
+	end
+end
+
+def example
+	Example.new
+end
+
+test "to_proc" do
+	expect(example.to_proc).to_be_a Proc
+	expect(example.to_proc.call) == "Hello, world!"
+end

data/gd/phlex/sgml/attributes.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+include TestHelper
+
+class ToPhlexAttributeValueable
+	def to_phlex_attribute_value
+		"to_phlex_attribute_value"
+	end
+end
+
+class ToSable
+	def to_s
+		"to_s"
+	end
+end
+
+class ToStrable
+	def to_str
+		"to_str"
+	end
+end
+
+test "with symbol-keyed hash attributes" do
+	component = build_component_with_template do
+		div data: { name: { first_name: "Joel" } }
+	end
+
+	expect(component.new).to_render %(<div data-name-first-name="Joel"></div>)
+end
+
+test "with string-keyed hash attributes" do
+	component = build_component_with_template do
+		div data: { "name" => { "first_name" => "Joel" } }
+	end
+
+	expect(component.new).to_render %(<div data-name-first_name="Joel"></div>)
+end
+
+test "with an array of symbols and strings" do
+	component = build_component_with_template do
+		div class: ["bg-red-500", :rounded]
+	end
+
+	expect(component.new).to_render %(<div class="bg-red-500 rounded"></div>)
+end
+
+test "with a set of symbols and strings" do
+	component = build_component_with_template do
+		div class: Set.new(["bg-red-500", :rounded])
+	end
+
+	expect(component.new).to_render %(<div class="bg-red-500 rounded"></div>)
+end
+
+test "with a to_phlex_attribute_value-able object" do
+	component = build_component_with_template do
+		div class: ToPhlexAttributeValueable.new
+	end
+
+	expect(component.new).to_render %(<div class="to_phlex_attribute_value"></div>)
+end
+
+test "with a to_s-able object" do
+	component = build_component_with_template do
+		div class: ToSable.new
+	end
+
+	expect(component.new).to_render %(<div class="to_s"></div>)
+end
+
+test "with a to_str-able object" do
+	component = build_component_with_template do
+		div class: ToStrable.new
+	end
+
+	expect(component.new).to_render %(<div class="to_str"></div>)
+end
+
+test "with numeric integer/float" do
+	component = build_component_with_template do
+		input type: "range", min: 0, max: 10, step: 0.5
+	end
+
+	expect(component.new).to_render %(<input type="range" min="0" max="10" step="0.5">)
+end
+
+if RUBY_ENGINE == "ruby"
+	context "with unique tag attributes" do
+		let def component
+			build_component_with_template do
+				div class: SecureRandom.hex
+			end
+		end
+
+		let def report
+			component.call
+
+			MemoryProfiler.report do
+				2.times { component.call }
+			end
+		end
+
+		test "doesn't leak memory" do
+			expect(report.total_retained) == 0
+		end
+	end
+end

data/gd/support/helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "phlex"
+require "bundler"
+
+Bundler.require :test
+
+module TestHelper
+	def build_component_with_template(&block)
+		Class.new(Phlex::HTML) { define_method(:template, &block) }
+	end
+end
+
+module ToRender
+	def to_render(expected_output)
+		output = subject.call
+		assert(output == expected_output) { "Expected `#{output.inspect}` to equal `#{expected_output.inspect}`." }
+	end
+end
+
+GreenDots.configure do |config|
+	config.register_matcher ToRender, Phlex::SGML
+end

data/lib/phlex/black_hole.rb

@@ -8,7 +8,7 @@ module Phlex::BlackHole
 		self
 	end
 
-	def length
+	def bytesize
 		0
 	end