graphiti 2.0.0.beta.2 → 2.0.0.beta.4

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 (269) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ci.yml +30 -86
  3. data/.github/workflows/docs.yml +60 -0
  4. data/.github/workflows/release.yml +8 -8
  5. data/.gitignore +7 -0
  6. data/.npmrc +9 -0
  7. data/.standard.yml +4 -1
  8. data/Appraisals +33 -32
  9. data/CHANGELOG.md +41 -0
  10. data/README.md +13 -2
  11. data/UPGRADING.md +2 -68
  12. data/docs/concepts/backends-and-models.md +122 -0
  13. data/docs/concepts/endpoints.md +183 -0
  14. data/docs/concepts/links.md +212 -0
  15. data/docs/concepts/overview.md +80 -0
  16. data/docs/concepts/persisting.md +376 -0
  17. data/docs/concepts/relationships.md +527 -0
  18. data/docs/concepts/resources.md +677 -0
  19. data/docs/getting-started/first-api.md +289 -0
  20. data/docs/getting-started/installation.md +185 -0
  21. data/docs/intro.md +307 -0
  22. data/docs/js/authentication.md +63 -0
  23. data/docs/js/ddau.md +20 -0
  24. data/docs/js/extra-params.md +41 -0
  25. data/docs/js/index.md +112 -0
  26. data/docs/js/installation.md +120 -0
  27. data/docs/js/middleware.md +72 -0
  28. data/docs/js/models.md +202 -0
  29. data/docs/js/reads.md +494 -0
  30. data/docs/js/state-syncing.md +100 -0
  31. data/docs/js/writes.md +373 -0
  32. data/docs/reference/vandal.md +63 -0
  33. data/docs/reference/why.md +13 -0
  34. data/docs/topics/authorization.md +155 -0
  35. data/docs/topics/caching.md +55 -0
  36. data/docs/topics/customizing-sideloads.md +156 -0
  37. data/docs/topics/debugging.md +216 -0
  38. data/docs/topics/error-handling.md +210 -0
  39. data/docs/topics/etags.md +46 -0
  40. data/docs/topics/hopping-relationships.md +149 -0
  41. data/docs/topics/json-attributes.md +77 -0
  42. data/docs/topics/openstruct-models.md +50 -0
  43. data/docs/topics/remote-resources.md +291 -0
  44. data/docs/topics/testing.md +894 -0
  45. data/docs/topics/without-activerecord.md +324 -0
  46. data/docs/tutorial/index.md +58 -0
  47. data/docs/tutorial/step_0.md +107 -0
  48. data/docs/tutorial/step_1.md +199 -0
  49. data/docs/tutorial/step_2.md +312 -0
  50. data/docs/tutorial/step_3.md +142 -0
  51. data/docs/tutorial/step_4.md +135 -0
  52. data/docs/tutorial/step_5.md +69 -0
  53. data/docs/tutorial/step_6.md +82 -0
  54. data/docs/tutorial/step_7.md +205 -0
  55. data/docs/tutorial/step_8.md +128 -0
  56. data/docs/tutorial/step_9.md +171 -0
  57. data/docs/upgrading.md +265 -0
  58. data/gemfiles/rails_7_1.gemfile +4 -3
  59. data/gemfiles/{rails_7_2_graphiti_rails.gemfile → rails_7_2.gemfile} +3 -3
  60. data/gemfiles/{rails_8_1_graphiti_rails.gemfile → rails_8_0.gemfile} +3 -3
  61. data/gemfiles/{rails_8_0_graphiti_rails.gemfile → rails_8_1.gemfile} +3 -3
  62. data/graphiti.gemspec +7 -5
  63. data/{deprecated_generators → lib/generators}/graphiti/api_test_generator.rb +7 -1
  64. data/{deprecated_generators → lib/generators}/graphiti/generator_mixin.rb +14 -1
  65. data/{deprecated_generators → lib/generators}/graphiti/install_generator.rb +19 -13
  66. data/{deprecated_generators → lib/generators}/graphiti/resource_generator.rb +43 -6
  67. data/{deprecated_generators → lib/generators}/graphiti/templates/index_request_spec.rb.erb +1 -1
  68. data/{deprecated_generators → lib/generators}/graphiti/templates/resource_reads_spec.rb.erb +6 -6
  69. data/{deprecated_generators → lib/generators}/graphiti/templates/show_request_spec.rb.erb +1 -1
  70. data/lib/graphiti/configuration.rb +2 -2
  71. data/lib/graphiti/error_serializers/conflict_request.rb +19 -0
  72. data/lib/graphiti/error_serializers/deprecated_constants.rb +48 -0
  73. data/lib/graphiti/error_serializers/invalid_request.rb +56 -0
  74. data/lib/graphiti/error_serializers/validation.rb +143 -0
  75. data/lib/graphiti/errors.rb +4 -23
  76. data/lib/graphiti/query.rb +1 -1
  77. data/lib/graphiti/rails/context.rb +33 -0
  78. data/lib/graphiti/rails/controller.rb +41 -0
  79. data/lib/graphiti/rails/debugging.rb +18 -0
  80. data/lib/graphiti/rails/exception_handlers.rb +77 -0
  81. data/lib/graphiti/rails/railtie.rb +139 -0
  82. data/lib/graphiti/rails/responders.rb +21 -0
  83. data/lib/graphiti/rails/test_helpers.rb +22 -0
  84. data/lib/graphiti/rails.rb +47 -29
  85. data/lib/graphiti/resource/configuration.rb +1 -0
  86. data/lib/graphiti/resource/interface.rb +2 -2
  87. data/lib/graphiti/resource/persistence.rb +14 -2
  88. data/lib/graphiti/resource/remote.rb +2 -2
  89. data/lib/graphiti/resource/sideloading.rb +1 -1
  90. data/lib/graphiti/resource.rb +13 -1
  91. data/lib/graphiti/responders.rb +7 -20
  92. data/lib/graphiti/schema.rb +5 -1
  93. data/lib/graphiti/schema_diff.rb +4 -0
  94. data/lib/graphiti/scope.rb +45 -37
  95. data/lib/graphiti/serializer.rb +6 -0
  96. data/lib/graphiti/sideload/belongs_to.rb +38 -5
  97. data/lib/graphiti/sideload/polymorphic_belongs_to.rb +27 -23
  98. data/lib/graphiti/sideload.rb +54 -35
  99. data/lib/graphiti/spec_helpers/errors.rb +73 -0
  100. data/lib/graphiti/spec_helpers/errors_proxy.rb +75 -0
  101. data/lib/graphiti/spec_helpers/helpers.rb +107 -0
  102. data/lib/graphiti/spec_helpers/node.rb +88 -0
  103. data/lib/graphiti/spec_helpers/rspec.rb +147 -0
  104. data/lib/graphiti/spec_helpers.rb +53 -0
  105. data/lib/graphiti/util/include_params.rb +2 -2
  106. data/lib/graphiti/util/persistence.rb +10 -11
  107. data/lib/graphiti/util/serializer_relationships.rb +41 -5
  108. data/lib/graphiti/version.rb +1 -1
  109. data/lib/graphiti-rails.rb +11 -0
  110. data/lib/graphiti.rb +34 -10
  111. data/lib/graphiti_errors.rb +11 -0
  112. data/lib/graphiti_spec_helpers/rspec.rb +3 -0
  113. data/lib/graphiti_spec_helpers.rb +11 -0
  114. data/lib/{graphiti/deprecated_tasks.rb → tasks/graphiti.rake} +6 -1
  115. data/package-lock.json +6199 -0
  116. data/package.json +5 -4
  117. data/website/.gitignore +20 -0
  118. data/website/README.md +43 -0
  119. data/website/docusaurus.config.js +141 -0
  120. data/website/package-lock.json +19474 -0
  121. data/website/package.json +46 -0
  122. data/website/sidebars.js +82 -0
  123. data/website/src/css/custom.css +58 -0
  124. data/website/src/pages/markdown-page.mdx +7 -0
  125. data/website/static/.nojekyll +0 -0
  126. data/website/static/1.13/2019/03/31/graphiti-1-0.html +205 -0
  127. data/website/static/1.13/2019/05/08/graphiti-1-1.html +212 -0
  128. data/website/static/1.13/2019/05/20/graphiti-1-2.html +214 -0
  129. data/website/static/1.13/2019/10/14/tutorial.html +198 -0
  130. data/website/static/1.13/CNAME +1 -0
  131. data/website/static/1.13/README.md +16 -0
  132. data/website/static/1.13/assets/css/syntax.css +60 -0
  133. data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
  134. data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
  135. data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
  136. data/website/static/1.13/assets/favicons/browserconfig.xml +9 -0
  137. data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
  138. data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
  139. data/website/static/1.13/assets/favicons/favicon.ico +0 -0
  140. data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
  141. data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +1 -0
  142. data/website/static/1.13/assets/favicons/site.webmanifest +19 -0
  143. data/website/static/1.13/assets/img/backend.gif +0 -0
  144. data/website/static/1.13/assets/img/conformity.png +0 -0
  145. data/website/static/1.13/assets/img/error_payload.png +0 -0
  146. data/website/static/1.13/assets/img/gh.png +0 -0
  147. data/website/static/1.13/assets/img/lifecycle.gif +0 -0
  148. data/website/static/1.13/assets/img/logo-500.png +0 -0
  149. data/website/static/1.13/assets/img/logo.png +0 -0
  150. data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
  151. data/website/static/1.13/assets/img/meta_total_count.png +0 -0
  152. data/website/static/1.13/assets/img/persist.jpg +0 -0
  153. data/website/static/1.13/assets/img/resource.gif +0 -0
  154. data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
  155. data/website/static/1.13/assets/img/rest1.gif +0 -0
  156. data/website/static/1.13/assets/img/rest2.gif +0 -0
  157. data/website/static/1.13/assets/img/rest3.gif +0 -0
  158. data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
  159. data/website/static/1.13/assets/img/why.png +0 -0
  160. data/website/static/1.13/assets/js/highlight.pack.js +2 -0
  161. data/website/static/1.13/assets/main.css +15518 -0
  162. data/website/static/1.13/assets/main.css.map +1 -0
  163. data/website/static/1.13/bin/bundle +109 -0
  164. data/website/static/1.13/bin/jekyll +27 -0
  165. data/website/static/1.13/bin/kramdown +27 -0
  166. data/website/static/1.13/bin/listen +27 -0
  167. data/website/static/1.13/bin/rake +27 -0
  168. data/website/static/1.13/bin/rougify +27 -0
  169. data/website/static/1.13/bin/safe_yaml +27 -0
  170. data/website/static/1.13/bin/sass +27 -0
  171. data/website/static/1.13/bin/sass-convert +27 -0
  172. data/website/static/1.13/bin/scss +27 -0
  173. data/website/static/1.13/blog.html +259 -0
  174. data/website/static/1.13/cheatsheet.html +316 -0
  175. data/website/static/1.13/cookbooks/authorization.md +0 -0
  176. data/website/static/1.13/cookbooks/caching.md +0 -0
  177. data/website/static/1.13/cookbooks/customizing-sideloads.html +325 -0
  178. data/website/static/1.13/cookbooks/etags.md +0 -0
  179. data/website/static/1.13/cookbooks/hopping-relationships.html +324 -0
  180. data/website/static/1.13/cookbooks/json_attributes.md +0 -0
  181. data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
  182. data/website/static/1.13/cookbooks/remote-resources.md +0 -0
  183. data/website/static/1.13/cookbooks/without-activerecord.html +510 -0
  184. data/website/static/1.13/features.html +249 -0
  185. data/website/static/1.13/feed.xml +106 -0
  186. data/website/static/1.13/guides/concepts/backends-and-models.html +467 -0
  187. data/website/static/1.13/guides/concepts/debugging.html +440 -0
  188. data/website/static/1.13/guides/concepts/endpoints.html +432 -0
  189. data/website/static/1.13/guides/concepts/error-handling.html +396 -0
  190. data/website/static/1.13/guides/concepts/links.html +501 -0
  191. data/website/static/1.13/guides/concepts/remote-resources.html +536 -0
  192. data/website/static/1.13/guides/concepts/resources.html +2176 -0
  193. data/website/static/1.13/guides/concepts/testing.html +1469 -0
  194. data/website/static/1.13/guides/getting-started/installation.html +420 -0
  195. data/website/static/1.13/guides/graphiti-rails-migration.html +242 -0
  196. data/website/static/1.13/guides/index.html +269 -0
  197. data/website/static/1.13/guides/overview.html +325 -0
  198. data/website/static/1.13/guides/upgrading-2-0.html +193 -0
  199. data/website/static/1.13/guides/upgrading.html +314 -0
  200. data/website/static/1.13/guides/vandal.html +282 -0
  201. data/website/static/1.13/guides/why.html +1121 -0
  202. data/website/static/1.13/index.html +72 -0
  203. data/website/static/1.13/js/authentication.html +295 -0
  204. data/website/static/1.13/js/ddau.html +238 -0
  205. data/website/static/1.13/js/extra-params.html +270 -0
  206. data/website/static/1.13/js/index.html +321 -0
  207. data/website/static/1.13/js/installation.html +637 -0
  208. data/website/static/1.13/js/introduction.html +257 -0
  209. data/website/static/1.13/js/middleware.html +318 -0
  210. data/website/static/1.13/js/reads/fieldsets.html +271 -0
  211. data/website/static/1.13/js/reads/filtering.html +289 -0
  212. data/website/static/1.13/js/reads/includes.html +260 -0
  213. data/website/static/1.13/js/reads/index.html +497 -0
  214. data/website/static/1.13/js/reads/nested-queries.html +353 -0
  215. data/website/static/1.13/js/reads/pagination.html +260 -0
  216. data/website/static/1.13/js/reads/sorting.html +265 -0
  217. data/website/static/1.13/js/reads/statistics.html +289 -0
  218. data/website/static/1.13/js/state-syncing.html +340 -0
  219. data/website/static/1.13/js/writes/deferred.html +296 -0
  220. data/website/static/1.13/js/writes/dirty-tracking.html +399 -0
  221. data/website/static/1.13/js/writes/index.html +391 -0
  222. data/website/static/1.13/js/writes/nested.html +330 -0
  223. data/website/static/1.13/js/writes/validations.html +272 -0
  224. data/website/static/1.13/quickstart.html +660 -0
  225. data/website/static/1.13/template +161 -0
  226. data/website/static/1.13/tutorial/index.html +250 -0
  227. data/website/static/1.13/tutorial/step_0.html +292 -0
  228. data/website/static/1.13/tutorial/step_1.html +517 -0
  229. data/website/static/1.13/tutorial/step_2.html +481 -0
  230. data/website/static/1.13/tutorial/step_3.html +323 -0
  231. data/website/static/1.13/tutorial/step_4.html +318 -0
  232. data/website/static/1.13/tutorial/step_5.html +265 -0
  233. data/website/static/1.13/tutorial/step_6.html +276 -0
  234. data/website/static/1.13/tutorial/step_7.html +390 -0
  235. data/website/static/1.13/tutorial/step_8.html +316 -0
  236. data/website/static/1.13/tutorial/step_9.html +365 -0
  237. data/website/static/assets/img/error_payload.png +0 -0
  238. data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
  239. data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
  240. data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
  241. data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
  242. data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
  243. data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
  244. data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
  245. data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
  246. data/website/static/assets/img/meta_total_count.png +0 -0
  247. data/website/static/img/docusaurus-social-card.jpg +0 -0
  248. data/website/static/img/docusaurus.png +0 -0
  249. data/website/static/img/favicon.ico +0 -0
  250. data/website/static/img/logo.png +0 -0
  251. data/website/static/img/logo.svg +1 -0
  252. data/website/static/img/undraw_docusaurus_mountain.svg +171 -0
  253. data/website/static/img/undraw_docusaurus_react.svg +170 -0
  254. data/website/static/img/undraw_docusaurus_tree.svg +40 -0
  255. metadata +245 -46
  256. data/gemfiles/rails_6.gemfile +0 -18
  257. data/gemfiles/rails_6_graphiti_rails.gemfile +0 -19
  258. data/gemfiles/rails_7.gemfile +0 -18
  259. data/gemfiles/rails_7_1_graphiti_rails.gemfile +0 -19
  260. data/gemfiles/rails_7_graphiti_rails.gemfile +0 -19
  261. data/lib/graphiti/railtie.rb +0 -121
  262. /data/{deprecated_generators → lib/generators}/graphiti/resource_test_generator.rb +0 -0
  263. /data/{deprecated_generators → lib/generators}/graphiti/templates/application_resource.rb.erb +0 -0
  264. /data/{deprecated_generators → lib/generators}/graphiti/templates/controller.rb.erb +0 -0
  265. /data/{deprecated_generators → lib/generators}/graphiti/templates/create_request_spec.rb.erb +0 -0
  266. /data/{deprecated_generators → lib/generators}/graphiti/templates/destroy_request_spec.rb.erb +0 -0
  267. /data/{deprecated_generators → lib/generators}/graphiti/templates/resource.rb.erb +0 -0
  268. /data/{deprecated_generators → lib/generators}/graphiti/templates/resource_writes_spec.rb.erb +0 -0
  269. /data/{deprecated_generators → lib/generators}/graphiti/templates/update_request_spec.rb.erb +0 -0
