phlex 0.5.2 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1963e4672b4434ef044665281037002385c31fbb8ac685d1726142f1639058f
-  data.tar.gz: 0ee1545f37c63e1fee9c52ba8a0bbbb9d36bc115f531ca1fcb7ca453c8ebe80d
+  metadata.gz: 3d4cbcb774d4dca95d1cb9740c0a002fd394c6887dec1e1cabe543c87f94308b
+  data.tar.gz: 1df41572816aefd255defc3ceace6e4c5eaeb5f462d26e2605fc751a4ea3d3d0
 SHA512:
-  metadata.gz: c43e0ea3c3cbeebf1f8db41ecb108c217265d7dad4fa2feca4b735e09885606c4e0653467a237c4c3a1dc758af55e31cc11a0443af9b5bf319b01a30ae0728a9
-  data.tar.gz: f735047df1f5b0a95bc648f2d78d32b8cc0d254b25f7cac4f966eb5ac28d78befacff005aa5297a5251e781718a7c5859bc8816d4ed5f799d715f0e59bba9e85
+  metadata.gz: 589006a44bc566ce1e1dfc90f1e05e9b3f6c7871c9686ba3670fd36b68b1318449b05cc2268c865b89779126092065a7d69cde793d753ea8d7dcaf268d8e1e9e
+  data.tar.gz: c7a960b66cd78bb9605cb37408bc6a044167ec912a249b40e46e58dd07e398e5a122737a28246e3eac2945a65156b72e57fb35096069719be3c4faa72b007ef7

data/Gemfile

@@ -5,32 +5,13 @@ 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"
 
 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

@@ -5,6 +5,8 @@ if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.0")
 end
 
 module Phlex::Helpers
+	private
+
 	def tokens(*tokens, **conditional_tokens)
 		conditional_tokens.each do |condition, token|
 			case condition

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,35 +182,17 @@ 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)
-
-			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)
+			when String
+				@_target << CGI.escape_html(content)
+			when Symbol
+				@_target << CGI.escape_html(content.name)
+			when Integer, Float
+				@_target << CGI.escape_html(content.to_s)
 			end
+
+			nil
 		end
 
 		def whitespace
@@ -225,8 +206,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 +224,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 +235,44 @@ module Phlex
 
 			@_target = original_buffer
 
-			new_buffer.html_safe
+			new_buffer
+		end
+
+		private
+
+		def around_template
+			before_template
+			yield
+			after_template
+		end
+
+		def before_template
+			nil
+		end
+
+		def after_template
+			nil
 		end
 
-		def helpers
-			@_view_context
+		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 << CGI.escape_html(content)
+				when Symbol
+					@_target << CGI.escape_html(content.name)
+				when Integer, Float
+					@_target << CGI.escape_html(content.to_s)
+				end
+			end
+
+			nil
 		end
 
 		def _attributes(**attributes)
@@ -306,14 +295,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 +309,13 @@ module Phlex
 				when true
 					buffer << " " << name
 				when String
-					buffer << " " << name << '="' << Hescape.escape_html(v) << '"'
+					buffer << " " << name << '="' << CGI.escape_html(v) << '"'
 				when Symbol
