PageRenderTime 62ms CodeModel.GetById 24ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/base-collection.html

https://bitbucket.org/madebybottle/bottlecap
HTML | 382 lines | 268 code | 114 blank | 0 comment | 0 complexity | 3fcb67328cc3ad046aaa7fe4192ea172 MD5 | raw file
    

  1. <!DOCTYPE html>
    2. 

  2. 

  3. <html>
    4. 

  4. <head>
    5. 

  5.   <title>base-collection.js</title>
    6. 

  6.   <meta http-equiv="content-type" content="text/html; charset=UTF-8">
    7. 

  7.   <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
    8. 

  8.   <link rel="stylesheet" media="all" href="docco.css" />
    9. 

  9. </head>
    10. 

  10. <body>
    11. 

  11.   <div id="container">
    12. 

  12.     <div id="background"></div>
    13. 

  13.     
    14. 

  14.       <ul id="jump_to">
    15. 

  15.         <li>
    16. 

  16.           <a class="large" href="javascript:void(0);">Jump To &hellip;</a>
    17. 

  17.           <a class="small" href="javascript:void(0);">+</a>
    18. 

  18.           <div id="jump_wrapper">
    19. 

  19.           <div id="jump_page">
    20. 

  20.             
    21. 

  21.               
    22. 

  22.               <a class="source" href="base-collection.html">
    23. 

  23.                 base-collection.js
    24. 

  24.               </a>
    25. 

  25.             
    26. 

  26.               
    27. 

  27.               <a class="source" href="filter-collection.html">
    28. 

  28.                 filter-collection.js
    29. 

  29.               </a>
    30. 

  30.             
    31. 

  31.               
    32. 

  32.               <a class="source" href="live-collection.html">
    33. 

  33.                 live-collection.js
    34. 

  34.               </a>
    35. 

  35.             
    36. 

  36.               
    37. 

  37.               <a class="source" href="base-controller.html">
    38. 

  38.                 base-controller.js
    39. 

  39.               </a>
    40. 

  40.             
    41. 

  41.               
    42. 

  42.               <a class="source" href="data-bindings.html">
    43. 

  43.                 data-bindings.js
    44. 

  44.               </a>
    45. 

  45.             
    46. 

  46.               
    47. 

  47.               <a class="source" href="base-model.html">
    48. 

  48.                 base-model.js
    49. 

  49.               </a>
    50. 

  50.             
    51. 

  51.               
    52. 

  52.               <a class="source" href="base-module.html">
    53. 

  53.                 base-module.js
    54. 

  54.               </a>
    55. 

  55.             
    56. 

  56.               
    57. 

  57.               <a class="source" href="base-router.html">
    58. 

  58.                 base-router.js
    59. 

  59.               </a>
    60. 

  60.             
    61. 

  61.               
    62. 

  62.               <a class="source" href="base-view.html">
    63. 

  63.                 base-view.js
    64. 

  64.               </a>
    65. 

  65.             
    66. 

  66.               
    67. 

  67.               <a class="source" href="collection-view.html">
    68. 

  68.                 collection-view.js
    69. 

  69.               </a>
    70. 

  70.             
    71. 

  71.               
    72. 

  72.               <a class="source" href="model-view.html">
    73. 

  73.                 model-view.js
    74. 

  74.               </a>
    75. 

  75.             
    76. 

  76.           </div>
    77. 

  77.         </li>
    78. 

  78.       </ul>
    79. 

  79.     
    80. 

  80.     <ul class="sections">
    81. 

  81.         
    82. 

  82.           <li id="title">
    83. 

  83.               <div class="annotation">
    84. 

  84.                   <h1>base-collection.js</h1>
    85. 

  85.               </div>
    86. 

  86.           </li>
    87. 

  87.         
    88. 

  88.         
    89. 

  89.         
    90. 

  90.         <li id="section-1">
    91. 

  91.             <div class="annotation">
    92. 

  92.               
    93. 

  93.               <div class="pilwrap ">
    94. 

  94.                 <a class="pilcrow" href="#section-1">&#182;</a>
    95. 

  95.               </div>
    96. 

  96.               
    97. 

  97.             </div>
    98. 

  98.             
    99. 

  99.             <div class="content"><div class='highlight'><pre>module.exports = <span class="keyword">function</span>(options) {</pre></div></div>
    100. 

  100.             
    101. 

  101.         </li>
    102. 

  102.         
    103. 

  103.         
    104. 

  104.         <li id="section-2">
    105. 

  105.             <div class="annotation">
    106. 

  106.               
    107. 

  107.               <div class="pilwrap for-h2">
    108. 

  108.                 <a class="pilcrow" href="#section-2">&#182;</a>
    109. 

  109.               </div>
    110. 

  110.               <h2>BaseCollection</h2>
    111. 

  111. <hr>
    112. 

  112. 

  113.             </div>
    114. 

  114.             
    115. 

  115.         </li>
    116. 

  116.         
    117. 

  117.         
    118. 

  118.         <li id="section-3">
    119. 

  119.             <div class="annotation">
    120. 

  120.               
    121. 

  121.               <div class="pilwrap ">
    122. 

  122.                 <a class="pilcrow" href="#section-3">&#182;</a>
    123. 

  123.               </div>
    124. 

  124.               <p>The BaseCollection is the base Collection for storing instances of models
    125. 

  125. for Bottlecap. It is the same as a normal Backbone.Collection, but with
    126. 

  126. a few alterations:</p>
    127. 

  127. <ul>
    128. 

  128. <li>It keeps a reference to the event bus upon construction</li>
    129. 

  129. <li>It can reply to DataStore API requests on that event bus, if a
    130. 

  130. namespace option is passed to it.</li>
    131. 

  131. </ul>
    132. 

  132. <h3>Dependencies</h3>
    133. 

  133. <hr>
    134. 

  134. 

  135.             </div>
    136. 

  136.             
    137. 

  137.         </li>
    138. 

  138.         
    139. 

  139.         
    140. 

  140.         <li id="section-4">
    141. 

  141.             <div class="annotation">
    142. 

  142.               
    143. 

  143.               <div class="pilwrap ">
    144. 

  144.                 <a class="pilcrow" href="#section-4">&#182;</a>
    145. 

  145.               </div>
    146. 

  146.               
    147. 

  147.             </div>
    148. 

  148.             
    149. 

  149.             <div class="content"><div class='highlight'><pre>  <span class="keyword">var</span> Backbone = options.Backbone;
    150. 

  150.   <span class="keyword">var</span> _ = options._;
    151. 

  151.   <span class="keyword">var</span> FilterCollection = options.FilterCollection;</pre></div></div>
    152. 

  152.             
    153. 

  153.         </li>
    154. 

  154.         
    155. 

  155.         
    156. 

  156.         <li id="section-5">
    157. 

  157.             <div class="annotation">
    158. 

  158.               
    159. 

  159.               <div class="pilwrap for-h3">
    160. 

  160.                 <a class="pilcrow" href="#section-5">&#182;</a>
    161. 

  161.               </div>
    162. 

  162.               <h3>BaseCollection</h3>
    163. 

  163. <hr>
    164. 

  164. 

  165.             </div>
    166. 

  166.             
    167. 

  167.         </li>
    168. 

  168.         
    169. 

  169.         
    170. 

  170.         <li id="section-6">
    171. 

  171.             <div class="annotation">
    172. 

  172.               
    173. 

  173.               <div class="pilwrap ">
    174. 

  174.                 <a class="pilcrow" href="#section-6">&#182;</a>
    175. 

  175.               </div>
    176. 

  176.               
    177. 

  177.             </div>
    178. 

  178.             
    179. 

  179.             <div class="content"><div class='highlight'><pre>  <span class="keyword">var</span> BaseCollection = Backbone.Collection.extend({</pre></div></div>
    180. 

  180.             
    181. 

  181.         </li>
    182. 

  182.         
    183. 

  183.         
    184. 

  184.         <li id="section-7">
    185. 

  185.             <div class="annotation">
    186. 

  186.               
    187. 

  187.               <div class="pilwrap ">
    188. 

  188.                 <a class="pilcrow" href="#section-7">&#182;</a>
    189. 

  189.               </div>
    190. 

  190.               <p>The DataStore API events</p>
    191. 

  191. 

  192.             </div>
    193. 

  193.             
    194. 

  194.             <div class="content"><div class='highlight'><pre>    dataStoreAPI: [
    195. 

  195.       <span class="string">'all'</span>, <span class="string">'find'</span>, <span class="string">'where'</span>, <span class="string">'filter'</span>, <span class="string">'build'</span>
    196. 

  196.     ],</pre></div></div>
    197. 

  197.             
    198. 

  198.         </li>
    199. 

  199.         
    200. 

  200.         
    201. 

  201.         <li id="section-8">
    202. 

  202.             <div class="annotation">
    203. 

  203.               
    204. 

  204.               <div class="pilwrap ">
    205. 

  205.                 <a class="pilcrow" href="#section-8">&#182;</a>
    206. 

  206.               </div>
    207. 

  207.               <p>Creates a BaseCollection and returns it. Accepts <code>models</code>, and
    208. 

  208. <code>options</code> parameters. The <code>options</code> parameter should contain an
    209. 

  209. instance of the application event bus. If you want this BaseCollection
    210. 

  210. to be able to respond to DataStore API requests on the event bus, you
    211. 

  211. should also pass a <code>namespace</code> property on the <code>options</code> object.</p>
    212. 

  212. 

  213.             </div>
    214. 

  214.             
    215. 

  215.             <div class="content"><div class='highlight'><pre>    constructor: <span class="keyword">function</span>(models, options) {
    216. 

  216.       Backbone.Collection.apply(<span class="keyword">this</span>, arguments);
    217. 

  217. 

  218.       models = models || [];
    219. 

  219.       options = options || {};
    220. 

  220. 

  221.       <span class="keyword">this</span>._vent = options.vent;
    222. 

  222. 

  223.       <span class="keyword">if</span> (!<span class="keyword">this</span>.namespace) {
    224. 

  224.         <span class="keyword">this</span>.namespace = options.namespace;
    225. 

  225.       }
    226. 

  226. 

  227.       <span class="keyword">if</span> (<span class="keyword">this</span>.namespace) {
    228. 

  228.         <span class="keyword">var</span> locals = _.map(<span class="keyword">this</span>.dataStoreAPI, <span class="keyword">function</span>(name) {
    229. 

  229.           <span class="keyword">return</span> <span class="string">'_'</span> + name;
    230. 

  230.         });
    231. 

  231. 

  232.         _.bindAll(<span class="keyword">this</span>, locals);
    233. 

  233.         <span class="keyword">this</span>._setupDSBindings(<span class="keyword">this</span>.namespace, <span class="keyword">this</span>.dataStoreAPI);
    234. 

  234.       }
    235. 

  235. 

  236.       <span class="keyword">return</span> <span class="keyword">this</span>;
    237. 

  237.     },</pre></div></div>
    238. 

  238.             
    239. 

  239.         </li>
    240. 

  240.         
    241. 

  241.         
    242. 

  242.         <li id="section-9">
    243. 

  243.             <div class="annotation">
    244. 

  244.               
    245. 

  245.               <div class="pilwrap for-h3">
    246. 

  246.                 <a class="pilcrow" href="#section-9">&#182;</a>
    247. 

  247.               </div>
    248. 

  248.               <h3>DataStore API functions</h3>
    249. 

  249. 

  250.             </div>
    251. 

  251.             
    252. 

  252.             <div class="content"><div class='highlight'><pre>    _subcollection: <span class="keyword">function</span>(options) {
    253. 

  253.       <span class="keyword">var</span> col = <span class="keyword">new</span> FilterCollection({
    254. 

  254.         filter: options.filter,
    255. 

  255.         parent: <span class="keyword">this</span>
    256. 

  256.       });
    257. 

  257.       <span class="keyword">return</span> col;
    258. 

  258.     },
    259. 

  259. 

  260.     _build: <span class="keyword">function</span>(attrs, options, cb) {
    261. 

  261.       <span class="keyword">var</span> args = Array.prototype.slice.call(arguments);
    262. 

  262. 

  263.       <span class="keyword">if</span> (args.length === <span class="number">1</span>) {
    264. 

  264.         cb = args[<span class="number">0</span>];
    265. 

  265.         attrs = {};
    266. 

  266.         options = {};
    267. 

  267.       } <span class="keyword">else</span> <span class="keyword">if</span> (args.length === <span class="number">2</span>) {
    268. 

  268.         attrs = args[<span class="number">0</span>];
    269. 

  269.         options = {};
    270. 

  270.         cb = args[<span class="number">1</span>];
    271. 

  271.       }
    272. 

  272. 

  273.       <span class="keyword">var</span> model = <span class="keyword">new</span> <span class="keyword">this</span>.model(attrs, options);
    274. 

  274.       <span class="keyword">return</span> cb (<span class="literal">null</span>, model);
    275. 

  275.     },
    276. 

  276. 

  277.     _all: <span class="keyword">function</span>(cb) {
    278. 

  278.       <span class="keyword">var</span> filter = <span class="keyword">function</span>(model) { <span class="keyword">return</span> <span class="literal">true</span>; };
    279. 

  279.       <span class="keyword">var</span> all = <span class="keyword">this</span>._subcollection({filter: filter});
    280. 

  280.       <span class="keyword">return</span> cb(<span class="literal">null</span>, all);
    281. 

  281.     },
    282. 

  282. 

  283.     _find: <span class="keyword">function</span>(attrs, cb) {
    284. 

  284.       <span class="keyword">this</span>._where(attrs, <span class="keyword">function</span>(err, data) {
    285. 

  285.         <span class="keyword">if</span> (err) { <span class="keyword">return</span> cb(err); }
    286. 

  286. 

  287.         <span class="keyword">if</span> (data.length &lt; <span class="number">1</span>) {
    288. 

  288.           err = <span class="keyword">new</span> Error(<span class="string">'DSNotFoundError'</span>);
    289. 

  289.           <span class="keyword">return</span> cb(err);
    290. 

  290.         }
    291. 

  291. 

  292.         <span class="keyword">var</span> model = data.at(<span class="number">0</span>);
    293. 

  293.         <span class="keyword">return</span> cb(<span class="literal">null</span>, model);
    294. 

  294.       });
    295. 

  295.     },
    296. 

  296. 

  297.     _where: <span class="keyword">function</span>(attrs, cb) {
    298. 

  298.       <span class="keyword">var</span> filter = <span class="keyword">function</span>(model) {
    299. 

  299. 

  300.         <span class="keyword">for</span> (<span class="keyword">var</span> key <span class="keyword">in</span> attrs) {
    301. 

  301.           <span class="keyword">var</span> modelValue = model.get(key);
    302. 

  302.           <span class="keyword">var</span> value = attrs[key];
    303. 

  303. 

  304.           <span class="keyword">if</span> ((value <span class="keyword">instanceof</span> Array) &amp;&amp; (modelValue <span class="keyword">instanceof</span> Array)) {
    305. 

  305.             <span class="keyword">if</span> (value !== modelValue) { <span class="keyword">return</span> <span class="literal">false</span>; }
    306. 

  306.           } <span class="keyword">else</span> <span class="keyword">if</span> (value <span class="keyword">instanceof</span> Array) {
    307. 

  307.             <span class="keyword">if</span> (!_.contains(value, modelValue)) { <span class="keyword">return</span> <span class="literal">false</span>; }
    308. 

  308.           } <span class="keyword">else</span> <span class="keyword">if</span> (modelValue <span class="keyword">instanceof</span> Array) {
    309. 

  309.             <span class="keyword">if</span> (!_.contains(modelValue, value)) { <span class="keyword">return</span> <span class="literal">false</span>; }
    310. 

  310.           } <span class="keyword">else</span> {
    311. 

  311.             <span class="keyword">if</span> (modelValue !== value) { <span class="keyword">return</span> <span class="literal">false</span>; }
    312. 

  312.           }
    313. 

  313.         }
    314. 

  314.         <span class="keyword">return</span> <span class="literal">true</span>;
    315. 

  315.       };
    316. 

  316.       <span class="keyword">var</span> col = <span class="keyword">this</span>._subcollection({filter: filter});
    317. 

  317.       <span class="keyword">return</span> cb(<span class="literal">null</span>, col);
    318. 

  318.     },
    319. 

  319. 

  320.     _filter: <span class="keyword">function</span>(filter, cb) {
    321. 

  321.       <span class="keyword">var</span> col = <span class="keyword">this</span>._subcollection({filter: filter});
    322. 

  322.       <span class="keyword">return</span> cb(<span class="literal">null</span>, col);
    323. 

  323.     },</pre></div></div>
    324. 

  324.             
    325. 

  325.         </li>
    326. 

  326.         
    327. 

  327.         
    328. 

  328.         <li id="section-10">
    329. 

  329.             <div class="annotation">
    330. 

  330.               
    331. 

  331.               <div class="pilwrap ">
    332. 

  332.                 <a class="pilcrow" href="#section-10">&#182;</a>
    333. 

  333.               </div>
    334. 

  334.               <p>Binds DataStore API message names to functions on this instance. For
    335. 

  335. example, ds:contacts:all -&gt; this._all</p>
    336. 

  336. 

  337.             </div>
    338. 

  338.             
    339. 

  339.             <div class="content"><div class='highlight'><pre>    _setupDSBindings: <span class="keyword">function</span>(namespace, dsEvents) {
    340. 

  340.       _.each(dsEvents, <span class="keyword">function</span>(name) {
    341. 

  341.         <span class="keyword">var</span> messageName = <span class="string">'ds:'</span> + namespace + <span class="string">':'</span> + name;
    342. 

  342.         <span class="keyword">var</span> ourFunc = <span class="keyword">this</span>[<span class="string">'_'</span> + name];
    343. 

  343.         <span class="keyword">this</span>._vent.handle(messageName, ourFunc);
    344. 

  344.       }, <span class="keyword">this</span>);
    345. 

  345.     }
    346. 

  346.   });</pre></div></div>
    347. 

  347.             
    348. 

  348.         </li>
    349. 

  349.         
    350. 

  350.         
    351. 

  351.         <li id="section-11">
    352. 

  352.             <div class="annotation">
    353. 

  353.               
    354. 

  354.               <div class="pilwrap for-h3">
    355. 

  355.                 <a class="pilcrow" href="#section-11">&#182;</a>
    356. 

  356.               </div>
    357. 

  357.               <h3>Exports</h3>
    358. 

  358. <hr>
    359. 

  359. 

  360.             </div>
    361. 

  361.             
    362. 

  362.         </li>
    363. 

  363.         
    364. 

  364.         
    365. 

  365.         <li id="section-12">
    366. 

  366.             <div class="annotation">
    367. 

  367.               
    368. 

  368.               <div class="pilwrap ">
    369. 

  369.                 <a class="pilcrow" href="#section-12">&#182;</a>
    370. 

  370.               </div>
    371. 

  371.               
    372. 

  372.             </div>
    373. 

  373.             
    374. 

  374.             <div class="content"><div class='highlight'><pre>  <span class="keyword">return</span> BaseCollection;
    375. 

  375. };</pre></div></div>
    376. 

  376.             
    377. 

  377.         </li>
    378. 

  378.         
    379. 

  379.     </ul>
    380. 

  380.   </div>
    381. 

  381. </body>
    382. 

  382. </html>
    383. 

  383.