phlex-rails 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4a2327429781bd723b011ea5fe05007feca4a608214ddd3c461cc2685cf8742
-  data.tar.gz: 856d741f12167f40769a271f2a61259f46773c95ab874bce7d169364f34e8d8a
+  metadata.gz: 901899deff58fafb2f6d66acc24fd5e52ae8261fabbc5e927f241d72439656ef
+  data.tar.gz: 00042a1aac9ecadab8ed5ecd188bb1e90dcb9194bc9da28571f559cc05087efb
 SHA512:
-  metadata.gz: c38fba4634834613a6a72e9811361749f63d2d056c8b8b7cd6b8a08c04f2a04dda95146dc5ec013bcfac9453287402da583435a018fd3becf7e14deba29ccf5c
-  data.tar.gz: aeb62a44768d06817370f9a169807a7bf7e718f516a866fb017d90b10b9ad3942e51cdcbda3ae3f22b2397b7a925fb1b3507e1603737edf53ade9fbc75e16c1e
+  metadata.gz: 839ee6ec4a6b77c256dcc3992068afda599044328b634dd323ed6e0b9e54d07199516a3695729d95b35bce21a43a6af4dd39957ea5e22fa7d9190108aab6fd38
+  data.tar.gz: 95703f5ae22a39eab0d14deb4562ca741563e7edbd72187203885ca921cd49ade0257a92b987a7fc1ffb1353372dee47089b4ab15cd6486f8ca72b86d479f760

data/Appraisals

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-appraise "rails-6" do
-	gem "rails", "~> 6"
-end
-
 appraise "rails-7" do
 	gem "rails", "~> 7"
 end
 
-appraise "rails-edge" do
-	gem "rails", github: "rails/rails"
+if RUBY_VERSION >= "3.1.0"
+	appraise "rails-edge" do
+		gem "rails", github: "rails/rails"
+	end
 end

data/Gemfile

@@ -6,14 +6,12 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 gemspec
 
 gem "phlex", github: "phlex-ruby/phlex"
-gem "phlex-testing-capybara", github: "phlex-ruby/phlex-testing-capybara"
-gem "combustion"
 gem "rubocop"
 gem "solargraph"
 gem "view_component"
 gem "appraisal", github: "excid3/appraisal", branch: "fix-bundle-env"
 gem "yard"
 
-# Ensure rails is loaded before rspec-rails.
 gem "rails"
-gem "rspec-rails"
+gem "puma"
+gem "sqlite3"

data/lib/generators/phlex/component/USAGE

@@ -5,4 +5,4 @@ Example:
   rails generate phlex:component Sidebar
 
 This will create:
-  app/components/sidebar_component.rb
+  app/views/components/sidebar_component.rb

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

@@ -2,7 +2,7 @@
 
 <% module_namespacing do -%>
 class <%= class_name %>Component < ApplicationComponent
-  def template
+  def view_template
     h1 { "<%= class_name %>" }
     p { "Find me in <%= @path %>" }
   end

data/lib/generators/phlex/install/install_generator.rb

@@ -5,7 +5,7 @@ module Phlex::Generators
 		source_root File.expand_path("templates", __dir__)
 
 		APPLICATION_CONFIGURATION_PATH = Rails.root.join("config/application.rb")
-		TAILWIND_CONFIGURATION_PATH = Rails.root.join("config/tailwind.config.js")
+		TAILWIND_CONFIGURATION_PATH = Rails.root.join("tailwind.config.js")
 
 		def autoload_components
 			return unless APPLICATION_CONFIGURATION_PATH.exist?
@@ -42,7 +42,6 @@ module Phlex::Generators
 
 			insert_into_file TAILWIND_CONFIGURATION_PATH, after: "content: [" do
 				"\n    './app/views/**/*.rb'," \
-					"\n    './app/components/**/*rb',"
 			end
 		end
 

data/lib/generators/phlex/install/templates/application_layout.rb

@@ -3,7 +3,7 @@
 class ApplicationLayout < ApplicationView
 	include Phlex::Rails::Layout
 
-	def template(&block)
+	def view_template(&block)
 		doctype
 
 		html do

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

@@ -2,7 +2,7 @@
 
 <% module_namespacing do -%>
 class <%= class_name %>View < ApplicationView
-  def template
+  def view_template
     h1 { "<%= class_name %>" }
     p { "Find me in <%= @path %>" }
   end

data/lib/phlex/rails/csv.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Rails
+		module CSV
+			module Overrides
+				def each_item(&block)
+					return super unless collection.is_a?(ActiveRecord::Relation)
+					return super unless collection.arel.orders.empty?
+
+					collection.find_each(&block)
+				end
+			end
+		end
+	end
+end

