phlex-rails 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a623bc2f1743cc9fb1c081bb545570ea4f74c68fd3239a91e2ea578f84351d49
-  data.tar.gz: 49ef5747faf129b2c03a74f12f2aa20d1c42618309d3cb3f96eba7f27d0867b2
+  metadata.gz: 7235a9f512ec98cba7ac0c7b433c6b8862a79393d7759283f9374c2de12cbc30
+  data.tar.gz: 63090c17e5a2996f2dce0da406fb97a3e58a43bfdc7799120cef331f3eea5133
 SHA512:
-  metadata.gz: 1bd8a771b4f85a3a3a6cd60e9b9e5c813f19a3ad5399fe5a2b668ac9a120435e5239c6a540b8565b3ac8a34848bb31fd0588c3bc9df0398148abb621eeb460d6
-  data.tar.gz: 2822f8e1c9cff19bf6ac7aaa7e8f76241bdec94f425bebb195c60d750bd5262996a4db0acbdb55e28e49cf3280def61274588dfdc9d964efe3b0ef7db16b3823
+  metadata.gz: 3f6488be48a2585d14065193a5c15b8c96218926f1617ece544062fc2d6957a4ab0a43f4d9a46ce610ff5c2cc883c40547af9764699444976755df67784dc55f
+  data.tar.gz: 1154d9f20816c76a233b4d83e919189a7c020fa0b7e364c113ab496867b40d33e19d6516571c7237baa11ce96de78bbcbcc2522f4acc614e8d6122f1227dfc9b

data/.rubocop.yml

@@ -29,3 +29,6 @@ Style/MixinUsage:
 
 Style/ConditionalAssignment:
   Enabled: false
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false

data/Gemfile

@@ -6,8 +6,9 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 gemspec
 
 gem "phlex", github: "joeldrapper/phlex", branch: "main"
-gem "sus"
+gem "rspec-rails"
 gem "combustion"
 gem "rubocop"
 gem "solargraph"
+gem "view_component"
 gem "appraisal", github: "excid3/appraisal", branch: "fix-bundle-env"

data/config.ru

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

data/lib/generators/phlex/controller/templates/view.rb.erb

@@ -1,8 +1,6 @@
 <% module_namespacing do -%>
 module Views
   class <%= class_name %>::<%= @action.camelize %> < Phlex::HTML
-    include ApplicationView
-
     def template
       <%= "# " unless @has_layout %>render Layout.new(title: "<%= class_name.gsub("::", " ").titlecase %> - <%= @action.titlecase %>") do
         h1 { "<%= class_name %>#<%= @action %>" }

data/lib/generators/phlex/layout/templates/layout.rb.erb

@@ -1,7 +1,6 @@
 <% module_namespacing do -%>
 module Views
   class <%= class_name %> < Phlex::HTML
-    include ApplicationView
     include Phlex::Rails::Layout
 
     def initialize(title:)

data/lib/generators/phlex/page/templates/page.rb.erb

@@ -1,8 +1,6 @@
 <% module_namespacing do -%>
 module Views
   class <%= class_name %> < Phlex::HTML
-    include ApplicationView
-
     def template
       render Layout.new(title: "<%= class_name.gsub("::", " ") %>") do
         h1 { "👋 Hello World!" }

data/lib/install/phlex.rb

@@ -15,18 +15,6 @@ unless application_configuration_content.match?(pattern)
 	)
 end
 
-unless Rails.root.join("app/views/application_view.rb").exist?
-	create_file(Rails.root.join("app/views/application_view.rb"), <<~RUBY)
-		# frozen_string_literal: true
-
-		module Views
-		  module ApplicationView
-		    include Rails.application.routes.url_helpers
-		  end
-		end
-	RUBY
-end
-
 tailwind_config_path = Rails.root.join("config/tailwind.config.js")
 
 if tailwind_config_path.exist?

data/lib/phlex/rails/helpers.rb

@@ -4,8 +4,8 @@ module Phlex
 	module Rails
 		module Helpers
 			module CSPMetaTag
-				def csp_meta_tag(**options)
-					if (output = @_view_context.csp_meta_tag(**options))
+				def csp_meta_tag(...)
+					if (output = @_view_context.csp_meta_tag(...))
 						@_target << output
 					end
 				end
@@ -63,6 +63,7 @@ module Phlex
 					alias_method :week_field, :__output_method__
 					alias_method :weekday_select, :__output_method__
 					alias_method :button, :__output_method__
+					alias_method :rich_text_area, :__output_method__
 				end
 
 				def form_with(*args, **kwargs, &block)
@@ -77,64 +78,72 @@ module Phlex
 			end
 
 			module StylesheetLinkTag
