File Coverage

blib/lib/KiokuDB/Role/ID/Content.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

#!/usr/bin/perl

package KiokuDB::Role::ID::Content;
use Moose::Role;

use namespace::clean -except => 'meta';

with qw(
    KiokuDB::Role::ID
    KiokuDB::Role::Immutable
);

__PACKAGE__

__END__

=pod

=head1 NAME

KiokuDB::Role::ID::Content - Content dependent object IDs

=head1 SYNOPSIS

    package BLOB;
    use Moose;

    use Digest::SHA1;

    with qw(KiokuDB::Role::ID::Content);

    sub kiokudb_object_id {
        my $self = shift;
        sha1_hex($self->data);
    }

    has data => (
        isa => "Str",
        is  => "ro",
        required => 1,
    );

=head1 DESCRIPTION

This is a role for L<KiokuDB::Role::Immutable> objects whose IDs depend on
their content, or in other words content addressible objects.

A canonical example is a string identified by its SHA-1 hash, as is
demonstrated in the L</SYNOPSIS>.

Objects which do this role are never updated in the database just like
L<KiokuDB::Role::Immutable> objects.

Additionally, it is not an error to insert such objects twice since the objects
are assumed to be identical.

=cut