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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (246) hide show
  1. checksums.yaml +4 -4
  2. data/.git-blame-ignore-revs +2 -0
  3. data/.github/workflows/ci.yml +55 -3
  4. data/.github/workflows/docs.yml +1 -1
  5. data/.github/workflows/notify-example-app.yml +18 -0
  6. data/.gitignore +2 -0
  7. data/.standard.yml +6 -0
  8. data/CHANGELOG.md +54 -0
  9. data/CONTRIBUTING.md +3 -1
  10. data/README.md +13 -206
  11. data/Rakefile +6 -3
  12. data/UPGRADING.md +1 -1
  13. data/graphiti.gemspec +8 -4
  14. data/lib/generators/graphiti/generator_mixin.rb +1 -1
  15. data/lib/generators/graphiti/install_generator.rb +1 -2
  16. data/lib/generators/graphiti/resource_generator.rb +6 -3
  17. data/lib/generators/graphiti/templates/application_resource.rb.erb +19 -0
  18. data/lib/generators/graphiti/templates/controller.rb.erb +26 -8
  19. data/lib/generators/graphiti/templates/index_request_spec.rb.erb +2 -2
  20. data/lib/generators/graphiti/templates/resource_reads_spec.rb.erb +4 -4
  21. data/lib/generators/graphiti/templates/show_request_spec.rb.erb +2 -2
  22. data/lib/graphiti/audit/report.rb +6 -6
  23. data/lib/graphiti/audit.rb +3 -4
  24. data/lib/graphiti/delegates/pagination.rb +2 -2
  25. data/lib/graphiti/deserializer.rb +3 -3
  26. data/lib/graphiti/errors.rb +6 -6
  27. data/lib/graphiti/extensions/temp_id.rb +1 -1
  28. data/lib/graphiti/query.rb +27 -8
  29. data/lib/graphiti/rails/context.rb +2 -1
  30. data/lib/graphiti/rails/controller.rb +3 -0
  31. data/lib/graphiti/rails/debugging.rb +1 -1
  32. data/lib/graphiti/rails/responders.rb +2 -1
  33. data/lib/graphiti/resource/configuration.rb +1 -0
  34. data/lib/graphiti/resource/dsl.rb +2 -2
  35. data/lib/graphiti/resource/interface.rb +3 -3
  36. data/lib/graphiti/resource/links.rb +1 -1
  37. data/lib/graphiti/resource/persistence.rb +1 -1
  38. data/lib/graphiti/resource/polymorphism.rb +1 -1
  39. data/lib/graphiti/resource.rb +2 -2
  40. data/lib/graphiti/resource_proxy.rb +0 -1
  41. data/lib/graphiti/runner.rb +8 -3
  42. data/lib/graphiti/scope.rb +13 -0
  43. data/lib/graphiti/scoping/filter.rb +5 -3
  44. data/lib/graphiti/scoping/paginate.rb +1 -1
  45. data/lib/graphiti/scoping/sort.rb +1 -1
  46. data/lib/graphiti/sideload/has_many.rb +1 -1
  47. data/lib/graphiti/spec_helpers/errors_proxy.rb +1 -1
  48. data/lib/graphiti/spec_helpers/matchers.rb +1 -1
  49. data/lib/graphiti/spec_helpers.rb +5 -0
  50. data/lib/graphiti/types.rb +5 -1
  51. data/lib/graphiti/util/cache_debug.rb +3 -3
  52. data/lib/graphiti/util/hash.rb +1 -1
  53. data/lib/graphiti/util/persistence.rb +6 -6
  54. data/lib/graphiti/util/serializer_relationships.rb +1 -1
  55. data/lib/graphiti/version.rb +1 -1
  56. data/lib/tasks/graphiti.rake +1 -1
  57. data/package.json +1 -0
  58. metadata +31 -197
  59. data/docs/concepts/backends-and-models.md +0 -122
  60. data/docs/concepts/endpoints.md +0 -183
  61. data/docs/concepts/links.md +0 -212
  62. data/docs/concepts/overview.md +0 -80
  63. data/docs/concepts/persisting.md +0 -376
  64. data/docs/concepts/relationships.md +0 -627
  65. data/docs/concepts/resources.md +0 -677
  66. data/docs/getting-started/first-api.md +0 -289
  67. data/docs/getting-started/installation.md +0 -185
  68. data/docs/intro.md +0 -307
  69. data/docs/js/authentication.md +0 -63
  70. data/docs/js/ddau.md +0 -20
  71. data/docs/js/extra-params.md +0 -41
  72. data/docs/js/index.md +0 -112
  73. data/docs/js/installation.md +0 -120
  74. data/docs/js/middleware.md +0 -72
  75. data/docs/js/models.md +0 -202
  76. data/docs/js/reads.md +0 -494
  77. data/docs/js/state-syncing.md +0 -100
  78. data/docs/js/writes.md +0 -373
  79. data/docs/reference/vandal.md +0 -63
  80. data/docs/reference/why.md +0 -13
  81. data/docs/topics/authorization.md +0 -155
  82. data/docs/topics/caching.md +0 -55
  83. data/docs/topics/customizing-sideloads.md +0 -156
  84. data/docs/topics/debugging.md +0 -242
  85. data/docs/topics/error-handling.md +0 -210
  86. data/docs/topics/etags.md +0 -46
  87. data/docs/topics/hopping-relationships.md +0 -149
  88. data/docs/topics/json-attributes.md +0 -77
  89. data/docs/topics/openstruct-models.md +0 -50
  90. data/docs/topics/remote-resources.md +0 -291
  91. data/docs/topics/testing.md +0 -894
  92. data/docs/topics/without-activerecord.md +0 -324
  93. data/docs/tutorial/index.md +0 -58
  94. data/docs/tutorial/step_0.md +0 -107
  95. data/docs/tutorial/step_1.md +0 -199
  96. data/docs/tutorial/step_2.md +0 -312
  97. data/docs/tutorial/step_3.md +0 -142
  98. data/docs/tutorial/step_4.md +0 -135
  99. data/docs/tutorial/step_5.md +0 -69
  100. data/docs/tutorial/step_6.md +0 -82
  101. data/docs/tutorial/step_7.md +0 -205
  102. data/docs/tutorial/step_8.md +0 -128
  103. data/docs/tutorial/step_9.md +0 -171
  104. data/docs/upgrading.md +0 -266
  105. data/website/.gitignore +0 -20
  106. data/website/README.md +0 -43
  107. data/website/docusaurus.config.js +0 -197
  108. data/website/package-lock.json +0 -19474
  109. data/website/package.json +0 -46
  110. data/website/sidebars.js +0 -82
  111. data/website/src/css/custom.css +0 -85
  112. data/website/src/pages/markdown-page.mdx +0 -7
  113. data/website/static/.nojekyll +0 -0
  114. data/website/static/1.13/2019/03/31/graphiti-1-0.html +0 -205
  115. data/website/static/1.13/2019/05/08/graphiti-1-1.html +0 -212
  116. data/website/static/1.13/2019/05/20/graphiti-1-2.html +0 -214
  117. data/website/static/1.13/2019/10/14/tutorial.html +0 -198
  118. data/website/static/1.13/CNAME +0 -1
  119. data/website/static/1.13/README.md +0 -16
  120. data/website/static/1.13/assets/css/syntax.css +0 -60
  121. data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
  122. data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
  123. data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
  124. data/website/static/1.13/assets/favicons/browserconfig.xml +0 -9
  125. data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
  126. data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
  127. data/website/static/1.13/assets/favicons/favicon.ico +0 -0
  128. data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
  129. data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +0 -1
  130. data/website/static/1.13/assets/favicons/site.webmanifest +0 -19
  131. data/website/static/1.13/assets/img/backend.gif +0 -0
  132. data/website/static/1.13/assets/img/conformity.png +0 -0
  133. data/website/static/1.13/assets/img/error_payload.png +0 -0
  134. data/website/static/1.13/assets/img/fancy-cushion.png +0 -0
  135. data/website/static/1.13/assets/img/gh.png +0 -0
  136. data/website/static/1.13/assets/img/home-bg.jpg +0 -0
  137. data/website/static/1.13/assets/img/lifecycle.gif +0 -0
  138. data/website/static/1.13/assets/img/logo-500.png +0 -0
  139. data/website/static/1.13/assets/img/logo.png +0 -0
  140. data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
  141. data/website/static/1.13/assets/img/meta_total_count.png +0 -0
  142. data/website/static/1.13/assets/img/persist.jpg +0 -0
  143. data/website/static/1.13/assets/img/resource.gif +0 -0
  144. data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
  145. data/website/static/1.13/assets/img/rest1.gif +0 -0
  146. data/website/static/1.13/assets/img/rest2.gif +0 -0
  147. data/website/static/1.13/assets/img/rest3.gif +0 -0
  148. data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
  149. data/website/static/1.13/assets/img/sunrise.png +0 -0
  150. data/website/static/1.13/assets/img/why.png +0 -0
  151. data/website/static/1.13/assets/js/highlight.pack.js +0 -2
  152. data/website/static/1.13/assets/main.css +0 -15518
  153. data/website/static/1.13/assets/main.css.map +0 -1
  154. data/website/static/1.13/bin/bundle +0 -109
  155. data/website/static/1.13/bin/jekyll +0 -27
  156. data/website/static/1.13/bin/kramdown +0 -27
  157. data/website/static/1.13/bin/listen +0 -27
  158. data/website/static/1.13/bin/rake +0 -27
  159. data/website/static/1.13/bin/rougify +0 -27
  160. data/website/static/1.13/bin/safe_yaml +0 -27
  161. data/website/static/1.13/bin/sass +0 -27
  162. data/website/static/1.13/bin/sass-convert +0 -27
  163. data/website/static/1.13/bin/scss +0 -27
  164. data/website/static/1.13/blog.html +0 -259
  165. data/website/static/1.13/cheatsheet.html +0 -316
  166. data/website/static/1.13/cookbooks/authorization.md +0 -0
  167. data/website/static/1.13/cookbooks/caching.md +0 -0
  168. data/website/static/1.13/cookbooks/customizing-sideloads.html +0 -325
  169. data/website/static/1.13/cookbooks/etags.md +0 -0
  170. data/website/static/1.13/cookbooks/hopping-relationships.html +0 -324
  171. data/website/static/1.13/cookbooks/json_attributes.md +0 -0
  172. data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
  173. data/website/static/1.13/cookbooks/remote-resources.md +0 -0
  174. data/website/static/1.13/cookbooks/without-activerecord.html +0 -510
  175. data/website/static/1.13/features.html +0 -249
  176. data/website/static/1.13/feed.xml +0 -106
  177. data/website/static/1.13/guides/concepts/backends-and-models.html +0 -467
  178. data/website/static/1.13/guides/concepts/debugging.html +0 -440
  179. data/website/static/1.13/guides/concepts/endpoints.html +0 -432
  180. data/website/static/1.13/guides/concepts/error-handling.html +0 -396
  181. data/website/static/1.13/guides/concepts/links.html +0 -501
  182. data/website/static/1.13/guides/concepts/remote-resources.html +0 -536
  183. data/website/static/1.13/guides/concepts/resources.html +0 -2176
  184. data/website/static/1.13/guides/concepts/testing.html +0 -1469
  185. data/website/static/1.13/guides/getting-started/installation.html +0 -420
  186. data/website/static/1.13/guides/graphiti-rails-migration.html +0 -242
  187. data/website/static/1.13/guides/index.html +0 -269
  188. data/website/static/1.13/guides/overview.html +0 -325
  189. data/website/static/1.13/guides/upgrading-2-0.html +0 -193
  190. data/website/static/1.13/guides/upgrading.html +0 -314
  191. data/website/static/1.13/guides/vandal.html +0 -282
  192. data/website/static/1.13/guides/why.html +0 -1121
  193. data/website/static/1.13/index.html +0 -72
  194. data/website/static/1.13/js/authentication.html +0 -295
  195. data/website/static/1.13/js/ddau.html +0 -238
  196. data/website/static/1.13/js/extra-params.html +0 -270
  197. data/website/static/1.13/js/index.html +0 -321
  198. data/website/static/1.13/js/installation.html +0 -637
  199. data/website/static/1.13/js/introduction.html +0 -257
  200. data/website/static/1.13/js/middleware.html +0 -318
  201. data/website/static/1.13/js/reads/fieldsets.html +0 -271
  202. data/website/static/1.13/js/reads/filtering.html +0 -289
  203. data/website/static/1.13/js/reads/includes.html +0 -260
  204. data/website/static/1.13/js/reads/index.html +0 -497
  205. data/website/static/1.13/js/reads/nested-queries.html +0 -353
  206. data/website/static/1.13/js/reads/pagination.html +0 -260
  207. data/website/static/1.13/js/reads/sorting.html +0 -265
  208. data/website/static/1.13/js/reads/statistics.html +0 -289
  209. data/website/static/1.13/js/state-syncing.html +0 -340
  210. data/website/static/1.13/js/writes/deferred.html +0 -296
  211. data/website/static/1.13/js/writes/dirty-tracking.html +0 -399
  212. data/website/static/1.13/js/writes/index.html +0 -391
  213. data/website/static/1.13/js/writes/nested.html +0 -330
  214. data/website/static/1.13/js/writes/validations.html +0 -272
  215. data/website/static/1.13/quickstart.html +0 -660
  216. data/website/static/1.13/template +0 -161
  217. data/website/static/1.13/tutorial/index.html +0 -250
  218. data/website/static/1.13/tutorial/step_0.html +0 -292
  219. data/website/static/1.13/tutorial/step_1.html +0 -517
  220. data/website/static/1.13/tutorial/step_2.html +0 -481
  221. data/website/static/1.13/tutorial/step_3.html +0 -323
  222. data/website/static/1.13/tutorial/step_4.html +0 -318
  223. data/website/static/1.13/tutorial/step_5.html +0 -265
  224. data/website/static/1.13/tutorial/step_6.html +0 -276
  225. data/website/static/1.13/tutorial/step_7.html +0 -390
  226. data/website/static/1.13/tutorial/step_8.html +0 -316
  227. data/website/static/1.13/tutorial/step_9.html +0 -365
  228. data/website/static/CNAME +0 -1
  229. data/website/static/assets/img/error_payload.png +0 -0
  230. data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
  231. data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
  232. data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
  233. data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
  234. data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
  235. data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
  236. data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
  237. data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
  238. data/website/static/assets/img/meta_total_count.png +0 -0
  239. data/website/static/img/docusaurus-social-card.jpg +0 -0
  240. data/website/static/img/docusaurus.png +0 -0
  241. data/website/static/img/favicon.ico +0 -0
  242. data/website/static/img/logo.png +0 -0
  243. data/website/static/img/logo.svg +0 -1
  244. data/website/static/img/undraw_docusaurus_mountain.svg +0 -171
  245. data/website/static/img/undraw_docusaurus_react.svg +0 -170
  246. data/website/static/img/undraw_docusaurus_tree.svg +0 -40
