base-repository/README.md

[](https://travis-ci.org/joehua87/base-repository)

[![Build Status](https://travis-ci.org/joehua87/base-repository.svg?branch=master)](https://travis-ci.org/joehua87/base-repository)

[![Coverage Status](https://coveralls.io/repos/joehua87/base-repository/badge.svg?branch=master&service=github)](https://coveralls.io/github/joehua87/base-repository?branch=master)

* The purpose of this project is to support define REST Api Query quickly by mapping url params with mongodb query
* Compatible with koa (generator)

# Examples:

* Querying article with commentsCount between 5 and 10
* Given: <code>minCommentsCount=5&maxCommentsCount=10</code>
* And you have the config file like file: tests/process-filter.test.js & tests/article.model.js
* It will parse the filter into <code>{commentsCount: {$gte: 5,$lte: 10}</code>

## Usage:

### BaseRepository
```javascript
import * as ArticleSchema from './article.model';
const repository = new BaseRepository(Article, ArticleSchema.config);
const Article = mongoose.model(ArticleSchema.schemaName, ArticleSchema.schema);
```
View more at '/tests/base-repository.tests.js'

### createController
```javascript
import { createController } from 'base-repository';
const controller = createController(repository);
```
Controller Function:
* query
* insert
* update
* getByKey
* getById
* getByFilter
* deleteById
* addChild
* removeChild

# TODO
* Add Code Coverage

# Run Test
* <code>npm install</code>
* <code>npm test</code>

# Run Examples
```
npm install
```
Generate Data
```
node examples/generate-data
```
Run Example
```
node examples
```

# Steps for generate Test Data
* Need a list of entities (real data).
* Transfer a list of entities into mongodb data & use as initial testing data