skyward-orm 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (191) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +182 -75
  3. data/lib/skyward/orm/adapters/postgresql/connection.rb +52 -0
  4. data/lib/skyward/orm/adapters/postgresql.rb +283 -0
  5. data/lib/skyward/orm/adapters/sqlite/constraints.rb +172 -0
  6. data/lib/skyward/orm/adapters/sqlite.rb +317 -0
  7. data/lib/skyward/orm/adapters.rb +38 -0
  8. data/lib/skyward/orm/catalog/column.rb +12 -0
  9. data/lib/skyward/orm/catalog/constraint.rb +13 -0
  10. data/lib/skyward/orm/catalog/index.rb +11 -0
  11. data/lib/skyward/orm/catalog/table.rb +10 -0
  12. data/lib/skyward/orm/catalog.rb +6 -0
  13. data/lib/skyward/orm/cli/boot_file.rb +43 -0
  14. data/lib/skyward/orm/cli/migrate.rb +30 -0
  15. data/lib/skyward/orm/cli/migration.rb +111 -0
  16. data/lib/skyward/orm/cli/rollback.rb +18 -0
  17. data/lib/skyward/orm/cli/status.rb +36 -0
  18. data/lib/skyward/orm/cli.rb +4 -0
  19. data/lib/skyward/orm/commands.rb +64 -0
  20. data/lib/skyward/orm/connection/database/schema_check.rb +67 -0
  21. data/lib/skyward/orm/connection/database.rb +357 -0
  22. data/lib/skyward/orm/connection/pool.rb +102 -0
  23. data/lib/skyward/orm/connection/session.rb +38 -0
  24. data/lib/skyward/orm/connection.rb +7 -0
  25. data/lib/skyward/orm/members.rb +16 -0
  26. data/lib/skyward/orm/migration_error.rb +4 -0
  27. data/lib/skyward/orm/migrations/add_column.rb +7 -0
  28. data/lib/skyward/orm/migrations/add_constraint.rb +7 -0
  29. data/lib/skyward/orm/migrations/add_index.rb +7 -0
  30. data/lib/skyward/orm/migrations/alter_table.rb +12 -0
  31. data/lib/skyward/orm/migrations/change_default.rb +9 -0
  32. data/lib/skyward/orm/migrations/change_nullable.rb +8 -0
  33. data/lib/skyward/orm/migrations/change_type.rb +9 -0
  34. data/lib/skyward/orm/migrations/create_table.rb +8 -0
  35. data/lib/skyward/orm/migrations/definitions.rb +176 -0
  36. data/lib/skyward/orm/migrations/diff.rb +213 -0
  37. data/lib/skyward/orm/migrations/directory.rb +48 -0
  38. data/lib/skyward/orm/migrations/discovery.rb +14 -0
  39. data/lib/skyward/orm/migrations/drop_column.rb +7 -0
  40. data/lib/skyward/orm/migrations/drop_constraint.rb +7 -0
  41. data/lib/skyward/orm/migrations/drop_index.rb +7 -0
  42. data/lib/skyward/orm/migrations/rename_column.rb +8 -0
  43. data/lib/skyward/orm/migrations/runner/edited.rb +7 -0
  44. data/lib/skyward/orm/migrations/runner/failed.rb +8 -0
  45. data/lib/skyward/orm/migrations/runner/irreversible.rb +7 -0
  46. data/lib/skyward/orm/migrations/runner/locked.rb +8 -0
  47. data/lib/skyward/orm/migrations/runner/migration.rb +11 -0
  48. data/lib/skyward/orm/migrations/runner/missing.rb +7 -0
  49. data/lib/skyward/orm/migrations/runner/raced.rb +7 -0
  50. data/lib/skyward/orm/migrations/runner.rb +227 -0
  51. data/lib/skyward/orm/migrations/script.rb +350 -0
  52. data/lib/skyward/orm/migrations/status.rb +93 -0
  53. data/lib/skyward/orm/migrations/summary.rb +110 -0
  54. data/lib/skyward/orm/migrations/versions.rb +19 -0
  55. data/lib/skyward/orm/migrations.rb +8 -0
  56. data/lib/skyward/orm/placeholders.rb +37 -0
  57. data/lib/skyward/orm/pool_timeout.rb +4 -0
  58. data/lib/skyward/orm/projection.rb +67 -0
  59. data/lib/skyward/orm/queries/clauses.rb +588 -0
  60. data/lib/skyward/orm/queries.rb +4 -0
  61. data/lib/skyward/orm/query.rb +26 -0
  62. data/lib/skyward/orm/record.rb +96 -0
  63. data/lib/skyward/orm/schema_mismatch.rb +4 -0
  64. data/lib/skyward/orm/statements.rb +97 -0
  65. data/lib/skyward/orm/tables/check.rb +8 -0
  66. data/lib/skyward/orm/tables/column.rb +10 -0
  67. data/lib/skyward/orm/tables/column_types.rb +74 -0
  68. data/lib/skyward/orm/tables/declarations.rb +172 -0
  69. data/lib/skyward/orm/tables/length.rb +8 -0
  70. data/lib/skyward/orm/tables/loaded.rb +21 -0
  71. data/lib/skyward/orm/tables/reference.rb +9 -0
  72. data/lib/skyward/orm/tables/rows.rb +52 -0
  73. data/lib/skyward/orm/tables/schema.rb +14 -0
  74. data/lib/skyward/orm/tables/sql.rb +7 -0
  75. data/lib/skyward/orm/tables/validation.rb +29 -0
  76. data/lib/skyward/orm/tables/values.rb +102 -0
  77. data/lib/skyward/orm/tables.rb +7 -0
  78. data/lib/skyward/orm/transactional.rb +18 -0
  79. data/lib/skyward/orm/version.rb +1 -1
  80. data/lib/skyward/orm/violation.rb +13 -0
  81. data/lib/skyward/orm/violation_error.rb +13 -0
  82. data/lib/skyward/orm.rb +72 -1
  83. data/sig/generated/skyward/orm/adapters/postgresql/connection.rbs +41 -0
  84. data/sig/generated/skyward/orm/adapters/postgresql.rbs +138 -0
  85. data/sig/generated/skyward/orm/adapters/sqlite/constraints.rbs +87 -0
  86. data/sig/generated/skyward/orm/adapters/sqlite.rbs +166 -0
  87. data/sig/generated/skyward/orm/adapters.rbs +15 -0
  88. data/sig/generated/skyward/orm/catalog/column.rbs +20 -0
  89. data/sig/generated/skyward/orm/catalog/constraint.rbs +22 -0
  90. data/sig/generated/skyward/orm/catalog/index.rbs +20 -0
  91. data/sig/generated/skyward/orm/catalog/table.rbs +20 -0
  92. data/sig/generated/skyward/orm/catalog.rbs +5 -0
  93. data/sig/generated/skyward/orm/cli/boot_file.rbs +21 -0
  94. data/sig/generated/skyward/orm/cli/migrate.rbs +15 -0
  95. data/sig/generated/skyward/orm/cli/migration.rbs +45 -0
  96. data/sig/generated/skyward/orm/cli/rollback.rbs +7 -0
  97. data/sig/generated/skyward/orm/cli/status.rbs +17 -0
  98. data/sig/generated/skyward/orm/cli.rbs +4 -0
  99. data/sig/generated/skyward/orm/commands.rbs +2 -0
  100. data/sig/generated/skyward/orm/connection/database/schema_check.rbs +31 -0
  101. data/sig/generated/skyward/orm/connection/database.rbs +226 -0
  102. data/sig/generated/skyward/orm/connection/pool.rbs +54 -0
  103. data/sig/generated/skyward/orm/connection/session.rbs +25 -0
  104. data/sig/generated/skyward/orm/connection.rbs +7 -0
  105. data/sig/generated/skyward/orm/members.rbs +9 -0
  106. data/sig/generated/skyward/orm/migration_error.rbs +4 -0
  107. data/sig/generated/skyward/orm/migrations/add_column.rbs +14 -0
  108. data/sig/generated/skyward/orm/migrations/add_constraint.rbs +14 -0
  109. data/sig/generated/skyward/orm/migrations/add_index.rbs +14 -0
  110. data/sig/generated/skyward/orm/migrations/alter_table.rbs +22 -0
  111. data/sig/generated/skyward/orm/migrations/change_default.rbs +18 -0
  112. data/sig/generated/skyward/orm/migrations/change_nullable.rbs +16 -0
  113. data/sig/generated/skyward/orm/migrations/change_type.rbs +18 -0
  114. data/sig/generated/skyward/orm/migrations/create_table.rbs +16 -0
  115. data/sig/generated/skyward/orm/migrations/definitions.rbs +81 -0
  116. data/sig/generated/skyward/orm/migrations/diff.rbs +99 -0
  117. data/sig/generated/skyward/orm/migrations/directory.rbs +37 -0
  118. data/sig/generated/skyward/orm/migrations/discovery.rbs +9 -0
  119. data/sig/generated/skyward/orm/migrations/drop_column.rbs +14 -0
  120. data/sig/generated/skyward/orm/migrations/drop_constraint.rbs +14 -0
  121. data/sig/generated/skyward/orm/migrations/drop_index.rbs +14 -0
  122. data/sig/generated/skyward/orm/migrations/rename_column.rbs +16 -0
  123. data/sig/generated/skyward/orm/migrations/runner/edited.rbs +14 -0
  124. data/sig/generated/skyward/orm/migrations/runner/failed.rbs +16 -0
  125. data/sig/generated/skyward/orm/migrations/runner/irreversible.rbs +14 -0
  126. data/sig/generated/skyward/orm/migrations/runner/locked.rbs +16 -0
  127. data/sig/generated/skyward/orm/migrations/runner/migration.rbs +22 -0
  128. data/sig/generated/skyward/orm/migrations/runner/missing.rbs +14 -0
  129. data/sig/generated/skyward/orm/migrations/runner/raced.rbs +14 -0
  130. data/sig/generated/skyward/orm/migrations/runner.rbs +73 -0
  131. data/sig/generated/skyward/orm/migrations/script.rbs +161 -0
  132. data/sig/generated/skyward/orm/migrations/status.rbs +49 -0
  133. data/sig/generated/skyward/orm/migrations/summary.rbs +50 -0
  134. data/sig/generated/skyward/orm/migrations/versions.rbs +11 -0
  135. data/sig/generated/skyward/orm/migrations.rbs +7 -0
  136. data/sig/generated/skyward/orm/placeholders.rbs +21 -0
  137. data/sig/generated/skyward/orm/pool_timeout.rbs +4 -0
  138. data/sig/generated/skyward/orm/projection.rbs +42 -0
  139. data/sig/generated/skyward/orm/queries/clauses.rbs +367 -0
  140. data/sig/generated/skyward/orm/queries.rbs +4 -0
  141. data/sig/generated/skyward/orm/query.rbs +20 -0
  142. data/sig/generated/skyward/orm/record.rbs +80 -0
  143. data/sig/generated/skyward/orm/schema_mismatch.rbs +4 -0
  144. data/sig/generated/skyward/orm/statements.rbs +53 -0
  145. data/sig/generated/skyward/orm/tables/check.rbs +16 -0
  146. data/sig/generated/skyward/orm/tables/column.rbs +20 -0
  147. data/sig/generated/skyward/orm/tables/column_types.rbs +39 -0
  148. data/sig/generated/skyward/orm/tables/declarations.rbs +87 -0
  149. data/sig/generated/skyward/orm/tables/length.rbs +16 -0
  150. data/sig/generated/skyward/orm/tables/loaded.rbs +14 -0
  151. data/sig/generated/skyward/orm/tables/reference.rbs +18 -0
  152. data/sig/generated/skyward/orm/tables/rows.rbs +24 -0
  153. data/sig/generated/skyward/orm/tables/schema.rbs +28 -0
  154. data/sig/generated/skyward/orm/tables/sql.rbs +14 -0
  155. data/sig/generated/skyward/orm/tables/validation.rbs +9 -0
  156. data/sig/generated/skyward/orm/tables/values.rbs +49 -0
  157. data/sig/generated/skyward/orm/tables.rbs +7 -0
  158. data/sig/generated/skyward/orm/transactional.rbs +11 -0
  159. data/sig/generated/skyward/orm/violation.rbs +22 -0
  160. data/sig/generated/skyward/orm/violation_error.rbs +10 -0
  161. data/sig/generated/skyward/orm.rbs +29 -0
  162. data/sig/manual/pg.rbs +31 -0
  163. data/sig/manual/skyward/orm/adapters/postgresql.rbs +3 -0
  164. data/sig/manual/skyward/orm/adapters/sqlite/constraints.rbs +3 -0
  165. data/sig/manual/skyward/orm/adapters/sqlite.rbs +3 -0
  166. data/sig/manual/skyward/orm/adapters.rbs +3 -0
  167. data/sig/manual/skyward/orm/cli/boot_file.rbs +3 -0
  168. data/sig/manual/skyward/orm/cli/migrate.rbs +3 -0
  169. data/sig/manual/skyward/orm/cli/migration.rbs +3 -0
  170. data/sig/manual/skyward/orm/cli/rollback.rbs +3 -0
  171. data/sig/manual/skyward/orm/cli/status.rbs +3 -0
  172. data/sig/manual/skyward/orm/connection/database/schema_check.rbs +3 -0
  173. data/sig/manual/skyward/orm/members.rbs +3 -0
  174. data/sig/manual/skyward/orm/migrations/definitions.rbs +3 -0
  175. data/sig/manual/skyward/orm/migrations/diff.rbs +3 -0
  176. data/sig/manual/skyward/orm/migrations/directory.rbs +3 -0
  177. data/sig/manual/skyward/orm/migrations/discovery.rbs +3 -0
  178. data/sig/manual/skyward/orm/migrations/runner.rbs +3 -0
  179. data/sig/manual/skyward/orm/migrations/script.rbs +3 -0
  180. data/sig/manual/skyward/orm/migrations/status.rbs +3 -0
  181. data/sig/manual/skyward/orm/migrations/summary.rbs +3 -0
  182. data/sig/manual/skyward/orm/migrations/versions.rbs +3 -0
  183. data/sig/manual/skyward/orm/placeholders.rbs +3 -0
  184. data/sig/manual/skyward/orm/statements.rbs +3 -0
  185. data/sig/manual/skyward/orm/tables/loaded.rbs +3 -0
  186. data/sig/manual/skyward/orm/tables/rows.rbs +3 -0
  187. data/sig/manual/skyward/orm/tables/validation.rbs +3 -0
  188. data/sig/manual/skyward/orm/tables/values.rbs +3 -0
  189. data/sig/manual/skyward/orm.rbs +45 -0
  190. data/sig/manual/sqlite3.rbs +23 -0
  191. metadata +188 -3
