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,64 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "skyward/orm"
4
+
5
+ discover = -> { Skyward::ORM::Migrations::Discovery.table_classes(Zeitwerk::Loader) }
6
+ generate = lambda do
7
+ Skyward::Core::Signatures::Inline.generate(
8
+ Dir.pwd,
9
+ rbs_inline: Skyward::Core::CLI::Executable.find("rbs-inline", feature: "rbs/inline"),
10
+ capture: Skyward::Core::CLI::Executable::CAPTURE
11
+ )
12
+ end
13
+
14
+ Skyward::Core::CLI.register(
15
+ "migration",
16
+ "Write the migration that brings the database in line with your table classes"
17
+ ) do |args|
18
+ Skyward::ORM::CLI::Migration.run(
19
+ args,
20
+ directory: Dir.pwd,
21
+ time: Time.now,
22
+ input: $stdin,
23
+ out: $stdout,
24
+ kernel: Kernel,
25
+ session: Skyward::ORM::Connection::SESSION,
26
+ discover:,
27
+ generate:
28
+ )
29
+ end
30
+
31
+ Skyward::Core::CLI.register("migrate", "Run the pending migrations in db/migrate") do |_args|
32
+ Skyward::ORM::CLI::Migrate.run(
33
+ directory: Dir.pwd,
34
+ out: $stdout,
35
+ kernel: Kernel,
36
+ session: Skyward::ORM::Connection::SESSION,
37
+ discover:,
38
+ generate:
39
+ )
40
+ end
41
+
42
+ Skyward::Core::CLI.register("rollback", "Undo the latest migration by running its -- down section") do |_args|
43
+ Skyward::ORM::CLI::Rollback.run(
44
+ directory: Dir.pwd,
45
+ out: $stdout,
46
+ kernel: Kernel,
47
+ session: Skyward::ORM::Connection::SESSION,
48
+ generate:
49
+ )
50
+ end
51
+
52
+ Skyward::Core::CLI.register(
53
+ "status",
54
+ "List which migrations have run, and how your table classes differ from the database"
55
+ ) do |_args|
56
+ Skyward::ORM::CLI::Status.run(
57
+ directory: Dir.pwd,
58
+ out: $stdout,
59
+ kernel: Kernel,
60
+ session: Skyward::ORM::Connection::SESSION,
61
+ discover:,
62
+ generate:
63
+ )
64
+ end
@@ -0,0 +1,67 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Connection::Database::SchemaCheck
4
+ extend self
5
+
6
+ # @rbs!
7
+ # type problem = [String, String, String]
8
+
9
+ MIGRATE = "Run `skyward migrate`, or `skyward migration` if you haven't generated one." #: String
10
+
11
+ # Only what the class declares is compared. Extra columns, indexes and
12
+ # constraints are left to `skyward status`, which reports them.
13
+ # @rbs (singleton(Skyward::ORM::Record) klass, Array[Skyward::ORM::Tables::Column] columns,
14
+ # Array[Skyward::ORM::Catalog::Table] tables, Skyward::ORM::_Adapter adapter) -> String?
15
+ def mismatch(klass, columns, tables, adapter)
16
+ name = klass.table_name
17
+ table = tables.find { |candidate| candidate.name == name }
18
+ problems = if table
19
+ columns.flat_map { |column| column_problems(klass, table, column, adapter) }
20
+ else
21
+ [[name.to_s, "The database has no table #{name}.", MIGRATE]] #: Array[problem]
22
+ end
23
+ report(klass, name, problems) unless problems.empty?
24
+ end
25
+
26
+ private
27
+
28
+ # @rbs (singleton(Skyward::ORM::Record) klass, Skyward::ORM::Catalog::Table table,
29
+ # Skyward::ORM::Tables::Column column, Skyward::ORM::_Adapter adapter) -> Array[problem]
30
+ def column_problems(klass, table, column, adapter)
31
+ name = column.name
32
+ found = table.columns.find { |candidate| candidate.name == name }
33
+ return [[name.to_s, "#{table.name} has no column #{name}.", MIGRATE]] unless found
34
+ # An untyped column's values pass through as the driver returns them.
35
+ return [] if column.type == :untyped
36
+
37
+ stored = "#{table.name}.#{name}"
38
+ declared = "#{klass}##{name}"
39
+ type = "#{stored} is #{found.type}, but #{declared} needs #{adapter.sql_type(column.type)}."
40
+ [
41
+ (type unless adapter.compatible?(column.type, found.type)),
42
+ (nullability(stored, declared, found.nullable) unless found.nullable == column.nullable)
43
+ ].compact.map { |problem| [name.to_s, problem, "#{MIGRATE} Or change #{declared}'s type to match."] }
44
+ end
45
+
46
+ # @rbs stored: String
47
+ # @rbs declared: String
48
+ # @rbs nullable: bool
49
+ # @rbs return: String
50
+ def nullability(stored, declared, nullable)
51
+ if nullable then "#{stored} allows NULL, but #{declared} doesn't."
52
+ else "#{stored} is NOT NULL, but #{declared} allows nil."
53
+ end
54
+ end
55
+
56
+ # @rbs klass: singleton(Skyward::ORM::Record)
57
+ # @rbs table: Symbol
58
+ # @rbs problems: Array[problem]
59
+ # @rbs return: String
60
+ def report(klass, table, problems)
61
+ width = problems.map { |label, _, _| label.length }.max.to_i
62
+ lines = problems.flat_map do |label, problem, fix|
63
+ [" #{label.ljust(width)} #{problem}", " #{" " * width} #{fix}"]
64
+ end
65
+ ["#{klass} doesn't match the #{table} table", "", *lines].join("\n")
66
+ end
67
+ end
@@ -0,0 +1,357 @@
1
+ # frozen_string_literal: true
2
+
3
+ class Skyward::ORM::Connection::Database
4
+ Held = Data.define(
5
+ :connection, #: Skyward::ORM::_Connection
6
+ :fiber, #: Fiber
7
+ :transaction, #: bool
8
+ :depth #: Integer
9
+ )
10
+
11
+ Statements = Data.define(
12
+ :start, #: String
13
+ :commit, #: Array[String]
14
+ :rollback #: Array[String]
15
+ )
16
+
17
+ TRANSACTION = Statements.new(start: "BEGIN", commit: ["COMMIT"], rollback: ["ROLLBACK"]) #: Statements
18
+
19
+ FOREIGN = "this transaction belongs to another fiber; start your own, or return the result to the block" #: String
20
+
21
+ # @rbs @adapter: Skyward::ORM::_Adapter
22
+ # @rbs @pool: Skyward::ORM::Connection::Pool
23
+ # @rbs @column_types: Skyward::ORM::Tables::ColumnTypes
24
+ # @rbs @tables: Array[Skyward::ORM::Catalog::Table]
25
+ # @rbs @check: bool
26
+ # @rbs @checked: Set[singleton(Skyward::ORM::Record)]
27
+ # @rbs @lock: Thread::Mutex
28
+ # @rbs @decoders: Hash[[singleton(Skyward::ORM::Record), Class, Array[Symbol]], ^(Array[untyped]) -> untyped]
29
+ # @rbs @key: Symbol
30
+
31
+ # @rbs (Skyward::ORM::_Adapter adapter, Skyward::ORM::Connection::Pool pool,
32
+ # Skyward::ORM::Tables::ColumnTypes column_types, Array[Skyward::ORM::Catalog::Table] tables, check: bool) -> void
33
+ def initialize(adapter, pool, column_types, tables, check:)
34
+ @adapter = adapter
35
+ @pool = pool
36
+ @column_types = column_types
37
+ @tables = tables
38
+ @check = check
39
+ @checked = Set.new
40
+ @lock = Thread::Mutex.new
41
+ @decoders = {}
42
+ # Fiber storage takes only a Symbol key, and each database's transactions are its own.
43
+ @key = :"skyward_orm_transaction_#{object_id}"
44
+ end
45
+
46
+ # The seam every query runs through. Fiber storage is copied into child
47
+ # fibers and threads, so one can find a transaction here that isn't its own.
48
+ # @rbs [T] () { (Skyward::ORM::_Connection connection) -> T } -> T
49
+ def connection(&)
50
+ held = Fiber[@key] #: Held?
51
+ return @pool.with(&) unless held
52
+ raise FiberError, FOREIGN unless owned?(held)
53
+
54
+ yield held.connection
55
+ end
56
+
57
+ # @rbs [T] () { () -> T } -> T
58
+ def transaction(&block)
59
+ held = Fiber[@key] #: Held?
60
+ return atomically(held.connection, held.depth + 1, &block) if held && owned?(held)
61
+
62
+ @pool.with { |connection| atomically(connection, 0, &block) }
63
+ end
64
+
65
+ # @rbs return: bool
66
+ def transaction?
67
+ held = Fiber[@key] #: Held?
68
+ !held.nil? && held.transaction && owned?(held)
69
+ end
70
+
71
+ # A transaction for code that can't wrap itself in one block, such as a
72
+ # test's setup and teardown, until #release rolls it back. transaction?
73
+ # doesn't report it, so code that branches on it behaves as it would untested.
74
+ # @rbs return: void
75
+ def hold
76
+ connection = @pool.checkout
77
+ Fiber[@key] = Held.new(connection:, fiber: Fiber.current, transaction: false, depth: 0)
78
+ connection.execute(TRANSACTION.start)
79
+ end
80
+
81
+ # Nothing is held when #hold raised before it could take a connection.
82
+ # @rbs return: void
83
+ def release
84
+ held = Fiber[@key] #: Held?
85
+ return unless held
86
+
87
+ Fiber[@key] = nil
88
+ begin
89
+ TRANSACTION.rollback.each { |sql| held.connection.execute(sql) }
90
+ ensure
91
+ @pool.checkin(held.connection)
92
+ end
93
+ end
94
+
95
+ # @dynamic adapter
96
+ attr_reader :adapter #: Skyward::ORM::_Adapter
97
+
98
+ # @dynamic column_types
99
+ attr_reader :column_types #: Skyward::ORM::Tables::ColumnTypes
100
+
101
+ # @dynamic tables
102
+ attr_reader :tables #: Array[Skyward::ORM::Catalog::Table]
103
+
104
+ # @rbs sql: String
105
+ # @rbs binds: Array[untyped]
106
+ # @rbs return: Array[Array[untyped]]
107
+ def execute(sql, binds = []) = connection { |checked_out| checked_out.execute(sql, binds) }
108
+
109
+ # @rbs tables: Array[singleton(Skyward::ORM::Record)]
110
+ # @rbs return: void
111
+ def check(tables)
112
+ @lock.synchronize do
113
+ unchecked = tables.reject { |table| @checked.include?(table) }
114
+ unchecked.each { |table| Skyward::ORM::Tables::Validation.validate(table) }
115
+ mismatches = unchecked.filter_map do |table|
116
+ SchemaCheck.mismatch(table, @column_types.columns(table), @tables, @adapter)
117
+ end
118
+ raise Skyward::ORM::SchemaMismatch, mismatches.join("\n\n") unless mismatches.empty?
119
+
120
+ @checked.merge(unchecked)
121
+ end
122
+ end
123
+
124
+ # A query selects its row class's members in order, so the decoder reads
125
+ # each value by position.
126
+ # @rbs table: singleton(Skyward::ORM::Record)
127
+ # @rbs row: Class
128
+ # @rbs expressed: Array[Symbol]
129
+ # @rbs return: ^(Array[untyped]) -> untyped
130
+ def decoder(table, row, expressed) = @decoders[[table, row, expressed]] ||= build(table, row, expressed)
131
+
132
+ # Every query and write calls this before it touches its table, so a table
133
+ # class loaded after connect is checked before its first use.
134
+ # @rbs table: singleton(Skyward::ORM::Record)
135
+ # @rbs return: void
136
+ def prepare(table)
137
+ check([table]) if @check
138
+ end
139
+
140
+ # @rbs error: StandardError
141
+ # @rbs table: Symbol?
142
+ # @rbs return: Skyward::ORM::Violation?
143
+ def violation(error, table) = @adapter.violation(error, @tables, table)
144
+
145
+ # @rbs sql: String
146
+ # @rbs values: Array[untyped]
147
+ # @rbs return: Array[Hash[Symbol, untyped]]
148
+ def hashes(sql, values)
149
+ columns, rows = run(sql, values)
150
+ rows.map { |row| columns.zip(row).to_h }
151
+ end
152
+
153
+ # Raw SQL picks its own columns, in its own order, so they're matched to the
154
+ # row class's members by name.
155
+ # @rbs row: Class
156
+ # @rbs sql: String
157
+ # @rbs values: Array[untyped]
158
+ # @rbs return: Array[untyped]
159
+ def rows(row, sql, values)
160
+ columns, fetched = run(sql, values)
161
+ types = @column_types.columns(row).to_h { |member| [member.name, member.type] }
162
+ unmatched(row, columns, types.keys)
163
+ fetched.map(&compile(row, columns, types.fetch_values(*columns)))
164
+ end
165
+
166
+ # @rbs migrations: Array[Skyward::ORM::Migrations::Runner::Migration]
167
+ # @rbs return: Skyward::ORM::Migrations::Runner::outcome
168
+ def migrate(migrations)
169
+ changing { |checked_out| Skyward::ORM::Migrations::Runner.run(@adapter, checked_out, migrations) }
170
+ end
171
+
172
+ # @rbs migrations: Array[Skyward::ORM::Migrations::Runner::Migration]
173
+ # @rbs return: Skyward::ORM::Migrations::Runner::rolled_back
174
+ def rollback(migrations)
175
+ changing { |checked_out| Skyward::ORM::Migrations::Runner.rollback(@adapter, checked_out, migrations) }
176
+ end
177
+
178
+ # The count is read on the connection that ran the write, before anything
179
+ # else runs on it.
180
+ # @rbs table: singleton(Skyward::ORM::Record)
181
+ # @rbs sql: String
182
+ # @rbs binds: Array[untyped]
183
+ # @rbs return: Integer | Skyward::ORM::Violation
184
+ def write(table, sql, binds)
185
+ prepare(table)
186
+ connection do |checked_out|
187
+ checked_out.execute(sql, binds)
188
+ checked_out.changes
189
+ end
190
+ rescue StandardError => e
191
+ violation(e, table.table_name) || raise
192
+ end
193
+
194
+ # RETURNING lists the row class's members in order, as its decoder reads
195
+ # them. Steep can't tie the row class to its rows, so they're untyped here.
196
+ # @rbs table: singleton(Skyward::ORM::Record)
197
+ # @rbs row: Class
198
+ # @rbs sql: String
199
+ # @rbs binds: Array[untyped]
200
+ # @rbs return: Array[untyped] | Skyward::ORM::Violation
201
+ def write_returning(table, row, sql, binds)
202
+ # Building the decoder prepares the table, so it's built before the write runs.
203
+ decode = decoder(table, row, [])
204
+ execute(sql, binds).map(&decode)
205
+ rescue StandardError => e
206
+ violation(e, table.table_name) || raise
207
+ end
208
+
209
+ private
210
+
211
+ # Migrating or rolling back changes the schema read at connect, even when a
212
+ # later migration fails, so it's read again, and every class is checked
213
+ # against it afresh.
214
+ # @rbs [T] () { (Skyward::ORM::_Connection connection) -> T } -> T
215
+ def changing
216
+ connection do |checked_out|
217
+ changed = yield checked_out
218
+ tables = @adapter.tables(checked_out)
219
+ @lock.synchronize do
220
+ @tables = tables
221
+ @checked.clear
222
+ end
223
+ changed
224
+ end
225
+ end
226
+
227
+ # @rbs held: Held
228
+ # @rbs return: bool
229
+ def owned?(held) = held.fiber.equal?(Fiber.current)
230
+
231
+ # @rbs [T] (Held held) { () -> T } -> T
232
+ def within(held)
233
+ outer = Fiber[@key] #: Held?
234
+ Fiber[@key] = held
235
+ begin
236
+ yield
237
+ ensure
238
+ Fiber[@key] = outer
239
+ end
240
+ end
241
+
242
+ # Rolled back in ensure rather than rescue, so a block left by throw or a
243
+ # killed thread rolls back too, and so does a commit that fails, and a start
244
+ # an exception interrupts once it has reached the database.
245
+ # @rbs [T] (Skyward::ORM::_Connection connection, Integer depth) { () -> T } -> T
246
+ def atomically(connection, depth)
247
+ statements = statements(depth)
248
+ within(Held.new(connection:, fiber: Fiber.current, transaction: true, depth:)) do
249
+ started = false
250
+ settled = false
251
+ begin
252
+ connection.execute(statements.start)
253
+ started = true
254
+ result = yield
255
+ ending(statements, result).each { |sql| connection.execute(sql) }
256
+ settled = true
257
+ result
258
+ ensure
259
+ undo(connection, statements, started) unless settled
260
+ end
261
+ end
262
+ end
263
+
264
+ # Each savepoint is named by its depth, so rolling back one whose start never
265
+ # reached the database can't roll back the one enclosing it instead.
266
+ # @rbs depth: Integer
267
+ # @rbs return: Statements
268
+ def statements(depth)
269
+ return TRANSACTION if depth.zero?
270
+
271
+ name = "skyward_#{depth}"
272
+ Statements.new(
273
+ start: "SAVEPOINT #{name}",
274
+ commit: ["RELEASE SAVEPOINT #{name}"],
275
+ rollback: ["ROLLBACK TO SAVEPOINT #{name}", "RELEASE SAVEPOINT #{name}"]
276
+ )
277
+ end
278
+
279
+ # Untyped, because Steep narrows a generic result to the violation it's
280
+ # tested for and then can't return it as the block's type.
281
+ # @rbs statements: Statements
282
+ # @rbs result: untyped
283
+ # @rbs return: Array[String]
284
+ def ending(statements, result) = result.is_a?(Skyward::ORM::Violation) ? statements.rollback : statements.commit
285
+
286
+ # A start that raised may not have reached the database, which then refuses
287
+ # to roll back, so that refusal gives way to the start's own error. On
288
+ # PostgreSQL a savepoint's refusal leaves the enclosing transaction aborted
289
+ # until that too rolls back, which is accepted: the start's error rolls it
290
+ # back unless a block rescues it and carries on.
291
+ # @rbs connection: Skyward::ORM::_Connection
292
+ # @rbs statements: Statements
293
+ # @rbs started: bool
294
+ # @rbs return: void
295
+ def undo(connection, statements, started)
296
+ statements.rollback.each { |sql| connection.execute(sql) }
297
+ rescue StandardError
298
+ raise if started
299
+ end
300
+
301
+ # @rbs table: singleton(Skyward::ORM::Record)
302
+ # @rbs row: Class
303
+ # @rbs expressed: Array[Symbol]
304
+ # @rbs return: ^(Array[untyped]) -> untyped
305
+ def build(table, row, expressed)
306
+ prepare(table)
307
+ # An expression reads no column, so without a type of its own its value passes through.
308
+ columns = @column_types.columns(table).to_h { |column| [column.name, column.type] }.except(*expressed)
309
+ members = @column_types.columns(row)
310
+ types = members.map { |member| member.type == :untyped ? columns[member.name] || :untyped : member.type }
311
+ compile(row, members.map(&:name), types)
312
+ end
313
+
314
+ # @rbs row: Class
315
+ # @rbs members: Array[Symbol]
316
+ # @rbs types: Array[Skyward::ORM::Tables::column_type]
317
+ # @rbs return: ^(Array[untyped]) -> untyped
318
+ def compile(row, members, types)
319
+ lambda do |values|
320
+ row.new(
321
+ **members.each_with_index.to_h do |member, index|
322
+ value = values.fetch(index)
323
+ [member, value.nil? ? nil : @adapter.decode(types.fetch(index), value)]
324
+ end
325
+ )
326
+ end
327
+ end
328
+
329
+ # Raw SQL returns rows, with no room for a violation, so one raises.
330
+ # @rbs sql: String
331
+ # @rbs values: Array[untyped]
332
+ # @rbs return: [Array[Symbol], Array[Array[untyped]]]
333
+ def run(sql, values)
334
+ statement = Skyward::ORM::Placeholders.replace(sql, values.size) { |position| @adapter.placeholder(position) }
335
+ binds = values.map { |value| @adapter.encode(value) }
336
+ Skyward::ORM::Placeholders.require_scalars(binds, "Skyward.query")
337
+ result = connection { |checked_out| checked_out.execute2(statement, *binds) }
338
+ [result.fetch(0).map(&:to_sym), result.drop(1)]
339
+ rescue StandardError => e
340
+ violation = violation(e, nil)
341
+ raise unless violation
342
+
343
+ raise Skyward::ORM::ViolationError, violation
344
+ end
345
+
346
+ # @rbs row: Class
347
+ # @rbs columns: Array[Symbol]
348
+ # @rbs members: Array[Symbol]
349
+ # @rbs return: void
350
+ def unmatched(row, columns, members)
351
+ extra = columns - members
352
+ raise ArgumentError, "#{row} has no member for #{extra.join(", ")}, which the SQL returns" if extra.any?
353
+
354
+ missing = members - columns
355
+ raise ArgumentError, "The SQL returns no #{missing.join(", ")} for #{row}" if missing.any?
356
+ end
357
+ end
@@ -0,0 +1,102 @@
1
+ # frozen_string_literal: true
2
+
3
+ class Skyward::ORM::Connection::Pool
4
+ # @rbs @size: Integer
5
+ # @rbs @opener: ^() -> Skyward::ORM::_Connection
6
+ # @rbs @timeout: Integer | Float
7
+ # @rbs @idle: Thread::Queue[Skyward::ORM::_Connection | :vacant]
8
+ # @rbs @opened: Integer
9
+ # @rbs @mutex: Thread::Mutex
10
+
11
+ # @rbs size: Integer
12
+ # @rbs opener: ^() -> Skyward::ORM::_Connection
13
+ # @rbs timeout: Integer | Float
14
+ # @rbs return: void
15
+ def initialize(size, opener, timeout: 5)
16
+ @size = size
17
+ @opener = opener
18
+ @timeout = timeout
19
+ @idle = Thread::Queue.new
20
+ @opened = 0
21
+ @mutex = Thread::Mutex.new
22
+ end
23
+
24
+ # @rbs [T] () { (Skyward::ORM::_Connection connection) -> T } -> T
25
+ def with
26
+ connection = checkout
27
+ begin
28
+ yield connection
29
+ ensure
30
+ checkin(connection)
31
+ end
32
+ end
33
+
34
+ # Thread::Queue and Thread::Mutex block only the waiting fiber under a fiber
35
+ # scheduler, so under Falcon a fiber waiting for a connection lets others run.
36
+ # @rbs return: Skyward::ORM::_Connection
37
+ def checkout
38
+ take(@idle.pop(timeout: 0)) || open || take(@idle.pop(timeout: @timeout)) || raise(
39
+ Skyward::ORM::PoolTimeout,
40
+ "Skyward ORM waited #{@timeout} seconds for a database connection, but all #{@size} in its pool " \
41
+ "stayed in use. Pass Skyward.connect a larger pool:, or hold each connection for less time."
42
+ )
43
+ end
44
+
45
+ # A connection can still come back mid-transaction when an exception also
46
+ # interrupts its rollback. This runs in #with's ensure, so a rollback or
47
+ # close that fails raises nothing to replace the block's own exception.
48
+ # @rbs connection: Skyward::ORM::_Connection
49
+ # @rbs return: void
50
+ def checkin(connection)
51
+ if reusable?(connection)
52
+ @idle.push(connection)
53
+ else
54
+ @idle.push(:vacant)
55
+ connection.close
56
+ end
57
+ rescue StandardError
58
+ nil
59
+ end
60
+
61
+ private
62
+
63
+ # @rbs connection: Skyward::ORM::_Connection
64
+ # @rbs return: bool
65
+ def reusable?(connection)
66
+ return true unless connection.transaction_active?
67
+
68
+ connection.execute("ROLLBACK")
69
+ !connection.transaction_active?
70
+ rescue StandardError
71
+ false
72
+ end
73
+
74
+ # @rbs slot: Skyward::ORM::_Connection | :vacant | nil
75
+ # @rbs return: Skyward::ORM::_Connection?
76
+ def take(slot)
77
+ case slot
78
+ when :vacant then fill
79
+ else slot
80
+ end
81
+ end
82
+
83
+ # @rbs return: Skyward::ORM::_Connection
84
+ def fill
85
+ @opener.call
86
+ rescue StandardError
87
+ @idle.push(:vacant)
88
+ raise
89
+ end
90
+
91
+ # The place is taken under the lock but the connection opened outside it, so a
92
+ # slow connect holds up no other checkout.
93
+ # @rbs return: Skyward::ORM::_Connection?
94
+ def open
95
+ return unless @mutex.synchronize { (@opened += 1) if @opened < @size }
96
+
97
+ @opener.call
98
+ rescue StandardError
99
+ @mutex.synchronize { @opened -= 1 }
100
+ raise
101
+ end
102
+ end
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ class Skyward::ORM::Connection::Session
4
+ # @rbs @database: Skyward::ORM::Connection::Database?
5
+ # @rbs @check: bool
6
+
7
+ # @rbs return: void
8
+ def initialize
9
+ @check = true
10
+ end
11
+
12
+ # @rbs database: Skyward::ORM::Connection::Database
13
+ # @rbs return: Skyward::ORM::Connection::Database
14
+ def connect(database)
15
+ @database = database
16
+ end
17
+
18
+ # @rbs return: Skyward::ORM::Connection::Database
19
+ def database
20
+ @database || raise(
21
+ Skyward::Core::BootError,
22
+ "Skyward ORM isn't connected. Call Skyward.connect(url) where your app boots."
23
+ )
24
+ end
25
+
26
+ # @rbs return: bool
27
+ def check? = @check
28
+
29
+ # The migration commands boot the app in here, because the migration is what
30
+ # fixes a schema that doesn't match, and its boot.rb connects with the default.
31
+ # @rbs [T] () { () -> T } -> T
32
+ def without_check
33
+ @check = false
34
+ yield
35
+ ensure
36
+ @check = true
37
+ end
38
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Connection
4
+ # One for the process: Skyward.connect sets its database, for every query. It
5
+ # lives here, not in session.rb, because Zeitwerk expects that file to define only Session.
6
+ SESSION = Skyward::ORM::Connection::Session.new #: Skyward::ORM::Connection::Session
7
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Members
4
+ extend self
5
+
6
+ KEYWORDS = %i[keyreq key].freeze #: Array[Symbol]
7
+
8
+ # @rbs row: Class
9
+ # @rbs return: Array[Symbol]
10
+ def of(row)
11
+ # Steep can't narrow a type by respond_to?.
12
+ return row.members if row.respond_to?(:members) # steep:ignore NoMethod
13
+
14
+ row.instance_method(:initialize).parameters.filter_map { |kind, name| name if KEYWORDS.include?(kind) }
15
+ end
16
+ end
@@ -0,0 +1,4 @@
1
+ # frozen_string_literal: true
2
+
3
+ class Skyward::ORM::MigrationError < StandardError
4
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations
4
+ AddColumn = Data.define(
5
+ :column #: Skyward::ORM::Tables::Column
6
+ )
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations
4
+ AddConstraint = 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
+ AddIndex = Data.define(
5
+ :index #: Skyward::ORM::Catalog::Index
6
+ )
7
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Migrations
4
+ # A table that differs from its class: the class's columns, the table as the
5
+ # database has it, and each difference, in the order the migration makes them.
6
+ AlterTable = Data.define(
7
+ :klass, #: singleton(Skyward::ORM::Record)
8
+ :columns, #: Array[Skyward::ORM::Tables::Column]
9
+ :table, #: Skyward::ORM::Catalog::Table
10
+ :edits #: Array[edit]
11
+ )
12
+ end