Initial commit.

.eslintignore

@@ -0,0 +1,3 @@
+.idea
+coverage
+node_modules

.eslintrc

@@ -0,0 +1,194 @@
+{
+  "parserOptions": {
+    "ecmaVersion": 6
+  },
+  "env": {
+    "amd": false,
+    "browser": false,
+    "jasmine": false,
+    "mocha": true,
+    "node": true
+  },
+  "globals": {
+    "Promise": false,
+    "console": true
+  },
+  "rules": {
+    "comma-dangle": [ 2, "never" ],
+    "no-cond-assign": [ 2, "always" ],
+    "no-console": 1,
+    "no-constant-condition": 2,
+    "no-control-regex": 1,
+    "no-debugger": 1,
+    "no-dupe-args": 2,
+    "no-dupe-keys": 2,
+    "no-duplicate-case": 2,
+    "no-empty-character-class": 2,
+    "no-empty": 2,
+    "no-ex-assign": 2,
+    "no-extra-boolean-cast": 2,
+    "no-extra-parens": 0,
+    "no-extra-semi": 2,
+    "no-func-assign": 2,
+    "no-inner-declarations": [ 2, "functions" ],
+    "no-invalid-regexp": 2,
+    "no-irregular-whitespace": 2,
+    "no-negated-in-lhs": 2,
+    "no-obj-calls": 2,
+    "no-regex-spaces": 2,
+    "no-sparse-arrays": 2,
+    "no-unexpected-multiline": 2,
+    "no-unreachable": 2,
+    "use-isnan": 2,
+    "valid-jsdoc": 0,
+    "valid-typeof": 2,
+    "accessor-pairs": 1,
+    "block-scoped-var": 2,
+    "complexity": [ 0, 11 ],
+    "consistent-return": 2,
+    "curly": [ 2, "all" ],
+    "default-case": 2,
+    "dot-location": [ 2, "property" ],
+    "dot-notation": [ 2, { "allowKeywords": true } ],
+    "eqeqeq": 2,
+    "guard-for-in": 0,
+    "no-alert": 2,
+    "no-caller": 2,
+    "no-case-declarations": 2,
+    "no-div-regex": 0,
+    "no-else-return": 2,
+    "no-empty-pattern": 2,
+    "no-eq-null": 2,
+    "no-eval": 2,
+    "no-extend-native": 2,
+    "no-extra-bind": 2,
+    "no-fallthrough": 2,
+    "no-floating-decimal": 2,
+    "no-implicit-coercion": 1,
+    "no-implied-eval": 2,
+    "no-invalid-this": 0,
+    "no-iterator": 2,
+    "no-labels": 2,
+    "no-lone-blocks": 2,
+    "no-loop-func": 2,
+    "no-magic-numbers": 0,
+    "no-multi-spaces": 2,
+    "no-multi-str": 2,
+    "no-native-reassign": 2,
+    "no-new-func": 2,
+    "no-new-wrappers": 2,
+    "no-new": 2,
+    "no-octal-escape": 2,
+    "no-octal": 2,
+    "no-param-reassign": 0,
+    "no-process-env": 0,
+    "no-proto": 2,
+    "no-redeclare": 2,
+    "no-return-assign": 2,
+    "no-script-url": 0,
+    "no-self-compare": 2,
+    "no-sequences": 2,
+    "no-throw-literal": 2,
+    "no-unused-expressions": 2,
+    "no-useless-call": 1,
+    "no-useless-concat": 2,
+    "no-void": 2,
+    "no-warning-comments": [ 0, { "terms": [ "todo", "fixme", "xxx" ], "location": "start" } ],
+    "no-with": 2,
+    "radix": 0,
+    "vars-on-top": 0,
+    "wrap-iife": 1,
+    "yoda": [ 2, "never" ],
+    "strict": [ 2, "global" ],
+    "init-declarations": [ 0, "always" ],
+    "no-catch-shadow": 2,
+    "no-delete-var": 2,
+    "no-label-var": 2,
+    "no-shadow-restricted-names": 2,
+    "no-shadow": 2,
+    "no-undef-init": 2,
+    "no-undef": 2,
+    "no-undefined": 2,
+    "no-unused-vars": [ 2, { "vars": "all", "args": "after-used" } ],
+    "no-use-before-define": 2,
+    "array-bracket-spacing": [ 2, "always", { "objectsInArrays": false } ],
+    "block-spacing": [ 2, "always" ],
+    "brace-style": [ 2, "1tbs", { "allowSingleLine": false } ],
+    "camelcase": [ 2, { "properties": "never" } ],
+    "comma-spacing": [ 2, { "before": false, "after": true } ],
+    "comma-style": 2,
+    "computed-property-spacing": [2, "never"],
+    "consistent-this": [ 2, "self" ],
+    "eol-last": 0,
+    "func-names": 0,
+    "func-style": [ 2, "expression" ],
+    "id-length": 0,
+    "id-match": 0,
+    "indent": [ 2, 2, { "SwitchCase": 1 } ],
+    "key-spacing": [ 2, { "beforeColon": false, "afterColon": true } ],
+    "keyword-spacing": 2,
+    "linebreak-style": [ 2, "unix" ],
+    "lines-around-comment": 0,
+    "max-depth": [ 1, 4 ],
+    "max-len": [ 1, 120 ],
+    "max-nested-callbacks": 0,
+    "max-params": [ 0, 4 ],
+    "max-statements": [ 0, 10 ],
+    "new-cap": 2,
+    "new-parens": 2,
+    "newline-after-var": 0,
+    "no-array-constructor": 2,
+    "no-bitwise": 0,
+    "no-continue": 1,
+    "no-inline-comments": 0,
+    "no-lonely-if": 2,
+    "no-mixed-spaces-and-tabs": [ 2, false ],
+    "no-multiple-empty-lines": [ 2, { "max": 1 } ],
+    "no-negated-condition": 2,
+    "no-nested-ternary": 0,
+    "no-new-object": 2,
+    "no-plusplus": 0,
+    "no-restricted-syntax": 0,
+    "no-spaced-func": 2,
+    "no-ternary": 0,
+    "no-trailing-spaces": 2,
+    "no-underscore-dangle": 0,
+    "no-unneeded-ternary": 2,
+    "object-curly-spacing": [ 2, "always" ],
+    "one-var": [ 2, "never" ],
+    "operator-assignment": [ 0, "always" ],
+    "operator-linebreak": [ 1, "before" ],
+    "padded-blocks": [ 2, "never" ],
+    "quote-props": [ 2, "as-needed" ],
+    "quotes": [ 2, "single" ],
+    "require-jsdoc": 0,
+    "semi-spacing": 2,
+    "semi": 2,
+    "sort-vars": [ 2, { "ignoreCase" : true } ],
+    "space-before-blocks": 2,
+    "space-before-function-paren": [ 2, "never" ],
+    "space-in-parens": 2,
+    "space-infix-ops": 2,
+    "space-unary-ops": [ 2, { "words": true, "nonwords": false } ],
+    "spaced-comment": [ 2, "always" ],
+    "wrap-regex": 0,
+    "arrow-body-style": [ 0, "as-needed" ],
+    "arrow-parens": [ 2, "always" ],
+    "arrow-spacing": [ 2, { "before": true, "after": true } ],
+    "constructor-super": 2,
+    "generator-star-spacing": 2,
+    "no-class-assign": 2,
+    "no-const-assign": 2,
+    "no-confusing-arrow": 0,
+    "no-dupe-class-members": 2,
+    "no-this-before-super": 2,
+    "no-var": 2,
+    "object-shorthand": [ 2, "methods" ],
+    "prefer-arrow-callback": 2,
+    "prefer-const": [ 2, { "ignoreReadBeforeAssign": true } ],
+    "prefer-reflect": 0,
+    "prefer-spread": 0,
+    "prefer-template": 2,
+    "require-yield": 2
+  }
+}

