graphiti 2.0.0.beta.7 → 2.0.0.beta.9

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 (251) hide show
  1. checksums.yaml +4 -4
  2. data/.git-blame-ignore-revs +2 -0
  3. data/.github/workflows/ci.yml +56 -4
  4. data/.github/workflows/docs.yml +10 -7
  5. data/.github/workflows/notify-example-app.yml +18 -0
  6. data/.github/workflows/release.yml +1 -1
  7. data/.gitignore +2 -0
  8. data/.standard.yml +6 -0
  9. data/CHANGELOG.md +66 -0
  10. data/CONTRIBUTING.md +3 -1
  11. data/README.md +13 -206
  12. data/Rakefile +34 -3
  13. data/UPGRADING.md +2 -2
  14. data/graphiti.gemspec +8 -4
  15. data/lib/generators/graphiti/generator_mixin.rb +1 -1
  16. data/lib/generators/graphiti/install_generator.rb +1 -1
  17. data/lib/generators/graphiti/resource_generator.rb +6 -3
  18. data/lib/generators/graphiti/templates/application_resource.rb.erb +19 -0
  19. data/lib/generators/graphiti/templates/controller.rb.erb +26 -8
  20. data/lib/graphiti/audit/report.rb +6 -6
  21. data/lib/graphiti/audit.rb +3 -4
  22. data/lib/graphiti/configuration.rb +11 -4
  23. data/lib/graphiti/debugger.rb +18 -6
  24. data/lib/graphiti/delegates/pagination.rb +2 -2
  25. data/lib/graphiti/deserializer.rb +3 -3
  26. data/lib/graphiti/error_serializers/deprecated_constants.rb +23 -0
  27. data/lib/graphiti/error_serializers/invalid_request.rb +6 -0
  28. data/lib/graphiti/errors.rb +22 -6
  29. data/lib/graphiti/extensions/temp_id.rb +1 -1
  30. data/lib/graphiti/query.rb +5 -4
  31. data/lib/graphiti/rails/context.rb +2 -1
  32. data/lib/graphiti/rails/controller.rb +3 -0
  33. data/lib/graphiti/rails/debugging.rb +1 -1
  34. data/lib/graphiti/rails/responders.rb +2 -1
  35. data/lib/graphiti/rails.rb +14 -0
  36. data/lib/graphiti/railtie.rb +8 -0
  37. data/lib/graphiti/resource/configuration.rb +1 -0
  38. data/lib/graphiti/resource/dsl.rb +2 -2
  39. data/lib/graphiti/resource/links.rb +1 -1
  40. data/lib/graphiti/resource/persistence.rb +1 -1
  41. data/lib/graphiti/resource/polymorphism.rb +1 -1
  42. data/lib/graphiti/resource.rb +2 -2
  43. data/lib/graphiti/resource_proxy.rb +0 -1
  44. data/lib/graphiti/scope.rb +68 -21
  45. data/lib/graphiti/scoping/filter.rb +5 -3
  46. data/lib/graphiti/scoping/paginate.rb +1 -1
  47. data/lib/graphiti/scoping/sort.rb +1 -1
  48. data/lib/graphiti/sideload/has_many.rb +1 -1
  49. data/lib/graphiti/sideload/polymorphic_belongs_to.rb +11 -4
  50. data/lib/graphiti/sideload.rb +8 -6
  51. data/lib/graphiti/spec_helpers/errors_proxy.rb +1 -1
  52. data/lib/graphiti/spec_helpers/matchers.rb +1 -1
  53. data/lib/graphiti/types.rb +5 -1
  54. data/lib/graphiti/util/cache_debug.rb +3 -3
  55. data/lib/graphiti/util/hash.rb +1 -1
  56. data/lib/graphiti/util/persistence.rb +6 -6
  57. data/lib/graphiti/util/serializer_relationships.rb +11 -2
  58. data/lib/graphiti/version.rb +1 -1
  59. data/lib/graphiti.rb +1 -1
  60. data/lib/tasks/graphiti.rake +1 -1
  61. data/package-lock.json +114 -0
  62. data/package.json +16 -3
  63. metadata +33 -198
  64. data/docs/concepts/backends-and-models.md +0 -122
  65. data/docs/concepts/endpoints.md +0 -183
  66. data/docs/concepts/links.md +0 -212
  67. data/docs/concepts/overview.md +0 -80
  68. data/docs/concepts/persisting.md +0 -376
  69. data/docs/concepts/relationships.md +0 -627
  70. data/docs/concepts/resources.md +0 -677
  71. data/docs/getting-started/first-api.md +0 -289
  72. data/docs/getting-started/installation.md +0 -185
  73. data/docs/intro.md +0 -307
  74. data/docs/js/authentication.md +0 -63
  75. data/docs/js/ddau.md +0 -20
  76. data/docs/js/extra-params.md +0 -41
  77. data/docs/js/index.md +0 -112
  78. data/docs/js/installation.md +0 -120
  79. data/docs/js/middleware.md +0 -72
  80. data/docs/js/models.md +0 -202
  81. data/docs/js/reads.md +0 -494
  82. data/docs/js/state-syncing.md +0 -100
  83. data/docs/js/writes.md +0 -373
  84. data/docs/reference/vandal.md +0 -63
  85. data/docs/reference/why.md +0 -13
  86. data/docs/topics/authorization.md +0 -155
  87. data/docs/topics/caching.md +0 -55
  88. data/docs/topics/customizing-sideloads.md +0 -156
  89. data/docs/topics/debugging.md +0 -242
  90. data/docs/topics/error-handling.md +0 -210
  91. data/docs/topics/etags.md +0 -46
  92. data/docs/topics/hopping-relationships.md +0 -149
  93. data/docs/topics/json-attributes.md +0 -77
  94. data/docs/topics/openstruct-models.md +0 -50
  95. data/docs/topics/remote-resources.md +0 -291
  96. data/docs/topics/testing.md +0 -916
  97. data/docs/topics/without-activerecord.md +0 -324
  98. data/docs/tutorial/index.md +0 -58
  99. data/docs/tutorial/step_0.md +0 -107
  100. data/docs/tutorial/step_1.md +0 -199
  101. data/docs/tutorial/step_2.md +0 -312
  102. data/docs/tutorial/step_3.md +0 -142
  103. data/docs/tutorial/step_4.md +0 -135
  104. data/docs/tutorial/step_5.md +0 -69
  105. data/docs/tutorial/step_6.md +0 -82
  106. data/docs/tutorial/step_7.md +0 -205
  107. data/docs/tutorial/step_8.md +0 -128
  108. data/docs/tutorial/step_9.md +0 -171
  109. data/docs/upgrading.md +0 -267
  110. data/website/.gitignore +0 -20
  111. data/website/README.md +0 -43
  112. data/website/docusaurus.config.js +0 -197
  113. data/website/package-lock.json +0 -19474
  114. data/website/package.json +0 -46
  115. data/website/sidebars.js +0 -82
  116. data/website/src/css/custom.css +0 -85
  117. data/website/src/pages/markdown-page.mdx +0 -7
  118. data/website/static/.nojekyll +0 -0
  119. data/website/static/1.13/2019/03/31/graphiti-1-0.html +0 -205
  120. data/website/static/1.13/2019/05/08/graphiti-1-1.html +0 -212
  121. data/website/static/1.13/2019/05/20/graphiti-1-2.html +0 -214
  122. data/website/static/1.13/2019/10/14/tutorial.html +0 -198
  123. data/website/static/1.13/CNAME +0 -1
  124. data/website/static/1.13/README.md +0 -16
  125. data/website/static/1.13/assets/css/syntax.css +0 -60
  126. data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
  127. data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
  128. data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
  129. data/website/static/1.13/assets/favicons/browserconfig.xml +0 -9
  130. data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
  131. data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
  132. data/website/static/1.13/assets/favicons/favicon.ico +0 -0
  133. data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
  134. data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +0 -1
  135. data/website/static/1.13/assets/favicons/site.webmanifest +0 -19
  136. data/website/static/1.13/assets/img/backend.gif +0 -0
  137. data/website/static/1.13/assets/img/conformity.png +0 -0
  138. data/website/static/1.13/assets/img/error_payload.png +0 -0
  139. data/website/static/1.13/assets/img/fancy-cushion.png +0 -0
  140. data/website/static/1.13/assets/img/gh.png +0 -0
  141. data/website/static/1.13/assets/img/home-bg.jpg +0 -0
  142. data/website/static/1.13/assets/img/lifecycle.gif +0 -0
  143. data/website/static/1.13/assets/img/logo-500.png +0 -0
  144. data/website/static/1.13/assets/img/logo.png +0 -0
  145. data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
  146. data/website/static/1.13/assets/img/meta_total_count.png +0 -0
  147. data/website/static/1.13/assets/img/persist.jpg +0 -0
  148. data/website/static/1.13/assets/img/resource.gif +0 -0
  149. data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
  150. data/website/static/1.13/assets/img/rest1.gif +0 -0
  151. data/website/static/1.13/assets/img/rest2.gif +0 -0
  152. data/website/static/1.13/assets/img/rest3.gif +0 -0
  153. data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
  154. data/website/static/1.13/assets/img/sunrise.png +0 -0
  155. data/website/static/1.13/assets/img/why.png +0 -0
  156. data/website/static/1.13/assets/js/highlight.pack.js +0 -2
  157. data/website/static/1.13/assets/main.css +0 -15518
  158. data/website/static/1.13/assets/main.css.map +0 -1
  159. data/website/static/1.13/bin/bundle +0 -109
  160. data/website/static/1.13/bin/jekyll +0 -27
  161. data/website/static/1.13/bin/kramdown +0 -27
  162. data/website/static/1.13/bin/listen +0 -27
  163. data/website/static/1.13/bin/rake +0 -27
  164. data/website/static/1.13/bin/rougify +0 -27
  165. data/website/static/1.13/bin/safe_yaml +0 -27
  166. data/website/static/1.13/bin/sass +0 -27
  167. data/website/static/1.13/bin/sass-convert +0 -27
  168. data/website/static/1.13/bin/scss +0 -27
  169. data/website/static/1.13/blog.html +0 -259
  170. data/website/static/1.13/cheatsheet.html +0 -316
  171. data/website/static/1.13/cookbooks/authorization.md +0 -0
  172. data/website/static/1.13/cookbooks/caching.md +0 -0
  173. data/website/static/1.13/cookbooks/customizing-sideloads.html +0 -325
  174. data/website/static/1.13/cookbooks/etags.md +0 -0
  175. data/website/static/1.13/cookbooks/hopping-relationships.html +0 -324
  176. data/website/static/1.13/cookbooks/json_attributes.md +0 -0
  177. data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
  178. data/website/static/1.13/cookbooks/remote-resources.md +0 -0
  179. data/website/static/1.13/cookbooks/without-activerecord.html +0 -510
  180. data/website/static/1.13/features.html +0 -249
  181. data/website/static/1.13/feed.xml +0 -106
  182. data/website/static/1.13/guides/concepts/backends-and-models.html +0 -467
  183. data/website/static/1.13/guides/concepts/debugging.html +0 -440
  184. data/website/static/1.13/guides/concepts/endpoints.html +0 -432
  185. data/website/static/1.13/guides/concepts/error-handling.html +0 -396
  186. data/website/static/1.13/guides/concepts/links.html +0 -501
  187. data/website/static/1.13/guides/concepts/remote-resources.html +0 -536
  188. data/website/static/1.13/guides/concepts/resources.html +0 -2176
  189. data/website/static/1.13/guides/concepts/testing.html +0 -1469
  190. data/website/static/1.13/guides/getting-started/installation.html +0 -420
  191. data/website/static/1.13/guides/graphiti-rails-migration.html +0 -242
  192. data/website/static/1.13/guides/index.html +0 -269
  193. data/website/static/1.13/guides/overview.html +0 -325
  194. data/website/static/1.13/guides/upgrading-2-0.html +0 -193
  195. data/website/static/1.13/guides/upgrading.html +0 -314
  196. data/website/static/1.13/guides/vandal.html +0 -282
  197. data/website/static/1.13/guides/why.html +0 -1121
  198. data/website/static/1.13/index.html +0 -72
  199. data/website/static/1.13/js/authentication.html +0 -295
  200. data/website/static/1.13/js/ddau.html +0 -238
  201. data/website/static/1.13/js/extra-params.html +0 -270
  202. data/website/static/1.13/js/index.html +0 -321
  203. data/website/static/1.13/js/installation.html +0 -637
  204. data/website/static/1.13/js/introduction.html +0 -257
  205. data/website/static/1.13/js/middleware.html +0 -318
  206. data/website/static/1.13/js/reads/fieldsets.html +0 -271
  207. data/website/static/1.13/js/reads/filtering.html +0 -289
  208. data/website/static/1.13/js/reads/includes.html +0 -260
  209. data/website/static/1.13/js/reads/index.html +0 -497
  210. data/website/static/1.13/js/reads/nested-queries.html +0 -353
  211. data/website/static/1.13/js/reads/pagination.html +0 -260
  212. data/website/static/1.13/js/reads/sorting.html +0 -265
  213. data/website/static/1.13/js/reads/statistics.html +0 -289
  214. data/website/static/1.13/js/state-syncing.html +0 -340
  215. data/website/static/1.13/js/writes/deferred.html +0 -296
  216. data/website/static/1.13/js/writes/dirty-tracking.html +0 -399
  217. data/website/static/1.13/js/writes/index.html +0 -391
  218. data/website/static/1.13/js/writes/nested.html +0 -330
  219. data/website/static/1.13/js/writes/validations.html +0 -272
  220. data/website/static/1.13/quickstart.html +0 -660
  221. data/website/static/1.13/template +0 -161
  222. data/website/static/1.13/tutorial/index.html +0 -250
  223. data/website/static/1.13/tutorial/step_0.html +0 -292
  224. data/website/static/1.13/tutorial/step_1.html +0 -517
  225. data/website/static/1.13/tutorial/step_2.html +0 -481
  226. data/website/static/1.13/tutorial/step_3.html +0 -323
  227. data/website/static/1.13/tutorial/step_4.html +0 -318
  228. data/website/static/1.13/tutorial/step_5.html +0 -265
  229. data/website/static/1.13/tutorial/step_6.html +0 -276
  230. data/website/static/1.13/tutorial/step_7.html +0 -390
  231. data/website/static/1.13/tutorial/step_8.html +0 -316
  232. data/website/static/1.13/tutorial/step_9.html +0 -365
  233. data/website/static/CNAME +0 -1
  234. data/website/static/assets/img/error_payload.png +0 -0
  235. data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
  236. data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
  237. data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
  238. data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
  239. data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
  240. data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
  241. data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
  242. data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
  243. data/website/static/assets/img/meta_total_count.png +0 -0
  244. data/website/static/img/docusaurus-social-card.jpg +0 -0
  245. data/website/static/img/docusaurus.png +0 -0
  246. data/website/static/img/favicon.ico +0 -0
  247. data/website/static/img/logo.png +0 -0
  248. data/website/static/img/logo.svg +0 -1
  249. data/website/static/img/undraw_docusaurus_mountain.svg +0 -171
  250. data/website/static/img/undraw_docusaurus_react.svg +0 -170
  251. data/website/static/img/undraw_docusaurus_tree.svg +0 -40
