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,15 @@
1
+ # Generated from lib/skyward/orm/adapters.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::Adapters
4
+ SCHEMES: Hash[String, Skyward::ORM::_Adapter]
5
+
6
+ # @rbs (String url, schemes: Hash[String, Skyward::ORM::_Adapter], requirer: ^(String) -> void)
7
+ # -> [Skyward::ORM::_Adapter, String]
8
+ def resolve: (String url, schemes: Hash[String, Skyward::ORM::_Adapter], requirer: ^(String) -> void) -> [ Skyward::ORM::_Adapter, String ]
9
+
10
+ private
11
+
12
+ # The URL can hold a password, so only its scheme is shown.
13
+ # @rbs (String? scheme, Hash[String, Skyward::ORM::_Adapter] schemes) -> String
14
+ def unsupported: (String? scheme, Hash[String, Skyward::ORM::_Adapter] schemes) -> String
15
+ end
@@ -0,0 +1,20 @@
1
+ # Generated from lib/skyward/orm/catalog/column.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::Catalog
4
+ class Column < Data
5
+ attr_reader name(): Symbol
6
+
7
+ attr_reader type(): String
8
+
9
+ attr_reader nullable(): bool
10
+
11
+ attr_reader default(): String?
12
+
13
+ def self.new: (Symbol name, String type, bool nullable, String? default) -> instance
14
+ | (name: Symbol, type: String, nullable: bool, default: String?) -> instance
15
+
16
+ def self.members: () -> [ :name, :type, :nullable, :default ]
17
+
18
+ def members: () -> [ :name, :type, :nullable, :default ]
19
+ end
20
+ end
@@ -0,0 +1,22 @@
1
+ # Generated from lib/skyward/orm/catalog/constraint.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::Catalog
4
+ class Constraint < Data
5
+ attr_reader name(): String?
6
+
7
+ attr_reader kind(): constraint_kind
8
+
9
+ attr_reader columns(): Array[Symbol]
10
+
11
+ attr_reader references(): Symbol?
12
+
13
+ attr_reader definition(): String
14
+
15
+ def self.new: (String? name, constraint_kind kind, Array[Symbol] columns, Symbol? references, String definition) -> instance
16
+ | (name: String?, kind: constraint_kind, columns: Array[Symbol], references: Symbol?, definition: String) -> instance
17
+
18
+ def self.members: () -> [ :name, :kind, :columns, :references, :definition ]
19
+
20
+ def members: () -> [ :name, :kind, :columns, :references, :definition ]
21
+ end
22
+ end
@@ -0,0 +1,20 @@
1
+ # Generated from lib/skyward/orm/catalog/index.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::Catalog
4
+ class Index < Data
5
+ attr_reader name(): String
6
+
7
+ attr_reader columns(): Array[Symbol]
8
+
9
+ attr_reader unique(): bool
10
+
11
+ attr_reader definition(): String
12
+
13
+ def self.new: (String name, Array[Symbol] columns, bool unique, String definition) -> instance
14
+ | (name: String, columns: Array[Symbol], unique: bool, definition: String) -> instance
15
+
16
+ def self.members: () -> [ :name, :columns, :unique, :definition ]
17
+
18
+ def members: () -> [ :name, :columns, :unique, :definition ]
19
+ end
20
+ end
@@ -0,0 +1,20 @@
1
+ # Generated from lib/skyward/orm/catalog/table.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::Catalog
4
+ class Table < Data
5
+ attr_reader name(): Symbol
6
+
7
+ attr_reader columns(): Array[Column]
8
+
9
+ attr_reader indexes(): Array[Index]
10
+
11
+ attr_reader constraints(): Array[Constraint]
12
+
13
+ def self.new: (Symbol name, Array[Column] columns, Array[Index] indexes, Array[Constraint] constraints) -> instance
14
+ | (name: Symbol, columns: Array[Column], indexes: Array[Index], constraints: Array[Constraint]) -> instance
15
+
16
+ def self.members: () -> [ :name, :columns, :indexes, :constraints ]
17
+
18
+ def members: () -> [ :name, :columns, :indexes, :constraints ]
19
+ end
20
+ end
@@ -0,0 +1,5 @@
1
+ # Generated from lib/skyward/orm/catalog.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::Catalog
4
+ type constraint_kind = :primary_key | :unique | :foreign_key | :check
5
+ end
@@ -0,0 +1,21 @@
1
+ # Generated from lib/skyward/orm/cli/boot_file.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::CLI::BootFile
4
+ FILE: String
5
+
6
+ # @rbs directory: String
7
+ # @rbs session: Skyward::ORM::Connection::Session
8
+ # @rbs generate: ^() -> String?
9
+ # @rbs return: Skyward::ORM::Connection::Database | String
10
+ def load: (String directory, Skyward::ORM::Connection::Session session, ^() -> String? generate) -> (Skyward::ORM::Connection::Database | String)
11
+
12
+ # The migration commands are what fixes a schema that doesn't match, so they
13
+ # boot the app with the check off.
14
+ # @rbs directory: String
15
+ # @rbs session: Skyward::ORM::Connection::Session
16
+ # @rbs kernel: singleton(Kernel)
17
+ # @rbs generate: ^() -> String?
18
+ # @rbs &: (Skyward::ORM::Connection::Database) -> void
19
+ # @rbs return: void
20
+ def boot: (String directory, Skyward::ORM::Connection::Session session, singleton(Kernel) kernel, ^() -> String? generate) { (Skyward::ORM::Connection::Database) -> void } -> void
21
+ end
@@ -0,0 +1,15 @@
1
+ # Generated from lib/skyward/orm/cli/migrate.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::CLI::Migrate
4
+ NOTHING: String
5
+
6
+ # @rbs (directory: String, out: _Writer, kernel: singleton(Kernel), session: Skyward::ORM::Connection::Session,
7
+ # discover: ^() -> Array[singleton(Skyward::ORM::Record)], generate: ^() -> String?) -> void
8
+ def run: (directory: String, out: _Writer, kernel: singleton(Kernel), session: Skyward::ORM::Connection::Session, discover: ^() -> Array[singleton(Skyward::ORM::Record)], generate: ^() -> String?) -> void
9
+
10
+ private
11
+
12
+ # @rbs (Skyward::ORM::Connection::Database database, directory: String, out: _Writer, kernel: singleton(Kernel),
13
+ # discover: ^() -> Array[singleton(Skyward::ORM::Record)]) -> void
14
+ def migrate: (Skyward::ORM::Connection::Database database, directory: String, out: _Writer, kernel: singleton(Kernel), discover: ^() -> Array[singleton(Skyward::ORM::Record)]) -> void
15
+ end
@@ -0,0 +1,45 @@
1
+ # Generated from lib/skyward/orm/cli/migration.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::CLI::Migration
4
+ NAME: Regexp
5
+
6
+ EMPTY: String
7
+
8
+ USAGE: String
9
+
10
+ NOTHING: String
11
+
12
+ YES: Regexp
13
+
14
+ # @rbs (Array[String] args, directory: String, time: Time, input: IO, out: _Writer, kernel: singleton(Kernel),
15
+ # session: Skyward::ORM::Connection::Session, discover: ^() -> Array[singleton(Skyward::ORM::Record)],
16
+ # generate: ^() -> String?) -> void
17
+ def run: (Array[String] args, directory: String, time: Time, input: IO, out: _Writer, kernel: singleton(Kernel), session: Skyward::ORM::Connection::Session, discover: ^() -> Array[singleton(Skyward::ORM::Record)], generate: ^() -> String?) -> void
18
+
19
+ private
20
+
21
+ # @rbs (String name, directory: String, time: Time, out: _Writer) -> void
22
+ def write_empty: (String name, directory: String, time: Time, out: _Writer) -> void
23
+
24
+ # Writing a second migration before the first has run would write the same
25
+ # change twice, so a pending one stops it. With no terminal to ask whether a
26
+ # column was renamed, it stops rather than guess, since a guess of no drops
27
+ # the column's data.
28
+ # @rbs (String name, Skyward::ORM::Connection::Database database, directory: String, time: Time, input: IO,
29
+ # out: _Writer, kernel: singleton(Kernel), discover: ^() -> Array[singleton(Skyward::ORM::Record)]) -> void
30
+ def write: (String name, Skyward::ORM::Connection::Database database, directory: String, time: Time, input: IO, out: _Writer, kernel: singleton(Kernel), discover: ^() -> Array[singleton(Skyward::ORM::Record)]) -> void
31
+
32
+ # @rbs input: IO
33
+ # @rbs out: _Writer
34
+ # @rbs question: String
35
+ # @rbs return: bool
36
+ def renamed?: (IO input, untyped out, String question) -> bool
37
+
38
+ # @rbs renames: Array[String]
39
+ # @rbs return: String
40
+ def unasked: (Array[String] renames) -> String
41
+
42
+ # @rbs files: Array[String]
43
+ # @rbs return: String
44
+ def pending: (Array[String] files) -> String
45
+ end
@@ -0,0 +1,7 @@
1
+ # Generated from lib/skyward/orm/cli/rollback.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::CLI::Rollback
4
+ # @rbs (directory: String, out: _Writer, kernel: singleton(Kernel), session: Skyward::ORM::Connection::Session,
5
+ # generate: ^() -> String?) -> void
6
+ def run: (directory: String, out: _Writer, kernel: singleton(Kernel), session: Skyward::ORM::Connection::Session, generate: ^() -> String?) -> void
7
+ end
@@ -0,0 +1,17 @@
1
+ # Generated from lib/skyward/orm/cli/status.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::CLI::Status
4
+ # Status only reports, so it can't ask whether a column was renamed, and
5
+ # shows one as a column dropped and another added.
6
+ UNASKED: ^(Symbol, Symbol, Symbol) -> bool
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: String, out: _Writer, kernel: singleton(Kernel), session: Skyward::ORM::Connection::Session, discover: ^() -> Array[singleton(Skyward::ORM::Record)], generate: ^() -> String?) -> void
11
+
12
+ private
13
+
14
+ # @rbs (Skyward::ORM::Connection::Database database, directory: String, out: _Writer, kernel: singleton(Kernel),
15
+ # discover: ^() -> Array[singleton(Skyward::ORM::Record)]) -> void
16
+ def report: (Skyward::ORM::Connection::Database database, directory: String, out: _Writer, kernel: singleton(Kernel), discover: ^() -> Array[singleton(Skyward::ORM::Record)]) -> void
17
+ end
@@ -0,0 +1,4 @@
1
+ # Generated from lib/skyward/orm/cli.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::CLI
4
+ end
@@ -0,0 +1,2 @@
1
+ # Generated from lib/skyward/orm/commands.rb with RBS::Inline
2
+
@@ -0,0 +1,31 @@
1
+ # Generated from lib/skyward/orm/connection/database/schema_check.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::Connection::Database::SchemaCheck
4
+ type problem = [ String, String, String ]
5
+
6
+ MIGRATE: String
7
+
8
+ # Only what the class declares is compared. Extra columns, indexes and
9
+ # constraints are left to `skyward status`, which reports them.
10
+ # @rbs (singleton(Skyward::ORM::Record) klass, Array[Skyward::ORM::Tables::Column] columns,
11
+ # Array[Skyward::ORM::Catalog::Table] tables, Skyward::ORM::_Adapter adapter) -> String?
12
+ def mismatch: (singleton(Skyward::ORM::Record) klass, Array[Skyward::ORM::Tables::Column] columns, Array[Skyward::ORM::Catalog::Table] tables, Skyward::ORM::_Adapter adapter) -> String?
13
+
14
+ private
15
+
16
+ # @rbs (singleton(Skyward::ORM::Record) klass, Skyward::ORM::Catalog::Table table,
17
+ # Skyward::ORM::Tables::Column column, Skyward::ORM::_Adapter adapter) -> Array[problem]
18
+ def column_problems: (singleton(Skyward::ORM::Record) klass, Skyward::ORM::Catalog::Table table, Skyward::ORM::Tables::Column column, Skyward::ORM::_Adapter adapter) -> Array[problem]
19
+
20
+ # @rbs stored: String
21
+ # @rbs declared: String
22
+ # @rbs nullable: bool
23
+ # @rbs return: String
24
+ def nullability: (String stored, String declared, bool nullable) -> String
25
+
26
+ # @rbs klass: singleton(Skyward::ORM::Record)
27
+ # @rbs table: Symbol
28
+ # @rbs problems: Array[problem]
29
+ # @rbs return: String
30
+ def report: (singleton(Skyward::ORM::Record) klass, Symbol table, Array[problem] problems) -> String
31
+ end
@@ -0,0 +1,226 @@
1
+ # Generated from lib/skyward/orm/connection/database.rb with RBS::Inline
2
+
3
+ class Skyward::ORM::Connection::Database
4
+ class Held < Data
5
+ attr_reader connection(): Skyward::ORM::_Connection
6
+
7
+ attr_reader fiber(): Fiber
8
+
9
+ attr_reader transaction(): bool
10
+
11
+ attr_reader depth(): Integer
12
+
13
+ def self.new: (Skyward::ORM::_Connection connection, Fiber fiber, bool transaction, Integer depth) -> instance
14
+ | (connection: Skyward::ORM::_Connection, fiber: Fiber, transaction: bool, depth: Integer) -> instance
15
+
16
+ def self.members: () -> [ :connection, :fiber, :transaction, :depth ]
17
+
18
+ def members: () -> [ :connection, :fiber, :transaction, :depth ]
19
+ end
20
+
21
+ class Statements < Data
22
+ attr_reader start(): String
23
+
24
+ attr_reader commit(): Array[String]
25
+
26
+ attr_reader rollback(): Array[String]
27
+
28
+ def self.new: (String start, Array[String] commit, Array[String] rollback) -> instance
29
+ | (start: String, commit: Array[String], rollback: Array[String]) -> instance
30
+
31
+ def self.members: () -> [ :start, :commit, :rollback ]
32
+
33
+ def members: () -> [ :start, :commit, :rollback ]
34
+ end
35
+
36
+ TRANSACTION: Statements
37
+
38
+ FOREIGN: String
39
+
40
+ @key: Symbol
41
+
42
+ @decoders: Hash[[ singleton(Skyward::ORM::Record), Class, Array[Symbol] ], ^(Array[untyped]) -> untyped]
43
+
44
+ @lock: Thread::Mutex
45
+
46
+ @checked: Set[singleton(Skyward::ORM::Record)]
47
+
48
+ @check: bool
49
+
50
+ @tables: Array[Skyward::ORM::Catalog::Table]
51
+
52
+ @column_types: Skyward::ORM::Tables::ColumnTypes
53
+
54
+ @pool: Skyward::ORM::Connection::Pool
55
+
56
+ @adapter: Skyward::ORM::_Adapter
57
+
58
+ # @rbs (Skyward::ORM::_Adapter adapter, Skyward::ORM::Connection::Pool pool,
59
+ # Skyward::ORM::Tables::ColumnTypes column_types, Array[Skyward::ORM::Catalog::Table] tables, check: bool) -> void
60
+ def initialize: (Skyward::ORM::_Adapter adapter, Skyward::ORM::Connection::Pool pool, Skyward::ORM::Tables::ColumnTypes column_types, Array[Skyward::ORM::Catalog::Table] tables, check: bool) -> void
61
+
62
+ # The seam every query runs through. Fiber storage is copied into child
63
+ # fibers and threads, so one can find a transaction here that isn't its own.
64
+ # @rbs [T] () { (Skyward::ORM::_Connection connection) -> T } -> T
65
+ def connection: [T] () { (Skyward::ORM::_Connection connection) -> T } -> T
66
+
67
+ # @rbs [T] () { () -> T } -> T
68
+ def transaction: [T] () { () -> T } -> T
69
+
70
+ # @rbs return: bool
71
+ def transaction?: () -> bool
72
+
73
+ # A transaction for code that can't wrap itself in one block, such as a
74
+ # test's setup and teardown, until #release rolls it back. transaction?
75
+ # doesn't report it, so code that branches on it behaves as it would untested.
76
+ # @rbs return: void
77
+ def hold: () -> void
78
+
79
+ # Nothing is held when #hold raised before it could take a connection.
80
+ # @rbs return: void
81
+ def release: () -> void
82
+
83
+ # @dynamic adapter
84
+ attr_reader adapter: Skyward::ORM::_Adapter
85
+
86
+ # @dynamic column_types
87
+ attr_reader column_types: Skyward::ORM::Tables::ColumnTypes
88
+
89
+ # @dynamic tables
90
+ attr_reader tables: Array[Skyward::ORM::Catalog::Table]
91
+
92
+ # @rbs sql: String
93
+ # @rbs binds: Array[untyped]
94
+ # @rbs return: Array[Array[untyped]]
95
+ def execute: (String sql, ?Array[untyped] binds) -> Array[Array[untyped]]
96
+
97
+ # @rbs tables: Array[singleton(Skyward::ORM::Record)]
98
+ # @rbs return: void
99
+ def check: (Array[singleton(Skyward::ORM::Record)] tables) -> void
100
+
101
+ # A query selects its row class's members in order, so the decoder reads
102
+ # each value by position.
103
+ # @rbs table: singleton(Skyward::ORM::Record)
104
+ # @rbs row: Class
105
+ # @rbs expressed: Array[Symbol]
106
+ # @rbs return: ^(Array[untyped]) -> untyped
107
+ def decoder: (singleton(Skyward::ORM::Record) table, Class row, Array[Symbol] expressed) -> ^(Array[untyped]) -> untyped
108
+
109
+ # Every query and write calls this before it touches its table, so a table
110
+ # class loaded after connect is checked before its first use.
111
+ # @rbs table: singleton(Skyward::ORM::Record)
112
+ # @rbs return: void
113
+ def prepare: (singleton(Skyward::ORM::Record) table) -> void
114
+
115
+ # @rbs error: StandardError
116
+ # @rbs table: Symbol?
117
+ # @rbs return: Skyward::ORM::Violation?
118
+ def violation: (StandardError error, Symbol? table) -> Skyward::ORM::Violation?
119
+
120
+ # @rbs sql: String
121
+ # @rbs values: Array[untyped]
122
+ # @rbs return: Array[Hash[Symbol, untyped]]
123
+ def hashes: (String sql, Array[untyped] values) -> Array[Hash[Symbol, untyped]]
124
+
125
+ # Raw SQL picks its own columns, in its own order, so they're matched to the
126
+ # row class's members by name.
127
+ # @rbs row: Class
128
+ # @rbs sql: String
129
+ # @rbs values: Array[untyped]
130
+ # @rbs return: Array[untyped]
131
+ def rows: (Class row, String sql, Array[untyped] values) -> Array[untyped]
132
+
133
+ # @rbs migrations: Array[Skyward::ORM::Migrations::Runner::Migration]
134
+ # @rbs return: Skyward::ORM::Migrations::Runner::outcome
135
+ def migrate: (Array[Skyward::ORM::Migrations::Runner::Migration] migrations) -> Skyward::ORM::Migrations::Runner::outcome
136
+
137
+ # @rbs migrations: Array[Skyward::ORM::Migrations::Runner::Migration]
138
+ # @rbs return: Skyward::ORM::Migrations::Runner::rolled_back
139
+ def rollback: (Array[Skyward::ORM::Migrations::Runner::Migration] migrations) -> Skyward::ORM::Migrations::Runner::rolled_back
140
+
141
+ # The count is read on the connection that ran the write, before anything
142
+ # else runs on it.
143
+ # @rbs table: singleton(Skyward::ORM::Record)
144
+ # @rbs sql: String
145
+ # @rbs binds: Array[untyped]
146
+ # @rbs return: Integer | Skyward::ORM::Violation
147
+ def write: (singleton(Skyward::ORM::Record) table, String sql, Array[untyped] binds) -> (Integer | Skyward::ORM::Violation)
148
+
149
+ # RETURNING lists the row class's members in order, as its decoder reads
150
+ # them. Steep can't tie the row class to its rows, so they're untyped here.
151
+ # @rbs table: singleton(Skyward::ORM::Record)
152
+ # @rbs row: Class
153
+ # @rbs sql: String
154
+ # @rbs binds: Array[untyped]
155
+ # @rbs return: Array[untyped] | Skyward::ORM::Violation
156
+ def write_returning: (singleton(Skyward::ORM::Record) table, Class row, String sql, Array[untyped] binds) -> (Array[untyped] | Skyward::ORM::Violation)
157
+
158
+ private
159
+
160
+ # Migrating or rolling back changes the schema read at connect, even when a
161
+ # later migration fails, so it's read again, and every class is checked
162
+ # against it afresh.
163
+ # @rbs [T] () { (Skyward::ORM::_Connection connection) -> T } -> T
164
+ def changing: [T] () { (Skyward::ORM::_Connection connection) -> T } -> T
165
+
166
+ # @rbs held: Held
167
+ # @rbs return: bool
168
+ def owned?: (Held held) -> bool
169
+
170
+ # @rbs [T] (Held held) { () -> T } -> T
171
+ def within: [T] (Held held) { () -> T } -> T
172
+
173
+ # Rolled back in ensure rather than rescue, so a block left by throw or a
174
+ # killed thread rolls back too, and so does a commit that fails, and a start
175
+ # an exception interrupts once it has reached the database.
176
+ # @rbs [T] (Skyward::ORM::_Connection connection, Integer depth) { () -> T } -> T
177
+ def atomically: [T] (Skyward::ORM::_Connection connection, Integer depth) { () -> T } -> T
178
+
179
+ # Each savepoint is named by its depth, so rolling back one whose start never
180
+ # reached the database can't roll back the one enclosing it instead.
181
+ # @rbs depth: Integer
182
+ # @rbs return: Statements
183
+ def statements: (Integer depth) -> Statements
184
+
185
+ # Untyped, because Steep narrows a generic result to the violation it's
186
+ # tested for and then can't return it as the block's type.
187
+ # @rbs statements: Statements
188
+ # @rbs result: untyped
189
+ # @rbs return: Array[String]
190
+ def ending: (Statements statements, untyped result) -> Array[String]
191
+
192
+ # A start that raised may not have reached the database, which then refuses
193
+ # to roll back, so that refusal gives way to the start's own error. On
194
+ # PostgreSQL a savepoint's refusal leaves the enclosing transaction aborted
195
+ # until that too rolls back, which is accepted: the start's error rolls it
196
+ # back unless a block rescues it and carries on.
197
+ # @rbs connection: Skyward::ORM::_Connection
198
+ # @rbs statements: Statements
199
+ # @rbs started: bool
200
+ # @rbs return: void
201
+ def undo: (Skyward::ORM::_Connection connection, Statements statements, bool started) -> void
202
+
203
+ # @rbs table: singleton(Skyward::ORM::Record)
204
+ # @rbs row: Class
205
+ # @rbs expressed: Array[Symbol]
206
+ # @rbs return: ^(Array[untyped]) -> untyped
207
+ def build: (singleton(Skyward::ORM::Record) table, Class row, Array[Symbol] expressed) -> ^(Array[untyped]) -> untyped
208
+
209
+ # @rbs row: Class
210
+ # @rbs members: Array[Symbol]
211
+ # @rbs types: Array[Skyward::ORM::Tables::column_type]
212
+ # @rbs return: ^(Array[untyped]) -> untyped
213
+ def compile: (Class row, Array[Symbol] members, Array[Skyward::ORM::Tables::column_type] types) -> ^(Array[untyped]) -> untyped
214
+
215
+ # Raw SQL returns rows, with no room for a violation, so one raises.
216
+ # @rbs sql: String
217
+ # @rbs values: Array[untyped]
218
+ # @rbs return: [Array[Symbol], Array[Array[untyped]]]
219
+ def run: (String sql, Array[untyped] values) -> [ Array[Symbol], Array[Array[untyped]] ]
220
+
221
+ # @rbs row: Class
222
+ # @rbs columns: Array[Symbol]
223
+ # @rbs members: Array[Symbol]
224
+ # @rbs return: void
225
+ def unmatched: (Class row, Array[Symbol] columns, Array[Symbol] members) -> void
226
+ end
@@ -0,0 +1,54 @@
1
+ # Generated from lib/skyward/orm/connection/pool.rb with RBS::Inline
2
+
3
+ class Skyward::ORM::Connection::Pool
4
+ @size: Integer
5
+
6
+ @opener: ^() -> Skyward::ORM::_Connection
7
+
8
+ @timeout: Integer | Float
9
+
10
+ @idle: Thread::Queue[Skyward::ORM::_Connection | :vacant]
11
+
12
+ @opened: Integer
13
+
14
+ @mutex: Thread::Mutex
15
+
16
+ # @rbs size: Integer
17
+ # @rbs opener: ^() -> Skyward::ORM::_Connection
18
+ # @rbs timeout: Integer | Float
19
+ # @rbs return: void
20
+ def initialize: (Integer size, ^() -> Skyward::ORM::_Connection opener, ?timeout: Integer | Float) -> void
21
+
22
+ # @rbs [T] () { (Skyward::ORM::_Connection connection) -> T } -> T
23
+ def with: [T] () { (Skyward::ORM::_Connection connection) -> T } -> T
24
+
25
+ # Thread::Queue and Thread::Mutex block only the waiting fiber under a fiber
26
+ # scheduler, so under Falcon a fiber waiting for a connection lets others run.
27
+ # @rbs return: Skyward::ORM::_Connection
28
+ def checkout: () -> Skyward::ORM::_Connection
29
+
30
+ # A connection can still come back mid-transaction when an exception also
31
+ # interrupts its rollback. This runs in #with's ensure, so a rollback or
32
+ # close that fails raises nothing to replace the block's own exception.
33
+ # @rbs connection: Skyward::ORM::_Connection
34
+ # @rbs return: void
35
+ def checkin: (Skyward::ORM::_Connection connection) -> void
36
+
37
+ private
38
+
39
+ # @rbs connection: Skyward::ORM::_Connection
40
+ # @rbs return: bool
41
+ def reusable?: (Skyward::ORM::_Connection connection) -> bool
42
+
43
+ # @rbs slot: Skyward::ORM::_Connection | :vacant | nil
44
+ # @rbs return: Skyward::ORM::_Connection?
45
+ def take: (Skyward::ORM::_Connection | :vacant | nil slot) -> Skyward::ORM::_Connection?
46
+
47
+ # @rbs return: Skyward::ORM::_Connection
48
+ def fill: () -> Skyward::ORM::_Connection
49
+
50
+ # The place is taken under the lock but the connection opened outside it, so a
51
+ # slow connect holds up no other checkout.
52
+ # @rbs return: Skyward::ORM::_Connection?
53
+ def open: () -> Skyward::ORM::_Connection?
54
+ end
@@ -0,0 +1,25 @@
1
+ # Generated from lib/skyward/orm/connection/session.rb with RBS::Inline
2
+
3
+ class Skyward::ORM::Connection::Session
4
+ @database: Skyward::ORM::Connection::Database?
5
+
6
+ @check: bool
7
+
8
+ # @rbs return: void
9
+ def initialize: () -> void
10
+
11
+ # @rbs database: Skyward::ORM::Connection::Database
12
+ # @rbs return: Skyward::ORM::Connection::Database
13
+ def connect: (Skyward::ORM::Connection::Database database) -> Skyward::ORM::Connection::Database
14
+
15
+ # @rbs return: Skyward::ORM::Connection::Database
16
+ def database: () -> Skyward::ORM::Connection::Database
17
+
18
+ # @rbs return: bool
19
+ def check?: () -> bool
20
+
21
+ # The migration commands boot the app in here, because the migration is what
22
+ # fixes a schema that doesn't match, and its boot.rb connects with the default.
23
+ # @rbs [T] () { () -> T } -> T
24
+ def without_check: [T] () { () -> T } -> T
25
+ end
@@ -0,0 +1,7 @@
1
+ # Generated from lib/skyward/orm/connection.rb with RBS::Inline
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
7
+ end
@@ -0,0 +1,9 @@
1
+ # Generated from lib/skyward/orm/members.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::Members
4
+ KEYWORDS: Array[Symbol]
5
+
6
+ # @rbs row: Class
7
+ # @rbs return: Array[Symbol]
8
+ def of: (Class row) -> Array[Symbol]
9
+ end
@@ -0,0 +1,4 @@
1
+ # Generated from lib/skyward/orm/migration_error.rb with RBS::Inline
2
+
3
+ class Skyward::ORM::MigrationError < StandardError
4
+ end
@@ -0,0 +1,14 @@
1
+ # Generated from lib/skyward/orm/migrations/add_column.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::Migrations
4
+ class AddColumn < Data
5
+ attr_reader column(): Skyward::ORM::Tables::Column
6
+
7
+ def self.new: (Skyward::ORM::Tables::Column column) -> instance
8
+ | (column: Skyward::ORM::Tables::Column) -> instance
9
+
10
+ def self.members: () -> [ :column ]
11
+
12
+ def members: () -> [ :column ]
13
+ end
14
+ end
@@ -0,0 +1,14 @@
1
+ # Generated from lib/skyward/orm/migrations/add_constraint.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::Migrations
4
+ class AddConstraint < Data
5
+ attr_reader constraint(): Skyward::ORM::Catalog::Constraint
6
+
7
+ def self.new: (Skyward::ORM::Catalog::Constraint constraint) -> instance
8
+ | (constraint: Skyward::ORM::Catalog::Constraint) -> instance
9
+
10
+ def self.members: () -> [ :constraint ]
11
+
12
+ def members: () -> [ :constraint ]
13
+ end
14
+ end
@@ -0,0 +1,14 @@
1
+ # Generated from lib/skyward/orm/migrations/add_index.rb with RBS::Inline
2
+
3
+ module Skyward::ORM::Migrations
4
+ class AddIndex < Data
5
+ attr_reader index(): Skyward::ORM::Catalog::Index
6
+
7
+ def self.new: (Skyward::ORM::Catalog::Index index) -> instance
8
+ | (index: Skyward::ORM::Catalog::Index) -> instance
9
+
10
+ def self.members: () -> [ :index ]
11
+
12
+ def members: () -> [ :index ]
13
+ end
14
+ end
@@ -0,0 +1,22 @@
1
+ # Generated from lib/skyward/orm/migrations/alter_table.rb with RBS::Inline
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
+ class AlterTable < Data
7
+ attr_reader klass(): singleton(Skyward::ORM::Record)
8
+
9
+ attr_reader columns(): Array[Skyward::ORM::Tables::Column]
10
+
11
+ attr_reader table(): Skyward::ORM::Catalog::Table
12
+
13
+ attr_reader edits(): Array[edit]
14
+
15
+ def self.new: (singleton(Skyward::ORM::Record) klass, Array[Skyward::ORM::Tables::Column] columns, Skyward::ORM::Catalog::Table table, Array[edit] edits) -> instance
16
+ | (klass: singleton(Skyward::ORM::Record), columns: Array[Skyward::ORM::Tables::Column], table: Skyward::ORM::Catalog::Table, edits: Array[edit]) -> instance
17
+
18
+ def self.members: () -> [ :klass, :columns, :table, :edits ]
19
+
20
+ def members: () -> [ :klass, :columns, :table, :edits ]
21
+ end
22
+ end