Merge pull request #3 from it-shark-pro/fs-module

FS module tasks

Author: EduardTrutsyk

.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

.eslintrc

@@ -0,0 +1,41 @@
+{
+  "parserOptions": {
+    "sourceType": "module"
+  },
+  "env": {
+    "es6": true,
+    "node": true,
+    "mocha": true
+  },
+  "extends": ["eslint:recommended"],
+  "rules": {
+    "array-bracket-spacing": 0,
+    "arrow-parens": [2, "as-needed"],
+    "comma-dangle": [2, "never"],
+    "comma-spacing": [2, {"after": true}],
+    "curly": [2, "multi-line"],
+    "eqeqeq": 2,
+    "func-names": 0,
+    "indent": [2, 2],
+    "max-len": 0,
+    "no-console": [ 1, {"allow": ["info", "error", "warn"]}],
+    "no-new-wrappers": 0,
+    "no-proto": 0,
+    "no-prototype-builtins": 0,
+    "no-restricted-syntax": 1,
+    "no-sparse-arrays": 0,
+    "no-unreachable": 2,
+    "no-unused-expressions": 2,
+    "no-unused-vars": [2, {"args": "none"}],
+    "semi": 2,
+    "quotes": [
+      2,
+      "single",
+      {
+        "avoidEscape": true,
+        "allowTemplateLiterals": true
+      }
+    ],
+    "require-yield": 1
+  }
+}

.eslintrc.js

@@ -56,4 +56,3 @@ typings/
 
 # dotenv environment variables file
 .env
-

.gitignore

@@ -1,3 +1,7 @@
 language: node_js
 node_js:
-  - "lts/*"
+  - "lts/*"
+
+script:
+  - yarn run lint
+  - yarn run test

.travis.yml