.gitignore

@@ -0,0 +1,4 @@
+.idea
+coverage
+node_modules
+npm-debug.log

.istanbul.yml

@@ -0,0 +1,6 @@
+check:
+  global:
+    branches: 100
+    functions: 100
+    lines: 100
+    statements: 100

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mathew Gardner
+
+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.

README.md

@@ -0,0 +1,133 @@
+## knex-supermodel
+
+[![circle](https://circleci.com/gh/mathewdgardner/knex-supermodel.svg?style=svg)](https://circleci.com/gh/mathewdgardner/knex-supermodel)
+[![coverage](https://coveralls.io/repos/github/mathewdgardner/knex-supermodel/badge.svg?branch=master)](https://coveralls.io/github/mathewdgardner/knex-supermodel?branch=master)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/mathewdgardner/knex-supermodel/master/LICENSE)
+
+## Description
+
+knex-supermodel is meant to be a very lite but not quite ORM for knex. This is accomplished by providing a base model that is simply an ES6 class that you extend in your own models. You can override the provided methods or even add to them to make your own. Each method will always return your model back to you, except in the obvious case of `collection`!
+
+This package requires ES6 features only available in node 6.
+
+## Examples
+
+##### Saving
+
+Any added properties will become part of the resultant query.
+
+```javascript
+class User extends require('knex-supermodel') {
+  constructor(opts) {
+    super(opts);
+  }
+}
+
+User.knex = knex;
+const user = new User({ foo: 'bar', bar: 'baz' });
+
+console.log(user.foo); // bar
+console.log(user.bar); // baz
+
+user.save(); // performs insert
+```
+
+##### Fetching
+
+When fetching, the provided object becomes the `where` clause with a limit of 1. This results in an instantaion of your class whose properties are loaded from the database.
+
+```javascript
+let user;
+
+User.fetch({ id: '123' })
+  .then((u) => {
+    user = u;
+  });
+```
+
+##### Collection
+
+When getting a collection, the provided object becomes the `where` clause. Each member in the collection is an instantation of your class.
+
+```javascript
+let users;
+
+User.collection({ foo: 'bar' })
+  .then((u) => {
+    users = u;
+  });
+```
+
+##### Create
+
+When creating, the provided object becomes the properties. After inserting into the database, an instantation of your class is returned.
+
+```javascript
+let user;
+
+User.create({ foo: 'bar' })
+  .then((u) => {
+    user = u;
+  });
+```
+
+##### Update
+
+When updating, the provided object is used to update the record. The same instantation of your class is return after update with its properties updated.
+
+```javascript
+User.fetch({ id: '123' })
+  .then((user) => {
+    console.log(user.foo); // bar
+
+    return user.update({ foo: 'baz' });
+  })
+  .then((user) => {
+    console.log(user.foo); // baz
+  });
+```
+
+##### Destroy
+
+When deleting, it assumed you want to delete by `id` unless you provide an id object that is in the format of a knex where object.
+
+```javascript
+User.fetch({ id: '123' })
+  .then((user) => {}
+    return user.destroy();
+  });
+
+User.fetch({ id: '123' })
+  .then((user) => {}
+    return user.destroy({ foo: 'bar', bar: 'baz' });
+  });
+```
+
+##### Transacting
+
+You may either provide a transacting knex to each method or chain it.
+
+```javascript
+let user;
+
+knex.transaction((trx) => {
+  User.fetch({ id: '123' }, { trx })
+    .then((u) => {
+      user = u;
+
+      return user.update({ foo: 'baz' });
+    });
+});
+
+knex.transaction((trx) => {
+  user.transaction(trx)
+    .update({ trx })
+    .then((user) => {
+      return user.update({ foo: 'baz' });
+    });
+});
+```
+
+## License
+
+This software is licensed under [the MIT license](LICENSE.md).

circle.yml

@@ -0,0 +1,26 @@
+machine:
+  pre:
+    - curl -sSL https://s3.amazonaws.com/circle-downloads/install-circleci-docker.sh | bash -s -- 1.10.0
+  services:
+    - docker
+  node:
+    version: 6
+
+dependencies:
+  cache_directories:
+    - node_modules
+  pre:
+    - sudo bash -c "curl -L https://github.com/docker/compose/releases/download/1.8.0-rc2/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose"
+    - sudo chmod +x /usr/local/bin/docker-compose
+    - docker-compose pull
+  override:
+    - npm install && npm update
+
+test:
+  override:
+    - npm run dc:test:setup
+    - npm run dc:test:coverage
+    - npm run ci:coveralls
+  post:
+    - sudo mv coverage $CIRCLE_ARTIFACTS || true
+    - sudo mv ./npm-debug.log $CIRCLE_ARTIFACTS || true