require.js - Speaker Deck

Slide 1

Slide 1 text

require.js a keynote information loader about a javascript module loader Wednesday, March 27, 13

Slide 2

Slide 2 text

what is requires • a javascript module loader Wednesday, March 27, 13

Slide 3

Slide 3 text

where to get it? • http://requirejs.org Wednesday, March 27, 13

Slide 4

Slide 4 text

who has it? wget http://requirejs.org/docs/release/2.1.5/miniﬁed/require.js \ -O ./public/js/require.min.js wget http://requirejs.org/docs/release/2.1.5/comments/require.js \ -O ./public/js/require.js Wednesday, March 27, 13

Slide 5

Slide 5 text

why do I need it? Wednesday, March 27, 13

Slide 6

Slide 6 text

why do I need it? • Web sites are turning into Web apps Wednesday, March 27, 13

Slide 7

Slide 7 text

why do I need it? • Web sites are turning into Web apps • Code complexity grows as the site gets bigger Wednesday, March 27, 13

Slide 8

Slide 8 text

why do I need it? • Web sites are turning into Web apps • Code complexity grows as the site gets bigger • Assembly gets harder Wednesday, March 27, 13

Slide 9

Slide 9 text

why do I need it? • Web sites are turning into Web apps • Code complexity grows as the site gets bigger • Assembly gets harder • Developer wants discrete JS ﬁles/modules Wednesday, March 27, 13

Slide 10

Slide 10 text

why do I need it? • Web sites are turning into Web apps • Code complexity grows as the site gets bigger • Assembly gets harder • Developer wants discrete JS ﬁles/modules • Deployment wants optimized code in just one or a few HTTP calls Wednesday, March 27, 13

Slide 11

Slide 11 text

how does it solve this? Wednesday, March 27, 13

Slide 12

Slide 12 text

how does it solve this? • Some sort of #include/import/require Wednesday, March 27, 13

Slide 13

Slide 13 text

how does it solve this? • Some sort of #include/import/require • ability to load nested dependencies Wednesday, March 27, 13

Slide 14

Slide 14 text

how does it solve this? • Some sort of #include/import/require • ability to load nested dependencies • ease of use for developer but then backed by an optimization tool that helps deployment Wednesday, March 27, 13

Slide 15

Slide 15 text

how do I use require.js? // index.html // scripts/main.js require(["loc/module"], function(module) { //This function is called when scripts/loc/module.js is loaded. //If module.js calls deﬁne(), then this function is not ﬁred until //util's dependencies have loaded, and the util argument will hold //the module value for "helper/util". }); Wednesday, March 27, 13

Slide 16

Slide 16 text

Slide 17

Slide 17 text

Slide 18

Slide 18 text

