phlex-rails 0.1.0 → 0.2.0

data/lib/generators/phlex/table/USAGE

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,14 @@
+# 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

@@ -0,0 +1,11 @@
+<% 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 %>

data/lib/generators/phlex/view/USAGE

@@ -0,0 +1,9 @@
+Description:
+  Generates a Phlex view with the given name
+
+Example:
+  rails generate phlex:view Sidebar
+
+This will create:
+  app/views/sidebar.rb
+  spec/views/sidebar_spec.rb or test/views/sidebar_test.rb

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

@@ -0,0 +1,14 @@
+<% module_namespacing do -%>
+module Views
+  class <%= class_name %> < Phlex::HTML
+    include ApplicationView
+
+    def template
+      <%= "# " unless @layout %>render Layout.new(title: "<%= class_name.gsub("::", " ").titlecase %>") do
+        h1 { "<%= class_name %>" }
+        p { "Find me in <%= @path %>" }
+      <%= "# " unless @layout %>end
+    end
+  end
+end
+<% end %>

data/lib/generators/phlex/view/view_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Generators
+		class ViewGenerator < ::Rails::Generators::NamedBase
+			source_root File.expand_path("templates", __dir__)
+
+			def create_view
+				@layout = layout
+				@path = File.join("app/views", class_path, "#{file_name}.rb")
+				template "view.rb.erb", @path
+			end
+
+			private
+
+			def layout
+				::Rails.root.join("app/views/layout.rb").exist?
+			end
+
+			hook_for :test_framework
+		end
+	end
+end

data/lib/generators/rspec/view/templates/view_spec.rb.erb

@@ -0,0 +1,10 @@
+require "rails_helper"
+
+RSpec.describe Views::<%= class_name %>, type: :view do
+  pending "renders without problem" do
+    result = render(described_class.new)
+
+    expect(result.css("h1").text).to eq "<%= class_name %>"
+    expect(result.css("p").text).to eq "Find me in <%= @path %>"
+  end
+end

data/lib/generators/rspec/view/view_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Rspec
+	module Generators
+		class ViewGenerator < ::Rails::Generators::NamedBase
+			source_root File.expand_path("templates", __dir__)
+
+			def create_view
+				@path = File.join("app/views", class_path, "#{file_name}.rb")
+				template "view_spec.rb.erb", File.join("spec/views", class_path, "#{file_name}_spec.rb")
+			end
+		end
+	end
+end

data/lib/generators/test_unit/templates/view_test.rb.erb

@@ -0,0 +1,15 @@
+require "test_helper"
+require "phlex/testing/rails"
+require "phlex/testing/nokogiri"
+
+class Views::<%= class_name %>Test < ActionView::TestCase
+  include Phlex::Testing::Rails::ViewHelper
+  include Phlex::Testing::Nokogiri::FragmentHelper
+
+  test "should render without problems" do
+    result = render(Views::<%= class_name %>.new)
+
+    assert_equal result.css("h1").first.text, "<%= class_name %>"
+    assert_equal result.css("p").first.text, "Find me in <%= @path %>"
+  end
+end

data/lib/generators/test_unit/view_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module TestUnit
+	class ViewGenerator < ::Rails::Generators::NamedBase
+		source_root File.expand_path("templates", __dir__)
+
+		def create_view
+			@path = File.join("app/views", class_path, "#{file_name}.rb")
+			template "view_test.rb.erb", File.join("test/views", class_path, "#{file_name}_test.rb")
+		end
+	end
+end

