@stdlib/random-streams-levy-cli 0.1.0

package/bin/cli

@@ -0,0 +1,194 @@
+#!/usr/bin/env node
+
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var proc = require( 'process' );
+var resolve = require( 'path' ).resolve;
+var readFileSync = require( '@stdlib/fs-read-file' ).sync;
+var writeFileSync = require( '@stdlib/fs-write-file' ).sync;
+var CLI = require( '@stdlib/cli-ctor' );
+var stdout = require( '@stdlib/streams-node-stdout' );
+var cwd = require( '@stdlib/process-cwd' );
+var Uint8Array = require( '@stdlib/array-uint8' );
+var Uint32Array = require( '@stdlib/array-uint32' );
+var isUint8Array = require( '@stdlib/assert-is-uint8array' );
+var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;
+var gcopy = require( '@stdlib/blas-base-gcopy' );
+var array2buffer = require( '@stdlib/buffer-from-array' );
+var randomStream = require( '@stdlib/random-streams-levy' );
+
+
+// FUNCTIONS //
+
+/**
+* Callback invoked once a source stream ends.
+*
+* @private
+*/
+function onEnd() {
+	// Append a trailing newline in accordance with standard POSIX behavior:
+	console.log( '' ); // eslint-disable-line no-console
+}
+
+/**
+* Attempts to load a PRNG state.
+*
+* @private
+* @param {string} filepath - absolute path to file containing PRNG state
+* @returns {(Uint32Array|Error)} PRNG state or an error
+*/
+function loadState( filepath ) {
+	var state;
+	var len;
+
+	state = readFileSync( filepath );
+	if ( state instanceof Error ) {
+		return state;
+	}
+	len = state.length;
+
+	// For older Node.js environments, convert the `Buffer` to a `Uint8Array`...
+	if ( !isUint8Array( state ) ) {
+		state = gcopy( len, state, 1, new Uint8Array( len ), 1 );
+	}
+	// Create a PRNG state array "view":
+	len /= Uint32Array.BYTES_PER_ELEMENT;
+	if ( !isInteger( len ) ) {
+		return new RangeError( 'invalid option. `state` has an invalid length.' );
+	}
+	return new Uint32Array( state.buffer, state.byteOffset, len );
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+* @returns {void}
+*/
+function main() {
+	var stream;
+	var flags;
+	var opts;
+	var args;
+	var cli;
+	var err;
+	var dir;
+	var i;
+
+	// Create a command-line interface:
+	cli = new CLI({
+		'pkg': require( './../package.json' ),
+		'options': require( './../etc/cli_opts.json' ),
+		'help': readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
+			'encoding': 'utf8'
+		})
+	});
+
+	// Get any provided command-line options:
+	flags = cli.flags();
+	if ( flags.help || flags.version ) {
+		return;
+	}
+
+	// Get the current working directory:
+	dir = cwd();
+
+	// Get any provided command-line arguments:
+	args = cli.args();
+	if ( args.length < 2 ) {
+		err = new Error( 'insufficient arguments. Must provide distribution parameters.' );
+		return onError( err );
+	}
+	args[ 0 ] = parseFloat( args[ 0 ] );
+	args[ 1 ] = parseFloat( args[ 1 ] );
+
+	opts = {};
+	if ( flags.iter ) {
+		opts.iter = parseInt( flags.iter, 10 );
+	}
+	if ( flags.sep ) {
+		opts.sep = flags.sep;
+	}
+	if ( flags.state ) {
+		opts.state = loadState( resolve( dir, flags.state ) );
+		if ( opts.state instanceof Error ) {
+			return onError( opts.state );
+		}
+	} else if ( flags.seed ) {
+		opts.seed = flags.seed.split( ',' );
+		for ( i = 0; i < opts.seed.length; i++ ) {
+			opts.seed[ i ] = parseInt( opts.seed[ i ], 10 );
+		}
+	}
+	if ( flags.snapshot ) {
+		proc.on( 'exit', onExit );
+	}
+
+	// Create a source stream and pipe to `stdout`:
+	stream = randomStream( args[ 0 ], args[ 1 ], opts );
+	stream.on( 'end', onEnd );
+
+	stream.pipe( stdout );
+
+	/**
+	* Callback invoked upon exiting the process.
+	*
+	* @private
+	* @param {integer} code - exit code
+	*/
+	function onExit( code ) {
+		var state;
+		var err;
+
+		// Get the current PRNG state:
+		state = stream.state;
+
+		// Create a byte array "view":
+		state = new Uint8Array( state.buffer, state.byteOffset, stream.byteLength ); // eslint-disable-line max-len
+
+		// Convert the byte array to a `Buffer` (with support for older Node.js environments):
+		state = array2buffer( state );
+
+		// Attempt to write the state to file:
+		err = writeFileSync( resolve( dir, flags.snapshot ), state );
+		if ( err ) {
+			onError( err, code || 1 );
+		}
+	}
+
+	/**
+	* Callback invoked upon encountering an error.
+	*
+	* @private
+	* @param {Error} error - error
+	* @param {integer} [code] - exit code
+	*/
+	function onError( error, code ) {
+		cli.error( error, code || 1 );
+	}
+}
+
+main();

