Feature/rnoz contributions

.circleci/config.yml

@@ -1,13 +1,34 @@
 version: 2
 jobs:
-  build:
+  lint:
     working_directory: ~/redshape
     docker:
       - image: circleci/node:10.15.3
     steps:
       - checkout
       - restore_cache:
           key: dependency-cache-{{ .Branch }}-{{ checksum "package.json" }}
+      - run: 'sudo apt install libxss-dev pkg-config'
+      - run:
+          name: Install Dependencies
+          command: 'npm install'
+      - save_cache:
+          key: dependency-cache-{{ .Branch }}-{{ checksum "package.json" }}
+          paths:
+            - ./node_modules
+      - run:
+          name: 'Linting'
+          command: 'npm run lint'
+
+  test:
+    working_directory: ~/redshape
+    docker:
+      - image: circleci/node:10.15.3
+    steps:
+      - checkout
+      - restore_cache:
+          key: dependency-cache-{{ .Branch }}-{{ checksum "package.json" }}
+      - run: 'sudo apt install libxss-dev libxext-dev libxtst6 libnss3 libgtk-3-0 libgtkextra-dev libasound2'
       - run:
           name: Install Dependencies
           command: 'npm install'
@@ -18,4 +39,10 @@ jobs:
       - run:
           name: Coverage
           command: 'npm test'
-
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - lint
+      - test

.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

.eslintrc.json

