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,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations
4
+ ChangeDefault = Data.define(
5
+ :column, #: Symbol
6
+ :from, #: String?
7
+ :to #: String?
8
+ )
9
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations
4
+ ChangeNullable = Data.define(
5
+ :column, #: Symbol
6
+ :nullable #: bool
7
+ )
8
+ end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations
4
+ ChangeType = Data.define(
5
+ :column, #: Symbol
6
+ :from, #: String
7
+ :to #: String
8
+ )
9
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations
4
+ CreateTable = Data.define(
5
+ :klass, #: singleton(Skyward::ORM::Record)
6
+ :columns #: Array[Skyward::ORM::Tables::Column]
7
+ )
8
+ end
@@ -0,0 +1,176 @@
1
+ # frozen_string_literal: true
2
+
3
+ # What a class's declarations make of its table, written as the catalog reads
4
+ # a table back, so a migration can write it and compare it with the database.
5
+ #
6
+ # Every constraint and index is named, so a violation names the same
7
+ # constraint on every database: SQLite reports an unnamed check by its
8
+ # expression, where PostgreSQL would make up these names.
9
+ module Skyward::ORM::Migrations::Definitions
10
+ extend self
11
+
12
+ ON_DELETE = {
13
+ cascade: "CASCADE",
14
+ restrict: "RESTRICT",
15
+ set_null: "SET NULL",
16
+ set_default: "SET DEFAULT",
17
+ no_action: "NO ACTION"
18
+ }.freeze #: Hash[Skyward::ORM::Tables::on_delete, String]
19
+
20
+ # Each column's constraints, in the order a column lists them, then each
21
+ # unique on more than one column.
22
+ # @rbs klass: singleton(Skyward::ORM::Record)
23
+ # @rbs columns: Array[Skyward::ORM::Tables::Column]
24
+ # @rbs return: Array[Skyward::ORM::Catalog::Constraint]
25
+ def constraints(klass, columns)
26
+ schema = klass.schema
27
+ table = klass.table_name
28
+ on_columns = columns.flat_map do |column|
29
+ name = column.name
30
+ references = schema.references.select { |reference| reference.column == name }
31
+ [
32
+ (constraint("#{table}_pkey", :primary_key, [name], "PRIMARY KEY (#{name})") if schema.primary_key == name),
33
+ (unique(table, [name]) if schema.uniques.include?([name])),
34
+ *checks(table, column, schema.checks),
35
+ *references.map { |reference| reference(table, reference) }
36
+ ].compact
37
+ end
38
+ [*on_columns, *schema.uniques.reject(&:one?).map { |columns| unique(table, columns) }]
39
+ end
40
+
41
+ # @rbs klass: singleton(Skyward::ORM::Record)
42
+ # @rbs return: Array[Skyward::ORM::Catalog::Index]
43
+ def indexes(klass)
44
+ table = klass.table_name
45
+ klass.schema.indexes.map do |columns|
46
+ name = name(table, columns, "index")
47
+ Skyward::ORM::Catalog::Index.new(
48
+ name:,
49
+ columns:,
50
+ unique: false,
51
+ definition: "CREATE INDEX #{name} ON #{table} (#{columns.join(", ")})"
52
+ )
53
+ end
54
+ end
55
+
56
+ # The SQL that follows the column's DEFAULT, or nil when it has none.
57
+ # @rbs klass: singleton(Skyward::ORM::Record)
58
+ # @rbs column: Symbol
59
+ # @rbs adapter: Skyward::ORM::_Adapter
60
+ # @rbs return: String?
61
+ def default(klass, column, adapter)
62
+ defaults = klass.schema.defaults
63
+ return unless defaults.key?(column)
64
+
65
+ value = defaults.fetch(column)
66
+ case value
67
+ when Skyward::ORM::Tables::SQL then adapter.default_expression(value.expression)
68
+ else literal(adapter.encode(value))
69
+ end
70
+ end
71
+
72
+ # The constraint as a column's own, in a column's definition.
73
+ # @rbs constraint: Skyward::ORM::Catalog::Constraint
74
+ # @rbs return: String
75
+ def inline(constraint)
76
+ clause = case constraint.kind
77
+ when :primary_key then "PRIMARY KEY"
78
+ when :unique then "UNIQUE"
79
+ when :check then constraint.definition
80
+ else constraint.definition.delete_prefix("FOREIGN KEY (#{constraint.columns.fetch(0)}) ")
81
+ end
82
+ "CONSTRAINT #{constraint.name} #{clause}"
83
+ end
84
+
85
+ # @rbs value: untyped
86
+ # @rbs return: String
87
+ def literal(value)
88
+ case value
89
+ when nil then "NULL"
90
+ when String then "'#{value.gsub("'", "''")}'"
91
+ when Integer, Float, true, false then value.to_s
92
+ else literal(value.to_s)
93
+ end
94
+ end
95
+
96
+ private
97
+
98
+ # @rbs name: String
99
+ # @rbs kind: Skyward::ORM::Catalog::constraint_kind
100
+ # @rbs columns: Array[Symbol]
101
+ # @rbs definition: String
102
+ # @rbs references: Symbol?
103
+ # @rbs return: Skyward::ORM::Catalog::Constraint
104
+ def constraint(name, kind, columns, definition, references = nil)
105
+ Skyward::ORM::Catalog::Constraint.new(name:, kind:, columns:, references:, definition:)
106
+ end
107
+
108
+ # @rbs table: Symbol
109
+ # @rbs columns: Array[Symbol]
110
+ # @rbs return: Skyward::ORM::Catalog::Constraint
111
+ def unique(table, columns)
112
+ constraint(name(table, columns, "key"), :unique, columns, "UNIQUE (#{columns.join(", ")})")
113
+ end
114
+
115
+ # A symbol union's check comes first, as part of the column's type.
116
+ # @rbs table: Symbol
117
+ # @rbs column: Skyward::ORM::Tables::Column
118
+ # @rbs checks: Array[Skyward::ORM::Tables::Check]
119
+ # @rbs return: Array[Skyward::ORM::Catalog::Constraint]
120
+ def checks(table, column, checks)
121
+ name = column.name
122
+ symbols = column.symbols.map { |symbol| literal(symbol.name) }.join(", ")
123
+ rules = [
124
+ *("#{name} IN (#{symbols})" if column.type == :enum),
125
+ *checks.select { |check| check.column == name }.map { |check| rule(name, check.rule) }
126
+ ]
127
+ # PostgreSQL numbers a column's second check the same way.
128
+ rules.each_with_index.map do |rule, index|
129
+ constraint("#{table}_#{name}_check#{index unless index.zero?}", :check, [name], "CHECK (#{rule})")
130
+ end
131
+ end
132
+
133
+ # @rbs column: Symbol
134
+ # @rbs rule: Skyward::ORM::Tables::SQL | Skyward::ORM::Tables::Length
135
+ # @rbs return: String
136
+ def rule(column, rule)
137
+ case rule
138
+ when Skyward::ORM::Tables::SQL then rule.expression
139
+ else length(column, rule)
140
+ end
141
+ end
142
+
143
+ # @rbs column: Symbol
144
+ # @rbs length: Skyward::ORM::Tables::Length
145
+ # @rbs return: String
146
+ def length(column, length)
147
+ min = length.min
148
+ max = length.max
149
+ if min && max then "length(#{column}) BETWEEN #{min} AND #{max}"
150
+ elsif min then "length(#{column}) >= #{min}"
151
+ else "length(#{column}) <= #{max}"
152
+ end
153
+ end
154
+
155
+ # @rbs table: Symbol
156
+ # @rbs reference: Skyward::ORM::Tables::Reference
157
+ # @rbs return: Skyward::ORM::Catalog::Constraint
158
+ def reference(table, reference)
159
+ column = reference.column
160
+ on_delete = reference.on_delete
161
+ parent = reference.table.table_name
162
+ constraint(
163
+ "#{table}_#{column}_fkey",
164
+ :foreign_key,
165
+ [column],
166
+ "FOREIGN KEY (#{column}) REFERENCES #{parent}#{" ON DELETE #{ON_DELETE.fetch(on_delete)}" if on_delete}",
167
+ parent
168
+ )
169
+ end
170
+
171
+ # @rbs table: Symbol
172
+ # @rbs columns: Array[Symbol]
173
+ # @rbs suffix: String
174
+ # @rbs return: String
175
+ def name(table, columns, suffix) = "#{table}_#{columns.join("_")}_#{suffix}"
176
+ end
@@ -0,0 +1,213 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations::Diff
4
+ extend self
5
+
6
+ ON_DELETE = /\bON\s+DELETE\s+(CASCADE|RESTRICT|SET\s+NULL|SET\s+DEFAULT|NO\s+ACTION)\b/i #: Regexp
7
+
8
+ NULL = "NULL" #: String
9
+
10
+ # New tables come first, each after the tables it references, so a changed
11
+ # table can reference a new table too. A table with no class is left alone:
12
+ # a class that isn't loaded looks the same.
13
+ # @rbs (Array[singleton(Skyward::ORM::Record)] classes, Skyward::ORM::Tables::ColumnTypes column_types,
14
+ # Array[Skyward::ORM::Catalog::Table] tables, Skyward::ORM::_Adapter adapter,
15
+ # ^(Symbol table, Symbol from, Symbol to) -> bool rename) -> Array[Skyward::ORM::Migrations::change]
16
+ def changes(classes, column_types, tables, adapter, rename)
17
+ classes.each { |klass| Skyward::ORM::Tables::Validation.validate(klass) }
18
+ refuse_shared(classes)
19
+ existing = tables.to_h { |table| [table.name, table] }
20
+ sorted = classes.sort_by { |klass| klass.table_name.name }
21
+ created = sorted.reject { |klass| existing.key?(klass.table_name) }.map do |klass|
22
+ Skyward::ORM::Migrations::CreateTable.new(klass:, columns: column_types.columns(klass))
23
+ end
24
+ altered = sorted.filter_map do |klass|
25
+ table = existing[klass.table_name]
26
+ altered(klass, column_types.columns(klass), table, adapter, rename) if table
27
+ end
28
+ [*parents_first(created), *altered]
29
+ end
30
+
31
+ private
32
+
33
+ # @rbs classes: Array[singleton(Skyward::ORM::Record)]
34
+ # @rbs return: void
35
+ def refuse_shared(classes)
36
+ shared = classes.group_by(&:table_name).select { |_, owners| owners.size > 1 }
37
+ return if shared.empty?
38
+
39
+ problems = shared.map do |table, owners|
40
+ "#{owners.map(&:to_s).sort.join(" and ")} each declare table :#{table}. Give each table one class."
41
+ end
42
+ raise Skyward::Core::BootError, problems.join("\n")
43
+ end
44
+
45
+ # Indexes and constraints go before the columns they're on, and come back
46
+ # after the columns they need.
47
+ # @rbs (singleton(Skyward::ORM::Record) klass, Array[Skyward::ORM::Tables::Column] columns,
48
+ # Skyward::ORM::Catalog::Table table, Skyward::ORM::_Adapter adapter,
49
+ # ^(Symbol table, Symbol from, Symbol to) -> bool rename) -> Skyward::ORM::Migrations::AlterTable?
50
+ def altered(klass, columns, table, adapter, rename)
51
+ names = columns.map(&:name)
52
+ had = table.columns.map(&:name)
53
+ added = columns.reject { |column| had.include?(column.name) }
54
+ removed = table.columns.reject { |column| names.include?(column.name) }
55
+ renamed = renames(klass.table_name, removed, added, adapter, rename)
56
+ new_columns = added.reject { |column| renamed.value?(column.name) }
57
+ dropped_indexes, added_indexes = indexes(klass, table, renamed)
58
+ dropped_constraints, added_constraints = constraints(klass, columns, table, renamed, new_columns)
59
+ dropped_columns = removed.reject { |column| renamed.key?(column.name) }
60
+ edits = [
61
+ *dropped_indexes,
62
+ *dropped_constraints,
63
+ *dropped_columns.map { |column| Skyward::ORM::Migrations::DropColumn.new(column:) },
64
+ *renamed.map { |from, to| Skyward::ORM::Migrations::RenameColumn.new(from:, to:) },
65
+ *new_columns.map { |column| Skyward::ORM::Migrations::AddColumn.new(column:) },
66
+ *columns.flat_map do |column|
67
+ found = table.columns.find { |kept| renamed.fetch(kept.name, kept.name) == column.name }
68
+ found ? changed(klass, column, found, adapter) : []
69
+ end,
70
+ *added_constraints,
71
+ *added_indexes
72
+ ] #: Array[Skyward::ORM::Migrations::edit]
73
+ Skyward::ORM::Migrations::AlterTable.new(klass:, columns:, table:, edits:) unless edits.empty?
74
+ end
75
+
76
+ # The indexes to drop and to add. One is compared by the columns it will
77
+ # have after any rename, and dropped as the database has it.
78
+ # @rbs klass: singleton(Skyward::ORM::Record)
79
+ # @rbs table: Skyward::ORM::Catalog::Table
80
+ # @rbs renamed: Hash[Symbol, Symbol]
81
+ # @rbs return: [Array[Skyward::ORM::Migrations::edit], Array[Skyward::ORM::Migrations::edit]]
82
+ def indexes(klass, table, renamed)
83
+ wanted = Skyward::ORM::Migrations::Definitions.indexes(klass)
84
+ pairs = table.indexes.map do |index|
85
+ [index, index.with(columns: moved(index.columns, renamed))]
86
+ end #: Array[[Skyward::ORM::Catalog::Index, Skyward::ORM::Catalog::Index]]
87
+ moved = pairs.map(&:last)
88
+ dropped = pairs.reject { |_, index| wanted.any? { |want| same_index?(index, want) } }
89
+ [
90
+ dropped.map { |index, _| Skyward::ORM::Migrations::DropIndex.new(index:) },
91
+ wanted.reject { |want| moved.any? { |index| same_index?(index, want) } }
92
+ .map { |index| Skyward::ORM::Migrations::AddIndex.new(index:) }
93
+ ]
94
+ end
95
+
96
+ # The constraints to drop and to add, compared as indexes are. A new
97
+ # column's own constraints are part of its definition.
98
+ # @rbs (singleton(Skyward::ORM::Record) klass, Array[Skyward::ORM::Tables::Column] columns,
99
+ # Skyward::ORM::Catalog::Table table, Hash[Symbol, Symbol] renamed, Array[Skyward::ORM::Tables::Column] new_columns)
100
+ # -> [Array[Skyward::ORM::Migrations::edit], Array[Skyward::ORM::Migrations::edit]]
101
+ def constraints(klass, columns, table, renamed, new_columns)
102
+ wanted = Skyward::ORM::Migrations::Definitions.constraints(klass, columns)
103
+ pairs = table.constraints.map do |constraint|
104
+ [constraint, constraint.with(columns: moved(constraint.columns, renamed))]
105
+ end #: Array[[Skyward::ORM::Catalog::Constraint, Skyward::ORM::Catalog::Constraint]]
106
+ moved = pairs.map(&:last)
107
+ dropped = pairs.reject { |_, constraint| wanted.any? { |want| same?(constraint, want) } }
108
+ added = wanted.reject do |want|
109
+ moved.any? { |constraint| same?(constraint, want) } || inline?(want, new_columns)
110
+ end
111
+ [
112
+ dropped.map { |constraint, _| Skyward::ORM::Migrations::DropConstraint.new(constraint:) },
113
+ added.map { |constraint| Skyward::ORM::Migrations::AddConstraint.new(constraint:) }
114
+ ]
115
+ end
116
+
117
+ # Each column that went is asked about each new one of a compatible type, in
118
+ # order, until one is a rename. A column it renames to isn't asked about again.
119
+ # @rbs (Symbol table, Array[Skyward::ORM::Catalog::Column] removed, Array[Skyward::ORM::Tables::Column] added,
120
+ # Skyward::ORM::_Adapter adapter, ^(Symbol table, Symbol from, Symbol to) -> bool rename) -> Hash[Symbol, Symbol]
121
+ def renames(table, removed, added, adapter, rename)
122
+ none = {} #: Hash[Symbol, Symbol]
123
+ removed.reduce(none) do |renamed, gone|
124
+ to = added.find do |column|
125
+ !renamed.value?(column.name) && adapter.compatible?(column.type, gone.type) &&
126
+ rename.call(table, gone.name, column.name)
127
+ end
128
+ to ? renamed.merge(gone.name => to.name) : renamed
129
+ end
130
+ end
131
+
132
+ # An untyped column has no type or nullability to compare.
133
+ # @rbs klass: singleton(Skyward::ORM::Record)
134
+ # @rbs column: Skyward::ORM::Tables::Column
135
+ # @rbs had: Skyward::ORM::Catalog::Column
136
+ # @rbs adapter: Skyward::ORM::_Adapter
137
+ # @rbs return: Array[Skyward::ORM::Migrations::edit]
138
+ def changed(klass, column, had, adapter)
139
+ name = column.name
140
+ sql_type = adapter.sql_type(column.type)
141
+ retyped = sql_type unless adapter.compatible?(column.type, had.type)
142
+ default = Skyward::ORM::Migrations::Definitions.default(klass, name, adapter)
143
+ # PostgreSQL keeps no default for DEFAULT NULL, which is the same as none.
144
+ redefaulted = (had.default || NULL) != (default || NULL)
145
+ renulled = sql_type && had.nullable != column.nullable
146
+ [
147
+ (Skyward::ORM::Migrations::ChangeType.new(column: name, from: had.type, to: retyped) if retyped),
148
+ (Skyward::ORM::Migrations::ChangeDefault.new(column: name, from: had.default, to: default) if redefaulted),
149
+ (Skyward::ORM::Migrations::ChangeNullable.new(column: name, nullable: column.nullable) if renulled)
150
+ ].compact
151
+ end
152
+
153
+ # Constraints are matched by name. SQLite can hold one with no name, which
154
+ # matches the one its class declares on the same columns. PostgreSQL rewrites
155
+ # a check's expression, and puts it on every column it mentions, so a check
156
+ # is matched by its name alone. A reference is also matched by what it does
157
+ # ON DELETE.
158
+ # @rbs had: Skyward::ORM::Catalog::Constraint
159
+ # @rbs wanted: Skyward::ORM::Catalog::Constraint
160
+ # @rbs return: bool
161
+ def same?(had, wanted)
162
+ name = had.name
163
+ same_columns = had.columns == wanted.columns && had.references == wanted.references &&
164
+ on_delete(had) == on_delete(wanted)
165
+ had.kind == wanted.kind && (name ? name == wanted.name && (had.kind == :check || same_columns) : same_columns)
166
+ end
167
+
168
+ # @rbs constraint: Skyward::ORM::Catalog::Constraint
169
+ # @rbs return: String
170
+ def on_delete(constraint)
171
+ action = constraint.definition[ON_DELETE, 1]
172
+ action ? action.upcase.gsub(/\s+/, " ") : "NO ACTION"
173
+ end
174
+
175
+ # An index is matched by its columns, so one a database already has under
176
+ # another name is kept.
177
+ # @rbs had: Skyward::ORM::Catalog::Index
178
+ # @rbs wanted: Skyward::ORM::Catalog::Index
179
+ # @rbs return: bool
180
+ def same_index?(had, wanted) = !had.unique && had.columns == wanted.columns
181
+
182
+ # @rbs constraint: Skyward::ORM::Catalog::Constraint
183
+ # @rbs added: Array[Skyward::ORM::Tables::Column]
184
+ # @rbs return: bool
185
+ def inline?(constraint, added)
186
+ constraint.columns.one? && added.any? { |column| column.name == constraint.columns.fetch(0) }
187
+ end
188
+
189
+ # @rbs columns: Array[Symbol]
190
+ # @rbs renamed: Hash[Symbol, Symbol]
191
+ # @rbs return: Array[Symbol]
192
+ def moved(columns, renamed) = columns.map { |column| renamed.fetch(column, column) }
193
+
194
+ # Tables that reference each other can't all come after their parents, so
195
+ # the first left goes next.
196
+ # @rbs pending: Array[Skyward::ORM::Migrations::CreateTable]
197
+ # @rbs placed: Array[Skyward::ORM::Migrations::CreateTable]
198
+ # @rbs return: Array[Skyward::ORM::Migrations::CreateTable]
199
+ def parents_first(pending, placed = [])
200
+ return placed if pending.empty?
201
+
202
+ waiting = pending.map { |change| change.klass.table_name }
203
+ ready = pending.find do |change|
204
+ parents(change.klass).none? { |parent| parent != change.klass.table_name && waiting.include?(parent) }
205
+ end
206
+ following = ready || pending.fetch(0)
207
+ parents_first(pending - [following], [*placed, following])
208
+ end
209
+
210
+ # @rbs klass: singleton(Skyward::ORM::Record)
211
+ # @rbs return: Array[Symbol]
212
+ def parents(klass) = klass.schema.references.map { |reference| reference.table.table_name }
213
+ end
@@ -0,0 +1,48 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "fileutils"
4
+
5
+ module Skyward::ORM::Migrations::Directory
6
+ extend self
7
+
8
+ PATH = "db/migrate" #: String
9
+
10
+ # @rbs directory: String
11
+ # @rbs name: String
12
+ # @rbs return: String?
13
+ def named(directory, name)
14
+ files(directory).find { |file| File.basename(file).match?(/\A\d+_#{Regexp.escape(name)}\.sql\z/) }
15
+ end
16
+
17
+ # A migration's version is the timestamp its file name starts with.
18
+ # @rbs directory: String
19
+ # @rbs ran: Array[String]
20
+ # @rbs return: Array[String]
21
+ def pending(directory, ran) = files(directory).reject { |file| ran.include?(version(file)) }
22
+
23
+ # @rbs directory: String
24
+ # @rbs time: Time
25
+ # @rbs name: String
26
+ # @rbs sql: String
27
+ # @rbs return: String
28
+ def write(directory, time, name, sql)
29
+ file = File.join(PATH, "#{time.getutc.strftime("%Y%m%d%H%M%S")}_#{name}.sql")
30
+ FileUtils.mkdir_p(File.join(directory, PATH))
31
+ File.write(File.join(directory, file), sql)
32
+ file
33
+ end
34
+
35
+ # @rbs path: String
36
+ # @rbs return: Array[String]
37
+ def sql_files(path) = Dir.glob("*.sql", base: path).sort
38
+
39
+ # @rbs file: String
40
+ # @rbs return: String
41
+ def version(file) = File.basename(file).split("_", 2).fetch(0)
42
+
43
+ private
44
+
45
+ # @rbs directory: String
46
+ # @rbs return: Array[String]
47
+ def files(directory) = sql_files(File.join(directory, PATH)).map { |file| File.join(PATH, file) }
48
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations::Discovery
4
+ extend self
5
+
6
+ # Subclasses lists only loaded classes, so an app that autoloads would
7
+ # otherwise hide every table class nothing has used yet.
8
+ # @rbs loader: singleton(Zeitwerk::Loader)
9
+ # @rbs return: Array[singleton(Skyward::ORM::Record)]
10
+ def table_classes(loader)
11
+ loader.eager_load_all
12
+ Skyward::ORM::Tables::Loaded.table_classes(Skyward::ORM::Record)
13
+ end
14
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations
4
+ DropColumn = Data.define(
5
+ :column #: Skyward::ORM::Catalog::Column
6
+ )
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations
4
+ DropConstraint = Data.define(
5
+ :constraint #: Skyward::ORM::Catalog::Constraint
6
+ )
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations
4
+ DropIndex = Data.define(
5
+ :index #: Skyward::ORM::Catalog::Index
6
+ )
7
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations
4
+ RenameColumn = Data.define(
5
+ :from, #: Symbol
6
+ :to #: Symbol
7
+ )
8
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations::Runner
4
+ Edited = Data.define(
5
+ :files #: Array[String]
6
+ )
7
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations::Runner
4
+ Failed = Data.define(
5
+ :file, #: String
6
+ :message #: String
7
+ )
8
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations::Runner
4
+ Irreversible = Data.define(
5
+ :file #: String
6
+ )
7
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations::Runner
4
+ Locked = Data.define(
5
+ :file, #: String
6
+ :message #: String
7
+ )
8
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations::Runner
4
+ Migration = Data.define(
5
+ :file, #: String
6
+ :version, #: String
7
+ :up, #: String
8
+ :down, #: String
9
+ :checksum #: String
10
+ )
11
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations::Runner
4
+ Missing = Data.define(
5
+ :version #: String
6
+ )
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations::Runner
4
+ Raced = Data.define(
5
+ :file #: String
6
+ )
7
+ end