phlex 0.2.2 → 0.3.1

data/docs/pages/views.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module Pages
+	class Views < ApplicationPage
+		def template
+			render Layout.new(title: "Components in Phlex") do
+				render Markdown.new(<<~MD)
+					#  Views
+
+					## Yielding content
+
+					Your views can accept content as a block passed to the template method. You can capture the content block and pass it to the `content` method to yield it.
+				MD
+
+				render Example.new do |e|
+					e.tab "card.rb", <<~RUBY
+						class Card < Phlex::View
+							def template(&)
+								article(class: "drop-shadow rounded p-5") {
+									h1 "Amazing content!"
+									yield_content(&)
+								}
+							end
+						end
+					RUBY
+
+					e.execute "Card.new.call { 'Your content here.\n' }"
+				end
+
+				render Markdown.new(<<~MD)
+					## Delegating content
+
+					Alternatively, you can pass the content down as an argument to another view or tag.
+				MD
+
+				render Example.new do |e|
+					e.tab "card.rb", <<~RUBY
+						class Card < Phlex::View
+							def template(&)
+								article(class: "drop-shadow rounded p-5", &)
+							end
+						end
+					RUBY
+
+					e.execute "Card.new.call { 'Your content here.' }"
+				end
+
+				render Markdown.new(<<~MD)
+					## Nested views
+
+					Components can render other views and optionally pass them content as a block.
+				MD
+
+				render Example.new do |e|
+					e.tab "example.rb", <<~RUBY
+						class Example < Phlex::View
+							def template
+								render Card.new do
+									h1 "Hello"
+								end
+							end
+						end
+					RUBY
+
+					e.tab "card.rb", <<~RUBY
+						class Card < Phlex::View
+							def template(&)
+								article(class: "drop-shadow rounded p-5", &)
+							end
+						end
+					RUBY
+
+					e.execute "Example.new.call"
+				end
+
+				render Markdown.new(<<~MD)
+					If the block just wraps a string, the string is treated as _text content_.
+				MD
+
+				render Example.new do |e|
+					e.tab "example.rb", <<~RUBY
+						class Example < Phlex::View
+							def template
+								render(Card.new) { "Hi" }
+							end
+						end
+					RUBY
+
+					e.tab "card.rb", <<~RUBY
+						class Card < Phlex::View
+							def template(&)
+								article(class: "drop-shadow rounded p-5", &)
+							end
+						end
+					RUBY
+
+					e.execute "Example.new.call"
+				end
+
+				render Markdown.new(<<~MD)
+					## Component attributes
+
+					Besides content, views can define attributes in an initializer, which can then be rendered in the template.
+				MD
+
+				render Example.new do |e|
+					e.tab "hello.rb", <<~RUBY
+						class Hello < Phlex::View
+							def initialize(name:)
+								@name = name
+							end
+
+							def template
+								h1 "Hello \#{@name}!"
+							end
+						end
+					RUBY
+
+					e.tab "example.rb", <<~RUBY
+						class Example < Phlex::View
+							def template
+								render Hello.new(name: "Joel")
+							end
+						end
+					RUBY
+
+					e.execute "Example.new.call"
+				end
+
+				render Markdown.new(<<~MD)
+					It’s usually a good idea to use instance variables directly rather than creating accessor methods for them. Otherwise it’s easy to run into naming conflicts. For example, your layout view might have the attribute `title`, to render into a `<title>` element in the document head. If you define `attr_accessor :title`, that would overwrite the `title` method for creating `<title>` elements.
+
+					## Calculations with methods
+
+					Views are just Ruby classes, so you can perform calculations on view attributes by defining your own methods.
+				MD
+
+				render Example.new do |e|
+					e.tab "status.rb", <<~RUBY
+						class Status < Phlex::View
+							def initialize(status:)
+								@status = status
+							end
+
+							def template
+								span status_emoji
+							end
+
+							private
+
+							def status_emoji
+								case @status
+								when :success
+									"✅"
+								when :failure
+									"❌"
+								end
+							end
+						end
+					RUBY
+
+					e.tab "example.rb", <<~RUBY
+						class Example < Phlex::View
+							def template
+								render Status.new(status: :success)
+							end
+						end
+					RUBY
+
+					e.execute "Example.new.call"
+				end
+			end
+		end
+	end
+end

