A well-organized system #3
+369
−174
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,180 +1,15 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
|
|
||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <title>Pomodoro</title> | ||
| </head> | ||
|
|
||
| <body> | ||
| <script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/p5.js"></script> | ||
| <script src="static/js/p5.sound.js"></script> | ||
| <script type="module" src="static/js/main.js"></script> | ||
| </body> | ||
|
|
||
| </html> | ||
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| // Due to the way processing works, some variables that are treated as constants can't be declared as such, because they must be set in `setup()`. | ||
| // We could probably avert this issue by severing the processing library from this project, and rewriting it in terms of DOM interaction. | ||
|
|
||
| import { timeFormatter } from "./presets.js"; | ||
| import { getTargetTime, getTime, getTimeDifference } from "./timeUtils.js"; | ||
| import TimeInformation from "./timeInformation.js"; | ||
|
|
||
| const modes = ["60x60", "25x25", "45x10", "1x1", "0.1x1", "0.02x0.02", "90x90"]; //add modes here | ||
|
|
||
| var timerRunning = false; | ||
| var buttons = []; | ||
| var currentWorkTime, currentRestTime; | ||
| var working = true; //false=resting | ||
| var currentButtonsAmount = 0; | ||
| var buttonWidth, buttonHeight; // Should be constant, but due to the way processing works, must be set in `setup()`. | ||
| var endTime; | ||
| var resetTimer = false; //for pomodoro screen | ||
| var theText; //for pomodoro screen - global | ||
| var timeLeft; | ||
| var soundEffect; // Should be constant. | ||
|
Comment on lines
+10
to
+20
There was a problem hiding this comment. All of these should be able to be turned into |
||
|
|
||
| function setup() { | ||
| buttonWidth = windowWidth / 5; | ||
| buttonHeight = windowHeight / 10; | ||
|
|
||
| createCanvas(windowWidth, windowHeight); | ||
|
|
||
| soundEffect = loadSound("static/audio/sound effect.mp3"); | ||
|
|
||
| background(200); | ||
| textAlign(CENTER); | ||
| buttons = makeButtonsFromModes(modes); | ||
| } | ||
|
|
||
| function draw() { | ||
| if (timerRunning) pomodoro(currentWorkTime, currentRestTime); | ||
| } | ||
|
|
||
| function resetProgram() { | ||
| //executes once to reset program | ||
| buttons.forEach((b) => b.remove()); | ||
|
There was a problem hiding this comment. I do see this call repeated in a few places. It's probably wise to extract this into its own function. |
||
| timerRunning = false; | ||
| clear(); | ||
| //setup screen | ||
| background(200); | ||
|
|
||
| textAlign(CENTER); | ||
|
|
||
| buttons = makeButtonsFromModes(modes); | ||
| } | ||
|
|
||
| function mouseClicked() { | ||
| if (timerRunning) timeFormatter.next(); | ||
| } | ||
|
|
||
| /** | ||
| * Makes one button to start the timer with the specified mode and destroys all other buttons. | ||
| * @param {string} mode - The timer mode, formatted like so: `"<Work time>x<Rest time>"` | ||
| */ | ||
| function setMode(mode) { | ||
| currentWorkTime = mode.substring(0, mode.indexOf("x")); | ||
| currentRestTime = mode.substring(mode.indexOf("x") + 1); | ||
|
|
||
| buttons.forEach((b) => b.remove()); | ||
|
|
||
| buttons = [ | ||
| makeButton( | ||
| "start", | ||
| (currentButtonsAmount = 1), | ||
| () => (resetTimer = timerRunning = true) | ||
| ), | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * Updates the screen to show the proper text about time left in a session. | ||
| * @param {number} workTime - The time to spend working | ||
| * @param {number} restTime - The time to spend resting | ||
| */ | ||
| function pomodoro(workTime, restTime) { | ||
| textSize((windowWidth + windowHeight) / 2 / 25); | ||
|
|
||
| if (resetTimer) { | ||
| buttons.forEach((b) => b.remove()); | ||
| endTime = getTargetTime(working ? workTime : restTime); | ||
| buttons = [ | ||
| makeButton( | ||
| "Reset", | ||
| (currentButtonsAmount = modes.length), | ||
| resetProgram | ||
| ), | ||
| ]; | ||
|
|
||
| soundEffect.play(); | ||
|
|
||
| resetTimer = false; | ||
| } | ||
|
Comment on lines
+83
to
+97
There was a problem hiding this comment. This could be better, we should strive for separation of concerns. There was a problem hiding this comment. It would be ideal to make a function call instead of setting a global variable used in another function, maybe making a |
||
|
|
||
| background(working ? color(0, 255, 0) : color(64, 64, 255)); | ||
|
|
||
| timeLeft = getTimeDifference(getTime(), endTime); | ||
|
|
||
| if (timeLeft.seconds <= 0) { | ||
| working = !working; | ||
| resetTimer = true; //recalculate time to finish | ||
| } | ||
|
|
||
| const currentTimeInfo = new TimeInformation( | ||
| working, | ||
| workTime, | ||
| restTime, | ||
| timeLeft | ||
| ); | ||
|
|
||
| theText = standardText(timeFormatter.textFrom(currentTimeInfo)); | ||
|
Comment on lines
+108
to
+115
There was a problem hiding this comment. This section of code now adheres to the Open-Closed Principle. |
||
| } | ||
|
|
||
| function standardText(txt) { | ||
| return text(txt, windowWidth / 2, windowHeight / 2); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a list of buttons from a list of timer modes. Each button will start the corresponding mode when clicked. | ||
| * @param {string[]} modes - List of timer modes that the buttons should start. | ||
| * @returns {Button[]} The list of buttons that start the timer with their mode. | ||
| */ | ||
| function makeButtonsFromModes(modes) { | ||
| return modes | ||
| .map(createButton) | ||
| .map((b, idx) => | ||
| b.position( | ||
| windowWidth / 2 - buttonWidth / 2, | ||
| windowHeight / 2 + | ||
| idx * buttonHeight - | ||
| (modes.length * buttonHeight) / 2 | ||
|
Comment on lines
+132
to
+135
There was a problem hiding this comment. This is complex logic that would be good to describe in more detail. |
||
| ) | ||
| ) | ||
| .map((b) => b.size(buttonWidth, buttonHeight)) | ||
| .map((b, idx) => b.mousePressed(() => setMode(modes[idx]))); | ||
|
There was a problem hiding this comment. This may not be the best solution, but at least we depend only on a parameter. |
||
| } | ||
|
|
||
| /** | ||
| * Creates a button on the screen. | ||
| * @param {string} txt - The text on the button | ||
| * @param {number} totalButtons - The intended total number of buttons | ||
| * @param {() => void} mPressed - The callback to be ran when the button is clicked | ||
| * @returns | ||
| */ | ||
| function makeButton(txt, totalButtons, mPressed) { | ||
| //currentButtonsAmount=the current number of buttons on screen before creation of this one | ||
| var button = createButton(txt); | ||
|
There was a problem hiding this comment. Could be |
||
| button.position( | ||
| windowWidth / 2 - buttonWidth / 2, | ||
| windowHeight / 2 + | ||
| currentButtonsAmount * buttonHeight - | ||
| (totalButtons * buttonHeight) / 2 | ||
| ); | ||
|
Comment on lines
+152
to
+157
There was a problem hiding this comment. This logic looks to be duplicated in |
||
| button.size(buttonWidth, buttonHeight); | ||
| button.mousePressed(mPressed); | ||
|
|
||
| currentButtonsAmount++; | ||
|
|
||
| return button; | ||
| } | ||
|
|
||
| window.setup = setup; | ||
| window.mouseClicked = mouseClicked; | ||
| window.draw = draw; | ||
|
Comment on lines
+166
to
+168
There was a problem hiding this comment. Small trick for |
||
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| import TimeFormatter from "./timeFormatter.js"; | ||
| import * as timeModes from "./timeModes.js"; | ||
|
|
||
| export const timeFormatter = new TimeFormatter([ | ||
| timeModes.dependent, | ||
| timeModes.independent, | ||
| ]); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Separation of concerns - I called this one "Code-Interface Segregation".