phlex 0.2.1 → 0.3.0

data/docs/pages/index.rb

@@ -1,40 +1,38 @@
 # frozen_string_literal: true
 
 module Pages
-  class Index < ApplicationPage
-    def template
-      render Layout.new(title: "Introduction to Phlex") do
-        render Markdown.new(<<~MD)
-          # Introduction
+	class Index < ApplicationPage
+		def template
+			render Layout.new(title: "Introduction to Phlex") do
+				render Markdown.new(<<~MD)
+	 				# Introduction
 
-          Phlex is a framework for building fast, reusable, testable view components in pure Ruby.
+					Phlex is a framework for building fast, reusable, testable views in pure Ruby.
 
-          Think of a component as anything on a web page that you could draw a circle around and name. Starting on the outside, you have the _“page”_ itself, inside the page is a _“header”_, in the header is a _“nav bar”_ and in the nav bar is a _“nav bar item.”_ These objects together make up an entire page and we call the objects components.
+					Each view object is an instance of a specific class of view. The nav-bar, for example, might contain three different nav-bar-items, but they’re all instances of the nav-bar-item class. This class, then, manifests everything there is to know about nav bar items in general. It models:
 
-          Each component object is an instance of a specific class of component. The nav-bar, for example, might contain three different nav-bar-items, but they’re all instances of the nav-bar-item class. This class, then, manifests everything there is to know about nav bar items in general. It models:
+					1. the **data** attributes being represented — perhaps url and label;
+					2. a **template**, which dictates how the data should be represented with HTML markup and CSS classes; and
+					3. **logic**, conditions, or calculations on the data — perhaps a predicate method to determine whether the link is active or not.
 
-          1. the **data** attributes being represented — perhaps url and label;
-          2. a **template**, which dictates how the data should be represented with HTML markup and CSS classes; and
-          3. **logic**, conditions, or calculations on the data — perhaps a predicate method to determine whether the link is active or not.
+					# Why use Phlex?
 
-          # Why use Phlex?
+					## Better developer experience 🎉
 
-          ## Better developer experience 🎉
+					You don’t need to introduce a new language like Slim, HAML, or ERB. Phlex views are plain old Ruby objects: view classes are just Ruby classes, templates are just methods, and HTML tags are just method calls. If you know how to define a method that calls another method, you pretty much already know how to use Phlex.
 
-          You don’t need to introduce a new language like Slim, HAML, or ERB. Phlex components are plain old Ruby objects: component classes are just Ruby classes, templates are just methods, and HTML tags are just method calls. If you know how to define a method that calls another method, you pretty much already know how to use Phlex.
+					## Better safety 🥽
+					Rails partials can implicitly depend on instance variables from a controller or view. This happens more often than you might think when copying code into a new partial extraction. If the partial is then rendered in a different context or the instance variable’s meaning changes, things can break quite severely without warning.
 
-          ## Better safety 🥽
-          Rails partials can implicitly depend on instance variables from a controller or view. This happens more often than you might think when copying code into a new partial extraction. If the partial is then rendered in a different context or the instance variable’s meaning changes, things can break quite severely without warning.
+					Conversely, Phlex view templates render in an isolated execution context where only the instance variables and methods for the specific view are exposed.
 
-          Conversely, Phlex component templates render in an isolated execution context where only the instance variables and methods for the specific component are exposed.
+					## Better performance 🚀
 
-          ## Better performance 🚀
+					Phlex is ~4.35× faster than ActionView and ~2× faster than ViewComponent. Phlex views are also streamable.
 
-          Phlex is ~4.35× faster than ActionView and ~2× faster than ViewComponent. Phlex components are also streamable.
-
-          Rails apps typically spend 40-80% of the response time rendering views, so this could be a significant factor in overall app performance.
-        MD
-      end
-    end
-  end
+					Rails apps typically spend 40-80% of the response time rendering views, so this could be a significant factor in overall app performance.
+				MD
+			end
+		end
+	end
 end

data/docs/pages/rails_integration.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Pages
+	class RailsIntegration < ApplicationPage
+		def template
+			render Layout.new(title: "Ruby on Rails integration") do
+				render Markdown.new(<<~MD)
+					# Ruby on Rails integration
+
+					## Installation
+
+					To install Phlex into your Rails application, you can run the `bin/rails phlex:install` command.
+
+					## Component generator
+
+					You can generate new views with the `rails g phlex:view` command.
+
+					For example, running `rails g phlex:view Card` will create the following file:
+				MD
+
+				render CodeBlock.new(<<~RUBY, syntax: :ruby)
+					# app/views/card.rb
+
+					module Views
+						class Card < Phlex::View
+							def template
+							end
+						end
+					end
+				RUBY
+
+				render Markdown.new(<<~MD)
+					## Helpers
+
+					You can use the `helpers` proxy to access helpers within a `Phlex::View`.
+
+					For example, you can use the `#t` helper for translations:
+				MD
+
+				render CodeBlock.new(<<~RUBY, syntax: :ruby)
+					# app/views/hello.rb
+
+					module Views
+						class Hello < Phlex::View
+						  delegate :t, to: :helpers
+
+							def template
+							  h1 do
+								  t "hello"
+								end
+							end
+						end
+					end
+				RUBY
+			end
+		end
+	end
+end

