Pro-bunfighting

The process of API design in teams.
Web Standards Group, London.

Transcript

1. Pro bun-fighting Testing, quality and group hugs
2. What the who? Frances Berriman BBC Glow JavaScript Library General web nerd London based…
3. Jake Archibald
4. Michael Mathews* *not actually Michael, but an entertaining real photo could not be located
5. … and that’s it.
6. … and that’s it. Steve Elson
8. … and that’s it. Ed Scotcher
9. … and that’s it. I love Glow for 1/6th of my day! Ed Scotcher
10. A small and distributed problem There’s only 3 of us. 2/3rds live in not-London. Build, support & learn.
11. Problem 1: Communicating what we want to make
12. Why care?
13. The unwrap() method “We need something that'll let us get a node and remove it from whatever it's in, and remove the parent, and then it needs to put the thing that's being unwrapped back in place. And then we'll give the user back what we put in. Any objections?”
14. The unwrap() method “We need something that'll let us get a node and remove it from whatever it's in, and remove the parent, and then it needs to put the thing that's being unwrapped back in place. And then we'll give the user back what they put in. Any objections?”
15. In JSDoc… @name glow.NodeList#unwrap @function @description Removes the parent of each item in the list @returns {glow.NodeList} The now unwrapped elements @example // Before: <div><p><span id="mySpan">Hello</span></p></div> // unwrap the given element glow("#mySpan").unwrap(); // After: <div><span id="mySpan">Hello</span></div>
16. In JSDoc… @name glow.NodeList#unwrap @function @description Removes the parent of each item in the list @returns {glow.NodeList} The now unwrapped elements @example // Before: <div><p><span id="mySpan">Hello</span></p></div> // unwrap the given element glow("#mySpan").unwrap(); // After: <div><span id="mySpan">Hello</span></div>
17. The bun-fight
18. Free documentation
19. Problem 2: Checking what we’ve made actually works
20. Qunit
21. unwrap() test example module('glow.NodeList#unwrap', {setup:setup, teardown:teardown});
22. unwrap() test example module('glow.NodeList#unwrap', {setup:setup, teardown:teardown}); test('glow.dom.NodeList#unwrap multiple elements with same parent', 8, function() { });
23. unwrap() test example module('glow.NodeList#unwrap', {setup:setup, teardown:teardown}); test('glow.dom.NodeList#unwrap multiple elements with same parent', 8, function() { var myNodeList = new glow.NodeList( byId('elmWithMixedNodes').childNodes ), returnNodeList; equal(typeof myNodeList.unwrap, 'function', 'glow.NodeList#unwrap is a function');
24. unwrap() test example module('glow.NodeList#unwrap', {setup:setup, teardown:teardown}); test('glow.dom.NodeList#unwrap multiple elements with same parent', 8, function() { var myNodeList = new glow.NodeList( byId('elmWithMixedNodes').childNodes ), returnNodeList; equal(typeof myNodeList.unwrap, 'function', 'glow.NodeList#unwrap is a function'); returnNodeList = myNodeList.unwrap(); strictEqual(returnNodeList, myNodeList, 'Same nodelist returned'); myNodeList.each(function() { equal(this.parentNode.id, 'testElmsContainer', 'Node moved to parent'); }); equal(myNodeList.item(0).prev()[0].id, 'elmWithTextNodes', 'Node inserted in correct position');
25. Sanity checking & code reviews
26. Conflict resolution
27. Problem 3: Checking what we’ve made is fast
28. Why Woosh?
29. Creating tests
30. Run time How long does it take for this method to run 1000 times? woosh.addTests('glow2-src', { 'unwrap': new woosh.Test(1000, function() { // unwrap and keep count of unwraps performed }), }
31. Over time How many times does this method run in a second? woosh.addTests('glow2-src', { 'unwrap': new woosh.TimeTest(1, function() { // unwrap and keep count of unwraps performed }), }
32. Live demo
36. The headlines • Treat documentation like code • There's no such thing as too many unit tests • Benchmark regularly if you want to get fast
37. And the rest
38. Roll credits Frances Berriman / @phae fberriman.com github.com/glow/glow2 Additional photos courtesy of: flickr.com/photos/stevec77/3870451388 flickr.com/photos/willsisti/4037142479 flickr.com/photos/jaffathecake/2835837370 flickr.com/photos/elson/3555981445