phlex-validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4c2d39e379a9b0828e6e83d85a7aff4a365cb4c201122345f370192d6814e95f
+  data.tar.gz: 6dbf8849d89cfd8fb9ec1ef710ec03dd386cb0bc891755b09889f8a1a73dfc18
+SHA512:
+  metadata.gz: 71b984607a5aa644f182374907f0e802cc35860f5e98d08472edeff90347eef55e4592ec4d46dc2e4dbb3689ca28a335dcbe475f3fb2281dd1bddbee4d8ac25e
+  data.tar.gz: 789af3fee569634428aad320adbd7b4be21169c20b90857ad9d4ef5fbb030fd0dc3e9ed8f9d0d3db8ae2426aac05099d5e6b6400fff144fe3b6a86b0b124ac04

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Joel Drapper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,11 @@
+# Phlex Validator
+
+This project is likely to become stricter over time, which means mostly every update will be a breaking change.
+
+## Common-sense validation
+
+This validator is designed to provide a common-sense validation experience for people writing HTML in Phlex. Sometimes that means being slightly stricter than the HTML specification. For example, there are some boolean attributes that also accept an empty string `""` as a _truthy_ value. The validator instead will require either `true` or `false`.
+
+## Bypass
+
+You can bypass validation by using String keys instead of Symbol keys.

