phlex-rails-template 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e022001e3e5566f7db0993ffdecfb1882e9f4be95261e3de53f9069b30be35d
+  data.tar.gz: 76e91257fcea31409418c57a18009113828abf25a15baf8eab60f71d7a9bb57e
+SHA512:
+  metadata.gz: b28168c3e642d9e3d69ab2b3344e5f2a7496294ccc74efc712f392e594b279e3e9ee5f416c3ab87fddb69517fa0f5f449b89f63614d7a73892fa8d8f27502dd8
+  data.tar.gz: 98ef56aed1738586da1915935a2a3f1bd6056853084a329495f7bce32a29899744dac141b95eb695cf89edfd1c13ecee7127d91c53233a483bcdcb5b420693fe

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/README.md

@@ -0,0 +1,86 @@
+# Phlex::Rails::Template
+
+A Rails template handler that lets you write Phlex components directly in `.html.rb` view files.
+
+## Installation
+
+Run the following command from the root of your Rails project:
+
+```ruby
+# Make sure you've installed phlex-rails
+bundle add 'phlex-rails-template'
+```
+
+## Usage
+
+Create view files with the `.html.rb` extension:
+
+```ruby
+# app/views/posts/show.html.rb
+h1 { @post.title }
+
+div(class: "content") do
+  p { @post.body }
+end
+```
+
+In your controller:
+
+```ruby
+class PostsController < ApplicationController
+  def show
+    @post = Post.find(params[:id])
+    # Renders app/views/posts/show.html.rb automatically
+  end
+end
+```
+
+Controller instance variables are automatically available in your templates.
+
+## Configuration
+
+You can customize how components are instantiated and how variables are assigned by passing a block to `register`:
+
+```ruby
+# config/initializers/phlex_rails_template.rb
+Phlex::Rails::Template.register :rb do
+  # Override the base component class
+  def component_class
+    ApplicationComponent
+  end
+
+  # Override to instantiate the component with custom arguments
+  def create_component(component_class)
+    component_class.new(view_context.session, request: view_context.request)
+  end
+
+  # Override to customize how controller variables are assigned
+  def assign_variables
+    view_context.assigns.each do |key, value|
+      component.instance_variable_set(:"@#{key}", "PREFIX: #{value}")
+    end
+  end
+end
+```
+
+Or you can pass a configurator class directly:
+
+```ruby
+class CustomConfigurator < Phlex::Rails::Template::Configurator
+  def component_class
+    ApplicationComponent
+  end
+end
+
+Phlex::Rails::Template.register :rb, CustomConfigurator
+```
+
+You can also register additional template handlers with different configurators:
+
+```ruby
+Phlex::Rails::Template.register :customrb, MyCustomConfigurator
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/phlex/rails/template/engine.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Phlex
+  module Rails
+    module Template
+      class Engine < ::Rails::Engine
+        initializer "phlex.rails.template.register_handler" do
+          ActiveSupport.on_load(:action_view) do
+            ActionView::Template.register_template_handler :rb, Phlex::Rails::Template::Handler
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlex/rails/template/handler.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Phlex
+  module Rails
+    module Template
+      class Handler
+        def self.call(template, source = nil)
+          src = source || template.source
+
+          <<~RUBY
+            __component__ = Phlex::Rails::Template.build(self, :rb) do
+              #{src}
+            end
+            __component__.render_in(self).to_s
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/phlex/rails/template/registry.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Phlex
+  module Rails
+    module Template
+      class Registry
+        def initialize
+          @handlers = {}
+        end
+        
+        def register(handler_name, configurator_class = nil, &block)
+          if block_given?
+            @handlers[handler_name] = Class.new(Configurator, &block)
+          else
+            @handlers[handler_name] = configurator_class
+          end
+        end
+        
+        def configurator_class_for(handler_name)
+          @handlers[handler_name] || Configurator
+        end
+        
+        def build(view_context, handler_name, &template_block)
+          configurator_class = configurator_class_for(handler_name)
+          configurator = configurator_class.new(view_context)
+          
+          component_class = Class.new(configurator.component_class) do
+            define_method(:view_template, &template_block)
+          end
+          
+          configurator.build(component_class)
+        end
+      end
+    end
+  end
+end

data/lib/phlex/rails/template/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Phlex
+  module Rails
+    module Template
+      VERSION = "0.1.1"
+    end
+  end
+end

data/lib/phlex/rails/template.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+require_relative "template/version"
+require_relative "template/registry"
+require_relative "template/handler"
+
+module Phlex
+  module Rails
+    module Template
+      class Error < StandardError; end
+      
+      class Configurator
+        attr_reader :view_context, :component
+        
+        def initialize(view_context)
+          @view_context = view_context
+        end
+        
+        def component_class
+          ::Views::Base
+        end
+        
+        def create_component(component_class)
+          component_class.new
+        end
+        
+        def assign_variables
+          assigns = view_context.respond_to?(:view_assigns) ? view_context.view_assigns : view_context.assigns
+          assigns.each do |key, value|
+            ivar = :"@#{key}"
+            if component.instance_variable_defined?(ivar)
+              raise ArgumentError,
+                "Refusing to overwrite #{ivar} on #{component.class}. " \
+                "It was already set by the component before assigns were applied."
+            end
+            component.instance_variable_set(ivar, value)
+          end
+        end
+        
+        def build(component_class)
+          @component = component_class.new
+          assign_variables
+          component
+        end
+      end
+      
+      @registry = Registry.new
+      
+      class << self
+        extend Forwardable
+        
+        attr_reader :registry
+        
+        def_delegators :registry, :register, :build
+      end
+    end
+  end
+end
+
+require_relative "template/engine" if defined?(Rails)

data/sig/phlex/rails/template.rbs

@@ -0,0 +1,8 @@
+module Phlex
+  module Rails
+    module Template
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: phlex-rails-template
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Brad Gessler
+bindir: exe
+cert_chain: []
+date: 2025-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: phlex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Write Phlex components directly in .html.rb view files
+email:
+- bradgessler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- README.md
+- Rakefile
+- lib/phlex/rails/template.rb
+- lib/phlex/rails/template/engine.rb
+- lib/phlex/rails/template/handler.rb
+- lib/phlex/rails/template/registry.rb
+- lib/phlex/rails/template/version.rb
+- sig/phlex/rails/template.rbs
+homepage: https://github.com/beautifulruby/phlex-rails-template
+licenses: []
+metadata:
+  homepage_uri: https://github.com/beautifulruby/phlex-rails-template
+  source_code_uri: https://github.com/beautifulruby/phlex-rails-template
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Rails template handler for Phlex components
+test_files: []