Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atoomic/simple-accessor
a light and simple way to provide accessor in perl
https://github.com/atoomic/simple-accessor
Last synced: about 2 months ago
JSON representation
a light and simple way to provide accessor in perl
- Host: GitHub
- URL: https://github.com/atoomic/simple-accessor
- Owner: atoomic
- Created: 2012-06-05T18:35:22.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2020-03-31T23:28:38.000Z (almost 5 years ago)
- Last Synced: 2024-10-13T11:34:33.645Z (3 months ago)
- Language: Perl
- Size: 25.4 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changes
Awesome Lists containing this project
README
[](https://github.com/atoomic/Simple-Accessor/actions)
[](https://github.com/atoomic/Simple-Accessor/actions)
# NAME
Simple::Accessor - very simple, light and powerful accessor
# SYNOPSIS
```perl
package Role::Color;
use Simple::Accessor qw{color};
sub _build_color { 'red' } # default color
package Car;
# that s all what you need ! no more line required
use Simple::Accessor qw{brand hp};
with 'Role::Color';
sub _build_hp { 2 }
sub _build_brand { 'unknown' }
package main;
my $c = Car->new( brand => 'zebra' );
is $c->brand, 'zebra';
is $c->color, 'red';
```
# DESCRIPTION
Simple::Accessor provides a simple object layer without any dependency.
It can be used where other ORM could be considered too heavy.
But it has also the main advantage to only need one single line of code.
It can be easily used in scripts...
# Usage
Create a package and just call Simple::Accessor.
The new method will be imported for you, and all accessors will be directly
accessible.
```perl
package MyClass;
# that s all what you need ! no more line required
use Simple::Accessor qw{foo bar cherry apple};
```
You can now call 'new' on your class, and create objects using these attributes
```perl
package main;
use MyClass;
my $o = MyClass->new()
or MyClass->new(bar => 42)
or MyClass->new(apple => 'fruit', cherry => 'fruit', banana => 'yummy');
```
You can get / set any value using the accessor
```
is $o->bar(), 42;
$o->bar(51);
is $o->bar(), 51;
```
You can provide your own init method that will be call by new with default args.
This is optional.
```perl
package MyClass;
sub build { # previously known as initialize
my ($self, %opts) = @_;
$self->foo(12345);
}
```
You can also control the object after or before its creation using
```perl
sub _before_build {
my ($self, %opts) = @_;
...
}
sub _after_build {
my ($self, %opts) = @_;
...
bless $self, 'Basket';
}
```
You can also provide individual builders / initializers
```perl
sub _build_bar { # previously known as _initialize_bar
# will be used if no value has been provided for bar
1031;
}
sub _build_cherry {
'red';
}
```
You can even use a very basic but useful hook system.
Any false value return by before or validate, will stop the setting process.
Be careful with the after method, as there is no protection against infinite loop.
```perl
sub _before_foo {
my ($self, $v) = @_;
# do whatever you want with $v
return 1 or 0;
}
sub _validate_foo {
my ($self, $v) = @_;
# invalid value ( will not be set )
return 0 if ( $v == 42);
# valid value
return 1;
}
sub _after_cherry {
my ($self) = @_;
# use the set value for extra operations
$self->apple($self->cherry());
}
```
# METHODS
None. The only public method provided is the classical import.
# CONTRIBUTE
You can contribute to this project on github https://github.com/atoomic/Simple-Accessor