Merge pull request #1 from fluture-js/avaq/everything

Add everything

Author: Avaq

.config

@@ -0,0 +1,5 @@
+author-name = Aldwin Vlasblom
+repo-owner = fluture-js
+repo-name = fluture-node
+source-files = index.mjs
+opening-delimiter = ```js

.eslintrc.json

@@ -0,0 +1,16 @@
+{
+  "root": true,
+  "extends": ["./node_modules/sanctuary-style/eslint-es6.json"],
+  "overrides": [
+    {
+      "files": ["README.md"],
+      "globals": {
+        "EventEmitter": "readonly",
+        "Future": "readonly",
+        "Readable": "readonly",
+        "buffer": "readonly",
+        "once": "readonly"
+      }
+    }
+  ]
+}

.gitignore

@@ -0,0 +1,3 @@
+/coverage/
+/index.js
+/node_modules/

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.travis.yml

@@ -0,0 +1,4 @@
+language: node_js
+node_js:
+  - "11"
+after_success: npm run codecov

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contribution Guideline
+
+## Making a contribution
+
+1. Fork the repo if you do not have write access
+1. Clone the remote (fork) from GitHub
+1. Create a branch named `<yourgithubusername>/<yourfeature>`
+1. Make one or more atomic commits
+1. Make sure the tests pass locally
+1. Create a pull-request on GitHub
+
+## Publishing a new version
+
+1. Make sure you have write access to the module on npm
+1. Make sure you have write access to the master branch on GitHub
+1. Checkout `master` and make sure it's up to date with the remote
+1. Run `npm run release <level>`, where `<level>` can be any of: 'major',
+   'minor', 'patch', 'premajor', 'preminor', 'prepatch', or 'prerelease'.

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2019 Aldwin Vlasblom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

index.mjs

@@ -0,0 +1,80 @@
+//. # Fluture Node
+//.
+//. Common Node API's wrapped to return [Fluture][] Futures.
+//.
+//. ## API
+
+import Future from 'fluture';
+
+//# once :: String -> EventEmitter -> Future Error a
+//.
+//. Resolve a Future with the first event emitted over
+//. the given event emitter under the given event name.
+//.
+//. When the Future is cancelled, it removes any trace of
+//. itself from the event emitter.
+//.
+//. ```js
+//. > const emitter = new EventEmitter ();
+//. > setTimeout (() => emitter.emit ('answer', 42), 100);
+//. > once ('answer') (emitter);
+//. Future.of (42);
+//. ```
+export const once = event => emitter => Future ((rej, res) => {
+  const removeListeners = () => {
+    emitter.removeListener ('error', onError);
+    emitter.removeListener (event, onEvent);
+  };
+  const onError = x => {
+    removeListeners ();
+    rej (x);
+  };
+  const onEvent = x => {
+    removeListeners ();
+    res (x);
+  };
+  emitter.once ('error', onError);
+  emitter.once (event, onEvent);
+  return removeListeners;
+});
+
+//# buffer :: ReadableStream a -> Future Error (Array a)
+//.
+//. Buffer all data on a Stream into a Future of an Array.
+//.
+//. When the Future is cancelled, it removes any trace of
+//. itself from the Stream.
+//.
+//. ```js
+//. > const stream = new Readable ({read: () => {}});
+//. > setTimeout (() => {
+//. .   stream.push ('hello');
+//. .   stream.push ('world');
+//. .   stream.push (null);
+//. . }, 100);
+//. > buffer (stream);
+//. Future.of ([Buffer.from ('hello'), Buffer.from ('world')]);
+//. ```
+export const buffer = stream => Future ((rej, res) => {
+  const chunks = [];
+  const removeListeners = () => {
+    stream.removeListener ('data', onData);
+    stream.removeListener ('error', rej);
+    stream.removeListener ('end', onEnd);
+  };
+  const onData = d => chunks.push (d);
+  const onEnd = () => {
+    removeListeners ();
+    res (chunks);
+  };
+  const onError = e => {
+    removeListeners ();
+    rej (e);
+  };
+  stream.on ('data', onData);
+  stream.once ('error', onError);
+  stream.once ('end', onEnd);
+  return removeListeners;
+});
+
+//. [Fluture]: https://github.com/fluture-js/Fluture

package.json

@@ -0,0 +1,40 @@
+{
+  "name": "fluture-node",
+  "version": "0.0.0",
+  "description": "Common Node API's wrapped to return Fluture Futures",
+  "main": "index",
+  "module": "index.mjs",
+  "scripts": {
+    "build": "rollup -c rollup.config.mjs",
+    "codecov": "codecov",
+    "doctest": "sanctuary-doctest",
+    "lint": "sanctuary-lint",
+    "release": "sanctuary-release",
+    "test": "npm run lint && sanctuary-test && npm run doctest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/fluture-js/fluture-node.git"
+  },
+  "files": [
+    "/index.js",
+    "/index.mjs",
+    "/LICENSE",
+    "/package.json",
+    "/README.md"
+  ],
+  "author": "Aldwin Vlasblom <aldwin@avaq.it> (https://github.com/Avaq)",
+  "license": "MIT",
+  "dependencies": {},
+  "peerDependencies": {
+    "fluture": "*"
+  },
+  "devDependencies": {
+    "c8": "^3.4.0",
+    "codecov": "^3.2.0",
+    "fluture": "^11.0.1",
+    "oletus": "^1.1.5",
+    "rollup": "^1.1.2",
+    "sanctuary-scripts": "^3.1.1"
+  }
+}

rollup.config.mjs

@@ -0,0 +1,9 @@
+export default {
+  input: 'index.mjs',
+  external: ['fluture'],
+  output: {
+    format: 'cjs',
+    file: 'index.js',
+    interop: false,
+  },
+};