Merge pull request #39 from Syn-Tax/refactoring

Refactoring

Author: Syn-Tax

package.json

@@ -1,6 +1,6 @@
 {
   "name": "Memento",
-  "version": "1.6.4-dev",
+  "version": "1.6.5",
   "author": {
     "name": "Oscar Morris",
     "email": "twocap06@gmail.com"
@@ -23,6 +23,7 @@
     "decompress-zip": "^0.3.3",
     "electron-debug": "^3.2.0",
     "electron-is-dev": "^2.0.0",
+    "electron-window-state": "^5.0.3",
     "fs-extra": "^10.0.0",
     "jimp": "^0.16.1",
     "query-string": "^7.0.0",

public/electron.js

@@ -1,20 +1,24 @@
 
 // Modules to control application life and create native browser window
-const {app, BrowserWindow, nativeTheme, protocol} = require('electron')
+const { app, BrowserWindow, nativeTheme, protocol } = require('electron')
 const path = require('path')
-const isDev = require('electron-is-dev');
+const isDev = require('electron-is-dev')
 const debug = require('electron-debug')
+const windowStateKeeper = require('electron-window-state')
 
 const dataFolder = path.join(app.getPath('userData'), "./Data")
 
-debug({isEnabled: true})
+debug()
 
-function createWindow () {
+function createWindow(windowState) {
+  // force light theme since no dark theme has been implemented
   nativeTheme.themeSource = 'light'
   // Create the browser window.
   const mainWindow = new BrowserWindow({
-    width: 800,
-    height: 600,
+    width: windowState.width,
+    height: windowState.height,
+    x: windowState.x,
+    y: windowState.y,
     webPreferences: {
       preload: path.join(__dirname, 'preload.js'),
       nodeIntegration: true,
@@ -23,11 +27,13 @@ function createWindow () {
     preload: path.join(__dirname, "preload.js")
   })
 
+  // remove the menubar from the window
   mainWindow.removeMenu()
 
   // and load the index.html of the app.
   mainWindow.loadURL(isDev ? 'http://localhost:3000' : `file://${path.join(__dirname, '../build/index.html')}`)
 
+  // if running in dev mode, open the developer tools automatically
   if (isDev) {
     mainWindow.webContents.openDevTools()
   }
@@ -38,14 +44,27 @@ function createWindow () {
 // initialization and is ready to create browser windows.
 // Some APIs can only be used after this event occurs.
 app.whenReady().then(() => {
-  createWindow()
+  // allow the window to remember where it was placed and what size it was
+  let win
+  let windowState = windowStateKeeper({
+    defaultWidth: 800,
+    defaultHeight: 600
+  })
+
+  // create the window
+  createWindow(windowState)
+
+  // allow the window state to be managed
+  windowState.manage(win)
 
+  // register the custom file protocol for getting images dynamically
   protocol.registerFileProtocol('imgid', (request, callback) => {
     const url = request.url.substr(8)
     console.log(url)
-    callback({path: path.join(dataFolder, ".images", url)})
+    callback({ path: path.join(dataFolder, ".images", url) })
   })
 
+  // boilerplate for MacOS
   app.on('activate', function () {
     // On macOS it's common to re-create a window in the app when the
     // dock icon is clicked and there are no other windows open.
@@ -58,7 +77,4 @@ app.whenReady().then(() => {
 // explicitly with Cmd + Q.
 app.on('window-all-closed', function () {
   if (process.platform !== 'darwin') app.quit()
-})
-
-// In this file you can include the rest of your app's specific main process
-// code. You can also put them in separate files and require them here.
+})

public/logo192.png

@@ -18,7 +18,7 @@ Go to the releases page - https://github.com/Syn-Tax/memento/releases - and down
 
 # Changelog
 
-## v1.6.3-dev
+## v1.6.5
 
 Features:
 

public/logo512.png

@@ -1,7 +1,6 @@
 import React from 'react';
 import Home from './Views/Home';
 import Folder from './Views/Folder';
-import CreateFolder from './Views/CreateFolder';
 import CreateList from './Views/CreateList';
 import List from './Views/List';
 import Test from './Views/Test';
@@ -17,40 +16,34 @@ const appPath = electron.remote.app.getPath('userData');
 
 const dataFolder = path.join(appPath, "./Data/")
 
-console.log(appPath)
-if (!fs.existsSync(dataFolder)){
+// create the data directory if it doesn't exist
+if (!fs.existsSync(dataFolder)) {
     fs.mkdirSync(dataFolder);
 }
 
+// create the images directory if it doesn't exist
 if (!fs.existsSync(path.join(dataFolder, "./.images"))) {
     fs.mkdirSync(path.join(dataFolder, "./.images"))
 }
 
+// get the files in the data directory 
 let files = getFiles(dataFolder)
 
+/** 
+* @function App - the base component
+* @return {JSX} - The JSX for the current page
+*/
 function App() {
+    // state for storing the files in object form
     const [gridItems, setGridItems] = React.useState(files)
 
-    const recreateFiles = () => {
+    // if a file has been changed, get the files again
+    fs.watch(dataFolder, { recursive: true }, (event, file) => {
         files = getFiles(dataFolder)
         setGridItems(files)
-    }
-
-    fs.watch(dataFolder, {recursive: true}, (event, file) => {
-        files = getFiles(dataFolder)
-        setGridItems(files)
-    })
-
-    /*
-    let watcher = chokidar.watch(dataFolder)
-
-    watcher.on('all', (evt, name) => {
-        recreateFiles()
     })
 
-    console.log(watcher.getWatched())
-    */
-
+    // return the current page using react-router
     return (
         <div className="App">
             <Router>
@@ -67,9 +60,6 @@ function App() {
                     <Route path="/test/:pathStr">
                         <Test />
                     </Route>
-                    <Route path="/create-folder/:pathStr">
-                        <CreateFolder gridItems={gridItems} />
-                    </Route>
                     <Route path="/create-list/:pathStr">
                         <CreateList gridItems={gridItems} />
                     </Route>

readme.md

@@ -1,6 +1,9 @@
 import { Fab } from '@material-ui/core';
 import ArrowBackIcon from '@material-ui/icons/ArrowBack';
-
+/** 
+* @function BackButton - The component for the button to navigate to the previous page.
+* @return {JSX} - The JSX for the component.
+*/
 function BackButton() {
     return (
         <Fab variant="extended" size="small" style={{ backgroundColor: "white", top: "2%", left: "5%", position: "absolute" }}>