File Coverage

blib/lib/Articulate/Enrichment.pm

Criterion	Covered	Total	%
statement	19	19	100.0
branch			n/a
condition			n/a
subroutine	5	5	100.0
pod	1	1	100.0
total	25	25	100.0

package Articulate::Enrichment;
use strict;
use warnings;

use Moo;

with 'Articulate::Role::Component';

use Articulate::Syntax qw(instantiate_array);

=head1 NAME

Articulate::Enrichment - tidy up your content before it goes into the database

=head1 DESCRIPTION

  use Articulate::Enrichment;
  $request = enrichment->enrich($item, $request);

This will pass the item and the request to a series of enrichment objects, each of which has the opportunity to alter the item according to their own rules, for instance, to add an 'updated on' date to the meta or to fix minor errors in the content.

Services should typically invoke enrichment when they create or update content, after validation but before storage.

Note: the item passed in is not cloned so this will typically mutate the item.

Enrichments should not mutate the request, however there is no technical barrier to them doing so.

=head1 ATTRIBUTES

=head3 enrichments

An array of the enrichment classes which will be used.

=cut

has enrichments => (
  is      => 'rw',
  default => sub { [] },
  coerce  => sub { instantiate_array(@_) }
);

=head1 METHODS

=head3 enrich

Passes the item and request objects to a series of enrichment objects, and returns the item after each has done their bit.

=cut

sub enrich {
  my $self    = shift;
  my $item    = shift;
  my $request = shift;
  foreach my $enrichment ( @{ $self->enrichments } ) {
    $request = $enrichment->enrich( $item, $request );
  }
  return $item;
}

1;