data/docs/pages/templates.rb

@@ -1,242 +1,242 @@
 # frozen_string_literal: true
 
 module Pages
-  class Templates < ApplicationPage
-    def template
-      render Layout.new(title: "Templates in Phlex") do
-        render Markdown.new(<<~MD)
-          # Templates
-
-          Rather than use another langauge like ERB, HAML or Slim, Phlex provides a Ruby DSL for defining HTML templates.
-
-          You can create a component class by subclassing `Phlex::Component` and defining a method called `template`. Within the `template` method, you can compose HTML markup by calling the name of any [HTML element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element).
-
-          The first argument to an HTML element method is the _text content_ for that element. For example, here’s a component with an `<h1>` element that says “Hello World!”
-        MD
-
-        render Example.new do |e|
-          e.tab "heading.rb", <<~RUBY
-            class Heading < Phlex::Component
-              def template
-                h1 "Hello World!"
-              end
-            end
-          RUBY
-
-          e.execute "Heading.new.call"
-        end
-
-        render Markdown.new(<<~MD)
-          The text content is always HTML-escaped, so it’s safe to use with user input.
-
-          ## Attributes
-
-          You can add attributes to HTML elements by passing keyword arguments to the tag method. Underscores (`_`) in attribute names are automatically converted to dashes (`-`).
-        MD
-
-        render Example.new do |e|
-          e.tab "heading.rb", <<~RUBY
-            class Heading < Phlex::Component
-              def template
-                h1 "Hello World!",
-                  class: "text-xl font-bold",
-                  aria_details: "details"
-              end
-            end
-          RUBY
-
-          e.execute "Heading.new.call"
-        end
-
-        render Markdown.new(<<~MD)
-          You can also use *boolean* attributes. When set to `true`, the attribute will be rendered without a value, when _falsy_, the attribute isn’t rendered at all.
-        MD
-
-        render Example.new do |e|
-          e.tab "example.rb", <<~RUBY
-            class Example < Phlex::Component
-              def template
-                input type: "radio", name: "channel", id: "1", checked: true
-                input type: "radio", name: "channel", id: "2", checked: false
-              end
-            end
-          RUBY
-
-          e.execute "Example.new.call"
-        end
-
-        render Markdown.new(<<~MD)
-          ## Nesting
-
-          Pass a block to an element method to nest other elements inside it.
-        MD
-
-        render Example.new do |e|
-          e.tab "nav.rb", <<~RUBY
-            class Nav < Phlex::Component
-              def template
-                nav do
-                  ul do
-                    li { a "Home", href: "/" }
-                    li { a "About", href: "/about" }
-                    li { a "Contact", href: "/contact" }
-                  end
-                end
-              end
-            end
-          RUBY
-
-          e.execute "Nav.new.call"
-        end
-
-        render Markdown.new(<<~MD)
-          ## Stand-alone text
-
-          You can also output text without wrapping it in an element by using the `text` method. All text content is HTML-escaped, so it’s safe to use with user input.
-        MD
-
-        render Example.new do |e|
-          e.tab "heading.rb", <<~RUBY
-            class Heading < Phlex::Component
-              def template
-                h1 { strong "Hello "; text "World!" }
-              end
-            end
-          RUBY
-
-          e.execute "Heading.new.call"
-        end
-
-        render Markdown.new(<<~MD)
-          ## Whitespace
-
-          While the examples on this page have been formatted for readability, there is usually no whitespace between HTML tags. If you need to add some whitespace, you can use the `whitespace` method. This is useful for adding space between _inline_ elements to allow them to wrap.
-        MD
-
-        render Example.new do |e|
-          e.tab "links.rb", <<~RUBY
-            class Links < Phlex::Component
-              def template
-                a "Home", href: "/"
-                whitespace
-                a "About", href: "/about"
-                whitespace
-                a "Contact", href: "/contact"
-              end
-            end
-          RUBY
-
-          e.execute "Links.new.call"
-        end
-
-        render Markdown.new(<<~MD)
-          ## Tokens and classes
-
-          The `tokens` method helps you define conditional HTML attribute tokens (such as CSS classes).
-
-          The `tokens` method accepts a splat of tokens that should always be output, and accepts keyword arguments for conditional tokens.
-
-          The keyword arguments allow you to specify under which conditions certain tokens are applicable. The keyword argument keys are the conditions and the values are the tokens. Conditions can be Procs or Symbols that map to a relevant method. The `:active?` Symbol, for example, maps to the `active?` instance method.
-
-          Here we have a `Link` component that produces an `<a>` tag with the CSS class `nav-item`. And if the link is _active_, we also apply the CSS class `nav-item-active`.
-        MD
-
-        render Example.new do |e|
-          e.tab "link.rb", <<~RUBY
-            class Link < Phlex::Component
-              def initialize(text, to:, active:)
-                @text = text
-                @to = to
-                @active = active
-              end
-
-              def template
-                a @text, href: @to, class: tokens("nav-item",
-                  active?: "nav-item-active")
-              end
-
-              private
-
-              def active? = @active
-            end
-          RUBY
-
-          e.tab "example.rb", <<~RUBY
-            class Example < Phlex::Component
-              def template
-                nav do
-                  ul do
-                    li { render Link.new("Home", to: "/", active: true) }
-                    li { render Link.new("About", to: "/about", active: false) }
-                  end
-                end
-              end
-            end
-          RUBY
-
-          e.execute "Example.new.call"
-        end
-
-        render Markdown.new(<<~MD)
-          You can also use the `classes` helper method to create a token list of classes. Since this method returns a hash (e.g. `{ class: "your CSS classes here" }`), you can destructure it into a `class:` keyword argument using the `**` prefix operator.
-        MD
-
-        render Example.new do |e|
-          e.tab "link.rb", <<~RUBY
-            class Link < Phlex::Component
-              def initialize(text, to:, active:)
-                @text = text
-                @to = to
-                @active = active
-              end
-
-              def template
-                a @text, href: @to, **classes("nav-item",
-                  active?: "nav-item-active")
-              end
-
-              private
-
-              def active? = @active
-            end
-          RUBY
-
-          e.tab "example.rb", <<~RUBY
-            class Example < Phlex::Component
-              def template
-                nav do
-                  ul do
-                    li { render Link.new("Home", to: "/", active: true) }
-                    li { render Link.new("About", to: "/about", active: false) }
-                  end
-                end
-              end
-            end
-          RUBY
-
-          e.execute "Example.new.call"
-        end
-
-        render Markdown.new(<<~MD)
-          ## The template element
-
-          Because the `template` method is used to define the component template itself, you need to use the method `template_tag` if you want to to render an HTML `<template>` tag.
-        MD
-
-        render Example.new do |e|
-          e.tab "example.rb", <<~RUBY
-            class Example < Phlex::Component
-              def template
-                template_tag do
-                  img src: "hidden.jpg", alt: "A hidden image."
-                end
-              end
-            end
-          RUBY
-
-          e.execute "Example.new.call"
-        end
-      end
-    end
-  end
+	class Templates < ApplicationPage
+		def template
+			render Layout.new(title: "Templates in Phlex") do
+				render Markdown.new(<<~MD)
+					# Templates
+
+					Rather than use another language like ERB, HAML or Slim, Phlex provides a Ruby DSL for defining HTML templates.
+
+					You can create a view class by subclassing `Phlex::View` and defining a method called `template`. Within the `template` method, you can compose HTML markup by calling the name of any [HTML element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element).
+
+					The first argument to an HTML element method is the _text content_ for that element. For example, here’s a view with an `<h1>` element that says “Hello World!”
+				MD
+
+				render Example.new do |e|
+					e.tab "heading.rb", <<~RUBY
+						class Heading < Phlex::View
+							def template
+								h1 "Hello World!"
+							end
+						end
+					RUBY
+
+					e.execute "Heading.new.call"
+				end
+
+				render Markdown.new(<<~MD)
+					The text content is always HTML-escaped, so it’s safe to use with user input.
+
+					## Attributes
+
+					You can add attributes to HTML elements by passing keyword arguments to the tag method. Underscores (`_`) in attribute names are automatically converted to dashes (`-`).
+				MD
+
+				render Example.new do |e|
+					e.tab "heading.rb", <<~RUBY
+						class Heading < Phlex::View
+							def template
+								h1 "Hello World!",
+									class: "text-xl font-bold",
+									aria_details: "details"
+							end
+						end
+					RUBY
+
+					e.execute "Heading.new.call"
+				end
+
+				render Markdown.new(<<~MD)
+					You can also use *boolean* attributes. When set to `true`, the attribute will be rendered without a value, when _falsy_, the attribute isn’t rendered at all.
+				MD
+
+				render Example.new do |e|
+					e.tab "example.rb", <<~RUBY
+						class Example < Phlex::View
+							def template
+								input type: "radio", name: "channel", id: "1", checked: true
+								input type: "radio", name: "channel", id: "2", checked: false
+							end
+						end
+					RUBY
+
+					e.execute "Example.new.call"
+				end
+
+				render Markdown.new(<<~MD)
+					## Nesting
+
+					Pass a block to an element method to nest other elements inside it.
+				MD
+
+				render Example.new do |e|
+					e.tab "nav.rb", <<~RUBY
+						class Nav < Phlex::View
+							def template
+								nav do
+									ul do
+										li { a "Home", href: "/" }
+										li { a "About", href: "/about" }
+										li { a "Contact", href: "/contact" }
+									end
+								end
+							end
+						end
+					RUBY
+
+					e.execute "Nav.new.call"
+				end
+
+				render Markdown.new(<<~MD)
+					## Stand-alone text
+
+					You can also output text without wrapping it in an element by using the `text` method. All text content is HTML-escaped, so it’s safe to use with user input.
+				MD
+
+				render Example.new do |e|
+					e.tab "heading.rb", <<~RUBY
+						class Heading < Phlex::View
+							def template
+								h1 { strong "Hello "; text "World!" }
+							end
+						end
+					RUBY
+
+					e.execute "Heading.new.call"
+				end
+
+				render Markdown.new(<<~MD)
+					## Whitespace
+
+					While the examples on this page have been formatted for readability, there is usually no whitespace between HTML tags. If you need to add some whitespace, you can use the `whitespace` method. This is useful for adding space between _inline_ elements to allow them to wrap.
+				MD
+
+				render Example.new do |e|
+					e.tab "links.rb", <<~RUBY
+						class Links < Phlex::View
+							def template
+								a "Home", href: "/"
+								whitespace
+								a "About", href: "/about"
+								whitespace
+								a "Contact", href: "/contact"
+							end
+						end
+					RUBY
+
+					e.execute "Links.new.call"
+				end
+
+				render Markdown.new(<<~MD)
+					## Tokens and classes
+
+					The `tokens` method helps you define conditional HTML attribute tokens (such as CSS classes).
+
+					The `tokens` method accepts a splat of tokens that should always be output, and accepts keyword arguments for conditional tokens.
+
+					The keyword arguments allow you to specify under which conditions certain tokens are applicable. The keyword argument keys are the conditions and the values are the tokens. Conditions can be Procs or Symbols that map to a relevant method. The `:active?` Symbol, for example, maps to the `active?` instance method.
+
+					Here we have a `Link` view that produces an `<a>` tag with the CSS class `nav-item`. And if the link is _active_, we also apply the CSS class `nav-item-active`.
+				MD
+
+				render Example.new do |e|
+					e.tab "link.rb", <<~RUBY
+						class Link < Phlex::View
+							def initialize(text, to:, active:)
+								@text = text
+								@to = to
+								@active = active
+							end
+
+							def template
+								a @text, href: @to, class: tokens("nav-item",
+									active?: "nav-item-active")
+							end
+
+							private
+
+							def active? = @active
+						end
+					RUBY
+
+					e.tab "example.rb", <<~RUBY
+						class Example < Phlex::View
+							def template
+								nav do
+									ul do
+										li { render Link.new("Home", to: "/", active: true) }
+										li { render Link.new("About", to: "/about", active: false) }
+									end
+								end
+							end
+						end
+					RUBY
+
+					e.execute "Example.new.call"
+				end
+
+				render Markdown.new(<<~MD)
+					You can also use the `classes` helper method to create a token list of classes. Since this method returns a hash (e.g. `{ class: "your CSS classes here" }`), you can destructure it into a `class:` keyword argument using the `**` prefix operator.
+				MD
+
+				render Example.new do |e|
+					e.tab "link.rb", <<~RUBY
+						class Link < Phlex::View
+							def initialize(text, to:, active:)
+								@text = text
+								@to = to
+								@active = active
+							end
+
+							def template
+								a @text, href: @to, **classes("nav-item",
+									active?: "nav-item-active")
+							end
+
+							private
+
+							def active? = @active
+						end
+					RUBY
+
+					e.tab "example.rb", <<~RUBY
+						class Example < Phlex::View
+							def template
+								nav do
+									ul do
+										li { render Link.new("Home", to: "/", active: true) }
+										li { render Link.new("About", to: "/about", active: false) }
+									end
+								end
+							end
+						end
+					RUBY
+
+					e.execute "Example.new.call"
+				end
+
+				render Markdown.new(<<~MD)
+					## The template element
+
+					Because the `template` method is used to define the view template itself, you need to use the method `template_tag` if you want to to render an HTML `<template>` tag.
+				MD
+
+				render Example.new do |e|
+					e.tab "example.rb", <<~RUBY
+						class Example < Phlex::View
+							def template
+								template_tag do
+									img src: "hidden.jpg", alt: "A hidden image."
+								end
+							end
+						end
+					RUBY
+
+					e.execute "Example.new.call"
+				end
+			end
+		end
+	end
 end