data/lib/phlex/rails/fragment_finder.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::FragmentFinder
+	extend self
+
+	Parser = if defined?(Nokolexbor)
+		Nokolexbor
+	else
+		require "nokogiri"
+		Nokogiri::HTML
+	end
+
+	def extract(html, ids)
+		parsed = Parser.parse(html)
+		selector = ids.map { |id| "##{id}" }.join(", ")
+
+		result = +""
+
+		ids.count.times do
+			if (fragment = parsed.at_css(selector))
+				result << fragment.to_s
+				fragment.remove
+			end
+		end
+
+		result
+	end
+end

data/lib/phlex/rails/helper_macros.rb

@@ -1,29 +1,15 @@
 # frozen_string_literal: true
 
-# @api private
 module Phlex::Rails::HelperMacros
-	def define_output_helper(method_name)
-		class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-			# frozen_string_literal: true
-
-			def #{method_name}(...)
-				output = helpers.#{method_name}(...)
-
-				case output
-				when ActiveSupport::SafeBuffer
-					@_context.target << output
-				end
-
-				nil
-			end
-		RUBY
-	end
-
-	def define_output_helper_with_capture_block(method_name)
+	# Register a Rails helper that returns safe HTML to be pushed to the output buffer.
+	def register_output_helper(method_name)
 		class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
 			# frozen_string_literal: true
 
 			def #{method_name}(*args, **kwargs, &block)
+  			context = @_context
+  			return if context.fragments && !context.in_target_fragment
+
 				output = if block
 					helpers.#{method_name}(*args, **kwargs) { capture(&block) }
 				else
@@ -40,17 +26,8 @@ module Phlex::Rails::HelperMacros
 		RUBY
 	end
 
-	def define_value_helper(method_name)
-		class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-			# frozen_string_literal: true
-
-			def #{method_name}(...)
-				helpers.#{method_name}(...)
-			end
-		RUBY
-	end
-
-	def define_value_helper_with_capture_block(method_name)
+	# Register a Rails helper that returns a value that shouldn’t be pushed to the output buffer.
+	def register_value_helper(method_name)
 		class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
 			# frozen_string_literal: true
 
@@ -64,11 +41,14 @@ module Phlex::Rails::HelperMacros
 		RUBY
 	end
 
-	def define_builder_yielding_helper(method_name, builder)
+	# @api private
+	def register_builder_yielding_helper(method_name, builder)
 		class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
 			# frozen_string_literal: true
 
 			def #{method_name}(*args, **kwargs)
+  			context = @_context
+  			return if context.fragments && !context.in_target_fragment
 				output = if block_given?
 					helpers.#{method_name}(*args, **kwargs) { |form|
 						capture do

data/lib/phlex/rails/helpers/action_cable_meta_tag.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ActionCableMetaTag
+	extend Phlex::Rails::HelperMacros
+
+	# @!method action_cable_meta_tag
+	# 	Outputs an "action-cable-url" meta tag with the value of the URL specified in your configuration. Ensure this is above your JavaScript tag:
+	# 	@see https://api.rubyonrails.org/classes/ActionCable/Helpers/ActionCableHelper.html#method-i-action_cable_meta_tag
+	# 	@return [nil]
+	register_output_helper :action_cable_meta_tag
+end

data/lib/phlex/rails/helpers/action_name.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ActionName
+	extend Phlex::Rails::HelperMacros
+
+	# @!method action_name
+	# 	@return [String] the name of the controller action, e.g. <code>"index"</code>
+	# 	@see https://api.rubyonrails.org/classes/AbstractController/Base.html#method-i-action_name
+	register_value_helper :action_name
+end

data/lib/phlex/rails/helpers/asset_path.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::AssetPath
+	extend Phlex::Rails::HelperMacros
+
+	# @!method asset_path(source, host: nil, protocol: nil, type: nil, skip_pipeline: nil, extname: nil)
+	# 	@param source [String]
+	# 	@param host [String]
+	# 	@param protocol [String] e.g. <code>"https"</code>
+	# 	@param type [Symbol] e.g. <code>:javascript</code>
+	# 	@param skip_pipeline [bool]
+	# 	@param extname [String] e.g. <code>".js"</code>
+	# 	@see https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-asset_path
+	register_value_helper :asset_path
+end

data/lib/phlex/rails/helpers/asset_url.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::AssetURL
+	extend Phlex::Rails::HelperMacros
+
+	# @!method asset_url(...)
+	register_value_helper :asset_url
+end