-				def stylesheet_link_tag(*sources)
-					if (output = @_view_context.stylesheet_link_tag(*sources))
+				def stylesheet_link_tag(...)
+					if (output = @_view_context.stylesheet_link_tag(...))
 						@_target << output
 					end
 				end
 			end
 
 			module FaviconLinkTag
-				def favicon_link_tag(*args)
-					if (output = @_view_context.favicon_link_tag(*args))
+				def favicon_link_tag(...)
+					if (output = @_view_context.favicon_link_tag(...))
 						@_target << output
 					end
 				end
 			end
 
 			module ImageTag
-				def image_tag(*args)
-					if (output = @_view_context.image_tag(*args))
+				def image_tag(...)
+					if (output = @_view_context.image_tag(...))
 						@_target << output
 					end
 				end
 			end
 
 			module AudioTag
-				def audio_tag(*args)
-					if (output = @_view_context.audio_tag(*args))
+				def audio_tag(...)
+					if (output = @_view_context.audio_tag(...))
 						@_target << output
 					end
 				end
 			end
 
 			module VideoTag
-				def video_tag(*args)
-					if (output = @_view_context.video_tag(*args))
+				def video_tag(...)
+					if (output = @_view_context.video_tag(...))
 						@_target << output
 					end
 				end
 			end
 
 			module PreloadLinkTag
-				def preload_link_tag(*args)
-					if (output = @_view_context.preload_link_tag(*args))
+				def preload_link_tag(...)
+					if (output = @_view_context.preload_link_tag(...))
 						@_target << output
 					end
 				end
 			end
 
 			module JavaScriptIncludeTag
-				def javascript_include_tag(*sources)
-					if (output = @_view_context.javascript_include_tag(*sources))
+				def javascript_include_tag(...)
+					if (output = @_view_context.javascript_include_tag(...))
 						@_target << output
 					end
 				end
 			end
 
 			module JavaScriptImportmapTags
-				def javascript_importmap_tags
-					if (output = @_view_context.javascript_importmap_tags)
+				def javascript_importmap_tags(...)
+					if (output = @_view_context.javascript_importmap_tags(...))
+						@_target << output
+					end
+				end
+			end
+
+			module JavaScriptImportModuleTag
+				def javascript_import_module_tag(...)
+					if (output = @_view_context.javascript_import_module_tag(...))
 						@_target << output
 					end
 				end

data/lib/phlex/rails/layout.rb

@@ -11,6 +11,7 @@ module Phlex
 			include Helpers::ActionCableMetaTag
 			include Helpers::JavaScriptIncludeTag
 			include Helpers::JavaScriptImportmapTags
+			include Helpers::JavaScriptImportModuleTag
 		end
 	end
 end

data/lib/phlex/rails/renderable.rb

@@ -21,7 +21,15 @@ module Phlex
 					call(view_context: view_context) do |*args|
 						view_context.with_output_buffer(self) do
 							original_length = @_target.length
-							output = yield(*args)
+
+							if args.length == 1 && Phlex::HTML === args[0]
+								output = yield(
+									args[0].unbuffered
+								)
+							else
+								output = yield(*args)
+							end
+
 							unchanged = (original_length == @_target.length)
 
 							if unchanged
@@ -32,6 +40,8 @@ module Phlex
 								end
 							end
 						end
+
+						nil
 					end.html_safe
 				else
 					call(view_context: view_context).html_safe
@@ -63,12 +73,34 @@ module Phlex
 			end
 
 			def capture
-				super.html_safe
+				super&.html_safe
 			end
 
 			# Trick ViewComponent into thinking we're a ViewComponent to fix rendering output
 			def set_original_view_context(view_context)
 			end
+
+			private def yield_content(&block)
+				return unless block
+
+				case block.binding.receiver
+				when Phlex::HTML
+					super
+				else
+					@_view_context.with_output_buffer(self) { super }
+				end
+			end
+
+			private def yield_content_with_args(*args, &block)
+				return unless block
+
+				case block.binding.receiver
+				when Phlex::HTML
+					super
+				else
+					@_view_context.with_output_buffer(self) { super }
+				end
+			end
 		end
 	end
 end

data/lib/phlex/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Phlex
 	module Rails
-		VERSION = "0.4.2"
+		VERSION = "0.5.0"
 	end
 end

data/lib/phlex/rails.rb

@@ -10,5 +10,16 @@ module Phlex::Rails
 		loader.setup
 	end
 
+	module AppendMethodAddedWarning
+		def method_added(name)
+			if name == :append || name == :safe_append
+				raise Phlex::NameError, "You shouldn't redefine the #{name} method as it's required for safe HTML output."
+			end
+
+			super
+		end
+	end
+
 	Phlex::HTML.prepend(Phlex::Rails::Renderable)
+	Phlex::HTML.extend(Phlex::Rails::AppendMethodAddedWarning)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlex-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Joel Drapper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-14 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.3.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.3.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -80,37 +80,7 @@ files:
 - LICENSE.txt
 - README.md
 - SECURITY.md
