-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
tunnckoCore
committed
Oct 4, 2015
1 parent
1d79b67
commit debf414
Showing
10 changed files
with
323 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# .editorconfig <https://github.com/tunnckoCore/dotfiles> | ||
# | ||
# Copyright (c) 2015 Charlike Mike Reagent, contributors. | ||
# Released under the MIT license. | ||
# | ||
|
||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
end_of_line = lf | ||
indent_size = 2 | ||
indent_style = space | ||
|
||
[*.js] | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
[*.php] | ||
indent_size = 4 | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
[*.md] | ||
insert_final_newline = false | ||
trim_trailing_whitespace = false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# .gitignore <https://github.com/tunnckoCore/dotfiles> | ||
# | ||
# Copyright (c) 2015 Charlike Mike Reagent, contributors. | ||
# Released under the MIT license. | ||
# | ||
|
||
# Always-ignore dirs # | ||
# #################### | ||
_gh_pages | ||
node_modules | ||
bower_components | ||
components | ||
vendor | ||
build | ||
dest | ||
dist | ||
src | ||
lib-cov | ||
coverage | ||
nbproject | ||
cache | ||
temp | ||
tmp | ||
always-generator | ||
|
||
# Packages # | ||
# ########## | ||
*.7z | ||
*.dmg | ||
*.gz | ||
*.iso | ||
*.jar | ||
*.rar | ||
*.tar | ||
*.zip | ||
|
||
# OS, Logs and databases # | ||
# ######################### | ||
*.pid | ||
*.dat | ||
*.log | ||
*.sql | ||
*.sqlite | ||
*~ | ||
~* | ||
|
||
# Another files # | ||
# ############### | ||
Icon? | ||
.DS_Store* | ||
Thumbs.db | ||
ehthumbs.db | ||
Desktop.ini | ||
npm-debug.log | ||
.directory | ||
._* | ||
lcov.info |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
language: "node_js" | ||
sudo: false | ||
|
||
node_js: | ||
- "0.12" | ||
- "4" | ||
|
||
notifications: | ||
email: | ||
on_success: never | ||
on_failure: never | ||
|
||
before_script: | ||
- npm install standard | ||
- standard | ||
|
||
script: | ||
- npm install istanbul-harmony | ||
- node --harmony node_modules/.bin/istanbul cover test.js | ||
|
||
after_success: | ||
- npm install coveralls | ||
- cat coverage/lcov.info | coveralls |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
|
||
|
||
## 0.0.0 - 2015-10-05 | ||
- Initial commit |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Contributing Guidelines | ||
|
||
Contributions are always welcome! | ||
|
||
**Before spending lots of time on something, ask for feedback on your idea first!** | ||
|
||
Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations. | ||
|
||
|
||
## Installing | ||
|
||
Fork and clone the repo, then `npm install` to install all dependencies and `npm test` to ensure all is okey before you start anything. | ||
|
||
|
||
## Testing | ||
|
||
Tests are run with `npm test`. Please ensure all tests are passing before submitting a pull request (unless you're creating a failing test to increase test coverage or show a problem). | ||
|
||
## Code Style | ||
|
||
[![standard][standard-image]][standard-url] | ||
|
||
This repository uses [`standard`][standard-url] to maintain code style and consistency, and to avoid style arguments. You are encouraged to install it globally. `npm test` runs `standard` so you don't have to! | ||
|
||
``` | ||
npm i standard -g | ||
``` | ||
|
||
It is intentional to don't have `standard`, `istanbul` and `coveralls` in the devDependencies. Travis will handle all that stuffs. That approach will save bandwidth also installing and development time. | ||
|
||
[standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg | ||
[standard-url]: https://github.com/feross/standard |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,74 @@ | ||
# always-generator | ||
Generatorify, basically, everything. You can create generator function from callback-style or synchronous function; sync function that returns child process, stream or observable; directly passed promise, stream or child process. | ||
# [always-generator][author-www-url] [![npmjs.com][npmjs-img]][npmjs-url] [![The MIT License][license-img]][license-url] | ||
|
||
> Generatorify, basically, everything. You can create generator function from callback-style or synchronous function; sync function that returns child process, stream or observable; directly passed promise, stream or child process. | ||
[![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url] | ||
|
||
|
||
## Install | ||
``` | ||
npm i always-generator --save | ||
``` | ||
|
||
|
||
## Usage | ||
> For more use-cases see the [tests](./test.js) | ||
```js | ||
var alwaysGenerator = require('always-generator') | ||
``` | ||
|
||
|
||
## Contributing | ||
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/hybridables/always-generator/issues/new). | ||
But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines. | ||
|
||
|
||
## [Charlike Make Reagent](http://j.mp/1stW47C) [![new message to charlike][new-message-img]][new-message-url] [![freenode #charlike][freenode-img]][freenode-url] | ||
|
||
[![tunnckocore.tk][author-www-img]][author-www-url] [![keybase tunnckocore][keybase-img]][keybase-url] [![tunnckoCore npm][author-npm-img]][author-npm-url] [![tunnckoCore twitter][author-twitter-img]][author-twitter-url] [![tunnckoCore github][author-github-img]][author-github-url] | ||
|
||
|
||
[npmjs-url]: https://www.npmjs.com/package/always-generator | ||
[npmjs-img]: https://img.shields.io/npm/v/always-generator.svg?label=always-generator | ||
|
||
[license-url]: https://github.com/hybridables/always-generator/blob/master/LICENSE.md | ||
[license-img]: https://img.shields.io/badge/license-MIT-blue.svg | ||
|
||
|
||
[codeclimate-url]: https://codeclimate.com/github/hybridables/always-generator | ||
[codeclimate-img]: https://img.shields.io/codeclimate/github/hybridables/always-generator.svg | ||
|
||
[travis-url]: https://travis-ci.org/hybridables/always-generator | ||
[travis-img]: https://img.shields.io/travis/hybridables/always-generator.svg | ||
|
||
[coveralls-url]: https://coveralls.io/r/hybridables/always-generator | ||
[coveralls-img]: https://img.shields.io/coveralls/hybridables/always-generator.svg | ||
|
||
[david-url]: https://david-dm.org/hybridables/always-generator | ||
[david-img]: https://img.shields.io/david/hybridables/always-generator.svg | ||
|
||
[standard-url]: https://github.com/feross/standard | ||
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg | ||
|
||
|
||
[author-www-url]: http://www.tunnckocore.tk | ||
[author-www-img]: https://img.shields.io/badge/www-tunnckocore.tk-fe7d37.svg | ||
|
||
[keybase-url]: https://keybase.io/tunnckocore | ||
[keybase-img]: https://img.shields.io/badge/keybase-tunnckocore-8a7967.svg | ||
|
||
[author-npm-url]: https://www.npmjs.com/~tunnckocore | ||
[author-npm-img]: https://img.shields.io/badge/npm-~tunnckocore-cb3837.svg | ||
|
||
[author-twitter-url]: https://twitter.com/tunnckoCore | ||
[author-twitter-img]: https://img.shields.io/badge/twitter-@tunnckoCore-55acee.svg | ||
|
||
[author-github-url]: https://github.com/tunnckoCore | ||
[author-github-img]: https://img.shields.io/badge/github-@tunnckoCore-4183c4.svg | ||
|
||
[freenode-url]: http://webchat.freenode.net/?channels=charlike | ||
[freenode-img]: https://img.shields.io/badge/freenode-%23charlike-5654a4.svg | ||
|
||
[new-message-url]: https://github.com/tunnckoCore/ama | ||
[new-message-img]: https://img.shields.io/badge/ask%20me-anything-green.svg |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
/*! | ||
* always-generator <https://github.com/hybridables/always-generator> | ||
* | ||
* Copyright (c) 2015 Charlike Mike Reagent <@tunnckoCore> (http://www.tunnckocore.tk) | ||
* Released under the MIT license. | ||
*/ | ||
|
||
'use strict' | ||
|
||
module.exports = function alwaysGenerator (val) { | ||
var self = this | ||
return function generatorify () { | ||
var ctx = self || this | ||
var args = require('sliced')(arguments) | ||
return function * alwaysGeneratorFunction () { | ||
return require('always-promise').call(ctx, val).apply(ctx, args) | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
{ | ||
"name": "always-generator", | ||
"version": "0.0.0", | ||
"description": "Generatorify, basically, everything. You can create generator function from callback-style or synchronous function; sync function that returns child process, stream or observable; directly passed promise, stream or child process.", | ||
"repository": "hybridables/always-generator", | ||
"author": "Charlike Mike Reagent <@tunnckoCore> (http://www.tunnckocore.tk)", | ||
"main": "index.js", | ||
"license": "MIT", | ||
"scripts": { | ||
"test": "standard && node test.js" | ||
}, | ||
"dependencies": { | ||
"always-promise": "^1.1.1", | ||
"sliced": "^1.0.1" | ||
}, | ||
"devDependencies": { | ||
"assertit": "^0.1.0", | ||
"is-es6-generator-function": "^1.0.0", | ||
"voa": "^0.1.1" | ||
}, | ||
"files": [ | ||
"index.js" | ||
], | ||
"keywords": [ | ||
"async", | ||
"asynchronous", | ||
"callback", | ||
"child", | ||
"fn", | ||
"func", | ||
"function", | ||
"gen", | ||
"generator", | ||
"process", | ||
"promise", | ||
"stream", | ||
"sync", | ||
"synchronous" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
/*! | ||
* always-generator <https://github.com/hybridables/always-generator> | ||
* | ||
* Copyright (c) 2015 Charlike Mike Reagent <@tunnckoCore> (http://www.tunnckocore.tk) | ||
* Released under the MIT license. | ||
*/ | ||
|
||
/* jshint asi:true */ | ||
|
||
'use strict' | ||
|
||
var fs = require('fs') | ||
var voa = require('voa') | ||
var test = require('assertit') | ||
var isGenFn = require('is-es6-generator-function') | ||
var alwaysGenerator = require('./index') | ||
|
||
test('should transfrom fs.readFileSync to function which returns generator fn', function (done) { | ||
var readFileSync = alwaysGenerator(fs.readFileSync) | ||
var gen = readFileSync('./package.json', 'utf8') | ||
test.strictEqual(typeof readFileSync, 'function') | ||
test.strictEqual(isGenFn(gen), true) | ||
done() | ||
}) | ||
|
||
test('should transfrom fs.readFile to function which returns generator fn', function (done) { | ||
var readFileAsync = alwaysGenerator(fs.readFile) | ||
var gen = readFileAsync('./package.json', 'utf8') | ||
test.strictEqual(typeof readFileAsync, 'function') | ||
test.strictEqual(isGenFn(gen), true) | ||
done() | ||
}) | ||
|
||
test('should return result when yield generator function', function (done) { | ||
var readFile = alwaysGenerator(fs.readFile) | ||
|
||
voa(function * () { | ||
var res = yield readFile('./package.json', 'utf8') | ||
test.ok(res.indexOf('"license": "MIT"') !== -1) | ||
return res | ||
}).then(function (res) { | ||
test.ok(res.indexOf('"license": "MIT"') !== -1) | ||
done() | ||
}, done) | ||
}) | ||
|