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.
- checksums.yaml +4 -4
- data/README.md +182 -75
- data/lib/skyward/orm/adapters/postgresql/connection.rb +52 -0
- data/lib/skyward/orm/adapters/postgresql.rb +283 -0
- data/lib/skyward/orm/adapters/sqlite/constraints.rb +172 -0
- data/lib/skyward/orm/adapters/sqlite.rb +317 -0
- data/lib/skyward/orm/adapters.rb +38 -0
- data/lib/skyward/orm/catalog/column.rb +12 -0
- data/lib/skyward/orm/catalog/constraint.rb +13 -0
- data/lib/skyward/orm/catalog/index.rb +11 -0
- data/lib/skyward/orm/catalog/table.rb +10 -0
- data/lib/skyward/orm/catalog.rb +6 -0
- data/lib/skyward/orm/cli/boot_file.rb +43 -0
- data/lib/skyward/orm/cli/migrate.rb +30 -0
- data/lib/skyward/orm/cli/migration.rb +111 -0
- data/lib/skyward/orm/cli/rollback.rb +18 -0
- data/lib/skyward/orm/cli/status.rb +36 -0
- data/lib/skyward/orm/cli.rb +4 -0
- data/lib/skyward/orm/commands.rb +64 -0
- data/lib/skyward/orm/connection/database/schema_check.rb +67 -0
- data/lib/skyward/orm/connection/database.rb +357 -0
- data/lib/skyward/orm/connection/pool.rb +102 -0
- data/lib/skyward/orm/connection/session.rb +38 -0
- data/lib/skyward/orm/connection.rb +7 -0
- data/lib/skyward/orm/members.rb +16 -0
- data/lib/skyward/orm/migration_error.rb +4 -0
- data/lib/skyward/orm/migrations/add_column.rb +7 -0
- data/lib/skyward/orm/migrations/add_constraint.rb +7 -0
- data/lib/skyward/orm/migrations/add_index.rb +7 -0
- data/lib/skyward/orm/migrations/alter_table.rb +12 -0
- data/lib/skyward/orm/migrations/change_default.rb +9 -0
- data/lib/skyward/orm/migrations/change_nullable.rb +8 -0
- data/lib/skyward/orm/migrations/change_type.rb +9 -0
- data/lib/skyward/orm/migrations/create_table.rb +8 -0
- data/lib/skyward/orm/migrations/definitions.rb +176 -0
- data/lib/skyward/orm/migrations/diff.rb +213 -0
- data/lib/skyward/orm/migrations/directory.rb +48 -0
- data/lib/skyward/orm/migrations/discovery.rb +14 -0
- data/lib/skyward/orm/migrations/drop_column.rb +7 -0
- data/lib/skyward/orm/migrations/drop_constraint.rb +7 -0
- data/lib/skyward/orm/migrations/drop_index.rb +7 -0
- data/lib/skyward/orm/migrations/rename_column.rb +8 -0
- data/lib/skyward/orm/migrations/runner/edited.rb +7 -0
- data/lib/skyward/orm/migrations/runner/failed.rb +8 -0
- data/lib/skyward/orm/migrations/runner/irreversible.rb +7 -0
- data/lib/skyward/orm/migrations/runner/locked.rb +8 -0
- data/lib/skyward/orm/migrations/runner/migration.rb +11 -0
- data/lib/skyward/orm/migrations/runner/missing.rb +7 -0
- data/lib/skyward/orm/migrations/runner/raced.rb +7 -0
- data/lib/skyward/orm/migrations/runner.rb +227 -0
- data/lib/skyward/orm/migrations/script.rb +350 -0
- data/lib/skyward/orm/migrations/status.rb +93 -0
- data/lib/skyward/orm/migrations/summary.rb +110 -0
- data/lib/skyward/orm/migrations/versions.rb +19 -0
- data/lib/skyward/orm/migrations.rb +8 -0
- data/lib/skyward/orm/placeholders.rb +37 -0
- data/lib/skyward/orm/pool_timeout.rb +4 -0
- data/lib/skyward/orm/projection.rb +67 -0
- data/lib/skyward/orm/queries/clauses.rb +588 -0
- data/lib/skyward/orm/queries.rb +4 -0
- data/lib/skyward/orm/query.rb +26 -0
- data/lib/skyward/orm/record.rb +96 -0
- data/lib/skyward/orm/schema_mismatch.rb +4 -0
- data/lib/skyward/orm/statements.rb +97 -0
- data/lib/skyward/orm/tables/check.rb +8 -0
- data/lib/skyward/orm/tables/column.rb +10 -0
- data/lib/skyward/orm/tables/column_types.rb +74 -0
- data/lib/skyward/orm/tables/declarations.rb +172 -0
- data/lib/skyward/orm/tables/length.rb +8 -0
- data/lib/skyward/orm/tables/loaded.rb +21 -0
- data/lib/skyward/orm/tables/reference.rb +9 -0
- data/lib/skyward/orm/tables/rows.rb +52 -0
- data/lib/skyward/orm/tables/schema.rb +14 -0
- data/lib/skyward/orm/tables/sql.rb +7 -0
- data/lib/skyward/orm/tables/validation.rb +29 -0
- data/lib/skyward/orm/tables/values.rb +102 -0
- data/lib/skyward/orm/tables.rb +7 -0
- data/lib/skyward/orm/transactional.rb +18 -0
- data/lib/skyward/orm/version.rb +1 -1
- data/lib/skyward/orm/violation.rb +13 -0
- data/lib/skyward/orm/violation_error.rb +13 -0
- data/lib/skyward/orm.rb +72 -1
- data/sig/generated/skyward/orm/adapters/postgresql/connection.rbs +41 -0
- data/sig/generated/skyward/orm/adapters/postgresql.rbs +138 -0
- data/sig/generated/skyward/orm/adapters/sqlite/constraints.rbs +87 -0
- data/sig/generated/skyward/orm/adapters/sqlite.rbs +166 -0
- data/sig/generated/skyward/orm/adapters.rbs +15 -0
- data/sig/generated/skyward/orm/catalog/column.rbs +20 -0
- data/sig/generated/skyward/orm/catalog/constraint.rbs +22 -0
- data/sig/generated/skyward/orm/catalog/index.rbs +20 -0
- data/sig/generated/skyward/orm/catalog/table.rbs +20 -0
- data/sig/generated/skyward/orm/catalog.rbs +5 -0
- data/sig/generated/skyward/orm/cli/boot_file.rbs +21 -0
- data/sig/generated/skyward/orm/cli/migrate.rbs +15 -0
- data/sig/generated/skyward/orm/cli/migration.rbs +45 -0
- data/sig/generated/skyward/orm/cli/rollback.rbs +7 -0
- data/sig/generated/skyward/orm/cli/status.rbs +17 -0
- data/sig/generated/skyward/orm/cli.rbs +4 -0
- data/sig/generated/skyward/orm/commands.rbs +2 -0
- data/sig/generated/skyward/orm/connection/database/schema_check.rbs +31 -0
- data/sig/generated/skyward/orm/connection/database.rbs +226 -0
- data/sig/generated/skyward/orm/connection/pool.rbs +54 -0
- data/sig/generated/skyward/orm/connection/session.rbs +25 -0
- data/sig/generated/skyward/orm/connection.rbs +7 -0
- data/sig/generated/skyward/orm/members.rbs +9 -0
- data/sig/generated/skyward/orm/migration_error.rbs +4 -0
- data/sig/generated/skyward/orm/migrations/add_column.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/add_constraint.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/add_index.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/alter_table.rbs +22 -0
- data/sig/generated/skyward/orm/migrations/change_default.rbs +18 -0
- data/sig/generated/skyward/orm/migrations/change_nullable.rbs +16 -0
- data/sig/generated/skyward/orm/migrations/change_type.rbs +18 -0
- data/sig/generated/skyward/orm/migrations/create_table.rbs +16 -0
- data/sig/generated/skyward/orm/migrations/definitions.rbs +81 -0
- data/sig/generated/skyward/orm/migrations/diff.rbs +99 -0
- data/sig/generated/skyward/orm/migrations/directory.rbs +37 -0
- data/sig/generated/skyward/orm/migrations/discovery.rbs +9 -0
- data/sig/generated/skyward/orm/migrations/drop_column.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/drop_constraint.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/drop_index.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/rename_column.rbs +16 -0
- data/sig/generated/skyward/orm/migrations/runner/edited.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/runner/failed.rbs +16 -0
- data/sig/generated/skyward/orm/migrations/runner/irreversible.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/runner/locked.rbs +16 -0
- data/sig/generated/skyward/orm/migrations/runner/migration.rbs +22 -0
- data/sig/generated/skyward/orm/migrations/runner/missing.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/runner/raced.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/runner.rbs +73 -0
- data/sig/generated/skyward/orm/migrations/script.rbs +161 -0
- data/sig/generated/skyward/orm/migrations/status.rbs +49 -0
- data/sig/generated/skyward/orm/migrations/summary.rbs +50 -0
- data/sig/generated/skyward/orm/migrations/versions.rbs +11 -0
- data/sig/generated/skyward/orm/migrations.rbs +7 -0
- data/sig/generated/skyward/orm/placeholders.rbs +21 -0
- data/sig/generated/skyward/orm/pool_timeout.rbs +4 -0
- data/sig/generated/skyward/orm/projection.rbs +42 -0
- data/sig/generated/skyward/orm/queries/clauses.rbs +367 -0
- data/sig/generated/skyward/orm/queries.rbs +4 -0
- data/sig/generated/skyward/orm/query.rbs +20 -0
- data/sig/generated/skyward/orm/record.rbs +80 -0
- data/sig/generated/skyward/orm/schema_mismatch.rbs +4 -0
- data/sig/generated/skyward/orm/statements.rbs +53 -0
- data/sig/generated/skyward/orm/tables/check.rbs +16 -0
- data/sig/generated/skyward/orm/tables/column.rbs +20 -0
- data/sig/generated/skyward/orm/tables/column_types.rbs +39 -0
- data/sig/generated/skyward/orm/tables/declarations.rbs +87 -0
- data/sig/generated/skyward/orm/tables/length.rbs +16 -0
- data/sig/generated/skyward/orm/tables/loaded.rbs +14 -0
- data/sig/generated/skyward/orm/tables/reference.rbs +18 -0
- data/sig/generated/skyward/orm/tables/rows.rbs +24 -0
- data/sig/generated/skyward/orm/tables/schema.rbs +28 -0
- data/sig/generated/skyward/orm/tables/sql.rbs +14 -0
- data/sig/generated/skyward/orm/tables/validation.rbs +9 -0
- data/sig/generated/skyward/orm/tables/values.rbs +49 -0
- data/sig/generated/skyward/orm/tables.rbs +7 -0
- data/sig/generated/skyward/orm/transactional.rbs +11 -0
- data/sig/generated/skyward/orm/violation.rbs +22 -0
- data/sig/generated/skyward/orm/violation_error.rbs +10 -0
- data/sig/generated/skyward/orm.rbs +29 -0
- data/sig/manual/pg.rbs +31 -0
- data/sig/manual/skyward/orm/adapters/postgresql.rbs +3 -0
- data/sig/manual/skyward/orm/adapters/sqlite/constraints.rbs +3 -0
- data/sig/manual/skyward/orm/adapters/sqlite.rbs +3 -0
- data/sig/manual/skyward/orm/adapters.rbs +3 -0
- data/sig/manual/skyward/orm/cli/boot_file.rbs +3 -0
- data/sig/manual/skyward/orm/cli/migrate.rbs +3 -0
- data/sig/manual/skyward/orm/cli/migration.rbs +3 -0
- data/sig/manual/skyward/orm/cli/rollback.rbs +3 -0
- data/sig/manual/skyward/orm/cli/status.rbs +3 -0
- data/sig/manual/skyward/orm/connection/database/schema_check.rbs +3 -0
- data/sig/manual/skyward/orm/members.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/definitions.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/diff.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/directory.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/discovery.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/runner.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/script.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/status.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/summary.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/versions.rbs +3 -0
- data/sig/manual/skyward/orm/placeholders.rbs +3 -0
- data/sig/manual/skyward/orm/statements.rbs +3 -0
- data/sig/manual/skyward/orm/tables/loaded.rbs +3 -0
- data/sig/manual/skyward/orm/tables/rows.rbs +3 -0
- data/sig/manual/skyward/orm/tables/validation.rbs +3 -0
- data/sig/manual/skyward/orm/tables/values.rbs +3 -0
- data/sig/manual/skyward/orm.rbs +45 -0
- data/sig/manual/sqlite3.rbs +23 -0
- metadata +188 -3
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
class Skyward::ORM::Record
|
|
4
|
+
extend Skyward::ORM::Tables::Declarations
|
|
5
|
+
|
|
6
|
+
# Each table class defines these for its columns, from Skyward::ORM::Tables::Rows.source.
|
|
7
|
+
# @rbs!
|
|
8
|
+
# private def initialize_columns: (Hash[Symbol, untyped] columns) -> void
|
|
9
|
+
# def to_h: () -> Hash[Symbol, untyped]
|
|
10
|
+
# def ==: (untyped other) -> bool
|
|
11
|
+
# def eql?: (untyped other) -> bool
|
|
12
|
+
# def hash: () -> Integer
|
|
13
|
+
|
|
14
|
+
# @dynamic initialize_columns, to_h, ==, eql?, hash
|
|
15
|
+
class_eval(Skyward::ORM::Tables::Rows.source([]), __FILE__, __LINE__)
|
|
16
|
+
|
|
17
|
+
# @rbs return: Skyward::ORM::Query[instance]
|
|
18
|
+
def self.all = Skyward::ORM::Query.new(self, Skyward::ORM::Connection::SESSION, scope: :all)
|
|
19
|
+
|
|
20
|
+
# @rbs table: singleton(Skyward::ORM::Record)
|
|
21
|
+
# @rbs **on: Symbol
|
|
22
|
+
# @rbs return: Skyward::ORM::Query[instance]
|
|
23
|
+
def self.join(table, **on) = all.join(table, **on)
|
|
24
|
+
|
|
25
|
+
# @rbs table: singleton(Skyward::ORM::Record)
|
|
26
|
+
# @rbs **on: Symbol
|
|
27
|
+
# @rbs return: Skyward::ORM::Query[instance]
|
|
28
|
+
def self.left_join(table, **on) = all.left_join(table, **on)
|
|
29
|
+
|
|
30
|
+
# @rbs sql: String?
|
|
31
|
+
# @rbs *values: untyped
|
|
32
|
+
# @rbs **conditions: untyped
|
|
33
|
+
# @rbs return: Skyward::ORM::Query[instance]
|
|
34
|
+
def self.where(sql = nil, *values, **conditions) = all.where(sql, *values, **conditions)
|
|
35
|
+
|
|
36
|
+
# @rbs sql: String?
|
|
37
|
+
# @rbs *values: untyped
|
|
38
|
+
# @rbs **conditions: untyped
|
|
39
|
+
# @rbs return: Skyward::ORM::Query[instance]
|
|
40
|
+
def self.exclude(sql = nil, *values, **conditions) = all.exclude(sql, *values, **conditions)
|
|
41
|
+
|
|
42
|
+
# @rbs *columns: Symbol
|
|
43
|
+
# @rbs **directions: Skyward::ORM::Queries::Clauses::direction
|
|
44
|
+
# @rbs return: Skyward::ORM::Query[instance]
|
|
45
|
+
def self.order(*columns, **directions) = all.order(*columns, **directions)
|
|
46
|
+
|
|
47
|
+
# @rbs **conditions: untyped
|
|
48
|
+
# @rbs return: instance?
|
|
49
|
+
def self.find_by(**conditions) = all.find_by(**conditions)
|
|
50
|
+
|
|
51
|
+
# @rbs [S] (Skyward::ORM::_Row[S] row, **String expressions) -> Skyward::ORM::Projection[S]
|
|
52
|
+
def self.into(row, **expressions)
|
|
53
|
+
Skyward::ORM::Query.new(self, Skyward::ORM::Connection::SESSION).into(row, **expressions)
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
# @rbs **values: untyped
|
|
57
|
+
# @rbs return: Integer | Skyward::ORM::Violation
|
|
58
|
+
def self.insert(**values)
|
|
59
|
+
database = Skyward::ORM::Connection::SESSION.database
|
|
60
|
+
sql, binds = Skyward::ORM::Statements.insert(database.adapter, database.column_types, self, values)
|
|
61
|
+
database.write(self, sql, binds)
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
# @rbs **values: untyped
|
|
65
|
+
# @rbs return: Integer
|
|
66
|
+
def self.insert!(**values)
|
|
67
|
+
written = insert(**values)
|
|
68
|
+
case written
|
|
69
|
+
when Skyward::ORM::Violation then raise Skyward::ORM::ViolationError, written
|
|
70
|
+
else written
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# @rbs return: Array[Symbol]
|
|
75
|
+
def self.members = schema.columns
|
|
76
|
+
|
|
77
|
+
# Ruby warns whenever initialize is removed, so a table class redefines
|
|
78
|
+
# initialize_columns instead, each time it gains a column.
|
|
79
|
+
# @rbs **columns: untyped
|
|
80
|
+
# @rbs return: void
|
|
81
|
+
def initialize(**columns)
|
|
82
|
+
initialize_columns(columns)
|
|
83
|
+
freeze
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# @rbs **changes: untyped
|
|
87
|
+
# @rbs return: self
|
|
88
|
+
def with(**changes) = self.class.new(**to_h, **changes) #: self
|
|
89
|
+
|
|
90
|
+
# @rbs keys: Array[Symbol]?
|
|
91
|
+
# @rbs return: Hash[Symbol, untyped]
|
|
92
|
+
def deconstruct_keys(keys) = keys ? to_h.slice(*keys) : to_h
|
|
93
|
+
|
|
94
|
+
# @rbs return: String
|
|
95
|
+
def inspect = "#<#{self.class} #{to_h.map { |column, value| "#{column}=#{value.inspect}" }.join(", ")}>"
|
|
96
|
+
end
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Skyward::ORM::Statements
|
|
4
|
+
extend self
|
|
5
|
+
|
|
6
|
+
# @rbs adapter: Skyward::ORM::_Adapter
|
|
7
|
+
# @rbs column_types: Skyward::ORM::Tables::ColumnTypes
|
|
8
|
+
# @rbs table: singleton(Skyward::ORM::Record)
|
|
9
|
+
# @rbs values: Hash[Symbol, untyped]
|
|
10
|
+
# @rbs return: [String, Array[untyped]]
|
|
11
|
+
def insert(adapter, column_types, table, values)
|
|
12
|
+
require_values(column_types, table, values)
|
|
13
|
+
require_present(table, column_types.columns(table), values.keys)
|
|
14
|
+
into = "INSERT INTO #{quote(table.table_name)}"
|
|
15
|
+
return ["#{into} DEFAULT VALUES", []] if values.empty?
|
|
16
|
+
|
|
17
|
+
placeholders = Array.new(values.size) { |index| adapter.placeholder(index + 1) }
|
|
18
|
+
[
|
|
19
|
+
"#{into} (#{values.keys.map { |column| quote(column) }.join(", ")}) VALUES (#{placeholders.join(", ")})",
|
|
20
|
+
values.values.map { |value| adapter.encode(value) }
|
|
21
|
+
]
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
# @rbs table: singleton(Skyward::ORM::Record)
|
|
25
|
+
# @rbs columns: Array[Symbol]
|
|
26
|
+
# @rbs return: void
|
|
27
|
+
def require_columns(table, columns)
|
|
28
|
+
known = table.schema.columns
|
|
29
|
+
unknown = (columns - known).first #: Symbol?
|
|
30
|
+
return unless unknown
|
|
31
|
+
|
|
32
|
+
suggestion = DidYouMean::SpellChecker.new(dictionary: known).correct(unknown).first
|
|
33
|
+
raise ArgumentError, "#{table} has no column #{unknown}.#{" Did you mean #{suggestion}?" if suggestion}"
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# @rbs column_types: Skyward::ORM::Tables::ColumnTypes
|
|
37
|
+
# @rbs table: singleton(Skyward::ORM::Record)
|
|
38
|
+
# @rbs conditions: Hash[Symbol, untyped]
|
|
39
|
+
# @rbs return: void
|
|
40
|
+
def require_conditions(column_types, table, conditions)
|
|
41
|
+
refuse(column_types, table, conditions) do |column, value|
|
|
42
|
+
Skyward::ORM::Tables::Values.mismatch(table, column, value)
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# @rbs column_types: Skyward::ORM::Tables::ColumnTypes
|
|
47
|
+
# @rbs table: singleton(Skyward::ORM::Record)
|
|
48
|
+
# @rbs values: Hash[Symbol, untyped]
|
|
49
|
+
# @rbs return: void
|
|
50
|
+
def require_values(column_types, table, values)
|
|
51
|
+
refuse(column_types, table, values) do |column, value|
|
|
52
|
+
Skyward::ORM::Tables::Values.write_mismatch(table, column, value)
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
# @rbs columns: Array[Symbol]
|
|
57
|
+
# @rbs return: String
|
|
58
|
+
def returning(columns) = "RETURNING #{columns.map { |column| quote(column) }.join(", ")}"
|
|
59
|
+
|
|
60
|
+
# Quoted, so a column named order or user is still a column.
|
|
61
|
+
# @rbs name: Symbol
|
|
62
|
+
# @rbs return: String
|
|
63
|
+
def quote(name) = %("#{name.name.gsub('"', '""')}")
|
|
64
|
+
|
|
65
|
+
private
|
|
66
|
+
|
|
67
|
+
# @rbs column_types: Skyward::ORM::Tables::ColumnTypes
|
|
68
|
+
# @rbs table: singleton(Skyward::ORM::Record)
|
|
69
|
+
# @rbs values: Hash[Symbol, untyped]
|
|
70
|
+
# @rbs &: (Skyward::ORM::Tables::Column column, untyped value) -> String?
|
|
71
|
+
# @rbs return: void
|
|
72
|
+
def refuse(column_types, table, values)
|
|
73
|
+
require_columns(table, values.keys)
|
|
74
|
+
columns = column_types.columns(table).to_h { |column| [column.name, column] }
|
|
75
|
+
refused = values.filter_map { |name, value| yield(columns.fetch(name), value) }.first
|
|
76
|
+
raise ArgumentError, refused if refused
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# An untyped column's nullability is unknown, so it's left to the database,
|
|
80
|
+
# like a column the class doesn't declare.
|
|
81
|
+
# @rbs table: singleton(Skyward::ORM::Record)
|
|
82
|
+
# @rbs columns: Array[Skyward::ORM::Tables::Column]
|
|
83
|
+
# @rbs given: Array[Symbol]
|
|
84
|
+
# @rbs return: void
|
|
85
|
+
def require_present(table, columns, given)
|
|
86
|
+
schema = table.schema
|
|
87
|
+
required = columns.reject do |column|
|
|
88
|
+
column.nullable || column.type == :untyped || column.name == schema.primary_key ||
|
|
89
|
+
schema.defaults.key?(column.name)
|
|
90
|
+
end
|
|
91
|
+
missing = required.map(&:name) - given
|
|
92
|
+
return if missing.empty?
|
|
93
|
+
|
|
94
|
+
raise ArgumentError,
|
|
95
|
+
"#{table}.insert needs #{missing.join(", ")}: a column that can't be NULL and has no default needs a value"
|
|
96
|
+
end
|
|
97
|
+
end
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
class Skyward::ORM::Tables::ColumnTypes
|
|
4
|
+
# @rbs @reader: Skyward::Core::Types::Reader
|
|
5
|
+
# @rbs @resolved: Hash[Class, Array[Skyward::ORM::Tables::Column]]
|
|
6
|
+
|
|
7
|
+
UNTYPED = Skyward::Core::Types::Scalar.new(name: :untyped) #: Skyward::Core::Types::Scalar
|
|
8
|
+
|
|
9
|
+
COLUMN_TYPES = "A column is Integer, Float, String, bool, Date, Time or a union of symbols, " \
|
|
10
|
+
"any of them nullable, or untyped." #: String
|
|
11
|
+
|
|
12
|
+
# @rbs reader: Skyward::Core::Types::Reader
|
|
13
|
+
# @rbs return: void
|
|
14
|
+
def initialize(reader)
|
|
15
|
+
@reader = reader
|
|
16
|
+
@resolved = {}
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
# A class's types are resolved once for the signatures the reader loaded, so
|
|
20
|
+
# no query reads RBS.
|
|
21
|
+
# @rbs klass: Class
|
|
22
|
+
# @rbs return: Array[Skyward::ORM::Tables::Column]
|
|
23
|
+
def columns(klass) = @resolved[klass] ||= resolve(klass)
|
|
24
|
+
|
|
25
|
+
private
|
|
26
|
+
|
|
27
|
+
# @rbs klass: Class
|
|
28
|
+
# @rbs return: Array[Skyward::ORM::Tables::Column]
|
|
29
|
+
def resolve(klass)
|
|
30
|
+
type_name = @reader.type_name(klass)
|
|
31
|
+
Skyward::ORM::Members.of(klass).map do |name|
|
|
32
|
+
returned = @reader.method_type(type_name, name)&.type&.return_type if type_name
|
|
33
|
+
written = returned.to_s.gsub(/(?<!\w)::/, "")
|
|
34
|
+
column = returned ? read(name, returned, written) : column(name, UNTYPED, written)
|
|
35
|
+
case column
|
|
36
|
+
when String then raise Skyward::Core::BootError, "#{klass}##{name} #{column}"
|
|
37
|
+
else column
|
|
38
|
+
end
|
|
39
|
+
end.freeze
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# @rbs name: Symbol
|
|
43
|
+
# @rbs returned: RBS::Types::t
|
|
44
|
+
# @rbs written: String
|
|
45
|
+
# @rbs return: Skyward::ORM::Tables::Column | String
|
|
46
|
+
def read(name, returned, written)
|
|
47
|
+
column(name, @reader.read(returned), written)
|
|
48
|
+
# The reader raises for a type it can't read at all, such as one that refers
|
|
49
|
+
# to itself, and the column should still be named.
|
|
50
|
+
rescue Skyward::Core::BootError => e
|
|
51
|
+
"is #{written}. #{e.message}"
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
# @rbs name: Symbol
|
|
55
|
+
# @rbs read: Skyward::Core::Types::result
|
|
56
|
+
# @rbs written: String
|
|
57
|
+
# @rbs return: Skyward::ORM::Tables::Column | String
|
|
58
|
+
def column(name, read, written)
|
|
59
|
+
nullable = read.is_a?(Skyward::Core::Types::Nullable)
|
|
60
|
+
carried = read.is_a?(Skyward::Core::Types::Nullable) ? read.type : read
|
|
61
|
+
case carried
|
|
62
|
+
when Skyward::Core::Types::Scalar
|
|
63
|
+
Skyward::ORM::Tables::Column.new(name:, type: carried.name, nullable:, symbols: [])
|
|
64
|
+
when Skyward::Core::Types::Enum
|
|
65
|
+
Skyward::ORM::Tables::Column.new(name:, type: :enum, nullable:, symbols: carried.symbols)
|
|
66
|
+
when Skyward::Core::Types::Unreadable
|
|
67
|
+
"can't be read: Skyward ORM doesn't read #{carried.type}#{", at #{carried.at}" if carried.at}. #{COLUMN_TYPES}"
|
|
68
|
+
when Skyward::Core::Types::Record, Skyward::Core::Types::Named, Skyward::Core::Types::ArrayOf,
|
|
69
|
+
Skyward::Core::Types::HashOf
|
|
70
|
+
"is #{written}, which isn't a column type yet. #{COLUMN_TYPES}"
|
|
71
|
+
else "is #{written}, which isn't a column type. #{COLUMN_TYPES}"
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# @rbs module-self Class
|
|
4
|
+
module Skyward::ORM::Tables::Declarations
|
|
5
|
+
EMPTY = Skyward::ORM::Tables::Schema.new(
|
|
6
|
+
table: nil,
|
|
7
|
+
primary_key: :id,
|
|
8
|
+
columns: [],
|
|
9
|
+
references: [],
|
|
10
|
+
defaults: {},
|
|
11
|
+
checks: [],
|
|
12
|
+
uniques: [],
|
|
13
|
+
indexes: []
|
|
14
|
+
) #: Skyward::ORM::Tables::Schema
|
|
15
|
+
|
|
16
|
+
ON_DELETE = %i[cascade restrict set_null set_default no_action].freeze #: Array[Skyward::ORM::Tables::on_delete]
|
|
17
|
+
|
|
18
|
+
# @rbs @schema: Skyward::ORM::Tables::Schema?
|
|
19
|
+
|
|
20
|
+
# @rbs return: Skyward::ORM::Tables::Schema
|
|
21
|
+
def schema = @schema || EMPTY
|
|
22
|
+
|
|
23
|
+
# @rbs return: Symbol
|
|
24
|
+
def table_name
|
|
25
|
+
schema.table || raise(Skyward::Core::BootError, "#{self} has no table. Add `table :name` to its body.")
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
# Every attr_reader is a column, so each one compiles the row's methods again.
|
|
29
|
+
# @rbs *names: interned
|
|
30
|
+
# @rbs return: Array[Symbol]
|
|
31
|
+
def attr_reader(*names)
|
|
32
|
+
# Steep doesn't look up super in the Class this module extends.
|
|
33
|
+
readers = super # steep:ignore UnexpectedSuper
|
|
34
|
+
columns = [*schema.columns, *readers]
|
|
35
|
+
repeated = columns.find { |column| columns.count(column) > 1 }
|
|
36
|
+
raise ArgumentError, "#{self} already has a column #{repeated}" if repeated
|
|
37
|
+
|
|
38
|
+
declare(columns: columns.freeze)
|
|
39
|
+
# Ruby warns when a method is redefined, so the old ones are removed first.
|
|
40
|
+
(Skyward::ORM::Tables::Rows::METHODS & [*instance_methods(false), *private_instance_methods(false)])
|
|
41
|
+
.each { |method| remove_method(method) }
|
|
42
|
+
class_eval(Skyward::ORM::Tables::Rows.source(columns), __FILE__, __LINE__)
|
|
43
|
+
readers
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# @rbs name: Symbol
|
|
47
|
+
# @rbs return: void
|
|
48
|
+
def table(name)
|
|
49
|
+
refuse(:table, [name], "the table's name must be a Symbol, such as :todos") unless symbol?(name)
|
|
50
|
+
declare(table: name)
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
# @rbs column: Symbol
|
|
54
|
+
# @rbs return: void
|
|
55
|
+
def primary_key(column)
|
|
56
|
+
problem = unnamed([column])
|
|
57
|
+
refuse(:primary_key, [column], problem) if problem
|
|
58
|
+
declare(primary_key: column)
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# @rbs column: Symbol
|
|
62
|
+
# @rbs table: singleton(Skyward::ORM::Record)
|
|
63
|
+
# @rbs on_delete: Skyward::ORM::Tables::on_delete?
|
|
64
|
+
# @rbs return: void
|
|
65
|
+
def references(column, table, on_delete: nil)
|
|
66
|
+
problem = unnamed([column]) || unreferenceable(table, on_delete)
|
|
67
|
+
refuse(:references, [column], problem) if problem
|
|
68
|
+
reference = Skyward::ORM::Tables::Reference.new(column:, table:, on_delete:)
|
|
69
|
+
declare(references: [*schema.references, reference].freeze)
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# @rbs **values: untyped
|
|
73
|
+
# @rbs return: void
|
|
74
|
+
def default(**values)
|
|
75
|
+
declare(defaults: schema.defaults.merge(values).freeze)
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
# @rbs *columns: Symbol
|
|
79
|
+
# @rbs return: void
|
|
80
|
+
def unique(*columns)
|
|
81
|
+
problem = unnamed(columns)
|
|
82
|
+
refuse(:unique, columns, problem) if problem
|
|
83
|
+
declare(uniques: [*schema.uniques, columns.freeze].freeze)
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# @rbs column: Symbol
|
|
87
|
+
# @rbs sql: Skyward::ORM::Tables::SQL?
|
|
88
|
+
# @rbs length: Range[Integer?]?
|
|
89
|
+
# @rbs return: void
|
|
90
|
+
def check(column, sql = nil, length: nil)
|
|
91
|
+
rule = unnamed([column]) || check_rule(sql, length)
|
|
92
|
+
case rule
|
|
93
|
+
when String then refuse(:check, [column], rule)
|
|
94
|
+
else declare(checks: [*schema.checks, Skyward::ORM::Tables::Check.new(column:, rule:)].freeze)
|
|
95
|
+
end
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
# @rbs *columns: Symbol
|
|
99
|
+
# @rbs return: void
|
|
100
|
+
def index(*columns)
|
|
101
|
+
problem = unnamed(columns)
|
|
102
|
+
refuse(:index, columns, problem) if problem
|
|
103
|
+
declare(indexes: [*schema.indexes, columns.freeze].freeze)
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
private
|
|
107
|
+
|
|
108
|
+
# @rbs **changes: untyped
|
|
109
|
+
# @rbs return: void
|
|
110
|
+
def declare(**changes)
|
|
111
|
+
@schema = schema.with(**changes)
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
# @rbs declaration: Symbol
|
|
115
|
+
# @rbs arguments: Array[untyped]
|
|
116
|
+
# @rbs problem: String
|
|
117
|
+
# @rbs return: bot
|
|
118
|
+
def refuse(declaration, arguments, problem)
|
|
119
|
+
raise ArgumentError, "#{self} #{"#{declaration} #{arguments.map(&:inspect).join(", ")}".rstrip}: #{problem}"
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
# @rbs value: untyped
|
|
123
|
+
# @rbs return: bool
|
|
124
|
+
def symbol?(value) = value.is_a?(Symbol)
|
|
125
|
+
|
|
126
|
+
# @rbs columns: Array[untyped]
|
|
127
|
+
# @rbs return: String?
|
|
128
|
+
def unnamed(columns)
|
|
129
|
+
if columns.empty? then "it needs at least one column"
|
|
130
|
+
elsif !columns.all?(Symbol) then "a column's name must be a Symbol, such as :title"
|
|
131
|
+
end
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
# @rbs table: untyped
|
|
135
|
+
# @rbs on_delete: untyped
|
|
136
|
+
# @rbs return: String?
|
|
137
|
+
def unreferenceable(table, on_delete)
|
|
138
|
+
if !table.is_a?(Class) || !(table < Skyward::ORM::Record)
|
|
139
|
+
"it references #{table.inspect}, which isn't a table class"
|
|
140
|
+
elsif !on_delete.nil? && !ON_DELETE.include?(on_delete)
|
|
141
|
+
"on_delete: is #{on_delete.inspect}, but it can only be :#{ON_DELETE.join(", :")} or nil"
|
|
142
|
+
end
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
# @rbs sql: untyped
|
|
146
|
+
# @rbs length: untyped
|
|
147
|
+
# @rbs return: Skyward::ORM::Tables::SQL | Skyward::ORM::Tables::Length | String
|
|
148
|
+
def check_rule(sql, length)
|
|
149
|
+
if sql && length then "it takes Skyward.sql(\"...\") or length:, not both"
|
|
150
|
+
elsif sql.is_a?(Skyward::ORM::Tables::SQL) then sql
|
|
151
|
+
elsif sql.is_a?(String) then "write the SQL as Skyward.sql(#{sql.inspect}), not a plain String"
|
|
152
|
+
elsif sql then "it takes Skyward.sql(\"...\") or length:, not #{sql.inspect}"
|
|
153
|
+
elsif length.nil? then "it needs Skyward.sql(\"...\") or length:"
|
|
154
|
+
else length_rule(length)
|
|
155
|
+
end
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# @rbs range: untyped
|
|
159
|
+
# @rbs return: Skyward::ORM::Tables::Length | String
|
|
160
|
+
def length_rule(range)
|
|
161
|
+
unless range.is_a?(Range) && [range.begin, range.end].compact.all?(Integer)
|
|
162
|
+
return "length: must be a Range of Integers, such as 1..200, not #{range.inspect}"
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
min = range.begin
|
|
166
|
+
max = range.exclude_end? && range.end ? range.end - 1 : range.end
|
|
167
|
+
if min.nil? && max.nil? then "length: #{range.inspect} needs a bound, such as 1..200"
|
|
168
|
+
elsif min && max && min > max then "length: #{range.inspect} is empty"
|
|
169
|
+
else Skyward::ORM::Tables::Length.new(min:, max:)
|
|
170
|
+
end
|
|
171
|
+
end
|
|
172
|
+
end
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Skyward::ORM::Tables::Loaded
|
|
4
|
+
extend self
|
|
5
|
+
|
|
6
|
+
# A subclass with no table is a shared base class or a row class, not a table.
|
|
7
|
+
# @rbs root: singleton(Skyward::ORM::Record)
|
|
8
|
+
# @rbs return: Array[singleton(Skyward::ORM::Record)]
|
|
9
|
+
def table_classes(root)
|
|
10
|
+
descendants(root).select { |klass| klass.schema.table }.sort_by(&:to_s)
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
private
|
|
14
|
+
|
|
15
|
+
# @rbs klass: singleton(Skyward::ORM::Record)
|
|
16
|
+
# @rbs return: Array[singleton(Skyward::ORM::Record)]
|
|
17
|
+
def descendants(klass)
|
|
18
|
+
subclasses = klass.subclasses #: Array[singleton(Skyward::ORM::Record)]
|
|
19
|
+
subclasses.flat_map { |subclass| [subclass, *descendants(subclass)] }
|
|
20
|
+
end
|
|
21
|
+
end
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Skyward::ORM::Tables::Rows
|
|
4
|
+
extend self
|
|
5
|
+
|
|
6
|
+
METHODS = %i[initialize_columns to_h == eql? hash].freeze #: Array[Symbol]
|
|
7
|
+
|
|
8
|
+
# Each row sets, compares and hashes its columns' instance variables
|
|
9
|
+
# directly, rather than reflecting on them for every row.
|
|
10
|
+
# @rbs columns: Array[Symbol]
|
|
11
|
+
# @rbs return: String
|
|
12
|
+
def source(columns)
|
|
13
|
+
mismatch = "raise ArgumentError, Skyward::ORM::Tables::Rows.mismatch(self.class, #{columns.inspect}, columns.keys)"
|
|
14
|
+
<<~RUBY
|
|
15
|
+
private def initialize_columns(columns)
|
|
16
|
+
#{columns.map { |column| "@#{column} = columns.fetch(#{column.inspect}) { #{mismatch} }" }.join("\n")}
|
|
17
|
+
#{mismatch} unless columns.size == #{columns.size}
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
def to_h = { #{columns.map { |column| "#{column}: @#{column}" }.join(", ")} }
|
|
21
|
+
|
|
22
|
+
def ==(other) = #{compare(columns, "==")}
|
|
23
|
+
|
|
24
|
+
def eql?(other) = #{compare(columns, "eql?")}
|
|
25
|
+
|
|
26
|
+
def hash = [#{["self.class", *columns.map { |column| "@#{column}" }].join(", ")}].hash
|
|
27
|
+
RUBY
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
# @rbs klass: Class
|
|
31
|
+
# @rbs columns: Array[Symbol]
|
|
32
|
+
# @rbs given: Array[Symbol]
|
|
33
|
+
# @rbs return: String
|
|
34
|
+
def mismatch(klass, columns, given)
|
|
35
|
+
missing = columns - given
|
|
36
|
+
unknown = given - columns
|
|
37
|
+
problems = [
|
|
38
|
+
("is missing #{missing.join(", ")}" unless missing.empty?),
|
|
39
|
+
("has no column #{unknown.join(", ")}" unless unknown.empty?)
|
|
40
|
+
]
|
|
41
|
+
"#{klass} #{problems.compact.join(", and ")}"
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
private
|
|
45
|
+
|
|
46
|
+
# @rbs columns: Array[Symbol]
|
|
47
|
+
# @rbs method: String
|
|
48
|
+
# @rbs return: String
|
|
49
|
+
def compare(columns, method)
|
|
50
|
+
["other.instance_of?(self.class)", *columns.map { |column| "@#{column}.#{method}(other.#{column})" }].join(" && ")
|
|
51
|
+
end
|
|
52
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Skyward::ORM::Tables
|
|
4
|
+
Schema = Data.define(
|
|
5
|
+
:table, #: Symbol?
|
|
6
|
+
:primary_key, #: Symbol
|
|
7
|
+
:columns, #: Array[Symbol]
|
|
8
|
+
:references, #: Array[Reference]
|
|
9
|
+
:defaults, #: Hash[Symbol, untyped]
|
|
10
|
+
:checks, #: Array[Check]
|
|
11
|
+
:uniques, #: Array[Array[Symbol]]
|
|
12
|
+
:indexes #: Array[Array[Symbol]]
|
|
13
|
+
)
|
|
14
|
+
end
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Skyward::ORM::Tables::Validation
|
|
4
|
+
extend self
|
|
5
|
+
|
|
6
|
+
# A declaration can come before the attr_reader that defines its column, so
|
|
7
|
+
# the columns it names are checked once the class has loaded.
|
|
8
|
+
# @rbs klass: singleton(Skyward::ORM::Record)
|
|
9
|
+
# @rbs return: void
|
|
10
|
+
def validate(klass)
|
|
11
|
+
schema = klass.schema
|
|
12
|
+
named = [
|
|
13
|
+
[:primary_key, schema.primary_key],
|
|
14
|
+
*schema.references.map { |reference| [:references, reference.column] },
|
|
15
|
+
*schema.defaults.keys.map { |column| [:default, column] },
|
|
16
|
+
*schema.uniques.flatten.map { |column| [:unique, column] },
|
|
17
|
+
*schema.checks.map { |check| [:check, check.column] },
|
|
18
|
+
*schema.indexes.flatten.map { |column| [:index, column] }
|
|
19
|
+
] #: Array[[Symbol, Symbol]]
|
|
20
|
+
unknown = named.reject { |_, column| schema.columns.include?(column) }.uniq
|
|
21
|
+
return if unknown.empty?
|
|
22
|
+
|
|
23
|
+
problems = unknown.map do |declaration, column|
|
|
24
|
+
"#{klass} has no column #{column}, which its #{declaration} names. " \
|
|
25
|
+
"Add `attr_reader :#{column}`, or fix the name."
|
|
26
|
+
end
|
|
27
|
+
raise Skyward::Core::BootError, problems.join("\n")
|
|
28
|
+
end
|
|
29
|
+
end
|