-- config/sus.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/blog.html.erb
-- 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/blog.rb
-- 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/rails_helper.rb
-- fixtures/view_helper.rb
-- lib/generators/phlex/collection/USAGE
-- lib/generators/phlex/collection/collection_generator.rb
-- lib/generators/phlex/collection/templates/collection.rb.erb
+- config.ru
 - lib/generators/phlex/controller/USAGE
 - lib/generators/phlex/controller/controller_generator.rb
 - lib/generators/phlex/controller/templates/controller.rb.erb
@@ -121,9 +91,6 @@ files:
 - 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
@@ -167,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.25
+rubygems_version: 3.4.3
 signing_key:
 specification_version: 4
 summary: A Phlex adapter for Rails

data/config/sus.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require "phlex/rails"
-
-Zeitwerk::Loader.eager_load_all

data/fixtures/dummy/app/components/comment_component.html.erb

@@ -1,14 +0,0 @@
-<div>
-  <span>
-    <%= @name %>
-  </span>
-  <span>
-    <%= @body %>
-  </span>
-
-  <%= content %>
-
-  <%= render Views::Comments::Reaction.new(emoji: 'hamburger') do |reaction| %>
-    <p>Emoji reaction for a comment from <%= @name %> with body <%= @body %></p>
-  <% end %>
-</div>

data/fixtures/dummy/app/components/comment_component.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-class CommentComponent < ViewComponent::Base
-	def initialize(name:, body:)
-		@name = name
-		@body = body
-	end
-end

data/fixtures/dummy/app/components/reaction_component.html.erb

@@ -1,3 +0,0 @@
-<p><%= @emoji %></p>
-
-<%= content %>

data/fixtures/dummy/app/components/reaction_component.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class ReactionComponent < ViewComponent::Base
-	def initialize(emoji:)
-		@emoji = emoji
-	end
-end

data/fixtures/dummy/app/controllers/articles_controller.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-class ArticlesController < ActionController::Base
-end

data/fixtures/dummy/app/controllers/comments_controller.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-class CommentsController < ActionController::Base
-end

data/fixtures/dummy/app/views/application_view.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Views
-	class ApplicationView < Phlex::HTML
-		include Rails.application.routes.url_helpers
-	end
-end

data/fixtures/dummy/app/views/articles/blog.html.erb

@@ -1,14 +0,0 @@
-<%= render Views::Blog.new do |v| %>
-
-  hidden
-
-  <% v.with_post do %><%= link_to "First Post", "/posts/1" %><% end %>
-
-  content
-
-  <% v.with_header do %><%= link_to "My blog", "/" %><% end %>
-
-  here
-
-  <% v.with_post do %><%= link_to "Last Post", "/posts/2" %><% end %>
-<% end %>

data/fixtures/dummy/app/views/articles/form.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Views
-	module Articles
-		class Form < ApplicationView
-			include Phlex::Rails::Helpers::FormWith
-
-			def template
-				form_with url: "test" do |f|
-					f.text_field :name
-				end
-			end
-		end
-	end
-end

data/fixtures/dummy/app/views/articles/index.html.erb

@@ -1,14 +0,0 @@
-<p>Before</p>
-
-<%= render(Views::Heading.new) { "Hello World!" } %>
-
-<%= render Views::Card.new do |a| %>
-  <p>Start Card A</p>
-  <%= a.title "Hello from A" %>
-  <%= render Views::Card.new do |b| %>
-    <p>Start Card B</p>
-    <%= b.title "Hello from B" %>
-    <p>End Card B</p>
-  <% end %>
-  <p>End Card A</p>
-<% end %>

data/fixtures/dummy/app/views/articles/new.html.erb

@@ -1 +0,0 @@
-<%= render Views::Articles::Form.new %>

data/fixtures/dummy/app/views/blog.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Views
-	class Blog < ApplicationView
-		def initialize
-			@posts = []
-		end
-
-		def template(&block)
-			capture(&block)
-
-			h3(class: "font-bold") { @header }
-
-			@posts.each do |post|
-				article(class: "drop-shadow p-5 rounded") { post }
-			end
-		end
-
-		def with_header(&block)
-			@header = capture(&block)
-		end
-
-		def with_post(&block)
-			@posts << capture(&block)
-		end
-	end
-end

data/fixtures/dummy/app/views/card.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Views
-	class Card < ApplicationView
-		def template(&block)
-			article class: "drop-shadow p-5 rounded", &block
-		end
-
-		def title(text)
-			h3 class: "font-bold" do
-				text
-			end
-		end
-	end
-end

