phlex 1.0.0.rc2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72f6baa9bd23ce981517a40897f2bb63a1cbd60fbc87bb127883e8eeb36cc302
-  data.tar.gz: 5abc8c59a81cdff51f5da9250a28d9cc42308b467aa662b155fb1d28eca4a1c2
+  metadata.gz: 8eeaf45425023ac13320c99f80956f12ec994395b3d349fc6a443334a6715b6d
+  data.tar.gz: 34672ca973f3bec7ade7cccae08e65fff009b122c5319345dadabf779877269e
 SHA512:
-  metadata.gz: 8db8f9df3da1f218bd2029ea22414ea53a910de8b1810d71c70a0e9022a1353dd69557c91eb1ffee5355733c0d8d6878aae9379a75ee0eaa76d05c6ee20abb8e
-  data.tar.gz: 8027722c6fd1592c86f5fa6150814206a007c12a810985c72231195dcb0089aa34fd91a5addbeb9c14a8137a5a2f3fe984c07f554ee6504a4b4c25d6dd216046
+  metadata.gz: 51d8f8bea886016a71b67a6b29b1b584dc1a95b29c4ac9cc24263a3e94be534e1ddfa89f800c10caf00618f27508828f9fc1b233b2829d0c1016aa484b0db6fc
+  data.tar.gz: 3cf6631189545652f860ec393fb63cf392bedd326271ee0863238a32f213a4704a7505442d4bbd06c7473e036c0dfb31c1f25584615189d801dc2515a25e4799

data/.rubocop.yml

@@ -24,3 +24,7 @@ Style/MethodCallWithoutArgsParentheses:
 
 Style/MixinUsage:
   Enabled: false
+
+Style/AccessModifierDeclarations:
+  Enabled: true
+  EnforcedStyle: inline

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,14 @@ 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)

data/SECURITY.md

@@ -1,5 +1,13 @@
 # Security Policy
 
-## Reporting a Vulnerability
+## Reporting a vulnerability
 
-If you found a possible security vulnerability in Phlex, please email security@phlex.fun.
+If you find a possible security vulnerability, please email security@phlex.fun. Do not create an issue or pull request either demonstrating or fixing the vulnerability.
+
+## Bug bounty
+
+[The Gem Foundation](https://ryanbigg.com/2022/11/the-gem-foundation) has kindly sponsored a $1 bug bounty to discover security vulnerabilities in Phlex.
+
+## Sponsoring a bug bounty
+
+If you wish to sponsor a bug bounty for Phlex, please get in touch with Joel at joel@drapper.me.

data/lib/phlex/collection.rb

@@ -17,9 +17,7 @@ module Phlex
 			@item ? item_template : collection_template { yield_items }
 		end
 
-		private
-
-		def yield_items
+		private def yield_items
 			if @item
 				raise ArgumentError, "You can only yield_items when rendering a collection. You are currently rendering an item."
 			end

data/lib/phlex/configuration.rb

@@ -2,6 +2,12 @@
 
 module Phlex
 	class Configuration
-		# Config coming soon.
+		attr_writer :experimental_warnings
+
+		def experimental_warnings
+			return @experimental_warnings if defined? @experimental_warnings
+
+			true
+		end
 	end
 end

data/lib/phlex/experimental.rb

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

data/lib/phlex/helpers.rb

@@ -5,7 +5,7 @@ if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.0")
 end
 
 module Phlex::Helpers
-	def tokens(*tokens, **conditional_tokens)
+	private def tokens(*tokens, **conditional_tokens)
 		conditional_tokens.each do |condition, token|
 			truthy = case condition
 				when Symbol then send(condition)
@@ -28,7 +28,7 @@ module Phlex::Helpers
 		tokens.join(" ")
 	end
 
-	def _append_token(tokens, token)
+	private def _append_token(tokens, token)
 		case token
 			when nil then nil
 			when String then tokens << token
@@ -39,7 +39,7 @@ module Phlex::Helpers
 		end
 	end
 
-	def classes(*tokens, **conditional_tokens)
+	private def classes(*tokens, **conditional_tokens)
 		tokens = self.tokens(*tokens, **conditional_tokens)
 
 		if tokens.empty?
@@ -49,7 +49,7 @@ module Phlex::Helpers
 		end
 	end
 
-	def mix(*args)
+	private def mix(*args)
 		args.each_with_object({}) do |object, result|
 			result.merge!(object) do |_key, old, new|
 				case new

data/lib/phlex/html.rb

@@ -134,27 +134,39 @@ module Phlex
 		end
 
 		def call(buffer = +"", view_context: nil, parent: nil, &block)
-			return buffer unless render?
-
-			raise "The same view instance shouldn't be rendered twice" if rendered?
-
-			@_rendered = true
 			@_target = buffer
 			@_view_context = view_context
 			@_parent = parent
 
-			around_template { template { yield_content(&block) } }
+			return buffer unless render?
 
-			self.class.rendered_at_least_once ||= true
+			around_template do
+				if block_given?
+					template do |*args|
+						if args.length > 0
+							yield_content_with_args(*args, &block)
+						else
+							yield_content(&block)
+						end
+					end
+				else
+					template
+				end
+			end
+
+			self.class.rendered_at_least_once = true
 
 			buffer
 		end
 
 		def render(renderable, *args, **kwargs, &block)
-			if renderable.is_a?(Phlex::HTML)
+			case renderable
+			when 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."
+			when Class
+				if renderable < Phlex::HTML
+					renderable.new.call(@_target, view_context: @_view_context, parent: self, &block)
+				end
 			else
 				raise ArgumentError, "You can't render a #{renderable}."
 			end
@@ -166,14 +178,6 @@ module Phlex
 			:html
 		end
 
-		def rendered?
-			@_rendered ||= false
-		end
-
-		def render?
-			true
-		end
-
 		STANDARD_ELEMENTS.each do |method_name, tag|
 			register_element(method_name, tag: tag)
 		end
@@ -187,7 +191,8 @@ module Phlex
 				case content
 					when String then content
 					when Symbol then content.name
-					else content.to_s
+					when Integer, Float then content.to_s
+					else format_object(content) || content.to_s
 				end
 			)
 
