Remove references to vote (#66)

* Update naming of max stars board property for consistency * Rename variable for consistency Replaced "votes" with "stars" * Replace "vote" mode with "active" mode * Remove references to "voting"
joekrump · Feb 23, 2021 · 8bbd4c0 · 8bbd4c0
1 parent 5f3de99
commit 8bbd4c0
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ A tool for helping run [a retrospective meeting](https://www.softwaretestinghelp
 1. Drag and drop cards between columns.
 2. **Anonymity**
    - Each user has a session but no personal identifying information is required.
-   - You only see your ⭐️s that you've given to cards while in voting mode.
+   - You only see your ⭐️s that you've given to cards while in "active" mode.
 3. **Review mode**
    - See the total number of ⭐️ values given to each card
    - Quickly identify the cards with the most ⭐️s using sorting.

diff --git a/server.ts b/server.ts
@@ -10,11 +10,11 @@ let sessionStore: {
   };
 } = {};
 
-const MAX_VOTES_USER_VOTE_PER_BOARD = 10;
+const BOARD_MAX_STARS_PER_USER = 10;
 const NEW_BOARD: Board = {
   title: `Retro - ${(new Date()).toLocaleDateString(undefined, { year: "numeric", month: "long", day: "numeric" })}`,
   showResults: false,
-  starsPerUser: MAX_VOTES_USER_VOTE_PER_BOARD,
+  maxStarsPerUser: BOARD_MAX_STARS_PER_USER,
   cards: {},
   timerRemainingMS: 0,
   timerDurationMS: 0,
@@ -115,7 +115,7 @@ function updateRemainingStars(
     card.stars[session.id]++;
   } else {
     console.log("No more stars left");
-    socket.emit(`board:star-limit-reached:${boardId}`, { maxStars: MAX_VOTES_USER_VOTE_PER_BOARD });
+    socket.emit(`board:star-limit-reached:${boardId}`, { maxStars: BOARD_MAX_STARS_PER_USER });
   }
 }
 
@@ -214,7 +214,7 @@ io.on("connection", (socket) => {
 
     const newSession = {
       id: sessionId,
-      remainingStars: MAX_VOTES_USER_VOTE_PER_BOARD,
+      remainingStars: BOARD_MAX_STARS_PER_USER,
     };
 
     if(!sessionStore[boardId]) {

diff --git a/src/@types/index.d.ts b/src/@types/index.d.ts
@@ -17,7 +17,7 @@ export interface Column {
 }
 
 export interface Board {
-  starsPerUser: number;
+  maxStarsPerUser: number;
   title: string;
   showResults: boolean;
   columns: Column[];

diff --git a/src/frontend/components/App/App.tsx b/src/frontend/components/App/App.tsx
@@ -50,7 +50,7 @@ export const App = () => {
       sessionId: string,
       remainingStars: number,
     }) => {
-      updateMode(board.showResults ? AppMode.review : AppMode.vote);
+      updateMode(board.showResults ? AppMode.review : AppMode.active);
       updateTimer({
         remainingMS: board.timerRemainingMS,
         status: board.timerStatus,
@@ -62,7 +62,7 @@ export const App = () => {
       updateBoard({
         id: boardId,
         title: board.title,
-        starsPerUser: board.starsPerUser,
+        maxStarsPerUser: board.maxStarsPerUser,
       });
       updateRemainingStars(remainingStars);
       sessionStorage.setItem("retroSessionId", sessionId);
@@ -78,7 +78,7 @@ export const App = () => {
     });
 
     socket.on(`board:show-results:${boardId}`, (data: { showResults: boolean }) => {
-      updateMode(data.showResults ? AppMode.review : AppMode.vote);
+      updateMode(data.showResults ? AppMode.review : AppMode.active);
     });
     socket.on(`board:timer-tick:${boardId}`, ({ remainingMS, status }: { remainingMS: number, status: "running" | "paused" | "stopped" }) => {
       updateTimer({
@@ -120,7 +120,7 @@ export const App = () => {
         <Header socket={socket} />
         <Board socket={socket} />
         <div className={`alert alert-star-limit ${showStarLimitAlert ? "alert--show" : ""}`}>
-          Your voting limit of {board.starsPerUser} has been reached. Undo previous stars if you want some back.
+          Your ⭐️ limit of {board.maxStarsPerUser} has been reached. Undo previous stars if you want some back.
         </div>
       </Suspense>
     </AppErrorBoundary>

diff --git a/src/frontend/components/Card/Card.tsx b/src/frontend/components/Card/Card.tsx
@@ -162,7 +162,7 @@ export const Card = (props: CardProps) => {
   }
 
   function isEditable() {
-    return ownerId === sessionId && mode === AppMode.vote;
+    return ownerId === sessionId && mode === AppMode.active;
   }
 
   function renderUserStars() {
@@ -248,8 +248,8 @@ export const Card = (props: CardProps) => {
                 ⭐️
               </button>
             }
-            { mode === AppMode.vote ? renderUserStars() : renderResults() }
-            { mode === AppMode.vote && userStars > 0 ? renderUndoButton() : null }
+            { mode === AppMode.active ? renderUserStars() : renderResults() }
+            { mode === AppMode.active && userStars > 0 ? renderUndoButton() : null }
           </div>
           { editLink }
         </div>

diff --git a/src/frontend/overmind/state.ts b/src/frontend/overmind/state.ts
@@ -1,7 +1,7 @@
 import { BoardColumn, Card } from "../../@types";
 
 export enum AppMode {
-  "vote",
+  "active",
   "review",
 };
 
@@ -10,7 +10,7 @@ export type State = {
   board: {
     title: string;
     id: string;
-    starsPerUser: number;
+    maxStarsPerUser: number;
   };
   sessionId: string;
   columns: BoardColumn[];
@@ -26,13 +26,13 @@ export type State = {
 const initialSessionId = sessionStorage.getItem("retroSessionId") ?? "";
 
 export const state: State = {
-  mode: AppMode.vote,
+  mode: AppMode.active,
   sessionId: initialSessionId,
   remainingStars: 0,
   board: {
     title: "",
     id: "",
-    starsPerUser: 0,
+    maxStarsPerUser: 0,
   },
   timer: {
     remainingMS: 0,