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,317 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Adapters::SQLite
4
+ extend self
5
+
6
+ # The first SQLite with RETURNING, which every write into a row class uses.
7
+ MINIMUM_VERSION = Gem::Version.new("3.35") #: Gem::Version
8
+
9
+ SQL_TYPES = {
10
+ integer: "INTEGER",
11
+ float: "REAL",
12
+ string: "TEXT",
13
+ bool: "INTEGER",
14
+ date: "TEXT",
15
+ time: "TEXT",
16
+ enum: "TEXT"
17
+ }.freeze #: Hash[Skyward::ORM::Tables::column_type, String]
18
+
19
+ # Fixed width and UTC, so text order is time order, and to the microsecond,
20
+ # as PostgreSQL keeps it. It's the format of SQLite's own CURRENT_TIMESTAMP,
21
+ # with the fraction added, so the two compare.
22
+ TIME_FORMAT = "%Y-%m-%d %H:%M:%S.%6N" #: String
23
+
24
+ # SQLite's extended result codes: SQLITE_CONSTRAINT_CHECK, _FOREIGNKEY,
25
+ # _NOTNULL, _PRIMARYKEY and _UNIQUE.
26
+ VIOLATIONS = {
27
+ 275 => :check,
28
+ 787 => :foreign_key,
29
+ 1299 => :not_null,
30
+ 1555 => :unique,
31
+ 2067 => :unique
32
+ }.freeze #: Hash[Integer, Skyward::ORM::violation_kind]
33
+
34
+ # SQLite enforces a RESTRICT foreign key as a trigger would, so it reports
35
+ # SQLITE_CONSTRAINT_TRIGGER, and only the message tells it from a trigger's RAISE.
36
+ TRIGGER = 1811 #: Integer
37
+ RESTRICTED = "FOREIGN KEY constraint failed" #: String
38
+
39
+ UNIQUE_KINDS = %i[unique primary_key].freeze #: Array[Skyward::ORM::Catalog::constraint_kind]
40
+
41
+ BUSY_TIMEOUT_MS = 5000 #: Integer
42
+
43
+ COLUMNS = <<~SQL #: String
44
+ SELECT m.name, m.sql, c.name, c.type, c."notnull", c.pk, c.dflt_value
45
+ FROM sqlite_schema AS m JOIN pragma_table_info(m.name) AS c
46
+ WHERE m.type = 'table' AND m.name NOT LIKE 'sqlite\\_%' ESCAPE '\\'
47
+ ORDER BY m.name, c.cid
48
+ SQL
49
+
50
+ INDEXES = <<~SQL #: String
51
+ SELECT m.name, i.name, i."unique", c.name, s.sql
52
+ FROM sqlite_schema AS m JOIN pragma_index_list(m.name) AS i JOIN pragma_index_info(i.name) AS c
53
+ JOIN sqlite_schema AS s ON s.type = 'index' AND s.name = i.name
54
+ WHERE m.type = 'table' AND i.origin = 'c'
55
+ ORDER BY m.name, i.name, c.seqno
56
+ SQL
57
+
58
+ # What SQLite takes as a default without parentheses: a string, blob or
59
+ # number, NULL, TRUE or FALSE.
60
+ LITERAL = /\A(?:'(?:[^']|'')*'|x'\h*'|[+-]?(?:\d+(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?|0x\h+|null|true|false)\z/i #: Regexp
61
+
62
+ # @rbs return: String
63
+ def driver = "sqlite3"
64
+
65
+ # @rbs location: String
66
+ # @rbs return: Skyward::ORM::_Connection
67
+ def connect(location)
68
+ connection = SQLite3::Database.new(location)
69
+ connection.extended_result_codes = true
70
+ # busy_timeout= would hold the GVL while it waits, so no other thread or
71
+ # fiber could run, including the one holding the lock.
72
+ connection.busy_handler_timeout = BUSY_TIMEOUT_MS
73
+ connection.execute("PRAGMA foreign_keys = ON")
74
+ require_version(connection.execute("SELECT sqlite_version()").dig(0, 0).to_s)
75
+ connection
76
+ end
77
+
78
+ # Each connection to :memory: opens its own empty database, so there can be
79
+ # only the one.
80
+ # @rbs location: String
81
+ # @rbs size: Integer
82
+ # @rbs return: Integer
83
+ def pool_size(location, size) = location == ":memory:" ? 1 : size
84
+
85
+ # @rbs version: String
86
+ # @rbs return: void
87
+ def require_version(version)
88
+ return if Gem::Version.new(version) >= MINIMUM_VERSION
89
+
90
+ raise Skyward::Core::BootError,
91
+ "Skyward ORM needs SQLite #{MINIMUM_VERSION} or later, for RETURNING, but the sqlite3 gem loaded " \
92
+ "SQLite #{version}. Update the sqlite3 gem, or the SQLite it's built against."
93
+ end
94
+
95
+ # @rbs (Integer _position) -> String
96
+ def placeholder(_position) = "?"
97
+
98
+ # SQLite takes an OFFSET only after a LIMIT, and a negative one is no limit.
99
+ # @rbs return: String
100
+ def unlimited = "LIMIT -1"
101
+
102
+ # @rbs type: Skyward::ORM::Tables::column_type
103
+ # @rbs return: String?
104
+ def sql_type(type) = SQL_TYPES[type]
105
+
106
+ # An INTEGER PRIMARY KEY is SQLite's rowid, which numbers rows on its own.
107
+ # @rbs return: String?
108
+ def identity = nil
109
+
110
+ # SQLite's ALTER TABLE can't change a column or a constraint, so a migration
111
+ # rebuilds the table instead.
112
+ # @rbs return: bool
113
+ def alters_in_place? = false
114
+
115
+ # SQLite takes only a literal as a default, unless the expression is in parentheses.
116
+ # @rbs expression: String
117
+ # @rbs return: String
118
+ def default_expression(expression) = "(#{expression})"
119
+
120
+ # SQLite stores a value by its column's affinity, which it reads from the
121
+ # declared type, so any declared type with the same affinity is compatible.
122
+ # @rbs type: Skyward::ORM::Tables::column_type
123
+ # @rbs sql_type: String
124
+ # @rbs return: bool
125
+ def compatible?(type, sql_type)
126
+ expected = SQL_TYPES[type]
127
+ expected.nil? || affinity(sql_type) == affinity(expected)
128
+ end
129
+
130
+ # @rbs value: untyped
131
+ # @rbs return: untyped
132
+ def encode(value)
133
+ case value
134
+ when true then 1
135
+ when false then 0
136
+ when Symbol then value.name
137
+ when Time then value.getutc.strftime(TIME_FORMAT)
138
+ when Date then value.iso8601
139
+ else value
140
+ end
141
+ end
142
+
143
+ # @rbs type: Skyward::ORM::Tables::column_type
144
+ # @rbs value: untyped
145
+ # @rbs return: untyped
146
+ def decode(type, value)
147
+ case type
148
+ when :bool then value != 0
149
+ when :date then Date.iso8601(value)
150
+ when :time then Time.new(value, in: "UTC")
151
+ when :enum then value.to_sym
152
+ # Rows are values, so even what the driver returns as it is comes back frozen.
153
+ else value.freeze
154
+ end
155
+ end
156
+
157
+ # @rbs (Skyward::ORM::_Connection connection) -> Array[Skyward::ORM::Catalog::Table]
158
+ def tables(connection)
159
+ index_rows = connection.execute(INDEXES).group_by(&:first)
160
+ connection.execute(COLUMNS).group_by(&:first).map do |name, rows|
161
+ columns = rows.map do |_, _, column, type, not_null, primary_key, default|
162
+ Skyward::ORM::Catalog::Column.new(
163
+ name: column.to_sym,
164
+ type:,
165
+ # A primary key column can't hold NULL in practice, though SQLite only
166
+ # enforces it for an INTEGER PRIMARY KEY or a NOT NULL column.
167
+ nullable: not_null.zero? && primary_key.zero?,
168
+ default: default(default)
169
+ )
170
+ end
171
+ Skyward::ORM::Catalog::Table.new(
172
+ name: name.to_sym,
173
+ columns:,
174
+ indexes: indexes(index_rows.fetch(name, [])),
175
+ constraints: Constraints.read(rows.fetch(0).fetch(1), columns.map(&:name))
176
+ )
177
+ end
178
+ end
179
+
180
+ # Foreign keys go off first, as SQLite's procedure for changing a table says,
181
+ # so dropping a table the migration rebuilds doesn't cascade to the rows that
182
+ # refer to it, and inside a transaction the PRAGMA does nothing. BEGIN
183
+ # IMMEDIATE takes the write lock as the transaction begins rather than at its
184
+ # first write, so a second migrator waits there, and then sees what the first ran.
185
+ # @rbs return: String
186
+ def begin_migration = "PRAGMA foreign_keys = OFF; BEGIN IMMEDIATE"
187
+
188
+ # @rbs (Skyward::ORM::_Connection connection) -> Array[String]
189
+ def foreign_key_violations(connection)
190
+ connection.execute("PRAGMA foreign_key_check").map do |table, rowid, parent, key|
191
+ "#{table} row #{rowid} refers to a missing #{parent} row (foreign key #{key})"
192
+ end
193
+ end
194
+
195
+ # @rbs return: String
196
+ def end_migration = "PRAGMA foreign_keys = ON"
197
+
198
+ # The code says which kind of constraint failed. The message names the
199
+ # columns of a unique or not-null one, and the name of a check, and the rest
200
+ # comes from the schema, from the table written, or from every table when
201
+ # raw SQL doesn't say which it writes.
202
+ # @rbs error: StandardError
203
+ # @rbs tables: Array[Skyward::ORM::Catalog::Table]
204
+ # @rbs table: Symbol?
205
+ # @rbs return: Skyward::ORM::Violation?
206
+ def violation(error, tables, table)
207
+ return unless error.is_a?(SQLite3::ConstraintException)
208
+
209
+ message = error.message
210
+ case error.code == TRIGGER && message == RESTRICTED ? :foreign_key : VIOLATIONS[error.code]
211
+ when :unique then unique(message, tables)
212
+ when :not_null then Skyward::ORM::Violation.new(
213
+ kind: :not_null,
214
+ constraint: nil,
215
+ columns: failed_columns(message).last,
216
+ message:
217
+ )
218
+ when :check then check(message, tables, table)
219
+ when :foreign_key then foreign_key(message, tables, table)
220
+ end
221
+ end
222
+
223
+ private
224
+
225
+ # @rbs sql_type: String
226
+ # @rbs return: Symbol
227
+ def affinity(sql_type)
228
+ declared = sql_type.upcase
229
+ if declared.include?("INT") then :integer
230
+ elsif declared.match?(/CHAR|CLOB|TEXT/) then :text
231
+ elsif declared.empty? || declared.include?("BLOB") then :blob
232
+ elsif declared.match?(/REAL|FLOA|DOUB/) then :real
233
+ else :numeric
234
+ end
235
+ end
236
+
237
+ # @rbs rows: Array[Array[untyped]]
238
+ # @rbs return: Array[Skyward::ORM::Catalog::Index]
239
+ def indexes(rows)
240
+ rows.group_by { |row| row.fetch(1) }.map do |name, columns|
241
+ Skyward::ORM::Catalog::Index.new(
242
+ name:,
243
+ # An index on an expression has no column there.
244
+ columns: columns.filter_map { |row| row.fetch(3)&.to_sym },
245
+ unique: columns.fetch(0).fetch(2) == 1,
246
+ definition: columns.fetch(0).fetch(4)
247
+ )
248
+ end
249
+ end
250
+
251
+ # SQLite reads a default back without the parentheses an expression was
252
+ # written in, so they go back on, as a migration writes them.
253
+ # @rbs default: String?
254
+ # @rbs return: String?
255
+ def default(default) = default.nil? || default.match?(LITERAL) ? default : "(#{default})"
256
+
257
+ # SQLite names a unique index on expressions rather than its columns.
258
+ # @rbs message: String
259
+ # @rbs tables: Array[Skyward::ORM::Catalog::Table]
260
+ # @rbs return: Skyward::ORM::Violation
261
+ def unique(message, tables)
262
+ index = detail(message)[/\Aindex '(.*)'\z/, 1]
263
+ if index
264
+ found = tables.flat_map(&:indexes).find { |candidate| candidate.name == index }
265
+ return Skyward::ORM::Violation.new(kind: :unique, constraint: index, columns: found&.columns || [], message:)
266
+ end
267
+
268
+ table, columns = failed_columns(message)
269
+ written = tables.select { |candidate| candidate.name == table }
270
+ constraints = written.flat_map(&:constraints).select { |constraint| UNIQUE_KINDS.include?(constraint.kind) }
271
+ keys = [*constraints, *written.flat_map(&:indexes).select(&:unique)]
272
+ key = keys.find { |candidate| candidate.columns.sort == columns.sort }
273
+ Skyward::ORM::Violation.new(kind: :unique, constraint: key&.name, columns:, message:)
274
+ end
275
+
276
+ # @rbs message: String
277
+ # @rbs tables: Array[Skyward::ORM::Catalog::Table]
278
+ # @rbs table: Symbol?
279
+ # @rbs return: Skyward::ORM::Violation
280
+ def check(message, tables, table)
281
+ name = detail(message)
282
+ written = tables.select { |candidate| table.nil? || candidate.name == table }
283
+ found = written.flat_map(&:constraints).find do |constraint|
284
+ constraint.kind == :check && constraint.name == name
285
+ end
286
+ Skyward::ORM::Violation.new(kind: :check, constraint: name, columns: found&.columns || [], message:)
287
+ end
288
+
289
+ # SQLite's message names no key at all, so it's the one key the table has
290
+ # or that refers to it. With more than one, it can't say which.
291
+ # @rbs message: String
292
+ # @rbs tables: Array[Skyward::ORM::Catalog::Table]
293
+ # @rbs table: Symbol?
294
+ # @rbs return: Skyward::ORM::Violation
295
+ def foreign_key(message, tables, table)
296
+ keys = tables.flat_map do |candidate|
297
+ candidate.constraints.select do |constraint|
298
+ constraint.kind == :foreign_key &&
299
+ (table.nil? || candidate.name == table || constraint.references == table)
300
+ end
301
+ end
302
+ key = keys.first if keys.one?
303
+ Skyward::ORM::Violation.new(kind: :foreign_key, constraint: key&.name, columns: key&.columns || [], message:)
304
+ end
305
+
306
+ # SQLite names them as table.column: "UNIQUE constraint failed: todos.list_id, todos.title".
307
+ # @rbs message: String
308
+ # @rbs return: [Symbol, Array[Symbol]]
309
+ def failed_columns(message)
310
+ names = detail(message).split(", ").map { |name| name.split(".", 2) }
311
+ [names.fetch(0).fetch(0).to_sym, names.map { |name| name.fetch(-1).to_sym }]
312
+ end
313
+
314
+ # @rbs message: String
315
+ # @rbs return: String
316
+ def detail(message) = message.split(": ", 2).last.to_s
317
+ end
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Adapters
4
+ extend self
5
+
6
+ SCHEMES = {
7
+ "postgres" => PostgreSQL,
8
+ "postgresql" => PostgreSQL,
9
+ "sqlite" => SQLite
10
+ }.freeze #: Hash[String, Skyward::ORM::_Adapter]
11
+
12
+ # @rbs (String url, schemes: Hash[String, Skyward::ORM::_Adapter], requirer: ^(String) -> void)
13
+ # -> [Skyward::ORM::_Adapter, String]
14
+ def resolve(url, schemes:, requirer:)
15
+ scheme, location = url.split("://", 2)
16
+ adapter = schemes[scheme.to_s] if location
17
+ raise Skyward::Core::BootError, unsupported(location && scheme, schemes) unless adapter && location
18
+
19
+ begin
20
+ # Required only now, so an app's Gemfile names just the one driver it uses.
21
+ requirer.call(adapter.driver)
22
+ rescue LoadError
23
+ raise Skyward::Core::BootError,
24
+ "Skyward ORM needs the #{adapter.driver} gem to connect to a #{scheme}:// URL. " \
25
+ "Add `gem \"#{adapter.driver}\"` to your Gemfile."
26
+ end
27
+ [adapter, location]
28
+ end
29
+
30
+ private
31
+
32
+ # The URL can hold a password, so only its scheme is shown.
33
+ # @rbs (String? scheme, Hash[String, Skyward::ORM::_Adapter] schemes) -> String
34
+ def unsupported(scheme, schemes)
35
+ url = scheme ? "a #{scheme}:// URL" : "a URL with no scheme"
36
+ "Skyward ORM can't connect to #{url}. It connects to #{schemes.keys.map { |key| "#{key}://" }.join(", ")} URLs."
37
+ end
38
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Catalog
4
+ Column = Data.define(
5
+ :name, #: Symbol
6
+ :type, #: String
7
+ :nullable, #: bool
8
+ # The SQL that follows DEFAULT, as a migration writes it, so a class's
9
+ # default compares with it as text.
10
+ :default #: String?
11
+ )
12
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Catalog
4
+ Constraint = Data.define(
5
+ :name, #: String?
6
+ :kind, #: constraint_kind
7
+ :columns, #: Array[Symbol]
8
+ :references, #: Symbol?
9
+ # What follows its name as a table constraint, such as
10
+ # "FOREIGN KEY (list_id) REFERENCES lists", so a migration can put it back.
11
+ :definition #: String
12
+ )
13
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Catalog
4
+ Index = Data.define(
5
+ :name, #: String
6
+ :columns, #: Array[Symbol]
7
+ :unique, #: bool
8
+ # Its CREATE INDEX statement, so a migration can put it back.
9
+ :definition #: String
10
+ )
11
+ end
@@ -0,0 +1,10 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Catalog
4
+ Table = Data.define(
5
+ :name, #: Symbol
6
+ :columns, #: Array[Column]
7
+ :indexes, #: Array[Index]
8
+ :constraints #: Array[Constraint]
9
+ )
10
+ end
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Catalog
4
+ # @rbs!
5
+ # type constraint_kind = :primary_key | :unique | :foreign_key | :check
6
+ end
@@ -0,0 +1,43 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::CLI::BootFile
4
+ extend self
5
+
6
+ FILE = "boot.rb" #: String
7
+
8
+ # @rbs directory: String
9
+ # @rbs session: Skyward::ORM::Connection::Session
10
+ # @rbs generate: ^() -> String?
11
+ # @rbs return: Skyward::ORM::Connection::Database | String
12
+ def load(directory, session, generate)
13
+ path = File.join(directory, FILE)
14
+ unless File.file?(path)
15
+ return "skyward: no #{FILE} in #{directory}. Run skyward where your app's #{FILE} loads its table classes " \
16
+ "and calls Skyward.connect."
17
+ end
18
+
19
+ failure = generate.call
20
+ return failure if failure
21
+
22
+ require path
23
+ session.database
24
+ end
25
+
26
+ # The migration commands are what fixes a schema that doesn't match, so they
27
+ # boot the app with the check off.
28
+ # @rbs directory: String
29
+ # @rbs session: Skyward::ORM::Connection::Session
30
+ # @rbs kernel: singleton(Kernel)
31
+ # @rbs generate: ^() -> String?
32
+ # @rbs &: (Skyward::ORM::Connection::Database) -> void
33
+ # @rbs return: void
34
+ def boot(directory, session, kernel, generate, &)
35
+ database = session.without_check { load(directory, session, generate) }
36
+ case database
37
+ when String then kernel.abort(database)
38
+ else yield database
39
+ end
40
+ rescue Skyward::Core::BootError => e
41
+ kernel.abort(e.message)
42
+ end
43
+ end
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::CLI::Migrate
4
+ extend self
5
+
6
+ NOTHING = "No pending migrations.\n" #: String
7
+
8
+ # @rbs (directory: String, out: _Writer, kernel: singleton(Kernel), session: Skyward::ORM::Connection::Session,
9
+ # discover: ^() -> Array[singleton(Skyward::ORM::Record)], generate: ^() -> String?) -> void
10
+ def run(directory:, out:, kernel:, session:, discover:, generate:)
11
+ Skyward::ORM::CLI::BootFile.boot(directory, session, kernel, generate) do |database|
12
+ migrate(database, directory:, out:, kernel:, discover:)
13
+ end
14
+ end
15
+
16
+ private
17
+
18
+ # @rbs (Skyward::ORM::Connection::Database database, directory: String, out: _Writer, kernel: singleton(Kernel),
19
+ # discover: ^() -> Array[singleton(Skyward::ORM::Record)]) -> void
20
+ def migrate(database, directory:, out:, kernel:, discover:)
21
+ runner = Skyward::ORM::Migrations::Runner
22
+ migrated = database.migrate(runner.read(File.join(directory, Skyward::ORM::Migrations::Directory::PATH)))
23
+ case migrated
24
+ when Array
25
+ out.write(migrated.empty? ? NOTHING : migrated.map { |version| "Migrated #{version}\n" }.join)
26
+ database.check(discover.call)
27
+ else kernel.abort(runner.message(migrated))
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,111 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::CLI::Migration
4
+ extend self
5
+
6
+ NAME = /\A[A-Za-z0-9_]+\z/ #: Regexp
7
+
8
+ EMPTY = "--empty" #: String
9
+
10
+ USAGE = "Usage: skyward migration [--empty] NAME\n" \
11
+ "NAME is letters, digits and _, such as add_notes_to_todos.\n" \
12
+ "--empty writes an empty migration for SQL you write yourself." #: String
13
+
14
+ NOTHING = "Every table matches its class. Nothing to write.\n" #: String
15
+
16
+ YES = /\Ay(?:es)?\z/i #: Regexp
17
+
18
+ # @rbs (Array[String] args, directory: String, time: Time, input: IO, out: _Writer, kernel: singleton(Kernel),
19
+ # session: Skyward::ORM::Connection::Session, discover: ^() -> Array[singleton(Skyward::ORM::Record)],
20
+ # generate: ^() -> String?) -> void
21
+ def run(args, directory:, time:, input:, out:, kernel:, session:, discover:, generate:)
22
+ flags, names = args.partition { |arg| arg.start_with?("-") }
23
+ name = names.fetch(0) if names.one?
24
+ empty = flags == [EMPTY]
25
+ return kernel.abort(USAGE) unless name&.match?(NAME) && (empty || flags.empty?)
26
+
27
+ taken = Skyward::ORM::Migrations::Directory.named(directory, name)
28
+ return kernel.abort("skyward: #{taken} is already named #{name}. Choose another name.") if taken
29
+ # An empty migration compares nothing, so it skips booting and works before
30
+ # the app can connect.
31
+ return write_empty(name, directory:, time:, out:) if empty
32
+
33
+ Skyward::ORM::CLI::BootFile.boot(directory, session, kernel, generate) do |database|
34
+ write(name, database, directory:, time:, input:, out:, kernel:, discover:)
35
+ end
36
+ end
37
+
38
+ private
39
+
40
+ # @rbs (String name, directory: String, time: Time, out: _Writer) -> void
41
+ def write_empty(name, directory:, time:, out:)
42
+ file = Skyward::ORM::Migrations::Directory.write(directory, time, name, "\n-- down\n")
43
+ out.write("Wrote #{file}. Add your SQL, then run `skyward migrate`.\n")
44
+ end
45
+
46
+ # Writing a second migration before the first has run would write the same
47
+ # change twice, so a pending one stops it. With no terminal to ask whether a
48
+ # column was renamed, it stops rather than guess, since a guess of no drops
49
+ # the column's data.
50
+ # @rbs (String name, Skyward::ORM::Connection::Database database, directory: String, time: Time, input: IO,
51
+ # out: _Writer, kernel: singleton(Kernel), discover: ^() -> Array[singleton(Skyward::ORM::Record)]) -> void
52
+ def write(name, database, directory:, time:, input:, out:, kernel:, discover:)
53
+ ran = Skyward::ORM::Migrations::Versions.checksums(database).keys
54
+ pending = Skyward::ORM::Migrations::Directory.pending(directory, ran)
55
+ return kernel.abort(pending(pending)) unless pending.empty?
56
+
57
+ adapter = database.adapter
58
+ unasked = [] #: Array[String]
59
+ rename = if input.tty?
60
+ ->(table, from, to) { renamed?(input, out, "Did you rename #{table}.#{from} to #{table}.#{to}? [y/N] ") }
61
+ else
62
+ lambda do |table, from, to|
63
+ unasked.push("#{table}.#{from} to #{table}.#{to}")
64
+ false
65
+ end
66
+ end
67
+ changes = Skyward::ORM::Migrations::Diff.changes(
68
+ discover.call,
69
+ database.column_types,
70
+ database.tables,
71
+ adapter,
72
+ rename
73
+ )
74
+ return kernel.abort(unasked(unasked)) unless unasked.empty?
75
+ return out.write(NOTHING) if changes.empty?
76
+
77
+ file = Skyward::ORM::Migrations::Directory.write(
78
+ directory,
79
+ time,
80
+ name,
81
+ Skyward::ORM::Migrations::Script.write(changes, adapter)
82
+ )
83
+ out.write(
84
+ Skyward::ORM::Migrations::Summary.text(changes, adapter),
85
+ "Wrote #{file}. Review it, then run `skyward migrate`.\n"
86
+ )
87
+ end
88
+
89
+ # @rbs input: IO
90
+ # @rbs out: _Writer
91
+ # @rbs question: String
92
+ # @rbs return: bool
93
+ def renamed?(input, out, question)
94
+ out.write(question)
95
+ input.gets.to_s.strip.match?(YES)
96
+ end
97
+
98
+ # @rbs renames: Array[String]
99
+ # @rbs return: String
100
+ def unasked(renames)
101
+ "skyward: did you rename #{renames.join(", or ")}? There's no terminal to ask, so nothing was written. " \
102
+ "Run `skyward migration` in a terminal to answer."
103
+ end
104
+
105
+ # @rbs files: Array[String]
106
+ # @rbs return: String
107
+ def pending(files)
108
+ "skyward: #{files.join(", ")} #{files.one? ? "hasn't" : "haven't"} run yet. " \
109
+ "Run `skyward migrate` before writing the next migration."
110
+ end
111
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::CLI::Rollback
4
+ extend self
5
+
6
+ # @rbs (directory: String, out: _Writer, kernel: singleton(Kernel), session: Skyward::ORM::Connection::Session,
7
+ # generate: ^() -> String?) -> void
8
+ def run(directory:, out:, kernel:, session:, generate:)
9
+ Skyward::ORM::CLI::BootFile.boot(directory, session, kernel, generate) do |database|
10
+ runner = Skyward::ORM::Migrations::Runner
11
+ rolled_back = database.rollback(runner.read(File.join(directory, Skyward::ORM::Migrations::Directory::PATH)))
12
+ case rolled_back
13
+ when String then out.write("Rolled back #{rolled_back}\n")
14
+ else kernel.abort(runner.rollback_message(rolled_back))
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::CLI::Status
4
+ extend self
5
+
6
+ # Status only reports, so it can't ask whether a column was renamed, and
7
+ # shows one as a column dropped and another added.
8
+ UNASKED = ->(*) { false } #: ^(Symbol, Symbol, Symbol) -> bool
9
+
10
+ # @rbs (directory: String, out: _Writer, kernel: singleton(Kernel), session: Skyward::ORM::Connection::Session,
11
+ # discover: ^() -> Array[singleton(Skyward::ORM::Record)], generate: ^() -> String?) -> void
12
+ def run(directory:, out:, kernel:, session:, discover:, generate:)
13
+ Skyward::ORM::CLI::BootFile.boot(directory, session, kernel, generate) do |database|
14
+ report(database, directory:, out:, kernel:, discover:)
15
+ end
16
+ end
17
+
18
+ private
19
+
20
+ # @rbs (Skyward::ORM::Connection::Database database, directory: String, out: _Writer, kernel: singleton(Kernel),
21
+ # discover: ^() -> Array[singleton(Skyward::ORM::Record)]) -> void
22
+ def report(database, directory:, out:, kernel:, discover:)
23
+ status = Skyward::ORM::Migrations::Status
24
+ classes = discover.call
25
+ tables = database.tables
26
+ adapter = database.adapter
27
+ migrations = status.migrations(
28
+ Skyward::ORM::Migrations::Runner.read(File.join(directory, Skyward::ORM::Migrations::Directory::PATH)),
29
+ Skyward::ORM::Migrations::Versions.checksums(database)
30
+ )
31
+ changes = Skyward::ORM::Migrations::Diff.changes(classes, database.column_types, tables, adapter, UNASKED)
32
+ unowned = status.unowned(tables, classes)
33
+ out.write(status.text(migrations, changes, unowned, adapter))
34
+ kernel.exit(1) unless status.clean?(migrations, changes, unowned)
35
+ end
36
+ end
@@ -0,0 +1,4 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::CLI
4
+ end