Initial commit.

Author: maoberlehner

.editorconfig

@@ -0,0 +1,14 @@
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,29 @@
+# Numerous always-ignore extensions
+*.diff
+*.err
+*.log
+*.orig
+*.rej
+*.swo
+*.swp
+*.vi
+*.zip
+*~
+
+# OS or Editor folders
+._*
+.cache
+.DS_Store
+.idea
+.project
+.settings
+.tmproj
+*.esproj
+*.sublime-project
+*.sublime-workspace
+nbproject
+Thumbs.db
+
+# Folders to ignore
+app
+node_modules

CONTRIBUTING.md

@@ -0,0 +1,47 @@
+## Reporting Issues
+Found a problem? Want a new feature?
+
+- See if your issue or idea has [already been reported].
+- Provide a [reduced test case] or a [live example].
+
+Remember, a bug is a *demonstrable problem* caused by *our* code.
+
+## Submitting Pull Requests
+Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits.
+
+1. To begin, [fork this project], clone your fork, and add our upstream.
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone https://github.com/<your-username>/typescript-database-abstraction
+   # Navigate to the newly cloned directory
+   cd typescript-database-abstraction
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://github.com/maoberlehner/typescript-database-abstraction
+   # Install the tools necessary for development
+   npm install
+   ```
+2. Create a branch for your feature or hotfix:
+   ```bash
+   # Move into a new branch for a feature
+   git checkout -b feature/thing
+   ```
+   ```bash
+   # Move into a new branch for a hotfix
+   git checkout -b hotfix/something
+   ```
+3. Push your branch up to your fork:
+   ```bash
+   # Push a feature branch
+   git push origin feature/thing
+   ```
+   ```bash
+   # Push a hotfix branch
+   git push origin hotfix/something
+   ```
+4. Now [open a pull request] with a clear title and description.
+
+[already been reported]: https://github.com/maoberlehner/typescript-database-abstraction/issues
+[fork this project]:     https://github.com/maoberlehner/typescript-database-abstraction/fork
+[live example]:          http://codepen.io/pen
+[open a pull request]:   https://help.github.com/articles/using-pull-requests/
+[reduced test case]:     https://css-tricks.com/reduced-test-cases/

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Markus Oberlehner
+
+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.

README.md

@@ -0,0 +1,27 @@
+# typescript-database-abstraction
+This is an example repository created for the following blog article: <LINK>.
+
+## Getting started
+- `yarn start` Runs the TypeScript compiler in watch mode.
+
+## Build
+- `yarn run build-app`
+
+## Run the demo code
+- `node app/index.js`
+
+## Lint
+- `yarn run lint`
+
+## Test
+- `yarn test`
+
+## About
+### Author
+Markus Oberlehner  
+Website: https://markus.oberlehner.net  
+Twitter: https://twitter.com/MaOberlehner  
+PayPal.me: https://paypal.me/maoberlehner
+
+### License
+MIT

package.json

@@ -0,0 +1,33 @@
+{
+  "name": "typescript-database-abstraction",
+  "version": "0.0.1",
+  "author": "Markus Oberlehner",
+  "homepage": "https://github.com/avalanchesass/typescript-database-abstraction",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/avalanchesass/typescript-database-abstraction"
+  },
+  "bugs": {
+    "url": "https://github.com/avalanchesass/typescript-database-abstraction/issues"
+  },
+  "devDependencies": {
+    "@types/glob": "^5.0.30",
+    "@types/js-yaml": "^3.5.29",
+    "@types/node": "^7.0.8",
+    "@types/sinon": "^1.16.35",
+    "ava": "^0.18.2",
+    "glob": "^7.1.1",
+    "js-yaml": "^3.8.2",
+    "sinon": "^2.0.0",
+    "tslint": "^4.5.1",
+    "typescript": "^2.2.1"
+  },
+  "scripts": {
+    "start": "yarn run clean-app && tsc -w",
+    "build-app": "yarn run clean-app && tsc",
+    "clean-app": "rm -Rf app",
+    "lint": "tslint 'src/**/*.ts'",
+    "test": "yarn run build-app && ava app/**/*.spec.js"
+  }
+}

resources/articles/an-article.md

@@ -0,0 +1,7 @@
+---
+title: "An article"
+description: "This is an article."
+---
+
+# An article
+Content of an article.

resources/articles/another-article.md

@@ -0,0 +1,7 @@
+---
+title: "Another article"
+description: "This is another article."
+---
+
+# Another article
+Content of another article.

src/classes/Database.spec.ts

@@ -0,0 +1,30 @@
+import test from 'ava';
+import * as sinon from 'sinon';
+
+import { Database } from './Database';
+
+test('should be a function', (t) => {
+  t.is(typeof Database, 'function');
+});
+
+test('should call the drivers getAll method', (t) => {
+  const MockDriver = {
+    getAll: sinon.spy(),
+    getById: () => ({}),
+  };
+  const db = new Database(MockDriver);
+  db.getAll(`some-table`);
+
+  t.true(MockDriver.getAll.called);
+});
+
+test('should call the drivers getById method', (t) => {
+  const MockDriver = {
+    getAll: () => [],
+    getById: sinon.spy(),
+  };
+  const db = new Database(MockDriver);
+  db.getById(`some-id`, `some-table`);
+
+  t.true(MockDriver.getById.called);
+});

src/classes/Database.ts

@@ -0,0 +1,29 @@
+import IDatabase from '../interfaces/IDatabase';
+
+export class Database implements IDatabase {
+  private driver: IDatabase;
+
+  /**
+   * Database
+   * @param driver
+   */
+  constructor(driver: IDatabase) {
+    this.driver = driver;
+  }
+
+  public getAll(table: string) {
+    return this.driver.getAll(table);
+  }
+
+  public getById(id: any, table: string) {
+    return this.driver.getById(id, table);
+  }
+}
+
+/**
+ * databaseFactory
+ * @param driver
+ */
+export default function databaseFactory(driver: IDatabase) {
+  return new Database(driver);
+}

src/classes/FileDriver.spec.ts

@@ -0,0 +1,57 @@
+// TODO: Refactor to promises.
+import test from 'ava';
+import * as path from 'path';
+import * as sinon from 'sinon';
+
+import { FileDriver } from './FileDriver';
+
+test('should be a function', (t) => {
+  t.is(typeof FileDriver, 'function');
+});
+
+test('should load files from the file system and extract data', (t) => {
+  const files = [
+    `file/a.md`,
+    `file/b.md`,
+  ];
+  const glob = {
+    sync: sinon.stub().returns(files),
+  };
+  const fs = {
+    readFileSync: sinon.stub().returns(`fake-content`),
+  };
+  const extractData = sinon.spy();
+  const extractor = sinon.stub().returns({ extractData });
+  const driver = new FileDriver(glob, path, fs, extractor, `/some/cwd`);
+
+  driver.getAll(`some-table`);
+
+  t.true(glob.sync.calledOnce);
+
+  t.true(fs.readFileSync.calledTwice);
+  t.true(fs.readFileSync.calledWith(`file/a.md`));
+  t.true(fs.readFileSync.calledWith(`file/b.md`));
+
+  t.true(extractor.calledTwice);
+  t.true(extractor.calledWith(`fake-content`));
+
+  t.true(extractData.calledTwice);
+});
+
+test('should load file from the file system and extract data', (t) => {
+  const glob = { sync: () => ([]) };
+  const fs = {
+    readFileSync: sinon.stub().returns(`fake-content`),
+  };
+  const extractData = sinon.spy();
+  const extractor = sinon.stub().returns({ extractData });
+  const cwd = `/some/cwd`;
+  const table = `some-table`;
+  const id = `some-id`;
+  const driver = new FileDriver(glob, path, fs, extractor, cwd);
+
+  driver.getById(id, table);
+
+  t.true(fs.readFileSync.calledWith(`${cwd}/resources/${table}/${id}.md`));
+  t.true(extractor.calledWith(`fake-content`));
+});

src/classes/FileDriver.ts

@@ -0,0 +1,78 @@
+import * as fs from 'fs';
+import * as glob from 'glob';
+import * as path from 'path';
+
+import IDatabase from '../interfaces/IDatabase';
+import IExtractor from '../interfaces/IExtractor';
+
+export class FileDriver implements IDatabase {
+  private glob: any;
+  private path: any;
+  private fs: any;
+  private extractor: (fileContent: string) => IExtractor;
+  private cwd: string;
+
+  /**
+   * FileDriver
+   * @param glob
+   * @param path
+   * @param fs
+   * @param extractor
+   * @param cwd
+   */
+  constructor(
+    glob,
+    path,
+    fs,
+    extractor,
+    cwd: string,
+  ) {
+    this.glob = glob;
+    this.path = path;
+    this.fs = fs;
+    this.extractor = extractor;
+    this.cwd = cwd;
+  }
+
+  public getAll(table: string): Array<object> {
+    const globPattern = path.resolve(this.cwd, `resources/${table}/*.md`);
+    return this.glob.sync(globPattern)
+      .map((file) => {
+        const fileContent: string = this.readFile(file);
+        return this.extractData(fileContent);
+      });
+  }
+
+  public getById(id: string, table: string): object {
+    const file = this.path.resolve(this.cwd, `resources/${table}/${id}.md`);
+    const fileContent: string = this.readFile(file);
+
+    return this.extractData(fileContent);
+  }
+
+  private readFile(file: string): string {
+    return this.fs.readFileSync(file, `utf8`);
+  }
+
+  private extractData(fileContent: string): object {
+    return this.extractor(fileContent).extractData();
+  }
+}
+
+/**
+ * fileDriverFactory
+ * @param extractor
+ * @param cwd
+ */
+export default function fileDriverFactory(
+  extractor,
+  cwd: string,
+): FileDriver {
+  return new FileDriver(
+    glob,
+    path,
+    fs,
+    extractor,
+    cwd,
+  );
+}