Class: Tina4::ORM
Class Method Summary collapse
- .all(limit: nil, offset: nil, order_by: nil, include: nil) ⇒ Object
-
.auto_crud ⇒ Object
auto_crud flag — when set to true, the class registers itself with Tina4::AutoCrud which auto-generates REST endpoints from the model.
- .auto_crud=(val) ⇒ Object
-
.auto_map ⇒ Object
Auto-map flag — defaults to TRUE for cross-framework parity (Python’s ORM has auto_map=True by default).
- .auto_map=(val) ⇒ Object
-
.belongs_to(name, class_name: nil, foreign_key: nil) ⇒ Object
belongs_to :user, class_name: “User”, foreign_key: “user_id”.
-
.clear_rel_cache ⇒ Object
Clear the relationship cache on all loaded instances (class-level helper).
- .count(conditions = nil, params = []) ⇒ Object
- .create(attributes = {}) ⇒ Object
- .create_table ⇒ Object
- .db ⇒ Object
-
.db=(database) ⇒ Object
Per-model database binding.
-
.eager_load(instances, include_list) ⇒ Object
Eager load relationships for a collection of instances (prevents N+1).
-
.field_mapping ⇒ Object
Field mapping: { ‘db_column’ => ‘ruby_attribute’ }.
- .field_mapping=(map) ⇒ Object
- .find(id_or_filter = nil, filter = nil, **kwargs) ⇒ Object
-
.find_by_id(id) ⇒ Object
find_by_id is PUBLIC — cross-framework parity with Python’s MyModel.find_by_id(pk_value) and PHP’s User::find($id).
- .find_or_fail(id) ⇒ Object
- .from_hash(hash) ⇒ Object
-
.get_db ⇒ Object
Return the database connection used by this model.
-
.get_db_column(property) ⇒ Object
Map a Ruby property name to its database column name using field_mapping.
-
.has_many(name, class_name: nil, foreign_key: nil) ⇒ Object
has_many :posts, class_name: “Post”, foreign_key: “user_id”.
-
.has_one(name, class_name: nil, foreign_key: nil) ⇒ Object
has_one :profile, class_name: “Profile”, foreign_key: “user_id”.
-
.inherited(subclass) ⇒ Object
When a new model class is defined, resolve any deferred ForeignKeyField wiring that targets it.
-
.model_subclasses ⇒ Object
Every Tina4::ORM subclass that has been loaded, in definition order.
-
.query ⇒ Tina4::QueryBuilder
Create a fluent QueryBuilder pre-configured for this model’s table and database.
-
.relationship_definitions ⇒ Object
Relationship definitions.
- .scope(name, filter_sql, params = []) ⇒ Object
- .select(sql, params = [], limit: nil, offset: nil, include: nil) ⇒ Object
- .select_one(sql, params = [], include: nil) ⇒ Object
-
.soft_delete ⇒ Object
Soft delete configuration.
- .soft_delete=(val) ⇒ Object
- .soft_delete_field ⇒ Object
- .soft_delete_field=(val) ⇒ Object
- .where(conditions, params = [], include: nil) ⇒ Object
- .with_trashed(conditions = "1=1", params = [], limit: 20, offset: 0) ⇒ Object
Instance Method Summary collapse
- #delete ⇒ Object
- #errors ⇒ Object
- #force_delete ⇒ Object
-
#initialize(attributes = {}) ⇒ ORM
constructor
A new instance of ORM.
-
#load(arg = nil, params = nil) ⇒ Object
load — populate this instance from the database.
- #persisted? ⇒ Boolean
- #restore ⇒ Object
- #save ⇒ Object
- #select(*fields) ⇒ Object
- #to_array ⇒ Object (also: #to_list)
-
#to_h(include: nil, case: nil) ⇒ Object
(also: #to_hash, #to_dict, #to_object)
Convert to hash using Ruby attribute names.
- #to_json(include: nil, **_args) ⇒ Object
- #to_s ⇒ Object
- #validate ⇒ Object
Methods included from FieldTypes
Constructor Details
#initialize(attributes = {}) ⇒ ORM
Returns a new instance of ORM.
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 |
# File 'lib/tina4/orm.rb', line 516 def initialize(attributes = {}) @persisted = false @errors = [] @relationship_cache = {} attributes.each do |key, value| setter = "#{key}=" __send__(setter, value) if respond_to?(setter) end # Set defaults. # v3.13.11 (issue #50.1): when the default is a Proc/lambda # (``default: -> { Time.now }``), call it per-instance so # per-row timestamps actually differ. Class objects are # excluded — ``default: Integer`` is almost never intended # to mean ``Integer.new`` (and Integer has no zero-arg # constructor anyway). self.class.field_definitions.each do |name, opts| if __send__(name).nil? && opts[:default] d = opts[:default] d = d.call if d.respond_to?(:call) && !d.is_a?(Class) __send__("#{name}=", d) end end end |
Class Method Details
.all(limit: nil, offset: nil, order_by: nil, include: nil) ⇒ Object
275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/tina4/orm.rb', line 275 def all(limit: nil, offset: nil, order_by: nil, include: nil) sql = "SELECT * FROM #{table_name}" if soft_delete sql += " WHERE #{soft_delete_field} IS NULL OR #{soft_delete_field} = 0" end sql += " ORDER BY #{order_by}" if order_by results = db.fetch(sql, [], limit: limit, offset: offset) instances = results.map { |row| from_hash(row) } eager_load(instances, include) if include instances end |
.auto_crud ⇒ Object
auto_crud flag — when set to true, the class registers itself with Tina4::AutoCrud which auto-generates REST endpoints from the model. Defaults to false. Cross-framework parity with Python’s autoCrud.
96 97 98 |
# File 'lib/tina4/orm.rb', line 96 def auto_crud defined?(@auto_crud) && !@auto_crud.nil? ? @auto_crud : false end |
.auto_crud=(val) ⇒ Object
100 101 102 103 104 105 |
# File 'lib/tina4/orm.rb', line 100 def auto_crud=(val) @auto_crud = val if val && defined?(::Tina4::AutoCrud) ::Tina4::AutoCrud.models << self unless ::Tina4::AutoCrud.models.include?(self) end end |
.auto_map ⇒ Object
Auto-map flag — defaults to TRUE for cross-framework parity (Python’s ORM has auto_map=True by default). The instance variable is treated as “unset” when nil; only an explicit ‘false` disables it.
85 86 87 |
# File 'lib/tina4/orm.rb', line 85 def auto_map defined?(@auto_map) && !@auto_map.nil? ? @auto_map : true end |
.auto_map=(val) ⇒ Object
89 90 91 |
# File 'lib/tina4/orm.rb', line 89 def auto_map=(val) @auto_map = val end |
.belongs_to(name, class_name: nil, foreign_key: nil) ⇒ Object
belongs_to :user, class_name: “User”, foreign_key: “user_id”
139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/tina4/orm.rb', line 139 def belongs_to(name, class_name: nil, foreign_key: nil) relationship_definitions[name] = { type: :belongs_to, class_name: class_name || name.to_s.split("_").map(&:capitalize).join, foreign_key: foreign_key || "#{name}_id" } define_method(name) do load_belongs_to(name) end end |
.clear_rel_cache ⇒ Object
Clear the relationship cache on all loaded instances (class-level helper). Useful after bulk operations when you want to force relationship re-loads.
457 458 459 460 |
# File 'lib/tina4/orm.rb', line 457 def clear_rel_cache # -> nil @_rel_cache = {} nil end |
.count(conditions = nil, params = []) ⇒ Object
299 300 301 302 303 304 305 306 307 308 309 |
# File 'lib/tina4/orm.rb', line 299 def count(conditions = nil, params = []) sql = "SELECT COUNT(*) as cnt FROM #{table_name}" where_parts = [] if soft_delete where_parts << "(#{soft_delete_field} IS NULL OR #{soft_delete_field} = 0)" end where_parts << "(#{conditions})" if conditions sql += " WHERE #{where_parts.join(' AND ')}" unless where_parts.empty? result = db.fetch_one(sql, params) result[:cnt].to_i end |
.create(attributes = {}) ⇒ Object
311 312 313 314 315 |
# File 'lib/tina4/orm.rb', line 311 def create(attributes = {}) instance = new(attributes) instance.save instance end |
.create_table ⇒ Object
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 |
# File 'lib/tina4/orm.rb', line 329 def create_table return true if db.table_exists?(table_name) # v3.13.16: engine-aware DDL. Ruby used to emit SQLite-only DDL on # every driver — INTEGER for booleans, DATETIME for datetimes, and a # raw AUTOINCREMENT keyword — then ignore db.execute()'s return value # and report success. On PostgreSQL the CREATE blew up # ("syntax error at or near AUTOINCREMENT"), db.execute() swallowed it # into get_error() and returned false, yet create_table still returned # true with no table created — a silent, misleading pass. # # The fix mirrors the Python reference (tina4_python.orm.model): # • get_database_type() now exists on Database (it didn't before, so # the v3.13.11 BooleanField check never actually fired on Ruby). # • BooleanField → native BOOLEAN (PG/MySQL) / BIT (MSSQL) / # INTEGER (sqlite, firebird) — both PG aliases are matched. # • DateTimeField → TIMESTAMP on PG/Firebird (neither has a DATETIME # type), DATETIME elsewhere. # • boolean DEFAULT is engine-aware: TRUE/FALSE for a native BOOLEAN, # 1/0 for INTEGER/BIT-backed bools. # • AUTOINCREMENT is translated per engine via SQLTranslator # (SERIAL on PG, AUTO_INCREMENT on MySQL, IDENTITY on MSSQL, dropped # on Firebird) instead of being emitted raw. # • return false (not true) when the DDL fails. engine = (db.respond_to?(:get_database_type) ? db.get_database_type : "").to_s.downcase bool_sql = case engine when "postgres", "postgresql" then "BOOLEAN" when "mysql" then "BOOLEAN" # alias for TINYINT(1) when "mssql", "sqlserver" then "BIT" else "INTEGER" # sqlite, firebird, odbc, anything else end # PostgreSQL and Firebird have no DATETIME type — CREATE TABLE fails # with `type "datetime" does not exist`. Emit each engine's real # timestamp type. (MySQL/MSSQL/SQLite keep DATETIME: valid there, and # on MySQL it avoids TIMESTAMP's auto-update + 2038 surprises.) datetime_sql = case engine when "postgres", "postgresql", "firebird" then "TIMESTAMP" else "DATETIME" end type_map = { integer: "INTEGER", string: "VARCHAR(255)", text: "TEXT", float: "REAL", decimal: "REAL", boolean: bool_sql, date: "DATE", datetime: datetime_sql, timestamp: "TIMESTAMP", blob: "BLOB", json: "TEXT" } col_defs = [] field_definitions.each do |name, opts| sql_type = type_map[opts[:type]] || "TEXT" if opts[:type] == :string && opts[:length] sql_type = "VARCHAR(#{opts[:length]})" end parts = ["#{name} #{sql_type}"] parts << "PRIMARY KEY" if opts[:primary_key] parts << "AUTOINCREMENT" if opts[:auto_increment] parts << "NOT NULL" if !opts[:nullable] && !opts[:primary_key] if opts[:default] && !opts[:auto_increment] parts << "DEFAULT #{default_literal(opts[:default], opts[:type], bool_sql)}" end col_defs << parts.join(" ") end sql = "CREATE TABLE IF NOT EXISTS #{table_name} (#{col_defs.join(', ')})" # Translate AUTOINCREMENT to the engine's auto-increment syntax # (INTEGER PRIMARY KEY AUTOINCREMENT -> SERIAL PRIMARY KEY on PG, etc.). # SQLTranslator keys off the -ql spelling for postgres. translator_engine = %w[postgres postgresql].include?(engine) ? "postgresql" : engine sql = SQLTranslator.auto_increment_syntax(sql, translator_engine) # Don't claim success when the DDL failed. db.execute() swallows the # driver error into get_error() and returns false, so a bad type (or # any DDL error) used to leave create_table returning true while no # table was actually created. ok = db.execute(sql) db.commit if ok == false Tina4::Log.error("create_table failed for #{table_name}: #{db.get_error}", { sql: sql }) return false end true end |
.db ⇒ Object
43 44 45 46 47 48 49 |
# File 'lib/tina4/orm.rb', line 43 def db # v3.13.12: implicit binding from TINA4_DATABASE_URL. # Resolution: per-class @db → global Tina4.database → env-derived # auto-discovery. Pre-v3.13.12 this fell through to nil — the # helper auto_discover_db existed but was never called. @db || Tina4.database || auto_discover_db end |
.db=(database) ⇒ Object
Per-model database binding
52 53 54 |
# File 'lib/tina4/orm.rb', line 52 def db=(database) @db = database end |
.eager_load(instances, include_list) ⇒ Object
Eager load relationships for a collection of instances (prevents N+1). include is an array of relationship names, supporting dot notation for nesting.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/tina4/orm.rb', line 186 def eager_load(instances, include_list) return if instances.nil? || instances.empty? # Group includes: top-level and nested top_level = {} include_list.each do |inc| parts = inc.to_s.split(".", 2) rel_name = parts[0].to_sym top_level[rel_name] ||= [] top_level[rel_name] << parts[1] if parts.length > 1 end top_level.each do |rel_name, nested| rel = relationship_definitions[rel_name] next unless rel klass = Object.const_get(rel[:class_name]) pk = primary_key_field || :id case rel[:type] when :has_one, :has_many fk = rel[:foreign_key] || "#{name.split('::').last.downcase}_id" pk_values = instances.map { |inst| inst.__send__(pk) }.compact.uniq next if pk_values.empty? placeholders = pk_values.map { "?" }.join(",") sql = "SELECT * FROM #{klass.table_name} WHERE #{fk} IN (#{placeholders})" results = klass.db.fetch(sql, pk_values) = results.map { |row| klass.from_hash(row) } # Eager load nested klass.eager_load(, nested) unless nested.empty? # Group by FK grouped = {} .each do |record| fk_val = record.__send__(fk.to_sym) if record.respond_to?(fk.to_sym) (grouped[fk_val] ||= []) << record end instances.each do |inst| pk_val = inst.__send__(pk) records = grouped[pk_val] || [] if rel[:type] == :has_one inst.instance_variable_get(:@relationship_cache)[rel_name] = records.first else inst.instance_variable_get(:@relationship_cache)[rel_name] = records end end when :belongs_to fk = rel[:foreign_key] || "#{rel_name}_id" fk_values = instances.map { |inst| inst.respond_to?(fk.to_sym) ? inst.__send__(fk.to_sym) : nil }.compact.uniq next if fk_values.empty? = klass.primary_key_field || :id placeholders = fk_values.map { "?" }.join(",") sql = "SELECT * FROM #{klass.table_name} WHERE #{} IN (#{placeholders})" results = klass.db.fetch(sql, fk_values) = results.map { |row| klass.from_hash(row) } klass.eager_load(, nested) unless nested.empty? lookup = {} .each { |r| lookup[r.__send__()] = r } instances.each do |inst| fk_val = inst.respond_to?(fk.to_sym) ? inst.__send__(fk.to_sym) : nil inst.instance_variable_get(:@relationship_cache)[rel_name] = lookup[fk_val] end end end end |
.field_mapping ⇒ Object
Field mapping: { ‘db_column’ => ‘ruby_attribute’ }
74 75 76 |
# File 'lib/tina4/orm.rb', line 74 def field_mapping @field_mapping || {} end |
.field_mapping=(map) ⇒ Object
78 79 80 |
# File 'lib/tina4/orm.rb', line 78 def field_mapping=(map) @field_mapping = map end |
.find(id_or_filter = nil, filter = nil, **kwargs) ⇒ Object
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/tina4/orm.rb', line 161 def find(id_or_filter = nil, filter = nil, **kwargs) include_list = kwargs.delete(:include) # find(id) — find by primary key # find(filter_hash) — find by criteria # find(name: "Alice") — keyword args as filter hash result = if id_or_filter.is_a?(Hash) find_by_filter(id_or_filter) elsif filter.is_a?(Hash) find_by_filter(filter) elsif !kwargs.empty? find_by_filter(kwargs) else find_by_id(id_or_filter) end if include_list && result instances = result.is_a?(Array) ? result : [result] eager_load(instances, include_list) end result end |
.find_by_id(id) ⇒ Object
find_by_id is PUBLIC — cross-framework parity with Python’s MyModel.find_by_id(pk_value) and PHP’s User::find($id). Spec at spec/orm_spec.rb:78 verifies public access. find_by_filter stays public for the same reason; both are part of the documented API.
446 447 448 449 450 451 452 453 |
# File 'lib/tina4/orm.rb', line 446 def find_by_id(id) pk = primary_key_field || :id sql = "SELECT * FROM #{table_name} WHERE #{pk} = ?" if soft_delete sql += " AND (#{soft_delete_field} IS NULL OR #{soft_delete_field} = 0)" end select_one(sql, [id]) end |
.find_or_fail(id) ⇒ Object
317 318 319 320 321 |
# File 'lib/tina4/orm.rb', line 317 def find_or_fail(id) result = find(id) raise "#{name} with #{primary_key_field || :id}=#{id} not found" if result.nil? result end |
.from_hash(hash) ⇒ Object
429 430 431 432 433 434 435 436 437 438 439 440 |
# File 'lib/tina4/orm.rb', line 429 def from_hash(hash) instance = new mapping_reverse = field_mapping.invert hash.each do |key, value| # Apply field mapping (db_col => ruby_attr) attr_name = mapping_reverse[key.to_s] || key setter = "#{attr_name}=" instance.__send__(setter, value) if instance.respond_to?(setter) end instance.instance_variable_set(:@persisted, true) instance end |
.get_db ⇒ Object
Return the database connection used by this model.
463 464 465 |
# File 'lib/tina4/orm.rb', line 463 def get_db # -> Database db end |
.get_db_column(property) ⇒ Object
Map a Ruby property name to its database column name using field_mapping. Returns the column name as a symbol.
469 470 471 472 |
# File 'lib/tina4/orm.rb', line 469 def get_db_column(property) # -> Symbol col = field_mapping[property.to_s] || property col.to_sym end |
.has_many(name, class_name: nil, foreign_key: nil) ⇒ Object
has_many :posts, class_name: “Post”, foreign_key: “user_id”
126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/tina4/orm.rb', line 126 def has_many(name, class_name: nil, foreign_key: nil) relationship_definitions[name] = { type: :has_many, class_name: class_name || name.to_s.sub(/s$/, "").split("_").map(&:capitalize).join, foreign_key: foreign_key } define_method(name) do load_has_many(name) end end |
.has_one(name, class_name: nil, foreign_key: nil) ⇒ Object
has_one :profile, class_name: “Profile”, foreign_key: “user_id”
113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/tina4/orm.rb', line 113 def has_one(name, class_name: nil, foreign_key: nil) relationship_definitions[name] = { type: :has_one, class_name: class_name || name.to_s.split("_").map(&:capitalize).join, foreign_key: foreign_key } define_method(name) do load_has_one(name) end end |
.inherited(subclass) ⇒ Object
When a new model class is defined, resolve any deferred ForeignKeyField wiring that targets it. The string / forward-reference form of ‘foreign_key_field` (e.g. `references: “Author”`) records the has_many side in @@_fk_registry but cannot wire it until the referenced class actually loads — which is now. Without this hook apply_fk_registry! was never called, so the has_many side silently never wired. The class body (where the model’s own foreign_key_field declarations run, populating the registry) executes AFTER inherited returns, so entries keyed on THIS class were already recorded by earlier-loaded models. Chain through super so we never clobber a future inherited hook.
29 30 31 32 33 |
# File 'lib/tina4/orm.rb', line 29 def self.inherited(subclass) super (@_model_subclasses ||= []) << subclass subclass.apply_fk_registry! if subclass.respond_to?(:apply_fk_registry!, true) end |
.model_subclasses ⇒ Object
Every Tina4::ORM subclass that has been loaded, in definition order. Mirrors Python’s ORM.__subclasses__() — used to resolve string-form ForeignKeyField references to a live class.
38 39 40 |
# File 'lib/tina4/orm.rb', line 38 def self.model_subclasses @_model_subclasses ||= [] end |
.query ⇒ Tina4::QueryBuilder
Create a fluent QueryBuilder pre-configured for this model’s table and database.
Usage:
results = User.query.where("active = ?", [1]).order_by("name").get
157 158 159 |
# File 'lib/tina4/orm.rb', line 157 def query QueryBuilder.from_table(table_name, db: db) end |
.relationship_definitions ⇒ Object
Relationship definitions
108 109 110 |
# File 'lib/tina4/orm.rb', line 108 def relationship_definitions @relationship_definitions ||= {} end |
.scope(name, filter_sql, params = []) ⇒ Object
423 424 425 426 427 |
# File 'lib/tina4/orm.rb', line 423 def scope(name, filter_sql, params = []) define_singleton_method(name) do |limit: 20, offset: 0| where(filter_sql, params) end end |
.select(sql, params = [], limit: nil, offset: nil, include: nil) ⇒ Object
287 288 289 290 291 292 |
# File 'lib/tina4/orm.rb', line 287 def select(sql, params = [], limit: nil, offset: nil, include: nil) results = db.fetch(sql, params, limit: limit, offset: offset) instances = results.map { |row| from_hash(row) } eager_load(instances, include) if include instances end |
.select_one(sql, params = [], include: nil) ⇒ Object
294 295 296 297 |
# File 'lib/tina4/orm.rb', line 294 def select_one(sql, params = [], include: nil) results = select(sql, params, limit: 1, include: include) results.first end |
.soft_delete ⇒ Object
Soft delete configuration
57 58 59 |
# File 'lib/tina4/orm.rb', line 57 def soft_delete @soft_delete || false end |
.soft_delete=(val) ⇒ Object
61 62 63 |
# File 'lib/tina4/orm.rb', line 61 def soft_delete=(val) @soft_delete = val end |
.soft_delete_field ⇒ Object
65 66 67 |
# File 'lib/tina4/orm.rb', line 65 def soft_delete_field @soft_delete_field || :is_deleted end |
.soft_delete_field=(val) ⇒ Object
69 70 71 |
# File 'lib/tina4/orm.rb', line 69 def soft_delete_field=(val) @soft_delete_field = val end |
.where(conditions, params = [], include: nil) ⇒ Object
262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/tina4/orm.rb', line 262 def where(conditions, params = [], include: nil) sql = "SELECT * FROM #{table_name}" if soft_delete sql += " WHERE (#{soft_delete_field} IS NULL OR #{soft_delete_field} = 0) AND (#{conditions})" else sql += " WHERE #{conditions}" end results = db.fetch(sql, params) instances = results.map { |row| from_hash(row) } eager_load(instances, include) if include instances end |
.with_trashed(conditions = "1=1", params = [], limit: 20, offset: 0) ⇒ Object
323 324 325 326 327 |
# File 'lib/tina4/orm.rb', line 323 def with_trashed(conditions = "1=1", params = [], limit: 20, offset: 0) sql = "SELECT * FROM #{table_name} WHERE #{conditions}" results = db.fetch(sql, params, limit: limit, offset: offset) results.map { |row| from_hash(row) } end |
Instance Method Details
#delete ⇒ Object
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 |
# File 'lib/tina4/orm.rb', line 572 def delete pk = self.class.primary_key_field || :id pk_value = __send__(pk) return false unless pk_value self.class.db.transaction do |db| if self.class.soft_delete db.update( self.class.table_name, { self.class.soft_delete_field => 1 }, { pk => pk_value } ) else db.delete(self.class.table_name, { pk => pk_value }) end end @persisted = false true end |
#errors ⇒ Object
673 674 675 |
# File 'lib/tina4/orm.rb', line 673 def errors @errors end |
#force_delete ⇒ Object
592 593 594 595 596 597 598 599 600 601 602 |
# File 'lib/tina4/orm.rb', line 592 def force_delete pk = self.class.primary_key_field || :id pk_value = __send__(pk) raise "Cannot delete: no primary key value" unless pk_value self.class.db.transaction do |db| db.delete(self.class.table_name, { pk => pk_value }) end @persisted = false true end |
#load(arg = nil, params = nil) ⇒ Object
load — populate this instance from the database.
Three forms (parity with Python’s model.load(sql, params, include)):
user.load # reload by primary key from instance
user.load(123) # load by primary key value
user.load("email = ?", ["a@b.c"]) # load by filter SQL + params (selectOne)
Returns true on hit, false on miss. Always clears the relationship cache.
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 |
# File 'lib/tina4/orm.rb', line 641 def load(arg = nil, params = nil) @relationship_cache = {} # Clear relationship cache on reload pk = self.class.primary_key_field || :id if arg.is_a?(String) # Filter-SQL form: user.load("email = ?", ["a@b.c"]) sql = "SELECT * FROM #{self.class.table_name} WHERE #{arg} LIMIT 1" result = self.class.db.fetch_one(sql, params || []) else # Primary-key form: user.load OR user.load(123) id = arg || __send__(pk) return false unless id result = self.class.db.fetch_one( "SELECT * FROM #{self.class.table_name} WHERE #{pk} = ?", [id] ) end return false unless result mapping_reverse = self.class.field_mapping.invert result.each do |key, value| attr_name = mapping_reverse[key.to_s] || key setter = "#{attr_name}=" __send__(setter, value) if respond_to?(setter) end @persisted = true true end |
#persisted? ⇒ Boolean
669 670 671 |
# File 'lib/tina4/orm.rb', line 669 def persisted? @persisted end |
#restore ⇒ Object
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 |
# File 'lib/tina4/orm.rb', line 604 def restore raise "Model does not support soft delete" unless self.class.soft_delete pk = self.class.primary_key_field || :id pk_value = __send__(pk) raise "Cannot restore: no primary key value" unless pk_value self.class.db.transaction do |db| db.update( self.class.table_name, { self.class.soft_delete_field => 0 }, { pk => pk_value } ) end __send__("#{self.class.soft_delete_field}=", 0) if respond_to?("#{self.class.soft_delete_field}=") true end |
#save ⇒ Object
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'lib/tina4/orm.rb', line 540 def save @errors = [] @relationship_cache = {} # Clear relationship cache on save validate_fields return false unless @errors.empty? data = to_db_hash(exclude_nil: true) pk = self.class.primary_key_field || :id pk_value = __send__(pk) self.class.db.transaction do |db| if @persisted && pk_value filter = { pk => pk_value } data.delete(pk) # Remove mapped primary key too mapped_pk = self.class.field_mapping[pk.to_s] data.delete(mapped_pk.to_sym) if mapped_pk db.update(self.class.table_name, data, filter) else result = db.insert(self.class.table_name, data) if result[:last_id] && respond_to?("#{pk}=") __send__("#{pk}=", result[:last_id]) end @persisted = true end end true rescue => e @errors << e. false end |
#select(*fields) ⇒ Object
741 742 743 744 745 746 |
# File 'lib/tina4/orm.rb', line 741 def select(*fields) fields_str = fields.map(&:to_s).join(", ") pk = self.class.primary_key_field || :id pk_value = __send__(pk) self.class.db.fetch_one("SELECT #{fields_str} FROM #{self.class.table_name} WHERE #{pk} = ?", [pk_value]) end |
#to_array ⇒ Object Also known as: to_list
727 728 729 |
# File 'lib/tina4/orm.rb', line 727 def to_array to_h.values end |
#to_h(include: nil, case: nil) ⇒ Object Also known as: to_hash, to_dict, to_object
Convert to hash using Ruby attribute names. Optionally include relationships via the include keyword. case: “camel” converts snake_case keys to camelCase (parity with Python’s to_dict(case=‘camel’)). Default keeps native snake_case.
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 |
# File 'lib/tina4/orm.rb', line 681 def to_h(include: nil, case: nil) key_case = binding.local_variable_get(:case) # :case is a reserved word hash = {} self.class.field_definitions.each_key do |name| hash[name] = __send__(name) end if include # Group includes: top-level and nested top_level = {} include.each do |inc| parts = inc.to_s.split(".", 2) rel_name = parts[0].to_sym top_level[rel_name] ||= [] top_level[rel_name] << parts[1] if parts.length > 1 end top_level.each do |rel_name, nested| next unless self.class.relationship_definitions.key?(rel_name) = __send__(rel_name) if .nil? hash[rel_name] = nil elsif .is_a?(Array) hash[rel_name] = .map { |r| r.to_h(include: nested.empty? ? nil : nested) } else hash[rel_name] = .to_h(include: nested.empty? ? nil : nested) end end end if key_case == "camel" || key_case == :camel # snake_case → camelCase: split on _, capitalize all but the first hash = hash.each_with_object({}) do |(k, v), out| parts = k.to_s.split("_") camel = parts[0] + parts[1..].map(&:capitalize).join out[camel.to_sym] = v end end hash end |
#to_json(include: nil, **_args) ⇒ Object
733 734 735 |
# File 'lib/tina4/orm.rb', line 733 def to_json(include: nil, **_args) JSON.generate(to_h(include: include)) end |
#to_s ⇒ Object
737 738 739 |
# File 'lib/tina4/orm.rb', line 737 def to_s "#<#{self.class.name} #{to_h}>" end |
#validate ⇒ Object
622 623 624 625 626 627 628 629 630 631 |
# File 'lib/tina4/orm.rb', line 622 def validate errors = [] self.class.field_definitions.each do |name, opts| value = __send__(name) if !opts[:nullable] && value.nil? && !opts[:auto_increment] && !opts[:default] errors << "#{name} cannot be null" end end errors end |