Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/denisraslov/grunt-mocker
Generating jquery mockjax mocks for RESTful services
https://github.com/denisraslov/grunt-mocker
Last synced: about 1 month ago
JSON representation
Generating jquery mockjax mocks for RESTful services
- Host: GitHub
- URL: https://github.com/denisraslov/grunt-mocker
- Owner: denisraslov
- License: mit
- Created: 2015-03-23T11:22:58.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-03-11T11:45:09.000Z (almost 9 years ago)
- Last Synced: 2024-11-16T10:45:52.843Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grunt-mocker
> Generating jquery mockjax mocks for RESTful services
## Why
Because I can.
## Getting Started
This plugin requires Grunt `~0.4.5`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-mocker --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-mocker');
```
## The "mocker" task
### Overview
In your project's Gruntfile, add a section named `mocker` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
mocker: {
options: {
// Task-specific options go here.
},
},
});
```
### Options
#### options.template
Type: `String`
A path to the file with template of mocks (see template format below).
#### options.dest
Type: `String`
A path to the folder where mocks files will created in.
### Template Format
```js
[
{
entity: {entity_name},
count: {count},
data:
{
{field_name}: {FieldType}
}
},
]
```
## FieldType
#### Primitive values
`String`, `NumberInt`, `NumberFloat`, `Boolean`, `Date`.
It will be generated random value with according type.
#### Values set
Use an array of allowable values to make mocker take random element from it.
For example:
```js
"sortDirection": ["ASC", "DESC", "NONE"]
```
#### References to another entities
If an entity must refer to another entity, use following syntax:
`*{referred_entity_name}` - reference to `referred_entity_name`, it will taken random element of generated `referred_entity_name`.
`*{referred_entity_name}.id` - the same to previous but the only `id` of `referred_entity_name` element will taken.
`[{count}]{referred_entity_name}` - array (with the according length) of references to `referred_entity_name` elements, it will taken random elements of generated `referred entity name`-entities.
`[{count}]{referred_entity_name}.id` - the same to previous but the only `id` of `referred_entity_name` elements will taken.
For example:
```js
{
"entity": "computer",
{
"user": "*users",
"userId": "*users.id",
"users": "[5]users",
"userIds": "[5]users.id"
}
}
```
### Usage Examples
#### Template
```js
[
{
"entity": "products",
"count": 3,
"data":
{
"name": "String",
"price": "NumberFloat",
"crearedAt": "Date",
"sortDirection": ["ACS", "DESC", "NONE"],
"groupId": "*groups.id"
}
},
{
"entity": "groups",
"count": 3,
"data":
{
"name": "String",
"open": "Boolean"
}
},
{
"entity": "user",
"count": 2,
"data":
{
"firstName": "String",
"lastName": "String",
"groupIds" "[2]groups.id"
}
}
]
```
#### Result
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
## Release History
_(Nothing yet)_