data/lib/phlex/validator/html/attributes/a.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::A = {
+		attributionsrc: _Union(_Boolean, Token),
+		download: Token,
+		href: Href,
+		hreflang: Language,
+		ping: Tokens,
+		referrerpolicy: ReferrerPolicy,
+		rel: ARel,
+		target: Target,
+		type: MimeType,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/area.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Area = {
+		alt: String,
+		# TODO: define coords dynamically
+		download: Token,
+		href: Href,
+		ping: Tokens,
+		referrerpolicy: ReferrerPolicy,
+		rel: ARel,
+		shape: Enum(
+			:rect,
+			:circle,
+			:poly,
+			:default
+		),
+		target: Target,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/audio.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Audio = {
+		autoplay: _Boolean,
+		controls: _Boolean,
+		controlslist: ControlsList,
+		crossorigin: CrossOrigin,
+		disableremoteplayback: _Boolean,
+		loop: _Boolean,
+		muted: _Boolean,
+		preload: Enum(
+			:none,
+			:metadata,
+			:auto
+		),
+		src: String,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/base.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Base = {
+		href: Href,
+		target: Target, # TODO: verify that this is actually the same target as in other cases
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/bdo.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Bdo = {
+		dir: TextDirection,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/blockquote.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Blockquote = {
+		cite: Href,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/body.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Body = {
+		onafterprint: JavaScript,
+		onbeforeprint: JavaScript,
+		onbeforeunload: JavaScript,
+		onblur: JavaScript,
+		onerror: JavaScript,
+		onfocus: JavaScript,
+		onhashchange: JavaScript,
+		onlanguagechange: JavaScript,
+		onload: JavaScript,
+		onmessage: JavaScript,
+		onmessageerror: JavaScript,
+		onoffline: JavaScript,
+		ononline: JavaScript,
+		onpageswap: JavaScript,
+		onpagehide: JavaScript,
+		onpagereveal: JavaScript,
+		onpageshow: JavaScript,
+		onpopstate: JavaScript,
+		onresize: JavaScript,
+		onrejectionhandled: JavaScript,
+		onstorage: JavaScript,
+		onunhandledrejection: JavaScript,
+		onunload: JavaScript,
+		alink: Deprecated,
+		background: Deprecated,
+		bgcolor: Deprecated,
+		bottommargin: Deprecated,
+		leftmargin: Deprecated,
+		link: Deprecated,
+		rightmargin: Deprecated,
+		text: Deprecated,
+		topmargin: Deprecated,
+		vlink: Deprecated,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/br.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Br = {
+		clear: Deprecated,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/button.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Button = {
+		autofocus: _Boolean,
+		command: _Union(
+			Enum(
+				:show_modal,
+				:close,
+				:request_close,
+				:show_popover,
+				:hide_popover,
+				:toggle_popover,
+			),
+			_String(/\A--/),
+		),
+		commandfor: DOMID,
+		disabled: _Boolean,
+		form: DOMID,
+		formaction: Href,
+		formenctype: FormEncoding,
+		formmethod: FormMethod,
+		formnovalidate: _Boolean,
+		formtarget: Target, # TODO: verify this is actually the same target
+		name: String,
+		popovertarget: DOMID,
+		popovertargetaction: PopoverTargetAction,
+		type: Enum(
+			:submit,
+			:reset,
+			:button
+		),
+		value: String,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/canvas.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Canvas = {
+		height: Integer,
+		width: Integer,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/caption.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Caption = {
+		align: Deprecated,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/col.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Col = {
+		span: UInt,
+		align: Deprecated,
+		bgcolor: Deprecated,
+		char: Deprecated,
+		charoff: Deprecated,
+		valign: Deprecated,
+		width: Deprecated,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/data.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Data = {
+		value: Value,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/del.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Del = {
+		cite: Href,
+		datetime: DateTimeString,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/details.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Details = {
+		open: _Boolean,
+		name: String,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/dfn.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Dfn = {
+		title: String,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/dialog.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Dialog = {
+		tabindex: _Never,
+		open: _Boolean,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/div.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Div = {
+		align: Deprecated,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/embed.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Embed = {
+		height: UInt,
+		src: Href,
+		type: MimeType,
+		width: UInt,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/fencedframe.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Fencedframe = {
+		allow: String,
+		height: UInt,
+		width: UInt,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/fieldset.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Fieldset = {
+			disabled: _Boolean,
+			form: DOMID,
+			name: String,
+		}.freeze
+end

data/lib/phlex/validator/html/attributes/form.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Form = {
+		accept: Deprecated,
+		accept_charset: String, # TODO: comma-separated list of charsets
+		autocomplete: Toggle,
+		name: _String(length: 1..), # TODO: must be unique among the form elements in form collection that its in if any
+		rel: SpaceSeparatedList(FormRel),
+		action: Href,
+		enctype: FormEncoding,
+		method: FormMethod,
+		novalidate: _Boolean,
+		target: Target, # TODO: this may need to be a custom enumeration
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/global.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Global = {
+		accesskey: Tokens,
+		autocapitalize: Enum(
+			:on,
+			:off,
+			:none,
+			:sentences,
+			:words,
+			:characters
+		),
+		autocorrect: Toggle,
+		autofocus: _Boolean,
+		class: Tokens,
+		contenteditable: Enum(
+			:true,
+			:false,
+			:plaintext_only
+		),
+		dir: _Union(
+			Token(:auto),
+			TextDirection,
+		),
+		draggable: EnumeratedBoolean,
+		enterkeyhint: Enum(
+			:enter,
+			:done,
+			:go,
+			:next,
+			:previous,
+			:search,
+			:send
+		),
+		exportparts: String, # TODO: investigate updating Phlex to comma-separate tokens passed to this attribute
+		hidden: _Union(
+			_Boolean,
+			Enum(
+				:hidden,
+				:until_found
+			)
+		),
+		id: DOMID,
+		inert: _Boolean,
+		inputmode: InputMode,
+		is: Token,
+		itemid: Token,
+		itemprop: Token,
+		itemref: Tokens,
+		itemscope: _Boolean,
+		itemtype: Token,
+		lang: Language,
+		nonce: Token,
+		part: Token,
+		popover: _Union(
+			_Boolean,
+			Enum(
+				:auto,
+				:hint,
+				:manual
+			)
+		),
+		slot: Token,
+		spellcheck: EnumeratedBoolean,
+		# TODO: figure out style
+		tabindex: Integer,
+		title: String,
+		translate: Affirmation,
+		virtualkeyboardpolicy: Enum(:auto, :manual),
+		writingsuggestions: EnumeratedBoolean,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/head.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Head = {
+		profile: Tokens, # TODO: improve this
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/hr.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Hr = {
+		align: Deprecated,
+		color: Deprecated,
+		noshade: Deprecated,
+		size: Deprecated,
+		width: Deprecated,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/html.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::HTML = {
+		version: Deprecated,
+		xmlns: String,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/iframe.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Iframe = {
+		allow: String,
+		allowfullscreen: Deprecated,
+		allowpaymentrequest: Deprecated,
+		browsingtopics: _Boolean,
+		credentialless: _Boolean,
+		csp: String, # TODO: improve this
+		height: UInt,
+		loading: Enum(
+			:eager,
+			:lazy
+		),
+		name: String,
+		referrerpolicy: ReferrerPolicy, # TODO: improve this
+		sandbox: Enum(
+			:allow_downloads,
+			:allow_forms,
+			:allow_modals,
+			:allow_orientation_lock,
+			:allow_pointer_lock,
+			:allow_popups,
+			:allow_popups_to_escape_sandbox,
+			:allow_presentation,
+			:allow_same_origin,
+			:allow_scripts,
+			:allow_storage_access_by_user_activation,
+			:allow_top_navigation,
+			:allow_top_navigation_by_user_activation,
+			:allow_top_navigation_to_custom_protocols
+		),
+		src: Href,
+		srcdoc: Phlex::HTML::SafeObject,
+		width: UInt,
+		align: Deprecated,
+		frameborder: Deprecated,
+		longdesc: Deprecated,
+		marginheight: Deprecated,
+		marginwidth: Deprecated,
+		scrolling: Deprecated,
+	}.freeze
+end

data/lib/phlex/validator/html/attributes/img.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Phlex::Validator::HTML
+	Attributes::Img = {
+		alt: String,
+		attributionsrc: AttributionSource,
+		crossorigin: CrossOrigin,
+		decoding: Enum(
+			:sync,
+			:async,
+			:auto
+		),
+		elementtiming: String,
+		fetchpriority: FetchPriority,
+		height: UInt,
+		ismap: _Boolean,
+		loading: Enum(
+			:eager,
+			:lazy
+		),
+		referrerpolicy: ReferrerPolicy,
+		sizes: String, # todo comma-separated list of sizes
+		src: Href,
+		srcset: String, # todo: comma-separated list
+		width: UInt,
+		usemap: _String(/^#/),
+		align: Deprecated,
+		border: Deprecated,
+		hspace: Deprecated,
+		longdesc: Deprecated,
+		name: Deprecated,
+		vspace: Deprecated,
+	}.freeze
+end