Try a little tenderness

Transcript

1. Coding is a fucking mess, big programs are complex and troublesome...
   follow Ottis advice and
   Try a little tenderness
2. Who am I?
3. Pau Ramon CTO at Teambox ! @masylum github.com/masylum
   
4. This talk is about good code style principles
5. Why caring about style?
6. Development is not the bottleneck,
   maintenance is
7. Code may be ugly, but is what you stare at all day
8. Mind your API Expose only what you need
9. Mind your API var obj = {}; obj.pi = 3.14; obj.circumference = function (r) { return num * this.pi; };
10. Mind your API var obj = {}; var pi = 3.14; obj.circumference = function (r) { return r * a; };
11. Be verbose Good naming
12. Be verbose function avg(xs) { var s = i = 0; var l = xs.length; for(; i < l; i++;){ s += parseInt(xs[i]); } return s / l; }
13. Be verbose function average(numbers) { var sum = i = 0; var length = numbers.length; for(; i < length; i++;){ sum += parseInt(numbers[i]); } return sum / length; }
14. Explicit over Implicit Magic is for magicians
15. Explicit over Implicit function Dog() { this.speed = 4; } require(‘run’); var dog = new Dog(); dog.run();
16. Explicit over Implicit function Dog() { this.speed = 4; } Dog.prototype.run = require(‘run’); var dog = new Dog(); dog.run();
17. Careful with DRY It creates dependencies
18. Careful with DRY function truncateName(el) { var attr = el.type === ‘user’ ? ‘fullName’ : ‘name’; return el[attr].substring(0, 40); }
19. Careful with DRY function truncate(string) { return string.substring(0, 40); } truncate(user.fullName); truncate(project.name);
20. Lines of code syndrome The myth of less is more
21. Lines of code syndrome function isUrgent(id) { if (task = Task.find(id) && task.urgent) return true; return false; }
22. Lines of code syndrome function isUrgent(id) { var task = Task.find(id); if (task && task.urgent) { return true; } return false; }
23. Self explanatory code Avoid inline comments
24. Self explanatory code function removeUser(id) { // find user var user = User.find(id); ... // remove tasks return user.tasks.remove(); }
25. Self explanatory code function removeUser(id) { var user = findUser(id); return removeTasks(user); }
26. Write contracts Document your API
27. Write contracts // removes the user function removeUser(id) ...
28. Write contracts /** * Removes the user and all his * assigned tasks * * @param {Number} id - user id * @return {Boolean} - did work? */ function removeUser(id) ...
29. Beware of nesting Flow control complexity
30. Beware of nesting function isComplete(task) { var comment = task.comment; if (comment) if (comment.status === 3) return true; return task.isResolved(); }
31. Beware of nesting function isComplete(task) { var comment = task.comment; if (comment) { return comment.isComplete(); } return task.isResolved(); }
32. Beware of nesting setTimeout(function () { setTimeout(function () { console.log(‘B’); }, 10); }, 20);
33. Beware of nesting ! function secondMethod() { console.log(‘B’); } function firstMethod() { setTimeout(secondMethod, 10); } setTimeout(firstMethod, 20);
34. Use tools They are better than you
35. Use tools • Have static analyzers to detect bad code practices and syntax errors • Use tools that can provide metrics • Integrate your tools with your editor • Integrate your tools with your process
36. Use tools • Javascript: JSHint • Ruby: Cane, Rubocop • IDE • SAAS: Codeclimate
37. Avoid broken windows With metrics and processes
38. Avoid broken windows • Before pushing: Git hooks • Before merging a branch: Travis • Before deploying a release: Jenkins