# mongoose-data-seed

Seed mongodb with data using mongoose models

## Install

    npm install --save mongoose-data-seed
    md-seed init

`md-seed init` will ask you to choose a folder for your seeders.

`md-seed init` will create the `seeders` folder, generate `md-seed-config.js` and update your `package.json`.

## Use

Generate seeder file

    md-seed g users

Run all seeders

    md-seed run

Or run specific seeders

    md-seed run users posts comments

## Options

Drop the database before seeding

    md-seed run --dropdb

## Seeder Example

    import { Seeder } from 'mongoose-data-seed';
    import { User } from '../server/models';

    const data = [
      {
        email: 'user1@gmail.com',
        password: '123123',
        passwordConfirmation: '123123',
        isAdmin: true
      },
      {
        email: 'user2@gmail.com',
        password: '123123',
        passwordConfirmation: '123123',
        isAdmin: false
      }
    ];

    class UsersSeeder extends Seeder {
      async shouldRun() {
        return User.countDocuments()
          .exec()
          .then(count => count === 0);
      }

      async run() {
        return User.create(data);
      }
    }

    export default UsersSeeder;

### md-seed-config.js

`md-seed` excepting to get 3 values from `md-seed-config.js`

1. `seedersList` - A key/value list of all your seeders, `md-seed` will run your seeders as they ordered in the list.
2. `connect` - Connect to mongodb implementation (should return promise).
3. `dropdb` - Drop/Clear the database implementation (should return promise).

#### Example

    import mongoose from 'mongoose';

    import Users from './seeders/users.seeder';
    import Posts from './seeders/posts.seeder';
    import Comments from './seeders/comments.seeder';

    const mongoURL = process.env.MONGO_URL || 'mongodb://localhost:27017/dbname';

    /**
     * Seeders List
     * order is important
     * @type {Object}
     */
    export const seedersList = {
      Users,
      Posts,
      Comments,
    };
    /**
     * Connect to mongodb implementation
     * @return {Promise}
     */
    export const connect = async () => await mongoose.connect(mongoURL, { useNewUrlParser: true });
    /**
     * Drop/Clear the database implementation
     * @return {Promise}
     */
    export const dropdb = async () => mongoose.connection.db.dropDatabase();

### Configurations

`mongoose-data-seed` configurations will get loaded from the `mdSeed` field in your `package.json` file.

Field | Default Value | Description
--- | --- | ---
`seedersFolder` | `'./seeders'` | Path for your seeders-folder, seeders will be generated into this folder.
`customSeederTemplate` | `undefined` | Path to a custom template file to generate your seeders from.

## Examples

1. md-seed-example

## License

MIT

# mongoose-data-seed

Seed mongodb with data using mongoose models

## Install

    npm install --save mongoose-data-seed
    md-seed init

`md-seed init` will ask you to choose a folder for your seeders.

`md-seed init` will create the `seeders` folder, generate `md-seed-config.js` and update your `package.json`.

## Use

Generate seeder file

    md-seed g users

Run all seeders

    md-seed run

Or run specific seeders

    md-seed run users posts comments

## Options

Drop the database before seeding

    md-seed run --dropdb

## Seeder Example

    import { Seeder } from 'mongoose-data-seed';
    import { User } from '../server/models';

    const data = [
      {
        email: 'user1@gmail.com',
        password: '123123',
        passwordConfirmation: '123123',
        isAdmin: true
      },
      {
        email: 'user2@gmail.com',
        password: '123123',
        passwordConfirmation: '123123',
        isAdmin: false
      }
    ];

    class UsersSeeder extends Seeder {
      async shouldRun() {
        return User.countDocuments()
          .exec()
          .then(count => count === 0);
      }

      async run() {
        return User.create(data);
      }
    }

    export default UsersSeeder;

### md-seed-config.js

`md-seed` excepting to get 3 values from `md-seed-config.js`

1. `seedersList` - A key/value list of all your seeders, `md-seed` will run your seeders as they ordered in the list.
2. `connect` - Connect to mongodb implementation (should return promise).
3. `dropdb` - Drop/Clear the database implementation (should return promise).

#### Example

    import mongoose from 'mongoose';

    import Users from './seeders/users.seeder';
    import Posts from './seeders/posts.seeder';
    import Comments from './seeders/comments.seeder';

    const mongoURL = process.env.MONGO_URL || 'mongodb://localhost:27017/dbname';

    /**
     * Seeders List
     * order is important
     * @type {Object}
     */
    export const seedersList = {
      Users,
      Posts,
      Comments,
    };
    /**
     * Connect to mongodb implementation
     * @return {Promise}
     */
    export const connect = async () => await mongoose.connect(mongoURL, { useNewUrlParser: true });
    /**
     * Drop/Clear the database implementation
     * @return {Promise}
     */
    export const dropdb = async () => mongoose.connection.db.dropDatabase();

### Configurations

`mongoose-data-seed` configurations will get loaded from the `mdSeed` field in your `package.json` file.

Field | Default Value | Description
--- | --- | ---
`seedersFolder` | `'./seeders'` | Path for your seeders-folder, seeders will be generated into this folder.
`customSeederTemplate` | `undefined` | Path to a custom template file to generate your seeders from.

## Examples

1. md-seed-example

## License

MIT

# Contributing

Contributions are always welcome, no matter how large or small.

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

## Code of Conduct

By participating, you are expected to uphold this Contributor Covenant Code of Conduct. Please report unacceptable behavior to sharvita@gmail.com.

## Project setup

First, fork then clone the repo:

    git clone https://github.com/your-username/mongoose-data-seed
    cd mongoose-data-seed
    git remote add upstream https://github.com/sharvit/mongoose-data-seed

Install dependencies:

    yarn

Run test suits to validate the project is working:

    yarn test

Run linter to validate the project code:

    yarn lint
    # to fix linting errors
    yarn lint --fix

Run linter to validate your commit message:

    yarn lint:commit

## Committing and Pushing changes

Create a branch and start hacking:

    git checkout -b my-branch

Commit and push your changes:

`generator-node-mdl` uses commitizen to create commit messages so semantic-release can automatically create releases.

    git add .

    yarn commit
    # answer the questions

    git push origin my-branch

Open this project on GitHub, then click “Compare & pull request”.

## Help needed

Please watch the repo and respond to questions/bug reports/feature requests, Thanks!

# 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, gender identity and expression, level of experience, 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 sharvita@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, version 1.4, available at http://contributor-covenant.org/version/1/4