-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
290 lines (179 loc) · 5.57 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
NAME
Nano - Object Persistence
ABSTRACT
Minimalist Object Persistence
SYNOPSIS
package Person;
use Moo;
extends 'Nano::Node';
has name => (
is => 'ro',
required => 1,
);
has friends => (
is => 'ro',
default => sub { People->new }
);
sub extroverted {
my ($self) = @_;
($self->friends->count > 1) ? 1 : 0
}
sub introverted {
my ($self) = @_;
($self->friends->count < 2) ? 1 : 0
}
package People;
use Moo;
extends 'Nano::Nodes';
sub new_type {
'Person'
}
sub extroverted {
my ($self) = @_;
$self->scope(sub {
my ($person) = @_;
$person->extroverted
});
}
sub introverted {
my ($self) = @_;
$self->scope(sub {
my ($person) = @_;
$person->introverted
});
}
package main;
my $rachel = Person->new(
id => 'rachel',
name => 'rachel',
);
my $monica = Person->new(
id => 'monica',
name => 'monica',
);
my $phoebe = Person->new(
id => 'phoebe',
name => 'phoebe',
);
$rachel->friends->set($monica);
$rachel->friends->set($phoebe);
$monica->friends->set($rachel);
$monica->friends->set($phoebe);
$phoebe->friends->set($rachel);
$phoebe->friends->set($monica);
$rachel->save;
$monica->save;
$phoebe->save;
$phoebe->friends->count; # 2
$phoebe->friends->extroverted->count; # 2
$phoebe->friends->introverted->count; # 0
my $nano = Nano->new;
my $friend = $nano->find('rachel');
DESCRIPTION
This package provides a minimalist framework for persisting objects
(i.e. class instances) with as little effort as possible. This
framework relies on the Zing toolkit which provides pluggable storage
and serialization options.
LIBRARIES
This package uses type constraints from:
Nano::Types
ATTRIBUTES
This package has the following attributes:
env
env(Env)
This attribute is read-only, accepts (Env) values, and is optional.
METHODS
This package implements the following methods:
domain
domain(Str $name) : Domain
The domain method returns a Zing::Domain object for the ID provided.
domain example #1
my $nano = Nano->new;
my $domain = $nano->domain('changelog');
dump
dump(Object $object) : HashRef
The dump method returns a serialized hash representation for the object
provided.
dump example #1
my $nano = Nano->new;
my $rachel = $nano->find('rachel');
my $dump = $nano->dump($rachel);
find
find(Str $name) : Node
The find method finds, inflates, and returns a prior persisted object
for the ID provided.
find example #1
my $nano = Nano->new;
my $phoebe = $nano->find('phoebe');
hash
hash(Str $name) : Str
The hash method returns a SHA-1 digest for the string provided.
hash example #1
my $nano = Nano->new;
my $email = '[email protected]';
$nano->hash($email);
keyval
keyval(Str $name) : KeyVal
The keyval method returns a Zing::KeyVal object for the ID provided.
keyval example #1
my $nano = Nano->new;
my $keyval = $nano->keyval('rachel');
name
name(Object $object) : Str
The name method returns the class name for the object provided.
name example #1
my $nano = Nano->new;
my $rachel = $nano->find('rachel');
my $name = $nano->name($rachel);
object
object(HashRef $object) : Object
The object method returns an object derived from a prior serialization
representation.
object example #1
my $nano = Nano->new;
my $new_rachel = $nano->object({
'$type' => 'node',
'$name' => 'Person',
'$data' => {
'id' => 'rachel',
'name' => 'rachel',
'nano' => {
'$skip' => 1
},
'friends' => {
'$skip' => 1
},
},
});
reify
reify(Str $name, HashRef $data) : Object
The reify method constructs an object from the class name and data
provided.
reify example #1
my $nano = Nano->new;
my $new_rachel = $nano->reify('Person', {
id => 'rachel',
name => 'rachel',
});
table
table(Str $name) : Table
The table method returns a Zing::Table object for the ID provided.
table example #1
my $nano = Nano->new;
my $rachel = $nano->find('rachel');
my $table = $nano->table($rachel->friends->id);
AUTHOR
Al Newkirk, [email protected]
LICENSE
Copyright (C) 2011-2019, Al Newkirk, et al.
This is free software; you can redistribute it and/or modify it under
the terms of the The Apache License, Version 2.0, as elucidated in the
"license file" <https://github.com/cpanery/nano/blob/master/LICENSE>.
PROJECT
Wiki <https://github.com/cpanery/nano/wiki>
Project <https://github.com/cpanery/nano>
Initiatives <https://github.com/cpanery/nano/projects>
Milestones <https://github.com/cpanery/nano/milestones>
Contributing
<https://github.com/cpanery/nano/blob/master/CONTRIBUTE.md>
Issues <https://github.com/cpanery/nano/issues>