File Coverage

blib/lib/Interchange6/Schema/Result/Inventory.pm

Criterion	Covered	Total	%
statement	16	16	100.0
branch	4	4	100.0
condition			n/a
subroutine	4	4	100.0
pod	2	2	100.0
total	26	26	100.0

use utf8;

package Interchange6::Schema::Result::Inventory;

=head1 NAME

Interchange6::Schema::Result::Inventory

=cut

use Interchange6::Schema::Candy;

=head1 DESCRIPTION

The Inventory class is used to store current stock levels for products.

=head1 ACCESSORS

=head2 sku

The SKU of the product.

Primary key and foreign constraint on
L<Interchange6::Schema::Result::Product/sku> via L</product> relationship.

=cut

primary_column sku =>
  { data_type => "varchar", size => 64 };

=head2 quantity

This is the quantity currently held in stock.

Defaults to 0.

=cut

column quantity => { data_type => "integer", default_value => 0 };

=head1 RELATIONS

=head2 product

Type: belongs_to

Related object: L<Interchange6::Schema::Result::Product>

=cut

belongs_to
  product => "Interchange6::Schema::Result::Product",
  "sku",
  { is_deferrable => 1, on_delete => "CASCADE", on_update => "CASCADE" };

=head1 METHODS


=head2 decrement( $quantity )

Atomically reduce L</quantity> by argument or by 1 if argument is not defined.
Returns new value of L</quantity>.

=cut

sub decrement {
    my ( $self, $quantity ) = @_;
    $quantity = 1 unless defined $quantity;
    $self->update( { quantity => \[ 'quantity - ?', $quantity ] } );
    $self->discard_changes;
    return $self->quantity;
}

=head2 increment( $quantity )

Atomically increase L</quantity> by argument or by 1 if argument is not defined.
Returns new value of L</quantity>.

=cut

sub increment {
    my ( $self, $quantity ) = @_;
    $quantity = 1 unless defined $quantity;
    $self->update( { quantity => \[ 'quantity + ?', $quantity ] } );
    $self->discard_changes;
    return $self->quantity;
}

1;