data/fixtures/compilation/vcall.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Fixtures
+	module Compilation
+		module VCall
+			class WithStandardElement < Phlex::View
+				def template
+					div
+				end
+			end
+
+			class WithVoidElement < Phlex::View
+				def template
+					img
+				end
+			end
+
+			class WithAnotherMethodCall < Phlex::View
+				def template
+					article
+					some_other_method
+					article
+				end
+			end
+
+			class WithRedefinedTagMethod < Phlex::View
+				def template
+					title
+					article
+				end
+
+				def title
+					h1
+				end
+			end
+		end
+	end
+end

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 module Views
-  module Articles
-    class Form < Phlex::Component
-      def template
-        form_with url: "test" do |f|
-          f.text_field :name
-        end
-      end
-    end
-  end
+	module Articles
+		class Form < Phlex::View
+			def template
+				form_with url: "test" do |f|
+					f.text_field :name
+				end
+			end
+		end
+	end
 end

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

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

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

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

data/fixtures/dummy/config/routes.rb

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

data/fixtures/dummy/db/schema.rb

@@ -1,6 +1,6 @@
 # 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.
+	# Set up any tables you need to exist for your test suite that don't belong
+	# in migrations.
 end

data/fixtures/layout.rb

@@ -1,31 +1,31 @@
 # frozen_string_literal: true
 
 module Example
-  class LayoutComponent < Phlex::Component
-    def initialize(title: "Example")
-      @title = title
-    end
+	class LayoutComponent < Phlex::View
+		def initialize(title: "Example")
+			@title = title
+		end
 
-    def template(&block)
-      html do
-        head do
-          title @title
-          meta name: "viewport", content: "width=device-width,initial-scale=1"
-          link href: "/assets/tailwind.css", rel: "stylesheet"
-        end
+		def template(&block)
+			html do
+				head do
+					title @title
+					meta name: "viewport", content: "width=device-width,initial-scale=1"
+					link href: "/assets/tailwind.css", rel: "stylesheet"
+				end
 
-        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" }
-            end
-          end
+				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" }
+						end
+					end
 
-          div class: "container mx-auto p-5", &block
-        end
-      end
-    end
-  end
+					div class: "container mx-auto p-5", &block
+				end
+			end
+		end
+	end
 end

data/fixtures/page.rb

@@ -1,41 +1,41 @@
 # frozen_string_literal: true
 
 module Example
-  class Page < Phlex::Component
-    def template
-      render LayoutComponent.new do
-        h1 "Hi"
+	class Page < Phlex::View
+		def template
+			render LayoutComponent.new do
+				h1 "Hi"
 
-        5.times do
-          div do
-            10.times do
-              a "Test", href: "something", unique: SecureRandom.uuid, data: { value: 1 }
-            end
-          end
-        end
+				5.times do
+					div do
+						10.times do
+							a "Test", href: "something", unique: SecureRandom.uuid, data: { value: 1 }
+						end
+					end
+				end
 
-        table do
-          thead do
-            10.times do
-              tr do
-                th "Hi"
-              end
-            end
-          end
+				table do
+					thead do
+						10.times do
+							tr do
+								th "Hi"
+							end
+						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
-            end
-          end
-        end
-      end
-    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
+						end
+					end
+				end
+			end
+		end
+	end
 end

data/fixtures/test_helper.rb

@@ -7,7 +7,7 @@ Bundler.require :test
 
 Combustion.path = "fixtures/dummy"
 Combustion.initialize! :action_controller do
-  config.autoload_paths << "#{root}/app"
+	config.autoload_paths << "#{root}/app"
 end
 
-require "component_helper"
+require "view_helper"

data/fixtures/view_helper.rb

