phlex-rails 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64bd1c0569d8a687689b1eec091acff484e3c3c7db388f80ddc1cb059881c680
-  data.tar.gz: 282af2d851aaef5e1266519b59ba5ade1360cd13666d629b4109441f16abb6f6
+  metadata.gz: 7b847ffd983ba4161668179eb395ccbfd50ee216892ffb7124bdacaa584a9e0a
+  data.tar.gz: e34aa3c4e6053b913f09f325ce11e16e6152afed5fecd18857a3ee634a735034
 SHA512:
-  metadata.gz: e9f65f079a1ec7372692767beb7f7f1f70dac50f4429f429aa0085bbfefcd40675e2933985d728ed2354fb90983d86a707d1f5432c3333f72f843032086c7924
-  data.tar.gz: 7e5f5fe2316c5db3ae8757a67517856ffdebf4f5b03467d17a712eb6c571486f402ceeb993cd1ceba31c3a7cfef37aa104ed297123be43fb30cb2af790775530
+  metadata.gz: e955615cd2b7ac990742dd35028d524f74f8f05f0799ede53f793435344d1b3c7db6b99c87fb2f3fedef50f016f53d7f3cf32070ab7894be1b86c734b93cca76
+  data.tar.gz: 675126fe1bc74b22ee7ec284f0048ca4051a4fb3ea863fe916c8c48c745ca1ea431ed84569fda5d6b9ce046a58fd67f3b11f3e78bab25f4496074fc7e55d8e8a

data/.rubocop.yml

@@ -10,3 +10,6 @@ AllCops:
 
 Style/MissingRespondToMissing:
   Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false

data/.yardopts

