graphiti 2.0.0.beta.6 → 2.0.0.beta.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (246) hide show
  1. checksums.yaml +4 -4
  2. data/.git-blame-ignore-revs +2 -0
  3. data/.github/workflows/ci.yml +55 -3
  4. data/.github/workflows/docs.yml +1 -1
  5. data/.github/workflows/notify-example-app.yml +18 -0
  6. data/.gitignore +2 -0
  7. data/.standard.yml +6 -0
  8. data/CHANGELOG.md +54 -0
  9. data/CONTRIBUTING.md +3 -1
  10. data/README.md +13 -206
  11. data/Rakefile +6 -3
  12. data/UPGRADING.md +1 -1
  13. data/graphiti.gemspec +8 -4
  14. data/lib/generators/graphiti/generator_mixin.rb +1 -1
  15. data/lib/generators/graphiti/install_generator.rb +1 -2
  16. data/lib/generators/graphiti/resource_generator.rb +6 -3
  17. data/lib/generators/graphiti/templates/application_resource.rb.erb +19 -0
  18. data/lib/generators/graphiti/templates/controller.rb.erb +26 -8
  19. data/lib/generators/graphiti/templates/index_request_spec.rb.erb +2 -2
  20. data/lib/generators/graphiti/templates/resource_reads_spec.rb.erb +4 -4
  21. data/lib/generators/graphiti/templates/show_request_spec.rb.erb +2 -2
  22. data/lib/graphiti/audit/report.rb +6 -6
  23. data/lib/graphiti/audit.rb +3 -4
  24. data/lib/graphiti/delegates/pagination.rb +2 -2
  25. data/lib/graphiti/deserializer.rb +3 -3
  26. data/lib/graphiti/errors.rb +6 -6
  27. data/lib/graphiti/extensions/temp_id.rb +1 -1
  28. data/lib/graphiti/query.rb +27 -8
  29. data/lib/graphiti/rails/context.rb +2 -1
  30. data/lib/graphiti/rails/controller.rb +3 -0
  31. data/lib/graphiti/rails/debugging.rb +1 -1
  32. data/lib/graphiti/rails/responders.rb +2 -1
  33. data/lib/graphiti/resource/configuration.rb +1 -0
  34. data/lib/graphiti/resource/dsl.rb +2 -2
  35. data/lib/graphiti/resource/interface.rb +3 -3
  36. data/lib/graphiti/resource/links.rb +1 -1
  37. data/lib/graphiti/resource/persistence.rb +1 -1
  38. data/lib/graphiti/resource/polymorphism.rb +1 -1
  39. data/lib/graphiti/resource.rb +2 -2
  40. data/lib/graphiti/resource_proxy.rb +0 -1
  41. data/lib/graphiti/runner.rb +8 -3
  42. data/lib/graphiti/scope.rb +13 -0
  43. data/lib/graphiti/scoping/filter.rb +5 -3
  44. data/lib/graphiti/scoping/paginate.rb +1 -1
  45. data/lib/graphiti/scoping/sort.rb +1 -1
  46. data/lib/graphiti/sideload/has_many.rb +1 -1
  47. data/lib/graphiti/spec_helpers/errors_proxy.rb +1 -1
  48. data/lib/graphiti/spec_helpers/matchers.rb +1 -1
  49. data/lib/graphiti/spec_helpers.rb +5 -0
  50. data/lib/graphiti/types.rb +5 -1
  51. data/lib/graphiti/util/cache_debug.rb +3 -3
  52. data/lib/graphiti/util/hash.rb +1 -1
  53. data/lib/graphiti/util/persistence.rb +6 -6
  54. data/lib/graphiti/util/serializer_relationships.rb +1 -1
  55. data/lib/graphiti/version.rb +1 -1
  56. data/lib/tasks/graphiti.rake +1 -1
  57. data/package.json +1 -0
  58. metadata +31 -197
  59. data/docs/concepts/backends-and-models.md +0 -122
  60. data/docs/concepts/endpoints.md +0 -183
  61. data/docs/concepts/links.md +0 -212
  62. data/docs/concepts/overview.md +0 -80
  63. data/docs/concepts/persisting.md +0 -376
  64. data/docs/concepts/relationships.md +0 -627
  65. data/docs/concepts/resources.md +0 -677
  66. data/docs/getting-started/first-api.md +0 -289
  67. data/docs/getting-started/installation.md +0 -185
  68. data/docs/intro.md +0 -307
  69. data/docs/js/authentication.md +0 -63
  70. data/docs/js/ddau.md +0 -20
  71. data/docs/js/extra-params.md +0 -41
  72. data/docs/js/index.md +0 -112
  73. data/docs/js/installation.md +0 -120
  74. data/docs/js/middleware.md +0 -72
  75. data/docs/js/models.md +0 -202
  76. data/docs/js/reads.md +0 -494
  77. data/docs/js/state-syncing.md +0 -100
  78. data/docs/js/writes.md +0 -373
  79. data/docs/reference/vandal.md +0 -63
  80. data/docs/reference/why.md +0 -13
  81. data/docs/topics/authorization.md +0 -155
  82. data/docs/topics/caching.md +0 -55
  83. data/docs/topics/customizing-sideloads.md +0 -156
  84. data/docs/topics/debugging.md +0 -242
  85. data/docs/topics/error-handling.md +0 -210
  86. data/docs/topics/etags.md +0 -46
  87. data/docs/topics/hopping-relationships.md +0 -149
  88. data/docs/topics/json-attributes.md +0 -77
  89. data/docs/topics/openstruct-models.md +0 -50
  90. data/docs/topics/remote-resources.md +0 -291
  91. data/docs/topics/testing.md +0 -894
  92. data/docs/topics/without-activerecord.md +0 -324
  93. data/docs/tutorial/index.md +0 -58
  94. data/docs/tutorial/step_0.md +0 -107
  95. data/docs/tutorial/step_1.md +0 -199
  96. data/docs/tutorial/step_2.md +0 -312
  97. data/docs/tutorial/step_3.md +0 -142
  98. data/docs/tutorial/step_4.md +0 -135
  99. data/docs/tutorial/step_5.md +0 -69
  100. data/docs/tutorial/step_6.md +0 -82
  101. data/docs/tutorial/step_7.md +0 -205
  102. data/docs/tutorial/step_8.md +0 -128
  103. data/docs/tutorial/step_9.md +0 -171
  104. data/docs/upgrading.md +0 -266
  105. data/website/.gitignore +0 -20
  106. data/website/README.md +0 -43
  107. data/website/docusaurus.config.js +0 -197
  108. data/website/package-lock.json +0 -19474
  109. data/website/package.json +0 -46
  110. data/website/sidebars.js +0 -82
  111. data/website/src/css/custom.css +0 -85
  112. data/website/src/pages/markdown-page.mdx +0 -7
  113. data/website/static/.nojekyll +0 -0
  114. data/website/static/1.13/2019/03/31/graphiti-1-0.html +0 -205
  115. data/website/static/1.13/2019/05/08/graphiti-1-1.html +0 -212
  116. data/website/static/1.13/2019/05/20/graphiti-1-2.html +0 -214
  117. data/website/static/1.13/2019/10/14/tutorial.html +0 -198
  118. data/website/static/1.13/CNAME +0 -1
  119. data/website/static/1.13/README.md +0 -16
  120. data/website/static/1.13/assets/css/syntax.css +0 -60
  121. data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
  122. data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
  123. data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
  124. data/website/static/1.13/assets/favicons/browserconfig.xml +0 -9
  125. data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
  126. data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
  127. data/website/static/1.13/assets/favicons/favicon.ico +0 -0
  128. data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
  129. data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +0 -1
  130. data/website/static/1.13/assets/favicons/site.webmanifest +0 -19
  131. data/website/static/1.13/assets/img/backend.gif +0 -0
  132. data/website/static/1.13/assets/img/conformity.png +0 -0
  133. data/website/static/1.13/assets/img/error_payload.png +0 -0
  134. data/website/static/1.13/assets/img/fancy-cushion.png +0 -0
  135. data/website/static/1.13/assets/img/gh.png +0 -0
  136. data/website/static/1.13/assets/img/home-bg.jpg +0 -0
  137. data/website/static/1.13/assets/img/lifecycle.gif +0 -0
  138. data/website/static/1.13/assets/img/logo-500.png +0 -0
  139. data/website/static/1.13/assets/img/logo.png +0 -0
  140. data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
  141. data/website/static/1.13/assets/img/meta_total_count.png +0 -0
  142. data/website/static/1.13/assets/img/persist.jpg +0 -0
  143. data/website/static/1.13/assets/img/resource.gif +0 -0
  144. data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
  145. data/website/static/1.13/assets/img/rest1.gif +0 -0
  146. data/website/static/1.13/assets/img/rest2.gif +0 -0
  147. data/website/static/1.13/assets/img/rest3.gif +0 -0
  148. data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
  149. data/website/static/1.13/assets/img/sunrise.png +0 -0
  150. data/website/static/1.13/assets/img/why.png +0 -0
  151. data/website/static/1.13/assets/js/highlight.pack.js +0 -2
  152. data/website/static/1.13/assets/main.css +0 -15518
  153. data/website/static/1.13/assets/main.css.map +0 -1
  154. data/website/static/1.13/bin/bundle +0 -109
  155. data/website/static/1.13/bin/jekyll +0 -27
  156. data/website/static/1.13/bin/kramdown +0 -27
  157. data/website/static/1.13/bin/listen +0 -27
  158. data/website/static/1.13/bin/rake +0 -27
  159. data/website/static/1.13/bin/rougify +0 -27
  160. data/website/static/1.13/bin/safe_yaml +0 -27
  161. data/website/static/1.13/bin/sass +0 -27
  162. data/website/static/1.13/bin/sass-convert +0 -27
  163. data/website/static/1.13/bin/scss +0 -27
  164. data/website/static/1.13/blog.html +0 -259
  165. data/website/static/1.13/cheatsheet.html +0 -316
  166. data/website/static/1.13/cookbooks/authorization.md +0 -0
  167. data/website/static/1.13/cookbooks/caching.md +0 -0
  168. data/website/static/1.13/cookbooks/customizing-sideloads.html +0 -325
  169. data/website/static/1.13/cookbooks/etags.md +0 -0
  170. data/website/static/1.13/cookbooks/hopping-relationships.html +0 -324
  171. data/website/static/1.13/cookbooks/json_attributes.md +0 -0
  172. data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
  173. data/website/static/1.13/cookbooks/remote-resources.md +0 -0
  174. data/website/static/1.13/cookbooks/without-activerecord.html +0 -510
  175. data/website/static/1.13/features.html +0 -249
  176. data/website/static/1.13/feed.xml +0 -106
  177. data/website/static/1.13/guides/concepts/backends-and-models.html +0 -467
  178. data/website/static/1.13/guides/concepts/debugging.html +0 -440
  179. data/website/static/1.13/guides/concepts/endpoints.html +0 -432
  180. data/website/static/1.13/guides/concepts/error-handling.html +0 -396
  181. data/website/static/1.13/guides/concepts/links.html +0 -501
  182. data/website/static/1.13/guides/concepts/remote-resources.html +0 -536
  183. data/website/static/1.13/guides/concepts/resources.html +0 -2176
  184. data/website/static/1.13/guides/concepts/testing.html +0 -1469
  185. data/website/static/1.13/guides/getting-started/installation.html +0 -420
  186. data/website/static/1.13/guides/graphiti-rails-migration.html +0 -242
  187. data/website/static/1.13/guides/index.html +0 -269
  188. data/website/static/1.13/guides/overview.html +0 -325
  189. data/website/static/1.13/guides/upgrading-2-0.html +0 -193
  190. data/website/static/1.13/guides/upgrading.html +0 -314
  191. data/website/static/1.13/guides/vandal.html +0 -282
  192. data/website/static/1.13/guides/why.html +0 -1121
  193. data/website/static/1.13/index.html +0 -72
  194. data/website/static/1.13/js/authentication.html +0 -295
  195. data/website/static/1.13/js/ddau.html +0 -238
  196. data/website/static/1.13/js/extra-params.html +0 -270
  197. data/website/static/1.13/js/index.html +0 -321
  198. data/website/static/1.13/js/installation.html +0 -637
  199. data/website/static/1.13/js/introduction.html +0 -257
  200. data/website/static/1.13/js/middleware.html +0 -318
  201. data/website/static/1.13/js/reads/fieldsets.html +0 -271
  202. data/website/static/1.13/js/reads/filtering.html +0 -289
  203. data/website/static/1.13/js/reads/includes.html +0 -260
  204. data/website/static/1.13/js/reads/index.html +0 -497
  205. data/website/static/1.13/js/reads/nested-queries.html +0 -353
  206. data/website/static/1.13/js/reads/pagination.html +0 -260
  207. data/website/static/1.13/js/reads/sorting.html +0 -265
  208. data/website/static/1.13/js/reads/statistics.html +0 -289
  209. data/website/static/1.13/js/state-syncing.html +0 -340
  210. data/website/static/1.13/js/writes/deferred.html +0 -296
  211. data/website/static/1.13/js/writes/dirty-tracking.html +0 -399
  212. data/website/static/1.13/js/writes/index.html +0 -391
  213. data/website/static/1.13/js/writes/nested.html +0 -330
  214. data/website/static/1.13/js/writes/validations.html +0 -272
  215. data/website/static/1.13/quickstart.html +0 -660
  216. data/website/static/1.13/template +0 -161
  217. data/website/static/1.13/tutorial/index.html +0 -250
  218. data/website/static/1.13/tutorial/step_0.html +0 -292
  219. data/website/static/1.13/tutorial/step_1.html +0 -517
  220. data/website/static/1.13/tutorial/step_2.html +0 -481
  221. data/website/static/1.13/tutorial/step_3.html +0 -323
  222. data/website/static/1.13/tutorial/step_4.html +0 -318
  223. data/website/static/1.13/tutorial/step_5.html +0 -265
  224. data/website/static/1.13/tutorial/step_6.html +0 -276
  225. data/website/static/1.13/tutorial/step_7.html +0 -390
  226. data/website/static/1.13/tutorial/step_8.html +0 -316
  227. data/website/static/1.13/tutorial/step_9.html +0 -365
  228. data/website/static/CNAME +0 -1
  229. data/website/static/assets/img/error_payload.png +0 -0
  230. data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
  231. data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
  232. data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
  233. data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
  234. data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
  235. data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
  236. data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
  237. data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
  238. data/website/static/assets/img/meta_total_count.png +0 -0
  239. data/website/static/img/docusaurus-social-card.jpg +0 -0
  240. data/website/static/img/docusaurus.png +0 -0
  241. data/website/static/img/favicon.ico +0 -0
  242. data/website/static/img/logo.png +0 -0
  243. data/website/static/img/logo.svg +0 -1
  244. data/website/static/img/undraw_docusaurus_mountain.svg +0 -171
  245. data/website/static/img/undraw_docusaurus_react.svg +0 -170
  246. data/website/static/img/undraw_docusaurus_tree.svg +0 -40
