Introduce #[AsBlock] attribute

[silasjoisten]

This PR introduces a powerful new way to define Storyblok blocks in Symfony applications using the #[AsBlock] attribute. This feature enables developers to register blocks generically, ensuring consistency and simplifying block management.

Key Features

1. #[AsBlock] Attribute

• Allows defining a block with an optional name and template.
• If name is omitted, the system will automatically convert the class name to camelCase (e.g., SampleBlock → sample_block).
• The template parameter specifies the Twig template used for rendering. If omitted, a default template path is derived.

2. Default Template Path Configuration

• Blocks are rendered using a default path:

  blocks/{name}.html.twig
  

• This can be customized via configuration:

  # config/packages/storyblok.yaml
  storyblok:
      blocks_template_path: 'my/custom/path'

3. New Twig Extension: BlockExtension

• Provides the render_block filter for rendering Storyblok blocks effortlessly.
• Example usage:

  {% for block in page.body %}
      {% if block is not null %}
          {{ block|render_block }}
      {% endif %}
  {% endfor %}

Example: Defining a Block with #[AsBlock]

namespace Storyblok\Bundle\Tests\Double\Block;

use Storyblok\Bundle\Block\Attribute\AsBlock;
use Webmozart\Assert\Assert;

#[AsBlock(technicalName: 'sample', template: 'custom_blocks/sample.html.twig')]
final readonly class SampleBlock
{
    public string $title;
    public string $description;

    public function __construct(array $values)
    {
        Assert::keyExists($values, 'title');
        $this->title = $values['title'];

        Assert::keyExists($values, 'description');
        $this->description = $values['description'];
    }
}

This class:

• Registers a Storyblok block named sample_block.
• Uses a custom template at custom_blocks/sample.html.twig.
• Ensures proper structure via assertions.

This PR brings significant flexibility and ease to managing Storyblok blocks within Symfony, making integration more intuitive and robust.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 89.15663% with 9 lines in your changes missing coverage. Please review.

Project coverage is 91.69%. Comparing base (5621062) to head (9043173).
Report is 2 commits behind head on master.

Files with missing lines	Patch %	Lines
src/DependencyInjection/StoryblokExtension.php	50.00%	8 Missing ⚠️
src/DataCollector/StoryblokCollector.php	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master      #16      +/-   ##
============================================
- Coverage     92.20%   91.69%   -0.52%     
- Complexity       52       70      +18     
============================================
  Files             7       12       +5     
  Lines           231      313      +82     
============================================
+ Hits            213      287      +74     
- Misses           18       26       +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull Request Overview

This PR introduces the new #[AsBlock] attribute to register Storyblok blocks in Symfony applications and adds documentation on its usage, including default template path customization and a new Twig filter for rendering blocks.

• Introduces the #[AsBlock] attribute to define Storyblok blocks.
• Documents the default template path configuration and customizable settings.
• Adds a new Twig filter, render_block, for dynamic block rendering.

[OskarStark]

I like it, except technicalName should be name

[silasjoisten]

I like it, except technicalName should be name

In storyblok its called technical_name, name is not possible anyway because the name property of an attribute is reserved by PHP

[OskarStark]

https://github.com/php-llm/llm-chain/blob/main/src/Chain/ToolBox/Attribute/AsTool.php

why should it be reserved?

[silasjoisten]

https://github.com/php-llm/llm-chain/blob/main/src/Chain/ToolBox/Attribute/AsTool.php

why should it be reserved?

All good i changed it. i think i called the wrong variable that time.

[Copilot]

Pull Request Overview

This PR introduces the #[AsBlock] attribute for defining Storyblok blocks in Symfony applications and updates the documentation accordingly.

• Adds a new section to README.md for block registration and usage examples.
• Provides guidance on configuring default template paths and rendering blocks in Twig.

Comments suppressed due to low confidence (1)

README.md:201

• The parameter 'name' is used instead of 'technicalName' as described in the PR title and metadata. Update the parameter to 'technicalName' for consistency.

#[AsBlock(name: 'sample', template: 'custom_blocks/sample.html.twig')]

[OskarStark]

Great work 👏