xs/model.xs

filter: Statementstmt 98.4% 125 / 127 Branchbran 57.3% 78 / 136 Conditioncond n/a MC/DCmcdc n/a Subroutinesub n/a Podpod n/a totaltotal 77.1% 203 / 263 CC 0 SCAR 0
CC
0
Cov
0%
CRAP 0
« include/punk/punk_stencil.h ↑ Summary include/punk/punk_ratelimit.h »
1 MODULE = Punk PACKAGE = Punk::Model
2  
3 PROTOTYPES: DISABLE
4  
5 # use Punk::Model - push the base class onto the caller's @ISA and install
6 # its declaration keywords, each a magic CV carrying that class's metadata.
7 void
8 import(class, ...)
9 SV *class
10 CODE:
11 {
12 58 ▶ const char *caller = CopSTASHPV(PL_curcop);
Branch: 7 branches
BranchTrueFalseTotal
const char *caller = CopSTASHPV(PL_curcop); 58 0 58
const char *caller = CopSTASHPV(PL_curcop); 58 0 58
const char *caller = CopSTASHPV(PL_curcop); 58 0 58
const char *caller = CopSTASHPV(PL_curcop); 0 58 58
const char *caller = CopSTASHPV(PL_curcop); 0 0 0
const char *caller = CopSTASHPV(PL_curcop); 58 0 58
const char *caller = CopSTASHPV(PL_curcop); 0 58 58
13 SV *caller_sv;
14 HV *meta;
15 SV *meta_rv;
16 PERL_UNUSED_VAR(class);
17 PERL_UNUSED_VAR(items);
18 58 ▶ if (!caller || strEQ(caller, "main")) XSRETURN_EMPTY;
Branch: 2 branches
BranchTrueFalseTotal
if (!caller || strEQ(caller, "main")) XSRETURN_EMPTY; 58 0 58
if (!caller || strEQ(caller, "main")) XSRETURN_EMPTY; 8 50 58
19 50 caller_sv = sv_2mortal(newSVpv(caller, 0));
20  
21 /* a second `use` in the same class: nothing to do. Asked of the
22 * class's OWN metadata - an inherited one means this is a subclass,
23 * which does need its own entry to declare into. */
24 50 ▶ if (pm_meta_own(aTHX_ caller_sv)) XSRETURN_EMPTY;
Branch: 1 branch
BranchTrueFalseTotal
if (pm_meta_own(aTHX_ caller_sv)) XSRETURN_EMPTY; 0 50 50
25  
26 50 meta = newHV();
27 50 (void)hv_stores(meta, "table", newSV(0));
28 50 (void)hv_stores(meta, "fields", newRV_noinc((SV *)newAV()));
29 50 (void)hv_stores(meta, "field", newRV_noinc((SV *)newHV()));
30 50 (void)hv_stores(meta, "primary", newSV(0));
31 50 (void)hv_stores(meta, "validate", newSV(0));
32 50 (void)hv_stores(meta, "database", newSVpvs("default"));
33 50 meta_rv = newRV_noinc((SV *)meta);
34 50 (void)hv_store_ent(pm_registry(aTHX), caller_sv, meta_rv, 0);
35  
36 { /* @Caller::ISA = ('Punk::Model'), unless a parent already put a
37 * model there - pushing it twice would be harmless but untidy. */
38 50 ▶ if (!sv_derived_from(caller_sv, "Punk::Model")) {
Branch: 1 branch
BranchTrueFalseTotal
if (!sv_derived_from(caller_sv, "Punk::Model")) { 50 0 50
39 50 AV *isa = get_av(form("%s::ISA", caller), GV_ADD);
40 50 av_push(isa, newSVpvs("Punk::Model"));
41 }
42 }
43  
44 { /* the keywords, each carrying [ $meta ] */
45 static const struct { const char *name; XSUBADDR_t body; } kw[] = {
46 { "table", pm_kw_table },
47 { "field", pm_kw_field },
48 { "database", pm_kw_database },
49 { "validate", pm_kw_validate },
50 { NULL, NULL }
51 };
52 int i;
53 250 ▶ for (i = 0; kw[i].name; i++) {
Branch: 1 branch
BranchTrueFalseTotal
for (i = 0; kw[i].name; i++) { 200 50 250
54 200 AV *cap = newAV();
55 SV *code;
56 200 av_push(cap, newSVsv(meta_rv));
57 200 code = punk_closure(aTHX_ kw[i].body, cap);
58 {
59 200 GV *gv = gv_fetchpv(form("%s::%s", caller, kw[i].name),
60 GV_ADD, SVt_PVCV);
61 200 sv_setsv((SV *)gv, code);
62 200 SvREFCNT_dec(code);
63 }
64 }
65 }
66 50 XSRETURN_EMPTY;
67 }
68  
69 # The finalised metadata hashref, or undef when the class declared no
70 # table. Punk::App calls _punk_model_meta at compile to test a class.
71 SV *
72 _meta(class, ...)
73 SV *class
74 ALIAS:
75 _punk_model_meta = 1
76 CODE:
77 {
78 72 ▶ SV *pkg = (items > 1 && SvOK(ST(1))) ? ST(1) : class;
Branch: 2 branches
BranchTrueFalseTotal
SV *pkg = (items > 1 && SvOK(ST(1))) ? ST(1) : class; 0 72 72
SV *pkg = (items > 1 && SvOK(ST(1))) ? ST(1) : class; 0 0 0
79 HV *m;
80 PERL_UNUSED_VAR(ix);
81 72 ▶ if (SvROK(pkg)) pkg = sv_2mortal(newSVpv(sv_reftype(SvRV(pkg), 1), 0));
Branch: 1 branch
BranchTrueFalseTotal
if (SvROK(pkg)) pkg = sv_2mortal(newSVpv(sv_reftype(SvRV(pkg), 1), 0)); 0 72 72
82 72 m = pm_meta_hv(aTHX_ pkg);
83 144 ▶ RETVAL = (m && pm_meta_finalize(aTHX_ m))
Branch: 1 branch
BranchTrueFalseTotal
RETVAL = (m && pm_meta_finalize(aTHX_ m)) 72 0 72
84 144 ▶ ? newRV_inc((SV *)m) : newSV(0);
Branch: 1 branch
BranchTrueFalseTotal
? newRV_inc((SV *)m) : newSV(0); 72 0 72
85 }
86 OUTPUT:
87 RETVAL
88  
89 # The per-worker instance: resolve the backend, hand it the table shape,
90 # compile the create/update validators. Called once per model per worker.
91 SV *
92 _instantiate(class, ...)
93 SV *class
94 CODE:
95 {
96 48 ▶ HV *dbopts = (items > 1 && SvROK(ST(1))
Branch: 1 branch
BranchTrueFalseTotal
HV *dbopts = (items > 1 && SvROK(ST(1)) 48 0 48
97 48 ▶ && SvTYPE(SvRV(ST(1))) == SVt_PVHV)
Branch: 1 branch
BranchTrueFalseTotal
&& SvTYPE(SvRV(ST(1))) == SVt_PVHV) 48 0 48
98 96 ▶ ? (HV *)SvRV(ST(1)) : NULL;
Branch: 1 branch
BranchTrueFalseTotal
? (HV *)SvRV(ST(1)) : NULL; 48 0 48
99 48 HV *m = pm_meta_hv(aTHX_ class);
100 HV *self;
101 SV *backend_class, *backend;
102 SV *should;
103  
104 48 ▶ if (!(m && pm_meta_finalize(aTHX_ m)))
Branch: 2 branches
BranchTrueFalseTotal
if (!(m && pm_meta_finalize(aTHX_ m))) 48 0 48
if (!(m && pm_meta_finalize(aTHX_ m))) 0 48 48
105 0 croak("Punk::Model: '%s' declares no table", SvPV_nolen(class));
106  
107 { /* backend => 'Class', defaulting to the shipped DBI one.
108 * backend => 'Punk::Model::DBIx::Loop' selects the non-blocking
109 * backend, whose methods return futures instead of values. */
110 48 ▶ SV *b = dbopts ? pm_get(aTHX_ dbopts, "backend") : NULL;
Branch: 1 branch
BranchTrueFalseTotal
SV *b = dbopts ? pm_get(aTHX_ dbopts, "backend") : NULL; 48 0 48
111 35 ▶ backend_class = (b && SvOK(b)) ? sv_2mortal(newSVsv(b))
Branch: 1 branch
BranchTrueFalseTotal
backend_class = (b && SvOK(b)) ? sv_2mortal(newSVsv(b)) 35 0 35
112 48 ▶ : sv_2mortal(newSVpvs("Punk::Model::DBI"));
Branch: 1 branch
BranchTrueFalseTotal
: sv_2mortal(newSVpvs("Punk::Model::DBI")); 35 13 48
113 }
114 { /* load it unless it is already there */
115 48 HV *stash = gv_stashsv(backend_class, 0);
116 48 ▶ if (!(stash && gv_fetchmethod_autoload(stash, "new", 0))) {
Branch: 2 branches
BranchTrueFalseTotal
if (!(stash && gv_fetchmethod_autoload(stash, "new", 0))) { 47 1 48
if (!(stash && gv_fetchmethod_autoload(stash, "new", 0))) { 0 47 47
117 1 ▶ if (!pk_require_once(aTHX_ SvPV_nolen(backend_class), FALSE))
Branch: 1 branch
BranchTrueFalseTotal
if (!pk_require_once(aTHX_ SvPV_nolen(backend_class), FALSE)) 0 0 0
118 0 ▶ croak("Punk::Model: backend '%s' failed to load: %s",
Branch: 2 branches
BranchTrueFalseTotal
croak("Punk::Model: backend '%s' failed to load: %s", 0 0 0
croak("Punk::Model: backend '%s' failed to load: %s", 0 0 0
119 SvPV_nolen(backend_class), SvPV_nolen(ERRSV));
120 }
121 }
122  
123 { /* $backend_class->new(database => \%conn, table, primary,
124 * columns) - the connection options minus our own key */
125 47 HV *conn = newHV();
126 47 dSP;
127 int count;
128 47 ▶ if (dbopts) {
Branch: 1 branch
BranchTrueFalseTotal
if (dbopts) { 47 0 47
129 HE *he;
130 47 hv_iterinit(dbopts);
131 139 ▶ while ((he = hv_iternext(dbopts))) {
Branch: 1 branch
BranchTrueFalseTotal
while ((he = hv_iternext(dbopts))) { 92 47 139
132 92 ▶ SV *k = HeSVKEY_force(he);
Branch: 2 branches
BranchTrueFalseTotal
SV *k = HeSVKEY_force(he); 92 0 92
SV *k = HeSVKEY_force(he); 0 92 92
133 92 ▶ if (SvCUR(k) == 7 && memEQ(SvPVX(k), "backend", 7))
Branch: 2 branches
BranchTrueFalseTotal
if (SvCUR(k) == 7 && memEQ(SvPVX(k), "backend", 7)) 47 45 92
if (SvCUR(k) == 7 && memEQ(SvPVX(k), "backend", 7)) 34 13 47
134 34 continue;
135 58 (void)hv_store_ent(conn, k, newSVsv(HeVAL(he)), 0);
136 }
137 }
138 47 ENTER; SAVETMPS;
139 47 ▶ PUSHMARK(SP);
Branch: 1 branch
BranchTrueFalseTotal
PUSHMARK(SP); 0 47 47
140 47 ▶ EXTEND(SP, 11);
Branch: 1 branch
BranchTrueFalseTotal
EXTEND(SP, 11); 0 47 47
141 47 PUSHs(backend_class);
142 47 mPUSHs(newSVpvs("database"));
143 47 mPUSHs(newRV_noinc((SV *)conn));
144 47 mPUSHs(newSVpvs("table"));
145 47 mPUSHs(newSVsv(pm_get(aTHX_ m, "table")));
146 47 mPUSHs(newSVpvs("primary"));
147 47 mPUSHs(newSVsv(pm_get(aTHX_ m, "primary")));
148 47 mPUSHs(newSVpvs("columns"));
149 47 mPUSHs(newSVsv(pm_get(aTHX_ m, "fields")));
150 /* the application, for a backend that reads from it (the
151 * markdown one reads a mount's pages); the others ignore it */
152 47 ▶ if (items > 2 && SvROK(ST(2))) {
Branch: 2 branches
BranchTrueFalseTotal
if (items > 2 && SvROK(ST(2))) { 27 20 47
if (items > 2 && SvROK(ST(2))) { 27 0 27
153 27 mPUSHs(newSVpvs("app"));
154 27 PUSHs(ST(2));
155 }
156 47 PUTBACK;
157 47 count = call_method("new", G_SCALAR);
158 47 SPAGAIN;
159 47 ▶ backend = count > 0 ? newSVsv(POPs) : &PL_sv_undef;
Branch: 1 branch
BranchTrueFalseTotal
backend = count > 0 ? newSVsv(POPs) : &PL_sv_undef; 47 0 47
160 47 ▶ PUTBACK; FREETMPS; LEAVE;
Branch: 1 branch
BranchTrueFalseTotal
PUTBACK; FREETMPS; LEAVE; 47 0 47
161 }
162  
163 47 self = newHV();
164 47 (void)hv_stores(self, "backend", backend);
165 47 (void)hv_stores(self, "meta", newRV_inc((SV *)m));
166  
167 47 should = pm_get(aTHX_ m, "should_validate");
168 47 ▶ if (should && SvTRUE(should)) {
Branch: 2 branches
BranchTrueFalseTotal
if (should && SvTRUE(should)) { 47 0 47
if (should && SvTRUE(should)) { 15 32 47
169 static const char *const which[] = { "cv_create", "cv_update" };
170 int partial;
171 15 (void)pk_require_once(aTHX_ "JSON::Schema::Fast", TRUE);
172 45 ▶ for (partial = 0; partial < 2; partial++) {
Branch: 1 branch
BranchTrueFalseTotal
for (partial = 0; partial < 2; partial++) { 30 15 45
173 30 SV *schema = sv_2mortal(pm_object_schema(aTHX_ m, partial));
174 30 dSP;
175 int count;
176 30 ENTER; SAVETMPS;
177 30 ▶ PUSHMARK(SP);
Branch: 1 branch
BranchTrueFalseTotal
PUSHMARK(SP); 0 30 30
178 30 ▶ EXTEND(SP, 2);
Branch: 1 branch
BranchTrueFalseTotal
EXTEND(SP, 2); 0 30 30
179 30 mPUSHs(newSVpvs("JSON::Schema::Fast"));
180 30 PUSHs(schema);
181 30 PUTBACK;
182 30 count = call_method("compile", G_SCALAR);
183 30 SPAGAIN;
184 30 ▶ if (count > 0)
Branch: 1 branch
BranchTrueFalseTotal
if (count > 0) 30 0 30
185 30 (void)hv_store(self, which[partial],
186 (I32)strlen(which[partial]),
187 newSVsv(POPs), 0);
188 30 ▶ PUTBACK; FREETMPS; LEAVE;
Branch: 1 branch
BranchTrueFalseTotal
PUTBACK; FREETMPS; LEAVE; 30 0 30
189 }
190 }
191 47 RETVAL = sv_bless(newRV_noinc((SV *)self), gv_stashsv(class, GV_ADD));
192 }
193 OUTPUT:
194 RETVAL
195  
196 SV *
197 backend(self)
198 SV *self
199 ALIAS:
200 meta = 1
201 CODE:
202 {
203 60 ▶ SV *v = pm_slot(aTHX_ self, ix ? "meta" : "backend");
Branch: 1 branch
BranchTrueFalseTotal
SV *v = pm_slot(aTHX_ self, ix ? "meta" : "backend"); 4 56 60
204 60 ▶ RETVAL = v ? newSVsv(v) : newSV(0);
Branch: 1 branch
BranchTrueFalseTotal
RETVAL = v ? newSVsv(v) : newSV(0); 60 0 60
205 }
206 OUTPUT:
207 RETVAL
208  
209 # get / search / delete / count: straight through to the backend, keeping
210 # the caller's context so a list-returning backend stays a list.
211 void
212 get(self, ...)
213 SV *self
214 ALIAS:
215 search = 1
216 delete = 2
217 count = 3
218 PPCODE:
219 {
220 static const char *const m[] = { "get", "search", "delete", "count" };
221 PERL_UNUSED_VAR(self);
222 617 pm_delegate(aTHX_ &ST(0), items, m[ix], GIMME_V);
223 548 return; /* whatever the backend left on the stack */
224 }
225  
226 # all: search with no filter and no options.
227 void
228 all(self)
229 SV *self
230 PPCODE:
231 {
232 14 SV *backend = pm_slot(aTHX_ self, "backend");
233 14 ▶ if (!backend) croak("Punk::Model: this model has no backend");
Branch: 1 branch
BranchTrueFalseTotal
if (!backend) croak("Punk::Model: this model has no backend"); 0 14 14
234 14 ▶ PUSHMARK(SP);
Branch: 1 branch
BranchTrueFalseTotal
PUSHMARK(SP); 0 14 14
235 14 ▶ EXTEND(SP, 3);
Branch: 1 branch
BranchTrueFalseTotal
EXTEND(SP, 3); 0 14 14
236 14 PUSHs(backend);
237 14 mPUSHs(newRV_noinc((SV *)newHV()));
238 14 mPUSHs(newRV_noinc((SV *)newHV()));
239 14 PUTBACK;
240 14 call_method("search", GIMME_V);
241 12 SPAGAIN;
242 12 return;
243 }
244  
245 void
246 create(self, data)
247 SV *self
248 SV *data
249 PPCODE:
250 {
251 84 SV *cv_sv = pm_slot(aTHX_ self, "cv_create");
252 84 ▶ if (cv_sv && SvOK(cv_sv)) pm_validate(aTHX_ self, cv_sv, data);
Branch: 2 branches
BranchTrueFalseTotal
if (cv_sv && SvOK(cv_sv)) pm_validate(aTHX_ self, cv_sv, data); 29 55 84
if (cv_sv && SvOK(cv_sv)) pm_validate(aTHX_ self, cv_sv, data); 29 0 29
253 80 pm_delegate(aTHX_ &ST(0), items, "create", GIMME_V);
254 76 return;
255 }
256  
257 # update validates the changes only: the primary key identifies the row
258 # rather than being part of what is being set, so a partial schema without
259 # it is what the payload has to satisfy.
260 void
261 update(self, data)
262 SV *self
263 SV *data
264 PPCODE:
265 {
266 16 SV *cv_sv = pm_slot(aTHX_ self, "cv_update");
267 16 ▶ if (cv_sv && SvOK(cv_sv)) {
Branch: 2 branches
BranchTrueFalseTotal
if (cv_sv && SvOK(cv_sv)) { 5 11 16
if (cv_sv && SvOK(cv_sv)) { 5 0 5
268 5 SV *meta = pm_slot(aTHX_ self, "meta");
269 5 ▶ SV *pk = (meta && SvROK(meta))
Branch: 1 branch
BranchTrueFalseTotal
SV *pk = (meta && SvROK(meta)) 5 0 5
270 10 ▶ ? pm_get(aTHX_ (HV *)SvRV(meta), "primary") : NULL;
Branch: 1 branch
BranchTrueFalseTotal
? pm_get(aTHX_ (HV *)SvRV(meta), "primary") : NULL; 5 0 5
271 5 HV *changes = newHV();
272 5 ▶ if (SvROK(data) && SvTYPE(SvRV(data)) == SVt_PVHV) {
Branch: 2 branches
BranchTrueFalseTotal
if (SvROK(data) && SvTYPE(SvRV(data)) == SVt_PVHV) { 5 0 5
if (SvROK(data) && SvTYPE(SvRV(data)) == SVt_PVHV) { 5 0 5
273 5 HV *src = (HV *)SvRV(data);
274 HE *he;
275 5 hv_iterinit(src);
276 15 ▶ while ((he = hv_iternext(src))) {
Branch: 1 branch
BranchTrueFalseTotal
while ((he = hv_iternext(src))) { 10 5 15
277 10 ▶ SV *k = HeSVKEY_force(he);
Branch: 2 branches
BranchTrueFalseTotal
SV *k = HeSVKEY_force(he); 10 0 10
SV *k = HeSVKEY_force(he); 0 10 10
278 10 ▶ if (pk && SvOK(pk) && sv_eq(k, pk)) continue;
Branch: 3 branches
BranchTrueFalseTotal
if (pk && SvOK(pk) && sv_eq(k, pk)) continue; 10 0 10
if (pk && SvOK(pk) && sv_eq(k, pk)) continue; 10 0 10
if (pk && SvOK(pk) && sv_eq(k, pk)) continue; 5 5 10
279 5 (void)hv_store_ent(changes, k, newSVsv(HeVAL(he)), 0);
280 }
281 }
282 5 pm_validate(aTHX_ self, cv_sv,
283 sv_2mortal(newRV_noinc((SV *)changes)));
284 }
285 15 pm_delegate(aTHX_ &ST(0), items, "update", GIMME_V);
286 13 return;
287 }
« include/punk/punk_stencil.h ↑ Summary include/punk/punk_ratelimit.h »