data/website/static/1.13/cookbooks/hopping-relationships.html ADDED
@@ -0,0 +1,324 @@
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
+ <h1 id="hopping-relationships">Hopping Relationships</h1>
84
+
85
+ <blockquote>
86
+ <p><a href="https://github.com/graphiti-api/employee_directory/commit/b187127d60ea67ef4c2a326721caeaad21ed7ec9">See the code</a></p>
87
+ </blockquote>
88
+
89
+ <p>Our <a href="https://github.com/graphiti-api/employee_directory">sample application</a>
90
+ has the setup <code class="language-plaintext highlighter-rouge">Employee &gt; Position &gt; Department</code>, where one of the
91
+ positions is the <code class="language-plaintext highlighter-rouge">current_position</code>. What if we wanted to change this to
92
+ <code class="language-plaintext highlighter-rouge">Employee &gt; Department</code>, hiding everything about positions
93
+ under-the-hood?</p>
94
+
95
+ <p>Let’s start by saying an <code class="language-plaintext highlighter-rouge">Employee</code> has many <code class="language-plaintext highlighter-rouge">Department</code>s. Here’s the
96
+ spec:</p>
97
+
98
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">describe</span> <span class="s1">'sideloading'</span> <span class="k">do</span>
99
+ <span class="n">describe</span> <span class="s1">'departments'</span> <span class="k">do</span>
100
+ <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>
101
+ <span class="n">let!</span><span class="p">(</span><span class="ss">:position1</span><span class="p">)</span> <span class="k">do</span>
102
+ <span class="n">create</span> <span class="ss">:position</span><span class="p">,</span>
103
+ <span class="ss">historical_index: </span><span class="mi">2</span><span class="p">,</span>
104
+ <span class="ss">employee: </span><span class="n">employee</span><span class="p">,</span>
105
+ <span class="ss">department: </span><span class="n">department1</span>
106
+ <span class="k">end</span>
107
+ <span class="n">let!</span><span class="p">(</span><span class="ss">:position2</span><span class="p">)</span> <span class="k">do</span>
108
+ <span class="n">create</span> <span class="ss">:position</span><span class="p">,</span>
109
+ <span class="ss">historical_index: </span><span class="mi">1</span><span class="p">,</span>
110
+ <span class="ss">employee: </span><span class="n">employee</span><span class="p">,</span>
111
+ <span class="ss">department: </span><span class="n">department2</span>
112
+ <span class="k">end</span>
113
+ <span class="n">let!</span><span class="p">(</span><span class="ss">:department1</span><span class="p">)</span> <span class="p">{</span> <span class="n">create</span><span class="p">(</span><span class="ss">:department</span><span class="p">)</span> <span class="p">}</span>
114
+ <span class="n">let!</span><span class="p">(</span><span class="ss">:department2</span><span class="p">)</span> <span class="p">{</span> <span class="n">create</span><span class="p">(</span><span class="ss">:department</span><span class="p">)</span> <span class="p">}</span>
115
+
116
+ <span class="n">before</span> <span class="k">do</span>
117
+ <span class="n">params</span><span class="p">[</span><span class="ss">:include</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'departments'</span>
118
+ <span class="k">end</span>
119
+
120
+ <span class="n">it</span> <span class="s1">'finds the departments for all positions'</span> <span class="k">do</span>
121
+ <span class="n">render</span>
122
+ <span class="n">sl</span> <span class="o">=</span> <span class="n">d</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nf">sideload</span><span class="p">(</span><span class="ss">:departments</span><span class="p">)</span>
123
+ <span class="n">expect</span><span class="p">(</span><span class="n">sl</span><span class="p">.</span><span class="nf">map</span><span class="p">(</span><span class="o">&amp;</span><span class="ss">:id</span><span class="p">)).</span><span class="nf">to</span> <span class="n">eq</span><span class="p">([</span><span class="n">department1</span><span class="p">.</span><span class="nf">id</span><span class="p">,</span> <span class="n">department2</span><span class="p">.</span><span class="nf">id</span><span class="p">])</span>
124
+ <span class="n">expect</span><span class="p">(</span><span class="n">sl</span><span class="p">.</span><span class="nf">map</span><span class="p">(</span><span class="o">&amp;</span><span class="ss">:jsonapi_type</span><span class="p">).</span><span class="nf">uniq</span><span class="p">).</span><span class="nf">to</span> <span class="n">eq</span><span class="p">([</span><span class="s1">'departments'</span><span class="p">])</span>
125
+ <span class="k">end</span>
126
+ <span class="k">end</span>
127
+ <span class="k">end</span></code></pre></figure>
128
+
129
+ <p>Start by defining the association:</p>
130
+
131
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_many</span> <span class="ss">:departments</span></code></pre></figure>
132
+
133
+ <p>And you’ll get this error:</p>
134
+
135
+ <figure class="highlight"><pre><code class="language-error" data-lang="error">Graphiti::Errors::AttributeError:
136
+ DepartmentResource: Tried to filter on attribute :employee_id, but could not find an attribute with that name.</code></pre></figure>
137
+
138
+ <p>Which makes sense - if this is a <code class="language-plaintext highlighter-rouge">has_many</code> association, we’d expect
139
+ DepartmentResource to filter by <code class="language-plaintext highlighter-rouge">employee_id</code>. Though in our case we
140
+ don’t have that as a foreign key, we can still implement the
141
+ <code class="language-plaintext highlighter-rouge">employee_id</code> filter:</p>
142
+
143
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">filter</span> <span class="ss">:employee_id</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">:eq</span><span class="p">]</span> <span class="k">do</span>
144
+ <span class="n">eq</span> <span class="k">do</span> <span class="o">|</span><span class="n">scope</span><span class="p">,</span> <span class="n">value</span><span class="o">|</span>
145
+ <span class="n">scope</span><span class="p">.</span><span class="nf">joins</span><span class="p">(</span><span class="ss">:positions</span><span class="p">).</span><span class="nf">merge</span><span class="p">(</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">value</span><span class="p">))</span>
146
+ <span class="k">end</span>
147
+ <span class="k">end</span></code></pre></figure>
148
+
149
+ <p>In order to find <code class="language-plaintext highlighter-rouge">Department</code>s by an <code class="language-plaintext highlighter-rouge">employee_id</code>, we need to join the
150
+ <code class="language-plaintext highlighter-rouge">positions</code> table which has the <code class="language-plaintext highlighter-rouge">employee_id</code> column.</p>
151
+
152
+ <p>We now get this error:</p>
153
+
154
+ <figure class="highlight"><pre><code class="language-error" data-lang="error">NoMethodError:
155
+ undefined method `employee_id' for #&lt;Department:0x00007fa6f330f768&gt;</code></pre></figure>
156
+
157
+ <p>Let’s say our URL is <code class="language-plaintext highlighter-rouge">/employees?include=departments</code>. We’ve fetched all
158
+ the <code class="language-plaintext highlighter-rouge">Employee</code>s and all the <code class="language-plaintext highlighter-rouge">Department</code>s, now we need to associate each
159
+ <code class="language-plaintext highlighter-rouge">Department</code> with its relevant <code class="language-plaintext highlighter-rouge">Employee</code>. Normally we’d do that by
160
+ looking at the <code class="language-plaintext highlighter-rouge">employee_id</code> foreign key on <code class="language-plaintext highlighter-rouge">Department</code>, but this
161
+ scenario has non-standard logic. Let’s tell Graphiti how to select
162
+ relevant <code class="language-plaintext highlighter-rouge">Department</code>s for a given <code class="language-plaintext highlighter-rouge">Employee</code>:</p>
163
+
164
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_many</span> <span class="ss">:departments</span> <span class="k">do</span>
165
+ <span class="n">assign_each</span> <span class="k">do</span> <span class="o">|</span><span class="n">employee</span><span class="p">,</span> <span class="n">departments</span><span class="o">|</span>
166
+ <span class="n">departments</span><span class="p">.</span><span class="nf">select</span> <span class="k">do</span> <span class="o">|</span><span class="n">d</span><span class="o">|</span>
167
+ <span class="n">employee_ids</span> <span class="o">=</span> <span class="n">d</span><span class="p">.</span><span class="nf">positions</span><span class="p">.</span><span class="nf">map</span><span class="p">(</span><span class="o">&amp;</span><span class="ss">:employee_id</span><span class="p">).</span><span class="nf">flatten</span>
168
+ <span class="n">employee</span><span class="p">.</span><span class="nf">id</span><span class="p">.</span><span class="nf">in?</span><span class="p">(</span><span class="n">employee_ids</span><span class="p">)</span>
169
+ <span class="k">end</span>
170
+ <span class="k">end</span>
171
+ <span class="k">end</span></code></pre></figure>
172
+
173
+ <p>There’s one final step - because we’re assigning a department to an
174
+ employee, we have to make sure that accessor exists:</p>
175
+
176
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/models/employee.rb</span>
177
+ <span class="nb">attr_accessor</span> <span class="ss">:department</span></code></pre></figure>
178
+
179
+ <p>And that’s it! Our test now passes.</p>
180
+
181
+ <p>There’s a little bit of sleight-of-hand above though. Our filter joins
182
+ to the <code class="language-plaintext highlighter-rouge">positions</code> table, and our assignment iterates over departments
183
+ and calls <code class="language-plaintext highlighter-rouge">department.positions</code>. <strong>If we don’t eager load, we’ll cause
184
+ an N+!</strong>!</p>
185
+
186
+ <p>There are two solutions to this. The first is to simple change <code class="language-plaintext highlighter-rouge">.joins</code>
187
+ to <code class="language-plaintext highlighter-rouge">.eager_load</code>:</p>
188
+
189
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">scope</span><span class="p">.</span><span class="nf">eager_load</span><span class="p">(</span><span class="ss">:positions</span><span class="p">).</span><span class="nf">merge</span><span class="p">(</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">value</span><span class="p">))</span></code></pre></figure>
190
+
191
+ <p>This ensures that not only are we joining on the <code class="language-plaintext highlighter-rouge">positions</code> table,
192
+ we’ll eagler load the <code class="language-plaintext highlighter-rouge">positions</code> <em>relationship</em> and avoid the N+1.</p>
193
+
194
+ <p>If you’re a stickler, though, you may have a nitpick. For one, if
195
+ we’re hitting <code class="language-plaintext highlighter-rouge">/departments?filter[employee_id]</code> directly there is no
196
+ need to eager load <code class="language-plaintext highlighter-rouge">positions</code> because we’re never associating to an
197
+ <code class="language-plaintext highlighter-rouge">Employee</code>. We’re paying a performance penalty when we don’t have to.</p>
198
+
199
+ <p>OK, let’s keep our filter <code class="language-plaintext highlighter-rouge">.joins</code>. We just have to tell Graphiti to
200
+ switch it to <code class="language-plaintext highlighter-rouge">.eager_load</code> when sideloading through <code class="language-plaintext highlighter-rouge">EmployeeResource</code>:</p>
201
+
202
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_many</span> <span class="ss">:departments</span> <span class="k">do</span>
203
+ <span class="c1"># ... code ...</span>
204
+
205
+ <span class="n">pre_load</span> <span class="k">do</span> <span class="o">|</span><span class="n">proxy</span><span class="p">,</span> <span class="n">employees</span><span class="o">|</span>
206
+ <span class="n">proxy</span><span class="p">.</span><span class="nf">scope</span><span class="p">.</span><span class="nf">object</span> <span class="o">=</span> <span class="n">proxy</span><span class="p">.</span><span class="nf">scope</span><span class="p">.</span><span class="nf">object</span><span class="p">.</span><span class="nf">eager_load</span><span class="p">(</span><span class="ss">:positions</span><span class="p">)</span>
207
+ <span class="k">end</span>
208
+ <span class="k">end</span></code></pre></figure>
209
+
210
+ <p>The <code class="language-plaintext highlighter-rouge">pre_load</code> hook fires after we’ve built up the scope, but before we
211
+ resolve it (before actually firing the query). It yields a <code class="language-plaintext highlighter-rouge">proxy</code>
212
+ object that we can modify - here we’re modifying the scope to eager load
213
+ positions.</p>
214
+
215
+ <p>It’s up to you if you care about this scenario - you may want to start
216
+ with <code class="language-plaintext highlighter-rouge">.eager_load</code> and only embrace to the extra work of <code class="language-plaintext highlighter-rouge">pre_load</code> when
217
+ you really need it.</p>
218
+
219
+ <p>The trick to these customizations is to think in Links. Resources
220
+ connect to each other with URLs - what would the query parameters of the
221
+ URL be? In this case, <code class="language-plaintext highlighter-rouge">filter?[employee_id]=123</code>. After that, we just
222
+ have to define how to associate relevant objects. Even with complex
223
+ associations hopping several levels, the same logic applies.</p>
224
+
225
+ <p>See the final code <a href="https://github.com/graphiti-api/employee_directory/commit/b187127d60ea67ef4c2a326721caeaad21ed7ec9">here</a>.</p>
226
+
227
+ <p><br />
228
+ <br /></p>
229
+
230
+ </div>
231
+ </div>
232
+ </main>
233
+ <div class="main-footer main-footer--dark">
234
+ <div class="container">
235
+ <div class="row">
236
+ <div class="col-sm-4 menu">
237
+ <h3>Overview</h3>
238
+ <ul>
239
+ <li>
240
+ <a href="/1.13/quickstart">Quickstart</a>
241
+ </li>
242
+ <li>
243
+ <a href="/1.13/tutorial">Tutorial</a>
244
+ </li>
245
+ <li>
246
+ <a href="/1.13/guides">Guides</a>
247
+ </li>
248
+ </ul>
249
+ </div>
250
+ <div class="col-sm-4 menu">
251
+ <h3>Contact</h3>
252
+ <ul>
253
+ <li>
254
+ <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
255
+ </li>
256
+ <li>
257
+ <a href="mailto:richmolj@gmail.com">Email</a>
258
+ </li>
259
+ </ul>
260
+ </div>
261
+ <div class="col-sm-4 menu">
262
+ <h3>Related</h3>
263
+ <ul>
264
+ <li>
265
+ <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
266
+ </li>
267
+ <li>
268
+ <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
269
+ </li>
270
+ <li>
271
+ <a target="_blank" href="https://vuejs.org/">VueJS</a>
272
+ </li>
273
+ </ul>
274
+ </div>
275
+ </div>
276
+ </div>
277
+ </div>
278
+
279
+ <script type="text/javascript">
280
+ $(function () {
281
+
282
+ var flipTabs = function() {
283
+ var isTS = true;
284
+ if (localStorage.getItem('js-lang') === 'javascript') {
285
+ isTS = false;
286
+ }
287
+
288
+ $('.code-tabs').each(function(index, el) {
289
+ if (isTS) {
290
+ console.log('hiding js');
291
+ $($(el).children()[1]).hide();
292
+ $($(el).children()[0]).show();
293
+ } else {
294
+ console.log('hiding ts');
295
+ $($(el).children()[0]).hide();
296
+ $($(el).children()[1]).show();
297
+ }
298
+ });
299
+
300
+ if (isTS) {
301
+ $('.tab.typescript').addClass('active');
302
+ $('.tab.javascript').removeClass('active');
303
+ } else {
304
+ $('.tab.typescript').removeClass('active');
305
+ $('.tab.javascript').addClass('active');
306
+ }
307
+ }
308
+
309
+ $('.tab').click(function() {
310
+ if ($(this).hasClass('typescript')) {
311
+ localStorage.setItem('js-lang', 'typescript');
312
+ } else {
313
+ localStorage.setItem('js-lang', 'javascript');
314
+ }
315
+
316
+ flipTabs();
317
+ });
318
+
319
+ flipTabs();
320
+ })
321
+ </script>
322
+
323
+ </body>
324
+ </html>
data/website/static/1.13/cookbooks/json_attributes.md ADDED
File without changes
data/website/static/1.13/cookbooks/remote-resources.md ADDED
File without changes