writing a module, today (function ($) { function Foo() { // do stuff here! } new Foo(); }(jQuery)); Wednesday, March 27, 13

Slide 19

Slide 19 text

writing a module, today var $ = require('jquery'); exports.myExample = function () { // do stuff here! }; Wednesday, March 27, 13

Slide 20

Slide 20 text

writing a module, today++: AMD deﬁne('mod',function(){ return function() { this.boom = function () { alert( 'Boom' ); }; } } ); Wednesday, March 27, 13

Slide 21

Slide 21 text

What is AMD? • Asynchronous Module Deﬁnition Wednesday, March 27, 13

Slide 22

Slide 22 text

why is this good? • Uses the CommonJS practice of string IDs for dependencies • IDs can be mapped to different paths. • Encapsulates the module definition. • Clear path to defining the module value. • Allows setting a function as a return value. Useful for constructor functions. • Defines a way to include multiple modules in one file. Wednesday, March 27, 13

Slide 23

Slide 23 text

why is this good? • Easy to test, because modules are compartmentalized • Dependency Injection Wednesday, March 27, 13

Slide 24

Slide 24 text

amd still handles this (function () { this.myGlobal = function () {}; }()); Wednesday, March 27, 13

Slide 25

Slide 25 text

require still supports normal javascript require(["some/script.js"], function() { //This function is called after some/script.js has loaded. }); Wednesday, March 27, 13

Slide 26

Slide 26 text

It’s easy! • http://requirejs.org/docs/why.html Wednesday, March 27, 13

Slide 27

Slide 27 text

Optimization! • We can compile all requirements into one ﬁle • We can minimize CSS and JavaScript using Closure Compiler (or UglifyJS) • We aren’t worried about CSS today Wednesday, March 27, 13

Slide 28

Slide 28 text

Can run... • In the browser • In Node • In Rhino Wednesday, March 27, 13

Slide 29

Slide 29 text

Using Closure Compiler • Means uses Java • Means using Rhino • r.js Wednesday, March 27, 13

Slide 30

Slide 30 text

jscompile #!/bin/sh java -classpath /Users/jasonlotito/Downloads/rhino1_7R4/js.jar:/Users/ jasonlotito/Downloads/compiler-latest/compiler.jar org.mozilla.javascript.tools.shell.Main r.js -o $1 Wednesday, March 27, 13

Slide 31

Slide 31 text

Getting the Compiler • http://requirejs.org/docs/download.html#rjs Wednesday, March 27, 13

Slide 32

Slide 32 text

compiler java -classpath /Users/jasonlotito/Downloads/rhino1_7R4/js.jar:/Users/ jasonlotito/Downloads/compiler-latest/compiler.jar org.mozilla.javascript.tools.shell.Main r.js -o $1 Wednesday, March 27, 13

Slide 33

Slide 33 text

compiler java -classpath /Users/jasonlotito/Downloads/rhino1_7R4/js.jar:/ Users/jasonlotito/Downloads/compiler-latest/compiler.jar org.mozilla.javascript.tools.shell.Main r.js -o $1 Wednesday, March 27, 13

Slide 34

Slide 34 text

Slide 35

Slide 35 text

Slide 36

Slide 36 text

Slide 37

Slide 37 text

Slide 38

Slide 38 text

How to compile? • jscompile path/to/app.build.js Wednesday, March 27, 13

Slide 39

Slide 39 text

What’s app.build.js ({ appDir: "../", baseUrl: "scripts/", dir: "../../webapp-build", optimize: "closure", paths: { "jquery": "empty:" }, modules: [ //Optimize the application ﬁles. jQuery is not //included since it is already in require-jquery.js { name: "main" } ], closure: { CompilerOptions: {}, CompilationLevel: 'SIMPLE_OPTIMIZATIONS', loggingLevel: 'WARNING' }, generateSourceMaps: true, preserveLicenseComments: false }) Wednesday, March 27, 13

Slide 40

Slide 40 text

Alright stop... Let’s make sense of all these options by establishing our surroundings, namely, our project structure Wednesday, March 27, 13

Slide 41

Slide 41 text

Our sample directory structure Wednesday, March 27, 13

Slide 42

Slide 42 text

Our sample directory structure • r.js Wednesday, March 27, 13

Slide 43

Slide 43 text

Our sample directory structure • r.js • webapp/ Wednesday, March 27, 13

Slide 44

Slide 44 text

Our sample directory structure • r.js • webapp/ • app.html Wednesday, March 27, 13

Slide 45

Slide 45 text

Our sample directory structure • r.js • webapp/ • app.html • scripts/ Wednesday, March 27, 13

Slide 46

Slide 46 text

Our sample directory structure • r.js • webapp/ • app.html • scripts/ • app.build.js Wednesday, March 27, 13

Slide 47

Slide 47 text

Our sample directory structure • r.js • webapp/ • app.html • scripts/ • app.build.js • app.build.dev.js Wednesday, March 27, 13

Slide 48

Slide 48 text

Our sample directory structure • r.js • webapp/ • app.html • scripts/ • app.build.js • app.build.dev.js • main.js Wednesday, March 27, 13

Slide 49

Slide 49 text

Our sample directory structure • r.js • webapp/ • app.html • scripts/ • app.build.js • app.build.dev.js • main.js • mod.js Wednesday, March 27, 13

Slide 50

Slide 50 text

the app require( ["jquery", "mod"], function ( $, mod ) { var mod = new mod(); setTimeout( function () { mod.boom(); $( 'h1' ).text( 'Hey you guys!' ); }, 2000 ); setTimeout( function () { mod.boom(); $( 'h1' ).text( 'Baby, ruth?' ); }, 4000 ); setTimeout( function () { mod.boom(); $( 'h1' ).text( 'Trufﬂe Shufﬂe' ); }, 6000 ); } ); Wednesday, March 27, 13

Slide 51

Slide 51 text

the module deﬁne('mod',function(){ return function() { this.boom = function () { alert( 'Boom' ); }; } } ); Wednesday, March 27, 13

Slide 52

Slide 52 text

modules can include other modules deﬁne('mod',['member/photos'],function(photos){ return function() { this.boom = function () { alert( 'Boom' ); photos.boom(); }; } } ); Wednesday, March 27, 13

Slide 53

Slide 53 text

Compiled! whee! Wednesday, March 27, 13

Slide 54

Slide 54 text

Compiled and minified via Closure Compiler (function(){define("mod",[],function(){return function(){this.boom=function() {alert("Boom")}}});require(["jquery","mod"],function(b,a){a=new a;setTimeout(function(){a.boom();b("h1").text("Hey you guys!")}, 2E3);setTimeout(function(){a.boom();b("h1").text("Baby, ruth?")}, 4E3);setTimeout(function(){a.boom();b("h1").text("Truffle Shuffle")}, 6E3)});define("main",function(){})})(); //@ sourceMappingURL=main.js.map Wednesday, March 27, 13

Slide 55

Slide 55 text

Compiled with Source Maps closure: { CompilerOptions: {}, CompilationLevel: 'SIMPLE_OPTIMIZATIONS', loggingLevel: 'WARNING' }, generateSourceMaps: true, preserveLicenseComments: false Wednesday, March 27, 13

Slide 56

Slide 56 text

.map file {"version":3, "file":"main.js", "lineCount":1, "mappings":"AAAC,SAAA,GACDA,MAAA,UAAgB,QAAA,SACP,SAAA,GACLC, SADK,CACOC,QAAAA,GAEVC,KAAA,QAFUD,CADP,CADO,CAAhB,CASA E,QAAA,kBAA4B,QAAA,CAAWC,CAAX,CAAcC,CAAd,EAEtBA,CAFsB,CAE hB,IAAIA,CAEdC,WAAA,CAAY,QAAA,GAEVD,CAAAL,KAAA,EACAI,EAAA, MAAAG,KAAA,iBAHU,CAAZ,KAMAD,WAAA,CAAY,QAAA,GAEVD,CAAAL, KAAA,EACAI,EAAA,MAAAG,KAAA,eAHU,CAAZ,KAMAD,WAAA,CAAY,QA AA,GAEVD,CAAAL,KAAA,EACAI,EAAA,MAAAG,KAAA,mBAHU,CAAZ,KAh B0B,CAA5B,CAwBAR,OAAA,QAAe,QAAA,IAAf,CAlCC,EAAA;", "sources":["main.js.src"], "names": ["define","boom","this.boom","alert","require","$","mod","setTimeout","text"]} Wednesday, March 27, 13

Slide 57

Slide 57 text

testing define( 'mod', ['Profile'], function ( Profile ) { function mod() { this.boom = function () { return (new Profile()).mockTrueLol(); }; } return mod; } ); Wednesday, March 27, 13

Slide 58

Slide 58 text

JSTestDriver # tests.jstd load: - r.js - webapp/tests/app.build.test.js # This let’s JSTestRunner serve up all the scripts for require serve: - webapp/scripts/*.js # Could also just do - webapp/tests/*.js test: - webapp/tests/GangTest.js - webapp/tests/LandTest.js - webapp/tests/ProﬁleTest.js - webapp/tests/TestJSTestDriver.js Wednesday, March 27, 13

Slide 59

Slide 59 text

JSTestRunner # tests.jstd load: - r.js - webapp/tests/app.build.test.js # This let’s JSTestRunner serve up all the scripts for require serve: - webapp/scripts/*.js # Could also just do - webapp/tests/*.js test: - webapp/tests/GangTest.js - webapp/tests/LandTest.js - webapp/tests/ProﬁleTest.js - webapp/tests/TestJSTestDriver.js Wednesday, March 27, 13

Slide 60

Slide 60 text

Slide 61

Slide 61 text

Slide 62

Slide 62 text

TestJSTestDriver (function (){ var Mod; AsyncTestCase( "TestJSTestDriver", { setUp: function ( queue ){ queue.call( function ( callbacks ){ require.undef( 'Profile' ); define( 'Profile', function (){ function Profile() {} Profile.prototype.mockTrueLol = function() { return true; }; return Profile; } ); require( [ 'mod' ], callbacks.add( function ( m ){ Mod = new m(); } ) ); } ); }, // tests here } ); })(); Wednesday, March 27, 13

Slide 63

Slide 63 text

Slide 64

Slide 64 text

Slide 65

Slide 65 text

Slide 66

Slide 66 text

Slide 67

Slide 67 text

Slide 68

Slide 68 text

Slide 69

Slide 69 text

TestJSTestDriver (function (){ var Mod; AsyncTestCase( "TestJSTestDriver", { // setUp here tearDown: function (){ Mod = null; }, "test Mod is setup": function (){ assertTrue( Mod.hasOwnProperty( 'boom' ) ); assertTrue( Mod.boom() ); } } ); })(); Wednesday, March 27, 13

Slide 70

Slide 70 text

Slide 71

Slide 71 text

Slide 72

Slide 72 text

PHPStorm Code and Compile Example They all worked before, honest! Wednesday, March 27, 13