Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hiddentao/method-mocks
Works with existing mocking and testing frameworks (e.g. Jest) to make method mocking easier.
https://github.com/hiddentao/method-mocks
Last synced: 8 days ago
JSON representation
Works with existing mocking and testing frameworks (e.g. Jest) to make method mocking easier.
- Host: GitHub
- URL: https://github.com/hiddentao/method-mocks
- Owner: hiddentao
- License: mit
- Created: 2018-07-17T09:12:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-07-19T15:08:05.000Z (over 6 years ago)
- Last Synced: 2024-10-07T05:48:17.225Z (about 1 month ago)
- Language: JavaScript
- Size: 97.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# method-mocks
[](http://travis-ci.org/hiddentao/method-mocks)
[](https://codecov.io/gh/hiddentao/method-mocks)
[](https://twitter.com/hiddentao)
Works with existing mocking and testing frameworks (e.g. Jest) to make method mocking easier.
Example (testing a [React Native](https://facebook.github.io/react-native/docs/getting-started.html) API):
```js
// App.js
import { Alert } from 'react-native'
export const alertUser = msg => Alert.alert(msg)
```
```js
// App.test.js
import { alertUser } from './App'
// This will get hoisted to the top at runtime by Jest
jest.mock('react-native', () => ({
Alert: require('method-mocks').setupMethodMocks({
SOME_KEY: 1
})
}))
describe('.alertUser()', () => {
let mock
beforeEach(() => {
/* Even though we're mocking an external module we're able to set the
mock for a given method on each iteration */
mock = Alert.setMethodMock('alert', jest.fn())
})
afterEach(() => {
/* clean-up! */
Alert.clearAllMethodMocks()
})
it('calls through to native alert', () => {
alertUser('test')
expect(mock).toHaveBeenCalledWith('test')
})
})
```
## Installation
```shell
npm i method-mocks
```
## API/Usage
**setupMethodMocks(obj)**
This will add the following methods to the passed-in object:
```js
{
/**
* Create a method of the given name and set it to be the given mock function.
*
* If method already exists then it's existing value will be saved prior to
* being overwritten with the given mock.
*
* @param {String} methodName The name of the method to mock.
* @param {Function} mockFn The mock function.
*
* @return the mock function
*/
setMethodMock: (methodName, mockFn),
/**
* Remove mocked method of the given name.
*
* If the method had already existed prior to getting mocked then this
* original implementation will be restored, else the method will be deleted.
*
* @param {String} methodName The name of the method.
*/
clearMethodMock: (methodName),
/**
* Remove all mocked methods.
*
* This is equivalent to calling `clearMethodMock()` for each mocked method,
* one-by-one.
*/
clearAllMethodMocks: ()
}
```
The return value will be the original object itself.
## Development
* Lint: `yarn lint`
* Test: `yarn test`
* Build: `yarn build`
## Contributors
All contributions welcome. Please see [CONTRIBUTING.md](https://github.com/hiddentao/method-mocks/raw/master/CCONTRIBUTING.md)
## License
[MIT](https://github.com/hiddentao/method-mocks/raw/master/LICENSE.md)