@@ -0,0 +1,16 @@
+# 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::View, &block)
+		end
+	end
+end

data/lib/generators/phlex/view/USAGE

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

data/lib/generators/phlex/{component/templates/component.rb.erb → view/templates/view.rb.erb}

@@ -1,6 +1,6 @@
 <% module_namespacing do -%>
 module Views
-  class <%= class_name %> < Phlex::Component
+  class <%= class_name %> < ApplicationView
     def template
     end
   end

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

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

data/lib/install/phlex.rb

@@ -0,0 +1,30 @@
+# 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
+		  class ApplicationView < Phlex::View
+		    include Rails.application.routes.url_helpers
+		  end
+		end
+	RUBY
+end
+
+say "Phlex successfully installed!"

data/lib/overrides/symbol/name.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Overrides::Symbol::Name
-  refine(Symbol) { alias_method :name, :to_s }
+	refine(Symbol) { alias_method :name, :to_s }
 end

data/lib/phlex/block.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 module Phlex
-  class Block
-    def initialize(context, &block)
-      @context = context
-      @block = block
-    end
+	class Block
+		def initialize(context, &block)
+			@context = context
+			@block = block
+		end
 
-    def to_proc
-      method(:call).to_proc
-    end
+		def to_proc
+			method(:call).to_proc
+		end
 
-    def call(*args, **kwargs)
-      @context.instance_exec(*args, **kwargs, &@block)
-    end
-  end
+		def call(*args, **kwargs)
+			@context.instance_exec(*args, **kwargs, &@block)
+		end
+	end
 end

data/lib/phlex/buffered.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
 module Phlex
-  class Buffered
-    def initialize(object, buffer:)
-      @object, @buffer = object, buffer
-    end
+	class Buffered
+		def initialize(object, buffer:)
+			@object, @buffer = object, buffer
+		end
 
-    def method_missing(name, *args, **kwargs, &block)
-      output = @object.public_send(name, *args, **kwargs, &block)
-      @buffer << output if output.is_a? String
-      nil
-    end
+		def method_missing(name, *args, **kwargs, &block)
+			output = @object.public_send(name, *args, **kwargs, &block)
+			@buffer << output if output.is_a? String
+			nil
+		end
 
-    def respond_to_missing?(name)
-      @object.respond_to?(name)
-    end
-  end
+		def respond_to_missing?(name)
+			@object.respond_to?(name)
+		end
+	end
 end

data/lib/phlex/compiler/formatter.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Phlex
+	class Compiler
+		class Formatter < SyntaxTree::Formatter
+			def genspace
+				-> (n) { "\t" * (n / 2) }
+			end
+
+			def format(node, stackable: true)
+				stack << node if stackable
+				doc = node.format(self)
+				stack.pop if stackable
+				doc
+			end
+
+			def flush
+				text "" if @open_string_append
+
+				super
+			end
+
+			def breakable(*args, **kwargs)
+				if !@texting && @open_string_append
+					@broken = kwargs
+				else
+					super
+				end
+			end
+
+			def chain_append(&block)
+				@appending = true
+
+				if @open_string_append
+					text '" << '
+				elsif @open_chain_append
+					text " << "
+				else
+					text "@_target << "
+				end
+
+				@open_string_append = false
+				@open_chain_append = true
+
+				yield(self)
+
+				@appending = false
+			end
+
+			def append(&block)
+				@appending = true
+
+				unless @open_string_append
+					if @open_chain_append
+						text ' << "'
+					else
+						text '@_target << "'
+					end
+
+					@open_chain_append = false
+					@open_string_append = true
+				end
+
+				yield(self)
+
+				@appending = false
+			end
+
+			def text(value, ...)
+				@texting = true
+
+				unless @appending
+					if @open_string_append
+						super('"')
+						@open_string_append = false
+					end
+
+					@open_chain_append = false
+
+					breakable(**@broken) if @broken
+				end
+
+				@broken = false
+
+				super
+
+				@texting = false
+			end
+		end
+	end
+end