commit example library

Author: Tane Piper

.eslintrc.json

@@ -0,0 +1,31 @@
+{
+  "root": true,
+  "ignorePatterns": ["**/*"],
+  "plugins": ["@nrwl/nx"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {
+        "@nrwl/nx/enforce-module-boundaries": [
+          "error",
+          {
+            "enforceBuildableLibDependency": true,
+            "allow": [],
+            "depConstraints": [{ "sourceTag": "*", "onlyDependOnLibsWithTags": ["*"] }]
+          }
+        ]
+      }
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "extends": ["plugin:@nrwl/nx/typescript"],
+      "parserOptions": { "project": "./tsconfig.*?.json" },
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "extends": ["plugin:@nrwl/nx/javascript"],
+      "rules": {}
+    }
+  ]
+}

.gitignore

@@ -37,3 +37,4 @@ testem.log
 # System Files
 .DS_Store
 Thumbs.db
+/docs/

.prettierignore

@@ -2,3 +2,4 @@
 
 /dist
 /coverage
+/docs

.prettierrc

@@ -1,3 +1,5 @@
 {
-  "singleQuote": true
+  "singleQuote": true,
+  "printWidth": 120,
+  "trailingComma": "all"
 }

.vscode/extensions.json

@@ -1,6 +1,7 @@
 {
   "recommendations": [
     "ms-vscode.vscode-typescript-tslint-plugin",
-    "esbenp.prettier-vscode"
+    "esbenp.prettier-vscode",
+    "firsttris.vscode-jest-runner"
   ]
 }

babel.config.json

@@ -0,0 +1,4 @@
+{
+  "presets": ["@nrwl/web/babel"],
+  "babelrcRoots": ["*"]
+}

jest.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  projects: ['<rootDir>/libs/rxjs/example-lib'],
+};

jest.preset.js

@@ -0,0 +1,3 @@
+const nxPreset = require('@nrwl/jest/preset');
+
+module.exports = { ...nxPreset };

libs/rxjs/example-lib/.babelrc

@@ -0,0 +1,4 @@
+{
+  "presets": ["@nrwl/web/babel"],
+  "plugins": []
+}

libs/rxjs/example-lib/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+  "extends": "../../../.eslintrc.json",
+  "ignorePatterns": ["!**/*"],
+  "rules": {}
+}

