offshore
Version:
An ORM for Node.js
558 lines (557 loc) • 16 kB
HTML
<html lang="en">
<head>
<title>Code coverage report for lib/offshore/query/finders/dynamicFinders.js</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../../../../prettify.css" />
<link rel="stylesheet" href="../../../../base.css" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../../../../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1>
<a href="../../../../index.html">all files</a> / <a href="index.html">lib/offshore/query/finders/</a> dynamicFinders.js
</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">95.83% </span>
<span class="quiet">Statements</span>
<span class='fraction'>46/48</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">93.1% </span>
<span class="quiet">Branches</span>
<span class='fraction'>27/29</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Functions</span>
<span class='fraction'>6/6</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Lines</span>
<span class='fraction'>46/46</span>
</div>
</div>
</div>
<div class='status-line high'></div>
<pre><table class="coverage">
<tr><td class="line-count quiet">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</td><td class="line-coverage quiet"><span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2×</span>
<span class="cline-any cline-yes">2×</span>
<span class="cline-any cline-yes">2×</span>
<span class="cline-any cline-yes">2×</span>
<span class="cline-any cline-yes">2×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2×</span>
<span class="cline-any cline-yes">410×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">410×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2230×</span>
<span class="cline-any cline-yes">174×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2056×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2056×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2056×</span>
<span class="cline-any cline-yes">2052×</span>
<span class="cline-any cline-yes">18468×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2052×</span>
<span class="cline-any cline-yes">6156×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2×</span>
<span class="cline-any cline-yes">24624×</span>
<span class="cline-any cline-yes">24624×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">24624×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">24624×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">24624×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">48×</span>
<span class="cline-any cline-yes">5×</span>
<span class="cline-any cline-yes">5×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">48×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">48×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">48×</span>
<span class="cline-any cline-yes">48×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">48×</span>
<span class="cline-any cline-yes">48×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">48×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">9×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">11×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">7×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4×</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">/**
* Dynamic Queries
*
* Query the collection using the name of the attribute directly
*/
var _ = require('lodash');
var usageError = require('../../utils/usageError');
var utils = require('../../utils/helpers');
var normalize = require('../../utils/normalize');
var hasOwnProperty = utils.object.hasOwnProperty;
var finder = module.exports = {};
/**
* buildDynamicFinders
*
* Attaches shorthand dynamic methods to the prototype for each attribute
* in the schema.
*/
finder.buildDynamicFinders = function() {
var self = this;
// For each defined attribute, create a dynamic finder function
Object.keys(this._attributes).forEach(function(attrName) {
// Check if attribute is an association, if so generate dynamic finders
if ((self._attributes[attrName].model && self.associationFinders === false) || self._attributes[attrName].collection) {
return;
}
var capitalizedMethods = ['findOneBy*', 'findOneBy*In', 'findOneBy*Like', 'findBy*', 'findBy*In',
'findBy*Like', 'countBy*', 'countBy*In', 'countBy*Like'];
var lowercasedMethods = ['*StartsWith', '*Contains', '*EndsWith'];
if (self.dynamicFinders !== false) {
capitalizedMethods.forEach(function(method) {
self.generateDynamicFinder(attrName, method);
});
lowercasedMethods.forEach(function(method) {
self.generateDynamicFinder(attrName, method, true);
});
}
});
};
/**
* generateDynamicFinder
*
* Creates a dynamic method based off the schema. Used for shortcuts for various
* methods where a criteria object can automatically be built.
*
* @param {String} attrName
* @param {String} method
* @param {Boolean} dont capitalize the attrName or do, defaults to false
*/
finder.generateDynamicFinder = function(attrName, method, dontCapitalize) {
var self = this;
var criteria;
// Capitalize Attribute Name for camelCase
var preparedAttrName = dontCapitalize ? attrName : utils.capitalize(attrName);
// Figure out actual dynamic method name by injecting attribute name
var actualMethodName = method.replace(/\*/g, preparedAttrName);
// Assign this finder to the collection
this[actualMethodName] = function dynamicMethod(value, options, cb) {
if (typeof options === 'function') {
cb = options;
options = null;
}
options = options || {};
var usage = utils.capitalize(self.identity) + '.' + actualMethodName + '(someValue,[options],callback)';
<span class="missing-if-branch" title="if path not taken" >I</span>if (typeof value === 'undefined') <span class="cstat-no" title="statement not covered" >return usageError('No value specified!', usage, cb);</span>
<span class="missing-if-branch" title="if path not taken" >I</span>if (options.where) <span class="cstat-no" title="statement not covered" >return usageError('Cannot specify `where` option in a dynamic ' + method + '*() query!', usage, cb);</span>
// Build criteria query and submit it
options.where = {};
options.where[attrName] = value;
switch (method) {
///////////////////////////////////////
// Finders
///////////////////////////////////////
case 'findOneBy*':
case 'findOneBy*In':
return self.findOne(options, cb);
case 'findOneBy*Like':
criteria = _.extend(options, {
where: {
like: options.where
}
});
return self.findOne(criteria, cb);
///////////////////////////////////////
// Aggregate Finders
///////////////////////////////////////
case 'findBy*':
case 'findBy*In':
return self.find(options, cb);
case 'findBy*Like':
criteria = _.extend(options, {
where: {
like: options.where
}
});
return self.find(criteria, cb);
///////////////////////////////////////
// Count Finders
///////////////////////////////////////
case 'countBy*':
case 'countBy*In':
return self.count(options, cb);
case 'countBy*Like':
criteria = _.extend(options, {
where: {
like: options.where
}
});
return self.count(criteria, cb);
///////////////////////////////////////
// Searchers
///////////////////////////////////////
case '*StartsWith':
return self.startsWith(options, cb);
case '*Contains':
return self.contains(options, cb);
case '*EndsWith':
return self.endsWith(options, cb);
}
};
};
</pre></td></tr>
</table></pre>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage
generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Apr 17 2018 10:49:40 GMT+0200 (CEST)
</div>
</div>
<script src="../../../../prettify.js"></script>
<script>
window.onload = function () {
if (typeof prettyPrint === 'function') {
prettyPrint();
}
};
</script>
<script src="../../../../sorter.js"></script>
</body>
</html>