PageRenderTime 57ms CodeModel.GetById 23ms RepoModel.GetById 1ms app.codeStats 0ms

/bower_components/backbone/docs/backbone.localstorage.html

https://github.com/robertd/benm
HTML | 438 lines | 310 code | 128 blank | 0 comment | 0 complexity | 907663343df468166d9ce721e7457fb5 MD5 | raw file
    

  1. <!DOCTYPE html>
    2. 

  2. 

  3. <html>
    4. 

  4. <head>
    5. 

  5.   <title>backbone.localstorage.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="backbone.localstorage.html">
    23. 

  23.                 backbone.localstorage.js
    24. 

  24.               </a>
    25. 

  25.             
    26. 

  26.               
    27. 

  27.               <a class="source" href="todos.html">
    28. 

  28.                 todos.js
    29. 

  29.               </a>
    30. 

  30.             
    31. 

  31.           </div>
    32. 

  32.         </li>
    33. 

  33.       </ul>
    34. 

  34.     
    35. 

  35.     <ul class="sections">
    36. 

  36.         
    37. 

  37.           <li id="title">
    38. 

  38.               <div class="annotation">
    39. 

  39.                   <h1>backbone.localstorage.js</h1>
    40. 

  40.               </div>
    41. 

  41.           </li>
    42. 

  42.         
    43. 

  43.         
    44. 

  44.         
    45. 

  45.         <li id="section-1">
    46. 

  46.             <div class="annotation">
    47. 

  47.               
    48. 

  48.               <div class="pilwrap ">
    49. 

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

  50.               </div>
    51. 

  51.               
    52. 

  52.             </div>
    53. 

  53.             
    54. 

  54.             <div class="content"><div class='highlight'><pre><span class="comment">/**
    55. 

  55.  * Backbone localStorage Adapter
    56. 

  56.  * Version 1.1.0
    57. 

  57.  *
    58. 

  58.  * https://github.com/jeromegn/Backbone.localStorage
    59. 

  59.  */</span>
    60. 

  60. (<span class="function"><span class="keyword">function</span> <span class="params">(root, factory)</span> {</span>
    61. 

  61.    <span class="keyword">if</span> (<span class="keyword">typeof</span> define === <span class="string">"function"</span> &amp;&amp; define.amd) {</pre></div></div>
    62. 

  62.             
    63. 

  63.         </li>
    64. 

  64.         
    65. 

  65.         
    66. 

  66.         <li id="section-2">
    67. 

  67.             <div class="annotation">
    68. 

  68.               
    69. 

  69.               <div class="pilwrap ">
    70. 

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

  71.               </div>
    72. 

  72.               <p>AMD. Register as an anonymous module.</p>
    73. 

  73. 

  74.             </div>
    75. 

  75.             
    76. 

  76.             <div class="content"><div class='highlight'><pre>      define([<span class="string">"underscore"</span>,<span class="string">"backbone"</span>], <span class="keyword">function</span>(_, Backbone) {</pre></div></div>
    77. 

  77.             
    78. 

  78.         </li>
    79. 

  79.         
    80. 

  80.         
    81. 

  81.         <li id="section-3">
    82. 

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

  83.               
    84. 

  84.               <div class="pilwrap ">
    85. 

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

  86.               </div>
    87. 

  87.               <p>Use global variables if the locals are undefined.</p>
    88. 

  88. 

  89.             </div>
    90. 

  90.             
    91. 

  91.             <div class="content"><div class='highlight'><pre>        <span class="keyword">return</span> factory(_ || root._, Backbone || root.Backbone);
    92. 

  92.       });
    93. 

  93.    } <span class="keyword">else</span> {</pre></div></div>
    94. 

  94.             
    95. 

  95.         </li>
    96. 

  96.         
    97. 

  97.         
    98. 

  98.         <li id="section-4">
    99. 

  99.             <div class="annotation">
    100. 

  100.               
    101. 

  101.               <div class="pilwrap ">
    102. 

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

  103.               </div>
    104. 

  104.               <p>RequireJS isn&#39;t being used. Assume underscore and backbone are loaded in <script> tags</p>
    105. 

  105. 

  106.             </div>
    107. 

  107.             
    108. 

  108.             <div class="content"><div class='highlight'><pre>      factory(_, Backbone);
    109. 

  109.    }
    110. 

  110. }(<span class="keyword">this</span>, <span class="keyword">function</span>(_, Backbone) {</pre></div></div>
    111. 

  111.             
    112. 

  112.         </li>
    113. 

  113.         
    114. 

  114.         
    115. 

  115.         <li id="section-5">
    116. 

  116.             <div class="annotation">
    117. 

  117.               
    118. 

  118.               <div class="pilwrap ">
    119. 

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

  120.               </div>
    121. 

  121.               <p>A simple module to replace <code>Backbone.sync</code> with <em>localStorage</em>-based
    122. 

  122. persistence. Models are given GUIDS, and saved into a JSON object. Simple
    123. 

  123. as that.</p>
    124. 

  124. <p>Hold reference to Underscore.js and Backbone.js in the closure in order
    125. 

  125. to make things work even if they are removed from the global namespace</p>
    126. 

  126. <p>Generate four random hex digits.</p>
    127. 

  127. 

  128.             </div>
    129. 

  129.             
    130. 

  130.             <div class="content"><div class='highlight'><pre><span class="function"><span class="keyword">function</span> <span class="title">S4</span><span class="params">()</span> {</span>
    131. 

  131.    <span class="keyword">return</span> (((<span class="number">1</span>+Math.random())*<span class="number">0x10000</span>)|<span class="number">0</span>).toString(<span class="number">16</span>).substring(<span class="number">1</span>);
    132. 

  132. };</pre></div></div>
    133. 

  133.             
    134. 

  134.         </li>
    135. 

  135.         
    136. 

  136.         
    137. 

  137.         <li id="section-6">
    138. 

  138.             <div class="annotation">
    139. 

  139.               
    140. 

  140.               <div class="pilwrap ">
    141. 

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

  142.               </div>
    143. 

  143.               <p>Generate a pseudo-GUID by concatenating random hexadecimal.</p>
    144. 

  144. 

  145.             </div>
    146. 

  146.             
    147. 

  147.             <div class="content"><div class='highlight'><pre><span class="function"><span class="keyword">function</span> <span class="title">guid</span><span class="params">()</span> {</span>
    148. 

  148.    <span class="keyword">return</span> (S4()+S4()+<span class="string">"-"</span>+S4()+<span class="string">"-"</span>+S4()+<span class="string">"-"</span>+S4()+<span class="string">"-"</span>+S4()+S4()+S4());
    149. 

  149. };</pre></div></div>
    150. 

  150.             
    151. 

  151.         </li>
    152. 

  152.         
    153. 

  153.         
    154. 

  154.         <li id="section-7">
    155. 

  155.             <div class="annotation">
    156. 

  156.               
    157. 

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

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

  159.               </div>
    160. 

  160.               <p>Our Store is represented by a single JS object in <em>localStorage</em>. Create it
    161. 

  161. with a meaningful name, like the name you&#39;d give a table.
    162. 

  162. window.Store is deprectated, use Backbone.LocalStorage instead</p>
    163. 

  163. 

  164.             </div>
    165. 

  165.             
    166. 

  166.             <div class="content"><div class='highlight'><pre>Backbone.LocalStorage = window.Store = <span class="keyword">function</span>(name) {
    167. 

  167.   <span class="keyword">this</span>.name = name;
    168. 

  168.   <span class="keyword">var</span> store = <span class="keyword">this</span>.localStorage().getItem(<span class="keyword">this</span>.name);
    169. 

  169.   <span class="keyword">this</span>.records = (store &amp;&amp; store.split(<span class="string">","</span>)) || [];
    170. 

  170. };
    171. 

  171. 

  172. _.extend(Backbone.LocalStorage.prototype, {</pre></div></div>
    173. 

  173.             
    174. 

  174.         </li>
    175. 

  175.         
    176. 

  176.         
    177. 

  177.         <li id="section-8">
    178. 

  178.             <div class="annotation">
    179. 

  179.               
    180. 

  180.               <div class="pilwrap ">
    181. 

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

  182.               </div>
    183. 

  183.               <p>Save the current state of the <strong>Store</strong> to <em>localStorage</em>.</p>
    184. 

  184. 

  185.             </div>
    186. 

  186.             
    187. 

  187.             <div class="content"><div class='highlight'><pre>  save: <span class="keyword">function</span>() {
    188. 

  188.     <span class="keyword">this</span>.localStorage().setItem(<span class="keyword">this</span>.name, <span class="keyword">this</span>.records.join(<span class="string">","</span>));
    189. 

  189.   },</pre></div></div>
    190. 

  190.             
    191. 

  191.         </li>
    192. 

  192.         
    193. 

  193.         
    194. 

  194.         <li id="section-9">
    195. 

  195.             <div class="annotation">
    196. 

  196.               
    197. 

  197.               <div class="pilwrap ">
    198. 

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

  199.               </div>
    200. 

  200.               <p>Add a model, giving it a (hopefully)-unique GUID, if it doesn&#39;t already
    201. 

  201. have an id of it&#39;s own.</p>
    202. 

  202. 

  203.             </div>
    204. 

  204.             
    205. 

  205.             <div class="content"><div class='highlight'><pre>  create: <span class="keyword">function</span>(model) {
    206. 

  206.     <span class="keyword">if</span> (!model.id) {
    207. 

  207.       model.id = guid();
    208. 

  208.       model.set(model.idAttribute, model.id);
    209. 

  209.     }
    210. 

  210.     <span class="keyword">this</span>.localStorage().setItem(<span class="keyword">this</span>.name+<span class="string">"-"</span>+model.id, JSON.stringify(model));
    211. 

  211.     <span class="keyword">this</span>.records.push(model.id.toString());
    212. 

  212.     <span class="keyword">this</span>.save();
    213. 

  213.     <span class="keyword">return</span> <span class="keyword">this</span>.find(model);
    214. 

  214.   },</pre></div></div>
    215. 

  215.             
    216. 

  216.         </li>
    217. 

  217.         
    218. 

  218.         
    219. 

  219.         <li id="section-10">
    220. 

  220.             <div class="annotation">
    221. 

  221.               
    222. 

  222.               <div class="pilwrap ">
    223. 

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

  224.               </div>
    225. 

  225.               <p>Update a model by replacing its copy in <code>this.data</code>.</p>
    226. 

  226. 

  227.             </div>
    228. 

  228.             
    229. 

  229.             <div class="content"><div class='highlight'><pre>  update: <span class="keyword">function</span>(model) {
    230. 

  230.     <span class="keyword">this</span>.localStorage().setItem(<span class="keyword">this</span>.name+<span class="string">"-"</span>+model.id, JSON.stringify(model));
    231. 

  231.     <span class="keyword">if</span> (!_.include(<span class="keyword">this</span>.records, model.id.toString()))
    232. 

  232.       <span class="keyword">this</span>.records.push(model.id.toString()); <span class="keyword">this</span>.save();
    233. 

  233.     <span class="keyword">return</span> <span class="keyword">this</span>.find(model);
    234. 

  234.   },</pre></div></div>
    235. 

  235.             
    236. 

  236.         </li>
    237. 

  237.         
    238. 

  238.         
    239. 

  239.         <li id="section-11">
    240. 

  240.             <div class="annotation">
    241. 

  241.               
    242. 

  242.               <div class="pilwrap ">
    243. 

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

  244.               </div>
    245. 

  245.               <p>Retrieve a model from <code>this.data</code> by id.</p>
    246. 

  246. 

  247.             </div>
    248. 

  248.             
    249. 

  249.             <div class="content"><div class='highlight'><pre>  find: <span class="keyword">function</span>(model) {
    250. 

  250.     <span class="keyword">return</span> <span class="keyword">this</span>.jsonData(<span class="keyword">this</span>.localStorage().getItem(<span class="keyword">this</span>.name+<span class="string">"-"</span>+model.id));
    251. 

  251.   },</pre></div></div>
    252. 

  252.             
    253. 

  253.         </li>
    254. 

  254.         
    255. 

  255.         
    256. 

  256.         <li id="section-12">
    257. 

  257.             <div class="annotation">
    258. 

  258.               
    259. 

  259.               <div class="pilwrap ">
    260. 

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

  261.               </div>
    262. 

  262.               <p>Return the array of all models currently in storage.</p>
    263. 

  263. 

  264.             </div>
    265. 

  265.             
    266. 

  266.             <div class="content"><div class='highlight'><pre>  findAll: <span class="keyword">function</span>() {
    267. 

  267.     <span class="keyword">return</span> _(<span class="keyword">this</span>.records).chain()
    268. 

  268.       .map(<span class="keyword">function</span>(id){
    269. 

  269.         <span class="keyword">return</span> <span class="keyword">this</span>.jsonData(<span class="keyword">this</span>.localStorage().getItem(<span class="keyword">this</span>.name+<span class="string">"-"</span>+id));
    270. 

  270.       }, <span class="keyword">this</span>)
    271. 

  271.       .compact()
    272. 

  272.       .value();
    273. 

  273.   },</pre></div></div>
    274. 

  274.             
    275. 

  275.         </li>
    276. 

  276.         
    277. 

  277.         
    278. 

  278.         <li id="section-13">
    279. 

  279.             <div class="annotation">
    280. 

  280.               
    281. 

  281.               <div class="pilwrap ">
    282. 

  282.                 <a class="pilcrow" href="#section-13">&#182;</a>
    283. 

  283.               </div>
    284. 

  284.               <p>Delete a model from <code>this.data</code>, returning it.</p>
    285. 

  285. 

  286.             </div>
    287. 

  287.             
    288. 

  288.             <div class="content"><div class='highlight'><pre>  destroy: <span class="keyword">function</span>(model) {
    289. 

  289.     <span class="keyword">if</span> (model.isNew())
    290. 

  290.       <span class="keyword">return</span> <span class="literal">false</span>
    291. 

  291.     <span class="keyword">this</span>.localStorage().removeItem(<span class="keyword">this</span>.name+<span class="string">"-"</span>+model.id);
    292. 

  292.     <span class="keyword">this</span>.records = _.reject(<span class="keyword">this</span>.records, <span class="keyword">function</span>(id){
    293. 

  293.       <span class="keyword">return</span> id === model.id.toString();
    294. 

  294.     });
    295. 

  295.     <span class="keyword">this</span>.save();
    296. 

  296.     <span class="keyword">return</span> model;
    297. 

  297.   },
    298. 

  298. 

  299.   localStorage: <span class="keyword">function</span>() {
    300. 

  300.     <span class="keyword">return</span> localStorage;
    301. 

  301.   },</pre></div></div>
    302. 

  302.             
    303. 

  303.         </li>
    304. 

  304.         
    305. 

  305.         
    306. 

  306.         <li id="section-14">
    307. 

  307.             <div class="annotation">
    308. 

  308.               
    309. 

  309.               <div class="pilwrap ">
    310. 

  310.                 <a class="pilcrow" href="#section-14">&#182;</a>
    311. 

  311.               </div>
    312. 

  312.               <p>fix for &quot;illegal access&quot; error on Android when JSON.parse is passed null</p>
    313. 

  313. 

  314.             </div>
    315. 

  315.             
    316. 

  316.             <div class="content"><div class='highlight'><pre>  jsonData: <span class="function"><span class="keyword">function</span> <span class="params">(data)</span> {</span>
    317. 

  317.       <span class="keyword">return</span> data &amp;&amp; JSON.parse(data);
    318. 

  318.   }
    319. 

  319. 

  320. });</pre></div></div>
    321. 

  321.             
    322. 

  322.         </li>
    323. 

  323.         
    324. 

  324.         
    325. 

  325.         <li id="section-15">
    326. 

  326.             <div class="annotation">
    327. 

  327.               
    328. 

  328.               <div class="pilwrap ">
    329. 

  329.                 <a class="pilcrow" href="#section-15">&#182;</a>
    330. 

  330.               </div>
    331. 

  331.               <p>localSync delegate to the model or collection&#39;s
    332. 

  332. <em>localStorage</em> property, which should be an instance of <code>Store</code>.
    333. 

  333. window.Store.sync and Backbone.localSync is deprectated, use Backbone.LocalStorage.sync instead</p>
    334. 

  334. 

  335.             </div>
    336. 

  336.             
    337. 

  337.             <div class="content"><div class='highlight'><pre>Backbone.LocalStorage.sync = window.Store.sync = Backbone.localSync = <span class="keyword">function</span>(method, model, options) {
    338. 

  338.   <span class="keyword">var</span> store = model.localStorage || model.collection.localStorage;
    339. 

  339. 

  340.   <span class="keyword">var</span> resp, errorMessage, syncDfd = $.Deferred &amp;&amp; $.Deferred(); <span class="comment">//If $ is having Deferred - use it.</span>
    341. 

  341. 

  342.   <span class="keyword">try</span> {
    343. 

  343. 

  344.     <span class="keyword">switch</span> (method) {
    345. 

  345.       <span class="keyword">case</span> <span class="string">"read"</span>:
    346. 

  346.         resp = model.id != <span class="literal">undefined</span> ? store.find(model) : store.findAll();
    347. 

  347.         <span class="keyword">break</span>;
    348. 

  348.       <span class="keyword">case</span> <span class="string">"create"</span>:
    349. 

  349.         resp = store.create(model);
    350. 

  350.         <span class="keyword">break</span>;
    351. 

  351.       <span class="keyword">case</span> <span class="string">"update"</span>:
    352. 

  352.         resp = store.update(model);
    353. 

  353.         <span class="keyword">break</span>;
    354. 

  354.       <span class="keyword">case</span> <span class="string">"delete"</span>:
    355. 

  355.         resp = store.destroy(model);
    356. 

  356.         <span class="keyword">break</span>;
    357. 

  357.     }
    358. 

  358. 

  359.   } <span class="keyword">catch</span>(error) {
    360. 

  360.     <span class="keyword">if</span> (error.code === DOMException.QUOTA_EXCEEDED_ERR &amp;&amp; window.localStorage.length === <span class="number">0</span>)
    361. 

  361.       errorMessage = <span class="string">"Private browsing is unsupported"</span>;
    362. 

  362.     <span class="keyword">else</span>
    363. 

  363.       errorMessage = error.message;
    364. 

  364.   }
    365. 

  365. 

  366.   <span class="keyword">if</span> (resp) {
    367. 

  367.     model.trigger(<span class="string">"sync"</span>, model, resp, options);
    368. 

  368.     <span class="keyword">if</span> (options &amp;&amp; options.success)
    369. 

  369.       options.success(resp);
    370. 

  370.     <span class="keyword">if</span> (syncDfd)
    371. 

  371.       syncDfd.resolve(resp);
    372. 

  372. 

  373.   } <span class="keyword">else</span> {
    374. 

  374.     errorMessage = errorMessage ? errorMessage
    375. 

  375.                                 : <span class="string">"Record Not Found"</span>;
    376. 

  376. 

  377.     <span class="keyword">if</span> (options &amp;&amp; options.error)
    378. 

  378.       options.error(errorMessage);
    379. 

  379.     <span class="keyword">if</span> (syncDfd)
    380. 

  380.       syncDfd.reject(errorMessage);
    381. 

  381.   }</pre></div></div>
    382. 

  382.             
    383. 

  383.         </li>
    384. 

  384.         
    385. 

  385.         
    386. 

  386.         <li id="section-16">
    387. 

  387.             <div class="annotation">
    388. 

  388.               
    389. 

  389.               <div class="pilwrap ">
    390. 

  390.                 <a class="pilcrow" href="#section-16">&#182;</a>
    391. 

  391.               </div>
    392. 

  392.               <p>add compatibility with $.ajax
    393. 

  393. always execute callback for success and error</p>
    394. 

  394. 

  395.             </div>
    396. 

  396.             
    397. 

  397.             <div class="content"><div class='highlight'><pre>  <span class="keyword">if</span> (options &amp;&amp; options.complete) options.complete(resp);
    398. 

  398. 

  399.   <span class="keyword">return</span> syncDfd &amp;&amp; syncDfd.promise();
    400. 

  400. };
    401. 

  401. 

  402. Backbone.ajaxSync = Backbone.sync;
    403. 

  403. 

  404. Backbone.getSyncMethod = <span class="keyword">function</span>(model) {
    405. 

  405.   <span class="keyword">if</span>(model.localStorage || (model.collection &amp;&amp; model.collection.localStorage)) {
    406. 

  406.     <span class="keyword">return</span> Backbone.localSync;
    407. 

  407.   }
    408. 

  408. 

  409.   <span class="keyword">return</span> Backbone.ajaxSync;
    410. 

  410. };</pre></div></div>
    411. 

  411.             
    412. 

  412.         </li>
    413. 

  413.         
    414. 

  414.         
    415. 

  415.         <li id="section-17">
    416. 

  416.             <div class="annotation">
    417. 

  417.               
    418. 

  418.               <div class="pilwrap ">
    419. 

  419.                 <a class="pilcrow" href="#section-17">&#182;</a>
    420. 

  420.               </div>
    421. 

  421.               <p>Override &#39;Backbone.sync&#39; to default to localSync,
    422. 

  422. the original &#39;Backbone.sync&#39; is still available in &#39;Backbone.ajaxSync&#39;</p>
    423. 

  423. 

  424.             </div>
    425. 

  425.             
    426. 

  426.             <div class="content"><div class='highlight'><pre>Backbone.sync = <span class="keyword">function</span>(method, model, options) {
    427. 

  427.   <span class="keyword">return</span> Backbone.getSyncMethod(model).apply(<span class="keyword">this</span>, [method, model, options]);
    428. 

  428. };
    429. 

  429. 

  430. <span class="keyword">return</span> Backbone.LocalStorage;
    431. 

  431. }));</pre></div></div>
    432. 

  432.             
    433. 

  433.         </li>
    434. 

  434.         
    435. 

  435.     </ul>
    436. 

  436.   </div>
    437. 

  437. </body>
    438. 

  438. </html>
    439. 

  439.