phlex 0.3.2 → 0.5.0

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

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

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

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

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

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

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

@@ -0,0 +1,3 @@
+<%= 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,7 +1,7 @@
 # frozen_string_literal: true
 
 module Views
-	class Heading < Phlex::View
+	class Heading < ApplicationView
 		def template(&block)
 			h1(&block)
 		end

data/fixtures/layout.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Example
-	class LayoutComponent < Phlex::View
+	class LayoutComponent < Phlex::HTML
 		def initialize(title: "Example")
 			@title = title
 		end
@@ -9,7 +9,7 @@ module Example
 		def template(&block)
 			html do
 				head do
-					title @title
+					title { @title }
 					meta name: "viewport", content: "width=device-width,initial-scale=1"
 					link href: "/assets/tailwind.css", rel: "stylesheet"
 				end
@@ -17,9 +17,9 @@ module Example
 				body class: "bg-zinc-100" do
 					nav class: "p-5", id: "main_nav" do
 						ul do
-							li(class: "p-5") { a "Home", href: "/" }
-							li(class: "p-5") { a "About", href: "/about" }
-							li(class: "p-5") { a "Contact", href: "/contact" }
+							li(class: "p-5") { a(href: "/") { "Home" } }
+							li(class: "p-5") { a(href: "/about") { "About" } }
+							li(class: "p-5") { a(href: "/contact") { "Contact" } }
 						end
 					end
 

data/fixtures/page.rb

@@ -1,37 +1,31 @@
 # frozen_string_literal: true
 
 module Example
-	class Page < Phlex::View
+	class Page < Phlex::HTML
 		def template
 			render LayoutComponent.new do
-				h1 "Hi"
+				h1 { "Hi" }
 
-				5.times do
-					div do
-						10.times do
-							a "Test", href: "something", unique: SecureRandom.uuid, data: { value: 1 }
+				table id: "test", class: "a b c d e f g" do
+					tr do
+						td id: "test", class: "a b c d e f g" do
+							span { "Hi" }
 						end
-					end
-				end
 
-				table do
-					thead do
-						10.times do
-							tr do
-								th "Hi"
-							end
+						td id: "test", class: "a b c d e f g" do
+							span { "Hi" }
+						end
+
+						td id: "test", class: "a b c d e f g" do
+							span { "Hi" }
+						end
+
+						td id: "test", class: "a b c d e f g" do
+							span { "Hi" }
 						end
-					end
 
-					tbody do
-						100.times do
-							tr class: "a b c d e f g", id: "something" do
-								10.times do
-									td class: "f g h i j k l" do
-										span "Test"
-									end
-								end
-							end
+						td id: "test", class: "a b c d e f g" do
+							span { "Hi" }
 						end
 					end
 				end

data/fixtures/{test_helper.rb → rails_helper.rb}

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
-require "phlex"
-require "bundler"
+require "phlex/rails"
 
-Bundler.require :test
+Bundler.require :rails
 
 Combustion.path = "fixtures/dummy"
+
 Combustion.initialize! :action_controller do
 	config.autoload_paths << "#{root}/app"
 end
-
-require "view_helper"
-
-Zeitwerk::Loader.eager_load_all

data/fixtures/standard_element.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Fixtures
+	module StandardElement
+		class WithParens < Phlex::HTML
+			def template
+				h1()
+			end
+		end
+
+		class WithoutParens < Phlex::HTML
+			def template
+				h1
+			end
+		end
+
+		module WithAttributes
+			class WithParens < Phlex::HTML
+				def template
+					h1(class: "font-bold")
+				end
+			end
+
+			class WithoutParens < Phlex::HTML
+				def template
+					h1 class: "font-bold"
+				end
+			end
+		end
+
+		module WithBraceBlock
+			class WithParens < Phlex::HTML
+				def template
+					h1() { "Hi" }
+				end
+			end
+
+			class WithoutParens < Phlex::HTML
+				def template
+					h1 { "Hi" }
+				end
+			end
+
+			class WithAttributes < Phlex::HTML
+				def template
+					h1(class: "font-bold") { "Hi" }
+				end
+			end
+		end
+
+		module WithDoBlock
+			class WithParens < Phlex::HTML
+				def template
+					h1() do
+						"Hi"
+					end
+				end
+			end
+
+			class WithoutParens < Phlex::HTML
+				def template
+					h1 do
+						"Hi"
+					end
+				end
+			end
+
+			module WithAttributes
+				class WithParens < Phlex::HTML
+					def template
+						h1(class: "font-bold") do
+							"Hi"
+						end
+					end
+				end
+
+				class WithoutParens < Phlex::HTML
+					def template
+						h1 class: "font-bold" do
+							"Hi"
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/fixtures/view_helper.rb

@@ -10,7 +10,7 @@ module ViewHelper
 
 	def view(&block)
 		let :view do
-			Class.new(Phlex::View, &block)
+			Class.new(Phlex::HTML, &block)
 		end
 	end
 end