@@ -0,0 +1 @@
+--private --hide-api private --markup markdown --exclude lib/generators

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] 2023-04-19
+
+### Added
+
+- Added an adapter for the pluralize view helper.
+
+## 0.10.0
+
+### Added
+
+- You can now render procs and lambdas and enumerables of renderables.
+- Experimental streaming interface
+
+### Fixed
+
+- Escaped ERB captures
+- Use buffered component unless renderin in a template
+
+***
+
+Before this changelog was introduced, changes were logged in the [release notes](https://github.com/phlex-ruby/phlex/releases).

data/Gemfile

@@ -5,11 +5,12 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gemspec
 
-gem "phlex", github: "joeldrapper/phlex"
-gem "phlex-testing-capybara", github: "joeldrapper/phlex-testing-capybara"
+gem "phlex", github: "phlex-ruby/phlex"
+gem "phlex-testing-capybara", github: "phlex-ruby/phlex-testing-capybara"
 gem "rspec-rails"
 gem "combustion"
 gem "rubocop"
 gem "solargraph"
 gem "view_component"
 gem "appraisal", github: "excid3/appraisal", branch: "fix-bundle-env"
+gem "yard"

data/lib/phlex/rails/buffered.rb

@@ -4,6 +4,7 @@ require "forwardable"
 
 module Phlex::Rails
 	# A decorator that buffers all missing method calls and captures the blocks passed to them.
+	# @api private
 	class Buffered < BasicObject
 		extend ::Forwardable
 

data/lib/phlex/rails/buffered_checkbox_builder.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Phlex::Rails
+	# @api private
 	class BufferedCheckboxBuilder < Buffered
 		# @!method object(...)
 		# @!method text(...)

data/lib/phlex/rails/buffered_form_builder.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Phlex::Rails
+	# @api private
 	class BufferedFormBuilder < Buffered
 		# @!method field_id(...)
 		# @!method field_name(...)

data/lib/phlex/rails/buffered_label_builder.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Phlex::Rails
+	# @api private
 	class BufferedLabelBuilder < Buffered
 		# @!method object(...)
 		# @!method translation(...)

data/lib/phlex/rails/buffered_radio_button_builder.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Phlex::Rails
+	# @api private
 	class BufferedRadioButtonBuilder < Buffered
 		# @!method object(...)
 		# @!method text(...)

data/lib/phlex/rails/engine.rb

@@ -4,6 +4,7 @@ require "rails/engine"
 
 module Phlex
 	module Rails
+		# @api private
 		class Engine < ::Rails::Engine
 		end
 	end

data/lib/phlex/rails/form.rb

@@ -2,6 +2,7 @@
 
 module Phlex
 	module Rails
+		# @api private
 		class Form < Phlex::HTML
 			def initialize(model)
 				@model = model

data/lib/phlex/rails/helpers.rb

@@ -883,6 +883,14 @@ module Phlex::Rails::Helpers
 		define_output_helper :phone_field_tag
 	end
 
+	module Pluralize
+		extend Phlex::Rails::HelperMacros
+
+		# @!method pluralize(...)
+		# 	@return [String]
+		define_value_helper :pluralize
+	end
+
 	module PreloadLinkTag
 		extend Phlex::Rails::HelperMacros
 

data/lib/phlex/rails/html/format.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# @api private
 module Phlex::Rails::HTML::Format
 	def format
 		:html

data/lib/phlex/rails/layout.rb

@@ -13,6 +13,7 @@ module Phlex::Rails
 		include Helpers::JavaScriptImportMapTags
 		include Helpers::JavaScriptImportModuleTag
 
+		# @api private
 		module Interface
 			def render(view, _locals, &block)
 				component = new

data/lib/phlex/rails/sgml/overrides.rb

@@ -34,7 +34,7 @@ module Phlex
 						call(view_context: view_context) do |*args|
 							original_length = @_context.target.length
 
-							if args.length == 1 && Phlex::SGML === args[0]
+							if args.length == 1 && Phlex::SGML === args[0] && !block.source_location&.[](0)&.end_with?(".rb")
 								output = view_context.capture(
 									args[0].unbuffered, &block
 								)
@@ -60,7 +60,8 @@ module Phlex
 					super&.html_safe
 				end
 
-				def plain(content)
+				# @api private
+				def __text__(content)
 					case content
 					when ActiveSupport::SafeBuffer
 						@_context.target << content
@@ -69,7 +70,19 @@ module Phlex
 					end
 				end
 
+				# @api private
+				def await(task)
+					if task.is_a?(ActiveRecord::Relation)
+						flush unless task.loaded?
+
+						task
+					else
+						super
+					end
+				end
+
 				# Trick ViewComponent into thinking we're a ViewComponent to fix rendering output
+				# @api private
 				def set_original_view_context(view_context)
 				end
 			end

data/lib/phlex/rails/streaming.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# @api private
+module Phlex::Rails::Streaming
+	private
+
+	def stream(view)
+		headers.delete("Content-Length")
+
+		headers["X-Accel-Buffering"] = "no"
+		headers["Cache-Control"] = "no-cache"
+		headers["Content-Type"] = "text/html; charset=utf-8"
+		headers["Last-Modified"] = Time.zone.now.ctime.to_s
+
+		response.status = 200
+
+		self.response_body = Enumerator.new do |buffer|
+			view.call(buffer, view_context: view_context)
+		rescue => e
+			buffer << %('">)
+			buffer << view_context.javascript_tag(nonce: true) { %(window.location = "/500.html").html_safe }
+
+			raise e
+		end
+	end
+end

data/lib/phlex/rails/unbuffered_overrides.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# @api private
 module Phlex::Rails::UnbufferedOverrides
 	def method_missing(name, *args, **kwargs, &block)
 		if @object.respond_to?(name)
@@ -8,7 +9,11 @@ module Phlex::Rails::UnbufferedOverrides
 				@object.capture do
 					if b
 						@object.public_send(name, *a, **k) do |*aa|
-							@object.helpers.capture(*aa, &b)
+							if aa.length == 1 && aa[0].is_a?(Phlex::SGML)
+								@object.helpers.capture(aa[0].unbuffered, &b)
+							else
+								@object.helpers.capture(*aa, &b)
+							end
 						end
 					else
 						@object.public_send(name, *a, **k)

data/lib/phlex/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Phlex
 	module Rails
-		VERSION = "0.9.0"
+		VERSION = "1.0.0"
 	end
 end

data/lib/phlex/rails.rb

@@ -22,11 +22,13 @@ module Phlex
 		prepend Phlex::Rails::SGML::Overrides
 	end
 
+	# @api private
 	class HTML
 		extend Phlex::Rails::HTML::Format
 		include Phlex::Rails::HTML::Format
 	end
 
+	# @api private
 	class Unbuffered
 		prepend ::Phlex::Rails::UnbufferedOverrides
 	end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlex-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Joel Drapper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -68,7 +68,9 @@ files:
 - ".editorconfig"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".yardopts"
 - Appraisals
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
@@ -113,6 +115,7 @@ files:
 - lib/phlex/rails/layout.rb
 - lib/phlex/rails/sgml/class_methods.rb
 - lib/phlex/rails/sgml/overrides.rb
+- lib/phlex/rails/streaming.rb
 - lib/phlex/rails/unbuffered_overrides.rb
 - lib/phlex/rails/version.rb
 - lib/phlex/testing/rails/view_helper.rb
@@ -122,8 +125,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://www.phlex.fun
-  source_code_uri: https://github.com/joeldrapper/phlex
-  changelog_uri: https://github.com/joeldrapper/phlex/releases
+  source_code_uri: https://github.com/phlex-ruby/phlex-rails
+  changelog_uri: https://github.com/phlex-ruby/phlex-rails/blob/main/CHANGELOG.md
   funding_uri: https://github.com/sponsors/joeldrapper
   rubygems_mfa_required: 'true'
 post_install_message: