phlex 0.2.2 → 0.3.1

data/lib/phlex/view.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.0")
+	using Overrides::Symbol::Name
+end
+
+module Phlex
+	class View
+		extend HTML
+		include Renderable
+
+		class << self
+			attr_accessor :rendered_at_least_once
+
+			def compile
+				return if @compiled
+				return unless name
+				return if name.start_with? "#"
+
+				Compiler.new(self).call
+
+				@compiled = true
+			end
+
+			def compiled?
+				!!@compiled
+			end
+		end
+
+		def call(buffer = +"", view_context: nil, parent: nil, &block)
+			raise "The same view instance shouldn't be rendered twice" if rendered?
+
+			@_rendered = true
+			@_target = buffer
+			@_view_context = view_context
+			@_parent = parent
+			@output_buffer = self
+
+			template(&block)
+
+			self.class.rendered_at_least_once ||= true
+
+			buffer
+		end
+
+		def rendered?
+			@_rendered ||= false
+		end
+
+		HTML::STANDARD_ELEMENTS.each do |method_name, tag|
+			register_element(method_name, tag: tag)
+		end
+
+		HTML::VOID_ELEMENTS.each do |method_name, tag|
+			register_void_element(method_name, tag: tag)
+		end
+
+		def yield_content(&block)
+			return unless block_given?
+
+			original_length = @_target.length
+			output = yield(self)
+			unchanged = (original_length == @_target.length)
+
+			if unchanged
+				case output
+				when String, Symbol, Integer, Float
+					text(output)
+				end
+			end
+
+			nil
+		end
+
+		def text(content)
+			@_target << case content
+			when String then CGI.escape_html(content)
+			when Symbol then CGI.escape_html(content.name)
+			else CGI.escape_html(content.to_s)
+			end
+
+			nil
+		end
+
+		def whitespace
+			@_target << " "
+			nil
+		end
+
+		def comment(content = "")
+			@_target << "<!-- " << CGI.escape_html(content.to_s) << " -->"
+			nil
+		end
+
+		def doctype
+			@_target << HTML::DOCTYPE
+			nil
+		end
+
+		def raw(content)
+			@_target << content
+			nil
+		end
+
+		def html_safe?
+			true
+		end
+
+		def safe_append=(value)
+			return unless value
+
+			@_target << case value
+			when String then value
+			when Symbol then value.name
+			else value.to_s
+			end
+		end
+
+		def append=(value)
+			return unless value
+
+			if value.html_safe?
+				self.safe_append = value
+			else
+				@_target << case value
+				when String then CGI.escape_html(value)
+				when Symbol then CGI.escape_html(value.name)
+				else CGI.escape_html(value.to_s)
+				end
+			end
+		end
+
+		def capture(&block)
+			return unless block_given?
+
+			original_buffer = @_target
+			new_buffer = +""
+			@_target = new_buffer
+
+			yield
+
+			@_target = original_buffer
+			new_buffer.html_safe
+		end
+
+		def classes(*tokens, **conditional_tokens)
+			{ class: self.tokens(*tokens, **conditional_tokens) }
+		end
+
+		def tokens(*tokens, **conditional_tokens)
+			conditional_tokens.each do |condition, token|
+				case condition
+				when Symbol then next unless send(condition)
+				when Proc then next unless condition.call
+				else raise ArgumentError,
+					"The class condition must be a Symbol or a Proc."
+				end
+
+				case token
+				when Symbol then tokens << token.name
+				when String then tokens << token
+				when Array then tokens.concat(t)
+				else raise ArgumentError,
+					"Conditional classes must be Symbols, Strings, or Arrays of Symbols or Strings."
+				end
+			end
+
+			tokens.compact.join(" ")
+		end
+
+		def helpers
+			@_view_context
+		end
+
+		def _attributes(attributes, buffer: +"")
+			if attributes[:href]&.start_with?(/\s*javascript/)
+				attributes[:href] = attributes[:href].sub(/^\s*(javascript:)+/, "")
+			end
+
+			_build_attributes(attributes, buffer: buffer)
+
+			unless self.class.rendered_at_least_once
+				Phlex::ATTRIBUTE_CACHE[attributes.hash] = buffer.freeze
+			end
+
+			buffer
+		end
+
+		def _build_attributes(attributes, buffer:)
+			attributes.each do |k, v|
+				next unless v
+
+				name = case k
+				when String
+					k
+				when Symbol
+					k.name.tr("_", "-")
+				else
+					k.to_s
+				end
+
+				if HTML::EVENT_ATTRIBUTES[name] || name.match?(/[<>&"']/)
+					raise ArgumentError, "Unsafe attribute name detected: #{k}."
+				end
+
+				case v
+				when true
+					buffer << " " << name
+				when String
+					buffer << " " << name << '="' << CGI.escape_html(v) << '"'
+				when Symbol
+					buffer << " " << name << '="' << CGI.escape_html(v.name) << '"'
+				when Hash
+					_build_attributes(v.transform_keys { "#{k}-#{_1.name.tr('_', '-')}" }, buffer: buffer)
+				else
+					buffer << " " << name << '="' << CGI.escape_html(v.to_s) << '"'
+				end
+			end
+
+			buffer
+		end
+	end
+end

data/lib/phlex.rb

@@ -2,29 +2,44 @@
 
 require "cgi"
 require "zeitwerk"
+require "syntax_tree"
 
 loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
 loader.ignore("#{__dir__}/generators")
 loader.inflector.inflect("html" => "HTML")
+loader.inflector.inflect("vcall" => "VCall")
+loader.inflector.inflect("fcall" => "FCall")
 loader.setup
 
 module Phlex
-  Error = Module.new
-  ArgumentError = Class.new(ArgumentError) { include Error }
+	Error = Module.new
+	ArgumentError = Class.new(ArgumentError) { include Error }
+	NameError = Class.new(NameError) { include Error }
 
-  extend self
+	extend self
 
-  ATTRIBUTE_CACHE = {}
+	ATTRIBUTE_CACHE = {}
 
-  def configuration
-    @configuration ||= Configuration.new
-  end
+	def const_missing(name)
+		if name == :Component
+			raise NameError, "👋 Phlex::Component is now Phlex::View"
+		else
+			super
+		end
+	end
 
-  def configure
-    yield configuration
-  end
+	def configuration
+		@configuration ||= Configuration.new
+	end
+
+	def configure
+		yield configuration
+	end
 end
 
-if defined?(Rails::Engine)
-  require "rails"
+begin
+	require "rails"
+	require "phlex/engine"
+rescue LoadError
+	# Rails isn't in this env, don't load the engine.
 end

data/lib/tasks/phlex_tasks.rake

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: phlex
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Joel Drapper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2022-09-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: syntax_tree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -24,17 +38,18 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-description: A high-performance view component framework optimised for developer happiness.
+description: A high-performance view framework optimised for developer happiness.
 email:
 - joel@drapper.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".rspec"
 - ".rubocop.yml"
-- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -56,10 +71,11 @@ files:
 - docs/components/title.rb
 - docs/page_builder.rb
 - docs/pages/application_page.rb
-- docs/pages/components.rb
 - docs/pages/index.rb
+- docs/pages/rails_integration.rb
 - docs/pages/templates.rb
-- fixtures/component_helper.rb
+- docs/pages/views.rb
+- fixtures/compilation/vcall.rb
 - fixtures/dummy/app/assets/config/manifest.js
 - fixtures/dummy/app/controllers/articles_controller.rb
 - fixtures/dummy/app/views/articles/form.rb
@@ -76,20 +92,33 @@ files:
 - fixtures/layout.rb
 - fixtures/page.rb
 - fixtures/test_helper.rb
-- lib/generators/phlex/component/USAGE
-- lib/generators/phlex/component/component_generator.rb
-- lib/generators/phlex/component/templates/component.rb.erb
+- fixtures/view_helper.rb
+- lib/generators/phlex/view/USAGE
+- lib/generators/phlex/view/templates/view.rb.erb
+- lib/generators/phlex/view/view_generator.rb
+- lib/install/phlex.rb
 - lib/overrides/symbol/name.rb
 - lib/phlex.rb
 - lib/phlex/block.rb
 - lib/phlex/buffered.rb
-- lib/phlex/component.rb
+- lib/phlex/compiler.rb
+- lib/phlex/compiler/formatter.rb
+- lib/phlex/compiler/generators/standard_element.rb
+- lib/phlex/compiler/generators/void_element.rb
+- lib/phlex/compiler/optimizers/base_optimizer.rb
+- lib/phlex/compiler/optimizers/vcall.rb
+- lib/phlex/compiler/visitors/base_visitor.rb
+- lib/phlex/compiler/visitors/component.rb
+- lib/phlex/compiler/visitors/component_method.rb
+- lib/phlex/compiler/visitors/file.rb
 - lib/phlex/configuration.rb
+- lib/phlex/engine.rb
 - lib/phlex/html.rb
-- lib/phlex/rails.rb
 - lib/phlex/rails/tag_helpers.rb
 - lib/phlex/renderable.rb
 - lib/phlex/version.rb
+- lib/phlex/view.rb
+- lib/tasks/phlex_tasks.rake
 - package-lock.json
 - package.json
 - phlex_logo.png
@@ -122,5 +151,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: A framework for building view components with a Ruby DSL.
+summary: A framework for building views with a Ruby DSL.
 test_files: []

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2022-06-01
-
-- Initial release

data/docs/pages/components.rb

@@ -1,175 +0,0 @@
-# frozen_string_literal: true
-
-module Pages
-  class Components < ApplicationPage
-    def template
-      render Layout.new(title: "Components in Phlex") do
-        render Markdown.new(<<~MD)
-          # Components
-
-          ## Yielding content
-
-          Your components 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::Component
-              def template(&)
-                article(class: "drop-shadow rounded p-5") {
-                  h1 "Amazing content!"
-                  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 component or tag.
-        MD
-
-        render Example.new do |e|
-          e.tab "card.rb", <<~RUBY
-            class Card < Phlex::Component
-              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 components
-
-          Components can render other components and optionally pass them content as a block.
-        MD
-
-        render Example.new do |e|
-          e.tab "example.rb", <<~RUBY
-            class Example < Phlex::Component
-              def template
-                render Card.new do
-                  h1 "Hello"
-                end
-              end
-            end
-          RUBY
-
-          e.tab "card.rb", <<~RUBY
-            class Card < Phlex::Component
-              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::Component
-              def template
-                render(Card.new) { "Hi" }
-              end
-            end
-          RUBY
-
-          e.tab "card.rb", <<~RUBY
-            class Card < Phlex::Component
-              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, components 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::Component
-              def initialize(name:)
-                @name = name
-              end
-
-              def template
-                h1 "Hello \#{@name}!"
-              end
-            end
-          RUBY
-
-          e.tab "example.rb", <<~RUBY
-            class Example < Phlex::Component
-              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 component 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
-
-          Components are just Ruby classes, so you can perform calculations on component attributes by defining your own methods.
-        MD
-
-        render Example.new do |e|
-          e.tab "status.rb", <<~RUBY
-            class Status < Phlex::Component
-              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::Component
-              def template
-                render Status.new(status: :success)
-              end
-            end
-          RUBY
-
-          e.execute "Example.new.call"
-        end
-      end
-    end
-  end
-end

data/fixtures/component_helper.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module ComponentHelper
-  def self.extended(parent)
-    parent.instance_exec do
-      let(:output) { example.call }
-      let(:example) { component.new }
-    end
-  end
-
-  def component(&block)
-    let :component do
-      Class.new(Phlex::Component, &block)
-    end
-  end
-end

data/lib/generators/phlex/component/USAGE

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

data/lib/generators/phlex/component/component_generator.rb

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