data/lib/phlex/rails/helpers/audio_path.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::AudioPath
+	extend Phlex::Rails::HelperMacros
+
+	# @!method audio_path(...)
+	register_value_helper :audio_path
+end

data/lib/phlex/rails/helpers/audio_tag.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::AudioTag
+	extend Phlex::Rails::HelperMacros
+
+	# @!method audio_tag(...)
+	# 	@return [nil]
+	register_output_helper :audio_tag
+end

data/lib/phlex/rails/helpers/audio_url.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::AudioURL
+	extend Phlex::Rails::HelperMacros
+
+	# @!method audio_url(...)
+	register_value_helper :audio_url
+end

data/lib/phlex/rails/helpers/auto_discovery_link_tag.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::AutoDiscoveryLinkTag
+	extend Phlex::Rails::HelperMacros
+
+	# @!method auto_discovery_link_tag(...)
+	# 	@return [nil]
+	register_output_helper :auto_discovery_link_tag
+end

data/lib/phlex/rails/helpers/build_tag_values.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::BuildTagValues
+	extend Phlex::Rails::HelperMacros
+
+	# @!method build_tag_values(...)
+	register_value_helper :build_tag_values
+end

data/lib/phlex/rails/helpers/button_tag.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ButtonTag
+	extend Phlex::Rails::HelperMacros
+
+	# @!method button_tag(...)
+	# 	@return [nil]
+	register_output_helper :button_tag
+end

data/lib/phlex/rails/helpers/button_to.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ButtonTo
+	extend Phlex::Rails::HelperMacros
+
+	# @!method button_to(...)
+	# 	@return [nil]
+	register_output_helper :button_to
+end

data/lib/phlex/rails/helpers/check_box.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::CheckBox
+	extend Phlex::Rails::HelperMacros
+
+	# @!method check_box(...)
+	# 	@return [nil]
+	register_output_helper :check_box
+end

data/lib/phlex/rails/helpers/check_box_tag.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::CheckBoxTag
+	extend Phlex::Rails::HelperMacros
+
+	# @!method check_box_tag(...)
+	# 	@return [nil]
+	register_output_helper :check_box_tag
+end

data/lib/phlex/rails/helpers/class_names.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ClassNames
+	extend Phlex::Rails::HelperMacros
+
+	# @!method class_names(...)
+	register_value_helper :class_names
+end

data/lib/phlex/rails/helpers/collection_check_boxes.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::CollectionCheckBoxes
+	extend Phlex::Rails::HelperMacros
+
+	# @!method collection_check_boxes(...)
+	# 	@yield [builder]
+	# 	@yieldparam builder [Phlex::Rails::BufferedCheckboxBuilder]
+	register_builder_yielding_helper :collection_check_boxes, Phlex::Rails::BufferedCheckboxBuilder
+end

data/lib/phlex/rails/helpers/collection_radio_buttons.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::CollectionRadioButtons
+	extend Phlex::Rails::HelperMacros
+
+	# @!method collection_radio_buttons(...)
+	# 	@yield [builder]
+	# 	@yieldparam builder [Phlex::Rails::BufferedRadioButtonBuilder]
+	register_builder_yielding_helper :collection_radio_buttons, Phlex::Rails::BufferedRadioButtonBuilder
+end

data/lib/phlex/rails/helpers/collection_select.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::CollectionSelect
+	extend Phlex::Rails::HelperMacros
+
+	# @!method collection_select(...)
+	# 	@return [nil]
+	register_output_helper :collection_select
+end

data/lib/phlex/rails/helpers/color_field.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ColorField
+	extend Phlex::Rails::HelperMacros
+
+	# @!method color_field(...)
+	# 	@return [nil]
+	register_output_helper :color_field
+end

data/lib/phlex/rails/helpers/color_field_tag.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ColorFieldTag
+	extend Phlex::Rails::HelperMacros
+
+	# @!method color_field_tag(...)
+	# 	@return [nil]
+	register_output_helper :color_field_tag
+end

data/lib/phlex/rails/helpers/compute_asset_extname.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ComputeAssetExtname
+	extend Phlex::Rails::HelperMacros
+
+	# @!method compute_asset_extname(...)
+	register_value_helper :compute_asset_extname
+end

data/lib/phlex/rails/helpers/compute_asset_host.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ComputeAssetHost
+	extend Phlex::Rails::HelperMacros
+
+	# @!method compute_asset_host(...)
+	register_value_helper :compute_asset_host
+end

