Skip to content

Commit 180617a

Browse files
LearningNerdLearningNerd
authored
Merge pull request #13 from LearnTeachCode/issue1
Rename functions, closes issue #1
2 parents 9c98b83 + 5ed5588 commit 180617a

File tree

2 files changed

+66
-66
lines changed

2 files changed

+66
-66
lines changed

‎public/local.js

+42-42
Original file line numberDiff line numberDiff line change
@@ -88,27 +88,27 @@ editor.getSession().setMode('ace/mode/javascript');
8888
/* ------------------------------------------------------------
8989
EVENT LISTENERS / SEND DATA TO SERVER
9090
91-
EVENT NAMES: CLIENT FUNCTIONS:
92-
- connection Send: SocketIO built-in event
93-
- disconnect Send: SocketIO built-in event
94-
- loggedIn Send: handleUserLogin
95-
- editorChange Send: handleUserTyping
96-
Receive: handleEditorChange
97-
- playerListChange Receive: handlePlayerListChange
98-
- updateState Receive: handleUpdateState
99-
- turnChange Receive: handleTurnChange
100-
- changeCursor Send: handleChangeCursor
101-
Receive: handleNewCursorData
102-
- changeScroll Send: handleChangeScroll
103-
Receive: handleNewScrollData
104-
- createNewGist Receive: createNewGist
105-
- newGistLink Receive: handleNewGistLink
106-
Send: (sent after creating or forking)
91+
EVENT NAMES: CLIENT FUNCTIONS:
92+
- connection Send: SocketIO built-in event
93+
- disconnect Send: SocketIO built-in event
94+
- userLogin Send: handleUserLogin
95+
- editorTextChange Send: handleLocalEditorTextChange
96+
Receive: handleServerEditorTextChange
97+
- playerListChange Receive: handlePlayerListChange
98+
- updateState Receive: handleUpdateState
99+
- turnChange Receive: handleTurnChange
100+
- editorCursorChange Send: handleLocalEditorCursorChange
101+
Receive: handleServerEditorCursorChange
102+
- editorScrollChange Send: handleLocalEditorScrollChange
103+
Receive: handleServerEditorScrollChange
104+
- createNewGist Receive: handleCreateNewGist
105+
- newGistLink Receive: handleNewGistLink
106+
Send: (sent after creating or forking)
107107
-------------------------------------------------------------- */
108-
editor.getSession().on('change', handleUserTyping);
109-
editor.getSession().selection.on('changeCursor', handleChangeCursor);
110-
editor.getSession().on('changeScrollLeft', handleChangeScroll);
111-
editor.getSession().on('changeScrollTop', handleChangeScroll);
108+
editor.getSession().on('change', handleLocalEditorTextChange);
109+
editor.getSession().selection.on('editorCursorChange', handleLocalEditorCursorChange);
110+
editor.getSession().on('changeScrollLeft', handleLocalEditorScrollChange);
111+
editor.getSession().on('changeScrollTop', handleLocalEditorScrollChange);
112112

