mevn-orm 3.0.0 → 3.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 StanoJs
+Copyright (c) 2021 Stanley Masinde
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,29 +1,59 @@
-# Mevn-orm
-![npm](https://img.shields.io/npm/v/mevn-orm?style=for-the-badge)
-[![GitHub license](https://img.shields.io/github/license/stanleymasinde/mevn-orm?style=for-the-badge)](https://github.com/StanleyMasinde/mevn-orm/blob/master/LICENSE)
-![GitHub issues](https://img.shields.io/github/issues/stanleymasinde/mevn-orm?style=for-the-badge)
+# Mevn ORM
+
+![npm](https://img.shields.io/npm/v/mevn-orm?style=for-the-badge)  [![GitHub license](https://img.shields.io/github/license/stanleymasinde/mevn-orm?style=for-the-badge)](https://github.com/StanleyMasinde/mevn-orm/blob/master/LICENSE)  ![GitHub issues](https://img.shields.io/github/issues/stanleymasinde/mevn-orm?style=for-the-badge)
+
+**Mevn ORM** is a lightweight ORM for Express.js and MySQL that provides a clean, fluent interface for building queries and managing models.  
+It is under maintenance mode and receives security updates. Development is paused, but the core ORM functionality is complete and usable.
+
+## Getting Started
 
 ```javascript
-   const { Model } = require('mevn-orm')
-
-   class User extends Model {}
-
-let columns = {
-    name: 'John Doe',
-    email: 'john@example.com',
-    password: secret // remember to hash the password
-}
-User()
-   .create(columns)
-   .then(created => {
-      // Do something after the creation
-   })
-   .catch(err => {
-      // Handle the error
-   })
-
-// With aync await
-const userId = await User.create(columns)
+const { Model } = require('mevn-orm')
+
+class User extends Model {}
+
+const user = await User.create({
+  name: 'John Doe',
+  email: 'john@example.com',
+  password: 'secret' // hash before storing
+})
+````
+
+## Features
+
+* Model-based abstraction
+* Create, Read, Update, Delete support
+* Chainable query builder (`where`, `first`, `all`)
+* Timestamps
+* Soft deletes
+* SQLite support for testing
+* Knex-based migration support
+
+## ORM Basics Checklist
+
+* [x] `Model` base class
+* [x] `.create`, `.find`, `.update`, `.delete`
+* [x] `.where()`, `.first()`, `.all()` chaining
+* [x] Table name inference
+* [x] Timestamps
+* [x] Soft deletes
+* [x] Basic relationship hooks (`hasOne`, `hasMany`, `belongsTo`)
+* [x] Raw queries
+* [x] Knex passthrough
+* [x] SQLite3 test DB
+* [x] Uses `mysql2` for production
+* [x] `dotenv` support
+
+## Testing
+
+This project uses [Vitest](https://vitest.dev/) for testing.
+
+```bash
+npm install
+npm run migrate
+npm run test
 ```
 
-_Still under development hence not ready for production_
+## License
+
+[MIT](./LICENSE)

package/lib/model.js

@@ -1,5 +1,15 @@
+const fs = require('fs')
 const knex = require('knex').knex
-const { development, staging, production } = require(process.cwd() + '/knexfile.cjs')
+
+let fileName
+
+if (fs.existsSync(process.cwd() + '/knexfile.js')) {
+	fileName = process.cwd() + '/knexfile.js'
+} else {
+	fileName = process.cwd() + '/knexfile.cjs'
+}
+const { development, staging, production } = require(fileName)
+
 const pluralize = require('pluralize')
 let config
 switch (process.env.NODE_ENV) {
@@ -41,12 +51,13 @@ class Model {
 			this.fillable.forEach((f) => {
 				rows[f] = this[f]
 			})
-			const id = await DB(this.table)
+			const [id] = await DB(this.table)
 				.insert(rows)
 			const fields = await DB(this.table).where({ id }).first()
 			for (const f in fields) {
 				this[f] = fields[f]
 			}
+			this['id'] = id
 			return this.stripColumns(this)
 		} catch (error) {
 			throw new Error(error)
@@ -176,10 +187,13 @@ class Model {
 		if (!foreignKey) {
 			foreignKey = `${this.modelName}_id`
 		}
-		relation[foreignKey] = localKey
-		const res = await DB(table).where(relation).first()
-		if (res) {
-			return this.stripColumns(new Related(res))
+
+		if (localKey) {
+			relation[foreignKey] = localKey
+			const res = await DB(table).where(relation).first()
+			if (res) {
+				return this.stripColumns(new Related(res))
+			}
 		}
 		return null
 	}
@@ -227,11 +241,11 @@ class Model {
 	 * Delete columns that are not needed
 	 * 
 	 */
-	stripColumns(Model) {
+	stripColumns(model) {
 		this.#private.concat(this.hidden).forEach((h) => {
-			delete Model[h]
+			delete model[h]
 		})
-		return Model
+		return model
 	}
 
 }

package/package.json

@@ -1,56 +1,68 @@
 {
   "name": "mevn-orm",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "simple ORM for express js",
   "type": "commonjs",
   "scripts": {
     "pretest": "node initDb",
-    "test": "mocha  --exit",
+    "test": "mocha --exit",
     "init:db": "node initDb",
     "migrate": "knex migrate:latest",
     "lint": "eslint --ext .js ./"
   },
   "peerDependencies": {
-    "knex": "^0.95",
-    "dotenv": "^10.0.0",
-    "mysql": "^2.18.0"
+    "dotenv": "^17.0.1",
+    "knex": "^3.0.0",
+    "mysql2": "^3.9.3"
+  },
+  "peerDependenciesMeta": {
+    "dotenv": {
+      "optional": false
+    },
+    "knex": {
+      "optional": false
+    }
   },
   "keywords": [
     "ORM",
     "express",
     "Mysql",
-    "mevn"
+    "mevn",
+    "database",
+    "orm",
+    "orm-express",
+    "orm-mysql"
+  ],
+  "author": "Stanley Masinde <stanmasinde@gmail.com> (https://stanleymasinde.github.io)",
+  "contributors": [
+    "Stanley Masinde <stanmasinde@gmail.com>"
   ],
-  "author": "Stanley Masinde",
   "license": "MIT",
   "dependencies": {
     "pluralize": "^8.0.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.13.16",
-    "@babel/core": "^7.15.8",
-    "@babel/eslint-parser": "^7.13.14",
-    "@babel/eslint-plugin": "^7.13.16",
-    "@babel/plugin-proposal-class-properties": "^7.14.5",
-    "chai": "^4.2.0",
-    "dotenv": "^8.6.0",
-    "eslint": "^7.25.0",
-    "faker": "^5.5.3",
-    "knex": "^0.95.11",
-    "mocha": "^9.1.2",
-    "mysql2": "^2.3.0",
-    "sqlite3": "^5.0.0"
+    "@babel/cli": "^7.24.5",
+    "@babel/core": "^7.24.5",
+    "@babel/eslint-parser": "^7.24.3",
+    "@babel/eslint-plugin": "^7.24.0",
+    "@faker-js/faker": "^9.8.0",
+    "chai": "^4.4.1",
+    "dotenv": "^17.0.1",
+    "knex": "^3.0.0",
+    "mocha": "^10.4.0",
+    "mysql": "^2.18.1",
+    "sqlite3": "^5.1.7"
   },
   "directories": {
+    "lib": "lib",
     "test": "test"
   },
   "private": false,
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/StanleyMasinde/mevn-orm.git"
-  },
+  "repository": "git+https://github.com/StanleyMasinde/mevn-orm.git",
   "bugs": {
-    "url": "https://github.com/StanleyMasinde/mevn-orm/issues"
+    "url": "https://github.com/StanleyMasinde/mevn-orm/issues",
+    "email": "stanleymasinde1@gmail.com"
   },
   "homepage": "https://github.com/StanleyMasinde/mevn-orm#readme",
   "main": "index.js"

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/dependabot.yml

@@ -1,30 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: npm
-  directory: '/'
-  schedule:
-    interval: daily
-    time: '00:00'
-  open-pull-requests-limit: 10
-  reviewers:
-    - stanleymasinde
-  assignees:
-    - stanleymasinde
-  commit-message:
-    prefix: fix
-    prefix-development: chore
-    include: scope
-- package-ecosystem: github-actions
-  directory: '/'
-  schedule:
-    interval: daily
-    time: '00:00'
-  open-pull-requests-limit: 10
-  reviewers:
-    - stanleymasinde
-  assignees:
-    - stanleymasinde
-  commit-message:
-    prefix: fix
-    prefix-development: chore
-    include: scope

package/.github/workflows/node.js.yml

@@ -1,31 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Node.js CI
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [12.x, 14.x, 15.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: cp .env.example .env
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm test

package/initDb

@@ -1,104 +0,0 @@
-#!/bin/env node
-require('dotenv').config()
-const Knex = require('knex')
-const { development, staging, production } = require('./knexfile.cjs')
-let config
-
-switch (process.env.NODE_ENV) {
-case 'testing':
-	config = development
-	break
-case 'development':
-	config = development
-	break
-case 'staging':
-	config = staging
-	break
-default:
-	config = production
-	break
-}
-async function initDatabase() {
-	const DB = Knex(config)
-	await DB.schema.dropTableIfExists('farmers')
-	await DB.schema.dropTableIfExists('farms')
-	await DB.schema.dropTableIfExists('profiles')
-	await DB.schema.dropTableIfExists('articles')
-	await DB.schema.createTable('farmers', (table) => {
-		table.bigIncrements('id')
-		table.string('name')
-		table.string('email').unique()
-		table.string('password')
-	})
-	await DB.schema.createTable('farms', (table) => {
-		table.bigIncrements('id')
-		table.bigInteger('farmer_id')
-		table.string('name')
-	})
-
-	await DB.schema.createTable('profiles', (table) => {
-		table.bigIncrements('id')
-		table.bigInteger('farmer_id')
-		table.string('bio')
-	})
-
-	await DB.schema.createTable('articles', (table) => {
-		table.bigIncrements('id')
-		table.string('title')
-		table.text('body')
-		table.bigInteger('postable_id')
-		table.string('postable_type')
-	})
-
-	await DB.table('Farmers').insert([
-		{
-			name: 'Jane Doe',
-			email: 'jane@mail.com',
-			password: 'pasword'
-		},
-		{
-			name: 'Ashley Doe',
-			email: 'ashley@mail.com',
-			password: 'pasword'
-		},
-		{
-			name: 'Alice Doe',
-			email: 'alice@mail.com',
-			password: 'pasword'
-		}
-	])
-
-	await DB.table('farms').insert([
-		{
-			farmer_id: 1,
-			name: 'Awesome Farm'
-		},
-		{
-			farmer_id: 1,
-			name: 'Awesome Farm two'
-		},
-		{
-			farmer_id: 1,
-			name: 'Awesome Farm three'
-		}
-	])
-
-	await DB.table('profiles').insert([
-		{
-			farmer_id: 1,
-			bio: 'Profile for farmer one'
-		}
-	])
-
-	await DB.table('articles').insert([
-		{
-			title: 'Awesome Post',
-			body: 'fffgjdfjdbdb something #1',
-			postable_id: 1,
-			postable_type: 'Farmer'
-		}
-	])
-
-	process.exit(0)
-}
-initDatabase()

package/test/model.test.js

@@ -1,86 +0,0 @@
-/* eslint-disable no-undef */
-const { Model, DB } = require('../index')
-const faker = require('faker')
-const { expect } = require('chai')
-class Profile extends Model {
-	fillable = ['farmer_id', 'bio']
-}
-class Farmer extends Model {
-	fillable = ['name', 'email', 'password']
-	hidden = ['password']
-
-	profile() {
-		return this.hasOne(Profile)
-	}
-}
-
-DB(Farmer)
-
-describe('#Model tests', () => {
-	it('#Model instance', async () => {
-		const farmer = new Farmer({
-			name: faker.name.findName(),
-			email: faker.internet.email(),
-			password: faker.internet.password()
-		})
-		await farmer.save()
-		expect(farmer).to.an('Object')
-	})
-
-	it('#find a model', async () => {
-		const farmer = await Farmer.find(1)
-		expect(farmer).to.an('Object')
-	})
-
-	it('#create a model', async () => {
-		const farmer = await Farmer.create({
-			name: faker.name.findName(),
-			email: faker.internet.email(),
-			password: faker.internet.password()
-		})
-		expect(farmer).to.an('Object')
-		expect(farmer.id).to.be.a('number')
-	})
-
-	it('#Update a model with a new instance', async () => {
-		const farmer = await Farmer.find(1)
-		await farmer.update({
-			name: 'new name',
-			email: faker.internet.email(),
-			password: faker.internet.password()
-		})
-		expect(farmer).to.an('Object')
-	})
-
-	it('#chain where and first', async () => {
-		const farmer = await Farmer.where({ id: 1 }).first()
-		expect(farmer).to.an('Object')
-	})
-
-	it('#Return null when not found', async () => {
-		const farmer = await Farmer.where({ id: 'ggggggg' }).first()
-		expect(farmer).to.be.null
-	})
-
-	it('#Delete a model', async () => {
-		const farmer = await Farmer.find(1)
-		await farmer.delete()
-		expect(await Farmer.find(1)).to.be.null
-	})
-
-	it('#Has one relationship', async () => {
-		const farmer = new Farmer({
-			name: faker.name.findName(),
-			email: faker.internet.email(),
-			password: faker.internet.password()
-		})
-		await farmer.save()
-		await new Profile({
-			farmer_id: farmer.id,
-			bio: faker.lorem.sentence()
-		}).save()
-		expect(farmer).to.an('Object')
-		const farmerProfile = await farmer.profile()
-		expect(farmerProfile).to.haveOwnProperty('farmer_id', farmer.id)
-	})
-})