libs/rxjs/example-lib/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- `fizzBuzz` operator that will return a [FizzBuzz](https://en.wikipedia.org/wiki/Fizz_buzz) based
+  on an observable stream of integer numbers.

libs/rxjs/example-lib/README.md

@@ -0,0 +1,7 @@
+# rxjs-example-lib
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test rxjs-example-lib` to execute the unit tests via [Jest](https://jestjs.io).

libs/rxjs/example-lib/jest.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  displayName: 'rxjs-example-lib',
+  preset: '../../../jest.preset.js',
+  globals: {
+    'ts-jest': {
+      tsConfig: '<rootDir>/tsconfig.spec.json',
+    },
+  },
+  transform: {
+    '^.+\\.[tj]sx?$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+  coverageDirectory: '../../../coverage/libs/rxjs/example-lib',
+};

libs/rxjs/example-lib/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@rxjs-ninja/example-lib",
+  "description": "An example of an RxJS Typescript library for the web",
+  "version": "0.0.1",
+  "keywords": [
+    "Rx",
+    "RxJS",
+    "ReactiveX",
+    "ReactiveExtensions",
+    "Streams",
+    "Observables",
+    "Observable",
+    "Stream",
+    "Typescript",
+    "Reactive",
+    "Utility",
+    "FizzBuzz"
+  ],
+  "homepage": "https://rxjs.ninja",
+  "bugs": {
+    "url": "https://github.com/rxjs-ninja/nx-library-starter/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Tane Piper",
+    "url": "https://tane.dev"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rxjs-ninja/nx-library-starter.git"
+  },
+  "peerDependencies": {
+    "@rxjs-ninja/rxjs-utility": "~2.1.2",
+    "rxjs": ">=6.5.0"
+  }
+}

libs/rxjs/example-lib/src/index.ts

@@ -0,0 +1,8 @@
+/**
+ * @packageDocumentation
+ * @module array
+ * @ignore
+ */
+/* istanbul ignore file */
+export { fizzbuzz } from './lib/fizzbuzz';
+export { fromFizzbuzz } from './lib/from-fizzbuzz';

libs/rxjs/example-lib/src/lib/fizzbuzz.spec.ts

@@ -0,0 +1,15 @@
+import { marbles } from 'rxjs-marbles/jest';
+import { fizzbuzz } from '@rxjs-ninja/example-lib';
+
+describe('fizzbuzz', () => {
+  it(
+    'should return Fizz for 3, Buzz for 5, FizzBuzz for 15 or number if any other number',
+    marbles((m) => {
+      const input = m.hot('-a-b-c-d-e-f-g-|', { a: 1, b: 2, c: 3, d: 4, e: 5, f: 15, g: 16 });
+      const subs = '^--------------!';
+      const expected = m.cold('-t-u-v-w-x-y-z-|', { t: 1, u: 2, v: 'Fizz', w: 4, x: 'Buzz', y: 'FizzBuzz', z: 16 });
+      m.expect(input.pipe(fizzbuzz())).toBeObservable(expected);
+      m.expect(input).toHaveSubscriptions(subs);
+    }),
+  );
+});

libs/rxjs/example-lib/src/lib/fizzbuzz.ts

@@ -0,0 +1,31 @@
+/**
+ * @packageDocumentation
+ * @module fizzbuzz
+ */
+import { Observable, OperatorFunction } from 'rxjs';
+import { mapIfSource } from '@rxjs-ninja/rxjs-utility';
+
+/**
+ * The `fizzBuzz` operator takes an observable source of numbers and returns
+ * either the number, or if the number is a modulus of `3, 5 and 15` it will instead return `Fizz`,
+ * `Buzz` or `FizzBuzz`
+ *
+ * @example
+ * ```ts
+ * timer(1000).pipe(fizzbuzz()).subscribe()
+ * // 1, 2, Fizz, 4, Buzz, Fizz, 7, 8, Fizz, Buzz, 11, Fizz, 13, 14, Fizz Buzz
+ * ```
+ *
+ * @returns Observable of a FizzBuzz sequence of numbers
+ * @category Fizzbuzz Operators
+ */
+export function fizzbuzz(): OperatorFunction<number, string | number> {
+  return (source: Observable<number>) =>
+    source.pipe(
+      mapIfSource<number, string, number>(
+        (value) => value % 15 == 0 || value % 3 == 0 || value % 5 == 0,
+        (value) => (value % 15 == 0 ? `FizzBuzz` : value % 3 === 0 ? 'Fizz' : 'Buzz'),
+        (value) => value,
+      ),
+    );
+}

libs/rxjs/example-lib/src/lib/from-fizzbuzz.spec.ts

@@ -0,0 +1,24 @@
+import { observe } from 'rxjs-marbles/jest';
+import { reduce, tap } from 'rxjs/operators';
+import { fromFizzbuzz } from '@rxjs-ninja/example-lib';
+
+describe('fromFizzbuzz', () => {
+  it(
+    'should create observable fibonacci sequence number up to the max number of iterations',
+    observe(() =>
+      fromFizzbuzz(20, 0).pipe(
+        reduce(
+          (acc, val) =>
+            typeof val === 'number'
+              ? { ...acc, number: [...acc.number, val] }
+              : {
+                  ...acc,
+                  string: [...acc.string, val],
+                },
+          { number: [], string: [] },
+        ),
+        tap((value) => expect(value.string).toHaveLength(8)),
+      ),
+    ),
+  );
+});

libs/rxjs/example-lib/src/lib/from-fizzbuzz.ts

@@ -0,0 +1,42 @@
+/**
+ * @packageDocumentation
+ * @module fizzbuzz
+ */
+
+import { Observable, Subscriber, timer } from 'rxjs';
+import { finalize, skip, takeWhile, tap } from 'rxjs/operators';
+import { mapIfSource } from '@rxjs-ninja/rxjs-utility';
+
+/**
+ * The `fromFizzbuzz` operator is used to create an observable [FizzBuzz](https://en.wikipedia.org/wiki/Fizz_buzz)
+ * sequence.
+ *
+ * @param iterations The number of iterations to emit
+ * @param emitDelay If set the observable will emit per millisecond set, by default this is 0
+ *
+ * @example
+ * ```ts
+ * fromFizzbuzz(15).pipe(tap(console.log)).subscribe()
+ * // 1, 2, Fizz, 4, Buzz, Fizz, 7, 8, Fizz, Buzz, 11, Fizz, 13, 14, Fizz Buzz
+ * ```
+ *
+ * @returns Observable of a FizzBuzz sequence of numbers
+ * @category Fizzbuzz Observables
+ */
+export function fromFizzbuzz(iterations: number, emitDelay = 0): Observable<string | number> {
+  return new Observable((subscriber: Subscriber<number>) => {
+    timer(0, emitDelay)
+      .pipe(
+        takeWhile((value) => !subscriber.closed && value < iterations),
+        skip(1),
+        mapIfSource<number, string, number>(
+          (value) => value % 15 == 0 || value % 3 == 0 || value % 5 == 0,
+          (value) => (value % 15 == 0 ? `FizzBuzz` : value % 3 === 0 ? 'Fizz' : 'Buzz'),
+          (value) => value,
+        ),
+        tap((value) => subscriber.next(value as any)),
+        finalize(() => subscriber.complete()),
+      )
+      .subscribe();
+  });
+}

libs/rxjs/example-lib/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

libs/rxjs/example-lib/tsconfig.lib.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "es2015",
+    "outDir": "../../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "exclude": ["**/*.spec.ts"],
+  "include": ["**/*.ts"]
+}

libs/rxjs/example-lib/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": ["**/*.spec.ts", "**/*.spec.tsx", "**/*.spec.js", "**/*.spec.jsx", "**/*.d.ts"]
+}

nx.json

@@ -22,5 +22,9 @@
       }
     }
   },
-  "projects": {}
+  "projects": {
+    "rxjs-example-lib": {
+      "tags": []
+    }
+  }
 }