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.
- checksums.yaml +4 -4
- data/.git-blame-ignore-revs +2 -0
- data/.github/workflows/ci.yml +55 -3
- data/.github/workflows/docs.yml +1 -1
- data/.github/workflows/notify-example-app.yml +18 -0
- data/.gitignore +2 -0
- data/.standard.yml +6 -0
- data/CHANGELOG.md +54 -0
- data/CONTRIBUTING.md +3 -1
- data/README.md +13 -206
- data/Rakefile +6 -3
- data/UPGRADING.md +1 -1
- data/graphiti.gemspec +8 -4
- data/lib/generators/graphiti/generator_mixin.rb +1 -1
- data/lib/generators/graphiti/install_generator.rb +1 -2
- data/lib/generators/graphiti/resource_generator.rb +6 -3
- data/lib/generators/graphiti/templates/application_resource.rb.erb +19 -0
- data/lib/generators/graphiti/templates/controller.rb.erb +26 -8
- data/lib/generators/graphiti/templates/index_request_spec.rb.erb +2 -2
- data/lib/generators/graphiti/templates/resource_reads_spec.rb.erb +4 -4
- data/lib/generators/graphiti/templates/show_request_spec.rb.erb +2 -2
- data/lib/graphiti/audit/report.rb +6 -6
- data/lib/graphiti/audit.rb +3 -4
- data/lib/graphiti/delegates/pagination.rb +2 -2
- data/lib/graphiti/deserializer.rb +3 -3
- data/lib/graphiti/errors.rb +6 -6
- data/lib/graphiti/extensions/temp_id.rb +1 -1
- data/lib/graphiti/query.rb +27 -8
- data/lib/graphiti/rails/context.rb +2 -1
- data/lib/graphiti/rails/controller.rb +3 -0
- data/lib/graphiti/rails/debugging.rb +1 -1
- data/lib/graphiti/rails/responders.rb +2 -1
- data/lib/graphiti/resource/configuration.rb +1 -0
- data/lib/graphiti/resource/dsl.rb +2 -2
- data/lib/graphiti/resource/interface.rb +3 -3
- data/lib/graphiti/resource/links.rb +1 -1
- data/lib/graphiti/resource/persistence.rb +1 -1
- data/lib/graphiti/resource/polymorphism.rb +1 -1
- data/lib/graphiti/resource.rb +2 -2
- data/lib/graphiti/resource_proxy.rb +0 -1
- data/lib/graphiti/runner.rb +8 -3
- data/lib/graphiti/scope.rb +13 -0
- data/lib/graphiti/scoping/filter.rb +5 -3
- data/lib/graphiti/scoping/paginate.rb +1 -1
- data/lib/graphiti/scoping/sort.rb +1 -1
- data/lib/graphiti/sideload/has_many.rb +1 -1
- data/lib/graphiti/spec_helpers/errors_proxy.rb +1 -1
- data/lib/graphiti/spec_helpers/matchers.rb +1 -1
- data/lib/graphiti/spec_helpers.rb +5 -0
- data/lib/graphiti/types.rb +5 -1
- data/lib/graphiti/util/cache_debug.rb +3 -3
- data/lib/graphiti/util/hash.rb +1 -1
- data/lib/graphiti/util/persistence.rb +6 -6
- data/lib/graphiti/util/serializer_relationships.rb +1 -1
- data/lib/graphiti/version.rb +1 -1
- data/lib/tasks/graphiti.rake +1 -1
- data/package.json +1 -0
- metadata +31 -197
- data/docs/concepts/backends-and-models.md +0 -122
- data/docs/concepts/endpoints.md +0 -183
- data/docs/concepts/links.md +0 -212
- data/docs/concepts/overview.md +0 -80
- data/docs/concepts/persisting.md +0 -376
- data/docs/concepts/relationships.md +0 -627
- data/docs/concepts/resources.md +0 -677
- data/docs/getting-started/first-api.md +0 -289
- data/docs/getting-started/installation.md +0 -185
- data/docs/intro.md +0 -307
- data/docs/js/authentication.md +0 -63
- data/docs/js/ddau.md +0 -20
- data/docs/js/extra-params.md +0 -41
- data/docs/js/index.md +0 -112
- data/docs/js/installation.md +0 -120
- data/docs/js/middleware.md +0 -72
- data/docs/js/models.md +0 -202
- data/docs/js/reads.md +0 -494
- data/docs/js/state-syncing.md +0 -100
- data/docs/js/writes.md +0 -373
- data/docs/reference/vandal.md +0 -63
- data/docs/reference/why.md +0 -13
- data/docs/topics/authorization.md +0 -155
- data/docs/topics/caching.md +0 -55
- data/docs/topics/customizing-sideloads.md +0 -156
- data/docs/topics/debugging.md +0 -242
- data/docs/topics/error-handling.md +0 -210
- data/docs/topics/etags.md +0 -46
- data/docs/topics/hopping-relationships.md +0 -149
- data/docs/topics/json-attributes.md +0 -77
- data/docs/topics/openstruct-models.md +0 -50
- data/docs/topics/remote-resources.md +0 -291
- data/docs/topics/testing.md +0 -894
- data/docs/topics/without-activerecord.md +0 -324
- data/docs/tutorial/index.md +0 -58
- data/docs/tutorial/step_0.md +0 -107
- data/docs/tutorial/step_1.md +0 -199
- data/docs/tutorial/step_2.md +0 -312
- data/docs/tutorial/step_3.md +0 -142
- data/docs/tutorial/step_4.md +0 -135
- data/docs/tutorial/step_5.md +0 -69
- data/docs/tutorial/step_6.md +0 -82
- data/docs/tutorial/step_7.md +0 -205
- data/docs/tutorial/step_8.md +0 -128
- data/docs/tutorial/step_9.md +0 -171
- data/docs/upgrading.md +0 -266
- data/website/.gitignore +0 -20
- data/website/README.md +0 -43
- data/website/docusaurus.config.js +0 -197
- data/website/package-lock.json +0 -19474
- data/website/package.json +0 -46
- data/website/sidebars.js +0 -82
- data/website/src/css/custom.css +0 -85
- data/website/src/pages/markdown-page.mdx +0 -7
- data/website/static/.nojekyll +0 -0
- data/website/static/1.13/2019/03/31/graphiti-1-0.html +0 -205
- data/website/static/1.13/2019/05/08/graphiti-1-1.html +0 -212
- data/website/static/1.13/2019/05/20/graphiti-1-2.html +0 -214
- data/website/static/1.13/2019/10/14/tutorial.html +0 -198
- data/website/static/1.13/CNAME +0 -1
- data/website/static/1.13/README.md +0 -16
- data/website/static/1.13/assets/css/syntax.css +0 -60
- data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
- data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
- data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
- data/website/static/1.13/assets/favicons/browserconfig.xml +0 -9
- data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
- data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
- data/website/static/1.13/assets/favicons/favicon.ico +0 -0
- data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
- data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +0 -1
- data/website/static/1.13/assets/favicons/site.webmanifest +0 -19
- data/website/static/1.13/assets/img/backend.gif +0 -0
- data/website/static/1.13/assets/img/conformity.png +0 -0
- data/website/static/1.13/assets/img/error_payload.png +0 -0
- data/website/static/1.13/assets/img/fancy-cushion.png +0 -0
- data/website/static/1.13/assets/img/gh.png +0 -0
- data/website/static/1.13/assets/img/home-bg.jpg +0 -0
- data/website/static/1.13/assets/img/lifecycle.gif +0 -0
- data/website/static/1.13/assets/img/logo-500.png +0 -0
- data/website/static/1.13/assets/img/logo.png +0 -0
- data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
- data/website/static/1.13/assets/img/meta_total_count.png +0 -0
- data/website/static/1.13/assets/img/persist.jpg +0 -0
- data/website/static/1.13/assets/img/resource.gif +0 -0
- data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
- data/website/static/1.13/assets/img/rest1.gif +0 -0
- data/website/static/1.13/assets/img/rest2.gif +0 -0
- data/website/static/1.13/assets/img/rest3.gif +0 -0
- data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
- data/website/static/1.13/assets/img/sunrise.png +0 -0
- data/website/static/1.13/assets/img/why.png +0 -0
- data/website/static/1.13/assets/js/highlight.pack.js +0 -2
- data/website/static/1.13/assets/main.css +0 -15518
- data/website/static/1.13/assets/main.css.map +0 -1
- data/website/static/1.13/bin/bundle +0 -109
- data/website/static/1.13/bin/jekyll +0 -27
- data/website/static/1.13/bin/kramdown +0 -27
- data/website/static/1.13/bin/listen +0 -27
- data/website/static/1.13/bin/rake +0 -27
- data/website/static/1.13/bin/rougify +0 -27
- data/website/static/1.13/bin/safe_yaml +0 -27
- data/website/static/1.13/bin/sass +0 -27
- data/website/static/1.13/bin/sass-convert +0 -27
- data/website/static/1.13/bin/scss +0 -27
- data/website/static/1.13/blog.html +0 -259
- data/website/static/1.13/cheatsheet.html +0 -316
- data/website/static/1.13/cookbooks/authorization.md +0 -0
- data/website/static/1.13/cookbooks/caching.md +0 -0
- data/website/static/1.13/cookbooks/customizing-sideloads.html +0 -325
- data/website/static/1.13/cookbooks/etags.md +0 -0
- data/website/static/1.13/cookbooks/hopping-relationships.html +0 -324
- data/website/static/1.13/cookbooks/json_attributes.md +0 -0
- data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
- data/website/static/1.13/cookbooks/remote-resources.md +0 -0
- data/website/static/1.13/cookbooks/without-activerecord.html +0 -510
- data/website/static/1.13/features.html +0 -249
- data/website/static/1.13/feed.xml +0 -106
- data/website/static/1.13/guides/concepts/backends-and-models.html +0 -467
- data/website/static/1.13/guides/concepts/debugging.html +0 -440
- data/website/static/1.13/guides/concepts/endpoints.html +0 -432
- data/website/static/1.13/guides/concepts/error-handling.html +0 -396
- data/website/static/1.13/guides/concepts/links.html +0 -501
- data/website/static/1.13/guides/concepts/remote-resources.html +0 -536
- data/website/static/1.13/guides/concepts/resources.html +0 -2176
- data/website/static/1.13/guides/concepts/testing.html +0 -1469
- data/website/static/1.13/guides/getting-started/installation.html +0 -420
- data/website/static/1.13/guides/graphiti-rails-migration.html +0 -242
- data/website/static/1.13/guides/index.html +0 -269
- data/website/static/1.13/guides/overview.html +0 -325
- data/website/static/1.13/guides/upgrading-2-0.html +0 -193
- data/website/static/1.13/guides/upgrading.html +0 -314
- data/website/static/1.13/guides/vandal.html +0 -282
- data/website/static/1.13/guides/why.html +0 -1121
- data/website/static/1.13/index.html +0 -72
- data/website/static/1.13/js/authentication.html +0 -295
- data/website/static/1.13/js/ddau.html +0 -238
- data/website/static/1.13/js/extra-params.html +0 -270
- data/website/static/1.13/js/index.html +0 -321
- data/website/static/1.13/js/installation.html +0 -637
- data/website/static/1.13/js/introduction.html +0 -257
- data/website/static/1.13/js/middleware.html +0 -318
- data/website/static/1.13/js/reads/fieldsets.html +0 -271
- data/website/static/1.13/js/reads/filtering.html +0 -289
- data/website/static/1.13/js/reads/includes.html +0 -260
- data/website/static/1.13/js/reads/index.html +0 -497
- data/website/static/1.13/js/reads/nested-queries.html +0 -353
- data/website/static/1.13/js/reads/pagination.html +0 -260
- data/website/static/1.13/js/reads/sorting.html +0 -265
- data/website/static/1.13/js/reads/statistics.html +0 -289
- data/website/static/1.13/js/state-syncing.html +0 -340
- data/website/static/1.13/js/writes/deferred.html +0 -296
- data/website/static/1.13/js/writes/dirty-tracking.html +0 -399
- data/website/static/1.13/js/writes/index.html +0 -391
- data/website/static/1.13/js/writes/nested.html +0 -330
- data/website/static/1.13/js/writes/validations.html +0 -272
- data/website/static/1.13/quickstart.html +0 -660
- data/website/static/1.13/template +0 -161
- data/website/static/1.13/tutorial/index.html +0 -250
- data/website/static/1.13/tutorial/step_0.html +0 -292
- data/website/static/1.13/tutorial/step_1.html +0 -517
- data/website/static/1.13/tutorial/step_2.html +0 -481
- data/website/static/1.13/tutorial/step_3.html +0 -323
- data/website/static/1.13/tutorial/step_4.html +0 -318
- data/website/static/1.13/tutorial/step_5.html +0 -265
- data/website/static/1.13/tutorial/step_6.html +0 -276
- data/website/static/1.13/tutorial/step_7.html +0 -390
- data/website/static/1.13/tutorial/step_8.html +0 -316
- data/website/static/1.13/tutorial/step_9.html +0 -365
- data/website/static/CNAME +0 -1
- data/website/static/assets/img/error_payload.png +0 -0
- data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
- data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
- data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
- data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
- data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
- data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
- data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
- data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
- data/website/static/assets/img/meta_total_count.png +0 -0
- data/website/static/img/docusaurus-social-card.jpg +0 -0
- data/website/static/img/docusaurus.png +0 -0
- data/website/static/img/favicon.ico +0 -0
- data/website/static/img/logo.png +0 -0
- data/website/static/img/logo.svg +0 -1
- data/website/static/img/undraw_docusaurus_mountain.svg +0 -171
- data/website/static/img/undraw_docusaurus_react.svg +0 -170
- data/website/static/img/undraw_docusaurus_tree.svg +0 -40
|
@@ -1,510 +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
|
-
<h1 id="usage-without-activerecord">Usage Without ActiveRecord</h1>
|
|
84
|
-
|
|
85
|
-
<p>Graphiti was built to be used with any ORM or datastore, from PostgreSQL
|
|
86
|
-
to elasticsearch to <code class="language-plaintext highlighter-rouge">Net::HTTP</code>. In fact, Graphiti itself is tested with
|
|
87
|
-
Plain Old Ruby Objects (POROs).</p>
|
|
88
|
-
|
|
89
|
-
<p>This cookbook will show how to customize a resource around a particular datastore, and how to package those
|
|
90
|
-
customizations into a reusable adapter. We’ll use an in-memory datastore
|
|
91
|
-
and Plain Old Ruby Objects (POROs) here, but the lessons apply to any
|
|
92
|
-
datastore.</p>
|
|
93
|
-
|
|
94
|
-
<p>For working code, see <a href="https://github.com/graphiti-api/employee_directory/blob/poro/app/resources/post_resource.rb">this branch of the sample application</a>.</p>
|
|
95
|
-
|
|
96
|
-
<p>We’ll start with this PORO model:</p>
|
|
97
|
-
|
|
98
|
-
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">Post</span>
|
|
99
|
-
<span class="c1"># Define getters/setters</span>
|
|
100
|
-
<span class="c1"># e.g. post.title = 'foo'</span>
|
|
101
|
-
<span class="no">ATTRS</span> <span class="o">=</span> <span class="p">[</span><span class="ss">:id</span><span class="p">,</span> <span class="ss">:title</span><span class="p">]</span>
|
|
102
|
-
<span class="no">ATTRS</span><span class="p">.</span><span class="nf">each</span> <span class="p">{</span> <span class="o">|</span><span class="n">a</span><span class="o">|</span> <span class="nb">attr_accessor</span><span class="p">(</span><span class="n">a</span><span class="p">)</span> <span class="p">}</span>
|
|
103
|
-
|
|
104
|
-
<span class="c1"># Instantiate with hash of attributes</span>
|
|
105
|
-
<span class="c1"># e.g. Post.new(title: 'foo')</span>
|
|
106
|
-
<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>
|
|
107
|
-
<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>
|
|
108
|
-
<span class="k">end</span>
|
|
109
|
-
|
|
110
|
-
<span class="c1"># This part only needed for our particular</span>
|
|
111
|
-
<span class="c1"># persistence implementation; you may not need it</span>
|
|
112
|
-
<span class="c1"># e.g. post.attributes # => { title: 'foo' }</span>
|
|
113
|
-
<span class="k">def</span> <span class="nf">attributes</span>
|
|
114
|
-
<span class="p">{}.</span><span class="nf">tap</span> <span class="k">do</span> <span class="o">|</span><span class="n">attrs</span><span class="o">|</span>
|
|
115
|
-
<span class="no">ATTRS</span><span class="p">.</span><span class="nf">each</span> <span class="k">do</span> <span class="o">|</span><span class="nb">name</span><span class="o">|</span>
|
|
116
|
-
<span class="n">attrs</span><span class="p">[</span><span class="nb">name</span><span class="p">]</span> <span class="o">=</span> <span class="nb">send</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
|
117
|
-
<span class="k">end</span>
|
|
118
|
-
<span class="k">end</span>
|
|
119
|
-
<span class="k">end</span>
|
|
120
|
-
<span class="k">end</span></code></pre></figure>
|
|
121
|
-
|
|
122
|
-
<p>And this in-memory datastore:</p>
|
|
123
|
-
|
|
124
|
-
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># If we were working with more than just Posts, we'd need a 'type'</span>
|
|
125
|
-
<span class="c1"># field here as well, to simulate a table name.</span>
|
|
126
|
-
<span class="no">DATA</span> <span class="o">=</span> <span class="p">[</span>
|
|
127
|
-
<span class="p">{</span> <span class="ss">id: </span><span class="mi">1</span><span class="p">,</span> <span class="ss">title: </span><span class="s1">'Graphiti'</span> <span class="p">},</span>
|
|
128
|
-
<span class="p">{</span> <span class="ss">id: </span><span class="mi">2</span><span class="p">,</span> <span class="ss">title: </span><span class="s1">'is'</span> <span class="p">},</span>
|
|
129
|
-
<span class="p">{</span> <span class="ss">id: </span><span class="mi">3</span><span class="p">,</span> <span class="ss">title: </span><span class="s1">'super'</span> <span class="p">},</span>
|
|
130
|
-
<span class="p">{</span> <span class="ss">id: </span><span class="mi">4</span><span class="p">,</span> <span class="ss">title: </span><span class="s1">'dope'</span> <span class="p">}</span>
|
|
131
|
-
<span class="p">]</span></code></pre></figure>
|
|
132
|
-
|
|
133
|
-
<a class="anchor" id="resource-overrides" />
|
|
134
|
-
<a class="header" href="#resource-overrides">
|
|
135
|
-
<h2>
|
|
136
|
-
Resource Overrides
|
|
137
|
-
</h2>
|
|
138
|
-
</a>
|
|
139
|
-
|
|
140
|
-
<p>If it’s your first time with a new ORM or datastore, we recommend
|
|
141
|
-
putting the logic in the Resource first. Once things are working <em>and</em>
|
|
142
|
-
there are multiple uses of the same overrides, package them into an
|
|
143
|
-
Adapter.</p>
|
|
144
|
-
|
|
145
|
-
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">PostResource</span> <span class="o"><</span> <span class="no">ApplicationResource</span>
|
|
146
|
-
<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>
|
|
147
|
-
|
|
148
|
-
<span class="n">attribute</span> <span class="ss">:title</span><span class="p">,</span> <span class="ss">:string</span>
|
|
149
|
-
|
|
150
|
-
<span class="k">def</span> <span class="nf">base_scope</span>
|
|
151
|
-
<span class="p">{}</span>
|
|
152
|
-
<span class="k">end</span>
|
|
153
|
-
|
|
154
|
-
<span class="k">def</span> <span class="nf">resolve</span><span class="p">(</span><span class="n">scope</span><span class="p">)</span>
|
|
155
|
-
<span class="no">DATA</span><span class="p">.</span><span class="nf">map</span> <span class="p">{</span> <span class="o">|</span><span class="n">d</span><span class="o">|</span> <span class="no">Post</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">d</span><span class="p">)</span> <span class="p">}</span>
|
|
156
|
-
<span class="k">end</span>
|
|
157
|
-
<span class="k">end</span></code></pre></figure>
|
|
158
|
-
|
|
159
|
-
<p>Here we’re using the <code class="language-plaintext highlighter-rouge">Null</code> adapter, which acts as a dumb pass-through.
|
|
160
|
-
This can be helpful when you just want to get running for a simple use
|
|
161
|
-
case and don’t want errors around features you haven’t implemented yet.
|
|
162
|
-
But it can also be confusing when you expect certain codepaths to
|
|
163
|
-
be hit. Mostly just be aware of <code class="language-plaintext highlighter-rouge">Null</code>’s behavior, or use
|
|
164
|
-
<code class="language-plaintext highlighter-rouge">Graphiti::Adapters::Abstract</code> to get helpful errors around what’s not
|
|
165
|
-
implemented.</p>
|
|
166
|
-
|
|
167
|
-
<p>We’re also supplying an explicit <code class="language-plaintext highlighter-rouge">base_scope</code>. This is the beginning
|
|
168
|
-
query object we’ll modify as params come in. In the case of
|
|
169
|
-
ActiveRecord, we might want an <code class="language-plaintext highlighter-rouge">ActiveRecord::Relation</code> like
|
|
170
|
-
<code class="language-plaintext highlighter-rouge">Post.all</code>. For our example, we’ll modify a simple ruby hash (keep in
|
|
171
|
-
mind the premise of building a hash of options and passing it off to a
|
|
172
|
-
client can apply to any datastore).</p>
|
|
173
|
-
|
|
174
|
-
<p>Finally, we’re <a href="/1.13/guides/concepts/resources#resolve">resolving that scope</a>,
|
|
175
|
-
returning the full dataset for now. The contract of <code class="language-plaintext highlighter-rouge">#resolve</code> is to
|
|
176
|
-
return an array of model instances, hence <code class="language-plaintext highlighter-rouge">DATA.map { |d| Post.new(d)
|
|
177
|
-
}</code>.</p>
|
|
178
|
-
|
|
179
|
-
<a class="anchor" id="sorting" />
|
|
180
|
-
<a class="header" href="#sorting">
|
|
181
|
-
<h4>
|
|
182
|
-
Sorting
|
|
183
|
-
</h4>
|
|
184
|
-
</a>
|
|
185
|
-
|
|
186
|
-
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">sort_all</span> <span class="k">do</span> <span class="o">|</span><span class="n">scope</span><span class="p">,</span> <span class="n">attribute</span><span class="p">,</span> <span class="n">direction</span><span class="o">|</span>
|
|
187
|
-
<span class="n">scope</span><span class="p">[</span><span class="ss">:sort</span><span class="p">].</span><span class="nf">merge!</span><span class="p">(</span><span class="ss">attribute: </span><span class="n">att</span><span class="p">,</span> <span class="ss">direction: </span><span class="n">dir</span><span class="p">)</span>
|
|
188
|
-
<span class="k">end</span>
|
|
189
|
-
|
|
190
|
-
<span class="k">def</span> <span class="nf">base_scope</span>
|
|
191
|
-
<span class="p">{</span> <span class="ss">sort: </span><span class="p">{}</span> <span class="p">}</span>
|
|
192
|
-
<span class="k">end</span>
|
|
193
|
-
|
|
194
|
-
<span class="k">def</span> <span class="nf">resolve</span><span class="p">(</span><span class="n">scope</span><span class="p">)</span>
|
|
195
|
-
<span class="k">if</span> <span class="n">sort</span> <span class="o">=</span> <span class="n">scope</span><span class="p">[</span><span class="ss">:sort</span><span class="p">].</span><span class="nf">presence</span>
|
|
196
|
-
<span class="n">data</span> <span class="o">=</span> <span class="no">DATA</span><span class="p">.</span><span class="nf">sort_by</span> <span class="p">{</span> <span class="o">|</span><span class="n">d</span><span class="o">|</span> <span class="n">d</span><span class="p">[</span><span class="n">sort</span><span class="p">[</span><span class="ss">:attribute</span><span class="p">].</span><span class="nf">to_sym</span><span class="p">]</span> <span class="p">}</span>
|
|
197
|
-
<span class="n">data</span> <span class="o">=</span> <span class="n">data</span><span class="p">.</span><span class="nf">reverse</span> <span class="k">if</span> <span class="n">sort</span><span class="p">[</span><span class="ss">:direction</span><span class="p">]</span> <span class="o">==</span> <span class="ss">:desc</span>
|
|
198
|
-
<span class="k">end</span>
|
|
199
|
-
<span class="no">DATA</span><span class="p">.</span><span class="nf">map</span> <span class="p">{</span> <span class="o">|</span><span class="n">d</span><span class="o">|</span> <span class="no">Post</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">d</span><span class="p">)</span> <span class="p">}</span>
|
|
200
|
-
<span class="k">end</span></code></pre></figure>
|
|
201
|
-
|
|
202
|
-
<p>We modified the base scope with a default hash key, <code class="language-plaintext highlighter-rouge">:sort</code>. When the
|
|
203
|
-
user requests sorting, we record this by merging into the hash. We can
|
|
204
|
-
then reference that information on the scope when resolving.</p>
|
|
205
|
-
|
|
206
|
-
<p>Note the <code class="language-plaintext highlighter-rouge">sort_all</code> scope block, in fact all scope blocks, must return the scope.</p>
|
|
207
|
-
|
|
208
|
-
<a class="anchor" id="paginating" />
|
|
209
|
-
<a class="header" href="#paginating">
|
|
210
|
-
<h4>
|
|
211
|
-
Paginating
|
|
212
|
-
</h4>
|
|
213
|
-
</a>
|
|
214
|
-
|
|
215
|
-
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">paginate</span> <span class="k">do</span> <span class="o">|</span><span class="n">scope</span><span class="p">,</span> <span class="n">current_page</span><span class="p">,</span> <span class="n">per_page</span><span class="o">|</span>
|
|
216
|
-
<span class="n">scope</span><span class="p">.</span><span class="nf">merge!</span><span class="p">(</span><span class="ss">current_page: </span><span class="n">current</span><span class="p">,</span> <span class="ss">per_page: </span><span class="n">per</span><span class="p">)</span>
|
|
217
|
-
<span class="k">end</span>
|
|
218
|
-
|
|
219
|
-
<span class="k">def</span> <span class="nf">resolve</span><span class="p">(</span><span class="n">scope</span><span class="p">)</span>
|
|
220
|
-
<span class="c1"># ... sorting ...</span>
|
|
221
|
-
<span class="n">start</span> <span class="o">=</span> <span class="p">(</span><span class="n">scope</span><span class="p">[</span><span class="ss">:current_page</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">scope</span><span class="p">[</span><span class="ss">:per_page</span><span class="p">]</span>
|
|
222
|
-
<span class="n">stop</span> <span class="o">=</span> <span class="n">start</span> <span class="o">+</span> <span class="n">scope</span><span class="p">[</span><span class="ss">:per_page</span><span class="p">]</span>
|
|
223
|
-
<span class="n">data</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">start</span><span class="o">...</span><span class="n">stop</span><span class="p">]</span>
|
|
224
|
-
<span class="c1"># ... return models ...</span>
|
|
225
|
-
<span class="k">end</span></code></pre></figure>
|
|
226
|
-
|
|
227
|
-
<p>Again: merge into the scope, then reference the scope data when
|
|
228
|
-
resolving.</p>
|
|
229
|
-
|
|
230
|
-
<a class="anchor" id="filtering" />
|
|
231
|
-
<a class="header" href="#filtering">
|
|
232
|
-
<h4>
|
|
233
|
-
Filtering
|
|
234
|
-
</h4>
|
|
235
|
-
</a>
|
|
236
|
-
|
|
237
|
-
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">filter</span> <span class="ss">:title</span><span class="p">,</span> <span class="ss">only: </span><span class="p">[</span><span class="ss">:eq</span><span class="p">]</span> <span class="k">do</span>
|
|
238
|
-
<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>
|
|
239
|
-
<span class="n">scope</span><span class="p">[</span><span class="ss">:filters</span><span class="p">][</span><span class="n">attribute</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
|
|
240
|
-
<span class="n">scope</span>
|
|
241
|
-
<span class="k">end</span>
|
|
242
|
-
<span class="k">end</span>
|
|
243
|
-
|
|
244
|
-
<span class="k">def</span> <span class="nf">base_scope</span><span class="p">(</span><span class="o">*</span><span class="p">)</span>
|
|
245
|
-
<span class="p">{</span> <span class="ss">sort: </span><span class="p">{},</span> <span class="ss">filters: </span><span class="p">{}</span> <span class="p">}</span>
|
|
246
|
-
<span class="k">end</span>
|
|
247
|
-
|
|
248
|
-
<span class="k">def</span> <span class="nf">resolve</span><span class="p">(</span><span class="n">scope</span><span class="p">)</span>
|
|
249
|
-
<span class="c1"># ... sorting ...</span>
|
|
250
|
-
<span class="n">scope</span><span class="p">[</span><span class="ss">:filters</span><span class="p">].</span><span class="nf">each_pair</span> <span class="k">do</span> <span class="o">|</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="o">|</span>
|
|
251
|
-
<span class="n">data</span> <span class="o">=</span> <span class="n">data</span><span class="p">.</span><span class="nf">select</span> <span class="p">{</span> <span class="o">|</span><span class="n">d</span><span class="o">|</span> <span class="n">d</span><span class="p">[</span><span class="n">k</span><span class="p">.</span><span class="nf">to_sym</span><span class="p">].</span><span class="nf">in?</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="p">}</span>
|
|
252
|
-
<span class="k">end</span>
|
|
253
|
-
<span class="c1"># ... pagination ...</span>
|
|
254
|
-
<span class="c1"># ... return models ...</span>
|
|
255
|
-
<span class="k">end</span></code></pre></figure>
|
|
256
|
-
|
|
257
|
-
<p>Same as above examples. Again, note that we must return the scope object
|
|
258
|
-
from the filter function.</p>
|
|
259
|
-
|
|
260
|
-
<a class="anchor" id="persisting" />
|
|
261
|
-
<a class="header" href="#persisting">
|
|
262
|
-
<h4>
|
|
263
|
-
Persisting
|
|
264
|
-
</h4>
|
|
265
|
-
</a>
|
|
266
|
-
|
|
267
|
-
<p>All at once:</p>
|
|
268
|
-
|
|
269
|
-
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># Instantiate a model for #create</span>
|
|
270
|
-
<span class="k">def</span> <span class="nf">build</span><span class="p">(</span><span class="n">model_class</span><span class="p">)</span>
|
|
271
|
-
<span class="n">model_class</span><span class="p">.</span><span class="nf">new</span>
|
|
272
|
-
<span class="k">end</span>
|
|
273
|
-
|
|
274
|
-
<span class="c1"># Used for create/update</span>
|
|
275
|
-
<span class="k">def</span> <span class="nf">assign_attributes</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">attributes</span><span class="p">)</span>
|
|
276
|
-
<span class="n">attributes</span><span class="p">.</span><span class="nf">each_pair</span> <span class="k">do</span> <span class="o">|</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="o">|</span>
|
|
277
|
-
<span class="n">model</span><span class="p">.</span><span class="nf">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>
|
|
278
|
-
<span class="k">end</span>
|
|
279
|
-
<span class="k">end</span>
|
|
280
|
-
|
|
281
|
-
<span class="c1"># Used for create/update</span>
|
|
282
|
-
<span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
|
|
283
|
-
<span class="n">attrs</span> <span class="o">=</span> <span class="n">model</span><span class="p">.</span><span class="nf">attributes</span><span class="p">.</span><span class="nf">dup</span>
|
|
284
|
-
<span class="n">attrs</span><span class="p">[</span><span class="ss">:id</span><span class="p">]</span> <span class="o">||=</span> <span class="no">DATA</span><span class="p">.</span><span class="nf">length</span> <span class="o">+</span> <span class="mi">1</span>
|
|
285
|
-
<span class="k">if</span> <span class="n">existing</span> <span class="o">=</span> <span class="no">DATA</span><span class="p">.</span><span class="nf">find</span> <span class="p">{</span> <span class="o">|</span><span class="n">d</span><span class="o">|</span> <span class="n">d</span><span class="p">[</span><span class="ss">:id</span><span class="p">].</span><span class="nf">to_s</span> <span class="o">==</span> <span class="n">attrs</span><span class="p">[</span><span class="ss">:id</span><span class="p">].</span><span class="nf">to_s</span> <span class="p">}</span>
|
|
286
|
-
<span class="n">existing</span><span class="p">.</span><span class="nf">merge!</span><span class="p">(</span><span class="n">attrs</span><span class="p">)</span>
|
|
287
|
-
<span class="k">else</span>
|
|
288
|
-
<span class="no">DATA</span> <span class="o"><<</span> <span class="n">attrs</span>
|
|
289
|
-
<span class="k">end</span>
|
|
290
|
-
<span class="n">model</span>
|
|
291
|
-
<span class="k">end</span>
|
|
292
|
-
|
|
293
|
-
<span class="c1"># Used for destroy</span>
|
|
294
|
-
<span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
|
|
295
|
-
<span class="no">DATA</span><span class="p">.</span><span class="nf">reject!</span> <span class="p">{</span> <span class="o">|</span><span class="n">d</span><span class="o">|</span> <span class="n">d</span><span class="p">[</span><span class="ss">:id</span><span class="p">].</span><span class="nf">to_s</span> <span class="o">==</span> <span class="n">model</span><span class="p">.</span><span class="nf">id</span><span class="p">.</span><span class="nf">to_s</span> <span class="p">}</span>
|
|
296
|
-
<span class="n">model</span>
|
|
297
|
-
<span class="k">end</span></code></pre></figure>
|
|
298
|
-
|
|
299
|
-
<p>These are the overrides for persistence operations. You are encouraged
|
|
300
|
-
<strong>not</strong> to override <code class="language-plaintext highlighter-rouge">create/update/destroy</code> directly and instead use
|
|
301
|
-
<a href="/1.13/guides/concepts/resources#persistence-lifecycle-hooks">Persistence Lifecycle Hooks</a>.</p>
|
|
302
|
-
|
|
303
|
-
<a class="anchor" id="adapters" />
|
|
304
|
-
<a class="header" href="#adapters">
|
|
305
|
-
<h2>
|
|
306
|
-
Adapters
|
|
307
|
-
</h2>
|
|
308
|
-
</a>
|
|
309
|
-
|
|
310
|
-
<p>OK so we have all our read and write operations working correctly. But
|
|
311
|
-
if we had multiple Resources all using an in-memory datastore, you’d see
|
|
312
|
-
this logic repeated all over the place. Let’s create an adapter to <a href="https://en.wikipedia.org/wiki/Don%27t_repeat_yourself">DRY</a>
|
|
313
|
-
up this logic.</p>
|
|
314
|
-
|
|
315
|
-
<p>There isn’t much more to do than copy/paste what we’ve already done.
|
|
316
|
-
Let’s start with our <code class="language-plaintext highlighter-rouge">base_scope</code>, sorting, and pagination:</p>
|
|
317
|
-
|
|
318
|
-
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">POROAdapter</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">Abstract</span>
|
|
319
|
-
<span class="k">def</span> <span class="nf">base_scope</span><span class="p">(</span><span class="o">*</span><span class="p">)</span>
|
|
320
|
-
<span class="p">{</span> <span class="ss">sort: </span><span class="p">{},</span> <span class="ss">filters: </span><span class="p">{}</span> <span class="p">}</span>
|
|
321
|
-
<span class="k">end</span>
|
|
322
|
-
|
|
323
|
-
<span class="k">def</span> <span class="nf">paginate</span><span class="p">(</span><span class="n">scope</span><span class="p">,</span> <span class="n">current</span><span class="p">,</span> <span class="n">per</span><span class="p">)</span>
|
|
324
|
-
<span class="n">scope</span><span class="p">.</span><span class="nf">merge!</span><span class="p">(</span><span class="ss">current_page: </span><span class="n">current</span><span class="p">,</span> <span class="ss">per_page: </span><span class="n">per</span><span class="p">)</span>
|
|
325
|
-
<span class="k">end</span>
|
|
326
|
-
|
|
327
|
-
<span class="k">def</span> <span class="nf">order</span><span class="p">(</span><span class="n">scope</span><span class="p">,</span> <span class="n">att</span><span class="p">,</span> <span class="n">dir</span><span class="p">)</span>
|
|
328
|
-
<span class="n">scope</span><span class="p">[</span><span class="ss">:sort</span><span class="p">].</span><span class="nf">merge!</span><span class="p">(</span><span class="ss">attribute: </span><span class="n">att</span><span class="p">,</span> <span class="ss">direction: </span><span class="n">dir</span><span class="p">)</span>
|
|
329
|
-
<span class="n">scope</span>
|
|
330
|
-
<span class="k">end</span>
|
|
331
|
-
|
|
332
|
-
<span class="k">def</span> <span class="nf">resolve</span><span class="p">(</span><span class="n">scope</span><span class="p">)</span>
|
|
333
|
-
<span class="n">data</span> <span class="o">=</span> <span class="no">DATA</span>
|
|
334
|
-
<span class="k">if</span> <span class="n">sort</span> <span class="o">=</span> <span class="n">scope</span><span class="p">[</span><span class="ss">:sort</span><span class="p">].</span><span class="nf">presence</span>
|
|
335
|
-
<span class="n">data</span> <span class="o">=</span> <span class="n">data</span><span class="p">.</span><span class="nf">sort_by</span> <span class="p">{</span> <span class="o">|</span><span class="n">d</span><span class="o">|</span> <span class="n">d</span><span class="p">[</span><span class="n">sort</span><span class="p">[</span><span class="ss">:attribute</span><span class="p">].</span><span class="nf">to_sym</span><span class="p">]</span> <span class="p">}</span>
|
|
336
|
-
<span class="n">data</span> <span class="o">=</span> <span class="n">data</span><span class="p">.</span><span class="nf">reverse</span> <span class="k">if</span> <span class="n">sort</span><span class="p">[</span><span class="ss">:direction</span><span class="p">]</span> <span class="o">==</span> <span class="ss">:desc</span>
|
|
337
|
-
<span class="k">end</span>
|
|
338
|
-
<span class="n">start</span> <span class="o">=</span> <span class="p">(</span><span class="n">scope</span><span class="p">[</span><span class="ss">:current_page</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">scope</span><span class="p">[</span><span class="ss">:per_page</span><span class="p">]</span>
|
|
339
|
-
<span class="n">stop</span> <span class="o">=</span> <span class="n">start</span> <span class="o">+</span> <span class="n">scope</span><span class="p">[</span><span class="ss">:per_page</span><span class="p">]</span>
|
|
340
|
-
<span class="n">data</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">start</span><span class="o">...</span><span class="n">stop</span><span class="p">]</span>
|
|
341
|
-
|
|
342
|
-
<span class="n">data</span><span class="p">.</span><span class="nf">map</span> <span class="p">{</span> <span class="o">|</span><span class="n">d</span><span class="o">|</span> <span class="n">resource</span><span class="p">.</span><span class="nf">model</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">d</span><span class="p">)</span> <span class="p">}</span>
|
|
343
|
-
<span class="k">end</span>
|
|
344
|
-
<span class="k">end</span></code></pre></figure>
|
|
345
|
-
|
|
346
|
-
<p>There’s really nothing here we haven’t seen before. We’re taking the
|
|
347
|
-
code we originally wrote, and sticking it into the interface defined by
|
|
348
|
-
<code class="language-plaintext highlighter-rouge">Graphiti::Adapters::Abstract</code>.</p>
|
|
349
|
-
|
|
350
|
-
<p>There’s a <em>little</em> more to do with filtering:</p>
|
|
351
|
-
|
|
352
|
-
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">def</span> <span class="nf">filter</span><span class="p">(</span><span class="n">scope</span><span class="p">,</span> <span class="n">attribute</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
|
|
353
|
-
<span class="n">scope</span><span class="p">[</span><span class="ss">:filters</span><span class="p">][</span><span class="n">attribute</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
|
|
354
|
-
<span class="n">scope</span>
|
|
355
|
-
<span class="k">end</span>
|
|
356
|
-
<span class="k">alias</span> <span class="ss">:filter_string_eq</span> <span class="ss">:filter</span>
|
|
357
|
-
<span class="k">alias</span> <span class="ss">:filter_integer_eq</span> <span class="ss">:filter</span>
|
|
358
|
-
<span class="k">alias</span> <span class="ss">:filter_date_eq</span> <span class="ss">:filter</span>
|
|
359
|
-
<span class="c1"># ... etc ...</span></code></pre></figure>
|
|
360
|
-
|
|
361
|
-
<p>The logic is the same, but we have a separate method for each filter
|
|
362
|
-
operator. This allows us to query differently based on the type - for
|
|
363
|
-
instance, ActiveRecord will default to case-insensitive for strings, but
|
|
364
|
-
straight equality for integers. If you don’t need operator-specific
|
|
365
|
-
logic, just <code class="language-plaintext highlighter-rouge">alias</code> as you see here.</p>
|
|
366
|
-
|
|
367
|
-
<p>You may want to limit the default operators we expect to work with a
|
|
368
|
-
given type. Let’s say your backend allows straight equality for strings,
|
|
369
|
-
but doesn’t support <code class="language-plaintext highlighter-rouge">prefix</code>, <code class="language-plaintext highlighter-rouge">suffix</code>, etc. You can specify this in
|
|
370
|
-
your adapter:</p>
|
|
371
|
-
|
|
372
|
-
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">default_operators</span>
|
|
373
|
-
<span class="k">super</span><span class="p">.</span><span class="nf">tap</span> <span class="k">do</span> <span class="o">|</span><span class="n">built_in</span><span class="o">|</span>
|
|
374
|
-
<span class="n">built_in</span><span class="p">[</span><span class="ss">:string</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="ss">:eq</span><span class="p">]</span>
|
|
375
|
-
<span class="k">end</span>
|
|
376
|
-
<span class="k">end</span>
|
|
377
|
-
|
|
378
|
-
<span class="c1"># or avoid super altogether</span>
|
|
379
|
-
|
|
380
|
-
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">default_operators</span>
|
|
381
|
-
<span class="p">{</span>
|
|
382
|
-
<span class="ss">string: </span><span class="p">[</span><span class="ss">:eq</span><span class="p">],</span>
|
|
383
|
-
<span class="ss">integer: </span><span class="p">[</span><span class="ss">:eq</span><span class="p">]</span>
|
|
384
|
-
<span class="c1"># ... etc ...</span>
|
|
385
|
-
<span class="p">}</span>
|
|
386
|
-
<span class="k">end</span></code></pre></figure>
|
|
387
|
-
|
|
388
|
-
<p><strong>That’s it for reads</strong>. For writes, I’ll post the entire adapter code
|
|
389
|
-
below - again, it’s just copy/pasting what we already wrote into a
|
|
390
|
-
slightly different format.</p>
|
|
391
|
-
|
|
392
|
-
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">def</span> <span class="nf">destroy</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
|
|
393
|
-
<span class="no">Post</span><span class="o">::</span><span class="no">DATA</span><span class="p">.</span><span class="nf">reject!</span> <span class="p">{</span> <span class="o">|</span><span class="n">d</span><span class="o">|</span> <span class="n">d</span><span class="p">[</span><span class="ss">:id</span><span class="p">].</span><span class="nf">to_s</span> <span class="o">==</span> <span class="n">model</span><span class="p">.</span><span class="nf">id</span><span class="p">.</span><span class="nf">to_s</span> <span class="p">}</span>
|
|
394
|
-
<span class="n">model</span>
|
|
395
|
-
<span class="k">end</span>
|
|
396
|
-
|
|
397
|
-
<span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
|
|
398
|
-
<span class="n">attrs</span> <span class="o">=</span> <span class="n">model</span><span class="p">.</span><span class="nf">attributes</span><span class="p">.</span><span class="nf">dup</span>
|
|
399
|
-
<span class="n">attrs</span><span class="p">[</span><span class="ss">:id</span><span class="p">]</span> <span class="o">||=</span> <span class="no">Post</span><span class="o">::</span><span class="no">DATA</span><span class="p">.</span><span class="nf">length</span> <span class="o">+</span> <span class="mi">1</span>
|
|
400
|
-
<span class="k">if</span> <span class="n">existing</span> <span class="o">=</span> <span class="no">Post</span><span class="o">::</span><span class="no">DATA</span><span class="p">.</span><span class="nf">find</span> <span class="p">{</span> <span class="o">|</span><span class="n">d</span><span class="o">|</span> <span class="n">d</span><span class="p">[</span><span class="ss">:id</span><span class="p">].</span><span class="nf">to_s</span> <span class="o">==</span> <span class="n">attrs</span><span class="p">[</span><span class="ss">:id</span><span class="p">].</span><span class="nf">to_s</span> <span class="p">}</span>
|
|
401
|
-
<span class="n">existing</span><span class="p">.</span><span class="nf">merge!</span><span class="p">(</span><span class="n">attrs</span><span class="p">)</span>
|
|
402
|
-
<span class="k">else</span>
|
|
403
|
-
<span class="no">Post</span><span class="o">::</span><span class="no">DATA</span> <span class="o"><<</span> <span class="n">attrs</span>
|
|
404
|
-
<span class="k">end</span>
|
|
405
|
-
<span class="n">model</span>
|
|
406
|
-
<span class="k">end</span>
|
|
407
|
-
|
|
408
|
-
<span class="c1"># For wrapping persistence operations in a DB transactions</span>
|
|
409
|
-
<span class="c1"># Our in-memory DB doesn't have transactions, so just yield</span>
|
|
410
|
-
<span class="k">def</span> <span class="nf">transaction</span><span class="p">(</span><span class="o">*</span><span class="p">)</span>
|
|
411
|
-
<span class="k">yield</span>
|
|
412
|
-
<span class="k">end</span></code></pre></figure>
|
|
413
|
-
|
|
414
|
-
<p>That’s really it. <a href="https://github.com/graphiti-api/employee_directory/blob/poro/app/resources/post_resource.rb">See the working code in Employee Directory here</a>.</p>
|
|
415
|
-
|
|
416
|
-
</div>
|
|
417
|
-
</div>
|
|
418
|
-
</main>
|
|
419
|
-
<div class="main-footer main-footer--dark">
|
|
420
|
-
<div class="container">
|
|
421
|
-
<div class="row">
|
|
422
|
-
<div class="col-sm-4 menu">
|
|
423
|
-
<h3>Overview</h3>
|
|
424
|
-
<ul>
|
|
425
|
-
<li>
|
|
426
|
-
<a href="/1.13/quickstart">Quickstart</a>
|
|
427
|
-
</li>
|
|
428
|
-
<li>
|
|
429
|
-
<a href="/1.13/tutorial">Tutorial</a>
|
|
430
|
-
</li>
|
|
431
|
-
<li>
|
|
432
|
-
<a href="/1.13/guides">Guides</a>
|
|
433
|
-
</li>
|
|
434
|
-
</ul>
|
|
435
|
-
</div>
|
|
436
|
-
<div class="col-sm-4 menu">
|
|
437
|
-
<h3>Contact</h3>
|
|
438
|
-
<ul>
|
|
439
|
-
<li>
|
|
440
|
-
<a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
|
|
441
|
-
</li>
|
|
442
|
-
<li>
|
|
443
|
-
<a href="mailto:richmolj@gmail.com">Email</a>
|
|
444
|
-
</li>
|
|
445
|
-
</ul>
|
|
446
|
-
</div>
|
|
447
|
-
<div class="col-sm-4 menu">
|
|
448
|
-
<h3>Related</h3>
|
|
449
|
-
<ul>
|
|
450
|
-
<li>
|
|
451
|
-
<a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
|
|
452
|
-
</li>
|
|
453
|
-
<li>
|
|
454
|
-
<a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
|
|
455
|
-
</li>
|
|
456
|
-
<li>
|
|
457
|
-
<a target="_blank" href="https://vuejs.org/">VueJS</a>
|
|
458
|
-
</li>
|
|
459
|
-
</ul>
|
|
460
|
-
</div>
|
|
461
|
-
</div>
|
|
462
|
-
</div>
|
|
463
|
-
</div>
|
|
464
|
-
|
|
465
|
-
<script type="text/javascript">
|
|
466
|
-
$(function () {
|
|
467
|
-
|
|
468
|
-
var flipTabs = function() {
|
|
469
|
-
var isTS = true;
|
|
470
|
-
if (localStorage.getItem('js-lang') === 'javascript') {
|
|
471
|
-
isTS = false;
|
|
472
|
-
}
|
|
473
|
-
|
|
474
|
-
$('.code-tabs').each(function(index, el) {
|
|
475
|
-
if (isTS) {
|
|
476
|
-
console.log('hiding js');
|
|
477
|
-
$($(el).children()[1]).hide();
|
|
478
|
-
$($(el).children()[0]).show();
|
|
479
|
-
} else {
|
|
480
|
-
console.log('hiding ts');
|
|
481
|
-
$($(el).children()[0]).hide();
|
|
482
|
-
$($(el).children()[1]).show();
|
|
483
|
-
}
|
|
484
|
-
});
|
|
485
|
-
|
|
486
|
-
if (isTS) {
|
|
487
|
-
$('.tab.typescript').addClass('active');
|
|
488
|
-
$('.tab.javascript').removeClass('active');
|
|
489
|
-
} else {
|
|
490
|
-
$('.tab.typescript').removeClass('active');
|
|
491
|
-
$('.tab.javascript').addClass('active');
|
|
492
|
-
}
|
|
493
|
-
}
|
|
494
|
-
|
|
495
|
-
$('.tab').click(function() {
|
|
496
|
-
if ($(this).hasClass('typescript')) {
|
|
497
|
-
localStorage.setItem('js-lang', 'typescript');
|
|
498
|
-
} else {
|
|
499
|
-
localStorage.setItem('js-lang', 'javascript');
|
|
500
|
-
}
|
|
501
|
-
|
|
502
|
-
flipTabs();
|
|
503
|
-
});
|
|
504
|
-
|
|
505
|
-
flipTabs();
|
|
506
|
-
})
|
|
507
|
-
</script>
|
|
508
|
-
|
|
509
|
-
</body>
|
|
510
|
-
</html>
|