data/website/static/1.13/tutorial/step_7.html DELETED
@@ -1,390 +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-7-many-to-many">Step 7: Many to Many</h3>
103
-
104
- <blockquote>
105
- <p><a href="https://github.com/graphiti-api/employee_directory/compare/step_6_write_customization...step_7_many_to_many">View the Diff</a></p>
106
- </blockquote>
107
-
108
- <p>Let’s add a <code class="language-plaintext highlighter-rouge">Team</code> relationship: a <code class="language-plaintext highlighter-rouge">Team</code> can have many <code class="language-plaintext highlighter-rouge">Employee</code>s, an
109
- <code class="language-plaintext highlighter-rouge">Employee</code> can have many <code class="language-plaintext highlighter-rouge">Team</code>s. Let’s also say a <code class="language-plaintext highlighter-rouge">Team</code> belongs to a
110
- <code class="language-plaintext highlighter-rouge">Department</code>.</p>
111
-
112
- <table class="table table-small text-center">
113
- <thead>
114
- <tr>
115
- <th class="text-center">id</th>
116
- <th class="text-center">department_id</th>
117
- <th class="text-center">name</th>
118
- </tr>
119
- </thead>
120
- <tbody>
121
- <tr>
122
- <td>1</td>
123
- <td>1</td>
124
- <td>The A Team</td>
125
- </tr>
126
- <tr>
127
- <td>2</td>
128
- <td>1</td>
129
- <td>The B Team</td>
130
- </tr>
131
- <tr>
132
- <td>3</td>
133
- <td>2</td>
134
- <td>The C Team</td>
135
- </tr>
136
- </tbody>
137
- </table>
138
-
139
- <p>To satisfy this many-to-many use case, we’ll need a join model,
140
- <code class="language-plaintext highlighter-rouge">TeamMembership</code>:</p>
141
-
142
- <table class="table table-small text-center">
143
- <thead>
144
- <tr>
145
- <th class="text-center">id</th>
146
- <th class="text-center">team_id</th>
147
- <th class="text-center">employee_id</th>
148
- </tr>
149
- </thead>
150
- <tbody>
151
- <tr>
152
- <td>1</td>
153
- <td>1</td>
154
- <td>1</td>
155
- </tr>
156
- <tr>
157
- <td>2</td>
158
- <td>2</td>
159
- <td>1</td>
160
- </tr>
161
- <tr>
162
- <td>3</td>
163
- <td>3</td>
164
- <td>2</td>
165
- </tr>
166
- </tbody>
167
- </table>
168
-
169
- <h3 id="the-rails-stuff-">The Rails Stuff 🚂</h3>
170
-
171
- <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>bin/rails g model Team name:string department:belongs_to
172
- <span class="nv">$ </span>bin/rails g model TeamMembership employee:belongs_to team:belongs_to
173
- <span class="nv">$ </span>bin/rails db:migrate</code></pre></figure>
174
-
175
- <p>Graphiti supports <code class="language-plaintext highlighter-rouge">has_many :through</code>:</p>
176
-
177
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/models/employee.rb</span>
178
- <span class="n">has_many</span> <span class="ss">:team_memberships</span>
179
- <span class="n">has_many</span> <span class="ss">:teams</span><span class="p">,</span> <span class="ss">through: :team_memberships</span></code></pre></figure>
180
-
181
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/models/department.rb</span>
182
- <span class="n">has_many</span> <span class="ss">:teams</span></code></pre></figure>
183
-
184
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">Team</span> <span class="o">&lt;</span> <span class="no">ApplicationRecord</span>
185
- <span class="n">belongs_to</span> <span class="ss">:department</span>
186
- <span class="n">has_many</span> <span class="ss">:team_memberships</span>
187
- <span class="n">has_many</span> <span class="ss">:employees</span><span class="p">,</span> <span class="ss">through: :team_memberships</span>
188
- <span class="k">end</span></code></pre></figure>
189
-
190
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">TeamMembership</span> <span class="o">&lt;</span> <span class="no">ApplicationRecord</span>
191
- <span class="n">belongs_to</span> <span class="ss">:team</span>
192
- <span class="n">belongs_to</span> <span class="ss">:employee</span>
193
- <span class="k">end</span></code></pre></figure>
194
-
195
- <p>Finally, we’ll need a new seed file to handle these new associations:</p>
196
-
197
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="p">[</span>
198
- <span class="no">Employee</span><span class="p">,</span>
199
- <span class="no">Position</span><span class="p">,</span>
200
- <span class="no">Department</span><span class="p">,</span>
201
- <span class="no">TeamMembership</span><span class="p">,</span>
202
- <span class="no">Team</span>
203
- <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>
204
-
205
- <span class="n">departments</span> <span class="o">=</span> <span class="p">[]</span>
206
- <span class="k">def</span> <span class="nf">create_department</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
207
- <span class="n">dept</span> <span class="o">=</span> <span class="no">Department</span><span class="p">.</span><span class="nf">create!</span> <span class="ss">name: </span><span class="nb">name</span>
208
- <span class="n">dept</span><span class="p">.</span><span class="nf">teams</span><span class="p">.</span><span class="nf">create!</span><span class="p">(</span><span class="ss">name: </span><span class="s1">'Engineering Team B'</span><span class="p">)</span>
209
- <span class="n">dept</span><span class="p">.</span><span class="nf">teams</span><span class="p">.</span><span class="nf">create!</span><span class="p">(</span><span class="ss">name: </span><span class="s1">'Engineering Team C'</span><span class="p">)</span>
210
- <span class="n">dept</span>
211
- <span class="k">end</span>
212
-
213
- <span class="n">departments</span> <span class="o">&lt;&lt;</span> <span class="n">create_department</span><span class="p">(</span><span class="s1">'Engineering'</span><span class="p">)</span>
214
- <span class="n">departments</span> <span class="o">&lt;&lt;</span> <span class="n">create_department</span><span class="p">(</span><span class="s1">'Safety'</span><span class="p">)</span>
215
- <span class="n">departments</span> <span class="o">&lt;&lt;</span> <span class="n">create_department</span><span class="p">(</span><span class="s1">'QA'</span><span class="p">)</span>
216
-
217
- <span class="mi">100</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
218
- <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>
219
- <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>
220
- <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>
221
-
222
- <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>
223
- <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>
224
- <span class="ss">historical_index: </span><span class="n">i</span><span class="p">,</span>
225
- <span class="ss">active: </span><span class="n">i</span> <span class="o">==</span> <span class="mi">1</span><span class="p">,</span>
226
- <span class="ss">department: </span><span class="n">departments</span><span class="p">.</span><span class="nf">sample</span>
227
- <span class="k">end</span>
228
-
229
- <span class="n">employee</span><span class="p">.</span><span class="nf">teams</span> <span class="o">&lt;&lt;</span> <span class="n">employee</span><span class="p">.</span><span class="nf">positions</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nf">department</span><span class="p">.</span><span class="nf">teams</span><span class="p">.</span><span class="nf">sample</span>
230
- <span class="k">end</span></code></pre></figure>
231
-
232
- <h3 id="the-graphiti-stuff-">The Graphiti Stuff 🎨</h3>
233
-
234
- <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>bin/rails g graphiti:resource Team name:string</code></pre></figure>
235
-
236
- <p>Let’s flesh out our <code class="language-plaintext highlighter-rouge">TeamResource</code>:</p>
237
-
238
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/resources/team_resource.rb</span>
239
- <span class="k">class</span> <span class="nc">TeamResource</span> <span class="o">&lt;</span> <span class="no">ApplicationResource</span>
240
- <span class="n">attribute</span> <span class="ss">:department_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">:filterable</span><span class="p">]</span>
241
- <span class="n">attribute</span> <span class="ss">:name</span><span class="p">,</span> <span class="ss">:string</span>
242
-
243
- <span class="n">belongs_to</span> <span class="ss">:department</span>
244
- <span class="n">many_to_many</span> <span class="ss">:employees</span>
245
- <span class="k">end</span></code></pre></figure>
246
-
247
- <p>The trick here is the <code class="language-plaintext highlighter-rouge">many_to_many</code> relationship. Let’s add the reverse
248
- as well:</p>
249
-
250
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/resources/employee_resource.rb</span>
251
- <span class="n">many_to_many</span> <span class="ss">:teams</span></code></pre></figure>
252
-
253
- <p>And for good measure:</p>
254
-
255
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/resources/department_resource.rb</span>
256
- <span class="n">has_many</span> <span class="ss">:teams</span></code></pre></figure>
257
-
258
- <p>We can now get all the usual functionality: fetch Employees and their
259
- Teams in a single request (or vice versa).</p>
260
-
261
- <h4 id="digging-deeper-">Digging Deeper 🧐</h4>
262
-
263
- <p>The <code class="language-plaintext highlighter-rouge">many_to_many</code> relationship is the only one where Graphiti modifies
264
- a separate Resource “under the hood”. When we said <code class="language-plaintext highlighter-rouge">many_to_many
265
- :employees</code>, the <code class="language-plaintext highlighter-rouge">EmployeeResource</code> got a <code class="language-plaintext highlighter-rouge">team_id</code> filter, and
266
- <code class="language-plaintext highlighter-rouge">many_to_many :teams</code> created an <code class="language-plaintext highlighter-rouge">employee_id</code> filter on <code class="language-plaintext highlighter-rouge">TeamResource</code>.</p>
267
-
268
- <p>This is because the logic is more complex than the default use case. We
269
- don’t have a simple <code class="language-plaintext highlighter-rouge">WHERE</code> clause; we need to join tables and look at
270
- the appropriate primary/foreign keys. If the name of your API
271
- association doesn’t match the name of your ActiveRecord association, try
272
- <code class="language-plaintext highlighter-rouge">has_many :things, as: :my_activerecord_relationship</code> to make the
273
- introspection work correctly - or, write your own filter.</p>
274
-
275
- <p>Sometimes you’ll have multiple levels of <code class="language-plaintext highlighter-rouge">has_many :through</code>. In this
276
- case, a simple <code class="language-plaintext highlighter-rouge">many_to_many</code> isn’t enough - check out our <a href="/1.13/cookbooks/hopping-relationships">Hopping
277
- Relationships</a> Cookbook.</p>
278
-
279
- <p>Think hard before reaching for <code class="language-plaintext highlighter-rouge">many_to_many</code>. Imagine one Team is the
280
- “primary” Team for an Employee. We’d add a <code class="language-plaintext highlighter-rouge">primary</code> boolean column to
281
- the <code class="language-plaintext highlighter-rouge">team_memberships</code> table…but that table isn’t exposed to the API!
282
- Consider if there’s a hidden domain concept there.</p>
283
-
284
- </div>
285
-
286
- <div class="clearfix">
287
- <h2 id="next">
288
- <a href="/1.13/tutorial/step_8">
289
- NEXT -
290
- <small>Step 8: Polymorphic Relationships</small>
291
- &raquo;
292
- </a>
293
- </h2>
294
- </div>
295
-
296
- </div>
297
- </div>
298
- </main>
299
- <div class="main-footer main-footer--dark">
300
- <div class="container">
301
- <div class="row">
302
- <div class="col-sm-4 menu">
303
- <h3>Overview</h3>
304
- <ul>
305
- <li>
306
- <a href="/1.13/quickstart">Quickstart</a>
307
- </li>
308
- <li>
309
- <a href="/1.13/tutorial">Tutorial</a>
310
- </li>
311
- <li>
312
- <a href="/1.13/guides">Guides</a>
313
- </li>
314
- </ul>
315
- </div>
316
- <div class="col-sm-4 menu">
317
- <h3>Contact</h3>
318
- <ul>
319
- <li>
320
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
321
- </li>
322
- <li>
323
- <a href="mailto:richmolj@gmail.com">Email</a>
324
- </li>
325
- </ul>
326
- </div>
327
- <div class="col-sm-4 menu">
328
- <h3>Related</h3>
329
- <ul>
330
- <li>
331
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
332
- </li>
333
- <li>
334
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
335
- </li>
336
- <li>
337
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
338
- </li>
339
- </ul>
340
- </div>
341
- </div>
342
- </div>
343
- </div>
344
-
345
- <script type="text/javascript">
346
- $(function () {
347
-
348
- var flipTabs = function() {
349
- var isTS = true;
350
- if (localStorage.getItem('js-lang') === 'javascript') {
351
- isTS = false;
352
- }
353
-
354
- $('.code-tabs').each(function(index, el) {
355
- if (isTS) {
356
- console.log('hiding js');
357
- $($(el).children()[1]).hide();
358
- $($(el).children()[0]).show();
359
- } else {
360
- console.log('hiding ts');
361
- $($(el).children()[0]).hide();
362
- $($(el).children()[1]).show();
363
- }
364
- });
365
-
366
- if (isTS) {
367
- $('.tab.typescript').addClass('active');
368
- $('.tab.javascript').removeClass('active');
369
- } else {
370
- $('.tab.typescript').removeClass('active');
371
- $('.tab.javascript').addClass('active');
372
- }
373
- }
374
-
375
- $('.tab').click(function() {
376
- if ($(this).hasClass('typescript')) {
377
- localStorage.setItem('js-lang', 'typescript');
378
- } else {
379
- localStorage.setItem('js-lang', 'javascript');
380
- }
381
-
382
- flipTabs();
383
- });
384
-
385
- flipTabs();
386
- })
387
- </script>
388
-
389
- </body>
390
- </html>