https://github.com/konapun/cobsy

An object system for Perl with loadable runtime packages
https://github.com/konapun/cobsy

Last synced: 23 days ago
JSON representation

An object system for Perl with loadable runtime packages

• Host: GitHub
• URL: https://github.com/konapun/cobsy
• Owner: konapun
• Created: 2014-05-22T23:42:41.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-08-01T04:15:37.000Z (over 9 years ago)
• Last Synced: 2024-10-16T17:54:38.186Z (2 months ago)
• Language: Perl
• Size: 340 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes

Awesome Lists containing this project

README

        
![cobsy](example/cobsy.png)

#A Component OBject SYstem for Perl

Cobsy is a way to build and extend objects at runtime using components, which function like packages. A Cobsy component exports attributes and methods to add to a Cobsy

Object (a Cob). Cobsy can form the basis for a component entity system, or any other project without a clear object hierarchy where you want to avoid the rigidity of

standard class-based inheritance.

## Components

A component is a "runtime package" which provides attributes and methods which are able to be installed into a Cob.

---

### `initialize([arguments])`

Define code to be run when the component is instantiated. Arguments (in the form of an array ref) can also be passed to the component. Initialize is mainly used to setup private

data associated with the component

### `finalize(cob)`

Define code to run immediately after this component is installed into a Cob

### `requires()`

Return a list (as an arrayref) of components required by this component

### `setPriority()`

Return an int representing the priority of this component (default: 1). Lower priorities will be loaded first. Priority is used when installing components and requiring components within a component.

Set a higher priority when you want to override a method exported from a different component or when you need a guarantee that a component will be available in a given place.

### `exportAttributes()`

Return a hashref of attribute keys to their values. Attributes will be available from the Cob via `$cob->attributes()`. If you don't want an attribute to be "public" or want to avoid polluting the Cob,

prefer storing properties only in the component (this will usually be what you want to do)

### `exportMethods()`

Return a hashref of keys representing method names to a coderef. Keys will be available through the Cob this component installs into via `$cob->method()`, for example

## Objects (Cobs)

Objects are containers for components. To create an object with a given set of components loaded in,

```perl

my $object = Cobsy::Object->new([

  'Test::Component::Named', # exports getName and setName

  'Test::Component::Aged' # exports getAge and setAge

]);

$object->setName('guy');

$object->setAge(200);

```

or, to use components initialized with given data,

```perl

my $object = Cobsy::Object->new({

  'Test::Component::Named' => ['guy'], # exports getName

  'Test::Component::Aged' => [200] # exports getAge

});

$object->getName(); # returns "guy"

$object->getAge(); # returns 200

```

Components will be loaded into a Cob by their priority.

To create a new Cob from another with additional components loaded, use `extend`

```perl

my $extended = $object->extend({

  'Test::Component::Specied' => "human" # exports getSpecies

});

$extended->getName(); # returns "guy"

$extended->getSpecies(); # returns "human"

$object->getSpecies(); # dies, because the Specied component is only available in $extended

```