-					buffer << " " << name << '="' << Hescape.escape_html(v.name) << '"'
+					buffer << " " << name << '="' << CGI.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) << '"'
+					buffer << " " << name << '="' << CGI.escape_html(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.2"
+	VERSION = "1.0.0.rc1"
 end

data/lib/phlex.rb

@@ -1,23 +1,12 @@
 # frozen_string_literal: true
 
-require "hescape"
+require "cgi"
 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")
-
-		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 = {}

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: phlex
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Joel Drapper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2022-11-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: hescape
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: syntax_tree
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-- !ruby/object:Gem::Dependency
-  name: view_component
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
 description: A high-performance view framework optimised for developer happiness.
 email:
 - joel@drapper.me
@@ -79,148 +37,30 @@ files:
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
-- Procfile.dev
 - README.md
-- Rakefile
 - SECURITY.md
 - bench.rb
-- config.ru
 - config/sus.rb
-- docs/assets/application.css
-- docs/assets/logo.png
-- docs/build.rb
-- docs/components/callout.rb
-- docs/components/code_block.rb
-- docs/components/code_span.rb
-- docs/components/example.rb
-- docs/components/heading.rb
-- docs/components/layout.rb
-- docs/components/markdown.rb
-- docs/components/nav.rb
-- docs/components/nav/item.rb
-- docs/components/tabs.rb
-- docs/components/tabs/tab.rb
-- docs/components/title.rb
-- docs/page_builder.rb
-- docs/pages/application_page.rb
-- docs/pages/helpers.rb
-- docs/pages/index.rb
-- docs/pages/library/collections.rb
-- docs/pages/rails/getting_started.rb
-- docs/pages/rails/helpers.rb
-- docs/pages/rails/layouts.rb
-- docs/pages/rails/migrating.rb
-- docs/pages/rails/rendering_views.rb
-- docs/pages/rails_integration.rb
-- docs/pages/templates.rb
-- docs/pages/testing/capybara.rb
-- docs/pages/testing/getting_started.rb
-- docs/pages/testing/nokogiri.rb
-- docs/pages/testing/rails.rb
-- docs/pages/translations.rb
-- docs/pages/views.rb
-- fixtures/compiler_test_helpers.rb
-- fixtures/content.rb
-- fixtures/dummy/app/assets/config/manifest.js
-- fixtures/dummy/app/components/comment_component.html.erb
-- fixtures/dummy/app/components/comment_component.rb
-- fixtures/dummy/app/components/reaction_component.html.erb
-- fixtures/dummy/app/components/reaction_component.rb
-- fixtures/dummy/app/controllers/articles_controller.rb
-- fixtures/dummy/app/controllers/comments_controller.rb
-- fixtures/dummy/app/views/application_view.rb
-- fixtures/dummy/app/views/articles/form.rb
-- fixtures/dummy/app/views/articles/index.html.erb
-- fixtures/dummy/app/views/articles/new.html.erb
-- fixtures/dummy/app/views/card.rb
-- fixtures/dummy/app/views/comments/comment.rb
-- fixtures/dummy/app/views/comments/index.html.erb
-- fixtures/dummy/app/views/comments/reaction.rb
-- fixtures/dummy/app/views/comments/show.html.erb
-- fixtures/dummy/app/views/heading.rb
-- fixtures/dummy/config/database.yml
-- fixtures/dummy/config/routes.rb
-- fixtures/dummy/config/storage.yml
-- fixtures/dummy/db/schema.rb
-- fixtures/dummy/log/.gitignore
-- fixtures/dummy/public/favicon.ico
 - fixtures/layout.rb
 - fixtures/page.rb
-- fixtures/rails_helper.rb
-- fixtures/standard_element.rb
 - fixtures/view_helper.rb
-- fixtures/void_element.rb
-- lib/generators/phlex/collection/USAGE
-- lib/generators/phlex/collection/collection_generator.rb
-- lib/generators/phlex/collection/templates/collection.rb.erb
-- lib/generators/phlex/controller/USAGE
-- lib/generators/phlex/controller/controller_generator.rb
-- lib/generators/phlex/controller/templates/controller.rb.erb
-- lib/generators/phlex/controller/templates/view.rb.erb
-- lib/generators/phlex/layout/USAGE
-- lib/generators/phlex/layout/layout_generator.rb
-- lib/generators/phlex/layout/templates/layout.rb.erb
-- lib/generators/phlex/page/USAGE
-- lib/generators/phlex/page/page_generator.rb
-- lib/generators/phlex/page/templates/page.rb.erb
-- lib/generators/phlex/table/USAGE
-- lib/generators/phlex/table/table_generator.rb
-- lib/generators/phlex/table/templates/table.rb.erb
-- lib/generators/phlex/view/USAGE
-- lib/generators/phlex/view/templates/view.rb.erb
-- lib/generators/phlex/view/view_generator.rb
-- lib/install/phlex.rb
 - lib/overrides/symbol/name.rb
 - lib/phlex.rb
-- lib/phlex/block.rb
 - lib/phlex/buffered.rb
 - lib/phlex/callable.rb
 - lib/phlex/collection.rb
-- lib/phlex/compiler.rb
-- lib/phlex/compiler/elements.rb
-- lib/phlex/compiler/formatter.rb
-- lib/phlex/compiler/generators/content.rb
-- lib/phlex/compiler/generators/element.rb
-- lib/phlex/compiler/nodes/base.rb
-- lib/phlex/compiler/nodes/call.rb
-- lib/phlex/compiler/nodes/command.rb
-- lib/phlex/compiler/nodes/fcall.rb
-- lib/phlex/compiler/nodes/method_add_block.rb
-- lib/phlex/compiler/nodes/vcall.rb
-- lib/phlex/compiler/optimizer.rb
-- lib/phlex/compiler/visitors/base.rb
-- lib/phlex/compiler/visitors/file.rb
-- lib/phlex/compiler/visitors/stable_scope.rb
-- lib/phlex/compiler/visitors/statements.rb
-- lib/phlex/compiler/visitors/view.rb
-- lib/phlex/compiler/visitors/view_method.rb
 - lib/phlex/configuration.rb
 - lib/phlex/elements.rb
-- lib/phlex/engine.rb
+- lib/phlex/experimental.rb
 - lib/phlex/helpers.rb
 - lib/phlex/html.rb
-- lib/phlex/html/callbacks.rb
-- lib/phlex/markdown.rb
-- lib/phlex/rails.rb
-- lib/phlex/rails/form.rb
-- lib/phlex/rails/helpers.rb
-- lib/phlex/rails/layout.rb
-- lib/phlex/renderable.rb
 - lib/phlex/table.rb
-- lib/phlex/testing/capybara.rb
-- lib/phlex/testing/nokogiri.rb
-- lib/phlex/testing/rails.rb
 - lib/phlex/testing/view_helper.rb
-- lib/phlex/translation.rb
 - lib/phlex/turbo/frame.rb
 - lib/phlex/turbo/stream.rb
 - lib/phlex/version.rb
-- lib/tasks/phlex_tasks.rake
-- package-lock.json
-- package.json
 - phlex_logo.png
 - sig/phlex.rbs
-- tailwind.config.js
 homepage: https://www.phlex.fun
 licenses:
 - MIT
@@ -241,12 +81,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.25
 signing_key:
 specification_version: 4
-summary: A framework for building views with a Ruby DSL.
+summary: A framework for building views in Ruby.
 test_files: []

data/Procfile.dev

@@ -1,3 +0,0 @@
-server: ruby -run -e httpd docs/dist
-docs: bundle exec docs/build.rb --watch
-tailwind: npx tailwindcss -i ./docs/assets/application.css -o ./docs/dist/application.css --watch

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-
-task :sus do
-	sh "bundle exec sus"
-end
-task default: :sus

data/config.ru

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require "rubygems"
-require "bundler"
-
-Bundler.require :default, :development
-
-Combustion.initialize! :all
-run Combustion::Application