foobara-postgresql-crud-driver 0.0.1

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 ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 3372860139e831774b1d0dcf96d276475e9c128758383e0d43eaf3b0aa43191e
4
+ data.tar.gz: 271a58763b91f23402447a8790d454b30c16420d72821d58a9244068a8923b54
5
+ SHA512:
6
+ metadata.gz: d43d752a836148695674b2886d5a117831867a14498cbcce06b229f725a64d141beaa3bf883e3a0a62cc0abc1aee6d7775529dcff7f693d8754f7e2ba6cb326a
7
+ data.tar.gz: 2c578ece66b3b77dcb3c63d7ff8368407a9e2b33a0ea4f4502dcc33b4fb9b4249df5fe787b661ddb0959770224f6517b88ccaf9f72c02f3d790efd84cf6f8c54
data/CHANGELOG.md ADDED
@@ -0,0 +1,7 @@
1
+ ## [0.0.1] - 2025-06-16
2
+
3
+ - Initial release
4
+
5
+ ## [0.0.0] - 2025-05-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,9 @@
1
+ This project is licensed under the MPL-2.0 license.
2
+
3
+
4
+ MPL-2.0 License: LICENSE-MPL-2.0.txt or https://www.mozilla.org/MPL/2.0/
5
+
6
+
7
+ This is equivalent to the following SPDX License Expression: MPL-2.0
8
+
9
+ Copyright (c) 2025 Miles Georgi
data/README.md ADDED
@@ -0,0 +1,47 @@
1
+ # Foobara::PostgresqlCrudDriver
2
+
3
+ Allows persisting Foobara Entity records in a Postgres database
4
+
5
+ ## Installation
6
+
7
+ Typical stuff: add `gem "foobara-postgresql-crud-driver"` to your Gemfile or .gemspec file. Or even just
8
+ `gem install foobara-postgresql-crud-driver` if just playing with it directly in scripts.
9
+
10
+ ## Usage
11
+
12
+ You can initialize a Foobara::PostgresqlCrudDriver instance with a URL, a credentials hash, or nothing at all
13
+ which will use the contents of `ENV["DATABASE_URL"]` by default.
14
+
15
+ ```ruby
16
+ crud_driver = Foobara::PostgresqlCrudDriver.new("postgres://testuser:testpassword@localhost/testdb")
17
+ Foobara::Persistence.default_crud_driver = crud_driver
18
+ ```
19
+
20
+ Note: There is not currently a Foobara migrations feature or system. So you will have to either manually
21
+ migrate or leach off of migrations of an existing system such as Rails by using the `foobara-rails-command-connector`
22
+ gem. If you think it would be fun to design/implement a migrations system for Foobara, please get in touch!!
23
+
24
+ ## Contributing
25
+
26
+ Bug reports and pull requests are welcome on GitHub
27
+ at https://github.com/foobara/postgresql-crud-driver
28
+
29
+ ## Development
30
+
31
+ If not using Docker, you can use the system postgres and setup a test database user. On the command line you can:
32
+
33
+ ```
34
+ $ sudo -u postgres psql
35
+ ```
36
+
37
+ And then:
38
+
39
+ ```sql
40
+ CREATE USER testuser WITH PASSWORD 'testpassword' CREATEDB;
41
+ ```
42
+
43
+ TODO: add instructions for use with docker and docker-compose.yml file
44
+
45
+ ## License
46
+
47
+ This project is licensed under the MPL-2.0 license. Please see LICENSE.txt for more info.
@@ -0,0 +1,4 @@
1
+ require "foobara/all"
2
+ require "pg"
3
+
4
+ Foobara::Util.require_directory "#{__dir__}/../../src"
@@ -0,0 +1,46 @@
1
+ module Foobara
2
+ class PostgresqlCrudDriver < Persistence::EntityAttributesCrudDriver
3
+ class ConnectionPool
4
+ class TooManyConnectionsError < StandardError; end
5
+
6
+ attr_accessor :max_connections, :connection_proc, :available_connections, :in_use_connections
7
+
8
+ def initialize(max_connections: 5, &connection_proc)
9
+ self.max_connections = max_connections
10
+ self.connection_proc = connection_proc
11
+ self.available_connections = []
12
+ self.in_use_connections = []
13
+ end
14
+
15
+ def checkout
16
+ connection = available_connections.pop
17
+
18
+ unless connection
19
+ if in_use_connections.size >= max_connections
20
+ # :nocov:
21
+ raise TooManyConnectionsError, "#{in_use_connections.size} connections in use, cannot allocate more."
22
+ # :nocov:
23
+ end
24
+
25
+ connection = connection_proc.call
26
+ end
27
+
28
+ in_use_connections << connection
29
+
30
+ connection
31
+ end
32
+
33
+ def checkin(connection)
34
+ in_use_connections.delete(connection)
35
+ available_connections << connection
36
+ end
37
+
38
+ def clear(&)
39
+ available_connections.each(&)
40
+ in_use_connections.each(&)
41
+ available_connections.clear
42
+ in_use_connections.clear
43
+ end
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,11 @@
1
+ module Foobara
2
+ class PostgresqlCrudDriver < Persistence::EntityAttributesCrudDriver
3
+ class PgTransaction
4
+ attr_accessor :connection
5
+
6
+ def initialize(connection)
7
+ self.connection = connection
8
+ end
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,412 @@
1
+ module Foobara
2
+ class PostgresqlCrudDriver < Persistence::EntityAttributesCrudDriver
3
+ class NoDatabaseUrlError < StandardError; end
4
+ class NoSuchColumnOrTableError < StandardError; end
5
+
6
+ class UnsupportedPgColumnTypeError < StandardError
7
+ def initialize(pg_type, attribute_name, entity_class)
8
+ # :nocov:
9
+ super("Unsupported column type #{pg_type} for attribute #{attribute_name} on #{entity_class.entity_name}")
10
+ # :nocov:
11
+ end
12
+ end
13
+
14
+ class << self
15
+ def get_transaction_number
16
+ @get_transaction_number ||= 0
17
+ @get_transaction_number += 1
18
+ if @get_transaction_number > 65_535
19
+ # TODO: test this codepath somehow
20
+ # :nocov:
21
+ @get_transaction_number = 1
22
+ # :nocov:
23
+ end
24
+ @get_transaction_number
25
+ end
26
+
27
+ def has_real_transactions?
28
+ true
29
+ end
30
+
31
+ def escape_identifier(identifier)
32
+ if identifier.is_a?(::Symbol)
33
+ identifier = identifier.to_s
34
+ end
35
+
36
+ "\"#{PG::Connection.escape(identifier).gsub('"', '""')}\""
37
+ end
38
+ end
39
+
40
+ attr_accessor :creds, :transaction_number
41
+
42
+ # We intentionally don't call super because super would open a connection which we do not want
43
+ # since we want one connection per transaction.
44
+ # rubocop:disable Lint/MissingSuper
45
+ def initialize(connection_or_credentials = nil)
46
+ self.transaction_number = self.class.get_transaction_number
47
+ self.tables = {}
48
+ self.creds = case connection_or_credentials
49
+ when ::String, ::Hash
50
+ connection_or_credentials
51
+ when nil
52
+ ENV["DATABASE_URL"] || raise(
53
+ NoDatabaseUrlError,
54
+ 'Must set ENV["DATABASE_URL"] if trying to initialize PostgresqlCrudDriver with no arguments'
55
+ )
56
+ else
57
+ # :nocov:
58
+ raise ArgumentError, "Expected a String or Hash with connection creds or nil with DATABASE_URL set"
59
+ # :nocov:
60
+ end
61
+ end
62
+ # rubocop:enable Lint/MissingSuper
63
+
64
+ def open_connection
65
+ PG.connect(creds)
66
+ end
67
+
68
+ def connection_pool
69
+ @connection_pool ||= ConnectionPool.new(max_connections: 5) { open_connection }
70
+ end
71
+
72
+ def open_transaction
73
+ connection = connection_pool.checkout
74
+ tx = PgTransaction.new(connection)
75
+ connection.exec("BEGIN")
76
+ flush_transaction(tx)
77
+ tx
78
+ end
79
+
80
+ def flush_transaction(raw_tx)
81
+ raw_tx.connection.exec("SAVEPOINT foobara_crud_driver_revert_point_#{transaction_number}")
82
+ end
83
+
84
+ def revert_transaction(raw_tx)
85
+ raw_tx.connection.exec("ROLLBACK TO foobara_crud_driver_revert_point_#{transaction_number}")
86
+ end
87
+
88
+ def rollback_transaction(raw_tx)
89
+ raw_tx.connection.exec("ROLLBACK")
90
+ connection_pool.checkin(raw_tx.connection)
91
+ end
92
+
93
+ def commit_transaction(raw_tx)
94
+ raw_tx.connection.exec("COMMIT")
95
+ connection_pool.checkin(raw_tx.connection)
96
+ end
97
+
98
+ class Table < Persistence::EntityAttributesCrudDriver::Table
99
+ ARRAY_ELEMENT_ENCODERS = {
100
+ "_int4" => PG::TextEncoder::Integer.new,
101
+ "_int8" => PG::TextEncoder::Integer.new,
102
+ "_text" => PG::TextEncoder::String.new,
103
+ "_varchar" => PG::TextEncoder::String.new,
104
+ "_bool" => PG::TextEncoder::Boolean.new,
105
+ "_float4" => PG::TextEncoder::Float.new,
106
+ "_float8" => PG::TextEncoder::Float.new
107
+ }.freeze
108
+
109
+ def all(page_size: nil)
110
+ Enumerator.new do |yielder|
111
+ after = nil
112
+
113
+ loop do
114
+ page = fetch_page(after:, page_size:)
115
+
116
+ break if page.empty?
117
+
118
+ page.each do |record|
119
+ yielder << record
120
+ end
121
+
122
+ after = DataPath.value_at(entity_class.primary_key_attribute, page.last)
123
+ end
124
+ end.lazy
125
+ end
126
+
127
+ def fetch_page(after: nil, page_size: nil, order_by: entity_class.primary_key_attribute)
128
+ page_size ||= 100
129
+
130
+ sql = <<~SQL
131
+ SELECT *
132
+ FROM #{PostgresqlCrudDriver.escape_identifier(table_name)}
133
+ SQL
134
+
135
+ if after
136
+ column, value = normalize_attribute(order_by, after)
137
+ sql += " WHERE #{column} > #{value} "
138
+ else
139
+ column = PostgresqlCrudDriver.escape_identifier(order_by)
140
+ end
141
+
142
+ sql += <<~SQL
143
+ ORDER BY #{column}
144
+ LIMIT #{page_size}
145
+ SQL
146
+
147
+ result_data = raw_connection.exec(sql)
148
+
149
+ result_data.map do |attributes|
150
+ restore_pg_attributes(attributes)
151
+ end
152
+ end
153
+
154
+ def insert(attributes)
155
+ columns = []
156
+ values = []
157
+
158
+ attributes.each_pair do |attribute_name, value|
159
+ column_name, value = normalize_attribute(attribute_name, value)
160
+
161
+ columns << column_name
162
+ values << value
163
+ end
164
+
165
+ sql = <<~SQL
166
+ INSERT INTO #{PostgresqlCrudDriver.escape_identifier(table_name)}
167
+ (#{columns.join(", ")})
168
+ VALUES (#{values.join(", ")})
169
+ RETURNING #{PostgresqlCrudDriver.escape_identifier(entity_class.primary_key_attribute)}
170
+ SQL
171
+
172
+ record_data = raw_connection.exec(sql)
173
+ record_id = record_data.first[entity_class.primary_key_attribute.to_s]
174
+
175
+ find(record_id)
176
+ rescue PG::UniqueViolation => e
177
+ raise CannotInsertError.new(record_id, "already exists: #{e.message}")
178
+ end
179
+
180
+ def count
181
+ sql = <<~SQL
182
+ SELECT COUNT(*)
183
+ FROM #{PostgresqlCrudDriver.escape_identifier(table_name)}
184
+ SQL
185
+
186
+ raw_connection.exec(sql).first["count"].to_i
187
+ end
188
+
189
+ def find(record_id)
190
+ column, value = normalize_attribute(entity_class.primary_key_attribute, record_id)
191
+
192
+ sql = <<~SQL
193
+ SELECT *
194
+ FROM #{PostgresqlCrudDriver.escape_identifier(table_name)}
195
+ WHERE #{column} = #{value}
196
+ SQL
197
+
198
+ attributes = raw_connection.exec(sql).first
199
+
200
+ restore_pg_attributes(attributes)
201
+ end
202
+
203
+ def update(attributes)
204
+ record_id = record_id_for(attributes)
205
+
206
+ unless exists?(record_id)
207
+ # :nocov:
208
+ raise CannotUpdateError.new(record_id, "does not exist")
209
+ # :nocov:
210
+ end
211
+
212
+ set_expressions = []
213
+
214
+ attributes.each_pair do |attribute_name, value|
215
+ column_name, value = normalize_attribute(attribute_name, value)
216
+
217
+ set_expressions << "#{column_name} = #{value}"
218
+ end
219
+
220
+ primary_key, record_id = normalize_attribute(entity_class.primary_key_attribute, record_id)
221
+
222
+ sql = <<~SQL
223
+ UPDATE #{PostgresqlCrudDriver.escape_identifier(table_name)}
224
+ SET #{set_expressions.join(", ")}
225
+ WHERE #{primary_key} = #{record_id}
226
+ SQL
227
+
228
+ raw_connection.exec(sql)
229
+ find(record_id)
230
+ end
231
+
232
+ def hard_delete(record_id)
233
+ unless exists?(record_id)
234
+ # :nocov:
235
+ raise CannotDeleteError.new(record_id, "does not exist")
236
+ # :nocov:
237
+ end
238
+
239
+ primary_key, record_id = normalize_attribute(entity_class.primary_key_attribute, record_id)
240
+
241
+ sql = <<~SQL
242
+ DELETE FROM #{PostgresqlCrudDriver.escape_identifier(table_name)}
243
+ WHERE #{primary_key} = #{record_id}
244
+ SQL
245
+
246
+ raw_connection.exec(sql)
247
+ end
248
+
249
+ def hard_delete_all
250
+ sql = <<~SQL
251
+ DELETE FROM #{PostgresqlCrudDriver.escape_identifier(table_name)}
252
+ SQL
253
+
254
+ raw_connection.exec(sql)
255
+ end
256
+
257
+ private
258
+
259
+ def raw_connection
260
+ # Feels so weird to grab the transaction this way, hmmm
261
+ entity_class.current_transaction.raw_tx.connection
262
+ end
263
+
264
+ def restore_pg_attributes(attributes)
265
+ return attributes if attributes.nil?
266
+
267
+ attributes = attributes.to_h do |attribute_name, value|
268
+ info = column_info[attribute_name.to_s]
269
+
270
+ value = case info[:type]
271
+ when "integer", "text", "timestamp without time zone"
272
+ value
273
+ when "jsonb"
274
+ if value.nil?
275
+ unless info[:is_nullable]
276
+ # :nocov:
277
+ raise "Unexpected nil value for #{attribute_name}"
278
+ # :nocov:
279
+ end
280
+
281
+ nil
282
+ else
283
+ JSON.parse(value)
284
+ end
285
+ when "ARRAY"
286
+ decoder = PG::TextDecoder::Array.new(name: info[:element_type])
287
+ decoder.decode(value)
288
+ else
289
+ # :nocov:
290
+ raise UnsupportedPgColumnTypeError.new(info[:type], attribute_name, entity_class)
291
+ # :nocov:
292
+ end
293
+
294
+ [attribute_name, value]
295
+ end
296
+
297
+ # TODO: don't do this?
298
+ entity_class.attributes_type.process_value!(attributes)
299
+ end
300
+
301
+ def normalize_attribute(attribute_name, value)
302
+ info = column_info[attribute_name.to_s]
303
+
304
+ unless info
305
+ # :nocov:
306
+ raise NoSuchColumnOrTableError, "Either #{table_name} or #{table_name}.#{attribute_name} does not exist"
307
+ # :nocov:
308
+ end
309
+
310
+ pg_type = info[:type]
311
+ foobara_type = entity_class.model_type.element_types.element_types[attribute_name]
312
+
313
+ value = if value.nil?
314
+ if info[:is_nullable]
315
+ "NULL"
316
+ else
317
+ # :nocov:
318
+ raise "Unexpected nil value for #{attribute_name}"
319
+ # :nocov:
320
+ end
321
+ elsif foobara_type.extends?(:number)
322
+ case pg_type
323
+ when "integer"
324
+ value.to_i
325
+ else
326
+ # :nocov:
327
+ raise UnsupportedPgColumnTypeError.new(pg_type, attribute_name, entity_class)
328
+ # :nocov:
329
+ end
330
+ elsif foobara_type.extends?(:string) || foobara_type.extends?(:symbol)
331
+ case pg_type
332
+ when "text"
333
+ "'#{PG::Connection.escape(value.to_s)}'"
334
+ else
335
+ # :nocov:
336
+ raise UnsupportedPgColumnTypeError.new(pg_type, attribute_name, entity_class)
337
+ # :nocov:
338
+ end
339
+ elsif foobara_type.extends?(:datetime)
340
+ case pg_type
341
+ when "timestamp without time zone"
342
+ "'#{PG::Connection.escape(value.inspect)}'"
343
+ else
344
+ # :nocov:
345
+ raise UnsupportedPgColumnTypeError.new(pg_type, attribute_name, entity_class)
346
+ # :nocov:
347
+ end
348
+ elsif foobara_type.extends?(:model) || foobara_type.extends?(:attributes)
349
+ case pg_type
350
+ when "jsonb"
351
+ "'#{PG::Connection.escape(JSON.fast_generate(value))}'"
352
+ else
353
+ # :nocov:
354
+ raise UnsupportedPgColumnTypeError.new(pg_type, attribute_name, entity_class)
355
+ # :nocov:
356
+ end
357
+ elsif foobara_type.extends?(:array)
358
+ element_type = foobara_type.element_type
359
+
360
+ if element_type.extends?(:detached_entity)
361
+ case pg_type
362
+ when "ARRAY"
363
+ elements_type = ARRAY_ELEMENT_ENCODERS[info[:element_type]]
364
+ array_string = PG::TextEncoder::Array.new(elements_type:).encode(value)
365
+ escaped = PG::Connection.escape(array_string)
366
+
367
+ "'#{escaped}'"
368
+ else
369
+ # :nocov:
370
+ raise UnsupportedPgColumnTypeError.new(pg_type, attribute_name, entity_class)
371
+ # :nocov:
372
+ end
373
+ else
374
+ # :nocov:
375
+ raise UnsupportedPgColumnTypeError.new(pg_type, attribute_name, entity_class)
376
+ # :nocov:
377
+ end
378
+ else
379
+ # :nocov:
380
+ raise UnsupportedPgColumnTypeError.new(pg_type, attribute_name, entity_class)
381
+ # :nocov:
382
+ end
383
+
384
+ [PostgresqlCrudDriver.escape_identifier(attribute_name), value]
385
+ end
386
+
387
+ def column_info
388
+ return @column_info if @column_info
389
+
390
+ sql = <<~HERE
391
+ SELECT column_name, data_type, is_nullable, udt_name
392
+ FROM information_schema.columns
393
+ WHERE table_schema = 'public' AND table_name = '#{raw_connection.escape(table_name)}'
394
+ ORDER BY ordinal_position
395
+ HERE
396
+
397
+ result = raw_connection.exec(sql)
398
+
399
+ @column_info = result.to_h do |row|
400
+ [
401
+ row["column_name"],
402
+ {
403
+ type: row["data_type"],
404
+ is_nullable: row["is_nullable"] == "YES",
405
+ element_type: row["udt_name"]
406
+ }
407
+ ]
408
+ end
409
+ end
410
+ end
411
+ end
412
+ end
metadata ADDED
@@ -0,0 +1,79 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: foobara-postgresql-crud-driver
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Miles Georgi
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: foobara
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - "~>"
17
+ - !ruby/object:Gem::Version
18
+ version: 0.0.131
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - "~>"
24
+ - !ruby/object:Gem::Version
25
+ version: 0.0.131
26
+ - !ruby/object:Gem::Dependency
27
+ name: pg
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: '0'
33
+ type: :runtime
34
+ prerelease: false
35
+ version_requirements: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - ">="
38
+ - !ruby/object:Gem::Version
39
+ version: '0'
40
+ email:
41
+ - azimux@gmail.com
42
+ executables: []
43
+ extensions: []
44
+ extra_rdoc_files: []
45
+ files:
46
+ - CHANGELOG.md
47
+ - LICENSE-MPL-2.0.txt
48
+ - LICENSE.txt
49
+ - README.md
50
+ - lib/foobara/postgresql_crud_driver.rb
51
+ - src/connection_pool.rb
52
+ - src/pg_transaction.rb
53
+ - src/postgresql_crud_driver.rb
54
+ homepage: https://github.com/foobara/postgresql-crud-driver
55
+ licenses:
56
+ - MPL-2.0
57
+ metadata:
58
+ homepage_uri: https://github.com/foobara/postgresql-crud-driver
59
+ source_code_uri: https://github.com/foobara/postgresql-crud-driver
60
+ changelog_uri: https://github.com/foobara/postgresql-crud-driver/blob/main/CHANGELOG.md
61
+ rubygems_mfa_required: 'true'
62
+ rdoc_options: []
63
+ require_paths:
64
+ - lib
65
+ required_ruby_version: !ruby/object:Gem::Requirement
66
+ requirements:
67
+ - - ">="
68
+ - !ruby/object:Gem::Version
69
+ version: 3.4.0
70
+ required_rubygems_version: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - ">="
73
+ - !ruby/object:Gem::Version
74
+ version: '0'
75
+ requirements: []
76
+ rubygems_version: 3.6.9
77
+ specification_version: 4
78
+ summary: Provides a CRUD driver for reading/writing entities with a PostgreSQL database
79
+ test_files: []