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
@@ -0,0 +1,323 @@
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-3-belongs-to">Step 3: Belongs To</h3>
103
+
104
+ <blockquote>
105
+ <p><a href="https://github.com/graphiti-api/employee_directory/compare/step_2_positions...step_3_departments">View the Diff</a></p>
106
+ </blockquote>
107
+
108
+ <p>We’ll be adding the database table <code class="language-plaintext highlighter-rouge">departments</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">name</th>
115
+ </tr>
116
+ </thead>
117
+ <tbody>
118
+ <tr>
119
+ <td>1</td>
120
+ <td>Engineering</td>
121
+ </tr>
122
+ <tr>
123
+ <td>2</td>
124
+ <td>Safety</td>
125
+ </tr>
126
+ <tr>
127
+ <td>3</td>
128
+ <td>QA</td>
129
+ </tr>
130
+ </tbody>
131
+ </table>
132
+
133
+ <p>We’ll also be adding a <code class="language-plaintext highlighter-rouge">department_id:integer</code> foreign key column to
134
+ the <code class="language-plaintext highlighter-rouge">positions</code> table.</p>
135
+
136
+ <h3 id="the-rails-stuff-">The Rails Stuff 🚂</h3>
137
+
138
+ <p>Generate the <code class="language-plaintext highlighter-rouge">Department</code> model:</p>
139
+
140
+ <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>bin/rails g model Department name:string</code></pre></figure>
141
+
142
+ <p>To add the foreign key to <code class="language-plaintext highlighter-rouge">positions</code>:</p>
143
+
144
+ <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>bin/rails g migration add_department_id_to_positions</code></pre></figure>
145
+
146
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">AddDepartmentIdToPositions</span> <span class="o">&lt;</span> <span class="no">ActiveRecord</span><span class="o">::</span><span class="no">Migration</span><span class="p">[</span><span class="mf">5.2</span><span class="p">]</span>
147
+ <span class="k">def</span> <span class="nf">change</span>
148
+ <span class="n">add_foreign_key</span> <span class="ss">:positions</span><span class="p">,</span> <span class="ss">:departments</span>
149
+ <span class="k">end</span>
150
+ <span class="k">end</span></code></pre></figure>
151
+
152
+ <p>Update the database:</p>
153
+
154
+ <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>bin/rails db:migrate</code></pre></figure>
155
+
156
+ <p>Update our seed file:</p>
157
+
158
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="p">[</span><span class="no">Employee</span><span class="p">,</span> <span class="no">Position</span><span class="p">,</span> <span class="no">Department</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>
159
+
160
+ <span class="n">engineering</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="s1">'Engineering'</span>
161
+ <span class="n">safety</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="s1">'Safety'</span>
162
+ <span class="n">qa</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="s1">'QA'</span>
163
+ <span class="n">departments</span> <span class="o">=</span> <span class="p">[</span><span class="n">engineering</span><span class="p">,</span> <span class="n">safety</span><span class="p">,</span> <span class="n">qa</span><span class="p">]</span>
164
+
165
+ <span class="mi">100</span><span class="p">.</span><span class="nf">times</span> <span class="k">do</span>
166
+ <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>
167
+ <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>
168
+ <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>
169
+
170
+ <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>
171
+ <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>
172
+ <span class="ss">historical_index: </span><span class="n">i</span><span class="p">,</span>
173
+ <span class="ss">active: </span><span class="n">i</span> <span class="o">==</span> <span class="mi">1</span><span class="p">,</span>
174
+ <span class="ss">department: </span><span class="n">departments</span><span class="p">.</span><span class="nf">sample</span>
175
+ <span class="k">end</span>
176
+ <span class="k">end</span></code></pre></figure>
177
+
178
+ <p>Make sure to update <code class="language-plaintext highlighter-rouge">spec/factories/departments.rb</code> with randomized
179
+ data. Then, since this is also a required relationship, update
180
+ <code class="language-plaintext highlighter-rouge">spec/factories/positions.rb</code> to always seed a department when we ask to
181
+ create a position:</p>
182
+
183
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">factory</span> <span class="ss">:position</span> <span class="k">do</span>
184
+ <span class="n">employee</span>
185
+ <span class="n">department</span>
186
+
187
+ <span class="c1"># ... code ...</span>
188
+ <span class="k">end</span></code></pre></figure>
189
+
190
+ <h3 id="the-graphiti-stuff-">The Graphiti Stuff 🎨</h3>
191
+
192
+ <p>You should be used to this by now:</p>
193
+
194
+ <figure class="highlight"><pre><code class="language-bash" data-lang="bash">bin/rails g graphiti:resource Department name:string</code></pre></figure>
195
+
196
+ <p>Add the association:</p>
197
+
198
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/resources/position_resource.rb</span>
199
+ <span class="n">belongs_to</span> <span class="ss">:department</span></code></pre></figure>
200
+
201
+ <p>And review the end of <a href="/1.13/tutorial/step_2">Step 2</a> to get all your specs
202
+ passing (add the department to the request payload). Practice makes perfect!</p>
203
+
204
+ <h4 id="digging-deeper-">Digging Deeper 🧐</h4>
205
+
206
+ <p>Note that we didn’t need a filter like we did in step two. That’s
207
+ because the primary key connecting the Resources is <code class="language-plaintext highlighter-rouge">id</code> by
208
+ default. In other words, the Link would be something like:</p>
209
+
210
+ <figure class="highlight"><pre><code class="language-bash" data-lang="bash">/departments?filter[id]<span class="o">=</span>1</code></pre></figure>
211
+
212
+ <p>Which we get out-of-the-📦</p>
213
+
214
+ <p>But remember, you can customize these relationships just like the
215
+ previous <code class="language-plaintext highlighter-rouge">has_many</code> section.</p>
216
+
217
+ </div>
218
+
219
+ <div class="clearfix">
220
+ <h2 id="next">
221
+ <a href="/1.13/tutorial/step_4">
222
+ NEXT -
223
+ <small>Step 4: Customizing Queries</small>
224
+ &raquo;
225
+ </a>
226
+ </h2>
227
+ </div>
228
+
229
+ </div>
230
+ </div>
231
+ </main>
232
+ <div class="main-footer main-footer--dark">
233
+ <div class="container">
234
+ <div class="row">
235
+ <div class="col-sm-4 menu">
236
+ <h3>Overview</h3>
237
+ <ul>
238
+ <li>
239
+ <a href="/1.13/quickstart">Quickstart</a>
240
+ </li>
241
+ <li>
242
+ <a href="/1.13/tutorial">Tutorial</a>
243
+ </li>
244
+ <li>
245
+ <a href="/1.13/guides">Guides</a>
246
+ </li>
247
+ </ul>
248
+ </div>
249
+ <div class="col-sm-4 menu">
250
+ <h3>Contact</h3>
251
+ <ul>
252
+ <li>
253
+ <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
254
+ </li>
255
+ <li>
256
+ <a href="mailto:richmolj@gmail.com">Email</a>
257
+ </li>
258
+ </ul>
259
+ </div>
260
+ <div class="col-sm-4 menu">
261
+ <h3>Related</h3>
262
+ <ul>
263
+ <li>
264
+ <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
265
+ </li>
266
+ <li>
267
+ <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
268
+ </li>
269
+ <li>
270
+ <a target="_blank" href="https://vuejs.org/">VueJS</a>
271
+ </li>
272
+ </ul>
273
+ </div>
274
+ </div>
275
+ </div>
276
+ </div>
277
+
278
+ <script type="text/javascript">
279
+ $(function () {
280
+
281
+ var flipTabs = function() {
282
+ var isTS = true;
283
+ if (localStorage.getItem('js-lang') === 'javascript') {
284
+ isTS = false;
285
+ }
286
+
287
+ $('.code-tabs').each(function(index, el) {
288
+ if (isTS) {
289
+ console.log('hiding js');
290
+ $($(el).children()[1]).hide();
291
+ $($(el).children()[0]).show();
292
+ } else {
293
+ console.log('hiding ts');
294
+ $($(el).children()[0]).hide();
295
+ $($(el).children()[1]).show();
296
+ }
297
+ });
298
+
299
+ if (isTS) {
300
+ $('.tab.typescript').addClass('active');
301
+ $('.tab.javascript').removeClass('active');
302
+ } else {
303
+ $('.tab.typescript').removeClass('active');
304
+ $('.tab.javascript').addClass('active');
305
+ }
306
+ }
307
+
308
+ $('.tab').click(function() {
309
+ if ($(this).hasClass('typescript')) {
310
+ localStorage.setItem('js-lang', 'typescript');
311
+ } else {
312
+ localStorage.setItem('js-lang', 'javascript');
313
+ }
314
+
315
+ flipTabs();
316
+ });
317
+
318
+ flipTabs();
319
+ })
320
+ </script>
321
+
322
+ </body>
323
+ </html>
@@ -0,0 +1,318 @@
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-4-customizing-queries">Step 4: Customizing Queries</h3>
103
+
104
+ <blockquote>
105
+ <p><a href="https://github.com/graphiti-api/employee_directory/compare/step_3_departments...step_4_customizations">View the Diff</a></p>
106
+ </blockquote>
107
+
108
+ <p>So far, we’ve done fairly straightforward queries. If a user filters on
109
+ <code class="language-plaintext highlighter-rouge">first_name</code>:</p>
110
+
111
+ <p><code class="language-plaintext highlighter-rouge">/api/v1/employees?filter[first_name]=Foo</code></p>
112
+
113
+ <p>We’ll query the equivalent database column:</p>
114
+
115
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="no">Employee</span><span class="p">.</span><span class="nf">where</span><span class="p">(</span><span class="ss">first_name: </span><span class="s1">'Foo'</span><span class="p">)</span></code></pre></figure>
116
+
117
+ <p>But what if there’s more complex logic? Let’s say we want to sort
118
+ Employees on their <code class="language-plaintext highlighter-rouge">title</code> - which comes from the <code class="language-plaintext highlighter-rouge">positions</code> table.
119
+ How would that work?</p>
120
+
121
+ <h3 id="the-rails-stuff-">The Rails Stuff 🚂</h3>
122
+
123
+ <p>First, we need to get data for an Employee’s <strong>current</strong> position.
124
+ Let’s start by defining what <code class="language-plaintext highlighter-rouge">current</code> means</p>
125
+
126
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/models/position.rb</span>
127
+ <span class="n">scope</span> <span class="ss">:current</span><span class="p">,</span> <span class="o">-&gt;</span> <span class="p">{</span> <span class="n">where</span><span class="p">(</span><span class="ss">historical_index: </span><span class="mi">1</span><span class="p">)</span> <span class="p">}</span></code></pre></figure>
128
+
129
+ <blockquote>
130
+ <p>See the <a href="https://guides.rubyonrails.org/active_record_querying.html#scopes">ActiveRecord Scopes</a> documentation if you’re unfamiliar with this concept.</p>
131
+ </blockquote>
132
+
133
+ <p>Reference this scope in a new association:</p>
134
+
135
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_one</span> <span class="ss">:current_position</span><span class="p">,</span>
136
+ <span class="o">-&gt;</span> <span class="p">{</span> <span class="n">current</span> <span class="p">},</span>
137
+ <span class="ss">class_name: </span><span class="s1">'Position'</span></code></pre></figure>
138
+
139
+ <p>Before moving on, let’s review what we need to do. The <code class="language-plaintext highlighter-rouge">ActiveRecord</code>
140
+ code for sorting Employees on their current position’s title would be:</p>
141
+
142
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="no">Employee</span><span class="p">.</span><span class="nf">joins</span><span class="p">(</span><span class="ss">:current_position</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">order</span><span class="p">(</span><span class="ss">title: :asc</span><span class="p">))</span></code></pre></figure>
143
+
144
+ <p>Let’s wire this up to Graphiti:</p>
145
+
146
+ <h3 id="the-graphiti-stuff-">The Graphiti Stuff 🎨</h3>
147
+
148
+ <p>We’re only going to <strong>sort</strong> and <strong>filter</strong> on the <code class="language-plaintext highlighter-rouge">title</code> attribute -
149
+ never display or persist. So start by defining the attribute as such:</p>
150
+
151
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">attribute</span> <span class="ss">:title</span><span class="p">,</span> <span class="ss">:string</span><span class="p">,</span> <span class="ss">only: </span><span class="p">[</span><span class="ss">:filterable</span><span class="p">,</span> <span class="ss">:sortable</span><span class="p">]</span></code></pre></figure>
152
+
153
+ <p>Then the <code class="language-plaintext highlighter-rouge">sort</code> DSL to place our custom query:</p>
154
+
155
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/resources/employee_resource.rb</span>
156
+ <span class="n">sort</span> <span class="ss">:title</span> <span class="k">do</span> <span class="o">|</span><span class="n">scope</span><span class="p">,</span> <span class="n">direction</span><span class="o">|</span>
157
+ <span class="n">scope</span><span class="p">.</span><span class="nf">joins</span><span class="p">(</span><span class="ss">:current_position</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">order</span><span class="p">(</span><span class="ss">title: </span><span class="n">direction</span><span class="p">))</span>
158
+ <span class="k">end</span></code></pre></figure>
159
+
160
+ <p>That’s it! When a request to sort on the title comes in, we’ll alter our
161
+ scope to join on the <code class="language-plaintext highlighter-rouge">positions</code> table, and order based on the current
162
+ position <code class="language-plaintext highlighter-rouge">title</code>.</p>
163
+
164
+ <p>The solution for filtering is similar:</p>
165
+
166
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/resources/employee_resource.rb</span>
167
+ <span class="n">filter</span> <span class="ss">:title</span> <span class="k">do</span>
168
+ <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>
169
+ <span class="n">scope</span><span class="p">.</span><span class="nf">joins</span><span class="p">(</span><span class="ss">:current_position</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">title: </span><span class="n">value</span><span class="p">))</span>
170
+ <span class="k">end</span>
171
+ <span class="k">end</span></code></pre></figure>
172
+
173
+ <p>We can now filter on title:</p>
174
+
175
+ <p><code class="language-plaintext highlighter-rouge">/api/v1/employees?filter[title]=Foo</code></p>
176
+
177
+ <p>Let’s do one more example - how would we order Employees by department
178
+ name? We <em>could</em> start the same way:</p>
179
+
180
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">attribute</span> <span class="ss">:department_name</span><span class="p">,</span> <span class="ss">:string</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>
181
+
182
+ <p>But if we’re <strong><em>only</em></strong> sorting, this is actually redundant. Whenever we
183
+ use the <code class="language-plaintext highlighter-rouge">sort</code> or <code class="language-plaintext highlighter-rouge">filter</code> DSL, we’re just creating a sort-only or
184
+ filter-only attribute under the hood. So let’s define everything in one
185
+ shot:</p>
186
+
187
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">sort</span> <span class="ss">:department_name</span><span class="p">,</span> <span class="ss">:string</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>
188
+ <span class="n">scope</span><span class="p">.</span><span class="nf">joins</span><span class="p">(</span><span class="ss">current_position: :department</span><span class="p">)</span>
189
+ <span class="p">.</span><span class="nf">merge</span><span class="p">(</span><span class="no">Department</span><span class="p">.</span><span class="nf">order</span><span class="p">(</span><span class="ss">name: </span><span class="n">value</span><span class="p">))</span>
190
+ <span class="k">end</span></code></pre></figure>
191
+
192
+ <p>Remember: you only need to pass the type as the second argument when an
193
+ attribute doesn’t already exist. And if you ever get an error saying
194
+ something is unfilterable or unsortable, check to see if you’ve already
195
+ defined a filter-only or sort-only attribute using these methods.</p>
196
+
197
+ <h4 id="digging-deeper-">Digging Deeper 🧐</h4>
198
+
199
+ <p>There’s a critical part of Graphiti that makes everything easier: start
200
+ by imagining it doesn’t exist.</p>
201
+
202
+ <p>In other words, the meat of the logic above had nothing to do with
203
+ Graphiti code - we’re simply “wiring up” independent ActiveRecord
204
+ queries. If you’re ever confused about query logic, get things working
205
+ without Graphiti first.</p>
206
+
207
+ <p>We could have changed the above to ActiveRecord scopes like
208
+ <code class="language-plaintext highlighter-rouge">.order_by_title(title)</code>, making the wiring code even simpler. Consider
209
+ doing this when the logic is reusable or particlar complex, but be aware
210
+ of the tradeoffs of <a href="/1.13/guides/concepts/testing#double-testing-units">double-testing units</a>.</p>
211
+
212
+ </div>
213
+
214
+ <div class="clearfix">
215
+ <h2 id="next">
216
+ <a href="/1.13/tutorial/step_5">
217
+ NEXT -
218
+ <small>Step 5: Has One</small>
219
+ &raquo;
220
+ </a>
221
+ </h2>
222
+ </div>
223
+
224
+ </div>
225
+ </div>
226
+ </main>
227
+ <div class="main-footer main-footer--dark">
228
+ <div class="container">
229
+ <div class="row">
230
+ <div class="col-sm-4 menu">
231
+ <h3>Overview</h3>
232
+ <ul>
233
+ <li>
234
+ <a href="/1.13/quickstart">Quickstart</a>
235
+ </li>
236
+ <li>
237
+ <a href="/1.13/tutorial">Tutorial</a>
238
+ </li>
239
+ <li>
240
+ <a href="/1.13/guides">Guides</a>
241
+ </li>
242
+ </ul>
243
+ </div>
244
+ <div class="col-sm-4 menu">
245
+ <h3>Contact</h3>
246
+ <ul>
247
+ <li>
248
+ <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
249
+ </li>
250
+ <li>
251
+ <a href="mailto:richmolj@gmail.com">Email</a>
252
+ </li>
253
+ </ul>
254
+ </div>
255
+ <div class="col-sm-4 menu">
256
+ <h3>Related</h3>
257
+ <ul>
258
+ <li>
259
+ <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
260
+ </li>
261
+ <li>
262
+ <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
263
+ </li>
264
+ <li>
265
+ <a target="_blank" href="https://vuejs.org/">VueJS</a>
266
+ </li>
267
+ </ul>
268
+ </div>
269
+ </div>
270
+ </div>
271
+ </div>
272
+
273
+ <script type="text/javascript">
274
+ $(function () {
275
+
276
+ var flipTabs = function() {
277
+ var isTS = true;
278
+ if (localStorage.getItem('js-lang') === 'javascript') {
279
+ isTS = false;
280
+ }
281
+
282
+ $('.code-tabs').each(function(index, el) {
283
+ if (isTS) {
284
+ console.log('hiding js');
285
+ $($(el).children()[1]).hide();
286
+ $($(el).children()[0]).show();
287
+ } else {
288
+ console.log('hiding ts');
289
+ $($(el).children()[0]).hide();
290
+ $($(el).children()[1]).show();
291
+ }
292
+ });
293
+
294
+ if (isTS) {
295
+ $('.tab.typescript').addClass('active');
296
+ $('.tab.javascript').removeClass('active');
297
+ } else {
298
+ $('.tab.typescript').removeClass('active');
299
+ $('.tab.javascript').addClass('active');
300
+ }
301
+ }
302
+
303
+ $('.tab').click(function() {
304
+ if ($(this).hasClass('typescript')) {
305
+ localStorage.setItem('js-lang', 'typescript');
306
+ } else {
307
+ localStorage.setItem('js-lang', 'javascript');
308
+ }
309
+
310
+ flipTabs();
311
+ });
312
+
313
+ flipTabs();
314
+ })
315
+ </script>
316
+
317
+ </body>
318
+ </html>