@@ -1,4 +1,5 @@
 {
+    "parser": "babel-eslint",
     "env": {
         "browser": true,
         "es6": true,
@@ -27,9 +28,48 @@
         "no-underscore-dangle": [ "error", {
             "allow": ["__initialize", "__reset"]
         }],
+        "max-len": ["error", { "code": 120, "ignoreComments": true }],
+        "no-restricted-syntax": "off",
         "camelcase": [ "error", {
-            "allow": ["api_key"]
+            "allow": [
+                "api_key",
+                "time_entry",
+                "spent_on",
+                "issue_id",
+                "activity_id",
+                "user_id",
+                "spent_hours",
+                "total_spent_hours",
+                "time_entries",
+                "project_id",
+                "tracker_id",
+                "status_id",
+                "assigned_to_id",
+                "author_id",
+                "due_date",
+                "created_on",
+                "priority_id",
+                "private_notes",
+                "total_count",
+                "estimated_duration",
+                "estimated_hours",
+                "done_ratio",
+                "assigned_to",
+                "start_date",
+                "custom_fields",
+                "closed_on",
+                "progress_info"
+            ]
         }],
+        "jsx-a11y/label-has-associated-control": "off",
+        "jsx-a11y/anchor-is-valid": "off",
+        "react/no-array-index-key": "off",
+        "no-mixed-operators": "off",
+        "react/forbid-prop-types": "off",
+        "react/require-default-props": "off",
+        "react/jsx-props-no-spreading": "off",
+        "max-classes-per-file": "off",
+        "no-use-before-define": "off",
         "jsx-a11y/label-has-for": [ 2, {
             "required": {
                 "every": [ "nesting", "id" ]

.gitignore

@@ -3,3 +3,7 @@ coverage/
 dist/
 build/
 .env
+.idea
+support/package-aur/*
+!support/package-aur/manager.sh
+!support/package-aur/PKGBUILD

README.md

@@ -9,36 +9,43 @@ Re-designs the way tasks, task info, tracked time and communication is done on r
 
 The project was originally developed for a MVP portfolio showcase, but there is some roadmap planned with new features that might be added once I find enough of free time.
 
-Thanks for using, or considering to use this project. I would love to hear some feedback as well as your suggestions and thoughts about what could be improved. If you have something to say, don't hesitate to [send me an email](mailto:redshape.app@gmail.com).
+Thanks for using, or considering to use this project.
 
 ![Redshape Screenshot](https://user-images.githubusercontent.com/4171202/58926139-bbd6df00-8752-11e9-92bb-ddfdb5bce33d.png)
 
 ## Installation
 
 ### macOS
+
 Download the latest [Redshape release](https://github.com/Spring3/redshape/releases/latest).
 
 The application will automatically update when a new release is available.
 
 ### Windows
+
 Download the latest [Redshape installer](https://github.com/Spring3/redshape/releases).
 
 You can download the .exe installer or the web installer. Both automatically detect the system architecture and set up the correct version.
 
 The application will automatically update when a new release is available.
 
-
 ### Linux
 
 Download the latest [Redshape release](https://github.com/Spring3/redshape/releases/latest).
 
 The application will automatically update when a new release is available.
 
-## License
-[GPL-3.0](https://github.com/Spring3/redshape/blob/master/LICENSE.md)
+## Development
 
-Created by [Daniyil Vasylenko](https://github.com/Spring3)
+If you don't have access to a deployed instance of redmine, you can now run it in docker
+
+Unfortuantely, you will have to configure it then yourself
+
+```
+docker-compose -f docker-compose.yml up
+```
 
+Then after you run the project with `npm run dev`, use `http://localhost` as redmine endpoint on the login form and provide the credentials or the API token 
 
 ## FAQ
 
@@ -48,6 +55,51 @@ Created by [Daniyil Vasylenko](https://github.com/Spring3)
 #### - Markdown is displayed incorrectly
 Please ask your Redmine admin user to check if it's enabled in `Administration -> General -> Text Formatting` menu. This path may change with the upcoming redmine releases, so please refer to Redmine documentation to find out exactly where this switch is located for your version of Redmine
 
-#### - My antivirus / Defender / Mac OS warns that it's not safe to run this app 
+#### - My antivirus / Defender / Mac OS warns that it's not safe to run this app
 Mac OS build was signed by a **self-signed certificate**, while Windows and Linux builds **were not signed at all**. In such case, you will see this warnings upon download or running the application / installation, saying that this app is not safe to run or that it was provided by an unknown developer and is not safe to run.
 
+#### - How to use timer controls
+
+Timer controls allow to manually modify the time for the timer by (1 or 5 minutes back and forth) as well as write temporary comments. Using these, we can directly modify the time after the pause in the task. To enable it, toggle the "Use advanced timer controls" item in the Settings menu
+
+#### - Idle behavior
+
+Redshape can pause the timer if it detects the system is idle for a range of times (5, 10 o 15 minutes). It will warn with notifications (15s. warning time before pausing).
+
+Optionally, it can automatically discard the idle time from the current timer when it is paused.
+
+#### - More accurate progressbar
+
+Issue progress slider can be changed with 1% step if configured (by default is 10%). 
+Enable this if you have support in the server side (ruby, redmine) to use every percentage (33%, 81%, etc).
+
+### AUR package
+
+Electron-builder does not offer aur packages. Therefore, in the directory `support/package-aur` we can build those for ArchLinux/Manjaro distributions. It is "optimized" and just installs around 50MiB, using the system electron, as it is exposed here [issue 4059](https://github.com/electron-userland/electron-builder/issues/4059).
+
+```sh
+bash support/package-aur/manager.sh pack # can be omitted if using the archive from the repo
+bash support/package-aur/manager.sh makepkg
+```
+
+Before publishing a release, you have to update the PKGBUILD:
+
+```sh
+# using npm script:
+npm run release:aur
+
+# alternatively, with the shell:
+bash support/package-aur/manager.sh pack pkgbuild
+```
+
+The second target (`pkgbuild`) will update the version and md5sums of the PKGBUILD.
+
+
+## License
+[GPL-3.0](https://github.com/Spring3/redshape/blob/master/LICENSE.md)
+
+Created by [Daniyil Vasylenko](https://github.com/Spring3)
+
+## Contributors
+
+[rNoz](https://github.com/rnoz) from [Group4Layers](https://www.group4layers.com)

__mocks__/electron-store.js

@@ -14,21 +14,24 @@ class Store {
   }
 
   get = (key) => {
+    // eslint-disable-next-line
     console.log('[electron-store] Using mocked get function');
     return values[key];
   }
 
   has = (key) => {
+    // eslint-disable-next-line
     console.log('[electron-store] Using mocked has function');
     return Object.hasOwnProperty.call(values, key);
   }
 
   set = (key, value) => {
+    // eslint-disable-next-line
     console.log('[electron-store] Using mocked set function');
     values[key] = value;
   }
 
-  delete = (key) => delete values[key]; 
+  delete = (key) => delete values[key];
 
   clear = () => Store.__reset();
 }

__mocks__/electron.js

@@ -4,6 +4,10 @@ const shell = {
   openExternal: () => {}
 };
 
+const powerMonitor = {
+  getSystemIdleTime: jest.fn()
+};
+
 const remote = {
   shell,
   process: {
@@ -17,10 +21,20 @@ const remote = {
     if (path.includes('/common/request')) {
       return require('../common/request'); // eslint-disable-line
     }
+    if (path.includes('electron')) {
+      return { powerMonitor };
+    }
     return undefined;
   }
 };
 
+const ipcRenderer = {
+  on: jest.fn(),
+  send: jest.fn(),
+  removeListener: jest.fn()
+};
+
 module.exports = {
-  remote
+  remote,
+  ipcRenderer
 };

__mocks__/image-mock.js

@@ -1 +1,4 @@
+import React from 'react';
+
+// eslint-disable-next-line react/jsx-filename-extension
 export default () => (<div className="image" />);

__mocks__/ipc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  send: jest.fn(),
+  setupTimer: jest.fn(),
+};

common/env.js

@@ -1,13 +1,14 @@
+// eslint-disable-next-line
 const { remote } = require('electron');
-const _pick = require('lodash/pick');
+const pick = require('lodash/pick');
 
 let config;
 
 // main process
 const mainProcess = process && process.type !== 'renderer' ? process : remote.process;
 
 if (!config) {
-  config = _pick(mainProcess.env, 'PORT', 'ENCRYPTION_KEY', 'NODE_ENV');
+  config = pick(mainProcess.env, 'PORT', 'ENCRYPTION_KEY', 'NODE_ENV');
   config.platform = mainProcess.platform;
 }
 

common/reporter.js

@@ -1,10 +1,11 @@
 const { openNewGitHubIssue, debugInfo } = require('electron-util');
 
 module.exports = {
-  report: error => openNewGitHubIssue({
+  report: (error) => openNewGitHubIssue({
     user: 'Spring3',
     repo: 'redshape',
     body: error && error instanceof Error
+      // eslint-disable-next-line max-len
       ? `Please describe the issue as detailed as you can\n\n---\n### Error Stack:\n \`\`\`\n${error.stack}\n\`\`\`\n### Debug Info:\n \`\`\`\n${debugInfo()}\n\`\`\``
       : `Please describe the issue as detailed as you can\n\n---\n### Debug Info:\n \`\`\`\n${debugInfo()}\n\`\`\``
   })

common/request.js

@@ -54,7 +54,16 @@ const handleReject = (error) => {
   // if this request was not cancelled
   if (!axios.isCancel(error)) {
     let errorMessage = 'Error';
-    if (error.status) {
+    const { response } = error;
+    const data = response && response.data;
+    const errors = data && data.errors;
+    if (errors) {
+      if (errors.length > 1) {
+        errorMessage = `${errorMessage}s - ${errors.join(' - ')}`;
+      } else {
+        errorMessage = `${errorMessage} ${errors[0]}`;
+      }
+    } else if (error.status) {
       errorMessage = `${errorMessage} ${error.status}`;
     }
     errorMessage = `${errorMessage} (${error.statusText || error.message})`;

common/utils.js

@@ -1,15 +1,17 @@
 const xss = require('xss');
+// eslint-disable-next-line import/no-extraneous-dependencies
 const { shell } = require('electron').remote;
 
 const openExternalUrl = url => new Promise((resolve, reject) => { // eslint-disable-line
   return (url && (url.startsWith('http') || url.startsWith('mailto:')))
     ? resolve(url)
     : reject(new Error('Intercepted suspicious url', url));
 })
-  .then(link => shell.openExternal(link))
-  .catch(error => console.error('Error when opening external url', url, error.message));
+  .then((link) => shell.openExternal(link))
+  // eslint-disable-next-line
+  .catch((error) => console.error('Error when opening external url', url, error.message));
 
-const xssFilter = input => xss(input);
+const xssFilter = (input) => xss(input);
 
 module.exports = {
   openExternalUrl,

docker-compose.yml

@@ -0,0 +1,23 @@
+version: '3.1'
+
+services:
+    redmine:
+      image: redmine:4.1
+      restart: always
+      ports:
+        - 80:3000
+      environment:
+        REDMINE_DB_MYSQL: db
+        REDMINE_DB_PASSWORD: example
+
+    db:
+      image: mysql:5.7
+      restart: always
+      environment:
+        MYSQL_ROOT_PASSWORD: example
+        MYSQL_DATABASE: redmine
+      volumes:
+        - db-data:/var/lib/mysql/data
+
+volumes:
+  db-data:

jest.config.js

@@ -4,8 +4,10 @@ module.exports = {
   clearMocks: true,
   collectCoverage: true,
   setupFilesAfterEnv: ['./setupJest.js'],
+  snapshotSerializers: ['enzyme-to-json/serializer'],
   moduleNameMapper: {
     '\\.(css|less)$': '<rootDir>/__mocks__/style-mock.js',
-    '\\.(png)$': '<rootDir>/__mocks__/image-mock.js'
+    '\\.(png)$': '<rootDir>/__mocks__/image-mock.js',
+    ipc$: '<rootDir>/__mocks__/ipc.js'
   }
 };