data/fixtures/dummy/app/views/comments/comment.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Views
-	module Comments
-		class Comment < ApplicationView
-			def initialize(name:, body:)
-				@name = name
-				@body = body
-			end
-
-			def template(&block)
-				div {
-					span { @name }
-					span { @body }
-
-					yield_content(&block)
-
-					render(::ReactionComponent.new(emoji: "hamburger")) do
-						p { "Emoji reaction for a comment from #{@name} with body #{@body}" }
-					end
-				}
-			end
-		end
-	end
-end

data/fixtures/dummy/app/views/comments/index.html.erb

@@ -1,3 +0,0 @@
-<%= render(CommentComponent.new(name: "Matz", body: "hey, folks")) do %>
-  Hello, World from a ViewComponent!
-<% end %>

data/fixtures/dummy/app/views/comments/reaction.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Views
-	module Comments
-		class Reaction < ApplicationView
-			def initialize(emoji:)
-				@emoji = emoji
-			end
-
-			def template(&block)
-				p { @emoji }
-
-				yield_content(&block)
-			end
-		end
-	end
-end

data/fixtures/dummy/app/views/comments/show.html.erb

@@ -1,3 +0,0 @@
-<%= render Views::Comments::Comment.new(name: "_why", body: "I'm back") do %>
-  Hello, World from a Phlex Component!
-<% end %>

data/fixtures/dummy/app/views/heading.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Views
-	class Heading < ApplicationView
-		def template(&block)
-			h1(&block)
-		end
-	end
-end

data/fixtures/dummy/config/database.yml

@@ -1,3 +0,0 @@
-test:
-  adapter:  sqlite3
-  database: db/combustion_test.sqlite

data/fixtures/dummy/config/routes.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-Rails.application.routes.draw do
-	# Rails routes here
-end

data/fixtures/dummy/config/storage.yml

@@ -1,3 +0,0 @@
-test:
-  service: Disk
-  root: /Users/joeldrapper/src/joeldrapper/phlex/tmp/storage

data/fixtures/dummy/db/schema.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-ActiveRecord::Schema.define do
-	# Set up any tables you need to exist for your test suite that don't belong
-	# in migrations.
-end

data/fixtures/dummy/log/.gitignore

@@ -1 +0,0 @@
-*.log

data/fixtures/rails_helper.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-Bundler.require :default
-
-Combustion.path = "fixtures/dummy"
-
-Combustion.initialize! :action_controller do
-	config.autoload_paths << "#{root}/app"
-end

data/fixtures/view_helper.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module ViewHelper
-	def self.extended(parent)
-		parent.class_exec do
-			let(:output) { example.call }
-			let(:example) { view.new }
-		end
-	end
-
-	def view(&block)
-		let :view do
-			Class.new(Phlex::HTML, &block)
-		end
-	end
-end

data/lib/generators/phlex/collection/USAGE

@@ -1,8 +0,0 @@
-Description:
-  Generates a Phlex collection view with the given name
-
-Example:
-  rails generate phlex:collection Articles::List
-
-This will create:
-  app/views/articles/list.rb

data/lib/generators/phlex/collection/collection_generator.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Phlex
-	module Generators
-		class CollectionGenerator < ::Rails::Generators::NamedBase
-			source_root File.expand_path("templates", __dir__)
-
-			def create_view
-				template "collection.rb.erb", File.join("app/views", class_path, "#{file_name}.rb")
-			end
-		end
-	end
-end

data/lib/generators/phlex/collection/templates/collection.rb.erb

@@ -1,16 +0,0 @@
-<% module_namespacing do -%>
-module Views
-  class <%= class_name %> < Phlex::HTML
-    include ApplicationView
-    include Phlex::Collection
-
-    def collection_template(&)
-      ul(&)
-    end
-
-    def item_template
-      li { @item }
-    end
-  end
-end
-<% end %>

data/lib/generators/phlex/table/USAGE

@@ -1,8 +0,0 @@
-Description:
-	Generates a Phlex table collection view with the given name
-
-Example:
-	rails generate phlex:collection Articles::Table --properties title author created_at
-
-This will create:
-	app/views/articles/table.rb

data/lib/generators/phlex/table/table_generator.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Phlex
-	module Generators
-		class TableGenerator < ::Rails::Generators::NamedBase
-			source_root File.expand_path("templates", __dir__)
-			class_option :properties, type: :array, default: []
-
-			def create_view
-				template "table.rb.erb", File.join("app/views", class_path, "#{file_name}.rb")
-			end
-		end
-	end
-end

data/lib/generators/phlex/table/templates/table.rb.erb

@@ -1,11 +0,0 @@
-<% module_namespacing do -%>
-module Views
-  class <%= class_name %> < Phlex::HTML
-    include ApplicationView
-    include Phlex::Table
-
-    <% options["properties"].each do |property| %>
-    property "<%= property.humanize %>", &:<%= property.underscore %><% end %>
-  end
-end
-<% end %>