feat: remove database from model (#98)

Author: ryandialpad

docs/guide/repository/deleting-data.md

@@ -62,13 +62,3 @@ You can also run a delete statement on a set of records. In this example, we wil
 ```js
 store.$repo(User).where('active', false).delete()
 ```
-
-## Deleting data by model instance method
-
-You may delete a specific record with the model `$delete` instance method.
-
-```js
-const user = store.$repo(User).find(1)
-
-user.$delete()
-```

src/database/Database.ts

@@ -89,7 +89,7 @@ export class Database {
 
       if (attr instanceof Relation) {
         attr.getRelateds().forEach((m) => {
-          this.register(m.$setDatabase(this))
+          this.register(m)
         })
       }
     }

src/model/Model.ts

@@ -1,8 +1,5 @@
 import { isNullish, isArray, assert } from '../support/Utils'
 import { Element, Item, Collection } from '../data/Data'
-import { Database } from '../database/Database'
-import { Query } from '../query/Query'
-import { NonEnumerable } from './decorators/NonEnumerable'
 import { Attribute } from './attributes/Attribute'
 import { Attr } from './attributes/types/Attr'
 import { String as Str } from './attributes/types/String'
@@ -55,12 +52,6 @@ export class Model {
    */
   protected static booted: Record<string, boolean> = {}
 
-  /**
-   * The database instance.
-   */
-  @NonEnumerable
-  protected _database!: Database
-
   /**
    * Create a new model instance.
    */
@@ -263,28 +254,6 @@ export class Model {
     return this.constructor as typeof Model
   }
 
-  /**
-   * Get the database instance.
-   */
-  $database(): Database {
-    assert(this._database !== undefined, [
-      'A Vuex Store instance is not injected into the model instance.',
-      'You might be trying to instantiate the model directly. Please use',
-      '`repository.make` method to create a new model instance.'
-    ])
-
-    return this._database
-  }
-
-  /**
-   * Set the database instance.
-   */
-  $setDatabase(database: Database): this {
-    this._database = database
-
-    return this
-  }
-
   /**
    * Get the entity for this model.
    */
@@ -315,18 +284,9 @@ export class Model {
     const self = this.$self()
     const model = new self(attributes, options) as this
 
-    model.$setDatabase(this.$database())
-
     return model
   }
 
-  /**
-   * Create a new query instance.
-   */
-  $query(): Query<this> {
-    return new Query(this.$database(), this)
-  }
-
   /**
    * Bootstrap this model.
    */
@@ -503,37 +463,6 @@ export class Model {
     return this.$toJson(this, { relations: false })
   }
 
-  /**
-   * Delete the model from the database.
-   */
-  $delete(): boolean {
-    const key = this.$getKeyName()
-
-    return isArray(key)
-      ? this.$deleteByCompositeKeyName(key)
-      : this.$deleteByKeyName(key)
-  }
-
-  /**
-   * Delete the model from the database by ID.
-   */
-  protected $deleteByKeyName(key: string): boolean {
-    return !!this.$query().destroy(this[key])
-  }
-
-  /**
-   * Delete the model from the database by composite key.
-   */
-  protected $deleteByCompositeKeyName(keys: string[]): boolean {
-    const query = this.$query()
-
-    keys.forEach((key) => {
-      query.where(key, this[key])
-    })
-
-    return query.delete().length > 0
-  }
-
   /**
    * Serialize this model, or the given model, as POJO.
    */

src/query/Query.ts

@@ -83,10 +83,7 @@ export class Query<M extends Model = Model> {
    * Create a new query instance from the given relation.
    */
   protected newQueryForRelation(relation: Relation): Query<Model> {
-    return new Query(
-      this.database,
-      relation.getRelated().$setDatabase(this.database)
-    )
+    return new Query(this.database, relation.getRelated())
   }
 
   /**

src/repository/Repository.ts

@@ -49,7 +49,7 @@ export class Repository<M extends Model = Model> {
   initialize(model?: ModelConstructor<M>): this {
     // If there's a model passed in, just use that and return immediately.
     if (model) {
-      this.model = model.newRawInstance().$setDatabase(this.database)
+      this.model = model.newRawInstance()
 
       return this
     }
@@ -59,7 +59,7 @@ export class Repository<M extends Model = Model> {
     // In this case, we'll check if the user has set model to the `use`
     // property and instantiate that.
     if (this.use) {
-      this.model = (this.use.newRawInstance() as M).$setDatabase(this.database)
+      this.model = this.use.newRawInstance() as M
 
       return this
     }

test/feature/model/deletes_delete.spec.ts

@@ -8,10 +8,6 @@ describe('unit/model/Model', () => {
     @Attr() id!: number
   }
 
-  it('throws when accessing the database but it is not injected', () => {
-    expect(() => new User().$database()).toThrow()
-  })
-
   it('ignores unkown field when filling the model', () => {
     const user = new User({ id: 1, name: 'John Doe' })
 

test/feature/model/deletes_delete_composite_key.spec.ts

@@ -22,7 +22,6 @@ describe('unit/repository/Repository', () => {
     const user = store.$repo(User).make()
 
     expect(user).toBeInstanceOf(User)
-    expect(user.$database()).toBe(store.$database)
     assertModel(user, { id: null, name: 'John Doe' })
   })
 
@@ -33,8 +32,6 @@ describe('unit/repository/Repository', () => {
     const user = store.$repo(User, connection).make()
 
     expect(user).toBeInstanceOf(User)
-    expect(user.$database()).toBe(store.$databases[connection])
-    expect(user.$database().started).toBe(true)
     assertModel(user, { id: null, name: 'John Doe' })
 
     // Fetches the same atabase on 2nd call.
@@ -51,7 +48,6 @@ describe('unit/repository/Repository', () => {
     })
 
     expect(user).toBeInstanceOf(User)
-    expect(user.$database()).toBe(store.$database)
     assertModel(user, { id: 1, name: 'Jane Doe' })
   })