phlex 0.4.0 → 0.5.0

data/lib/phlex.rb

@@ -1,34 +1,39 @@
 # frozen_string_literal: true
 
-require "cgi"
+require "hescape"
 require "zeitwerk"
 require "syntax_tree"
 
-loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
-loader.ignore("#{__dir__}/generators")
-loader.ignore("#{__dir__}/install")
-loader.inflector.inflect("html" => "HTML")
-loader.inflector.inflect("vcall" => "VCall")
-loader.inflector.inflect("fcall" => "FCall")
-loader.setup
-
 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/rails.rb")
+		loader.ignore("#{__dir__}/phlex/rails")
+
+		loader.inflector.inflect("html" => "HTML")
+		loader.inflector.inflect("vcall" => "VCall")
+		loader.inflector.inflect("fcall" => "FCall")
+		loader.setup
+	end
+
 	Error = Module.new
 	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 = {}
 
-	def const_missing(name)
-		if name == :Component
-			raise NameError, "👋 Phlex::Component is now Phlex::View"
-		else
-			super
-		end
-	end
-
 	def configuration
 		@configuration ||= Configuration.new
 	end
@@ -37,10 +42,3 @@ module Phlex
 		yield configuration
 	end
 end
-
-begin
-	require "rails"
-	require "phlex/engine"
-rescue LoadError
-	# Rails isn't in this env, don't load the engine.
-end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: phlex
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Joel Drapper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-12 00:00:00.000000000 Z
+date: 2022-11-15 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
@@ -60,7 +74,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
-- ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -72,6 +85,7 @@ files:
 - SECURITY.md
 - bench.rb
 - config.ru
+- config/sus.rb
 - docs/assets/application.css
 - docs/assets/logo.png
 - docs/build.rb
@@ -99,8 +113,14 @@ files:
 - 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/compilation/vcall.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
@@ -108,6 +128,7 @@ files:
 - 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
@@ -125,11 +146,17 @@ files:
 - fixtures/dummy/public/favicon.ico
 - fixtures/layout.rb
 - fixtures/page.rb
-- fixtures/test_helper.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
@@ -147,26 +174,47 @@ files:
 - 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/standard_element.rb
-- lib/phlex/compiler/generators/void_element.rb
-- lib/phlex/compiler/optimizers/base_optimizer.rb
-- lib/phlex/compiler/optimizers/vcall.rb
-- lib/phlex/compiler/visitors/base_visitor.rb
-- lib/phlex/compiler/visitors/component.rb
-- lib/phlex/compiler/visitors/component_method.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/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/phlex/view.rb
 - lib/tasks/phlex_tasks.rake
 - package-lock.json
 - package.json
@@ -197,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.25
 signing_key:
 specification_version: 4
 summary: A framework for building views with a Ruby DSL.

data/.rspec

@@ -1 +0,0 @@
---require spec_helper

data/fixtures/compilation/vcall.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Fixtures
-	module Compilation
-		module VCall
-			class WithStandardElement < Phlex::View
-				def template
-					div
-				end
-			end
-
-			class WithVoidElement < Phlex::View
-				def template
-					img
-				end
-			end
-
-			class WithAnotherMethodCall < Phlex::View
-				def template
-					article
-					some_other_method
-					article
-				end
-			end
-
-			class WithRedefinedTagMethod < Phlex::View
-				def template
-					title
-					article
-				end
-
-				def title
-					h1
-				end
-			end
-		end
-	end
-end

data/lib/phlex/compiler/generators/standard_element.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Phlex
-	class Compiler
-		module Generators
-			class StandardElement
-				def initialize(formatter, method_name:, arguments: nil)
-					@formatter = formatter
-					@method_name = method_name
-				end
-
-				def call
-					@formatter.append do |f|
-						f.text "<"
-						f.text tag
-						f.text ">"
-
-						f.text "</"
-						f.text tag
-						f.text ">"
-					end
-				end
-
-				def tag
-					HTML::STANDARD_ELEMENTS[@method_name]
-				end
-			end
-		end
-	end
-end

data/lib/phlex/compiler/generators/void_element.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Phlex
-	class Compiler
-		module Generators
-			class VoidElement
-				def initialize(formatter, method_name:, arguments: nil)
-					@formatter = formatter
-					@method_name = method_name
-					@arguments = arguments
-				end
-
-				def call
-					@formatter.append do |f|
-						f.text "<"
-						f.text tag
-						f.text " />"
-					end
-				end
-
-				private
-
-				def tag
-					HTML::VOID_ELEMENTS[@method_name]
-				end
-			end
-		end
-	end
-end

