chore: Model.db now returns raw Db connection, Model.query the query …

…object for the table

README.md

@@ -82,13 +82,13 @@ Delete keeps the original object intact. Returns `true` if the record was delete
 success = user.delete # => T::Boolean
 
 # or delete by any query:
-User.db.where('...').delete # => Integer, number of deleted records
+User.query.where('...').delete # => Integer, number of deleted records
 ```
 
 To build more complex queries, Sequel can be used directly:
 
 ```ruby
-query = User.db.where({ name: 'John' })
+query = User.query.where({ name: 'John' })
 query = query.where('...') # "query" is a 'Sequel::Dataset' that you can chain as you like
 query = query.limit(10)
 
@@ -217,7 +217,7 @@ module Airports
       # FROM "airports"
       # WHERE (("name" ILIKE 'xx%') OR ("id" ILIKE 'xx%'))
       #
-      query = Airport.db.where(Sequel.ilike(:name, "#{search}%"))
+      query = Airport.query.where(Sequel.ilike(:name, "#{search}%"))
       query = query.or(Sequel.ilike(:id, "#{search}%"))
 
       Airport.resolve(query)

lib/kirei/model.rb

@@ -18,15 +18,15 @@ def class; super; end # rubocop:disable all
     def update(hash)
       hash[:updated_at] = Time.now.utc if respond_to?(:updated_at) && hash[:updated_at].nil?
       self.class.wrap_jsonb_non_primivitives!(hash)
-      self.class.db.where({ id: id }).update(hash)
+      self.class.query.where({ id: id }).update(hash)
       self.class.find_by({ id: id })
     end
 
     # Delete keeps the original object intact. Returns true if the record was deleted.
     # Calling delete multiple times will return false after the first (successful) call.
     sig { returns(T::Boolean) }
     def delete
-      count = self.class.db.where({ id: id }).delete
+      count = self.class.query.where({ id: id }).delete
       count == 1
     end
 

lib/kirei/model/base_class_interface.rb

@@ -34,16 +34,19 @@ def resolve_first(hash); end
       sig { abstract.returns(T.untyped) }
       def table_name; end
 
+      sig { abstract.returns(T.untyped) }
+      def query; end
+
       sig { abstract.returns(T.untyped) }
       def db; end
 
-      sig { abstract.returns(Integer) }
+      sig { abstract.returns(T.untyped) }
       def human_id_length; end
 
-      sig { abstract.returns(String) }
+      sig { abstract.returns(T.untyped) }
       def human_id_prefix; end
 
-      sig { abstract.returns(String) }
+      sig { abstract.returns(T.untyped) }
       def generate_human_id; end
     end
   end

lib/kirei/model/class_methods.rb

@@ -25,8 +25,13 @@ def model_name
       end
 
       sig { override.returns(Sequel::Dataset) }
+      def query
+        db[table_name.to_sym]
+      end
+
+      sig { override.returns(Sequel::Database) }
       def db
-        App.raw_db_connection[table_name.to_sym]
+        App.raw_db_connection
       end
 
       sig do
@@ -35,12 +40,12 @@ def db
         ).returns(T::Array[T.attached_class])
       end
       def where(hash)
-        resolve(db.where(hash))
+        resolve(query.where(hash))
       end
 
       sig { override.returns(T::Array[T.attached_class]) }
       def all
-        resolve(db.all)
+        resolve(query.all)
       end
 
       # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
@@ -67,7 +72,7 @@ def create(hash)
           all_attributes["updated_at"] = Time.now.utc
         end
 
-        pkey = T.let(db.insert(all_attributes), String)
+        pkey = T.let(query.insert(all_attributes), String)
 
         T.must(find_by({ id: pkey }))
       end
@@ -92,7 +97,7 @@ def wrap_jsonb_non_primivitives!(attributes)
         ).returns(T.nilable(T.attached_class))
       end
       def find_by(hash)
-        resolve_first(db.where(hash))
+        resolve_first(query.where(hash))
       end
 
       # Extra or unknown properties present in the Hash do not raise exceptions at

spec/test_app/app/services/airports/filter.rb

@@ -19,7 +19,7 @@ def self.call(search)
       # FROM "airports"
       # WHERE (("name" ILIKE 'xx%') OR ("id" ILIKE 'xx%'))
       #
-      query = Airport.db.where(Sequel.ilike(:name, "#{search}%"))
+      query = Airport.query.where(Sequel.ilike(:name, "#{search}%"))
       query = query.or(Sequel.ilike(:id, "#{search}%"))
 
       Kirei::Services::Result.new(result: Airport.resolve(query))

spec/test_app/db/seeds.rb

@@ -1,28 +1,31 @@
 # typed: strict
 # frozen_string_literal: true
 
-Airport.db.delete
+Airport.query.delete
 
 test = Airport.new(
   id: Airport.generate_human_id,
   name: "A test airport with a human ID",
 )
-test.save
 
 muc = Airport.new(
   id: "MUC",
   name: "Munich Airport"
 )
-muc.save
 
 ber = Airport.new(
   id: "BER",
   name: "Berlin Brandenburg Airport"
 )
-ber.save
 
 sfo = Airport.new(
   id: "SFO",
   name: "San Francisco International Airport"
 )
-sfo.save
+
+Airport.db.transaction do
+  test.save
+  muc.save
+  ber.save
+  sfo.save
+end