The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Deeme::Obj - Minimal base class for Deeme

SYNOPSIS

  package Cat;
  use Deeme::Obj -base;

  has name => 'Nyan';
  has [qw(birds mice)] => 2;

  package Tiger;
  use Deeme::Obj 'Cat';

  has friend  => sub { Cat->new };
  has stripes => 42;

  package main;
  use Deeme::Obj -strict;

  my $mew = Cat->new(name => 'Longcat');
  say $mew->mice;
  say $mew->mice(3)->birds(4)->mice;

  my $rawr = Tiger->new(stripes => 23, mice => 0);
  say $rawr->tap(sub { $_->friend->name('Tacgnol') })->mice;

DESCRIPTION

Deeme::Obj is a simple base class for Deeme, a fork of Mojo::Base.

  # Automatically enables "strict", "warnings", "utf8" and Perl 5.10 features
  use Deeme::Obj -strict;
  use Deeme::Obj -base;
  use Deeme::Obj 'SomeBaseClass';

All three forms save a lot of typing.

  # use Deeme::Obj -strict;
  use strict;
  use warnings;
  use utf8;
  use feature ':5.10';
  use IO::Handle ();

  # use Deeme::Obj -base;
  use strict;
  use warnings;
  use utf8;
  use feature ':5.10';
  use IO::Handle ();
  use Deeme::Obj;
  push @ISA, 'Deeme::Obj';
  sub has { Deeme::Obj::attr(__PACKAGE__, @_) }

  # use Deeme::Obj 'SomeBaseClass';
  use strict;
  use warnings;
  use utf8;
  use feature ':5.10';
  use IO::Handle ();
  require SomeBaseClass;
  push @ISA, 'SomeBaseClass';
  use Deeme::Obj;
  sub has { Deeme::Obj::attr(__PACKAGE__, @_) }

FUNCTIONS

Deeme::Obj implements the following functions like Mojo::Base, which can be imported with the -base flag or by setting a base class.

has

  has 'name';
  has [qw(name1 name2 name3)];
  has name => 'foo';
  has name => sub {...};
  has [qw(name1 name2 name3)] => 'foo';
  has [qw(name1 name2 name3)] => sub {...};

Create attributes for hash-based objects, just like the "attr" method.

METHODS

Deeme::Obj implements the following methods.

attr

  $object->attr('name');
  BaseSubClass->attr('name');
  BaseSubClass->attr([qw(name1 name2 name3)]);
  BaseSubClass->attr(name => 'foo');
  BaseSubClass->attr(name => sub {...});
  BaseSubClass->attr([qw(name1 name2 name3)] => 'foo');
  BaseSubClass->attr([qw(name1 name2 name3)] => sub {...});

Create attribute accessor for hash-based objects, an array reference can be used to create more than one at a time. Pass an optional second argument to set a default value, it should be a constant or a callback. The callback will be executed at accessor read time if there's no set value. Accessors can be chained, that means they return their invocant when they are called with an argument.

new

  my $object = BaseSubClass->new;
  my $object = BaseSubClass->new(name => 'value');
  my $object = BaseSubClass->new({name => 'value'});

This base class provides a basic constructor for hash-based objects. You can pass it either a hash or a hash reference with attribute values.

tap

  $object = $object->tap(sub {...});

K combinator, tap into a method chain to perform operations on an object within the chain. The object will be the first argument passed to the callback and is also available as $_.

DEBUGGING

You can set the DEEME_OBJ_DEBUG environment variable to get some advanced diagnostics information printed to STDERR.

  DEEME_OBJ_DEBUG=1

SEE ALSO

Deeme, Mojo::Base.