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
@@ -1,481 +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
- <h2 id="step-2-has-many">Step 2: Has Many</h2>
103
-
104
- <blockquote>
105
- <p><a href="https://github.com/graphiti-api/employee_directory/compare/step_1_employees...step_2_positions">View the Code</a></p>
106
- </blockquote>
107
-
108
- <p>We’ll be adding the database table <code class="language-plaintext highlighter-rouge">positions</code>:</p>
109
-
110
- <table class="table table-small text-center">
111
- <thead>
112
- <tr>
113
- <th class="text-center">id</th>
114
- <th class="text-center">employee_id</th>
115
- <th class="text-center">title</th>
116
- <th class="text-center">active</th>
117
- <th class="text-center">historical_index</th>
118
- <th class="text-center">created_at</th>
119
- <th class="text-center">updated_at</th>
120
- </tr>
121
- </thead>
122
- <tbody>
123
- <tr>
124
- <td>1</td>
125
- <td>900</td>
126
- <td>Engineer</td>
127
- <td>true</td>
128
- <td>1</td>
129
- <td>2018-09-04</td>
130
- <td>2018-09-04</td>
131
- </tr>
132
- <tr>
133
- <td>2</td>
134
- <td>900</td>
135
- <td>Intern</td>
136
- <td>true</td>
137
- <td>2</td>
138
- <td>2018-09-04</td>
139
- <td>2018-09-04</td>
140
- </tr>
141
- <tr>
142
- <td>3</td>
143
- <td>800</td>
144
- <td>Manager</td>
145
- <td>true</td>
146
- <td>1</td>
147
- <td>2018-09-04</td>
148
- <td>2018-09-04</td>
149
- </tr>
150
- </tbody>
151
- </table>
152
-
153
- <p>Because this table tracks all historical positions, we have the
154
- <code class="language-plaintext highlighter-rouge">historical_index</code> column. This tells the order the employee moved
155
- through each position, where <code class="language-plaintext highlighter-rouge">1</code> is most recent.</p>
156
-
157
- <h3 id="the-rails-stuff-">The Rails Stuff 🚂</h3>
158
-
159
- <p>Generate the <code class="language-plaintext highlighter-rouge">Position</code> model:</p>
160
-
161
- <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>bin/rails g model Position title:string active:boolean historical_index:integer employee:belongs_to
162
- <span class="nv">$ </span>bin/rails db:migrate</code></pre></figure>
163
-
164
- <p>Update the <code class="language-plaintext highlighter-rouge">Employee</code> model with the association, too:</p>
165
-
166
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/models/employee.rb</span>
167
- <span class="n">has_many</span> <span class="ss">:positions</span></code></pre></figure>
168
-
169
- <p>And update our seed data:</p>
170
-
171
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># db/seeds.rb</span>
172
- <span class="p">[</span><span class="no">Employee</span><span class="p">,</span> <span class="no">Position</span><span class="p">].</span><span class="nf">each</span><span class="p">(</span><span class="o">&amp;</span><span class="ss">:delete_all</span><span class="p">)</span>
173
-
174
- <span class="mi">100</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
175
- <span class="n">employee</span> <span class="o">=</span> <span class="no">Employee</span><span class="p">.</span><span class="nf">create!</span> <span class="ss">first_name: </span><span class="no">Faker</span><span class="o">::</span><span class="no">Name</span><span class="p">.</span><span class="nf">first_name</span><span class="p">,</span>
176
- <span class="ss">last_name: </span><span class="no">Faker</span><span class="o">::</span><span class="no">Name</span><span class="p">.</span><span class="nf">last_name</span><span class="p">,</span>
177
- <span class="ss">age: </span><span class="nb">rand</span><span class="p">(</span><span class="mi">20</span><span class="o">..</span><span class="mi">80</span><span class="p">)</span>
178
-
179
- <span class="p">(</span><span class="mi">1</span><span class="o">..</span><span class="mi">2</span><span class="p">).</span><span class="nf">each</span> <span class="k">do</span> <span class="o">|</span><span class="n">i</span><span class="o">|</span>
180
- <span class="n">employee</span><span class="p">.</span><span class="nf">positions</span><span class="p">.</span><span class="nf">create!</span> <span class="ss">title: </span><span class="no">Faker</span><span class="o">::</span><span class="no">Job</span><span class="p">.</span><span class="nf">title</span><span class="p">,</span>
181
- <span class="ss">historical_index: </span><span class="n">i</span><span class="p">,</span>
182
- <span class="ss">active: </span><span class="n">i</span> <span class="o">==</span> <span class="mi">1</span>
183
- <span class="k">end</span>
184
- <span class="k">end</span></code></pre></figure>
185
-
186
- <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>bin/rails db:seed</code></pre></figure>
187
-
188
- <h3 id="the-graphiti-stuff-">The Graphiti Stuff 🎨</h3>
189
-
190
- <p>Let’s start by running the same command as before to create
191
- <code class="language-plaintext highlighter-rouge">PositionResource</code>:</p>
192
-
193
- <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>bin/rails g graphiti:resource Position title:string active:boolean</code></pre></figure>
194
-
195
- <p>We’ll need to add the association, just like ActiveRecord:</p>
196
-
197
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/resources/employee_resource.rb</span>
198
- <span class="n">has_many</span> <span class="ss">:positions</span></code></pre></figure>
199
-
200
- <p>…and a corresponding filter:</p>
201
-
202
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/resources/position_resource.rb</span>
203
- <span class="n">filter</span> <span class="ss">:employee_id</span><span class="p">,</span> <span class="ss">:integer</span></code></pre></figure>
204
-
205
- <p>If you visit <code class="language-plaintext highlighter-rouge">/api/v1/employees</code>, you’ll see a number of HTTP
206
- <a href="/1.13/guides/concepts/links">Links</a>
207
- that allow lazy-loading positions. Or, if you visit
208
- <code class="language-plaintext highlighter-rouge">/api/v1/employees?include=positions</code>, you’ll load the employees and
209
- positions in a single request. We’ll dig a bit deeper into this logic
210
- in the section below.</p>
211
-
212
- <p>Before we get there, let’s revisit the <code class="language-plaintext highlighter-rouge">historical_index</code> column. For now, let’s
213
- treat this as an implementation detail that the API should not expose -
214
- let’s say we want to support sorting on this attribute but nothing else:</p>
215
-
216
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">attribute</span> <span class="ss">:historical_index</span><span class="p">,</span> <span class="ss">:integer</span><span class="p">,</span> <span class="ss">only: </span><span class="p">[</span><span class="ss">:sortable</span><span class="p">]</span></code></pre></figure>
217
-
218
- <p>We’re almost done, but if you run your tests you’ll see two outstanding
219
- errors. This is because <a href="https://blog.bigbinary.com/2016/02/15/rails-5-makes-belong-to-association-required-by-default.html">Rails 5 belongs_to associations are required by
220
- default</a>. We can’t save a <code class="language-plaintext highlighter-rouge">Position</code> without its corresponding <code class="language-plaintext highlighter-rouge">Employee</code>.</p>
221
-
222
- <p>We can solve this in three ways:</p>
223
-
224
- <ul>
225
- <li>Turn this off globally, with <a href="https://edgeguides.rubyonrails.org/configuring.html#configuring-active-record">config.active_record.belongs_to_required_by_default</a>. You may want to do this in test-mode only.</li>
226
- <li>Turn this off for the specific association: <code class="language-plaintext highlighter-rouge">belongs_to :employee,
227
- optional: true</code>.</li>
228
- <li>Associate an <code class="language-plaintext highlighter-rouge">Employee</code> as part of the API request.</li>
229
- </ul>
230
-
231
- <p>We’ll take for the last option. Look at
232
- <code class="language-plaintext highlighter-rouge">spec/resources/position/writes_spec.rb</code>:</p>
233
-
234
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="no">RSpec</span><span class="p">.</span><span class="nf">describe</span> <span class="no">PositionResource</span><span class="p">,</span> <span class="ss">type: :resource</span> <span class="k">do</span>
235
- <span class="n">describe</span> <span class="s1">'creating'</span> <span class="k">do</span>
236
- <span class="n">let</span><span class="p">(</span><span class="ss">:payload</span><span class="p">)</span> <span class="k">do</span>
237
- <span class="p">{</span>
238
- <span class="ss">data: </span><span class="p">{</span>
239
- <span class="ss">type: </span><span class="s1">'positions'</span><span class="p">,</span>
240
- <span class="ss">attributes: </span><span class="p">{</span> <span class="p">}</span>
241
- <span class="p">}</span>
242
- <span class="p">}</span>
243
- <span class="k">end</span>
244
-
245
- <span class="n">let</span><span class="p">(</span><span class="ss">:instance</span><span class="p">)</span> <span class="k">do</span>
246
- <span class="no">PositionResource</span><span class="p">.</span><span class="nf">build</span><span class="p">(</span><span class="n">payload</span><span class="p">)</span>
247
- <span class="k">end</span>
248
-
249
- <span class="n">it</span> <span class="s1">'works'</span> <span class="k">do</span>
250
- <span class="n">expect</span> <span class="p">{</span>
251
- <span class="n">expect</span><span class="p">(</span><span class="n">instance</span><span class="p">.</span><span class="nf">save</span><span class="p">).</span><span class="nf">to</span> <span class="n">eq</span><span class="p">(</span><span class="kp">true</span><span class="p">)</span>
252
- <span class="p">}.</span><span class="nf">to</span> <span class="n">change</span> <span class="p">{</span> <span class="no">Position</span><span class="p">.</span><span class="nf">count</span> <span class="p">}.</span><span class="nf">by</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
253
- <span class="k">end</span>
254
- <span class="k">end</span>
255
- <span class="k">end</span></code></pre></figure>
256
-
257
- <p>When running our tests, let’s make sure the <code class="language-plaintext highlighter-rouge">historical_index</code> column
258
- reflects the order we created the positions. This code recalculates
259
- everything after a record is saved:</p>
260
-
261
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># spec/factories/position.rb</span>
262
- <span class="no">FactoryBot</span><span class="p">.</span><span class="nf">define</span> <span class="k">do</span>
263
- <span class="n">factory</span> <span class="ss">:position</span> <span class="k">do</span>
264
- <span class="n">employee</span>
265
-
266
- <span class="n">title</span> <span class="p">{</span> <span class="no">Faker</span><span class="o">::</span><span class="no">Job</span><span class="p">.</span><span class="nf">title</span> <span class="p">}</span>
267
-
268
- <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>
269
- <span class="k">unless</span> <span class="n">position</span><span class="p">.</span><span class="nf">historical_index</span>
270
- <span class="n">scope</span> <span class="o">=</span> <span class="no">Position</span>
271
- <span class="p">.</span><span class="nf">where</span><span class="p">(</span><span class="ss">employee_id: </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>
272
- <span class="p">.</span><span class="nf">order</span><span class="p">(</span><span class="ss">created_at: :desc</span><span class="p">)</span>
273
- <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>
274
- <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>
275
- <span class="k">end</span>
276
- <span class="k">end</span>
277
- <span class="k">end</span>
278
- <span class="k">end</span>
279
- <span class="k">end</span></code></pre></figure>
280
-
281
- <p>Let’s associate an <code class="language-plaintext highlighter-rouge">Employee</code>. Start by seeding the data:</p>
282
-
283
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">let!</span><span class="p">(</span><span class="ss">:employee</span><span class="p">)</span> <span class="p">{</span> <span class="n">create</span><span class="p">(</span><span class="ss">:employee</span><span class="p">)</span> <span class="p">}</span></code></pre></figure>
284
-
285
- <p>And associate via <code class="language-plaintext highlighter-rouge">relationships</code>:</p>
286
-
287
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">let</span><span class="p">(</span><span class="ss">:payload</span><span class="p">)</span> <span class="k">do</span>
288
- <span class="p">{</span>
289
- <span class="ss">data: </span><span class="p">{</span>
290
- <span class="ss">type: </span><span class="s1">'positions'</span><span class="p">,</span>
291
- <span class="ss">attributes: </span><span class="p">{</span> <span class="p">},</span>
292
- <span class="ss">relationships: </span><span class="p">{</span>
293
- <span class="ss">employee: </span><span class="p">{</span>
294
- <span class="ss">data: </span><span class="p">{</span>
295
- <span class="ss">id: </span><span class="n">employee</span><span class="p">.</span><span class="nf">id</span><span class="p">.</span><span class="nf">to_s</span><span class="p">,</span>
296
- <span class="ss">type: </span><span class="s1">'employees'</span>
297
- <span class="p">}</span>
298
- <span class="p">}</span>
299
- <span class="p">}</span>
300
- <span class="p">}</span>
301
- <span class="p">}</span>
302
- <span class="k">end</span></code></pre></figure>
303
-
304
- <p>To ensure the <code class="language-plaintext highlighter-rouge">PositionResource</code> will process this relationship, the
305
- last step is to add it:</p>
306
-
307
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/resources/position_resource.rb</span>
308
- <span class="n">belongs_to</span> <span class="ss">:employee</span></code></pre></figure>
309
-
310
- <p>This will associate the <code class="language-plaintext highlighter-rouge">Position</code> to the <code class="language-plaintext highlighter-rouge">Employee</code> as part of the
311
- creation process. The test should now pass - make the same change to
312
- <code class="language-plaintext highlighter-rouge">spec/api/v1/positions/create_spec.rb</code> to get a fully-passing test
313
- suite.</p>
314
-
315
- <h4 id="digging-deeper-">Digging Deeper 🧐</h4>
316
-
317
- <p>Why did we need the <code class="language-plaintext highlighter-rouge">employee_id</code> filter above? To explain that, let’s dive deeper into the logic connecting Resources.</p>
318
-
319
- <p>If you hit <code class="language-plaintext highlighter-rouge">/api/v1/employees</code>, you’ll see a number of
320
- <a href="/1.13/guides/concepts/links">Links</a> in the
321
- response. These are useful for lazy-loading, but the same logic
322
- applies to eager loading. Let’s take a look at a Link to see how these
323
- Resources connect together:</p>
324
-
325
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="p">{</span>
326
- <span class="o">...</span>
327
- <span class="ss">relationships: </span><span class="p">{</span>
328
- <span class="ss">positions: </span><span class="p">{</span>
329
- <span class="ss">links: </span><span class="p">{</span>
330
- <span class="ss">related: </span><span class="s2">"http://localhost:3000/api/v1/positions?filter[employee_id]=1"</span>
331
- <span class="p">}</span>
332
- <span class="p">}</span>
333
- <span class="p">}</span>
334
- <span class="o">...</span>
335
- <span class="p">}</span></code></pre></figure>
336
-
337
- <p>The salient bit: <code class="language-plaintext highlighter-rouge">/positions?filter[employee_id]=1</code>. In other words,
338
- fetch all Positions for the given Employee id.That means, whether we’re lazy-loading data in separate requests or
339
- eager-loading in a single request, <strong>the same logic fires
340
- under-the-hood</strong>:</p>
341
-
342
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="no">PositionResource</span><span class="p">.</span><span class="nf">all</span><span class="p">({</span>
343
- <span class="ss">filter: </span><span class="p">{</span> <span class="ss">employee_id: </span><span class="mi">1</span> <span class="p">}</span>
344
- <span class="p">})</span></code></pre></figure>
345
-
346
- <p>This means we need <code class="language-plaintext highlighter-rouge">filter :employee_id, :integer</code> to satisfy the query.</p>
347
-
348
- <p>We can customize the logic connecting Resources in a few different
349
- ways. First some simple options:</p>
350
-
351
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_many</span> <span class="ss">:positions</span><span class="p">,</span> <span class="ss">foreign_key: :emp_id</span><span class="p">,</span> <span class="ss">primary_key: :eid</span></code></pre></figure>
352
-
353
- <p>So far so good. The logic, and corresponding Link, both update as you’d
354
- expect (though we’d of course need a corresponding <code class="language-plaintext highlighter-rouge">filter
355
- :emp_id, :integer</code> on <code class="language-plaintext highlighter-rouge">PositionResource</code>).</p>
356
-
357
- <p>Those options are just simple versions of parameter customization.
358
- You can customize parameters connecting Resources with the <code class="language-plaintext highlighter-rouge">params</code> block:</p>
359
-
360
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_many</span> <span class="ss">:positions</span> <span class="k">do</span>
361
- <span class="n">params</span> <span class="k">do</span> <span class="o">|</span><span class="nb">hash</span><span class="p">,</span> <span class="n">employees</span><span class="o">|</span>
362
- <span class="nb">hash</span><span class="p">[</span><span class="ss">:filter</span><span class="p">]</span> <span class="c1"># =&gt; { employee_id: employees.map(&amp;:id) }</span>
363
- <span class="nb">hash</span><span class="p">[</span><span class="ss">:filter</span><span class="p">][</span><span class="ss">:active</span><span class="p">]</span> <span class="o">=</span> <span class="kp">true</span>
364
- <span class="nb">hash</span><span class="p">[</span><span class="ss">:sort</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'-created_at'</span>
365
- <span class="k">end</span>
366
- <span class="k">end</span></code></pre></figure>
367
-
368
- <p>Customizing these params affects the Link as well as the eager-load
369
- logic. Remember the parameters here should reflect the JSON:API
370
- specification, or anything <code class="language-plaintext highlighter-rouge">PositionResource.all</code> accepts.</p>
371
-
372
- <p>These are the most common options, but there’s a bunch more. Check
373
- out the <a href="/1.13/guides/concepts/resources#relationships">Resource Relationships Guide</a> to dig even deeper.</p>
374
-
375
- </div>
376
-
377
- <div class="clearfix">
378
- <h2 id="next">
379
- <a href="/1.13/tutorial/step_3">
380
- NEXT -
381
- <small>Step 3: Belongs To</small>
382
- &raquo;
383
- </a>
384
- </h2>
385
- </div>
386
-
387
- </div>
388
- </div>
389
- </main>
390
- <div class="main-footer main-footer--dark">
391
- <div class="container">
392
- <div class="row">
393
- <div class="col-sm-4 menu">
394
- <h3>Overview</h3>
395
- <ul>
396
- <li>
397
- <a href="/1.13/quickstart">Quickstart</a>
398
- </li>
399
- <li>
400
- <a href="/1.13/tutorial">Tutorial</a>
401
- </li>
402
- <li>
403
- <a href="/1.13/guides">Guides</a>
404
- </li>
405
- </ul>
406
- </div>
407
- <div class="col-sm-4 menu">
408
- <h3>Contact</h3>
409
- <ul>
410
- <li>
411
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
412
- </li>
413
- <li>
414
- <a href="mailto:richmolj@gmail.com">Email</a>
415
- </li>
416
- </ul>
417
- </div>
418
- <div class="col-sm-4 menu">
419
- <h3>Related</h3>
420
- <ul>
421
- <li>
422
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
423
- </li>
424
- <li>
425
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
426
- </li>
427
- <li>
428
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
429
- </li>
430
- </ul>
431
- </div>
432
- </div>
433
- </div>
434
- </div>
435
-
436
- <script type="text/javascript">
437
- $(function () {
438
-
439
- var flipTabs = function() {
440
- var isTS = true;
441
- if (localStorage.getItem('js-lang') === 'javascript') {
442
- isTS = false;
443
- }
444
-
445
- $('.code-tabs').each(function(index, el) {
446
- if (isTS) {
447
- console.log('hiding js');
448
- $($(el).children()[1]).hide();
449
- $($(el).children()[0]).show();
450
- } else {
451
- console.log('hiding ts');
452
- $($(el).children()[0]).hide();
453
- $($(el).children()[1]).show();
454
- }
455
- });
456
-
457
- if (isTS) {
458
- $('.tab.typescript').addClass('active');
459
- $('.tab.javascript').removeClass('active');
460
- } else {
461
- $('.tab.typescript').removeClass('active');
462
- $('.tab.javascript').addClass('active');
463
- }
464
- }
465
-
466
- $('.tab').click(function() {
467
- if ($(this).hasClass('typescript')) {
468
- localStorage.setItem('js-lang', 'typescript');
469
- } else {
470
- localStorage.setItem('js-lang', 'javascript');
471
- }
472
-
473
- flipTabs();
474
- });
475
-
476
- flipTabs();
477
- })
478
- </script>
479
-
480
- </body>
481
- </html>