data/lib/install/phlex.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+say "Installing Phlex..."
+
+application_configuration_path = Rails.root.join("config/application.rb")
+application_configuration_content = File.read(application_configuration_path)
+
+pattern = %r(config.autoload_paths << (Rails.root.join\(.app.\)|.\#{root}/app.)\n)
+
+unless application_configuration_content.match?(pattern)
+	inject_into_class(
+		application_configuration_path,
+		"Application",
+		%(    config.autoload_paths << "\#{root}/app"\n)
+	)
+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?
+	insert_into_file tailwind_config_path, after: "content: [" do
+		"\n    './app/views/**/*.rb',"
+	end
+end
+
+say "Phlex successfully installed!"

data/lib/phlex/rails/buffer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Rails
+		# A wrapper for Rails’ OutputBuffer that acts like a Phlex buffer.
+
+		class Buffer < SimpleDelegator
+			def <<(value)
+				__getobj__.safe_append = (value)
+				self
+			end
+
+			def length
+				__getobj__.length
+			end
+		end
+	end
+end

data/lib/phlex/rails/engine.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "rails/engine"
+
+module Phlex
+	module Rails
+		class Engine < ::Rails::Engine
+		end
+	end
+end

data/lib/phlex/rails/form.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Rails
+		class Form < Phlex::HTML
+			def initialize(model)
+				@model = model
+			end
+
+			def self.input_field(method_name, type:)
+				define_method method_name do |field, value: @model.attributes[field.to_s], **attributes|
+					input(
+						name: field_name(field),
+						type: type,
+						value: value,
+						**attributes
+					)
+				end
+			end
+
+			def template(&block)
+				form action: @url, method: @method do
+					authenticity_token_field
+					yield_content(&block)
+				end
+			end
+
+			def authenticity_token_field
+				input(
+					name: "authenticity_token",
+					type: "hidden",
+					value: @_view_context.form_authenticity_token
+				)
+			end
+
+			def submit(value)
+				input(
+					name: "commit",
+					type: "submit",
+					value: value
+				)
+			end
+
+			def url
+				@_view_context.url_for(@model)
+			end
+
+			def field_name(*field)
+				@_view_context.field_name(ActiveModel::Naming.param_key(@model.class), *field)
+			end
+
+			input_field :url_field, type: "url"
+			input_field :text_field, type: "text"
+			input_field :date_field, type: "date"
+			input_field :time_field, type: "time"
+			input_field :week_field, type: "week"
+			input_field :month_field, type: "month"
+			input_field :email_field, type: "email"
+			input_field :color_field, type: "color"
+			input_field :hidden_field, type: "hidden"
+			input_field :search_field, type: "search"
+			input_field :password_field, type: "password"
+			input_field :telephone_field, type: "tel"
+			input_field :datetime_local_field, type: "datetime-local"
+		end
+	end
+end

data/lib/phlex/rails/helpers.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Rails
+		module Helpers
+			module CSPMetaTag
+				def csp_meta_tag(**options)
+					if (output = @_view_context.csp_meta_tag(**options))
+						@_target << output
+					end
+				end
+			end
+
+			module CSRFMetaTags
+				def csrf_meta_tags
+					if (output = @_view_context.csrf_meta_tags)
+						@_target << output
+					end
+				end
+			end
+
+			module ActionCableMetaTag
+				def action_cable_meta_tag
+					if (output = @_view_context.action_cable_meta_tag)
+						@_target << output
+					end
+				end
+			end
+
+			module FormWith
+				class BufferedFormWith < Phlex::Buffered
+					alias_method :check_box, :__output_method__
+					alias_method :collection_check_boxes, :__output_method__
+					alias_method :collection_radio_buttons, :__output_method__
+					alias_method :collection_select, :__output_method__
+					alias_method :color_field, :__output_method__
+					alias_method :date_field, :__output_method__
+					alias_method :date_select, :__output_method__
+					alias_method :datetime_field, :__output_method__
+					alias_method :datetime_local_field, :__output_method__
+					alias_method :datetime_select, :__output_method__
+					alias_method :email_field, :__output_method__
+					alias_method :file_field, :__output_method__
+					alias_method :grouped_collection_select, :__output_method__
+					alias_method :hidden_field, :__output_method__
+					alias_method :label, :__output_method__
+					alias_method :month_field, :__output_method__
+					alias_method :number_field, :__output_method__
+					alias_method :password_field, :__output_method__
+					alias_method :phone_field, :__output_method__
+					alias_method :radio_button, :__output_method__
+					alias_method :range_field, :__output_method__
+					alias_method :search_field, :__output_method__
+					alias_method :select, :__output_method__
+					alias_method :submit, :__output_method__
+					alias_method :telephone_field, :__output_method__
+					alias_method :text_area, :__output_method__
+					alias_method :text_field, :__output_method__
+					alias_method :time_field, :__output_method__
+					alias_method :time_select, :__output_method__
+					alias_method :time_zone_select, :__output_method__
+					alias_method :url_field, :__output_method__
+					alias_method :week_field, :__output_method__
+					alias_method :weekday_select, :__output_method__
+					alias_method :button, :__output_method__
+				end
+
+				def form_with(*args, **kwargs, &block)
+					@_target << @_view_context.form_with(*args, **kwargs) { |form|
+						capture do
+							yield(
+								BufferedFormWith.new(form, buffer: @_target)
+							)
+						end.html_safe
+					}
+				end
+			end
+
+			module StylesheetLinkTag
+				def stylesheet_link_tag(*sources)
+					if (output = @_view_context.stylesheet_link_tag(*sources))
+						@_target << output
+					end
+				end
+			end
+
+			module FaviconLinkTag
+				def favicon_link_tag(*args)
+					if (output = @_view_context.favicon_link_tag(*args))
+						@_target << output
+					end
+				end
+			end
+
+			module PreloadLinkTag
+				def preload_link_tag(*args)
+					if (output = @_view_context.preload_link_tag(*args))
+						@_target << output
+					end
+				end
+			end
+
+			module JavaScriptIncludeTag
+				def javascript_include_tag(*sources)
+					if (output = @_view_context.javascript_include_tag(*sources))
+						@_target << output
+					end
+				end
+			end
+
+			module JavaScriptImportmapTags
+				def javascript_importmap_tags
+					if (output = @_view_context.javascript_importmap_tags)
+						@_target << output
+					end
+				end
+			end
+
+			module ContentFor
+				def content_for(slot, &block)
+					@_view_context.content_for(slot, capture(&block))
+				end
+			end
+		end
+	end
+end

data/lib/phlex/rails/layout.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Rails
+		module Layout
+			include Helpers::CSPMetaTag
+			include Helpers::CSRFMetaTags
+			include Helpers::FaviconLinkTag
+			include Helpers::PreloadLinkTag
+			include Helpers::StylesheetLinkTag
+			include Helpers::ActionCableMetaTag
+			include Helpers::JavaScriptIncludeTag
+			include Helpers::JavaScriptImportmapTags
+		end
+	end
+end

data/lib/phlex/rails/renderable.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Rails
+		module Renderable
+			def helpers
+				@_view_context
+			end
+
+			def render(renderable, *args, **kwargs, &block)
+				return super if renderable.is_a?(Phlex::HTML)
+				return super if renderable.is_a?(Class) && renderable < Phlex::HTML
+
+				@_target << @_view_context.render(renderable, *args, **kwargs, &block)
+
+				nil
+			end
+
+			def render_in(view_context, &block)
+				output_buffer = view_context.output_buffer
+
+				# Since https://github.com/rails/rails/pull/45731
+				if output_buffer.respond_to?(:raw_buffer)
+					buffer = output_buffer.raw_buffer
+				else
+					buffer = Buffer.new(output_buffer)
+				end
+
+				call(buffer, view_context: view_context, &block)
+
+				nil
+			end
+		end
+	end
+end

data/lib/phlex/rails/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Phlex
-  module Rails
-    VERSION = "0.1.0"
-  end
+	module Rails
+		VERSION = "0.2.0"
+	end
 end

data/lib/phlex/rails.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "rails/version"
+require "phlex"
+require "phlex/rails/engine"
 
-module Phlex
-  module Rails
-    class Error < StandardError; end
-    # Your code goes here...
-  end
+module Phlex::Rails
+	Loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false).tap do |loader|
+		loader.push_dir("#{__dir__}/rails", namespace: Phlex::Rails)
+		loader.setup
+	end
+
+	Phlex::HTML.include(Phlex::Rails::Renderable)
 end

data/lib/phlex/testing/rails.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "phlex/testing/view_helper"
+
+module Phlex::Testing
+	module Rails
+		module ViewHelper
+			include Phlex::Testing::ViewHelper
+
+			def view_context
+				controller.view_context
+			end
+
+			def controller
+				@controller ||= ActionView::TestCase::TestController.new
+			end
+		end
+	end
+end

data/lib/phlex-rails.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "phlex/rails"

data/lib/tasks/phlex_tasks.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+namespace :phlex do
+	desc "Install Phlex in the Rails application"
+
+	task :install do
+		install_file_path = File.expand_path("../install/phlex.rb", __dir__)
+
+		system "#{RbConfig.ruby} bin/rails app:template LOCATION=#{install_file_path}"
+	end
+end