data/website/static/1.13/tutorial/step_5.html DELETED
@@ -1,265 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
-
4
- <head>
5
- <meta charset="utf-8">
6
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
7
- <meta name="viewport" content="width=device-width, initial-scale=1">
8
- <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet">
9
- <link href="https://fonts.googleapis.com/css?family=Boogaloo" rel="stylesheet">
10
-
11
- <link rel="apple-touch-icon" sizes="180x180" href="/1.13/assets/favicons/apple-touch-icon.png">
12
- <link rel="icon" type="image/png" sizes="32x32" href="/1.13/assets/favicons/favicon-32x32.png">
13
- <link rel="icon" type="image/png" sizes="16x16" href="/1.13/assets/favicons/favicon-16x16.png">
14
- <link rel="manifest" href="/1.13/assets/favicons/site.webmanifest">
15
- <link rel="mask-icon" href="/1.13/assets/favicons/safari-pinned-tab.svg" color="#F86DA7">
16
- <link rel="shortcut icon" href="/1.13/assets/favicons/favicon.ico">
17
- <meta name="msapplication-TileColor" content="#F86DA7">
18
- <meta name="msapplication-config" content="/1.13/assets/favicons/browserconfig.xml">
19
- <meta name="theme-color" content="#F86DA7">
20
-
21
- <title>Graphiti</title>
22
- <meta name="description" content="Stylish Graph APIs">
23
-
24
- <link rel="stylesheet" href="/1.13/assets/main.css?ref=wh4t3v45">
25
- <link rel="alternate" type="application/rss+xml" title="Graphiti" href="/1.13/feed.xml">
26
-
27
- <!-- Global site tag (gtag.js) - Google Analytics -->
28
- <script async src="https://www.googletagmanager.com/gtag/js?id=UA-127904727-1"></script>
29
- <script>
30
- window.dataLayer = window.dataLayer || [];
31
- function gtag(){dataLayer.push(arguments);}
32
- gtag('js', new Date());
33
-
34
- gtag('config', 'UA-127904727-1');
35
- </script>
36
-
37
- <!-- javascript -->
38
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
39
- <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
40
-
41
-
42
- </head>
43
-
44
-
45
- <body>
46
- <main class="page-content" aria-label="Content">
47
- <div class="wrapper">
48
- <header class="navbar navbar-inverse normal" role="banner">
49
- <div class="container">
50
- <div class="navbar-header">
51
- <a href="/1.13/1.13" class="navbar-brand">
52
- <img alt="logo" src="/1.13/assets/img/logo.png">
53
- </a>
54
- </div>
55
- <nav class="" role="navigation">
56
- <ul class="nav navbar-nav nav-links">
57
- <li>
58
- <a class="quickstart nav-link" href="/1.13/quickstart">Quickstart</a>
59
- </li>
60
- <li>
61
- <a class="guides nav-link" href="/1.13/guides">Guides</a>
62
- </li>
63
- <li>
64
- <a class="tutorial nav-link" href="/1.13/tutorial">Tutorial</a>
65
- </li>
66
- <li>
67
- <a class="spraypaint nav-link" href="/1.13/js">Spraypaint</a>
68
- </li>
69
- </ul>
70
- <ul class="nav gh navbar-nav navbar-right visible-lg visible-md">
71
- <li>
72
- <span class="star">⭐</span>
73
- <a href="https://github.com/graphiti-api/graphiti">
74
- <img alt="github-star" style="margin-right: 65px;margin-top: -20px" src="/1.13/assets/img/gh.png">
75
- </a>
76
- </li>
77
- </ul>
78
- </nav>
79
- </div>
80
- </header>
81
-
82
- <div class="container">
83
- <div class="toc col-md-3">
84
- <h1 id="tutorial">Tutorial</h1>
85
-
86
- <ul>
87
- <li><a href="/1.13/tutorial/step_0">Step 0: Bootstrapping</a></li>
88
- <li><a href="/1.13/tutorial/step_1">Step 1: Initial Resource</a></li>
89
- <li><a href="/1.13/tutorial/step_2">Step 2: Has Many</a></li>
90
- <li><a href="/1.13/tutorial/step_3">Step 3: Belongs To</a></li>
91
- <li><a href="/1.13/tutorial/step_4">Step 4: Customizing Queries</a></li>
92
- <li><a href="/1.13/tutorial/step_5">Step 5: Has One</a></li>
93
- <li><a href="/1.13/tutorial/step_6">Step 6: Customizing Writes</a></li>
94
- <li><a href="/1.13/tutorial/step_7">Step 7: Many-to-Many</a></li>
95
- <li><a href="/1.13/tutorial/step_8">Step 8: Polymorphic Relationships</a></li>
96
- <li><a href="/1.13/tutorial/step_9">Step 9: Polymorphic Resources</a></li>
97
- </ul>
98
- </div>
99
-
100
- <div class="col-md-8">
101
-
102
- <h3 id="step-5-has-one">Step 5: Has One</h3>
103
-
104
- <blockquote>
105
- <p><a href="https://github.com/graphiti-api/employee_directory/compare/step_4_customizations...step_5_has_one">View the Diff</a></p>
106
- </blockquote>
107
-
108
- <p>In the last step, we introduced the concept of a “current position” to
109
- the model layer. Let’s now expose that relationship to the API.</p>
110
-
111
- <h3 id="the-rails-stuff-">The Rails Stuff 🚂</h3>
112
-
113
- <p>We already defined a <code class="language-plaintext highlighter-rouge">Position.current</code> scope that we’ll re-use -
114
- let’s just make a small tweak to support the opposite use case as
115
- well:</p>
116
-
117
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">scope</span> <span class="ss">:current</span><span class="p">,</span> <span class="o">-&gt;</span><span class="p">(</span><span class="n">bool</span><span class="p">)</span> <span class="p">{</span>
118
- <span class="n">clause</span> <span class="o">=</span> <span class="p">{</span> <span class="ss">historical_index: </span><span class="mi">1</span> <span class="p">}</span>
119
- <span class="n">bool</span> <span class="p">?</span> <span class="n">where</span><span class="p">(</span><span class="n">clause</span><span class="p">)</span> <span class="p">:</span> <span class="n">where</span><span class="p">.</span><span class="nf">not</span><span class="p">(</span><span class="n">clause</span><span class="p">)</span>
120
- <span class="p">}</span></code></pre></figure>
121
-
122
- <h3 id="the-graphiti-stuff-">The Graphiti Stuff 🎨</h3>
123
-
124
- <p>You might already have an idea how this might work from the prior step</p>
125
- <ul>
126
- <li>we’ll use the <code class="language-plaintext highlighter-rouge">params</code> block to customize the relationship. The
127
- <code class="language-plaintext highlighter-rouge">has_one</code> macro ensures the result is treated as a single object and
128
- not an array.</li>
129
- </ul>
130
-
131
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/resources/employee_resource.rb</span>
132
- <span class="n">has_one</span> <span class="ss">:current_position</span><span class="p">,</span> <span class="ss">resource: </span><span class="no">PositionResource</span> <span class="k">do</span>
133
- <span class="n">params</span> <span class="k">do</span> <span class="o">|</span><span class="nb">hash</span><span class="o">|</span>
134
- <span class="nb">hash</span><span class="p">[</span><span class="ss">:filter</span><span class="p">][</span><span class="ss">:current</span><span class="p">]</span> <span class="o">=</span> <span class="kp">true</span>
135
- <span class="k">end</span>
136
- <span class="k">end</span></code></pre></figure>
137
-
138
- <p>Which means we’ll have to implement that filter - re-using the
139
- ActiveRecord scope we already defined!</p>
140
-
141
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">filter</span> <span class="ss">:current</span><span class="p">,</span> <span class="ss">:boolean</span> <span class="k">do</span>
142
- <span class="n">eq</span> <span class="p">{</span> <span class="o">|</span><span class="n">scope</span><span class="p">,</span> <span class="n">value</span><span class="o">|</span> <span class="n">scope</span><span class="p">.</span><span class="nf">current</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="p">}</span>
143
- <span class="k">end</span></code></pre></figure>
144
-
145
- <h4 id="digging-deeper-">Digging Deeper 🧐</h4>
146
-
147
- <p>In this example, we’re able to return only a single record because we
148
- have a <code class="language-plaintext highlighter-rouge">historical_index</code> column. If this column didn’t exist - maybe
149
- we’re just ordering on <code class="language-plaintext highlighter-rouge">created_at</code> and taking the first record - we’d
150
- have a problem. What if we were loading 20 employees and wanted the
151
- <code class="language-plaintext highlighter-rouge">current_position</code> of each - what SQL would limit the resultset
152
- correctly?</p>
153
-
154
- <p>We call this a <a href="/1.13/guides/concepts/resources#faux-has-one">faux has_one</a> and there’s nothing easily done here. Graphiti will ensure only one record
155
- is returned by the API, but the query will take longer and loading extra
156
- records will eat memory. If there are lots of records in the
157
- association, look into adding a column like <code class="language-plaintext highlighter-rouge">historical_index</code>.</p>
158
-
159
- </div>
160
-
161
- <div class="clearfix">
162
- <h2 id="next">
163
- <a href="/1.13/tutorial/step_6">
164
- NEXT -
165
- <small>Step 6: Customizing Writes</small>
166
- &raquo;
167
- </a>
168
- </h2>
169
- </div>
170
-
171
- </div>
172
- </div>
173
- </main>
174
- <div class="main-footer main-footer--dark">
175
- <div class="container">
176
- <div class="row">
177
- <div class="col-sm-4 menu">
178
- <h3>Overview</h3>
179
- <ul>
180
- <li>
181
- <a href="/1.13/quickstart">Quickstart</a>
182
- </li>
183
- <li>
184
- <a href="/1.13/tutorial">Tutorial</a>
185
- </li>
186
- <li>
187
- <a href="/1.13/guides">Guides</a>
188
- </li>
189
- </ul>
190
- </div>
191
- <div class="col-sm-4 menu">
192
- <h3>Contact</h3>
193
- <ul>
194
- <li>
195
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
196
- </li>
197
- <li>
198
- <a href="mailto:richmolj@gmail.com">Email</a>
199
- </li>
200
- </ul>
201
- </div>
202
- <div class="col-sm-4 menu">
203
- <h3>Related</h3>
204
- <ul>
205
- <li>
206
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
207
- </li>
208
- <li>
209
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
210
- </li>
211
- <li>
212
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
213
- </li>
214
- </ul>
215
- </div>
216
- </div>
217
- </div>
218
- </div>
219
-
220
- <script type="text/javascript">
221
- $(function () {
222
-
223
- var flipTabs = function() {
224
- var isTS = true;
225
- if (localStorage.getItem('js-lang') === 'javascript') {
226
- isTS = false;
227
- }
228
-
229
- $('.code-tabs').each(function(index, el) {
230
- if (isTS) {
231
- console.log('hiding js');
232
- $($(el).children()[1]).hide();
233
- $($(el).children()[0]).show();
234
- } else {
235
- console.log('hiding ts');
236
- $($(el).children()[0]).hide();
237
- $($(el).children()[1]).show();
238
- }
239
- });
240
-
241
- if (isTS) {
242
- $('.tab.typescript').addClass('active');
243
- $('.tab.javascript').removeClass('active');
244
- } else {
245
- $('.tab.typescript').removeClass('active');
246
- $('.tab.javascript').addClass('active');
247
- }
248
- }
249
-
250
- $('.tab').click(function() {
251
- if ($(this).hasClass('typescript')) {
252
- localStorage.setItem('js-lang', 'typescript');
253
- } else {
254
- localStorage.setItem('js-lang', 'javascript');
255
- }
256
-
257
- flipTabs();
258
- });
259
-
260
- flipTabs();
261
- })
262
- </script>
263
-
264
- </body>
265
- </html>
data/website/static/1.13/tutorial/step_6.html DELETED
@@ -1,276 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
-
4
- <head>
5
- <meta charset="utf-8">
6
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
7
- <meta name="viewport" content="width=device-width, initial-scale=1">
8
- <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet">
9
- <link href="https://fonts.googleapis.com/css?family=Boogaloo" rel="stylesheet">
10
-
11
- <link rel="apple-touch-icon" sizes="180x180" href="/1.13/assets/favicons/apple-touch-icon.png">
12
- <link rel="icon" type="image/png" sizes="32x32" href="/1.13/assets/favicons/favicon-32x32.png">
13
- <link rel="icon" type="image/png" sizes="16x16" href="/1.13/assets/favicons/favicon-16x16.png">
14
- <link rel="manifest" href="/1.13/assets/favicons/site.webmanifest">
15
- <link rel="mask-icon" href="/1.13/assets/favicons/safari-pinned-tab.svg" color="#F86DA7">
16
- <link rel="shortcut icon" href="/1.13/assets/favicons/favicon.ico">
17
- <meta name="msapplication-TileColor" content="#F86DA7">
18
- <meta name="msapplication-config" content="/1.13/assets/favicons/browserconfig.xml">
19
- <meta name="theme-color" content="#F86DA7">
20
-
21
- <title>Graphiti</title>
22
- <meta name="description" content="Stylish Graph APIs">
23
-
24
- <link rel="stylesheet" href="/1.13/assets/main.css?ref=wh4t3v45">
25
- <link rel="alternate" type="application/rss+xml" title="Graphiti" href="/1.13/feed.xml">
26
-
27
- <!-- Global site tag (gtag.js) - Google Analytics -->
28
- <script async src="https://www.googletagmanager.com/gtag/js?id=UA-127904727-1"></script>
29
- <script>
30
- window.dataLayer = window.dataLayer || [];
31
- function gtag(){dataLayer.push(arguments);}
32
- gtag('js', new Date());
33
-
34
- gtag('config', 'UA-127904727-1');
35
- </script>
36
-
37
- <!-- javascript -->
38
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
39
- <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
40
-
41
-
42
- </head>
43
-
44
-
45
- <body>
46
- <main class="page-content" aria-label="Content">
47
- <div class="wrapper">
48
- <header class="navbar navbar-inverse normal" role="banner">
49
- <div class="container">
50
- <div class="navbar-header">
51
- <a href="/1.13/1.13" class="navbar-brand">
52
- <img alt="logo" src="/1.13/assets/img/logo.png">
53
- </a>
54
- </div>
55
- <nav class="" role="navigation">
56
- <ul class="nav navbar-nav nav-links">
57
- <li>
58
- <a class="quickstart nav-link" href="/1.13/quickstart">Quickstart</a>
59
- </li>
60
- <li>
61
- <a class="guides nav-link" href="/1.13/guides">Guides</a>
62
- </li>
63
- <li>
64
- <a class="tutorial nav-link" href="/1.13/tutorial">Tutorial</a>
65
- </li>
66
- <li>
67
- <a class="spraypaint nav-link" href="/1.13/js">Spraypaint</a>
68
- </li>
69
- </ul>
70
- <ul class="nav gh navbar-nav navbar-right visible-lg visible-md">
71
- <li>
72
- <span class="star">⭐</span>
73
- <a href="https://github.com/graphiti-api/graphiti">
74
- <img alt="github-star" style="margin-right: 65px;margin-top: -20px" src="/1.13/assets/img/gh.png">
75
- </a>
76
- </li>
77
- </ul>
78
- </nav>
79
- </div>
80
- </header>
81
-
82
- <div class="container">
83
- <div class="toc col-md-3">
84
- <h1 id="tutorial">Tutorial</h1>
85
-
86
- <ul>
87
- <li><a href="/1.13/tutorial/step_0">Step 0: Bootstrapping</a></li>
88
- <li><a href="/1.13/tutorial/step_1">Step 1: Initial Resource</a></li>
89
- <li><a href="/1.13/tutorial/step_2">Step 2: Has Many</a></li>
90
- <li><a href="/1.13/tutorial/step_3">Step 3: Belongs To</a></li>
91
- <li><a href="/1.13/tutorial/step_4">Step 4: Customizing Queries</a></li>
92
- <li><a href="/1.13/tutorial/step_5">Step 5: Has One</a></li>
93
- <li><a href="/1.13/tutorial/step_6">Step 6: Customizing Writes</a></li>
94
- <li><a href="/1.13/tutorial/step_7">Step 7: Many-to-Many</a></li>
95
- <li><a href="/1.13/tutorial/step_8">Step 8: Polymorphic Relationships</a></li>
96
- <li><a href="/1.13/tutorial/step_9">Step 9: Polymorphic Resources</a></li>
97
- </ul>
98
- </div>
99
-
100
- <div class="col-md-8">
101
-
102
- <h3 id="step-6-customizing-writes">Step 6: Customizing Writes</h3>
103
-
104
- <blockquote>
105
- <p><a href="https://github.com/graphiti-api/employee_directory/compare/step_5_has_one...step_6_write_customization">View the Diff</a></p>
106
- </blockquote>
107
-
108
- <p>When we ran the generators (and created a blank Resource class), we got the ability to create, update, and destroy resources for free. You can turn off this behavior with <code class="language-plaintext highlighter-rouge">self.read_only = true</code>. Or for relationships: <code class="language-plaintext highlighter-rouge">has_many :positions, writable: false</code>.</p>
109
-
110
- <p>But in RESTful APIs, it’s super common for persistence operations to
111
- have side effects - that’s how we avoid extraneous verbs and
112
- inconsistent patterns.</p>
113
-
114
- <p>In a prior step, we updated <code class="language-plaintext highlighter-rouge">position</code> Factory to automatically reorder
115
- the <code class="language-plaintext highlighter-rouge">historical_index</code>: when a new record comes in, all the prior
116
- values need to change. This step will show how to add that behavior to
117
- our API, using hooks that work for a variety of scenarios: sending
118
- emails, checking authorization roles, queuing delayed jobs, and more.</p>
119
-
120
- <h3 id="the-rails-stuff-">The Rails Stuff 🚂</h3>
121
-
122
- <p>Previously, we put the logic that re-ordered the <code class="language-plaintext highlighter-rouge">historical_index</code>
123
- column in the <code class="language-plaintext highlighter-rouge">position</code> factory. Let’s move that to the model so our
124
- tests and API can share the same logic:</p>
125
-
126
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/models/position.rb</span>
127
- <span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">reorder!</span><span class="p">(</span><span class="n">employee_id</span><span class="p">)</span>
128
- <span class="n">scope</span> <span class="o">=</span> <span class="no">Position</span><span class="p">.</span><span class="nf">where</span><span class="p">(</span><span class="ss">employee_id: </span><span class="n">employee_id</span><span class="p">).</span><span class="nf">order</span><span class="p">(</span><span class="ss">created_at: :desc</span><span class="p">)</span>
129
- <span class="n">scope</span><span class="p">.</span><span class="nf">each_with_index</span> <span class="k">do</span> <span class="o">|</span><span class="nb">p</span><span class="p">,</span> <span class="n">index</span><span class="o">|</span>
130
- <span class="nb">p</span><span class="p">.</span><span class="nf">update_attribute</span><span class="p">(</span><span class="ss">:historical_index</span><span class="p">,</span> <span class="n">index</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
131
- <span class="k">end</span>
132
- <span class="k">end</span></code></pre></figure>
133
-
134
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># spec/factories/positions.rb</span>
135
- <span class="c1"># ... code ...</span>
136
- <span class="n">after</span><span class="p">(</span><span class="ss">:create</span><span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="n">position</span><span class="o">|</span>
137
- <span class="k">unless</span> <span class="n">position</span><span class="p">.</span><span class="nf">historical_index</span>
138
- <span class="no">Position</span><span class="p">.</span><span class="nf">reorder!</span><span class="p">(</span><span class="n">position</span><span class="p">.</span><span class="nf">employee</span><span class="p">.</span><span class="nf">id</span><span class="p">)</span>
139
- <span class="k">end</span>
140
- <span class="k">end</span></code></pre></figure>
141
-
142
- <h3 id="the-graphiti-stuff-">The Graphiti Stuff 🎨</h3>
143
-
144
- <p>All Graphiti updates happen within a transaction. We want to insert our
145
- code right before that transaction closes - after the graph of objects
146
- has been persisted and validations have passed. To do that, we’ll use
147
- the <code class="language-plaintext highlighter-rouge">before_commit</code> hook:</p>
148
-
149
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">before_commit</span> <span class="ss">only: </span><span class="p">[</span><span class="ss">:create</span><span class="p">,</span> <span class="ss">:destroy</span><span class="p">]</span> <span class="k">do</span> <span class="o">|</span><span class="n">position</span><span class="o">|</span>
150
- <span class="no">Position</span><span class="p">.</span><span class="nf">reorder!</span><span class="p">(</span><span class="n">position</span><span class="p">.</span><span class="nf">employee_id</span><span class="p">)</span>
151
- <span class="k">end</span></code></pre></figure>
152
-
153
- <p>Again, note that the <code class="language-plaintext highlighter-rouge">Position.reorder!</code> code existed independent of our
154
- API, and was re-used in our factory.</p>
155
-
156
- <h4 id="digging-deeper-">Digging Deeper 🧐</h4>
157
-
158
- <p>Resources come with <a href="/1.13/guides/concepts/resources#persistence-lifecycle-hooks">Lifecycle Hooks</a>, similar to ActiveRecord <a href="https://guides.rubyonrails.org/active_record_callbacks.html">Callbacks</a>.</p>
159
-
160
- <p>Those callbacks have gotten a bad reputation. This is because your Model
161
- can be - is supposed to be - used in a variety of contexts across your
162
- application. Some of those contexts will want a given callback to fire,
163
- others will not, and accomodating the conditionals gets hairy. This is
164
- why many developers move that functionality into <a href="https://engineering.gusto.com/the-rails-callbacks-best-practices-used-at-gusto/">Service Objects</a>.</p>
165
-
166
- <p>But Resource callbacks don’t have the same problem - they only fire in
167
- the context of your API, and can be associated to a single endpoint. You
168
- can still use Service Objects if you’d like; Graphiti callbacks simply wire them up.</p>
169
-
170
- </div>
171
-
172
- <div class="clearfix">
173
- <h2 id="next">
174
- <a href="/1.13/tutorial/step_7">
175
- NEXT -
176
- <small>Step 7: Many to Many</small>
177
- &raquo;
178
- </a>
179
- </h2>
180
- </div>
181
-
182
- </div>
183
- </div>
184
- </main>
185
- <div class="main-footer main-footer--dark">
186
- <div class="container">
187
- <div class="row">
188
- <div class="col-sm-4 menu">
189
- <h3>Overview</h3>
190
- <ul>
191
- <li>
192
- <a href="/1.13/quickstart">Quickstart</a>
193
- </li>
194
- <li>
195
- <a href="/1.13/tutorial">Tutorial</a>
196
- </li>
197
- <li>
198
- <a href="/1.13/guides">Guides</a>
199
- </li>
200
- </ul>
201
- </div>
202
- <div class="col-sm-4 menu">
203
- <h3>Contact</h3>
204
- <ul>
205
- <li>
206
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
207
- </li>
208
- <li>
209
- <a href="mailto:richmolj@gmail.com">Email</a>
210
- </li>
211
- </ul>
212
- </div>
213
- <div class="col-sm-4 menu">
214
- <h3>Related</h3>
215
- <ul>
216
- <li>
217
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
218
- </li>
219
- <li>
220
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
221
- </li>
222
- <li>
223
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
224
- </li>
225
- </ul>
226
- </div>
227
- </div>
228
- </div>
229
- </div>
230
-
231
- <script type="text/javascript">
232
- $(function () {
233
-
234
- var flipTabs = function() {
235
- var isTS = true;
236
- if (localStorage.getItem('js-lang') === 'javascript') {
237
- isTS = false;
238
- }
239
-
240
- $('.code-tabs').each(function(index, el) {
241
- if (isTS) {
242
- console.log('hiding js');
243
- $($(el).children()[1]).hide();
244
- $($(el).children()[0]).show();
245
- } else {
246
- console.log('hiding ts');
247
- $($(el).children()[0]).hide();
248
- $($(el).children()[1]).show();
249
- }
250
- });
251
-
252
- if (isTS) {
253
- $('.tab.typescript').addClass('active');
254
- $('.tab.javascript').removeClass('active');
255
- } else {
256
- $('.tab.typescript').removeClass('active');
257
- $('.tab.javascript').addClass('active');
258
- }
259
- }
260
-
261
- $('.tab').click(function() {
262
- if ($(this).hasClass('typescript')) {
263
- localStorage.setItem('js-lang', 'typescript');
264
- } else {
265
- localStorage.setItem('js-lang', 'javascript');
266
- }
267
-
268
- flipTabs();
269
- });
270
-
271
- flipTabs();
272
- })
273
- </script>
274
-
275
- </body>
276
- </html>