package/docs/usage.txt

@@ -0,0 +1,15 @@
+
+Usage: random-levy [options] <mu> <c>
+
+Options:
+
+  -h,  --help               Print this message.
+  -V,  --version            Print the package version.
+       --sep sep            Separator used to join streamed data. Default: '\n'.
+  -n,  --iter iterations    Number of pseudorandom numbers.
+       --seed seed          Pseudorandom number generator seed.
+       --state filepath     Path to a file containing the pseudorandom number
+                            generator state.
+       --snapshot filepath  Output file path for saving the pseudorandom number
+                            generator state upon exit.
+

package/etc/cli_opts.json

@@ -0,0 +1,24 @@
+{
+	"string": [
+		"sep",
+		"iter",
+		"state",
+		"seed",
+		"snapshot"
+	],
+	"boolean": [
+		"help",
+		"version"
+	],
+	"alias": {
+		"help": [
+			"h"
+		],
+		"version": [
+			"V"
+		],
+		"iter": [
+			"n"
+		]
+	}
+}

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@stdlib/random-streams-levy-cli",
+  "version": "0.1.0",
+  "description": "Create a readable stream for generating pseudorandom numbers drawn from a Lévy distribution.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "bin": {
+    "random-levy": "./bin/cli"
+  },
+  "homepage": "https://stdlib.io",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/random-streams-levy.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {
+    "@stdlib/array-uint32": "^0.1.0",
+    "@stdlib/array-uint8": "^0.1.0",
+    "@stdlib/assert-is-integer": "^0.1.0",
+    "@stdlib/assert-is-uint8array": "^0.1.0",
+    "@stdlib/blas-base-gcopy": "^0.1.0",
+    "@stdlib/buffer-from-array": "^0.1.0",
+    "@stdlib/cli-ctor": "^0.1.0",
+    "@stdlib/fs-read-file": "^0.1.0",
+    "@stdlib/fs-write-file": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/process-cwd": "^0.1.0",
+    "@stdlib/random-base-levy": "^0.1.0",
+    "@stdlib/streams-node-stdout": "^0.1.0",
+    "@stdlib/random-streams-levy": "0.1.0"
+  },
+  "devDependencies": {
+    "@stdlib/assert-is-browser": "^0.1.0",
+    "@stdlib/assert-is-windows": "^0.1.0",
+    "@stdlib/fs-exists": "^0.1.0",
+    "@stdlib/fs-unlink": "^0.1.0",
+    "@stdlib/process-exec-path": "^0.1.0",
+    "@stdlib/string-replace": "^0.1.0",
+    "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
+    "proxyquire": "^2.0.0",
+    "istanbul": "^0.4.1",
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
+  },
+  "keywords": [
+    "stdlib",
+    "stdmath",
+    "mathematics",
+    "math",
+    "statistics",
+    "stats",
+    "prng",
+    "rng",
+    "pseudorandom",
+    "random",
+    "rand",
+    "levy",
+    "continuous",
+    "readable",
+    "stream",
+    "seed",
+    "seedable"
+  ],
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
+  }
+}

package/test/fixtures/write_error.js.txt

@@ -0,0 +1,41 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+var proc = require( 'process' );
+var resolve = require( 'path' ).resolve;
+var proxyquire = require( 'proxyquire' );
+
+var fpath = resolve( __dirname, '..', 'bin', 'cli' );
+
+proc.stdin.isTTY = true;
+proc.argv[ 2 ] = 2.0;
+proc.argv[ 3 ] = 5.0;
+proc.argv[ 4 ] = '--iter';
+proc.argv[ 5 ] = '10';
+proc.argv[ 6 ] = '--snapshot';
+proc.argv[ 7 ] = resolve( __dirname, 'fixtures', 'tmp_state.txt' );
+
+proxyquire( fpath, {
+	'@stdlib/fs-write-file': {
+		'sync': writeFile
+	}
+});
+
+function writeFile() {
+	return new Error( 'beep' );
+}