phlex 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e074c926f013d613e2523b41c8dd604758d087c64d377b50a343c651b0164c0d
-  data.tar.gz: 56019e811dff06ef053adfeb20160fe29c247ee2e2f37848eba1580d240c41fd
+  metadata.gz: f1a287ded1bcdc949fef4ca4ae24eb7870a83f9eb90c02d1cdd04152e1606ea1
+  data.tar.gz: 0aa47c95c2a46aacf2845f8bd58af88683b5283554c8f0e90d0199386505ef14
 SHA512:
-  metadata.gz: 24489ae7f67415aa23ce258d6a121fe37418ce32e543888410b730821feeafd5fda6f164dd6f390f9dd4a0ec7a8a92ae5c50deb53376f95f987203ad4da2acf2
-  data.tar.gz: 1ddfa0b6dff09c597cec5f77f521faf89344981e4f3ddd3237722d94cb4d4faeec0d385a7ef4a0a18acec770d7f22811ac489ae94dfdfc3fc92fbf1cbb676f20
+  metadata.gz: 9cc696d354b00376956a4574c27f00851c3ad0b0598132dcb301cccf65a9b5d95cf35adc2032afb47b53ff9f52899090b3657113d4d8483e3d410efdf19478e0
+  data.tar.gz: 9cd0b3c7a746f58faaf77bcd0502fb96721889622e6cc1bf0e7b9e2f97f859bb8562fd800609ee5d964f9b1cee39e31c2c66c72ff0fba93653c6d4fc6ac85bc4

data/.rubocop.yml

@@ -14,7 +14,8 @@ Layout/CaseIndentation:
 Style/StringConcatenation:
   Enabled: false
 
-
+Style/CaseEquality:
+  Enabled: false
 
 Security/Eval:
   Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/Gemfile

@@ -7,7 +7,6 @@ gemspec
 
 gem "rubocop"
 gem "sus"
-gem "syntax_suggest"
 gem "zeitwerk"
 gem "benchmark-ips"
 gem "erb"

data/README.md

@@ -14,6 +14,12 @@ If you run into any trouble, please [start a discussion](https://github.com/joel
 
 Everyone interacting in Phlex codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joeldrapper/phlex/blob/main/CODE_OF_CONDUCT.md).
 
