1.0.0-beta.4 (#4)

The release of 1.0.0-beta.4 version.

Author: Amaimersion

CHANGELOG.md

@@ -1,3 +1,37 @@
+# 1.0.0-beta.4 (3 мая, 2018)
+
+## Расширение
+
+### Новые функции
+
+* Отслеживание посещаемости.
+
+### Добавлено
+
+* Добавлена поддержка для новых постов и ответов.
+* Добавлена опция выключения активных постов после создания скриншота.
+
+### Изменено
+
+* Изменено название всплывающего меню c 2сh+ на 2ch-helper.
+* Небольшие изменения в дизайне всплывающего меню.
+* Небольшие изменения в дизайне настроек.
+* После изменения настроек новые настройки буду действовать без перезагрузки страницы.
+
+## Проект
+
+### Добавлено
+
+* Добавлены запасные шрифты.
+* Добавлена документация для недокументированных модулей.
+* Добавлена иконка github в папку icons.
+
+### Изменено
+
+* Незначительные изменения кода.
+* Изменены названия иконок.
+* Небольшие изменения в Readme.
+
 # 1.0.0-beta.3 (23 февраля, 2018)
 
 ## Расширение

README.md

@@ -19,6 +19,7 @@
 
 - создание скриншота постов и треда.
 - загрузка изображений, видео и треда.
+- отслеживание статистики посещаемости.
 
 ## Системные требования
 
@@ -28,11 +29,12 @@
 
 **GitHub**
 
-1. Скачайте этот репозиторий.
-2. Перейдите на вкладку <chrome://extensions>.
-3. Включите режим разработчика.
-4. Нажмите на "Загрузить распакованное расширение...".
-5. Выберите папку "extension".
+1. Перейдите в раздел [releases](https://github.com/Amaimersion/2ch-helper/releases).
+2. Скачайте Latest release версию.
+3. Перейдите на вкладку <chrome://extensions>.
+4. Включите режим разработчика.
+5. Нажмите на "Загрузить распакованное расширение...".
+6. Выберите папку "extension".
 
 ## Лицензия
 

extension/interaction/js/scripts/background/background-API.js

@@ -40,7 +40,8 @@ BackgroundAPI.getUserSettings = function() {
     // what settings to receive.
     const settings = [
         'settings_screenshot',
-        'settings_download'
+        'settings_download',
+        'statistics'
     ];
 
     chrome.storage.sync.get(settings, (data) => {
@@ -49,6 +50,43 @@ BackgroundAPI.getUserSettings = function() {
 }
 
 
+/**
+ * Updates user settings.
+ * 
+ * @memberof BackgroundAPI
+ * @static
+ * @async
+ */
+BackgroundAPI.updateUserSettings = function() {
+    this.getUserSettings();
+}
+
+
+/**
+ * Saves user settings.
+ * If field passed, then saves certain field settings, else saves all settings.
+ * 
+ * @memberof BackgroundAPI
+ * @static
+ * 
+ * @param {String} [field]
+ * A field of settings for saving.
+ * If passed, then other settings will not be saved.
+ *  
+ * @param {function()} [callback]
+ * A callback that executes after saving. 
+ */
+BackgroundAPI.saveUserSettings = function(field, callback) {
+    callback = callback || function() {};
+
+    if (field) {
+        chrome.storage.sync.set(this.userSettings[field], callback);
+    } else {
+        chrome.storage.sync.set(this.userSettings, callback);
+    }
+}
+
+
 /**
  * Injects a script into the page.
  * 

extension/interaction/js/scripts/background/background-on-message.js

@@ -141,6 +141,19 @@ BackgroundMessage.commandHandler = async function(request, sendResponse) {
         }
 
         sendResponse({status: true});
+    
+    } else if (command === 'updateUserSettings') {
+        BackgroundAPI.updateUserSettings();
+        sendResponse({status: true});
+
+    } else if (command === 'updateStatistics') {
+        try {
+            await BackgroundStatistics.updateStatistics(
+                request.field, request.data
+            );
+        } catch (error) {
+            throw error;
+        }
     }
 }
 

extension/interaction/js/scripts/background/background-statistics.js

@@ -0,0 +1,162 @@
+/** 
+ * The module that handles statistics requests.
+ * 
+ * @module BackgroundStatistics
+ */
+function BackgroundStatistics() {}
+
+
+/**
+ * A names of settings in user profile.
+ * 
+ * @memberof BackgroundStatistics
+ * @static
+ * @type {Object}
+ */
+BackgroundStatistics.fields = {
+    main: 'statistics',
+    totalSecondsSpent: 'totalSecondsSpent'
+}; 
+
+
+/**
+ * Handles requests for statistics updates.
+ * 
+ * @memberof BackgroundStatistics
+ * @static
+ * @async
+ * 
+ * @param {String} field
+ * A field of statistics for update.
+ *  
+ * @param {Object} data
+ * A data for update.
+ *  
+ * @returns {Promise<void | Error>} 
+ * A promise for the update that will resolve when the update will end.
+ * Resolve will contain nothing if success, otherwise reject will contain an error.
+ */
+BackgroundStatistics.updateStatistics = function(field, data) {
+    return new Promise(async (resolve, reject) => {
+        if (field === 'totalSecondsSpent') {
+            try {
+                await this.updateTotalSecondsSpent(
+                    data.loadedDate,
+                    data.closedDate
+                );
+            } catch (error) {
+                return reject(error);
+            }
+
+            return resolve();
+        } else {
+            const error = new Error();
+            erroe.message = 'An unknown field.';
+
+            return reject(error);
+        }
+    });
+}
+
+
+/**
+ * Handles 'totalSecondsSpent' field update.
+ * 
+ * @memberof BackgroundStatistics
+ * @static
+ * @async
+ * 
+ * @param {Number} loadedMs
+ * A time of opening the page in milliseconds. 
+ * 
+ * @param {Number} closedMs 
+ * A time of closing the page in milliseconds. 
+ * 
+ * @returns {Promise<void | Error>} 
+ * A promise for the update that will resolve when the update will end.
+ * Resolve will contain nothing if success, otherwise reject will contain an error.
+ */
+BackgroundStatistics.updateTotalSecondsSpent = function(loadedMs, closedMs) {
+    return new Promise(async (resolve, reject) => {
+        let seconds = 0;
+
+        seconds = closedMs - loadedMs;
+        seconds /= 1000;
+        seconds = Math.round(seconds);
+
+        const mainField = this.fields.main;
+        const field = this.fields.totalSecondsSpent;
+
+        seconds += BackgroundAPI.userSettings[mainField][field];
+
+        try {
+            await this.updateStatisticsField(field, seconds);
+        } catch (error) {
+            return reject(error);
+        }
+
+        return resolve();
+    });
+}
+
+
+/**
+ * Updates certain field of user settings.
+ * 
+ * @memberof BackgroundStatistics
+ * @static
+ * @async
+ * 
+ * @param {String} field
+ * A field to set. 
+ * 
+ * @param {any} value
+ * A value to set. 
+ * 
+ * @returns {Promise<void | Error>} 
+ * A promise for the update that will resolve when the update will end.
+ * Resolve will contain nothing if success, otherwise reject will contain an error.
+ */
+BackgroundStatistics.updateStatisticsField = function(field, value) {
+    return new Promise((resolve, reject) => {
+        const mainField = this.fields.main;
+        const errorOccurrence = this.createErrorOccurrence(reject);
+        console.log(errorOccurrence);
+
+        BackgroundAPI.userSettings[mainField][field] = value;
+
+        BackgroundAPI.saveUserSettings(mainField, () => {
+            window.clearTimeout(errorOccurrence);
+            return resolve();
+        });
+    });
+}
+
+
+/**
+ * Creates timeout limit error occurrence.
+ * Created to work in Promise.
+ * 
+ * @memberof BackgroundStatistics
+ * @static
+ * 
+ * @param {Function} reject
+ * A reject from Promise that will contain an error.
+ * 
+ * @param {Number} [delay=5000]
+ * Through how many milliseconds will happen timeout limit.
+ * Defaults to 5000. 
+ * 
+ * @returns {Number}
+ * A positive integer value which identifies the timer.
+ */
+BackgroundStatistics.createErrorOccurrence = function(reject, delay) {
+    delay = delay || 5000;
+
+    return window.setTimeout(() => {
+        const error = new Error();
+        error.message = 'Timeout limit.';
+
+        reject(error);
+    }, delay);
+}

extension/interaction/js/scripts/background/background-user-profile.js

@@ -21,6 +21,8 @@ UserProfile.defaultProfile = {
         fileNameThread: 'thread',
         format: 'jpeg',
         quality: 100,
+        turnOffPostsYes: true,
+        turnOffPostsNo: false,
         delay: 500
     },
 
@@ -29,6 +31,10 @@ UserProfile.defaultProfile = {
         userName: false,
         fileName: '',
         delay: 500
+    },
+
+    statistics: {
+        totalSecondsSpent: 0
     }
 };
 

extension/interaction/js/scripts/content/content-API.js

@@ -197,6 +197,19 @@ ContentAPI.getUserSettings = function() {
     chrome.storage.sync.get(settings, (data) => {
         this.userSettings = data;
     });
+
+}
+
+
+/**
+ * Updates user settings.
+ * 
+ * @memberof ContentAPI
+ * @static
+ * @async
+ */
+ContentAPI.updateUserSettings = function() {
+    this.getUserSettings();
 }