data/fixtures/void_element.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Fixtures
+	module VoidElement
+		class WithParens < Phlex::HTML
+			def template
+				img()
+			end
+		end
+
+		class WithoutParens < Phlex::HTML
+			def template
+				img
+			end
+		end
+
+		module WithAttributes
+			class WithParens < Phlex::HTML
+				def template
+					img(class: "a b c")
+				end
+			end
+
+			class WithoutParens < Phlex::HTML
+				def template
+					img class: "a b c"
+				end
+			end
+		end
+	end
+end

data/lib/generators/phlex/collection/USAGE

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

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

@@ -0,0 +1,16 @@
+<% 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/controller/USAGE

@@ -0,0 +1,10 @@
+Description:
+  Generates a Rails controller with Phlex views for the supplied actions
+
+Example:
+  rails generate phlex:controller Articles index show
+
+This will create:
+  app/controllers/articles_controller.rb
+  app/views/articles/index.rb
+  app/views/articles/show.rb

data/lib/generators/phlex/controller/controller_generator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Phlex
+	module Generators
+		class ControllerGenerator < ::Rails::Generators::NamedBase # :nodoc:
+			source_root File.expand_path("templates", __dir__)
+
+			argument :actions, type: :array, default: [], banner: "action action"
+			class_option :skip_routes, type: :boolean, desc: "Don't add routes to config/routes.rb."
+			class_option :parent, type: :string, default: "ApplicationController", desc: "The parent class for the generated controller"
+
+			check_class_collision suffix: "Controller"
+
+			def create_controller_files
+				template "controller.rb.erb", File.join("app/controllers", class_path, "#{file_name}_controller.rb")
+			end
+
+			def copy_view_files
+				base_path = File.join("app/views", class_path, file_name)
+				empty_directory base_path
+
+				actions.each do |action|
+					Rails::Generators.invoke("phlex:view", [remove_possible_suffix(name) + "/" + action])
+				end
+			end
+
+			def add_routes
+				return if options[:skip_routes]
+				return if actions.empty?
+
+				routing_code = actions.map { |action| "get '#{file_name}/#{action}'" }.join("\n")
+				route routing_code, namespace: regular_class_path
+			end
+
+			hook_for :test_framework, as: :controller do |generator|
+				invoke generator, [remove_possible_suffix(name), actions]
+			end
+
+			private
+
+			def parent_class_name
+				options[:parent]
+			end
+
+			def file_name
+				@_file_name ||= remove_possible_suffix(super)
+			end
+
+			def remove_possible_suffix(name)
+				name.sub(/_?controller$/i, "")
+			end
+		end
+	end
+end

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

@@ -0,0 +1,10 @@
+<% module_namespacing do -%>
+class <%= class_name %>Controller < <%= parent_class_name.classify %>
+<% actions.each do |action| -%>
+  def <%= action %>
+    render Views::<%= class_name %>::<%= action.camelize %>.new
+  end
+<%= "\n" unless action == actions.last -%>
+<% end -%>
+end
+<% end -%>

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

@@ -0,0 +1,14 @@
+<% 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 %>" }
+        p { "Find me in <%= @path %>" }
+      <%= "# " unless @has_layout %>end
+    end
+  end
+end
+<% end %>

data/lib/generators/phlex/layout/USAGE

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

data/lib/generators/phlex/layout/layout_generator.rb

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

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

@@ -0,0 +1,31 @@
+<% module_namespacing do -%>
+module Views
+  class <%= class_name %> < Phlex::HTML
+    include ApplicationView
+    include Phlex::Rails::Layout
+
+    def initialize(title:)
+      @title = title
+    end
+
+    def template(&)
+      doctype
+
+      html do
+        head do
+          meta charset: "utf-8"
+          csp_meta_tag
+          csrf_meta_tags
+          meta name: "viewport", content: "width=device-width,initial-scale=1"
+          title { @title }
+          stylesheet_link_tag "application"
+        end
+
+        body do
+          main(&)
+        end
+      end
+    end
+  end
+end
+<% end %>

data/lib/generators/phlex/page/USAGE

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

data/lib/generators/phlex/page/page_generator.rb

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

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

@@ -0,0 +1,13 @@
+<% 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!" }
+      end
+    end
+  end
+end
+<% end %>

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/templates/view.rb.erb

@@ -1,7 +1,13 @@
 <% module_namespacing do -%>
 module Views
-  class <%= class_name %> < ApplicationView
+  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

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

@@ -6,7 +6,15 @@ module Phlex
 			source_root File.expand_path("templates", __dir__)
 
 			def create_view
-				template "view.rb.erb", File.join("app/views", class_path, "#{file_name}.rb")
+				@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
 		end
 	end

data/lib/install/phlex.rb

@@ -20,11 +20,20 @@ unless Rails.root.join("app/views/application_view.rb").exist?
 		# frozen_string_literal: true
 
 		module Views
-		  class ApplicationView < Phlex::View
+		  module ApplicationView
 		    include Rails.application.routes.url_helpers
+		    include Phlex::Translation
 		  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/block.rb

@@ -2,15 +2,13 @@
 
 module Phlex
 	class Block
+		include Callable
+
 		def initialize(context, &block)
 			@context = context
 			@block = block
 		end
 
-		def to_proc
-			method(:call).to_proc
-		end
-
 		def call(*args, **kwargs)
 			@context.instance_exec(*args, **kwargs, &@block)
 		end