Assert DOM Elements in Laravel Tests

 The Laravel DOM Assertions package by René Sinnbeck adds document object model (DOM) assertion helpers to Laravel's TestResponse class:

This package provides some extra assertion helpers to use in HTTP Tests. If you have ever needed more control over your view assertions than assertSee, assertSeeInOrder, assertSeeText, assertSeeTextInOrder, assertDontSee, and assertDontSeeText then this is the package for you.

The package's README has an example of asserting a navigation menu to ensure the correct li element has an active class, but also ensure the "Home" li element does not:

$this->get(route('about'))
    ->assertOk()
    ->assertElementExists('nav > ul', function(AssertElement $ul) {
        $ul->contains('li', [
            'class' => 'active',
            'text' => 'About'
        ]);
        $ul->doesntContain('li', [
            'class' => 'active',
            'text' => 'Home'
        ]);
    });

The snippet illustrates the granular control provided by this package, including testing DOM elements, nested elements, forms, and more. At the time of the writing, this package's main assertions include:

• Assert if an element exists
• Assert if an element has a given attribute
• Assert if an element contains in another element
• Assert that an element does not contain another element
• Find an element to process further assertions
• Assert if a form exists
• Assert that a form has a CSRF token
• Assert for select options

You can learn more about this package, get full installation instructions, and view the source code on GitHub.

As a side note, this package's source code has an example of using the macroable mixin method to add multiple macro methods into another object from a service provider, which might be a helpful inspiration for others writing packages for Laravel.

Read More

Attach Time-sliced Metadata to Eloquent Models

 Laravel Multiplex is a Laravel package to attach time-sliced metadata to Eloquent models. With the v1.0 release near, here are the main features:

• Metadata is saved in versions, including the ability to schedule metadata for the future
• Fluent syntax
• East to try extending your model with versionable metadata without touching original columns
• Type conversion system
• Configurable

Here are a few basic examples of how this package looks working with a model:

$post = \App\Models\Post::first();
 
// Set meta fluently for any key – `likes` is no column of `Post`.
$post->likes = 24;
 
// Or use the `setMeta` method.
$post->setMeta('likes', 24);
 
// Set multiple values
$model->setMeta([
    'hide' => true,
    'color' => '#000',
    'likes' => 24,
]);
 
// You may also schedule changes, for example, change the meta in 2 years:
$post->setMetaAt('likes', 6000, '+2 years');

You can also limit which meta keys are allowed on a model with a $metaKeys property:

class Post extends Model
{
    use HasMeta;
 
    protected array $metaKeys = [
        'color',
        'hide',
    ];
 
    // You can use typecast array keys
    protected array $metaKeys = [
        'foo',
        'count' => 'integer',
        'color' => 'string',
        'hide' => 'boolean',
    ];
 
}

When you set up this package, read the performance section to avoid N+1 queries. To learn more about this package and get full installation instructions, check out the laravel-metadata on GitHub.

Read More