@@ -1 +1,125 @@
-# nodejs-assessment
+[![Build Status](https://travis-ci.org/it-shark-pro/nodejs-assignments.svg?branch=master)](https://travis-ci.org/it-shark-pro/nodejs-assignments)
+![Hackage-Deps](https://img.shields.io/hackage-deps/v/lens.svg)
+[![Greenkeeper badge](https://badges.greenkeeper.io/it-shark-pro/nodejs-assignments.svg)](https://greenkeeper.io/)
+[![GitHub release](https://img.shields.io/github/release/it-shark-pro/nodejs-assignments.svg)](https://github.com/it-shark-pro/js-assignments/releases/latest)
+
+
+# [Brest IT Shark](https://it-shark.pro/)
+[![IT Shark](https://avatars2.githubusercontent.com/u/34164782?s=200&v=4)](http://it-shark.pro/)
+## Nodejs Assignments
+
+### Docs
+* [How to sync your fork from original repo to keep up with their changes](/docs/sync-fork.md)
+* [Submit your solution to us for review](https://goo.gl/X6GjMB)
+
+The motivation of this project is to show TDD process in the wild to the beginners. Assingment tests are implemented in various ways to feel a difference and gain the experience what manner is good, what is bad and what is ugly.
+
+Another idea is to prepare assignment to cover main nodejs features, to drilling and mastering skills.  Some tasks are practical, but some tasks are rather synthetic.
+
+And the last idea is to inure trainees to work using unit test and feel uncomfortable when programming without tests.
+
+### To start javascript assignments please follow the next steps:
+*  [Fork this repo](#user-content-how-to-fork-this-repo)
+*  [Setup travis-ci to test the commits](#user-content-how-to-setup-travis-ci)
+*  [Setup the work environment](#user-content-how-to-setup-work-environment)
+*  [Implement assignments using TDD fashion](#user-content-how-to-implement-assignments-using-tdd-fashion)
+*  [How to debug tasks](#how-to-debug-tasks)
+
+### How to fork this repo
+* Click the **Fork** button at the top-right corner of this page and the repository will be copied to your own account.
+* Run `git clone https://github.com/<your-account>/nodejs-assignments.git` from command line to download the repo.
+
+### How to setup travis-ci
+* Open [https://travis-ci.org/](https://travis-ci.org/) and sign in with your github account.
+* Activate your forked repo **nodejs-assignments**.
+* Edit local README.md file and update all links (just replace all occurrences of `'it-shark-pro'` with your account name).
+* Commit and push updated README.md to github:
+```bash
+  git add README.md
+  git commit -m "Update the links"
+  git push origin master
+```
+* Open https://github.com/it-shark-pro/nodejs-assignments and test the build icon. Now it will run all tests and update status once you push changes to github. Keep this icon green!
+
+
+### How to setup work environment
+* Download and install the latest [Nodejs](https://nodejs.org/en/download/).
+* Run `npm install` from you repository folder to download the required modules. All dependent modules will be located in the  *node_modules* folder.
+* Open your favorite editor and complete tasks.
+* Open your terminal and use `npm test` command to run all tests. You can run single file by passing it as argument `npm test ./test/01-strings-tests.js`.
+* The local repo folder has the following structure: <pre>
+    node_modules - app dependences restored by `npm install` command, you can delete this folder and restore later again.
+    task - folder with tasks modules, it's your main folder.
+    test - folder with tests modules to verify the tasks completion.
+</pre>
+
+### How to implement assignments using TDD fashion
+Now you are ready to implement assignments. Tasks modules are located in the **task** folder. Each module consists of several tasks for specified topic. Each task is usually a regular function:
+```javascript
+  /**
+   * Reads file by given path synchronously and returns file data.
+   *
+   * @param {String} path
+   * @return {String}
+   *
+   * @example
+   *   'filder/file.txt' => 'File content'
+   */
+  function readFileSync(path) {
+    /* implement your code here */
+    throw new Error('Not implemented');
+  }
+```
+Resolve this task using the following [TDD steps](https://en.wikipedia.org/wiki/Test-driven_development#Test-driven_development_cycle):
+* Run unit tests and make sure that everything is OK and there are no failing tests.
+* Read the task description in the comment above the function. Try to understand the idea. If you got it you are to write unit test first, but unit tests are already prepared :) Skip step with writing unit tests.
+* Remove the throwing error line from function body
+```javascript
+     throw new Error('Not implemented');
+```
+and run the unit tests again. Find one test failed (red). Now it's time to fix it!
+* Implement the function by any way and verify your solution by running tests until the failed test become passed (green).
+* Your solution work, but now time to refactor it. Try to make your code as pretty and simple as possible keeping up the test green.
+* Once you can't improve your code and tests are passed you can commit your solution.
+* Push your updates to github server and check if tests passed on [travis-ci](https://travis-ci.org/it-shark-pro/nodejs-assignments/builds).
+* If everything is OK you can try to resolve the next task.
+
+### How to debug tasks
+To debug tests you can use **Node inspector**. To install it just run `npm install -g node-inspector` in your terminal. Then follow next steps:
+* Add `debugger;` to the first line of your task.
+* Run your test file with `npm run test-debug ./test/01-strings-tests.js`.
+* In another terminal run `node-inspector` and copy link from the output.
+* Open the link in your favorite browser. You should see Chrome Developers Tools like interface where you can debug your tasks.
+* When you found and fix your issue, close the browser's tab with the debug tools, stop the node-inspector by pressing Ctrl-C, stop the test runner by pressing Ctrl-C, remove the `debugger;` from your task.
+
+### How to debug (beginner's way)
+There is an easier way to debug for beginners with free Visual Studio Code:
+* Install VSC from https://code.visualstudio.com/
+* Open project folder in VSC and follow the instruction from https://code.visualstudio.com/docs/runtimes/nodejs#_debugging-your-node-application to create a default `launch.json`
+* Modify the `launch.json` in the IDE, set the properties "program" and "args" (empty "args" value run all tests, to run particular test specify this test file in "args"):
+```
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+           ...
+           "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
+           ...
+           "args": ["./test/01-file-system-tests.js"],
+           ...
+         },
+         ...
+     ]
+}
+```
+* Click in the gutter to the left of the line number to set the breakpoint. Press `F5` to run debug.
+* NOTE: The `launch.json` is stored in the `.vscode` project folder.
+
+## Contribution
+Feel free to contribute into this project. New tasks and katas are welcome.
+
+## ESLint
+To fix linting execute:
+```
+npm run lint -- --fix
+```

README.md

@@ -0,0 +1,12 @@
+### 1. Add remote from original repository in your forked repository:
+
+    `cd path/into/cloned/fork-repo`
+    `git remote add upstream [email protected]:it-shark-pro/nodejs-assignments.git`
+    `git fetch upstream`
+
+### 2. Updating your fork from original repo to keep up with their changes:
+
+    `git pull upstream master`
+
+### 3. Resolve conflicts if needed and install npm packages
+    `npm update`

docs/sync-fork.md

@@ -1,13 +1,28 @@
-module.exports = function testOptional(title, fn) {
-  it(title, function () {
-    try {
-      fn.call(this);
-    } catch (err) {
-      if (err.message === 'Not implemented') {
-        this.test.skip();
-      } else {
-        throw err;
-      }
+function testOptional(fn, callback) {
+  try {
+    fn.call(this, callback);
+  } catch (err) {
+    if (err.message === 'Not implemented') {
+      this.test.skip();
+    } else {
+      throw err;
     }
+  }
+}
+
+function itSync(title, fn) {
+  it(title, function () {
+    testOptional.call(this, fn);
+  });
+}
+
+function itAsync(title, fn) {
+  it(title, function (done) {
+    testOptional.call(this, fn, done);
   });
+}
+
+module.exports = {
+  itSync,
+  itAsync
 };