data/lib/phlex/rails/helpers/compute_asset_path.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ComputeAssetPath
+	extend Phlex::Rails::HelperMacros
+
+	# @!method compute_asset_path(...)
+	register_value_helper :compute_asset_path
+end

data/lib/phlex/rails/helpers/content_for.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ContentFor
+	extend Phlex::Rails::HelperMacros
+
+	# @!method content_for?(...)
+	register_value_helper :content_for?
+
+	# @!method content_for(...)
+	register_value_helper :content_for
+end

data/lib/phlex/rails/helpers/content_tag.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ContentTag
+	extend Phlex::Rails::HelperMacros
+
+	# @!method content_tag(...)
+	# 	@return [nil]
+	register_output_helper :content_tag
+end

data/lib/phlex/rails/helpers/controller_name.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ControllerName
+	extend Phlex::Rails::HelperMacros
+
+	# @!method controller_name(...)
+	register_value_helper :controller_name
+end

data/lib/phlex/rails/helpers/controller_path.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::ControllerPath
+	extend Phlex::Rails::HelperMacros
+
+	# @!method controller_path(...)
+	register_value_helper :controller_path
+end

data/lib/phlex/rails/helpers/csp_meta_tag.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::CSPMetaTag
+	extend Phlex::Rails::HelperMacros
+
+	# @!method csp_meta_tag(...)
+	# 	@return [nil]
+	register_output_helper :csp_meta_tag
+end

data/lib/phlex/rails/helpers/csrf_meta_tags.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::CSRFMetaTags
+	extend Phlex::Rails::HelperMacros
+
+	# @!method csrf_meta_tags(...)
+	# 	@return [nil]
+	register_output_helper :csrf_meta_tags
+end

data/lib/phlex/rails/helpers/current_cycle.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::CurrentCycle
+	extend Phlex::Rails::HelperMacros
+
+	# @!method current_cycle(...)
+	register_value_helper :current_cycle
+end

data/lib/phlex/rails/helpers/current_page.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::CurrentPage
+	extend Phlex::Rails::HelperMacros
+
+	# @!method current_page?(...)
+	register_value_helper :current_page?
+end

data/lib/phlex/rails/helpers/cycle.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::Cycle
+	extend Phlex::Rails::HelperMacros
+
+	# @!method cycle(...)
+	register_value_helper :cycle
+end

data/lib/phlex/rails/helpers/date_field.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::DateField
+	extend Phlex::Rails::HelperMacros
+
+	# @!method date_field(...)
+	# 	@return [nil]
+	register_output_helper :date_field
+end

data/lib/phlex/rails/helpers/date_field_tag.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::DateFieldTag
+	extend Phlex::Rails::HelperMacros
+
+	# @!method date_field_tag(...)
+	# 	@return [nil]
+	register_output_helper :date_field_tag
+end

data/lib/phlex/rails/helpers/date_select.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::DateSelect
+	extend Phlex::Rails::HelperMacros
+
+	# @!method date_select(...)
+	# 	@return [nil]
+	register_output_helper :date_select
+end

data/lib/phlex/rails/helpers/datetime_field.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::DatetimeField
+	extend Phlex::Rails::HelperMacros
+
+	# @!method datetime_field(...)
+	# 	@return [nil]
+	register_output_helper :datetime_field
+end

data/lib/phlex/rails/helpers/datetime_field_tag.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::DatetimeFieldTag
+	extend Phlex::Rails::HelperMacros
+
+	# @!method datetime_field_tag(...)
+	# 	@return [nil]
+	register_output_helper :datetime_field_tag
+end

data/lib/phlex/rails/helpers/datetime_local_field.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::DatetimeLocalField
+	extend Phlex::Rails::HelperMacros
+
+	# @!method datetime_local_field(...)
+	# 	@return [nil]
+	register_output_helper :datetime_local_field
+end

data/lib/phlex/rails/helpers/datetime_local_field_tag.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::DatetimeLocalFieldTag
+	extend Phlex::Rails::HelperMacros
+
+	# @!method datetime_local_field_tag(...)
+	# 	@return [nil]
+	register_output_helper :datetime_local_field_tag
+end

data/lib/phlex/rails/helpers/datetime_select.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::DatetimeSelect
+	extend Phlex::Rails::HelperMacros
+
+	# @!method datetime_select(...)
+	# 	@return [nil]
+	register_output_helper :datetime_select
+end

data/lib/phlex/rails/helpers/debug.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex::Rails::Helpers::Debug
+	extend Phlex::Rails::HelperMacros
+
+	# @!method debug(...)
+	# 	@return [nil]
+	register_output_helper :debug
+end