view_component_subtemplates 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 604c21a85c4afb58ae6b08b1bc1fcbc99ed132de60bb7d9e846b3fe0e50e0c25
+  data.tar.gz: b5a0456d4a5d8f83d3368f03839a2d04ffbcb6edbc97e2d6224eaae30737a4d5
+SHA512:
+  metadata.gz: 276d58f9205465d4c98cb4fe864764dd58d130a850b4b05bb3a5c21942f68edc8a5f123aa5d8dbe68ac4746ea282c97d299a44df5bae3bb4cddfc091182757a1
+  data.tar.gz: f36101a4c89486232386935f7b1676a9b359aa1b0ede4b6df95fbf5ef371d4dc5b6633fb3cb59c86f73dc6fea20c60696e42059e447ce3a40934eb0dd8407290

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-07-18
+
+### Agregado
+- Implementación inicial del soporte para sub-templates en ViewComponent usando archivos sidecar
+- Añadido el DSL `template_arguments` para definir argumentos en sub-templates
+- Generación dinámica de métodos `call_*` para sub-templates con validación estricta de argumentos
+- Integración con el flujo de compilación de ViewComponent

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/README.md

@@ -0,0 +1,124 @@
+# ViewComponent Subtemplates
+
+[![Gem Version](https://badge.fury.io/rb/view_component_subtemplates.svg)](https://badge.fury.io/rb/view_component_subtemplates)
+[![Build Status](https://github.com/bukhr/view_component_subtemplates/workflows/CI/badge.svg)](https://github.com/bukhr/view_component_subtemplates/actions)
+
+Adds support for **sub-templates with typed arguments** to [ViewComponent](https://viewcomponent.org/), enabling modular, reusable component architectures.
+
+## Features
+
+✅ **Template Arguments** - Define typed arguments for sub-templates  
+✅ **Automatic Detection** - Sub-templates discovered in component sidecar directories  
+✅ **Dynamic Methods** - `call_[name]` helper methods generated automatically  
+✅ **ViewComponent Integration** - Seamless integration with existing ViewComponent workflow  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'view_component_subtemplates'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Quick Start
+
+### 1. Define a component
+
+```ruby
+# app/components/table_component.rb
+class TableComponent < ViewComponent::Base
+  def initialize(users:, title:)
+    @users = users
+    @title = title
+  end
+end
+```
+
+### 2. Create your templates
+
+```erb
+<!-- app/components/table_component.html.erb -->
+<div class="table-container">
+  <%= call_header(title: @title, sortable: true) %>
+  
+  <tbody>
+    <% @users.each_with_index do |user, index| %>
+      <%= call_row(model: user, highlight: index.even?) %>
+    <% end %>
+  </tbody>
+  
+  <%= call_footer(total_count: @users.count) %>
+</div>
+```
+
+### 3. File structure
+
+```
+app/components/
+├── table_component.rb
+├── table_component.html.erb
+└── table_component/
+    ├── header.html.erb
+    ├── row.html.erb
+    └── footer.html.erb
+```
+
+### 4. Sub-template files
+
+```erb
+<!-- app/components/table_component/header.html.erb -->
+<%# locals: (title:, sortable:) -%>
+<thead class="<%= 'sortable' if sortable %>">
+  <tr>
+    <th><%= title %></th>
+    <th>Actions</th>
+  </tr>
+</thead>
+```
+
+```erb
+<!-- app/components/table_component/row.html.erb -->
+<%# locals: (model:, highlight:) -%>
+<tr class="<%= 'highlighted' if highlight %>">
+  <td><%= model.name %></td>
+  <td><%= model.email %></td>
+</tr>
+```
+
+```erb
+<!-- app/components/table_component/footer.html.erb -->
+<%# locals: (total_count:) -%>
+<tfoot>
+  <tr>
+    <td colspan="2">Total: <%= total_count %> users</td>
+  </tr>
+</tfoot>
+```
+
+### 5. Use in your views
+
+```erb
+<%= render TableComponent.new(users: @users, title: "User List") %>
+```
+
+## Requirements
+
+- Ruby >= 3.1.0
+- Rails >= 7.0.0
+- ViewComponent >= 4.2.0
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+```bash
+bundle install
+bundle exec rake test
+```
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/view_component_subtemplates/compiler_extension.rb

@@ -0,0 +1,38 @@
+# compiler_extension.rb
+module ViewComponentSubtemplates
+  module CompilerExtension
+    # Processes a component class to compile its sub-templates.
+    # Called from the after_compile hook.
+    def self.process_component(component_class)
+      gather_sub_templates_for(component_class).each do |sub_template|
+        sub_template.compile_to_component
+      end
+    end
+
+    private
+
+    def self.gather_sub_templates_for(component_class)
+      component_subdir = ViewComponentSubtemplates.component_subdir_for(component_class)
+      return [] unless Dir.exist?(component_subdir)
+
+      template_extensions = ActionView::Template.template_handler_extensions
+      
+      Dir.glob(File.join(component_subdir, "*")).filter_map do |file_path|
+        next unless File.file?(file_path)
+        
+        file_extension = File.extname(file_path)[1..] # Remove the leading dot
+        next unless template_extensions.include?(file_extension)
+        
+        # Correctly extract template name by removing the first extension found.
+        # e.g. "header.html.erb" -> "header"
+        template_name = File.basename(file_path).split('.').first
+        
+        SubTemplate.new(
+          component: component_class,
+          path: file_path,
+          template_name: template_name
+        )
+      end
+    end
+  end
+end

data/lib/view_component_subtemplates/sub_template.rb

@@ -0,0 +1,106 @@
+# sub_template.rb
+module ViewComponentSubtemplates
+  # Represents a single sub-template file associated with a ViewComponent.
+  # This class is responsible for parsing the template, extracting its arguments,
+  # and defining the corresponding `call_*` method on the component class.
+  #
+  # PUBLIC API - The following methods are guaranteed to be stable across minor versions:
+  # - #component:       Returns the associated component class.
+  # - #path:             Returns the absolute path to the template file.
+  # - #template_name:    Returns the short name of the template (e.g., `header`).
+  # - #explicit_locals:  Returns an array of symbols for the template's arguments.
+  # - #source:           Returns the raw source code of the template file.
+  #
+  # PRIVATE API - All other methods are subject to change without notice.
+  class SubTemplate
+    # PUBLIC API
+    attr_reader :component, :path, :template_name
+
+    def initialize(component:, path:, template_name:)
+      @component = component
+      @path = path
+      @template_name = template_name
+      @source = nil # Lazily loaded
+      @explicit_locals = nil # Lazily loaded
+    end
+
+    def source
+      @source ||= File.read(path)
+    end
+
+    def explicit_locals
+      @explicit_locals ||= extract_explicit_locals_from_source
+    end
+
+    # This is the main entry point for the class from the compiler extension
+    def compile_to_component
+      validate_file_exists!
+      compiled_source = compile_erb_source
+      define_render_method(compiled_source, explicit_locals)
+    end
+
+    private
+
+    def validate_file_exists!
+      unless File.exist?(path)
+        raise ViewComponentSubtemplates::Error, "Template file not found: #{path}"
+      end
+    end
+
+    def extract_explicit_locals_from_source
+      match = source.match(/<%#\s*locals:\s*\((.*?)\)\s*-%>/)
+      return [] unless match
+
+      locals_string = match[1]
+      locals_string.scan(/(\w+):/).flatten.map(&:to_sym)
+    end
+
+    def compile_erb_source
+      erb = ERB.new(source)
+      erb.filename = path
+      erb.src
+    end
+
+    def define_render_method(compiled_source, expected_args)
+      render_method_name = "__render_sub_template_#{template_name}"
+      call_method_name = "call_#{template_name}"
+
+      define_private_render_method(render_method_name, compiled_source, expected_args)
+      define_public_call_method(call_method_name, render_method_name, expected_args)
+    end
+
+    def define_private_render_method(name, compiled_source, args)
+      @component.class_eval <<~RUBY, path, 1
+        private
+        def #{name}(#{args.join(', ')})
+          (#{compiled_source}).html_safe
+        end
+      RUBY
+    end
+
+    def define_public_call_method(call_name, render_name, args)
+      @component.silence_redefinition_of_method(call_name.to_sym)
+
+      if args.any?
+        signature = args.map { |arg| "#{arg}:" }.join(", ")
+        forwarded_args = args.join(", ")
+
+        @component.class_eval <<~RUBY, path, 1
+          def #{call_name}(#{signature})
+            #{render_name}(#{forwarded_args})
+          end
+        RUBY
+      else
+        @component.class_eval <<~RUBY, path, 1
+          def #{call_name}
+            #{render_name}
+          end
+        RUBY
+      end
+    end
+  end
+end
+
+
+
+

data/lib/view_component_subtemplates/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ViewComponentSubtemplates
+  VERSION = "0.1.0"
+end

data/lib/view_component_subtemplates.rb

@@ -0,0 +1,43 @@
+# view_component_subtemplates.rb
+# frozen_string_literal: true
+
+require "view_component"
+
+# Ensure ViewComponent internals are loaded
+require "view_component/base"
+require "view_component/compiler"
+
+require_relative "view_component_subtemplates/version"
+require_relative "view_component_subtemplates/compiler_extension"
+
+module ViewComponentSubtemplates
+  class Error < StandardError; end
+
+  def self.sub_template_path_for(component_class, template_name)
+    component_dir = File.dirname(component_class.identifier)
+    component_name = component_class.name.demodulize.underscore
+    File.join(component_dir, component_name, "#{template_name}.html.erb")
+  end
+
+  def self.component_subdir_for(component_class)
+    component_dir = File.dirname(component_class.identifier)
+    component_name = component_class.name.demodulize.underscore
+    File.join(component_dir, component_name)
+  end
+
+  # Module to extend ViewComponent::Base class methods
+  # This hooks into the after_compile class method from ViewComponent PR #2411
+  module AfterCompileHook
+    def after_compile
+      super
+      ViewComponentSubtemplates::CompilerExtension.process_component(self)
+    end
+  end
+end
+
+# Load SubTemplate after the module is fully configured
+require_relative "view_component_subtemplates/sub_template"
+
+# Extend ViewComponent::Base class methods to hook into after_compile
+# This uses prepend on the singleton class to extend the class method
+ViewComponent::Base.singleton_class.prepend(ViewComponentSubtemplates::AfterCompileHook)

data/sig/view_component_subtemplates.rbs

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

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: view_component_subtemplates
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jsolas
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Adds support for sub-templates with arguments to ViewComponent, allowing
+  components to have multiple templates in their sidecar directory.
+email:
+- jsolas@buk.cl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- Rakefile
+- lib/view_component_subtemplates.rb
+- lib/view_component_subtemplates/compiler_extension.rb
+- lib/view_component_subtemplates/sub_template.rb
+- lib/view_component_subtemplates/version.rb
+- sig/view_component_subtemplates.rbs
+homepage: https://github.com/bukhr/view_component_subtemplates
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/bukhr/view_component_subtemplates
+  source_code_uri: https://github.com/bukhr/view_component_subtemplates
+  changelog_uri: https://github.com/bukhr/view_component_subtemplates/blob/main/CHANGELOG.md
+post_install_message:
+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.5.18
+signing_key:
+specification_version: 4
+summary: Sub-templates functionality for ViewComponent
+test_files: []