113113
// When client connects to server,
114114
socket.on('connect', function(){
@@ -135,12 +135,12 @@ function handleUserLogin (userData) {
135135
updateLoggedInView(userData.login, userData.avatar_url);
136136

137137
// Notify server that user logged in
138-
socket.emit('loggedIn', {login: userData.login, avatar_url: userData.avatar_url});
138+
socket.emit('userLogin', {login: userData.login, avatar_url: userData.avatar_url});
139139
}
140140

141141
// Send editorInputView data to server
142-
function handleUserTyping (event) {
143-
//console.log('handleUserTyping event! value: ');
142+
function handleLocalEditorTextChange (event) {
143+
//console.log('handleLocalEditorTextChange event! value: ');
144144
//console.log(event);
145145

146146
//console.log('%c ' + editor.getValue(), 'color: green; font-weight: bold;');
@@ -149,7 +149,7 @@ function handleUserTyping (event) {
149149
if (socket.id === currentPlayerId) {
150150
//console.log('Sending data to server!')
151151
// Send data to server
152-
socket.emit( 'editorChange', editor.getValue() );
152+
socket.emit( 'editorTextChange', editor.getValue() );
153153
}
154154
}
155155

@@ -176,8 +176,8 @@ function handleUserNameChange (event) {
176176
}
177177

178178
// Send cursor and selection data to server
179-
function handleChangeCursor (event) {
180-
//console.log('changeCursor fired!');
179+
function handleLocalEditorCursorChange (event) {
180+
//console.log('editorCursorChange fired!');
181181
//console.log('%c ' + event, 'color: green; font-weight: bold;');
182182

183183
// Cursor object:
@@ -187,16 +187,16 @@ function handleChangeCursor (event) {
187187
// { end: {column, row}, start: {column, row} }
188188

189189
// Send to server:
190-
socket.emit( 'changeCursor', { cursor: editor.getSession().selection.getCursor(), range: editor.getSession().selection.getRange() } );
190+
socket.emit( 'editorCursorChange', { cursor: editor.getSession().selection.getCursor(), range: editor.getSession().selection.getRange() } );
191191
}
192192

193193
// Send scroll data to server
194-
function handleChangeScroll (event) {
195-
//console.log('changeScroll (left or top) fired!');
194+
function handleLocalEditorScrollChange (event) {
195+
//console.log('editorScrollChange (left or top) fired!');
196196
//console.log('%c scrollLeft: ' + editor.getSession().getScrollLeft() + ', scrollTop: ' + editor.getSession().getScrollTop(), 'color: green; font-weight: bold;');
197197

198198
// Send to server:
199-
socket.emit('changeScroll', { scrollLeft: editor.getSession().getScrollLeft(), scrollTop: editor.getSession().getScrollTop() });
199+
socket.emit('editorScrollChange', { scrollLeft: editor.getSession().getScrollLeft(), scrollTop: editor.getSession().getScrollTop() });
200200
}
201201

202202
// TODO: Test 'input' event some more in different browsers!
@@ -205,25 +205,25 @@ function handleChangeScroll (event) {
205205
/* -------------------------------------------------
206206
EVENT LISTENERS / RECEIVE DATA FROM SERVER
207207
---------------------------------------------------- */
208-
socket.on('editorChange', handleEditorChange);
209-
socket.on('changeCursor', handleNewCursorData);
210-
socket.on('changeScroll', handleNewScrollData);
208+
socket.on('editorTextChange', handleServerEditorTextChange);
209+
socket.on('editorCursorChange', handleServerEditorCursorChange);
210+
socket.on('editorScrollChange', handleServerEditorScrollChange);
211211
socket.on('playerListChange', handlePlayerListChange);
212212
socket.on('updateState', handleUpdateState);
213213
socket.on('turnChange', handleTurnChange);
214-
socket.on('createNewGist', createNewGist);
214+
socket.on('createNewGist', handleCreateNewGist);
215215
socket.on('newGistLink', handleNewGistLink);
216216

217217
// When receiving new editorInputView data from server
218-
function handleEditorChange (data) {
219-
//console.log('editorChange event received!');
218+
function handleServerEditorTextChange (data) {
219+
//console.log('editorTextChange event received!');
220220
//console.log('%c ' + data, 'color: blue; font-weight: bold;');
221221

222222
updateEditorView(data);
223223
}
224224

225225
// When receiving new cursor/selection data from server
226-
function handleNewCursorData (data) {
226+
function handleServerEditorCursorChange (data) {
227227
//console.log('%c cursorChange event received!', 'color: blue; font-weight: bold;');
228228
//console.dir(data);
229229

@@ -233,8 +233,8 @@ function handleNewCursorData (data) {
233233
}
234234

235235
// When receiving new scroll data from server
236-
function handleNewScrollData (data) {
237-
//console.log('%c scrollChange event received!', 'color: blue; font-weight: bold;');
236+
function handleServerEditorScrollChange (data) {
237+
//console.log('%c editorScrollChange event received!', 'color: blue; font-weight: bold;');
238238
//console.dir(data);
239239

240240
// Set Ace editor's scroll position to match
@@ -531,8 +531,8 @@ function updateCurrentGistView (gistData) {
531531
GITHUB API FUNCTIONS
532532
---------------------------------------------------- */
533533
// Make a POST request via AJAX to create a Gist for the current user
534-
function createNewGist() {
535-
console.log('called createNewGist at ' + new Date().toString().substring(16,25), 'color: red; font-weight: bold;');
534+
function handleCreateNewGist() {
535+
console.log('called handleCreateNewGist at ' + new Date().toString().substring(16,25), 'color: red; font-weight: bold;');
536536
// use currentAccessToken
537537
// use https://developer.github.com/v3/gists/#create-a-gist
538538

@@ -551,7 +551,7 @@ function createNewGist() {
551551

552552
postWithGitHubToken('https://api.github.com/gists', gistObject).then(function(responseText){
553553
//console.log(responseText);
554-
console.log('createNewGist: response received at ' + new Date().toString().substring(16,25), 'color: red; font-weight: bold;');
554+
console.log('handleCreateNewGist: response received at ' + new Date().toString().substring(16,25), 'color: red; font-weight: bold;');
555555
console.dir(gistObject);
556556

557557
var gistObject = JSON.parse(responseText);

‎server.js

+24-24
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,12 @@ server.listen(port, function() {
6666

6767
/* ------------------------------------------------------------
6868
EVENT NAMES: SERVER FUNCTIONS:
69-
- loggedIn io.emit: playerListChange
70-
socket.emit: editorChange, changeScroll, changeCursor, turnChange
69+
- userLogin io.emit: playerListChange
70+
socket.emit: editorTextChange, editorScrollChange, editorCursorChange, turnChange
7171
- disconnect Broadcast: playerListChange
72-
- editorChange Broadcast: editorChange
73-
- changeCursor Broadcast: changeCursor
74-
- changeScroll Broadcast: changeScroll
72+
- editorTextChange Broadcast: editorTextChange
73+
- editorCursorChange Broadcast: editorCursorChange
74+
- editorScrollChange Broadcast: editorScrollChange
7575
- updateState Broadcast: updateState
7676
- turnChange Broadcast: turnChange
7777
- createNewGist Broadcast: createNewGist
@@ -102,7 +102,7 @@ io.on('connection', function (socket) {
102102
//console.log('\t\t playerList.length: ' + playerList.length);
103103

104104
// When a user logs in,
105-
socket.on('loggedIn', function (userData) {
105+
socket.on('userLogin', function (userData) {
106106
console.log('\n* * * * # # # # User logged in! # # # # * * * * *');
107107
console.log('\t\t > > > ' + userData.login + ' < < <\n');
108108
//console.log('\t\t playerList.length: ' + playerList.length);
@@ -114,12 +114,12 @@ io.on('connection', function (socket) {
114114
playerList.push(socket.id);
115115

116116
// Send current state of the text editor to the new client, to initialize!
117-
socket.emit('editorChange', editorContent);
117+
socket.emit('editorTextChange', editorContent);
118118
if (editorScroll != null) {
119-
socket.emit('changeScroll', editorScroll);
119+
socket.emit('editorScrollChange', editorScroll);
120120
}
121121
if (editorCursorAndSelection != null) {
122-
socket.emit('changeCursor', editorCursorAndSelection);
122+
socket.emit('editorCursorChange', editorCursorAndSelection);
123123
}
124124

125125
// Initialize the turn (and timer) with first connected user
@@ -137,7 +137,7 @@ io.on('connection', function (socket) {
137137
// Broadcast updated playerList to ALL clients
138138
io.emit('playerListChange', playerData);
139139

140-
console.log('\non("loggedIn") -- turnData broadcasted!\n');
140+
console.log('\non("userLogin") -- turnData broadcasted!\n');
141141
//console.log( getTurnData() );
142142

143143
//console.log(' ! ! ! ! ! ! player data and list ! ! ! ! ! !');
@@ -204,10 +204,10 @@ io.on('connection', function (socket) {
204204
}
205205
});
206206

207-
// When "editorChange" event received, update editor state and broadcast it back out
208-
socket.on('editorChange', function (data) {
207+
// When "editorTextChange" event received, update editor state and broadcast it back out
208+
socket.on('editorTextChange', function (data) {
209209

210-
//console.log('editorChange event received!');
210+
//console.log('editorTextChange event received!');
211211
//console.log(data);
212212

213213
// Double check that this user is allowed to type (in case of client-side tampering with the JS!)
@@ -216,17 +216,17 @@ io.on('connection', function (socket) {
216216
editorContent = data;
217217

218218
// Broadcast updated editor content to other clients
219-
socket.broadcast.emit('editorChange', editorContent);
219+
socket.broadcast.emit('editorTextChange', editorContent);
220220

221221
//console.log('Broadcasting editorContent to other clients!');
222222
}
223223

224224
});
225225

226-
// When "changeCursor" event received, update editor state and broadcast it back out
227-
socket.on('changeCursor', function (data) {
226+
// When "editorCursorChange" event received, update editor state and broadcast it back out
227+
socket.on('editorCursorChange', function (data) {
228228

229-
//console.log('changeCursor event received!');
229+
//console.log('editorCursorChange event received!');
230230
//console.log(data);
231231

232232
// Double check that this user is allowed to broadcast (in case of client-side tampering with the JS!)
@@ -235,17 +235,17 @@ io.on('connection', function (socket) {
235235
editorCursorAndSelection = data;
236236

237237
// Broadcast data to other clients
238-
socket.broadcast.emit('changeCursor', editorCursorAndSelection);
238+
socket.broadcast.emit('editorCursorChange', editorCursorAndSelection);
239239

240-
//console.log('Broadcasting changeCursor to other clients!');
240+
//console.log('Broadcasting editorCursorChange to other clients!');
241241
}
242242

243243
});
244244

245-
// When "changeScroll" event received, update editor state and broadcast it back out
246-
socket.on('changeScroll', function (data) {
245+
// When "editorScrollChange" event received, update editor state and broadcast it back out
246+
socket.on('editorScrollChange', function (data) {
247247

248-
//console.log('changeScroll event received!');
248+
//console.log('editorScrollChange event received!');
249249
//console.log(data);
250250

251251
// Double check that this user is allowed to broadcast (in case of client-side tampering with the JS!)
@@ -254,9 +254,9 @@ io.on('connection', function (socket) {
254254
editorScroll = data;
255255

256256
// Broadcast data to other clients
257-
socket.broadcast.emit('changeScroll', editorScroll);
257+
socket.broadcast.emit('editorScrollChange', editorScroll);
258258

259-
//console.log('Broadcasting changeScroll to other clients!');
259+
//console.log('Broadcasting editorScrollChange to other clients!');
260260
}
261261

262262
});

0 commit comments

Comments
 (0)