@@ -0,0 +1,283 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Adapters::PostgreSQL
4
+ extend self
5
+
6
+ SQL_TYPES = {
7
+ integer: "bigint",
8
+ float: "double precision",
9
+ string: "text",
10
+ bool: "boolean",
11
+ date: "date",
12
+ time: "timestamptz",
13
+ enum: "text"
14
+ }.freeze #: Hash[Skyward::ORM::Tables::column_type, String]
15
+
16
+ # As the catalog spells each type, which compatible? is given.
17
+ COMPATIBLE = {
18
+ integer: %w[bigint integer smallint],
19
+ float: ["double precision", "real"],
20
+ string: ["text", "character varying", "uuid", "citext"],
21
+ bool: ["boolean"],
22
+ date: ["date"],
23
+ time: ["timestamp with time zone", "timestamp without time zone"],
24
+ enum: ["text", "character varying"]
25
+ }.freeze #: Hash[Skyward::ORM::Tables::column_type, Array[String]]
26
+
27
+ # The catalog puts a length or precision in parentheses.
28
+ MODIFIER = /\(\d+(?:,\d+)?\)/ #: Regexp
29
+
30
+ # UTC, so a timestamp column, which has no zone, holds the same instant as a
31
+ # timestamptz, and to the microsecond, as PostgreSQL keeps it. Its trailing
32
+ # zeros go, as PostgreSQL writes a time back, so a default compares as text.
33
+ TIME_FORMAT = "%Y-%m-%d %H:%M:%S.%6N" #: String
34
+ TRAILING_ZEROS = /\.?0+\z/ #: Regexp
35
+
36
+ # PostgreSQL reads a literal default back cast to its type, as 'normal'::text,
37
+ # and quotes a number that isn't a plain integer or decimal, as '-1'::integer.
38
+ CAST = /\A(?<literal>'(?:[^']|'')*')::(?<type>[a-z ]+)\z/ #: Regexp
39
+ NUMERIC = /\A(?:smallint|integer|bigint|numeric|real|double precision)\z/ #: Regexp
40
+
41
+ # Float() refuses the special values PostgreSQL writes out.
42
+ SPECIAL_FLOATS = {
43
+ "Infinity" => Float::INFINITY,
44
+ "-Infinity" => -Float::INFINITY,
45
+ "NaN" => Float::NAN
46
+ }.freeze #: Hash[String, Float]
47
+
48
+ MIGRATION_LOCK = 7_310_420_115 #: Integer
49
+
50
+ # Each value comes back as text, and a boolean as t or f.
51
+ TRUE_TEXT = "t" #: String
52
+
53
+ VIOLATIONS = {
54
+ "23505" => :unique,
55
+ "23503" => :foreign_key,
56
+ "23502" => :not_null,
57
+ "23514" => :check
58
+ }.freeze #: Hash[String, Skyward::ORM::violation_kind]
59
+
60
+ CONSTRAINT_KINDS = {
61
+ "p" => :primary_key,
62
+ "u" => :unique,
63
+ "f" => :foreign_key,
64
+ "c" => :check
65
+ }.freeze #: Hash[String, Skyward::ORM::Catalog::constraint_kind]
66
+
67
+ # The tables an unqualified name finds, as every query names them.
68
+ TABLES = "t.relkind IN ('r', 'p') AND t.relnamespace <> 'pg_catalog'::regnamespace " \
69
+ "AND pg_table_is_visible(t.oid)" #: String
70
+
71
+ COLUMNS = <<~SQL.freeze #: String
72
+ SELECT t.relname, a.attname, format_type(a.atttypid, a.atttypmod), a.attnotnull, pg_get_expr(d.adbin, d.adrelid)
73
+ FROM pg_catalog.pg_class AS t
74
+ JOIN pg_catalog.pg_attribute AS a ON a.attrelid = t.oid AND a.attnum > 0 AND NOT a.attisdropped
75
+ LEFT JOIN pg_catalog.pg_attrdef AS d ON d.adrelid = a.attrelid AND d.adnum = a.attnum
76
+ WHERE #{TABLES}
77
+ ORDER BY t.relname, a.attnum
78
+ SQL
79
+
80
+ # Leaves out the indexes primary keys and unique constraints make, as SQLite's does.
81
+ INDEXES = <<~SQL.freeze #: String
82
+ SELECT t.relname, i.relname, x.indisunique, a.attname, pg_get_indexdef(x.indexrelid)
83
+ FROM pg_catalog.pg_index AS x
84
+ JOIN pg_catalog.pg_class AS t ON t.oid = x.indrelid
85
+ JOIN pg_catalog.pg_class AS i ON i.oid = x.indexrelid
86
+ CROSS JOIN LATERAL unnest(x.indkey::int2[]) WITH ORDINALITY AS k(attnum, position)
87
+ LEFT JOIN pg_catalog.pg_attribute AS a ON a.attrelid = t.oid AND a.attnum = k.attnum
88
+ WHERE #{TABLES} AND k.position <= x.indnkeyatts AND NOT EXISTS (
89
+ SELECT FROM pg_catalog.pg_constraint AS c WHERE c.conindid = x.indexrelid AND c.contype IN ('p', 'u')
90
+ )
91
+ ORDER BY t.relname, i.relname, k.position
92
+ SQL
93
+
94
+ # A check on no column has no conkey, so the join keeps it with no columns.
95
+ CONSTRAINTS = <<~SQL.freeze #: String
96
+ SELECT t.relname, c.conname, c.contype, a.attname, r.relname, pg_get_constraintdef(c.oid)
97
+ FROM pg_catalog.pg_constraint AS c
98
+ JOIN pg_catalog.pg_class AS t ON t.oid = c.conrelid
99
+ LEFT JOIN pg_catalog.pg_class AS r ON r.oid = c.confrelid
100
+ LEFT JOIN LATERAL unnest(c.conkey) WITH ORDINALITY AS k(attnum, position) ON true
101
+ LEFT JOIN pg_catalog.pg_attribute AS a ON a.attrelid = t.oid AND a.attnum = k.attnum
102
+ WHERE #{TABLES} AND c.contype IN ('p', 'u', 'f', 'c')
103
+ ORDER BY t.relname, c.conname, k.position
104
+ SQL
105
+
106
+ # @rbs return: String
107
+ def driver = "pg"
108
+
109
+ # Values are decoded from PostgreSQL's ISO text, whatever the server's
110
+ # defaults, and times read and written in UTC. libpq prints each notice the
111
+ # server sends, so only warnings and worse are sent, or `skyward migrate`
112
+ # would print that schema_migrations already exists.
113
+ # @rbs location: String
114
+ # @rbs return: Skyward::ORM::_Connection
115
+ def connect(location)
116
+ connection = PG.connect("postgresql://#{location}")
117
+ connection.exec("SET TimeZone = 'UTC'; SET DateStyle = 'ISO'; SET client_min_messages = warning")
118
+ Connection.new(connection)
119
+ end
120
+
121
+ # @rbs (String _location, Integer size) -> Integer
122
+ def pool_size(_location, size) = size
123
+
124
+ # @rbs position: Integer
125
+ # @rbs return: String
126
+ def placeholder(position) = "$#{position}"
127
+
128
+ # PostgreSQL takes an OFFSET with no LIMIT before it.
129
+ # @rbs return: String?
130
+ def unlimited = nil
131
+
132
+ # @rbs type: Skyward::ORM::Tables::column_type
133
+ # @rbs return: String?
134
+ def sql_type(type) = SQL_TYPES[type]
135
+
136
+ # @rbs return: String?
137
+ def identity = "GENERATED ALWAYS AS IDENTITY"
138
+
139
+ # @rbs return: bool
140
+ def alters_in_place? = true
141
+
142
+ # A second migrator waits at the lock until the first commits, and then sees
143
+ # what it ran. Any fixed key will do: the lock is the database's own.
144
+ # @rbs return: String
145
+ def begin_migration = "BEGIN; SELECT pg_advisory_xact_lock(#{MIGRATION_LOCK})"
146
+
147
+ # PostgreSQL checks each foreign key as the migration writes.
148
+ # @rbs (Skyward::ORM::_Connection _connection) -> Array[String]
149
+ def foreign_key_violations(_connection) = []
150
+
151
+ # Ending the transaction released the lock, and nothing else was set.
152
+ # @rbs return: String
153
+ def end_migration = ""
154
+
155
+ # @rbs expression: String
156
+ # @rbs return: String
157
+ def default_expression(expression) = expression
158
+
159
+ # @rbs type: Skyward::ORM::Tables::column_type
160
+ # @rbs sql_type: String
161
+ # @rbs return: bool
162
+ def compatible?(type, sql_type)
163
+ accepted = COMPATIBLE[type]
164
+ accepted.nil? || accepted.include?(sql_type.sub(MODIFIER, ""))
165
+ end
166
+
167
+ # The driver sends every other value as its to_s, which PostgreSQL reads.
168
+ # @rbs value: untyped
169
+ # @rbs return: untyped
170
+ def encode(value)
171
+ case value
172
+ when Symbol then value.name
173
+ when Time then "#{value.getutc.strftime(TIME_FORMAT).sub(TRAILING_ZEROS, "")}+00"
174
+ else value
175
+ end
176
+ end
177
+
178
+ # @rbs type: Skyward::ORM::Tables::column_type
179
+ # @rbs value: untyped
180
+ # @rbs return: untyped
181
+ def decode(type, value)
182
+ case type
183
+ when :integer then Integer(value, 10)
184
+ when :float then SPECIAL_FLOATS.fetch(value) { Float(value) }
185
+ when :bool then value == TRUE_TEXT
186
+ when :date then Date.iso8601(value)
187
+ # A timestamp column's text has no zone, so it's read as the UTC it was written in.
188
+ when :time then Time.new(value, in: "UTC").getutc
189
+ when :enum then value.to_sym
190
+ else value.freeze
191
+ end
192
+ end
193
+
194
+ # @rbs (Skyward::ORM::_Connection connection) -> Array[Skyward::ORM::Catalog::Table]
195
+ def tables(connection)
196
+ index_rows = connection.execute(INDEXES).group_by(&:first)
197
+ constraint_rows = connection.execute(CONSTRAINTS).group_by(&:first)
198
+ connection.execute(COLUMNS).group_by(&:first).map do |name, rows|
199
+ Skyward::ORM::Catalog::Table.new(
200
+ name: name.to_sym,
201
+ columns: rows.map do |_, column, type, not_null, default|
202
+ Skyward::ORM::Catalog::Column.new(
203
+ name: column.to_sym, type:, nullable: not_null != TRUE_TEXT, default: default(default)
204
+ )
205
+ end,
206
+ indexes: indexes(index_rows.fetch(name, [])),
207
+ constraints: constraints(constraint_rows.fetch(name, []))
208
+ )
209
+ end
210
+ end
211
+
212
+ # @rbs (StandardError error, Array[Skyward::ORM::Catalog::Table] tables, Symbol? _table)
213
+ # -> Skyward::ORM::Violation?
214
+ def violation(error, tables, _table)
215
+ result = error.result if error.is_a?(PG::Error)
216
+ kind = VIOLATIONS[result&.error_field(PG::PG_DIAG_SQLSTATE).to_s]
217
+ return unless result && kind
218
+
219
+ constraint = result.error_field(PG::PG_DIAG_CONSTRAINT_NAME)
220
+ Skyward::ORM::Violation.new(
221
+ kind:,
222
+ constraint:,
223
+ columns: if kind == :not_null
224
+ [result.error_field(PG::PG_DIAG_COLUMN_NAME)].compact.map(&:to_sym)
225
+ else
226
+ constrained(tables, result.error_field(PG::PG_DIAG_TABLE_NAME), constraint)
227
+ end,
228
+ message: result.error_field(PG::PG_DIAG_MESSAGE_PRIMARY).to_s
229
+ )
230
+ end
231
+
232
+ private
233
+
234
+ # @rbs rows: Array[Array[untyped]]
235
+ # @rbs return: Array[Skyward::ORM::Catalog::Index]
236
+ def indexes(rows)
237
+ rows.group_by { |row| row.fetch(1) }.map do |name, keys|
238
+ Skyward::ORM::Catalog::Index.new(
239
+ name:,
240
+ # An index on an expression has no column there.
241
+ columns: keys.filter_map { |row| row.fetch(3)&.to_sym },
242
+ unique: keys.fetch(0).fetch(2) == TRUE_TEXT,
243
+ definition: keys.fetch(0).fetch(4)
244
+ )
245
+ end
246
+ end
247
+
248
+ # @rbs rows: Array[Array[untyped]]
249
+ # @rbs return: Array[Skyward::ORM::Catalog::Constraint]
250
+ def constraints(rows)
251
+ rows.group_by { |row| row.fetch(1) }.map do |name, keys|
252
+ first = keys.fetch(0)
253
+ Skyward::ORM::Catalog::Constraint.new(
254
+ name:,
255
+ kind: CONSTRAINT_KINDS.fetch(first.fetch(2)),
256
+ columns: keys.filter_map { |row| row.fetch(3)&.to_sym },
257
+ references: first.fetch(4)&.to_sym,
258
+ definition: first.fetch(5)
259
+ )
260
+ end
261
+ end
262
+
263
+ # @rbs expression: String?
264
+ # @rbs return: String?
265
+ def default(expression)
266
+ cast = CAST.match(expression.to_s)
267
+ return expression unless cast
268
+
269
+ literal = cast[:literal].to_s
270
+ NUMERIC.match?(cast[:type].to_s) ? literal.delete("'") : literal
271
+ end
272
+
273
+ # @rbs tables: Array[Skyward::ORM::Catalog::Table]
274
+ # @rbs table: String?
275
+ # @rbs name: String?
276
+ # @rbs return: Array[Symbol]
277
+ def constrained(tables, table, name)
278
+ found = tables.find { |candidate| candidate.name.name == table }
279
+ return [] unless found
280
+
281
+ [*found.constraints, *found.indexes].find { |key| key.name == name }&.columns || []
282
+ end
283
+ end
@@ -0,0 +1,172 @@
1
+ # frozen_string_literal: true
2
+
3
+ # SQLite keeps no catalog of constraints, only each table's CREATE TABLE
4
+ # statement, so their names, kinds, columns and definitions are read from that.
5
+ module Skyward::ORM::Adapters::SQLite::Constraints
6
+ extend self
7
+
8
+ # A token's kind, its text with any quotes removed, and where it starts and
9
+ # ends in the statement, so a definition can be cut from the statement as written.
10
+ # @rbs!
11
+ # type token = [Symbol, String, Integer, Integer]
12
+
13
+ TOKEN = Regexp.union(
14
+ %r{\s+|--[^\n]*|/\*.*?\*/}m,
15
+ /"(?:[^"]|"")*"|`(?:[^`]|``)*`|\[[^\]]*\]/,
16
+ /'(?:[^']|'')*'/,
17
+ /[\p{L}_][\p{L}\p{N}_$]*/,
18
+ /./m
19
+ ) #: Regexp
20
+
21
+ DEPTH = { open: 1, close: -1 }.freeze #: Hash[Symbol, Integer]
22
+
23
+ NAMES = %i[word name].freeze #: Array[Symbol]
24
+
25
+ TABLE_CONSTRAINTS = %w[CONSTRAINT PRIMARY UNIQUE CHECK FOREIGN].freeze #: Array[String]
26
+
27
+ KINDS = {
28
+ "PRIMARY" => :primary_key,
29
+ "UNIQUE" => :unique,
30
+ "CHECK" => :check,
31
+ "FOREIGN" => :foreign_key,
32
+ "REFERENCES" => :foreign_key
33
+ }.freeze #: Hash[String, Skyward::ORM::Catalog::constraint_kind]
34
+
35
+ # The words that start a column's next constraint, or its default or collation.
36
+ COLUMN_CLAUSES = %w[
37
+ CONSTRAINT PRIMARY NOT NULL UNIQUE CHECK DEFAULT COLLATE REFERENCES GENERATED AS
38
+ ].freeze #: Array[String]
39
+
40
+ # A reference's ON DELETE SET NULL and SET DEFAULT end in these.
41
+ SET_TO = %w[NULL DEFAULT].freeze #: Array[String]
42
+
43
+ # @rbs sql: String
44
+ # @rbs columns: Array[Symbol]
45
+ # @rbs return: Array[Skyward::ORM::Catalog::Constraint]
46
+ def read(sql, columns) = definitions(sql).flat_map { |definition| constraints(sql, definition, columns) }
47
+
48
+ private
49
+
50
+ # The scan covers every character, since its last alternative matches any
51
+ # one, so each token starts where the one before it ends.
52
+ # @rbs sql: String
53
+ # @rbs return: Array[Array[[token, Integer]]]
54
+ def definitions(sql)
55
+ texts = sql.scan(TOKEN) #: Array[String]
56
+ starts = texts.each_with_object([0]) { |text, offsets| offsets << (offsets.fetch(-1) + text.length) }
57
+ tokens = texts.each_with_index.filter_map { |text, index| token(text, starts.fetch(index)) }
58
+ body = tokens.drop_while { |token| token.first != :open }.drop(1)
59
+ depths = body.each_with_object([0]) { |token, levels| levels << (levels.fetch(-1) + DEPTH.fetch(token.first, 0)) }
60
+ paired = body.each_with_index.map { |token, index| [token, depths.fetch(index)] } #: Array[[token, Integer]]
61
+ paired.take_while { |token, depth| !(depth.zero? && token.first == :close) }
62
+ .chunk { |token, depth| depth.zero? && token.first == :comma ? :_separator : true }
63
+ .map { |_, definition| definition }
64
+ end
65
+
66
+ # @rbs text: String
67
+ # @rbs start: Integer
68
+ # @rbs return: token?
69
+ def token(text, start)
70
+ finish = start + text.length
71
+ case text
72
+ when %r{\A(?:\s|--|/\*)} then nil
73
+ when /\A"/ then [:name, text[1...-1].to_s.gsub('""', '"'), start, finish]
74
+ when /\A`/ then [:name, text[1...-1].to_s.gsub("``", "`"), start, finish]
75
+ when /\A\[/ then [:name, text[1...-1].to_s, start, finish]
76
+ when /\A'/ then [:string, text, start, finish]
77
+ when "(" then [:open, text, start, finish]
78
+ when ")" then [:close, text, start, finish]
79
+ when "," then [:comma, text, start, finish]
80
+ when /\A[\p{L}_]/ then [:word, text, start, finish]
81
+ else [:other, text, start, finish]
82
+ end
83
+ end
84
+
85
+ # A column's own constraints are on that column. A table constraint names
86
+ # its columns in parentheses, and a check is on the columns its expression
87
+ # mentions.
88
+ # @rbs sql: String
89
+ # @rbs definition: Array[[token, Integer]]
90
+ # @rbs columns: Array[Symbol]
91
+ # @rbs return: Array[Skyward::ORM::Catalog::Constraint]
92
+ def constraints(sql, definition, columns)
93
+ tokens = definition.map(&:first)
94
+ first = tokens.fetch(0)
95
+ column = first[1].to_sym unless TABLE_CONSTRAINTS.include?(word(first))
96
+ definition.each_with_index.filter_map do |(token, depth), index|
97
+ kind = KINDS[word(token).to_s] if depth.zero?
98
+ # A table's FOREIGN KEY is followed by its REFERENCES.
99
+ next if kind.nil? || (column.nil? && word(token) == "REFERENCES")
100
+
101
+ Skyward::ORM::Catalog::Constraint.new(
102
+ name: (tokens.fetch(index - 1)[1] if index > 1 && word(tokens.fetch(index - 2)) == "CONSTRAINT"),
103
+ kind:,
104
+ columns: column ? [column] : mentioned(first_parenthesized(definition.drop(index + 1)), columns),
105
+ references: (referenced(tokens.drop(index)) if kind == :foreign_key),
106
+ definition: column ? on_column(sql, kind, column, definition.drop(index)) : text(sql, tokens.drop(index))
107
+ )
108
+ end
109
+ end
110
+
111
+ # A column's constraint, written as the table constraint it's the same as.
112
+ # @rbs sql: String
113
+ # @rbs kind: Skyward::ORM::Catalog::constraint_kind
114
+ # @rbs column: Symbol
115
+ # @rbs rest: Array[[token, Integer]]
116
+ # @rbs return: String
117
+ def on_column(sql, kind, column, rest)
118
+ case kind
119
+ when :primary_key then "PRIMARY KEY (#{column})"
120
+ when :unique then "UNIQUE (#{column})"
121
+ when :check then text(sql, own(rest))
122
+ else "FOREIGN KEY (#{column}) #{text(sql, own(rest))}"
123
+ end
124
+ end
125
+
126
+ # A column constraint runs until the column's next clause. ON DELETE SET
127
+ # NULL and NOT DEFERRABLE are inside a reference, though, not clauses of
128
+ # their own.
129
+ # @rbs rest: Array[[token, Integer]]
130
+ # @rbs return: Array[token]
131
+ def own(rest)
132
+ tokens = rest.map(&:first)
133
+ ending = rest.each_index.find do |index|
134
+ next false if index.zero? || rest.fetch(index).last.positive?
135
+
136
+ clause = word(tokens.fetch(index))
137
+ following = tokens[index + 1]
138
+ COLUMN_CLAUSES.include?(clause.to_s) &&
139
+ !(SET_TO.include?(clause) && word(tokens.fetch(index - 1)) == "SET") &&
140
+ !(clause == "NOT" && following && word(following) == "DEFERRABLE")
141
+ end
142
+ tokens.take(ending || tokens.size)
143
+ end
144
+
145
+ # @rbs sql: String
146
+ # @rbs tokens: Array[token]
147
+ # @rbs return: String
148
+ def text(sql, tokens) = sql[tokens.fetch(0)[2]...tokens.fetch(-1)[3]].to_s
149
+
150
+ # @rbs token: token
151
+ # @rbs return: String?
152
+ def word(token) = (token[1].upcase if token.first == :word)
153
+
154
+ # @rbs rest: Array[[token, Integer]]
155
+ # @rbs return: Array[token]
156
+ def first_parenthesized(rest)
157
+ rest.drop_while { |token, _| token.first != :open }.drop(1).take_while { |_, depth| depth.positive? }.map(&:first)
158
+ end
159
+
160
+ # @rbs tokens: Array[token]
161
+ # @rbs columns: Array[Symbol]
162
+ # @rbs return: Array[Symbol]
163
+ def mentioned(tokens, columns)
164
+ tokens.filter_map do |kind, text|
165
+ columns.find { |column| column.name.casecmp?(text) } if NAMES.include?(kind)
166
+ end.uniq
167
+ end
168
+
169
+ # @rbs tokens: Array[token]
170
+ # @rbs return: Symbol
171
+ def referenced(tokens) = tokens.drop_while { |token| word(token) != "REFERENCES" }.fetch(1)[1].to_sym
172
+ end