data/lib/phlex/compiler/optimizers/base_optimizer.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Phlex
-	class Compiler
-		module Optimizers
-			class BaseOptimizer
-				def initialize(node, compiler:)
-					@node = node
-					@compiler = compiler
-				end
-
-				def call
-					if standard_element?
-						@node.extend(self.class::StandardElement)
-					elsif void_element?
-						@node.extend(self.class::VoidElement)
-					else
-						false
-					end
-				end
-
-				private
-
-				def standard_element?
-					HTML::STANDARD_ELEMENTS[name] && !@compiler.redefined?(name)
-				end
-
-				def void_element?
-					HTML::VOID_ELEMENTS[name] && !@compiler.redefined?(name)
-				end
-			end
-		end
-	end
-end

data/lib/phlex/compiler/optimizers/vcall.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Phlex
-	class Compiler
-		module Optimizers
-			class VCall < BaseOptimizer
-				module StandardElement
-					def format(formatter)
-						Generators::StandardElement.new(formatter,
-							method_name: value.value.to_sym).call
-					end
-				end
-
-				module VoidElement
-					def format(formatter)
-						Generators::VoidElement.new(formatter,
-							method_name: value.value.to_sym).call
-					end
-				end
-
-				private
-
-				def name
-					@node.value.value.to_sym
-				end
-			end
-		end
-	end
-end

data/lib/phlex/compiler/visitors/base_visitor.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Phlex
-	class Compiler
-		module Visitors
-			class BaseVisitor < SyntaxTree::Visitor
-				def initialize(compiler = nil)
-					@compiler = compiler
-				end
-
-				private
-
-				def format(node)
-					Formatter.format("", node)
-				end
-			end
-		end
-	end
-end

data/lib/phlex/compiler/visitors/component.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Phlex
-	class Compiler
-		module Visitors
-			class Component < BaseVisitor
-				visit_method def visit_def(node)
-					visitor = Visitors::ComponentMethod.new(@compiler)
-					visitor.visit_all(node.child_nodes)
-
-					if visitor.optimized_something?
-						@compiler.redefine(
-							format(node)
-						)
-					end
-				end
-
-				visit_method def visit_class(node)
-					nil
-				end
-
-				visit_method def visit_module(node)
-					nil
-				end
-			end
-		end
-	end
-end

data/lib/phlex/compiler/visitors/component_method.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Phlex
-	class Compiler
-		module Visitors
-			class ComponentMethod < BaseVisitor
-				def optimized_something?
-					!!@optimized_something
-				end
-
-				visit_method def visit_vcall(node)
-					@optimized_something = Optimizers::VCall.new(node,
-						compiler: @compiler).call
-
-					super
-				end
-
-				visit_method def visit_class(node)
-					nil
-				end
-
-				visit_method def visit_module(node)
-					nil
-				end
-			end
-		end
-	end
-end

data/lib/phlex/view.rb

@@ -1,229 +0,0 @@
-# frozen_string_literal: true
-
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.0")
-	using Overrides::Symbol::Name
-end
-
-module Phlex
-	class View
-		extend HTML
-		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)
-			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
-
-		HTML::STANDARD_ELEMENTS.each do |method_name, tag|
-			register_element(method_name, tag: tag)
-		end
-
-		HTML::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 << case content
-			when String then CGI.escape_html(content)
-			when Symbol then CGI.escape_html(content.name)
-			else CGI.escape_html(content.to_s)
-			end
-
-			nil
-		end
-
-		def whitespace
-			@_target << " "
-			nil
-		end
-
-		def comment(content = "")
-			@_target << "<!-- " << CGI.escape_html(content.to_s) << " -->"
-			nil
-		end
-
-		def doctype
-			@_target << HTML::DOCTYPE
-			nil
-		end
-
-		def 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 CGI.escape_html(value)
-				when Symbol then CGI.escape_html(value.name)
-				else CGI.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 classes(*tokens, **conditional_tokens)
-			tokens = self.tokens(*tokens, **conditional_tokens)
-
-			if tokens.present?
-				{ class: tokens }
-			else
-				{}
-			end
-		end
-
-		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."
-				end
-
-				case token
-				when Symbol then tokens << token.name
-				when String then tokens << token
-				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 helpers
-			@_view_context
-		end
-
-		def _attributes(attributes, buffer: +"")
-			if attributes[:href]&.start_with?(/\s*javascript/)
-				attributes[:href] = attributes[:href].sub(/^\s*(javascript:)+/, "")
-			end
-
-			_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 << '="' << CGI.escape_html(v) << '"'
-				when Symbol
-					buffer << " " << name << '="' << CGI.escape_html(v.name) << '"'
-				when Hash
-					_build_attributes(v.transform_keys { "#{k}-#{_1.name.tr('_', '-')}" }, buffer: buffer)
-				else
-					buffer << " " << name << '="' << CGI.escape_html(v.to_s) << '"'
-				end
-			end
-
-			buffer
-		end
-	end
-end