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,588 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Skyward::ORM::Query and Skyward::ORM::Projection differ only in what a write
4
+ # returns, so everything else is here.
5
+ # @rbs generic R
6
+ module Skyward::ORM::Queries::Clauses
7
+ include Enumerable #[R]
8
+
9
+ # @rbs!
10
+ # type direction = :asc | :desc
11
+ # type condition = Comparison | Fragment | Negation | Disjunction
12
+ # type scope = :all | :start | :narrowed
13
+
14
+ DIRECTIONS = %i[asc desc].freeze #: Array[direction]
15
+
16
+ Comparison = Data.define(
17
+ :column, #: Symbol
18
+ :operator, #: String
19
+ :value #: untyped
20
+ )
21
+
22
+ Fragment = Data.define(
23
+ :sql, #: String
24
+ :values #: Array[untyped]
25
+ )
26
+
27
+ Negation = Data.define(
28
+ :conditions #: Array[condition]
29
+ )
30
+
31
+ Disjunction = Data.define(
32
+ :left, #: Array[condition]
33
+ :right #: Array[condition]
34
+ )
35
+
36
+ Join = Data.define(
37
+ :keyword, #: String
38
+ :table, #: singleton(Skyward::ORM::Record)
39
+ :on #: Hash[Symbol, Symbol]
40
+ )
41
+
42
+ # @rbs @table: singleton(Skyward::ORM::Record)
43
+ # @rbs @session: Skyward::ORM::Connection::Session
44
+ # @rbs @joins: Array[Join]
45
+ # @rbs @row: Class
46
+ # @rbs @expressions: Hash[Symbol, String]
47
+ # @rbs @scope: scope
48
+ # @rbs @conditions: Array[condition]
49
+ # @rbs @orders: Array[[Symbol, direction]]
50
+ # @rbs @groups: Array[Symbol]
51
+ # @rbs @limit: Integer?
52
+ # @rbs @offset: Integer?
53
+
54
+ # scope: is :all only for an explicit Todo.all, which may update or delete
55
+ # every row, and :narrowed once a where or exclude has been called, even
56
+ # with nothing, which an insert refuses.
57
+ # @rbs table: singleton(Skyward::ORM::Record)
58
+ # @rbs session: Skyward::ORM::Connection::Session
59
+ # @rbs joins: Array[Join]
60
+ # @rbs row: Class
61
+ # @rbs expressions: Hash[Symbol, String]
62
+ # @rbs scope: scope
63
+ # @rbs conditions: Array[condition]
64
+ # @rbs orders: Array[[Symbol, direction]]
65
+ # @rbs groups: Array[Symbol]
66
+ # @rbs limit: Integer?
67
+ # @rbs offset: Integer?
68
+ # @rbs return: void
69
+ def initialize(
70
+ table,
71
+ session,
72
+ joins: [],
73
+ row: table,
74
+ expressions: {},
75
+ scope: :start,
76
+ conditions: [],
77
+ orders: [],
78
+ groups: [],
79
+ limit: nil,
80
+ offset: nil
81
+ )
82
+ @table = table
83
+ @session = session
84
+ @joins = [*joins].freeze
85
+ @row = row
86
+ @expressions = expressions.dup.freeze
87
+ @scope = scope
88
+ @conditions = [*conditions].freeze
89
+ @orders = [*orders].freeze
90
+ @groups = [*groups].freeze
91
+ @limit = limit
92
+ @offset = offset
93
+ freeze
94
+ end
95
+
96
+ # @rbs table: singleton(Skyward::ORM::Record)
97
+ # @rbs **on: Symbol
98
+ # @rbs return: self
99
+ def join(table, **on) = with(joins: [*@joins, joined("JOIN", table, on)])
100
+
101
+ # @rbs table: singleton(Skyward::ORM::Record)
102
+ # @rbs **on: Symbol
103
+ # @rbs return: self
104
+ def left_join(table, **on) = with(joins: [*@joins, joined("LEFT JOIN", table, on)])
105
+
106
+ # @rbs sql: String?
107
+ # @rbs *values: untyped
108
+ # @rbs **conditions: untyped
109
+ # @rbs return: self
110
+ def where(sql = nil, *values, **conditions)
111
+ with(scope: :narrowed, conditions: [*@conditions, *build(sql, values, conditions)])
112
+ end
113
+
114
+ # @rbs sql: String?
115
+ # @rbs *values: untyped
116
+ # @rbs **conditions: untyped
117
+ # @rbs return: self
118
+ def exclude(sql = nil, *values, **conditions)
119
+ built = build(sql, values, conditions)
120
+ with(scope: :narrowed, conditions: built.empty? ? @conditions : [*@conditions, Negation.new(conditions: built)])
121
+ end
122
+
123
+ # @rbs sql: String?
124
+ # @rbs *values: untyped
125
+ # @rbs **conditions: untyped
126
+ # @rbs return: self
127
+ def or(sql = nil, *values, **conditions)
128
+ raise ArgumentError, "#{@table} has no conditions to or with. Start with where or exclude." if @conditions.empty?
129
+
130
+ built = build(sql, values, conditions)
131
+ raise ArgumentError, "#{@table} has nothing to or with. Give or conditions or SQL." if built.empty?
132
+
133
+ with(conditions: [Disjunction.new(left: @conditions, right: built)])
134
+ end
135
+
136
+ # @rbs *columns: Symbol
137
+ # @rbs **directions: direction
138
+ # @rbs return: self
139
+ def order(*columns, **directions)
140
+ Skyward::ORM::Statements.require_columns(@table, [*columns, *directions.keys])
141
+ # The direction is written into the SQL, so only these two may reach it.
142
+ column, direction = directions.find { |_, candidate| !DIRECTIONS.include?(candidate) }
143
+ raise ArgumentError, "#{@table} can't order #{column} by #{direction.inspect}, only :asc or :desc" if column
144
+
145
+ with(orders: [*@orders, *columns.map { |name| [name, :asc] }, *directions.to_a])
146
+ end
147
+
148
+ # @rbs *columns: Symbol
149
+ # @rbs return: self
150
+ def group(*columns)
151
+ Skyward::ORM::Statements.require_columns(@table, columns)
152
+ with(groups: [*@groups, *columns])
153
+ end
154
+
155
+ # @rbs count: Integer
156
+ # @rbs return: self
157
+ def limit(count) = with(limit: require_count(:limit, count))
158
+
159
+ # @rbs count: Integer
160
+ # @rbs return: self
161
+ def offset(count) = with(offset: require_count(:offset, count))
162
+
163
+ # Steep ties the row class to S only through its new, so the query keeps it
164
+ # as the Class it is.
165
+ # @rbs [S] (Skyward::ORM::_Row[S] row, **String expressions) -> Skyward::ORM::Projection[S]
166
+ def into(row, **expressions)
167
+ klass = row #: Class
168
+ require_members(klass, expressions)
169
+ with(query: Skyward::ORM::Projection, row: klass, expressions:)
170
+ end
171
+
172
+ # Ordered by the primary key when nothing else orders it, so both databases
173
+ # return the same row.
174
+ # @rbs () -> R?
175
+ # | (Integer count) -> Array[R]
176
+ def first(count = nil)
177
+ return super if count
178
+
179
+ rows(@orders.empty? ? [[@table.schema.primary_key, :asc]] : @orders, 1).first
180
+ end
181
+
182
+ # @rbs **conditions: untyped
183
+ # @rbs return: R?
184
+ def find_by(**conditions) = where(**conditions).first
185
+
186
+ # PostgreSQL refuses an ORDER BY beside COUNT(*), so the count leaves it out.
187
+ # A LIMIT beside it would limit the one row COUNT(*) returns, so a page is
188
+ # counted through a subquery, as the groups of a grouped query are.
189
+ # @rbs (*untyped args) ?{ (R) -> boolish } -> Integer
190
+ def count(*args, &block)
191
+ return super if block || !args.empty?
192
+
193
+ database = @session.database
194
+ prepare(database)
195
+ sql, binds = from(database, [], @limit)
196
+ counted = @groups.empty? && @limit.nil? && @offset.nil? ? sql : %(FROM (SELECT 1 #{sql}) AS "counted")
197
+ # PostgreSQL's driver returns every value as text, so the adapter reads it.
198
+ database.adapter.decode(:integer, database.execute("SELECT COUNT(*) #{counted}", binds).fetch(0).fetch(0))
199
+ end
200
+
201
+ # Order can't change whether the query has a row, so it's left out, and a
202
+ # limit of 0 has none.
203
+ # @rbs return: bool
204
+ def exists?
205
+ database = @session.database
206
+ prepare(database)
207
+ sql, binds = from(database, [], [@limit, 1].compact.min)
208
+ !database.execute("SELECT 1 #{sql}", binds).empty?
209
+ end
210
+
211
+ # @rbs () { (R) -> void } -> self
212
+ # | () -> Enumerator[R, self]
213
+ def each(&block)
214
+ return enum_for(:each) unless block
215
+
216
+ rows(@orders, @limit).each(&block)
217
+ self
218
+ end
219
+
220
+ # @rbs return: [String, Array[untyped]]
221
+ def to_sql = statement(@session.database, @orders, @limit)
222
+
223
+ private
224
+
225
+ # Steep can't tie the class it builds to self, or the row class to S, so
226
+ # each public method types the query it returns.
227
+ # @rbs query: Class
228
+ # @rbs joins: Array[Join]
229
+ # @rbs row: Class
230
+ # @rbs expressions: Hash[Symbol, String]
231
+ # @rbs scope: scope
232
+ # @rbs conditions: Array[condition]
233
+ # @rbs orders: Array[[Symbol, direction]]
234
+ # @rbs groups: Array[Symbol]
235
+ # @rbs limit: Integer?
236
+ # @rbs offset: Integer?
237
+ # @rbs return: untyped
238
+ def with(
239
+ # Steep reads self.class in a module as the module, though it's always the
240
+ # class that includes it.
241
+ query: self.class, # steep:ignore IncompatibleAssignment
242
+ joins: @joins,
243
+ row: @row,
244
+ expressions: @expressions,
245
+ scope: @scope,
246
+ conditions: @conditions,
247
+ orders: @orders,
248
+ groups: @groups,
249
+ limit: @limit,
250
+ offset: @offset
251
+ )
252
+ query.new(@table, @session, joins:, row:, expressions:, scope:, conditions:, orders:, groups:, limit:, offset:)
253
+ end
254
+
255
+ # @rbs keyword: String
256
+ # @rbs table: singleton(Skyward::ORM::Record)
257
+ # @rbs on: Hash[Symbol, Symbol]
258
+ # @rbs return: Join
259
+ def joined(keyword, table, on)
260
+ unless table.is_a?(Class) && table < Skyward::ORM::Record && table.schema.table
261
+ raise ArgumentError, "#{@table} can't join #{table.inspect}, which isn't a table class"
262
+ end
263
+ # A table that's in a query twice needs an alias to tell the two apart,
264
+ # which a query can't give it.
265
+ if tables.any? { |present| present.table_name == table.table_name }
266
+ raise ArgumentError, "#{@table} can't join #{table}, since #{table.table_name} is already in the query"
267
+ end
268
+ raise ArgumentError, "#{@table} can't join #{table} on nothing. Give it columns, such as list_id: :id" if on.empty?
269
+
270
+ Skyward::ORM::Statements.require_columns(@table, on.keys)
271
+ Skyward::ORM::Statements.require_columns(table, on.values)
272
+ Join.new(keyword:, table:, on:)
273
+ end
274
+
275
+ # @rbs sql: String?
276
+ # @rbs values: Array[untyped]
277
+ # @rbs conditions: Hash[Symbol, untyped]
278
+ # @rbs return: Array[condition]
279
+ def build(sql, values, conditions)
280
+ Skyward::ORM::Statements.require_conditions(@session.database.column_types, @table, conditions)
281
+ [(Fragment.new(sql:, values:) if sql), *conditions.flat_map { |column, value| comparisons(column, value) }].compact
282
+ end
283
+
284
+ # @rbs column: Symbol
285
+ # @rbs value: untyped
286
+ # @rbs return: Array[Comparison]
287
+ def comparisons(column, value)
288
+ return [Comparison.new(column:, operator: "=", value:)] unless value.is_a?(Range)
289
+
290
+ ends = [
291
+ (Comparison.new(column:, operator: ">=", value: value.begin) unless value.begin.nil?),
292
+ (Comparison.new(column:, operator: value.exclude_end? ? "<" : "<=", value: value.end) unless value.end.nil?)
293
+ ].compact
294
+ raise ArgumentError, "#{@table} can't match #{column} to #{value.inspect}, a range with neither end" if ends.empty?
295
+
296
+ ends
297
+ end
298
+
299
+ # @rbs return: Array[String]
300
+ def clauses
301
+ [
302
+ ("into expressions" unless @expressions.empty?),
303
+ ("join" unless @joins.empty?),
304
+ ("order" unless @orders.empty?),
305
+ ("group" unless @groups.empty?),
306
+ ("limit" if @limit),
307
+ ("offset" if @offset)
308
+ ].compact
309
+ end
310
+
311
+ # @rbs clauses: Array[String]
312
+ # @rbs return: String
313
+ def listing(clauses)
314
+ *others, last = clauses
315
+ others.empty? ? last.to_s : "#{others.join(", ")} or #{last}"
316
+ end
317
+
318
+ # Neither PostgreSQL nor SQLite (as it's usually built) takes a JOIN,
319
+ # ORDER BY, GROUP BY, LIMIT or OFFSET on an UPDATE or DELETE, and an into
320
+ # expression, such as an aggregate, means nothing portable in its RETURNING.
321
+ # @rbs method: Symbol
322
+ # @rbs return: void
323
+ def require_writable(method)
324
+ refused = clauses
325
+ unless refused.empty?
326
+ raise ArgumentError,
327
+ "#{@table} can't #{method} a query with #{listing(refused)}, which PostgreSQL and SQLite don't both support"
328
+ end
329
+ return unless @conditions.empty? && @scope != :all
330
+
331
+ raise ArgumentError,
332
+ "#{@table} can't #{method} a query with no conditions, which would change every row. " \
333
+ "Narrow it with where or exclude, or start from #{@table}.all to change every row."
334
+ end
335
+
336
+ # @rbs method: Symbol
337
+ # @rbs count: Integer
338
+ # @rbs return: Integer
339
+ def require_count(method, count)
340
+ return count if count.is_a?(Integer) && !count.negative?
341
+
342
+ raise ArgumentError, "#{@table} can't #{method} by #{count.inspect}, only by a non-negative Integer"
343
+ end
344
+
345
+ # @rbs row: Class
346
+ # @rbs expressions: Hash[Symbol, String]
347
+ # @rbs return: void
348
+ def require_members(row, expressions)
349
+ members = Skyward::ORM::Members.of(row)
350
+ unknown = expressions.keys - members
351
+ raise ArgumentError, "#{row} has no member #{unknown.join(", ")} to take an expression" unless unknown.empty?
352
+
353
+ unread = members - @table.schema.columns - expressions.keys
354
+ return if unread.empty?
355
+
356
+ raise ArgumentError, "#{@table} has no column #{unread.join(", ")}, so #{row} needs an expression for it"
357
+ end
358
+
359
+ # @rbs database: Skyward::ORM::Connection::Database
360
+ # @rbs orders: Array[[Symbol, direction]]
361
+ # @rbs limit: Integer?
362
+ # @rbs return: [String, Array[untyped]]
363
+ def statement(database, orders, limit)
364
+ sql, binds = from(database, orders, limit)
365
+ columns = Skyward::ORM::Members.of(@row).map do |member|
366
+ expression = @expressions.fetch(member, nil)
367
+ expression ? "#{expression} AS #{Skyward::ORM::Statements.quote(member)}" : qualified(member)
368
+ end.join(", ")
369
+ ["SELECT #{columns} #{sql}", binds]
370
+ end
371
+
372
+ # @rbs database: Skyward::ORM::Connection::Database
373
+ # @rbs orders: Array[[Symbol, direction]]
374
+ # @rbs limit: Integer?
375
+ # @rbs return: [String, Array[untyped]]
376
+ def from(database, orders, limit)
377
+ adapter = database.adapter
378
+ where, binds = filter(database, 1)
379
+ ordered = orders.map { |column, direction| "#{qualified(column)} #{direction.upcase}" }
380
+ # The limit and offset are bound rather than written in, so every page of a
381
+ # query shares one SQL string.
382
+ paging = [limit, @offset].compact
383
+ sql = [
384
+ "FROM #{Skyward::ORM::Statements.quote(@table.table_name)}",
385
+ *@joins.map { |join| joining(join) },
386
+ where,
387
+ ("GROUP BY #{@groups.map { |column| qualified(column) }.join(", ")}" unless @groups.empty?),
388
+ ("ORDER BY #{ordered.join(", ")}" unless orders.empty?),
389
+ limit ? "LIMIT #{adapter.placeholder(binds.size + 1)}" : (adapter.unlimited if @offset),
390
+ ("OFFSET #{adapter.placeholder(binds.size + paging.size)}" if @offset)
391
+ ].compact.join(" ")
392
+ [sql, [*binds, *paging]]
393
+ end
394
+
395
+ # @rbs join: Join
396
+ # @rbs return: String
397
+ def joining(join)
398
+ on = join.on.map { |column, joined| "#{qualified(column)} = #{qualified(joined, join.table)}" }.join(" AND ")
399
+ "#{join.keyword} #{Skyward::ORM::Statements.quote(join.table.table_name)} ON #{on}"
400
+ end
401
+
402
+ # An UPDATE binds its SET values first, so its WHERE's numbered placeholders
403
+ # start after them.
404
+ # @rbs database: Skyward::ORM::Connection::Database
405
+ # @rbs position: Integer
406
+ # @rbs return: [String?, Array[untyped]]
407
+ def filter(database, position)
408
+ clauses, binds = conjunction(database, @conditions, position)
409
+ [("WHERE #{clauses}" unless @conditions.empty?), binds]
410
+ end
411
+
412
+ # @rbs database: Skyward::ORM::Connection::Database
413
+ # @rbs conditions: Array[condition]
414
+ # @rbs position: Integer
415
+ # @rbs return: [String, Array[untyped]]
416
+ def conjunction(database, conditions, position)
417
+ none = [[], []] #: [Array[String], Array[untyped]]
418
+ clauses, binds = conditions.reduce(none) do |(sqls, values), condition|
419
+ sql, bound = render(database, condition, position + values.size)
420
+ [[*sqls, condition.is_a?(Disjunction) && conditions.size > 1 ? "(#{sql})" : sql], [*values, *bound]]
421
+ end
422
+ [clauses.join(" AND "), binds]
423
+ end
424
+
425
+ # @rbs database: Skyward::ORM::Connection::Database
426
+ # @rbs condition: condition
427
+ # @rbs position: Integer
428
+ # @rbs return: [String, Array[untyped]]
429
+ def render(database, condition, position)
430
+ case condition
431
+ when Comparison then comparison(database, condition, position)
432
+ when Fragment then fragment(database, condition, position)
433
+ when Negation then negation(database, condition.conditions, position)
434
+ when Disjunction
435
+ left, left_binds = alternative(database, condition.left, position)
436
+ right, right_binds = alternative(database, condition.right, position + left_binds.size)
437
+ ["#{left} OR #{right}", [*left_binds, *right_binds]]
438
+ end
439
+ end
440
+
441
+ # @rbs database: Skyward::ORM::Connection::Database
442
+ # @rbs comparison: Comparison
443
+ # @rbs position: Integer
444
+ # @rbs return: [String, Array[untyped]]
445
+ def comparison(database, comparison, position)
446
+ name = qualified(comparison.column)
447
+ value = comparison.value
448
+ case value
449
+ when nil then ["#{name} IS NULL", []]
450
+ when Array then within(database, name, value, position)
451
+ else ["#{name} #{comparison.operator} #{database.adapter.placeholder(position)}", [database.adapter.encode(value)]]
452
+ end
453
+ end
454
+
455
+ # @rbs database: Skyward::ORM::Connection::Database
456
+ # @rbs fragment: Fragment
457
+ # @rbs position: Integer
458
+ # @rbs return: [String, Array[untyped]]
459
+ def fragment(database, fragment, position)
460
+ adapter = database.adapter
461
+ binds = fragment.values.map { |value| adapter.encode(value) }
462
+ Skyward::ORM::Placeholders.require_scalars(binds, "An SQL condition")
463
+ sql = Skyward::ORM::Placeholders.replace(fragment.sql, binds.size) do |index|
464
+ adapter.placeholder(position + index - 1)
465
+ end
466
+ # A -- comment runs to the end of its line, so the closing parenthesis
467
+ # goes on a line of its own.
468
+ ["(#{sql}#{"\n" if sql.include?("--")})", binds]
469
+ end
470
+
471
+ # NOT of an unknown is unknown, so a row whose column is NULL would be left
472
+ # out, though it doesn't match. An untyped column may hold NULL, and an SQL
473
+ # string's columns can't be known.
474
+ # @rbs database: Skyward::ORM::Connection::Database
475
+ # @rbs conditions: Array[condition]
476
+ # @rbs position: Integer
477
+ # @rbs return: [String, Array[untyped]]
478
+ def negation(database, conditions, position)
479
+ sql, binds = conjunction(database, conditions, position)
480
+ nullable = database.column_types.columns(@table).select { |column| column.nullable || column.type == :untyped }
481
+ .map(&:name)
482
+ unknowable = conditions.filter_map do |condition|
483
+ next unless condition.is_a?(Comparison) && nullable.include?(condition.column)
484
+
485
+ value = condition.value
486
+ condition.column unless value.nil? || (value.is_a?(Array) && value.include?(nil))
487
+ end
488
+ kept = unknowable.uniq.map { |column| " OR #{qualified(column)} IS NULL" }.join
489
+ [kept.empty? ? "NOT (#{sql})" : "(NOT (#{sql})#{kept})", binds]
490
+ end
491
+
492
+ # @rbs database: Skyward::ORM::Connection::Database
493
+ # @rbs conditions: Array[condition]
494
+ # @rbs position: Integer
495
+ # @rbs return: [String, Array[untyped]]
496
+ def alternative(database, conditions, position)
497
+ sql, binds = conjunction(database, conditions, position)
498
+ [conditions.size > 1 ? "(#{sql})" : sql, binds]
499
+ end
500
+
501
+ # PostgreSQL refuses an empty IN (), and IN never matches NULL.
502
+ # @rbs database: Skyward::ORM::Connection::Database
503
+ # @rbs name: String
504
+ # @rbs values: Array[untyped]
505
+ # @rbs position: Integer
506
+ # @rbs return: [String, Array[untyped]]
507
+ def within(database, name, values, position)
508
+ present = values.compact
509
+ placeholders = Array.new(present.size) { |index| database.adapter.placeholder(position + index) }
510
+ list = "#{name} IN (#{placeholders.join(", ")})"
511
+ sql = if values.empty? then "1 = 0"
512
+ elsif present.empty? then "#{name} IS NULL"
513
+ elsif values.include?(nil) then "(#{list} OR #{name} IS NULL)"
514
+ else list
515
+ end
516
+ [sql, present.map { |value| database.adapter.encode(value) }]
517
+ end
518
+
519
+ # Steep can't tie the row class to R, so the rows are untyped here and each
520
+ # public method types them.
521
+ # @rbs orders: Array[[Symbol, direction]]
522
+ # @rbs limit: Integer?
523
+ # @rbs return: Array[untyped]
524
+ def rows(orders, limit)
525
+ database = @session.database
526
+ # Building the decoder prepares the starting table, once.
527
+ @joins.each { |join| database.prepare(join.table) }
528
+ decode = database.decoder(@table, @row, @expressions.keys)
529
+ sql, binds = statement(database, orders, limit)
530
+ database.execute(sql, binds).map(&decode)
531
+ end
532
+
533
+ # @rbs return: Array[singleton(Skyward::ORM::Record)]
534
+ def tables = [@table, *@joins.map(&:table)]
535
+
536
+ # @rbs database: Skyward::ORM::Connection::Database
537
+ # @rbs return: void
538
+ def prepare(database) = tables.each { |table| database.prepare(table) }
539
+
540
+ # Once a query has a join, a column's name could be in more than one table,
541
+ # so each is qualified with its own.
542
+ # @rbs name: Symbol
543
+ # @rbs table: singleton(Skyward::ORM::Record)
544
+ # @rbs return: String
545
+ def qualified(name, table = @table)
546
+ quoted = Skyward::ORM::Statements.quote(name)
547
+ @joins.empty? ? quoted : "#{Skyward::ORM::Statements.quote(table.table_name)}.#{quoted}"
548
+ end
549
+
550
+ # @rbs values: Hash[Symbol, untyped]
551
+ # @rbs return: [String, Array[untyped]]
552
+ def updating(values)
553
+ raise ArgumentError, "#{@table} update needs a column to set, such as update(done: true)" if values.empty?
554
+
555
+ database = @session.database
556
+ Skyward::ORM::Statements.require_values(database.column_types, @table, values)
557
+ assignments = values.keys.each.with_index(1).map do |column, position|
558
+ "#{Skyward::ORM::Statements.quote(column)} = #{database.adapter.placeholder(position)}"
559
+ end
560
+ changing(
561
+ :update,
562
+ "UPDATE #{Skyward::ORM::Statements.quote(@table.table_name)} SET #{assignments.join(", ")}",
563
+ values.values
564
+ )
565
+ end
566
+
567
+ # @rbs return: [String, Array[untyped]]
568
+ def deleting = changing(:delete, "DELETE FROM #{Skyward::ORM::Statements.quote(@table.table_name)}", [])
569
+
570
+ # @rbs method: Symbol
571
+ # @rbs sql: String
572
+ # @rbs values: Array[untyped]
573
+ # @rbs return: [String, Array[untyped]]
574
+ def changing(method, sql, values)
575
+ require_writable(method)
576
+ database = @session.database
577
+ where, binds = filter(database, values.size + 1)
578
+ [[sql, where].compact.join(" "), [*values.map { |value| database.adapter.encode(value) }, *binds]]
579
+ end
580
+
581
+ # @rbs [T] (T | Skyward::ORM::Violation written) -> T
582
+ def unviolated(written)
583
+ case written
584
+ when Skyward::ORM::Violation then raise Skyward::ORM::ViolationError, written
585
+ else written
586
+ end
587
+ end
588
+ end
@@ -0,0 +1,4 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Skyward::ORM::Queries
4
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ # @rbs generic R
4
+ class Skyward::ORM::Query
5
+ include Skyward::ORM::Queries::Clauses #[R]
6
+
7
+ # @rbs **values: untyped
8
+ # @rbs return: Integer | Skyward::ORM::Violation
9
+ def update(**values)
10
+ sql, binds = updating(values)
11
+ @session.database.write(@table, sql, binds)
12
+ end
13
+
14
+ # @rbs **values: untyped
15
+ # @rbs return: Integer
16
+ def update!(**values) = unviolated(update(**values))
17
+
18
+ # @rbs return: Integer | Skyward::ORM::Violation
19
+ def delete
20
+ sql, binds = deleting
21
+ @session.database.write(@table, sql, binds)
22
+ end
23
+
24
+ # @rbs return: Integer
25
+ def delete! = unviolated(delete)
26
+ end