+### Who uses Phlex?
+
+- [Clearscope](https://www.clearscope.io)
+
+*If you can share that your company uses Phlex in production, please open a PR to list it here.*
+
 ### Sponsorship 💖
 
 Maintaining a library is a lot of work. If your company benefits from this work or is likely to benefit from it in the future, please consider [sponsorship](https://github.com/sponsors/joeldrapper). Phlex is actively developed and maintained by **[Joel Drapper](https://github.com/sponsors/joeldrapper)**.
@@ -25,3 +31,15 @@ If you’ve found a potential security issue, please email [security@phlex.fun](
 ### Thanks 🙏
 
 Thanks [Logology](https://www.logology.co) for sponsoring our logo.
+
+### Prior Art 🎨
+
+- [markaby](https://github.com/markaby/markaby)
+- [erector](https://github.com/erector/erector)
+- [papercraft](https://github.com/digital-fabric/papercraft)
+- [matestack](https://github.com/matestack/matestack-ui-core)
+- [arbre](https://github.com/activeadmin/arbre)
+- [tubby](https://github.com/judofyr/tubby)
+- [hoshi](https://github.com/pete/hoshi)
+- [hyperstack](https://github.com/hyperstack-org/hyperstack)
+- [clearwater](https://github.com/clearwater-rb/clearwater)

data/lib/phlex/black_hole.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Phlex
+	module BlackHole
+		extend self
+
+		def <<(anything)
+			self
+		end
+
+		def length
+			0
+		end
+	end
+end

data/lib/phlex/buffered.rb

@@ -10,8 +10,8 @@ module Phlex
 		end
 
 		# Alias output methods to this
-		def __output_method__(*args, **kwargs, &block)
-			output = __getobj__.public_send(__callee__, *args, **kwargs, &block)
+		def __output_method__(...)
+			output = __getobj__.public_send(__callee__, ...)
 			@buffer << output if output.is_a? String
 			nil
 		end

data/lib/phlex/deferred_render.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Phlex
+	module DeferredRender
+		include Experimental
+	end
+end

data/lib/phlex/elements.rb

@@ -13,11 +13,11 @@ module Phlex
         def #{element}(**attributes, &block)
           if attributes.length > 0
             if block_given?
-              @_target << "<#{tag}" << (Phlex::ATTRIBUTE_CACHE[attributes.hash] || _attributes(**attributes)) << ">"
+              @_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}>"
+              @_target << "<#{tag}" << (Phlex::ATTRIBUTE_CACHE[attributes.hash] || __attributes__(**attributes)) << "></#{tag}>"
             end
           else
             if block_given?
@@ -31,6 +31,8 @@ module Phlex
 
           nil
         end
+
+				alias_method :_#{element}, :#{element}
 			RUBY
 		end
 
@@ -40,13 +42,15 @@ module Phlex
 
         def #{element}(**attributes)
           if attributes.length > 0
-            @_target << "<#{tag}" << (Phlex::ATTRIBUTE_CACHE[attributes.hash] || _attributes(**attributes)) << ">"
+            @_target << "<#{tag}" << (Phlex::ATTRIBUTE_CACHE[attributes.hash] || __attributes__(**attributes)) << ">"
           else
             @_target << "<#{tag}>"
           end
 
           nil
         end
+
+				alias_method :_#{element}, :#{element}
 			RUBY
 		end
 	end

data/lib/phlex/experimental.rb

@@ -4,7 +4,7 @@ module Phlex
 	module Experimental
 		def before_template
 			if Phlex.configuration.experimental_warnings
-				puts "Warning: #{self.class.name} is experimental and subject to change."
+				puts "Warning: #{self.class.name} is using experimental Phlex features that are subject to change."
 			end
 
 			super

data/lib/phlex/helpers.rb

@@ -15,12 +15,12 @@ module Phlex::Helpers
 
 			if truthy
 				case token
-					when Hash then _append_token(tokens, token[:then])
-					else _append_token(tokens, token)
+					when Hash then __append_token__(tokens, token[:then])
+					else __append_token__(tokens, token)
 				end
 			else
 				case token
-					when Hash then _append_token(tokens, token[:else])
+					when Hash then __append_token__(tokens, token[:else])
 				end
 			end
 		end
@@ -28,7 +28,7 @@ module Phlex::Helpers
 		tokens.join(" ")
 	end
 
-	private def _append_token(tokens, token)
+	private def __append_token__(tokens, token)
 		case token
 			when nil then nil
 			when String then tokens << token

data/lib/phlex/html.rb

@@ -131,22 +131,44 @@ module Phlex
 
 		class << self
 			attr_accessor :rendered_at_least_once
+
+			def call(...)
+				new(...).call
+			end
+			alias_method :render, :call
+
+			def new(*args, **kwargs, &block)
+				if block
+					object = super(*args, **kwargs, &nil)
+					object.instance_variable_set(:@_content_block, block)
+					object
+				else
+					super
+				end
+			end
 		end
 
 		def call(buffer = +"", view_context: nil, parent: nil, &block)
-			return buffer unless render?
-
 			@_target = buffer
 			@_view_context = view_context
 			@_parent = parent
 
+			block ||= @_content_block
+
+			return buffer unless render?
+
 			around_template do
-				if block_given?
-					template do |*args|
-						if args.length > 0
-							yield_content_with_args(*args, &block)
-						else
-							yield_content(&block)
+				if block
+					if DeferredRender === self
+						__vanish__(self, &block)
+						template
+					else
+						template do |*args|
+							if args.length > 0
+								yield_content_with_args(*args, &block)
+							else
+								yield_content(&block)
+							end
 						end
 					end
 				else
@@ -154,12 +176,12 @@ module Phlex
 				end
 			end
 
-			self.class.rendered_at_least_once ||= true
+			self.class.rendered_at_least_once = true
 
 			buffer
 		end
 
-		def render(renderable, *args, **kwargs, &block)
+		def render(renderable, &block)
 			case renderable
 			when Phlex::HTML
 				renderable.call(@_target, view_context: @_view_context, parent: self, &block)
@@ -191,7 +213,7 @@ module Phlex
 				case content
 					when String then content
 					when Symbol then content.name
-					when Integer, Float then content.to_s
+					when Integer then content.to_s
 					else format_object(content) || content.to_s
 				end
 			)
@@ -223,12 +245,13 @@ module Phlex
 			nil
 		end
 
-		def unsafe_raw(content = nil, &block)
-			@_target << (content || instance_exec(&block))
-			nil
+		def unsafe_raw(content = nil)
+			return nil unless content
+
+			@_target << content
 		end
 
-		def capture(&block)
+		def capture
 			return unless block_given?
 
 			original_buffer = @_target
@@ -237,9 +260,23 @@ module Phlex
 
 			yield
 
+			new_buffer
+		ensure
 			@_target = original_buffer
+		end
 
-			new_buffer
+		# Like `capture` but the output is vanished into a BlackHole buffer.
+		# Becuase the BlackHole does nothing with the output, this should be faster.
+		def __vanish__(*args)
+			return unless block_given?
+
+			original_buffer = @_target
+			@_target = BlackHole
+
+			yield(*args)
+			nil
+		ensure
+			@_target = original_buffer
 		end
 
 		# Default render predicate can be overridden to prevent rendering
@@ -247,8 +284,11 @@ module Phlex
 			true
 		end
 
-		private def format_object(oject)
-			nil
+		private def format_object(object)
+			case object
+			when Float
+				object.to_s
+			end
 		end
 
 		private def around_template
@@ -265,7 +305,7 @@ module Phlex
 			nil
 		end
 
-		private def yield_content(&block)
+		private def yield_content
 			return unless block_given?
 
 			original_length = @_target.length
@@ -278,7 +318,7 @@ module Phlex
 					@_target << ERB::Util.html_escape(content)
 				when Symbol
 					@_target << ERB::Util.html_escape(content.name)
-				when Integer, Float
+				when Integer
 					@_target << ERB::Util.html_escape(content.to_s)
 				else
 					if (formatted_object = format_object(content))
@@ -290,7 +330,7 @@ module Phlex
 			nil
 		end
 
-		private def yield_content_with_args(*args, &block)
+		private def yield_content_with_args(*args)
 			return unless block_given?
 
 			original_length = @_target.length
@@ -315,13 +355,13 @@ module Phlex
 			nil
 		end
 
-		private def _attributes(**attributes)
+		private def __attributes__(**attributes)
 			if attributes[:href]&.start_with?(/\s*javascript/)
 				attributes[:href] = attributes[:href].sub(/^\s*(javascript:)+/, "")
 			end
 
 			buffer = +""
-			_build_attributes(attributes, buffer: buffer)
+			__build_attributes__(attributes, buffer: buffer)
 
 			unless self.class.rendered_at_least_once
 				Phlex::ATTRIBUTE_CACHE[attributes.hash] = buffer.freeze
@@ -330,7 +370,7 @@ module Phlex
 			buffer
 		end
 
-		private def _build_attributes(attributes, buffer:)
+		private def __build_attributes__(attributes, buffer:)
 			attributes.each do |k, v|
 				next unless v
 
@@ -353,7 +393,14 @@ module Phlex
 				when Symbol
 					buffer << " " << name << '="' << ERB::Util.html_escape(v.name) << '"'
 				when Hash
-					_build_attributes(v.transform_keys { "#{k}-#{_1.name.tr('_', '-')}" }, buffer: buffer)
+					__build_attributes__(
+						v.transform_keys { |subkey|
+							case subkey
+								when Symbol then"#{k}-#{subkey.name.tr('_', '-')}"
+								else "#{k}-#{subkey}"
+							end
+						}, buffer: buffer
+					)
 				else
 					buffer << " " << name << '="' << ERB::Util.html_escape(v.to_s) << '"'
 				end
@@ -361,5 +408,14 @@ module Phlex
 
 			buffer
 		end
+
+		# This should be the last method defined
+		def self.method_added(method_name)
+			if method_name[0] == "_" && Phlex::HTML.instance_methods.include?(method_name) && instance_method(method_name).owner != Phlex::HTML
+				raise NameError, "👋 Redefining the method `#{name}##{method_name}` is not a good idea."
+			end
+
+			super
+		end
 	end
 end

data/lib/phlex/unbuffered.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Phlex
+	class Unbuffered < BasicObject
+		CACHE = {}
+
+		def self.call(object)
+			decorator = CACHE[object.class.name] ||= ::Class.new(self)
+			decorator.new(object)
+		end
+
+		def initialize(object)
+			@object = object
+		end
+
+		def inspect
+			"Unbuffered(#{@object.class.name})[object: #{@object.inspect}]"
+		end
+
+		# Borrow some important methods from Object
+		define_method :__class__,
+			::Object.instance_method(:class)
+
+		define_method :__public_send__,
+			::Object.instance_method(:public_send)
+
+		define_method :__callee__,
+			::Object.instance_method(:__callee__)
+
+		def respond_to_missing?(...)
+			@object.respond_to?(...)
+		end
+
+		def method_missing(name, *args, &block)
+			if @object.respond_to?(name)
+				# If the object responds to this method, we want to define it by aliasing the __output_method__.
+				__class__.alias_method(name, :__output_method__)
+
+				# Now we've defined this missing method, we can call it.
+				__public_send__(name, *args, &block)
+			else
+				super
+			end
+		end
+
+		# This method is designed to be aliased and references the callee which is whatever alias you called.
+		def __output_method__(*args, &block)
+			@object.capture { @object.public_send(__callee__, *args, &block) }
+		end
+
+		def __forward_method__(*args, &block)
+			@object.public_send(__callee__, *args, &block)
+		end
+
+		# Forward some methods to the original underlying method
+		alias_method :call, :__forward_method__
+		alias_method :send, :__forward_method__
+		alias_method :public_send, :__forward_method__
+	end
+end

data/lib/phlex/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlex
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Joel Drapper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-08 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -33,6 +33,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".rubocop.yml"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
@@ -46,18 +47,19 @@ files:
 - fixtures/view_helper.rb
 - lib/overrides/symbol/name.rb
 - lib/phlex.rb
+- lib/phlex/black_hole.rb
 - lib/phlex/buffered.rb
 - lib/phlex/callable.rb
 - lib/phlex/collection.rb
 - lib/phlex/configuration.rb
+- lib/phlex/deferred_render.rb
 - lib/phlex/elements.rb
 - lib/phlex/experimental.rb
 - lib/phlex/helpers.rb
 - lib/phlex/html.rb
 - lib/phlex/table.rb
 - lib/phlex/testing/view_helper.rb
-- lib/phlex/turbo/frame.rb
-- lib/phlex/turbo/stream.rb
+- lib/phlex/unbuffered.rb
 - lib/phlex/version.rb
 - phlex_logo.png
 - sig/phlex.rbs
@@ -85,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.25
+rubygems_version: 3.4.4
 signing_key:
 specification_version: 4
 summary: A framework for building views in Ruby.

data/lib/phlex/turbo/frame.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Phlex
-	module Turbo
-		class Frame < Phlex::HTML
-			include Experimental
-
-			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

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