data/website/static/1.13/guides/concepts/backends-and-models.html DELETED
@@ -1,467 +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="backends-and-models">Backends and Models</h1>
85
-
86
- <ul>
87
- <li>1 <a href="#overview">Overview</a>
88
- <ul>
89
- <li><a href="#activerecord">ActiveRecord</a></li>
90
- <li><a href="#model-requirements">Model Requirements</a></li>
91
- <li><a href="#validations">Validations</a></li>
92
- </ul>
93
- </li>
94
- <li>2 <a href="#model-implementations">Model Implementations</a>
95
- <ul>
96
- <li><a href="#poro">PORO</a></li>
97
- <li><a href="#activemodel-model">ActiveModel::Model</a></li>
98
- <li><a href="#dry-struct">Dry::Struct</a></li>
99
- </ul>
100
- </li>
101
- <li>3 <a href="#model-tips">Model Tips</a>
102
- <ul>
103
- <li><a href="#id-less-models">ID-less Models</a></li>
104
- </ul>
105
- </li>
106
- </ul>
107
- </div>
108
-
109
- <div class="col-md-8">
110
-
111
- <a class="anchor" id="overview" />
112
- <a class="header" href="#overview">
113
- <h2>
114
- Overview
115
- </h2>
116
- </a>
117
-
118
- <p>A Resource <em>queries</em> and <em>persists</em> to a <strong>Backend</strong>. It returns
119
- <strong>Models</strong> from the Backend response, which get <em>serialized</em>. In this way, it is
120
- an implementation of the <a href="https://martinfowler.com/eaaCatalog/repository.html">Repository Pattern</a>.</p>
121
-
122
- <p>This is best illustrated in code. Let’s say we have a Backend class
123
- that accepts a hash of options to perform a query:</p>
124
-
125
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">results</span> <span class="o">=</span> <span class="no">Backend</span><span class="p">.</span><span class="nf">query</span> <span class="p">\</span>
126
- <span class="ss">conditions: </span><span class="p">{</span> <span class="ss">name: </span><span class="s1">'Jane'</span> <span class="p">},</span>
127
- <span class="ss">sort: </span><span class="p">{</span> <span class="ss">created_at: :asc</span> <span class="p">}</span>
128
-
129
- <span class="n">results</span> <span class="c1"># [{ id: 1, name: 'Jane', rank: 83 }, ...]</span></code></pre></figure>
130
-
131
- <p>And a PORO Model that encapsulates those results, holding business logic:</p>
132
-
133
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">Employee</span>
134
- <span class="nb">attr_accessor</span> <span class="ss">:id</span><span class="p">,</span> <span class="ss">:name</span><span class="p">,</span> <span class="ss">:rank</span>
135
-
136
- <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">attrs</span> <span class="o">=</span> <span class="p">{})</span>
137
- <span class="n">attrs</span><span class="p">.</span><span class="nf">each_pair</span> <span class="p">{</span> <span class="o">|</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="o">|</span> <span class="nb">send</span><span class="p">(</span><span class="ss">:"</span><span class="si">#{</span><span class="n">k</span><span class="si">}</span><span class="ss">="</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="p">}</span>
138
- <span class="k">end</span>
139
-
140
- <span class="k">def</span> <span class="nf">exemplary?</span>
141
- <span class="n">rank</span> <span class="o">&gt;</span> <span class="mi">80</span>
142
- <span class="k">end</span>
143
- <span class="k">end</span></code></pre></figure>
144
-
145
- <p>Meaning that normally, our code would look something like:</p>
146
-
147
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">results</span> <span class="o">=</span> <span class="no">Backend</span><span class="p">.</span><span class="nf">query</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
148
- <span class="n">employees</span> <span class="o">=</span> <span class="n">results</span><span class="p">.</span><span class="nf">map</span> <span class="p">{</span> <span class="o">|</span><span class="n">r</span><span class="o">|</span> <span class="no">Employee</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">r</span><span class="p">)</span> <span class="p">}</span>
149
- <span class="n">employees</span><span class="p">.</span><span class="nf">map</span><span class="p">(</span><span class="o">&amp;</span><span class="ss">:exemplary?</span><span class="p">)</span> <span class="c1"># =&gt; [true, false, ...]</span></code></pre></figure>
150
-
151
- <p>Let’s wire-up that same code to a Resource:</p>
152
-
153
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">EmployeeResource</span> <span class="o">&lt;</span> <span class="no">ApplicationResource</span>
154
- <span class="c1"># We'll be coding the logic manually</span>
155
- <span class="nb">self</span><span class="p">.</span><span class="nf">adapter</span> <span class="o">=</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Adapters</span><span class="o">::</span><span class="no">Null</span>
156
-
157
- <span class="n">attribute</span> <span class="ss">:name</span><span class="p">,</span> <span class="ss">:string</span>
158
-
159
- <span class="c1"># The blank scope we start with</span>
160
- <span class="k">def</span> <span class="nf">base_scope</span>
161
- <span class="p">{</span> <span class="ss">conditions: </span><span class="p">{},</span> <span class="ss">sort: </span><span class="p">{}</span> <span class="p">}</span>
162
- <span class="k">end</span>
163
-
164
- <span class="c1"># Merge filters into the hash based on request params</span>
165
- <span class="n">filter</span> <span class="ss">:name</span> <span class="k">do</span>
166
- <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>
167
- <span class="n">scope</span><span class="p">[</span><span class="ss">:conditions</span><span class="p">].</span><span class="nf">merge!</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
168
- <span class="n">scope</span>
169
- <span class="k">end</span>
170
- <span class="k">end</span>
171
-
172
- <span class="c1"># Set sort based on request params</span>
173
- <span class="n">sort</span> <span class="ss">:name</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>
174
- <span class="n">scope</span><span class="p">[</span><span class="ss">:sort</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span> <span class="ss">name: </span><span class="n">direction</span> <span class="p">}</span>
175
- <span class="n">scope</span>
176
- <span class="k">end</span>
177
-
178
- <span class="c1"># 'scope' here is our hash</span>
179
- <span class="c1"># We pass it to Backend.query, and return Models</span>
180
- <span class="k">def</span> <span class="nf">resolve</span><span class="p">(</span><span class="n">scope</span><span class="p">)</span>
181
- <span class="n">results</span> <span class="o">=</span> <span class="no">Backend</span><span class="p">.</span><span class="nf">query</span><span class="p">(</span><span class="n">scope</span><span class="p">)</span>
182
- <span class="n">results</span><span class="p">.</span><span class="nf">map</span> <span class="p">{</span> <span class="o">|</span><span class="n">r</span><span class="o">|</span> <span class="no">Employee</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">r</span><span class="p">)</span> <span class="p">}</span>
183
- <span class="k">end</span>
184
- <span class="k">end</span></code></pre></figure>
185
-
186
- <p>As you see above, a <strong>scope</strong> can be anything from an
187
- <code class="language-plaintext highlighter-rouge">ActiveRecord::Relation</code> to a plain Ruby Hash. We want to adjust
188
- <em>something</em> based on the request parameters and pass it to our backend.
189
- From the raw backend results, we can instantiate Models. <strong>Note that we
190
- always return the full scope at the end of each block.</strong></p>
191
-
192
- <p>Of course, most Backends have predictable and consistent interfaces. It
193
- would be a pain to manually write this code for every Resource. So
194
- instead we could build an <strong>Adapter</strong> to DRY this logic:</p>
195
-
196
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">EmployeeResource</span> <span class="o">&lt;</span> <span class="no">ApplicationResource</span>
197
- <span class="nb">self</span><span class="p">.</span><span class="nf">adapter</span> <span class="o">=</span> <span class="no">BackendAdapter</span>
198
- <span class="n">attribute</span> <span class="ss">:name</span><span class="p">,</span> <span class="ss">:string</span>
199
- <span class="k">end</span></code></pre></figure>
200
-
201
- <p>In summary: a Resource builds a query that is sent to a Backend. The
202
- backend executes the query, and we instantiate Models from the raw
203
- results.</p>
204
-
205
- <a class="anchor" id="activerecord" />
206
- <a class="header" href="#activerecord">
207
- <h3>
208
- ActiveRecord
209
- </h3>
210
- </a>
211
-
212
- <p>From the <a href="https://guides.rubyonrails.org/active_record_basics.html#the-active-record-pattern">ActiveRecord Guides</a>:</p>
213
-
214
- <blockquote>
215
- <p><em><a href="https://www.martinfowler.com/eaaCatalog/activeRecord.html">Active Record was described by Martin Fowler</a> in his book Patterns of Enterprise Application Architecture. In Active Record, objects carry both persistent data and behavior which operates on that data. Active Record takes the opinion that ensuring data access logic as part of the object will educate users of that object on how to write to and read from the database.</em></p>
216
- </blockquote>
217
-
218
- <p>In other words, ActiveRecord <strong>combines</strong> a Backend and Model.
219
- Opinions on this <a href="https://blog.lelonek.me/why-is-your-rails-application-still-coupled-to-activerecord-efe34d657c91">vary</a>,
220
- but Graphiti supports either approach: we can separate data and business layers, or
221
- combine them. See the ActiveRecord doppelgänger of the above at our
222
- <a href="/1.13/cheatsheet">Resource cheatsheet</a>.</p>
223
-
224
- <a class="anchor" id="model-requirements" />
225
- <a class="header" href="#model-requirements">
226
- <h3>
227
- Model Requirements
228
- </h3>
229
- </a>
230
-
231
- <p>The only hard requirement of a Model is that it responds to <code class="language-plaintext highlighter-rouge">id</code>. We use
232
- <code class="language-plaintext highlighter-rouge">model.id</code> to determine uniqueness when rendering a JSONAPI response.
233
- <strong>You will get incorrect results if <code class="language-plaintext highlighter-rouge">model.id</code> is not unique</strong>.</p>
234
-
235
- <p>Models should also respond to any readable attributes. Remember that:</p>
236
-
237
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">attribute</span> <span class="ss">:name</span><span class="p">,</span> <span class="ss">:string</span></code></pre></figure>
238
-
239
- <p>Is the same as</p>
240
-
241
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># @object is your Model instance</span>
242
- <span class="n">attribute</span> <span class="ss">:name</span><span class="p">,</span> <span class="ss">:string</span> <span class="k">do</span>
243
- <span class="vi">@object</span><span class="p">.</span><span class="nf">name</span>
244
- <span class="k">end</span></code></pre></figure>
245
-
246
- <p>If your Model does not respond to <code class="language-plaintext highlighter-rouge">#name</code>, either pass a block to <code class="language-plaintext highlighter-rouge">attribute</code> or
247
- look into <a href="https://blog.bigbinary.com/2012/01/08/alias-vs-alias-method.html">aliasing</a>.</p>
248
-
249
- <a class="anchor" id="validations" />
250
- <a class="header" href="#validations">
251
- <h4>
252
- Validations
253
- </h4>
254
- </a>
255
-
256
- <p>Graphiti will perform validations on your models during write requests,
257
- returning a <a href="http://jsonapi.org/format/#errors">JSONAPI-compliant errors payload</a>.
258
- To get this functionality, your model must adhere to the
259
- <a href="https://api.rubyonrails.org/classes/ActiveModel/Validations.html">ActiveModel::Validations API</a>:</p>
260
-
261
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">model</span><span class="p">.</span><span class="nf">valid?</span>
262
- <span class="n">object</span><span class="p">.</span><span class="nf">errors</span><span class="p">.</span><span class="nf">messages</span><span class="p">.</span><span class="nf">each_pair</span> <span class="p">{</span> <span class="o">...</span> <span class="p">}</span></code></pre></figure>
263
-
264
- <p>It is highly recommended to mix in:</p>
265
-
266
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">Employee</span>
267
- <span class="kp">include</span> <span class="no">ActiveModel</span><span class="o">::</span><span class="no">Validations</span>
268
- <span class="k">end</span></code></pre></figure>
269
-
270
- <a class="anchor" id="model-implementations" />
271
- <a class="header" href="#model-implementations">
272
- <h2>
273
- Model Implementations
274
- </h2>
275
- </a>
276
-
277
- <p>Because our default is ActiveRecord, it may be unclear what other Models
278
- look like. Graphiti itself has no opinion about your Model layer, but
279
- below are a few examples.</p>
280
-
281
- <a class="anchor" id="poro" />
282
- <a class="header" href="#poro">
283
- <h3>
284
- 2.1 PORO
285
- </h3>
286
- </a>
287
-
288
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">Employee</span>
289
- <span class="nb">attr_accessor</span> <span class="ss">:id</span><span class="p">,</span>
290
- <span class="ss">:first_name</span><span class="p">,</span>
291
- <span class="ss">:last_name</span><span class="p">,</span>
292
- <span class="ss">:age</span>
293
-
294
- <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">attrs</span> <span class="o">=</span> <span class="p">{})</span>
295
- <span class="n">attrs</span><span class="p">.</span><span class="nf">each_pair</span> <span class="p">{</span> <span class="o">|</span><span class="n">k</span><span class="p">,</span><span class="n">v</span><span class="o">|</span> <span class="nb">send</span><span class="p">(</span><span class="ss">:"</span><span class="si">#{</span><span class="n">k</span><span class="si">}</span><span class="ss">="</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="p">}</span>
296
- <span class="k">end</span>
297
- <span class="k">end</span></code></pre></figure>
298
-
299
- <p>This is a common Ruby example. <code class="language-plaintext highlighter-rouge">attr_accessor</code> defines getters and
300
- setters for our properties, and we assign those properties in the
301
- constructor:</p>
302
-
303
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">e</span> <span class="o">=</span> <span class="no">Employee</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="ss">id: </span><span class="mi">1</span><span class="p">,</span> <span class="ss">first_name: </span><span class="s1">'Jane'</span><span class="p">)</span>
304
- <span class="n">e</span><span class="p">.</span><span class="nf">first_name</span> <span class="c1"># =&gt; 'Jane'</span></code></pre></figure>
305
-
306
- <a class="anchor" id="activemodel-model" />
307
- <a class="header" href="#activemodel-model">
308
- <h3>
309
- 2.2 ActiveModel::Model
310
- </h3>
311
- </a>
312
-
313
- <p>A simple abstraction of the above is <a href="https://api.rubyonrails.org/classes/ActiveModel/Model.html">ActiveModel::Model</a>:</p>
314
-
315
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">Employee</span>
316
- <span class="kp">include</span> <span class="no">ActiveModel</span><span class="o">::</span><span class="no">Model</span>
317
-
318
- <span class="nb">attr_accessor</span> <span class="ss">:id</span><span class="p">,</span>
319
- <span class="ss">:first_name</span><span class="p">,</span>
320
- <span class="ss">:last_name</span><span class="p">,</span>
321
- <span class="ss">:age</span>
322
- <span class="k">end</span></code></pre></figure>
323
-
324
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">e</span> <span class="o">=</span> <span class="no">Employee</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="ss">id: </span><span class="mi">1</span><span class="p">,</span> <span class="ss">first_name: </span><span class="s1">'Jane'</span><span class="p">)</span>
325
- <span class="n">e</span><span class="p">.</span><span class="nf">first_name</span> <span class="c1"># =&gt; 'Jane'</span></code></pre></figure>
326
-
327
- <a class="anchor" id="dry-struct" />
328
- <a class="header" href="#dry-struct">
329
- <h3>
330
- 2.3 Dry::Struct
331
- </h3>
332
- </a>
333
-
334
- <p><a href="https://dry-rb.org/gems/dry-types">dry-types</a> is a dependency of Graphiti and successor to the popular <a href="https://github.com/solnic/virtus">Virtus</a>.</p>
335
-
336
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">module</span> <span class="nn">Types</span>
337
- <span class="kp">include</span> <span class="no">Dry</span><span class="o">::</span><span class="no">Types</span><span class="p">.</span><span class="nf">module</span>
338
- <span class="k">end</span>
339
-
340
- <span class="k">class</span> <span class="nc">Employee</span> <span class="o">&lt;</span> <span class="no">Dry</span><span class="o">::</span><span class="no">Struct</span>
341
- <span class="n">attribute</span> <span class="ss">:id</span><span class="p">,</span> <span class="no">Types</span><span class="o">::</span><span class="no">Integer</span>
342
- <span class="n">attribute</span> <span class="ss">:first_name</span><span class="p">,</span> <span class="no">Types</span><span class="o">::</span><span class="no">String</span>
343
- <span class="n">attribute</span> <span class="ss">:last_name</span><span class="p">,</span> <span class="no">Types</span><span class="o">::</span><span class="no">Integer</span>
344
- <span class="n">attribute</span> <span class="ss">:age</span><span class="p">,</span> <span class="no">Types</span><span class="o">::</span><span class="no">Integer</span>
345
- <span class="k">end</span></code></pre></figure>
346
-
347
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">e</span> <span class="o">=</span> <span class="no">Employee</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="ss">id: </span><span class="mi">1</span><span class="p">,</span> <span class="ss">first_name: </span><span class="s1">'Jane'</span><span class="p">)</span>
348
- <span class="n">e</span><span class="p">.</span><span class="nf">first_name</span> <span class="c1"># =&gt; 'Jane'</span></code></pre></figure>
349
-
350
- <a class="anchor" id="model-tips" />
351
- <a class="header" href="#model-tips">
352
- <h2>
353
- 3 Model Tips
354
- </h2>
355
- </a>
356
-
357
- <a class="anchor" id="id-less-models" />
358
- <a class="header" href="#id-less-models">
359
- <h3>
360
- ID-less Models
361
- </h3>
362
- </a>
363
-
364
- <p>If your Model does not have an <code class="language-plaintext highlighter-rouge">id</code> property, using a random UUID is
365
- perfectly acceptable:</p>
366
-
367
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">def</span> <span class="nf">id</span>
368
- <span class="vi">@id</span> <span class="o">||=</span> <span class="no">SecureRandom</span><span class="p">.</span><span class="nf">uuid</span>
369
- <span class="k">end</span></code></pre></figure>
370
-
371
- </div>
372
-
373
- </div>
374
- </div>
375
- </main>
376
- <div class="main-footer main-footer--dark">
377
- <div class="container">
378
- <div class="row">
379
- <div class="col-sm-4 menu">
380
- <h3>Overview</h3>
381
- <ul>
382
- <li>
383
- <a href="/1.13/quickstart">Quickstart</a>
384
- </li>
385
- <li>
386
- <a href="/1.13/tutorial">Tutorial</a>
387
- </li>
388
- <li>
389
- <a href="/1.13/guides">Guides</a>
390
- </li>
391
- </ul>
392
- </div>
393
- <div class="col-sm-4 menu">
394
- <h3>Contact</h3>
395
- <ul>
396
- <li>
397
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
398
- </li>
399
- <li>
400
- <a href="mailto:richmolj@gmail.com">Email</a>
401
- </li>
402
- </ul>
403
- </div>
404
- <div class="col-sm-4 menu">
405
- <h3>Related</h3>
406
- <ul>
407
- <li>
408
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
409
- </li>
410
- <li>
411
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
412
- </li>
413
- <li>
414
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
415
- </li>
416
- </ul>
417
- </div>
418
- </div>
419
- </div>
420
- </div>
421
-
422
- <script type="text/javascript">
423
- $(function () {
424
-
425
- var flipTabs = function() {
426
- var isTS = true;
427
- if (localStorage.getItem('js-lang') === 'javascript') {
428
- isTS = false;
429
- }
430
-
431
- $('.code-tabs').each(function(index, el) {
432
- if (isTS) {
433
- console.log('hiding js');
434
- $($(el).children()[1]).hide();
435
- $($(el).children()[0]).show();
436
- } else {
437
- console.log('hiding ts');
438
- $($(el).children()[0]).hide();
439
- $($(el).children()[1]).show();
440
- }
441
- });
442
-
443
- if (isTS) {
444
- $('.tab.typescript').addClass('active');
445
- $('.tab.javascript').removeClass('active');
446
- } else {
447
- $('.tab.typescript').removeClass('active');
448
- $('.tab.javascript').addClass('active');
449
- }
450
- }
451
-
452
- $('.tab').click(function() {
453
- if ($(this).hasClass('typescript')) {
454
- localStorage.setItem('js-lang', 'typescript');
455
- } else {
456
- localStorage.setItem('js-lang', 'javascript');
457
- }
458
-
459
- flipTabs();
460
- });
461
-
462
- flipTabs();
463
- })
464
- </script>
465
-
466
- </body>
467
- </html>