mevn-orm 2.3.3 → 2.3.7

package/knexfile.js

@@ -12,7 +12,7 @@ module.exports = {
 	},
 
 	staging: {
-		client: process.env.DB_CLIENT || 'mysql2',
+		client: process.env.DB_CLIENT || 'mysql',
 		connection: {
 			database: process.env.DB_DATABASE || 'my_db',
 			user: process.env.DB_USER || 'username',
@@ -28,7 +28,7 @@ module.exports = {
 	},
 
 	production: {
-		client: process.env.DB_CLIENT || 'mysql2',
+		client: process.env.DB_CLIENT || 'mysql',
 		connection: {
 			database: process.env.DB_DATABASE || 'my_db',
 			user: process.env.DB_USER || 'username',

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.js')
+
+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) {
@@ -178,7 +188,7 @@ class Model {
 			foreignKey = `${this.modelName}_id`
 		}
 
-		if(localKey) {
+		if (localKey) {
 			relation[foreignKey] = localKey
 			const res = await DB(table).where(relation).first()
 			if (res) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mevn-orm",
-  "version": "2.3.3",
+  "version": "2.3.7",
   "description": "simple ORM for express js",
   "type": "commonjs",
   "scripts": {
@@ -11,8 +11,8 @@
     "lint": "eslint --ext .js ./"
   },
   "peerDependencies": {
-    "dotenv": "^15.0.0",
-    "knex": "^1.0.1",
+    "dotenv": "^16.0.1",
+    "knex": "^2.1.0",
     "mysql": "^2.18.1"
   },
   "peerDependenciesMeta": {
@@ -27,7 +27,11 @@
     "ORM",
     "express",
     "Mysql",
-    "mevn"
+    "mevn",
+    "database",
+    "orm",
+    "orm-express",
+    "orm-mysql"
   ],
   "author": "Stanley Masinde <stanmasinde@gmail.com> (https://stanleymasinde.github.io)",
   "contributors": [
@@ -43,21 +47,24 @@
     "@babel/eslint-parser": "^7.13.14",
     "@babel/eslint-plugin": "^7.13.16",
     "@babel/plugin-proposal-class-properties": "^7.14.5",
-    "@vscode/sqlite3": "^5.0.7",
     "chai": "^4.2.0",
     "dotenv": "^15.0.0",
     "eslint": "^7.25.0",
     "faker": "^5.5.3",
-    "knex": "^1.0.1",
+    "knex": "^2.1.0",
     "mocha": "^9.1.2",
-    "mysql2": "^2.3.0"
+    "mysql2": "^2.3.0",
+    "sqlite3": "^5.0.8"
   },
   "directories": {
     "lib": "lib",
     "test": "test"
   },
   "private": false,
-  "repository": "git+https://github.com/StanleyMasinde/mevn-orm.git",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/StanleyMasinde/mevn-orm.git"
+  },
   "bugs": {
     "url": "https://github.com/StanleyMasinde/mevn-orm/issues",
     "email": "stanmasinde@gmail.com"

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,109 +0,0 @@
-#!/bin/env node
-require('dotenv').config()
-const Knex = require('knex')
-const { development, staging, production } = require('./knexfile.js')
-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)
-
-	try {
-		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)
-	} catch (error) {
-		process.exit(1)
-	}
-}
-initDatabase()

package/test/model.test.js

@@ -1,87 +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)
-	})
-})