mevn-orm 2.2.2

package/.babelrc

@@ -0,0 +1,3 @@
+{
+    "plugins": ["@babel/plugin-proposal-class-properties"]
+}

package/.env.example

@@ -0,0 +1,9 @@
+NODE_ENV=testing
+
+DB_HOST=localhost
+DB_USER=root
+DB_PASSWORD=
+DB_DATABASE=mevn_orm
+DB_CLIENT=mysql2
+
+TESTING_DB=sqlite3

package/.eslintrc.json

@@ -0,0 +1,36 @@
+{
+    "env": {
+        "commonjs": true,
+        "es2021": true,
+        "node": true
+    },
+    "extends": "eslint:recommended",
+    "plugins": ["@babel"],
+    "parser": "@babel/eslint-parser",
+    "parserOptions": {
+        "ecmaVersion": 12
+    },
+    "rules": {
+        "no-console":"warn",
+        "constructor-super":"off",
+        "no-this-before-super":"off",
+        "arrow-parens":"error",
+        "class-methods-use-this":"error",
+        "indent": [
+            "error",
+            "tab"
+        ],
+        "linebreak-style": [
+            "error",
+            "unix"
+        ],
+        "quotes": [
+            "error",
+            "single"
+        ],
+        "semi": [
+            "error",
+            "never"
+        ]
+    }
+}

package/.gitattributes

@@ -0,0 +1,8 @@
+.github export-ignore
+_config.yml export-ignore
+.gitignore export-ignore
+CODE_OF_CONDUCT.md export-ignore
+SECURITY.md export-ignore
+test export-ignore
+test.sh export-ignore
+initDb export-ignore

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+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

@@ -0,0 +1,20 @@
+---
+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

@@ -0,0 +1,30 @@
+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

@@ -0,0 +1,31 @@
+# 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/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at stanleyoren@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 StanoJs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+# 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)
+
+```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)
+```
+
+_Still under development hence not ready for production_

package/index.js

@@ -0,0 +1,3 @@
+require('dotenv').config()
+const Model = require('./lib/model')
+module.exports = { Model }

package/initDb

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

@@ -0,0 +1,46 @@
+module.exports = {
+
+	development: {
+		client: 'sqlite3',
+		connection: {
+			filename: './dev.sqlite'
+		},
+		useNullAsDefault: true,
+		migrations: {
+			tableName: 'migrations',
+		}
+	},
+
+	staging: {
+		client: process.env.DB_CLIENT || 'mysql2',
+		connection: {
+			database: process.env.DB_DATABASE || 'my_db',
+			user: process.env.DB_USER || 'username',
+			password: process.env.DB_PASSWORD || 'password'
+		},
+		pool: {
+			min: 2,
+			max: 10
+		},
+		migrations: {
+			tableName: 'migrations'
+		}
+	},
+
+	production: {
+		client: process.env.DB_CLIENT || 'mysql2',
+		connection: {
+			database: process.env.DB_DATABASE || 'my_db',
+			user: process.env.DB_USER || 'username',
+			password: process.env.DB_PASSWORD || 'password'
+		},
+		pool: {
+			min: 2,
+			max: 10
+		},
+		migrations: {
+			tableName: 'migrations'
+		}
+	}
+
+}

package/lib/model.js

@@ -0,0 +1,125 @@
+const { development, staging, production } = require('../knexfile')
+const pluralize = require('pluralize')
+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
+}
+const DB = require('knex')(config)
+class Model {
+	#private
+	static table = pluralize(this.name.toLowerCase())
+	static currentQuery
+	constructor(properties) {
+		for (const key in properties) {
+			this[key] = properties[key]
+		}
+		this.fillable = []
+		this.hidden = []
+		this.#private = ['fillable', 'hidden', 'table']
+		this.modelName = this.constructor.name.toLowerCase()
+		this.table = pluralize(this.modelName)
+	}
+
+	/**
+	 * Save a model to the database
+	 */
+	async save() {
+		try {
+			let rows = {}
+			this.fillable.forEach((f) => {
+				rows[f] = this[f]
+			})
+			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]
+			}
+			return this.stripColumns(this)
+		} catch (error) {
+			console.log(error)
+		}
+	}
+
+	/**
+	 * --------------|
+	 * Relationships |
+	 * --------------|
+	 */
+
+	/**
+	 * One to one relationship
+	 * @param {*} related 
+	 */
+	async hasOne(Related, localKey, foreignKey) {
+		const table = new Related().table
+		const relation = {}
+		if (!localKey) {
+			localKey = this.id
+		}
+		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))
+		}
+		return null
+	}
+	// hasMany(related) {}
+	// hasManyThrough(related) {}
+	// belongsTo(related) {}
+	// belongsToMany(related) {}
+
+	/**
+	 * Where condition
+	 * @param {*} conditions 
+	 * @returns 
+	 */
+	static where(conditions = {}) {
+		this.currentQuery = DB(pluralize(this.name.toLowerCase()))
+			.where(conditions)
+		return this
+	}
+
+	/*ß
+	 * Return the first model
+	 * @param {*} columns 
+	 */
+	static async first(columns) {
+		try {
+			if (!this.currentQuery) {
+				const rows = await DB(this.table).first(columns)
+				return new this(rows)
+			}
+		} catch (error) {
+			console.log(error)
+		}
+	}
+
+
+	/**
+	 * Delete columns that are not needed
+	 * 
+	 */
+	stripColumns(Model) {
+		this.#private.concat(this.hidden).forEach((h) => {
+			delete Model[h]
+		})
+		return Model
+	}
+
+}
+module.exports = Model

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "mevn-orm",
+  "version": "2.2.2",
+  "description": "simple ORM for express js",
+  "type": "commonjs",
+  "scripts": {
+    "pretest": "node initDb",
+    "test": "mocha  --exit",
+    "init:db": "node initDb",
+    "migrate": "knex migrate:latest",
+    "lint": "eslint --ext .js ./"
+  },
+  "peerDependencies": {
+    "knex": "^0.95"
+  },
+  "keywords": [
+    "ORM",
+    "express",
+    "Mysql",
+    "mevn"
+  ],
+  "author": "Stanley Masinde",
+  "license": "MIT",
+  "dependencies": {
+    "dotenv": "^8.2.0",
+    "knex": "^0.95",
+    "pluralize": "^8.0.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.13.16",
+    "@babel/core": "^7.13.16",
+    "@babel/eslint-parser": "^7.13.14",
+    "@babel/eslint-plugin": "^7.13.16",
+    "@babel/plugin-proposal-class-properties": "^7.13.0",
+    "chai": "^4.2.0",
+    "eslint": "^7.25.0",
+    "faker": "^5.5.3",
+    "mocha": "^9.1.2",
+    "sqlite3": "^5.0.0"
+  },
+  "directories": {
+    "test": "test"
+  },
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/StanleyMasinde/mevn-orm.git"
+  },
+  "bugs": {
+    "url": "https://github.com/StanleyMasinde/mevn-orm/issues"
+  },
+  "homepage": "https://github.com/StanleyMasinde/mevn-orm#readme",
+  "main": "dist/index.js"
+}

package/test/model.test.js

@@ -0,0 +1,43 @@
+/* eslint-disable no-undef */
+const { Model } = 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)
+	}
+}
+
+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('#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)
+	})
+})