foobara-redis-crud-driver 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: efa32802bd7b6065e513bef1b4fd296c0ce3571e24206881ae0f0d6571aa21fd
4
+ data.tar.gz: 80ad9758218da58db633b0499b8f20d7b2c7646922238ff6bdfcb8b21a6da6af
5
+ SHA512:
6
+ metadata.gz: 0d357cea2fb696600f07078995f009b325881dfd9c089d3292ea8b463788b30e92e3bfaef654ad58f77b0276117b31d3a7aa4706d4b8f9228b354f03da223da4
7
+ data.tar.gz: 9a96a07a9fbec4ae03078583173dd7c60bb3288a87821e7376ae81ed81cea92ef4c90ac00b2392f4e3f42e6222c53b832af7c2bb6fde691ba297492cd715a431
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 3.2.2
data/CHANGELOG.md ADDED
@@ -0,0 +1,7 @@
1
+ ## [0.0.1] - 2024-11-22
2
+
3
+ - Release as a gem
4
+
5
+ ## [0.0.0] - 2024-01-08
6
+
7
+ - Project birth
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at https://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
data/LICENSE.txt ADDED
@@ -0,0 +1,8 @@
1
+ This project is released under the Mozilla Public License Version 2.0
2
+
3
+ All files in this project/repository are released under the
4
+ Mozilla Public License Version 2.0 license unless otherwise indicated.
5
+
6
+ See LICENSE-MPL-2.0.txt or https://www.mozilla.org/en-US/MPL/2.0/ for details.
7
+
8
+ Copyright (c) 2024 Miles Georgi
data/README.md ADDED
@@ -0,0 +1,55 @@
1
+ # RedisCrudDriver
2
+
3
+ TODO: Delete this and the text below, and describe your gem
4
+
5
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library
6
+ into a gem. Put your Ruby code in the file `lib/redis_crud_driver`. To experiment with that code, run `bin/console` for
7
+ an interactive prompt.
8
+
9
+ ## Installation
10
+
11
+ From this directory, run the following:
12
+
13
+ ```
14
+ bundle config set local.foobara ../foobara
15
+ bundle config set disable_local_branch_check true
16
+ ```
17
+
18
+ NOTE: you don´t need to do this because it is already done, but when setting up a new project, you need to
19
+ put a valid private key in REDIS_CRUD_DRIVER_KEY_FOR_FOOBARA in gitub actions secrets for this
20
+ repository.
21
+
22
+ You can copy the key with something like `cat ~/.ssh/<private_key_you_want_to_use> | xclip`
23
+
24
+ TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it
25
+ to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with
26
+ instructions to install your gem from git if you don't plan to release to RubyGems.org.
27
+
28
+ Install the gem and add to the application's Gemfile by executing:
29
+
30
+ $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
31
+
32
+ If bundler is not being used to manage dependencies, install the gem by executing:
33
+
34
+ $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
35
+
36
+ ## Usage
37
+
38
+ TODO: Write usage instructions here
39
+
40
+ ## Development
41
+
42
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
43
+ also run `bin/console` for an interactive prompt that will allow you to experiment.
44
+
45
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
46
+ version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
47
+ push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
48
+
49
+ ## Contributing
50
+
51
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redis_crud_driver.
52
+
53
+ ### Licensing
54
+
55
+ This project is licensed under the Mozilla Public License Version 2.0. Please see LICENSE.txt for more info.
@@ -0,0 +1,19 @@
1
+ require "redis"
2
+
3
+ require "foobara/all"
4
+
5
+ module Foobara
6
+ class RedisCrudDriver < Persistence::EntityAttributesCrudDriver
7
+ class << self
8
+ def reset_all
9
+ if instance_variable_defined?(:@redis)
10
+ # TODO: protect against this in production
11
+ redis.flushdb
12
+ remove_instance_variable(:@redis)
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
18
+
19
+ Foobara::Util.require_directory("#{__dir__}/../../src")
@@ -0,0 +1,234 @@
1
+ module Foobara
2
+ class RedisCrudDriver < Persistence::EntityAttributesCrudDriver
3
+ class NoRedisUrlError < StandardError; end
4
+
5
+ class << self
6
+ attr_writer :redis
7
+
8
+ def redis
9
+ @redis ||= if ENV["REDIS_URL"]
10
+ Redis.new(url: ENV["REDIS_URL"])
11
+ else
12
+ raise NoRedisUrlError,
13
+ 'Must set ENV["REDIS_URL"] if trying to initialize RedisCrudDriver with no arguments'
14
+ end
15
+ end
16
+ end
17
+
18
+ attr_reader :prefix
19
+
20
+ # TODO: maybe we should distinguish between nil being passed in and no args? nil feels like it could be an error.
21
+ def initialize(connection_or_credentials = nil, prefix: nil)
22
+ @prefix = prefix
23
+ super(connection_or_credentials)
24
+ end
25
+
26
+ def open_connection(connection_url_or_credentials)
27
+ case connection_url_or_credentials
28
+ when Redis
29
+ connection_url_or_credentials
30
+ when ::String
31
+ Redis.new(url: connection_url_or_credentials)
32
+ when ::Hash
33
+ Redis.new(connection_url_or_credentials)
34
+ when nil
35
+ self.class.redis
36
+ end
37
+ end
38
+
39
+ # We don't make use of Redis transaction feature here because they are do not really work
40
+ # like database transactions which is what this feature is based on. We might want to use database transactions
41
+ # in some sort of flush feature though.
42
+ def open_transaction
43
+ # Should we have some kind of fake transaction object that raises errors when used after rolledback/closed?
44
+ Object.new
45
+ end
46
+
47
+ def close_transaction(_raw_tx)
48
+ end
49
+
50
+ def rollback_transaction(_raw_tx)
51
+ # nothing to do... except maybe enter a state where we don't flush anything else
52
+ # but can just rely on higher-up plumbing for that
53
+ end
54
+
55
+ class Table < Persistence::EntityAttributesCrudDriver::Table
56
+ def initialize(...)
57
+ super
58
+
59
+ unless entity_class.primary_key_type.type_symbol == :integer
60
+ # TODO: when primary key is a string such as a uuid we should
61
+ # probably set the score to 0 and use other methods. But not interested in implementing that stuff now.
62
+ # :nocov:
63
+ raise "Only integer primary keys are supported for now"
64
+ # :nocov:
65
+ end
66
+ end
67
+
68
+ def prefix
69
+ crud_driver.prefix
70
+ end
71
+
72
+ def get_id
73
+ redis.incr(sequence_key)
74
+ end
75
+
76
+ def sequence_key
77
+ @sequence_key ||= "#{entity_key_prefix}$sequence"
78
+ end
79
+
80
+ def primary_keys_index_key
81
+ @primary_keys_index_key ||= "#{entity_key_prefix}$all"
82
+ end
83
+
84
+ def entity_key_prefix
85
+ @entity_key_prefix ||= [*prefix, table_name].join(":")
86
+ end
87
+
88
+ def record_key_prefix(record_id)
89
+ "#{entity_key_prefix}:#{record_id}"
90
+ end
91
+
92
+ def all
93
+ Enumerator.new do |yielder|
94
+ batches_of_primary_keys.each do |batch|
95
+ raw_records = redis.pipelined do |p|
96
+ batch.each do |record_id|
97
+ p.hgetall(record_key_prefix(record_id))
98
+ end
99
+ end
100
+
101
+ raw_records.each do |raw_record|
102
+ yielder << restore_attributes_from_redis(raw_record)
103
+ end
104
+ end
105
+ end.lazy
106
+ end
107
+
108
+ def count
109
+ redis.zcount(primary_keys_index_key, "-inf", "+inf")
110
+ end
111
+
112
+ def find(record_id)
113
+ pairs = redis.hgetall(record_key_prefix(record_id))
114
+
115
+ unless pairs.empty?
116
+ restore_attributes_from_redis(pairs.to_h)
117
+ end
118
+ end
119
+
120
+ def find!(record_id)
121
+ attributes = find(record_id)
122
+
123
+ unless attributes
124
+ raise CannotFindError.new(record_id, "does not exist")
125
+ end
126
+
127
+ attributes
128
+ end
129
+
130
+ def insert(attributes)
131
+ attributes = Util.deep_dup(attributes)
132
+
133
+ record_id = record_id_for(attributes)
134
+
135
+ if record_id
136
+ # TODO: implement exists? using redis instead of super's find
137
+ if exists?(record_id)
138
+ raise CannotInsertError.new(record_id, "already exists")
139
+ end
140
+ else
141
+ record_id = get_id
142
+ attributes.merge!(primary_key_attribute => record_id)
143
+ end
144
+
145
+ prepare_attributes_for_redis(attributes)
146
+
147
+ # TODO: use redis.multi here
148
+ redis.hset(record_key_prefix(record_id), attributes)
149
+ redis.zadd(primary_keys_index_key, record_id, record_id)
150
+ find(record_id)
151
+ end
152
+
153
+ def update(attributes)
154
+ record_id = record_id_for(attributes)
155
+
156
+ unless exists?(record_id)
157
+ # :nocov:
158
+ raise CannotUpdateError.new(record_id, "does not exist")
159
+ # :nocov:
160
+ end
161
+
162
+ attributes = prepare_attributes_for_redis(Util.deep_dup(attributes))
163
+
164
+ redis.hset(record_key_prefix(record_id), attributes)
165
+ find(record_id)
166
+ end
167
+
168
+ def hard_delete(record_id)
169
+ # TODO: add multi
170
+ key = record_key_prefix(record_id)
171
+
172
+ if redis.del(key) != 1
173
+ # :nocov:
174
+ raise CannotUpdateError.new(record_id, "#{key} does not exist")
175
+ # :nocov:
176
+ end
177
+
178
+ unless redis.zrem(primary_keys_index_key, record_id)
179
+ # :nocov:
180
+ raise "Unexpected: when deleting #{key}, " \
181
+ "#{record_id} was not present in the primary key index for #{primary_keys_index_key}"
182
+ # :nocov:
183
+ end
184
+ end
185
+
186
+ def hard_delete_all
187
+ batches_of_primary_keys.each do |batch|
188
+ redis.pipelined do |p|
189
+ batch.each do |record_id|
190
+ p.del(record_key_prefix(record_id))
191
+ p.zrem(primary_keys_index_key, record_id)
192
+ end
193
+ end
194
+ end
195
+ end
196
+
197
+ private
198
+
199
+ def redis
200
+ raw_connection
201
+ end
202
+
203
+ def prepare_attributes_for_redis(attributes)
204
+ attributes.transform_values! do |value|
205
+ JSON.fast_generate(value)
206
+ end
207
+ end
208
+
209
+ def restore_attributes_from_redis(attributes)
210
+ attributes.to_h do |attribute_name, value|
211
+ [attribute_name.to_sym, JSON.parse(value)]
212
+ end
213
+ end
214
+
215
+ def batches_of_primary_keys
216
+ limit = [0, 50]
217
+
218
+ lower_bound = 0
219
+
220
+ Enumerator.new do |yielder|
221
+ loop do
222
+ batch = redis.zrangebyscore(primary_keys_index_key, lower_bound, "+inf", limit:)
223
+
224
+ break if batch.empty?
225
+
226
+ yielder << batch
227
+
228
+ lower_bound = batch.last.to_i + 1
229
+ end
230
+ end.lazy
231
+ end
232
+ end
233
+ end
234
+ end
metadata ADDED
@@ -0,0 +1,83 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: foobara-redis-crud-driver
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Miles Georgi
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2024-11-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: foobara
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: redis
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ description: Provides support for entity CRUD in Redis for Foobara
42
+ email:
43
+ - azimux@gmail.com
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - ".ruby-version"
49
+ - CHANGELOG.md
50
+ - LICENSE-MPL-2.0.txt
51
+ - LICENSE.txt
52
+ - README.md
53
+ - lib/foobara/redis_crud_driver.rb
54
+ - src/foobara/redis_crud_driver.rb
55
+ homepage: https://github.com/foobara/redis-crud-driver
56
+ licenses:
57
+ - MPL-2.0
58
+ metadata:
59
+ homepage_uri: https://github.com/foobara/redis-crud-driver
60
+ source_code_uri: https://github.com/foobara/redis-crud-driver
61
+ changelog_uri: https://github.com/foobara/redis-crud-driver/blob/main/CHANGELOG.md
62
+ rubygems_mfa_required: 'true'
63
+ post_install_message:
64
+ rdoc_options: []
65
+ require_paths:
66
+ - lib
67
+ - src
68
+ required_ruby_version: !ruby/object:Gem::Requirement
69
+ requirements:
70
+ - - ">="
71
+ - !ruby/object:Gem::Version
72
+ version: 3.2.2
73
+ required_rubygems_version: !ruby/object:Gem::Requirement
74
+ requirements:
75
+ - - ">="
76
+ - !ruby/object:Gem::Version
77
+ version: '0'
78
+ requirements: []
79
+ rubygems_version: 3.5.23
80
+ signing_key:
81
+ specification_version: 4
82
+ summary: Provides support for entity CRUD in Redis for Foobara
83
+ test_files: []