@@ -219,8 +224,9 @@ module Phlex
 		end
 
 		def unsafe_raw(content = nil, &block)
-			@_target << (content || instance_exec(&block))
-			nil
+			return nil unless content
+
+			@_target << content
 		end
 
 		def capture(&block)
@@ -237,23 +243,30 @@ module Phlex
 			new_buffer
 		end
 
-		private
+		# Default render predicate can be overridden to prevent rendering
+		private def render?
+			true
+		end
+
+		private def format_object(oject)
+			nil
+		end
 
-		def around_template
+		private def around_template
 			before_template
 			yield
 			after_template
 		end
 
-		def before_template
+		private def before_template
 			nil
 		end
 
-		def after_template
+		private def after_template
 			nil
 		end
 
-		def yield_content(&block)
+		private def yield_content(&block)
 			return unless block_given?
 
 			original_length = @_target.length
@@ -268,13 +281,42 @@ module Phlex
 					@_target << ERB::Util.html_escape(content.name)
 				when Integer, Float
 					@_target << ERB::Util.html_escape(content.to_s)
+				else
+					if (formatted_object = format_object(content))
+						@_target << ERB::Util.html_escape(formatted_object)
+					end
+				end
+			end
+
+			nil
+		end
+
+		private def yield_content_with_args(*args, &block)
+			return unless block_given?
+
+			original_length = @_target.length
+			content = yield(*args)
+			unchanged = (original_length == @_target.length)
+
+			if unchanged
+				case content
+				when String
+					@_target << ERB::Util.html_escape(content)
+				when Symbol
+					@_target << ERB::Util.html_escape(content.name)
+				when Integer, Float
+					@_target << ERB::Util.html_escape(content.to_s)
+				else
+					if (formatted_object = format_object(content))
+						@_target << ERB::Util.html_escape(formatted_object)
+					end
 				end
 			end
 
 			nil
 		end
 
-		def _attributes(**attributes)
+		private def _attributes(**attributes)
 			if attributes[:href]&.start_with?(/\s*javascript/)
 				attributes[:href] = attributes[:href].sub(/^\s*(javascript:)+/, "")
 			end
@@ -289,7 +331,7 @@ module Phlex
 			buffer
 		end
 
-		def _build_attributes(attributes, buffer:)
+		private def _build_attributes(attributes, buffer:)
 			attributes.each do |k, v|
 				next unless v
 
@@ -312,7 +354,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

data/lib/phlex/table.rb

@@ -50,13 +50,11 @@ module Phlex
 			child.alias_method :foot_cell, :cell
 		end
 
-		private
-
-		def properties
+		private def properties
 			self.class.properties
 		end
 
-		def collection_template(&block)
+		private def collection_template(&block)
 			table do
 				head_template
 				body_template(&block)
@@ -64,11 +62,11 @@ module Phlex
 			end
 		end
 
-		def item_template
+		private def item_template
 			row_template
 		end
 
-		def head_template
+		private def head_template
 			if self.class.properties.any? { |p| p[:header] }
 				head do
 					head_row do
@@ -85,14 +83,14 @@ module Phlex
 			end
 		end
 
-		def body_template
+		private def body_template
 			body { yield_items }
 		end
 
-		def foot_template
+		private def foot_template
 		end
 
-		def row_template
+		private def row_template
 			body_row do
 				self.class.properties.each do |property|
 					body_cell(**property[:attributes]) do

data/lib/phlex/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlex
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
+  version: 1.1.0
 platform: ruby
 authors:
 - Joel Drapper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-27 00:00:00.000000000 Z
+date: 2023-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -81,9 +81,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.25
 signing_key: