-
Notifications
You must be signed in to change notification settings - Fork 20
/
Module.coffee
716 lines (592 loc) · 31.4 KB
/
Module.coffee
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
_.mixin (require 'underscore.string').exports()
fs = require 'fs'
util = require 'util'
When = require 'when'
# uRequire
upath = require 'upath'
ModuleGeneratorTemplates = require '../templates/ModuleGeneratorTemplates'
TextResource = require './TextResource'
Dependency = require "./Dependency"
isTrueOrFileMatch = require '../config/isTrueOrFileMatch'
isLikeCode = require "../codeUtils/isLikeCode"
isEqualCode = require "../codeUtils/isEqualCode"
replaceCode = require "../codeUtils/replaceCode"
toAST = require "../codeUtils/toAST"
toCode = require "../codeUtils/toCode"
# Represents a Javascript nodejs/commonjs or AMD module
class Module extends TextResource
# override @dstFilename, save modules in build.template._combinedTemp if it exists
Object.defineProperties @::,
dstPath: get:->
if @bundle?.build.template._combinedTemp
@bundle.build.template._combinedTemp
else
if @bundle?.build.dstPath
@bundle.build.dstPath
else
''
# @todo: infer 'booleanOrFilespecs' from blendConfigs (with 'arraysConcatOrOverwrite' BlenderBehavior ?)
# @todo: move method to BundleFile, keep only this data to Module
for bof in ['useStrict', 'bare', 'globalWindow',
'runtimeInfo', 'rootExports_ignore',
'rootExports_noConflict'
'allNodeRequires', 'dummyParams'
'scanAllow', 'injectExportsModule',
'noLoaderUMD', 'warnNoLoaderUMD']
do (bof) ->
Object.defineProperty Module::, 'is'+ _.capitalize(bof),
get: ->
value = _B.getp @bundle?.build, bof, separator: '_'
isTrueOrFileMatch value, @path
###
Check if `super` in TextResource has spotted changes and thus has a possibly changed @converted (javascript code)
& call `@adjust()` if so.
It does not actually convert to any template - the bundle building does that
But the module info needs to provide dependencies information (eg to inject Dependencies etc)
###
refresh: ->
super.then (superRefreshed)=>
if not superRefreshed
@hasChanged = false # no change in parent, why should I change ?
else
if @sourceCodeJs is @converted # @converted is produced by TextResource's refresh
l.verbose "No changes in **compiled sourceCodeJs** of module '#{@srcFilename}' "
@hasChanged = false
else
@sourceCodeJs = @converted
@parse()
if _.isEqual @AST_top, @AST_top_previous
l.verbose "No changes in **parsed AST sourceCodeJs** of module '#{@srcFilename}' "
@hasChanged = false
else
if @bundle?.build?.watch.enabled is true # to know when refresh() hasChanged next time
@AST_top_previous = _.clone @AST_top, true # keep a deep clone (cause @AST_top mutates)
delete @beforeBody
delete @afterBody
delete @mergedCode
@extract()
@prepare()
@hasChanged = true
reset:->
super
delete @sourceCodeJs
delete @AST_top_previous
delete @beforeBody
delete @afterBody
delete @mergedCode
@resetModuleInfo()
# init / clear stuff & create those on demand
resetModuleInfo:->
@flags = {}
# delete @[dv] for dv in @AST_data
@[dv] = [] for dv in @keys_extractedDepsAndVarsArrays
delete @defineArrayDeps # = [] @todo: set to []
delete @parameters # = []
# keep a reference to our data, easy to init & export
AST_data: [
'AST_top', 'AST_body', 'AST_factoryBody'
'AST_preDefineIIFENodes'
]
keys_extractedDepsAndVarsArrays: [
'ext_defineArrayDeps', 'ext_defineFactoryParams'
'ext_requireDeps', 'ext_requireVars'
'ext_asyncRequireDeps', 'ext_asyncFactoryParams'
]
keys_resolvedDependencies: [
'defineArrayDeps', 'nodeDeps'
]
# info for debuging / testing (empties are eliminated)
info: ->
info = {}
for p in _.flatten [
@keys_extractedDepsAndVarsArrays,
@keys_resolvedDependencies, [
'flags', 'name', 'kind', 'path'
'factoryBody', 'preDefineIIFEBody', 'parameters']
]
if !_.isEmpty @[p]
if _.isArray @[p]
info[p] = _.map @[p], (x)=>
if p in @keys_resolvedDependencies
x.name() # return fileRelative, with plugin & ext if exists
else
x.toString() # return as is
else
info[p] = @[p]
info
# Read the AST of defineArrayDeps & factory params and add them to the corresponding arrays
readArrayDepsAndVars: (arrayAst, arrayDeps, paramsAst, factoryParams) ->
for astArrayDep, idx in arrayAst.elements
param = paramsAst[idx]?.name
if _B.isLike {type: 'Literal'}, astArrayDep # astArrayDep is { type: 'Literal', value: 'someString' }
arrayDep = new Dependency astArrayDep.value, @,
AST_requireLiterals: [ astArrayDep ] # store refs to ASTs of this dep for quick replacements
else
arrayDep = new Dependency (@toCode astArrayDep), @, {
untrusted:true,
AST_requireUntrustedDep: [astArrayDep]} # useless for now
arrayDeps.push arrayDep if arrayDep
factoryParams.push param if param
# add excessive params as they are
for excParamIdx in [arrayAst.elements.length..paramsAst.length-1] by 1
factoryParams.push paramsAst[excParamIdx]?.name
@
# called at each AST node as the AST tree is traversed
requireFinder: (prop, src, dst, blender)=> # bind to this instance
# do we have a `require()` CallExpression nested somewhere ?
if _B.isLike {type:"CallExpression", callee: {type: "Identifier", name: "require"}}, src[prop]
if _B.isLike {arguments: [type: 'Literal']}, src[prop] # require('aStringLiteral')
requireDep = new Dependency src[prop].arguments[0].value, @,
AST_requireLiterals: [ src[prop].arguments[0] ]
else # require( non literal expression ) #@todo: warn for wrong signature
# signature of async `require([dep1, dep2], function(dep1, dep2){...})`
if _B.isLike [{type: 'ArrayExpression'}, {type: 'FunctionExpression'}], src[prop].arguments
args = src[prop].arguments
@readArrayDepsAndVars(args[0], (@ext_asyncRequireDeps or= []), # async require deps array, at pos 0
args[1].params, (@ext_asyncFactoryParams or= []) ) # async factory function, at pos 1
else
requireDep = new Dependency (@toCode src[prop].arguments[0]), @, untrusted:true
# store the assigned or declared requireVar
if _B.isLike({type: 'AssignmentExpression', left: type:'Identifier'}, src) or
_B.isLike({type: 'VariableDeclarator', id: type: 'Identifier'}, src)
requireVar =
if _B.isLike type: 'AssignmentExpression', src
src.left.name
else # assigned as a declaration
src.id.name
# warn if `require('string literal')` signature is wrong
if src[prop].arguments.length > 1 #@todo: improve
l.warn """Wrong require() signature in #{@toCode src[prop]}
Use the proper AMD `require([dep1, dep2], function(dep1, dep2){...})` for the asnychronous AMD require."""
# keep dep & var together - insert at the index of last var
# push deps without a var to the end
if requireDep
if requireVar
(@ext_requireVars or= []).push requireVar
(@ext_requireDeps or= []).splice @ext_requireVars.length-1, 0, requireDep
else
(@ext_requireDeps or= []).push requireDep
return null
parse: ->
l.debug "Module::parse() for '#{@srcFilename}'" if l.deb 70
try
@AST_top = toAST @sourceCodeJs #, {comment:true, range:true}
catch err
throw new UError "Error parsing Module's '#{@srcFilename}' javascript.", nested: err
@
extract: ->
l.debug "Module::extract for '#{@srcFilename}'" if l.deb 70
@resetModuleInfo()
# retrieve bare body, i.e without coffeescript IIFE (function(){..body..}).call(this);
if isLikeCode('(function(){}).call()', @AST_top.body) or
isLikeCode('(function(){}).apply()', @AST_top.body)
@AST_body = @AST_top.body[0].expression.callee.object.body.body
@AST_preDefineIIFENodes = [] # store all nodes along IIFEied define()
else
if isLikeCode '(function(){})()', @AST_top.body
@AST_body = @AST_top.body[0].expression.callee.body.body
@AST_preDefineIIFENodes = [] # store all nodes along IIFEied define()
else
@AST_body = @AST_top.body
# we now have our @AST_body, with no IIFE
defines = [] # should contain max one define()
for bodyNode, idx in @AST_body
# look for a) single define call b) flags
# store preDefineIIFENodes, but exclude flags and amdefine :-)
if bodyNode.expression and isLikeCode 'define()', bodyNode
defines.push bodyNode.expression
if defines.length > 1
throw new UError "Each AMD file shoule have one (top-level or IIFE) define call - found #{defines.length} `define` calls"
else
currentBranchBodyNode = bodyNode
currentConsequent = currentBranchBodyNode.consequent
defineFound = false
while (not defineFound) and currentConsequent
if isLikeCode 'define()', currentConsequent.body
defines.push currentConsequent.body[0].expression
defineFound = true
if defines.length > 1
throw new UError "Each AMD file should have one (top-level or IIFE) define call - found #{defines.length} `define` calls"
else
currentBranchBodyNode = currentBranchBodyNode.alternate
currentConsequent = if currentBranchBodyNode then currentBranchBodyNode.consequent else null
if not defineFound
# grab flags - dont add to @AST_preDefineIIFENodes
if isLikeCode '({urequire:{}})', bodyNode
@flags = (eval @toCode bodyNode).urequire
else
# omit 'amdefine' from @AST_preDefineIIFENodes
if not (isLikeCode('var define;', bodyNode) or
isLikeCode('if(typeof define!=="function"){define=require("amdefine")(module);}', bodyNode) or
isLikeCode('if(typeof define!=="function"){var define=require("amdefine")(module);}', bodyNode)) and
not isLikeCode(';', bodyNode) and @AST_preDefineIIFENodes
@AST_preDefineIIFENodes.push bodyNode
# AMD module
if defines.length is 1
define = defines[0]
args = define.arguments
@kind = 'AMD'
@name = args[0].value if args.length is 3
if args[args.length-1].type is 'Identifier'
AMDSignature = ['Literal', 'ArrayExpression', 'Identifier' ]
for i in [0..args.length-1]
if args[i].type isnt AMDSignature[i+(3-args.length)]
throw new UError "Invalid AMD define() signature with #{args.length} args: got a '#{args[i].type}' as arg #{i}, expected a '#{AMDSignature[i+(3-args.length)]}'."
factoryParamName = args[args.length-1].name
for i in [0..this.AST_top.body[0].expression.callee.params.length-1]
if this.AST_top.body[0].expression.callee.params[i].name is factoryParamName
factory = this.AST_top.body[0].expression.arguments[i]
else
AMDSignature = ['Literal', 'ArrayExpression'
if args[args.length-1].type is 'FunctionExpression'
'FunctionExpression'
else
if args[args.length-1].type is 'ArrowFunctionExpression'
'ArrowFunctionExpression'
else
throw new UError "Invalid AMD define() signature" + _.pluck(args, 'type').join ', '
]
for i in [0..args.length-1]
if args[i].type isnt AMDSignature[i+(3-args.length)]
throw new UError "Invalid AMD define() signature with #{args.length} args: got a '#{args[i].type}' as arg #{i}, expected a '#{AMDSignature[i+(3-args.length)]}'."
factory = args[args.length-1]
if args.length >=2
@readArrayDepsAndVars args[args.length-2], @ext_defineArrayDeps, # deps array : either at pos 0 or 1, followed by factory function
factory.params, @ext_defineFactoryParams # factory function, always last argument
else # just 1 factory arg - pluck name
@ext_defineFactoryParams = _.map factory.params, 'name'
@AST_factoryBody = factory.body
else
@kind = 'nodejs'
@AST_factoryBody =
if _.isEmpty @AST_preDefineIIFENodes
@AST_body
else
@AST_preDefineIIFENodes #use instead of @AST_body, as it ommits flags
delete @AST_preDefineIIFENodes
_B.traverse @AST_factoryBody, @requireFinder # store info from `require()` calls
l.debug "'#{@srcFilename}' extracted module .info():\n", _.omit @info(), ['factoryBody', 'preDefineIIFEBody'] if l.deb 90
@
# leave basic extracted as is, but create the Dependency arrays actually used on template
prepare: ->
l.debug "@prepare for '#{@srcFilename}'\n" if l.deb 70
# Store @parameters removing *redundant* ones (those in excess of @ext_defineArrayDeps):
# RequireJS doesn't like them if require is 1st param!
@parameters =
if @ext_defineArrayDeps.length is 0
[]
else
@ext_defineFactoryParams[0..@ext_defineArrayDeps.length-1]
if (@ext_defineArrayDeps.length < @ext_defineFactoryParams.length)
l.deb "module `#{@path}`: Discarding redundant define factory parameters", @ext_defineFactoryParams[@ext_defineArrayDeps.length..] if l.deb 5
# add dummy params for deps without corresponding params
if @isDummyParams
if (lenDiff = @ext_defineArrayDeps.length - @parameters.length) > 0
@parameters.push "___dummy___param__#{pi}" for pi in [1..lenDiff]
# Our final' defineArrayDeps will eventually have -in this order-:
# - original ext_defineArrayDeps, each instantiated as a Dependency
# - all dependencies.imports, if template is not 'combined'
# - module injected dependencies
# - Add all deps in `require('dep')`, from @module.ext_requireDeps are added
# @see adjust
@defineArrayDeps = (dep.clone() for dep in @ext_defineArrayDeps)
# 'require' & associates are *fixed* in UMD template (if needed), so remove 'require' as dep & arg
# @todo: check template and with module, exports
if ar1 = (@parameters[0] is 'require') | ar2 = (@defineArrayDeps[0]?.isEqual? 'require')
if ar1 and (ar2 or @defineArrayDeps[0] is undefined)
@parameters.shift()
@defineArrayDeps.shift()
else
throw new UError("Module '#{@path}':" +
if ar1 then "1st define factory argument is 'require', but 1st dependency is '#{@defineArrayDeps[0]}'"
else "1st dependency is 'require', but 1st define factory argument is '#{@parameters[0]}'")
@
###
Produce final template information:
- bundleRelative deps like `require('path/dep')` in factory, are replaced with their fileRelative counterpart
- injecting dependencies?.exports?.bundle
- add @ext_requireDeps to @defineArrayDeps
@todo: decouple from build, use calculated (cached) properties, populated at convertWithTemplate(@build) step
###
adjust: (@build) ->
if @build?.template?.name isnt 'combined' # 'combined doesn't need them - they are added to the define that calls the factory
@injectDeps @bundle?.dependencies?.imports
# add rootExports, i.e {'models/PersonModel': ['persons', 'personsModel']}`
# is like having a `{rootExports: ['persons', 'personsModel'], noConflict:true}` in 'models/PersonModel' module.
@flags.rootExports = _B.arrayize @flags.rootExports if @flags.rootExports
if rootExports = @bundle?.dependencies?.rootExports?[@path]
(@flags.rootExports or= []).push rt for rt in _B.arrayize rootExports when rt not in (@flags.rootExports or [])
@flags.noConflict = @isRootExports_noConflict
@webRootMap = @bundle?.webRootMap || '.'
# Add all deps in `require('dep')`, from @module.ext_requireDeps(those not already there)
# Reason: execution stucks on require('dep') if its not loaded (i.e not present in ext_defineArrayDeps).
# see https://github.com/jrburke/requirejs/issues/467
# Even if there are no other arrayDependencies, we still add them all to prevent RequireJS scan @ runtime
# (# RequireJs disables runtime scan if even one dep exists in []).
# We dont add them only if _.isEmpty and `--scanAllow` and we dont have a `rootExports`
addToArrayDependencies = (reqDep)=>
if (not reqDep.isNode )
foundDeps = _.filter @defineArrayDeps, (dep) ->dep.isEqual reqDep
if _.isEmpty foundDeps # if not already there
#reqDep = reqDep.clone() # clone, to keep ext_XXX intact #lo longer needed
@defineArrayDeps.push reqDep
else
for rl in (reqDep.AST_requireLiterals or []) # pass any ASTs to a foundDep so its gets updated.
_.last(foundDeps).AST_requireLiterals.push rl
if not (_.isEmpty(@defineArrayDeps) and @isScanAllow and not @flags.rootExports)
for reqDep in @ext_requireDeps
addToArrayDependencies reqDep
@updateRequireLiteralASTs()
for newDep, oldDeps of (@bundle?.dependencies?.replace or {})
for oldDep in oldDeps
@replaceDep oldDep, newDep, relative: 'bundle'
@
# update dependencies in AST
# It by default replaces each bundleRelative dep in require('someDir/someDep') calls
# with the fileRelative path eg '../someDir/someDep' -that works everywhere-, remove 'node' fake pluging etc
updateRequireLiteralASTs: ->
for dep in _.uniq _.flatten [ @defineArrayDeps, @ext_requireDeps, @ext_asyncRequireDeps ]
if dep and not dep.untrusted
dep.updateAST()
###
inject [depVars] dependencies and their corresponding parameters (inferred if not found) to the whole bundle (i.e defineArrayDeps)
It makes sure that :
* not two same-named parameters are injected - the 'late arrivals' bindings are simply ignored (with a warning). So if a Module already has a parameter `'_'` and you try to inject `'lodash':'_'`, it wont be injected at all.
* Not injecting a self-dependency. If you are at module `'agreements/isAgree'`, trying to inject dependency `'agreements/isAgree'` will be ignored (without a warning, only a debug message).
*Circular dependencies*:
Dependencies are also NOT injected in these two cases that would create Circular dependencies:
* In all other injected dependencies of `depVars` in this `modyle.injectDeps(depVars)` call. This makes sure that in
modyle.injectDeps({
'utils/MyError': 'MyError',
'utils/functionalUtils': 'functionalUtils'
});
both `utils/MyError` & `utils/functionalUtils` will NOT be injected in each other.
* when the module A that is the dependency to be injected in module B, already a dependency to B. So consider a call to
modyle.injectDeps({'config': 'config' });
where `config.js` module is
var defaultConfig = require('common/defaultConfig');
module.exports = helpers.deepMerge(defaultConfig, {foo: {bar: ''}});
and we are about to inject `config.js` as a dependency into `common/defaultConfig`. In this case, we would create a circular dependency which is not what we intended, so urequire will make the decision NOT to inject.
###
injectDeps: (depVars, forceCircular = false) ->
if l.deb(40)
if not _.isEmpty depVars
l.debug("#{@path}: injecting dependencies: ", depVars)
if not @parameters # todo: remove this limitation
throw new UError "Can't use `Module.injectDeps` so early - for now use it on `runAt = 'beforeTemplate` RCs only!"
{dependenciesBindingsBlender} = require '../config/blendConfigs' # circular reference delayed loading
return if _.isEmpty depVars = dependenciesBindingsBlender.blend depVars
@bundle?.inferEmptyDepVars? depVars, "Infering empty depVars from injectDeps for '#{@path}'"
for depName, varNames of depVars
dep = new Dependency depName, @
l.deb 70, "Check if we should inject '#{dep.type}' dependency `#{depName}` into `#{@path}`"
if dep.isEqual @path
l.debug "#{@path}: NOT injecting '#{dep.type}' dependency '#{depName}' on it's self'" if l.deb 50
continue
else
if not forceCircular and dep.isBundle # local modules like 'ramda' as well as system, external etc are always injected
l.deb 90, "Circular dependencies check: should '#{dep.type}' dependency `#{depName}` be injected into `#{@path}`?"
# check the this module is it self an injected dep
if (_.any depVars, (dv, dvDepName) => (new Dependency dvDepName, @).isEqual @path)
l.debug("#{@path}: NOT injecting '#{dep.type}' dependency '#{depName}' on another `injectDeps()` module `#{@path}`'") if l.deb 50
continue
else
# find module to be injected as a dependency, to check its dependencies...
# If this module's @path exist in it's dependencies,
# dont inject it as a dependency (avoid circular dep)
if modToBeInjected = _.find(@bundle?.modules, (m)=> m.path is depName)
if modToBeInjected.getDepsVars()[@path]
l.debug("#{@path}: NOT injecting '#{dep.type}' dependency '#{depName}' on `#{@path}`' because module '#{depName}' has `#{@path}`' as a dependency.") if l.deb 50
continue
# actually inject, if varName not already a param
for varName in varNames # add for all corresponding vars, BEFORE the deps not corresponding to params!
if (varName in @parameters)
l.warn("#{@path}: NOT injecting dependency '#{depName}' as parameter '#{varName}' cause it already exists.") #if l.deb 90
else
@defineArrayDeps.splice @parameters.length, 0, dep
@parameters.push varName
l.debug("#{@path}: injected dependency '#{depName}' as parameter '#{varName}'") if l.deb 70
null
###
Replaces one or more Dependencies with another dependency on the Module (not the whole Bundle).
It makes the replacements on
* All Dependency instances in `@defineArrayDeps` array (which is also where @nodeDeps are derived)
* All AST Literals in code, in deps array ['literal',...] or require('literal') calls,
**always leaving the fileRelative replaceDep string **
@param matchDep {String|RegExp|Function|Dependency} The dependency/ies to match,
@see Dependency::isMatch about dep matching in general
When a partial search is used for matching (noted with `|` at end of dep, for example `'../../lib|'`),
then a partial replacement (i.e translation) is also performed:
All deps that pass `_(dep).startsWith('../../lib')` will get only their '../../lib' path replaced with newDep, instead of a whole replacement.
Hence `mod.replaceDep '../../some2/external/lib|', '../other/wow/lib/'` will do the obvious, translate the first part all mactching deps, i.e `'../../some2/external/lib/DEPENDENCY'` will become `'../other/wow/lib/DEPENDENCY'`.
@see options below for matching & replacing in `relative:'file'` (default) or `relative:'bundle'`
@param replaceDep {Dependency|String|Undefined} The dependency to replace the old with.
* If `replaceDep` is empty, it removes all `matchDep`s from @defineArrayDeps
(BUT NOT FROM THE AST @todo: why not - it can be costly but optional?)
* if its a partial matchDep, then its only the matched part that will be replaced
properly copy & spec of all its properties, plugin etc.
@param options: {relative, plugin, ext} Whether to have these considered
relative: @todo: explain
###
replaceDep: (matchDep, newDep, options = {}) ->
l.deb debugHead = """
Module.replaceDep #{ if newDep then 'REPLACING' else ' DELETING'}: #{
util.inspect options } #{util.inspect matchDep}, #{util.inspect newDep}""" if l.deb 70
if _.isString matchDep
matchDep = new Dependency matchDep, @ # set temporarily, cause we need plugin, resourceName, extension etc extraction
if matchDep instanceof Dependency
if (not options.relative) and # if no specified relative: 'bundle|file'
(not matchDep.isRelative) # if matching a matchDep not starting with '.'
options.relative = 'bundle' # then default to bundle, since we are searching for matchDep within bundle
# otherwise use defaults
if newDep
if not (newDep instanceof Dependency)
if _.isString newDep
newDep = new Dependency newDep, @ # new dep
else
if not _.isFunction newDep
l.er err = "#{debugHead} Wrong new dependency type '#{newDep}' in module #{@path} - should be String|Dependency|Undefined."
throw new UError err
# both matchDep & newDep are Dependency instances now (if newDep exists)
# find & update (or remove) all matching deps in defineArrayDeps
removeArrayIdxs = []
for dep, depIdx in (@defineArrayDeps or [])
depName = dep.name options # relative: options.relative # plugin:false
if isMatch = (if _.isFunction matchDep
matchDep depName, dep, options # dep has plugin, @module, @module.bundle etc
else
dep.isMatch matchDep, options)
if not newDep # just mark idx for lazy removal
l.debug 90, "mark depIdx for lazy removal '#{depIdx}'"
removeArrayIdxs.push depIdx
else # replace part
if matchDep isnt newDep # if matchDep IS newDep no replacement
updDep = if _.isFunction(newDep)
newDep depName, dep
else
newDep
updDep = new Dependency updDep, @ if _.isString updDep # temporary to extract info
if updDep
if not (updDep instanceof Dependency)
l.er err = "Wrong newDep dependency type '#{matchDep}' in module #{@path} - should be String|Function|Dependency."
throw new UError err
else
dep.update updDep, matchDep, options
else
l.deb 90, "mark idx for lazy removal, returned from Function newDep '#{depIdx}'"
removeArrayIdxs.push depIdx
# lazy remove found old deps
for rai in removeArrayIdxs by -1 # in reverse order so idxs stay meaningful
l.deb "delete dependency '#{@defineArrayDeps[rai]}'" if l.deb(80)
@defineArrayDeps.splice rai, 1
@parameters.splice rai, 1
null
###
Returns all deps in this module along with their corresponding parameters (variable names)
@param {Function} depFltr optional callback filtering dependency, called with dep (defaults to all-true fltr)
@return {Object}
{
jquery: ['$', 'jQuery']
lodash: ['_']
'models/person': ['pm']
}
###
getDepsVars: (depFltr=->true) ->
depVars = {}
depVarArrays = # use the Array<Dependency> ones, cause they talk 'bundleRelative'
'defineArrayDeps' : 'parameters'
'ext_requireDeps' : 'ext_requireVars'
'ext_asyncRequireDeps' : 'ext_asyncFactoryParams'
for depsArrayName, varsArrayName of depVarArrays
for dep, idx in (@[depsArrayName] or []) when depFltr(dep)
bundleRelativeDep = dep.name relative:'bundle'
dv = (depVars[bundleRelativeDep] or= [])
# store the variable(s) associated with dep
if @[varsArrayName][idx] and not (@[varsArrayName][idx] in dv )
dv.push @[varsArrayName][idx] # if there is a var, add once
depVars
replaceCode: (matchCode, replCode) ->
replaceCode @AST_factoryBody, matchCode, replCode
# add report data after all deps manipulations are done (adjust, & beforeTemplate RCs)
addReportData:->
for dep in _.flatten [ @defineArrayDeps
@ext_asyncRequireDeps
_.filter(@ext_requireDeps, (dep) -> dep.isNode) ]
if dep.type not in ['bundle', 'system'] # ignore 'normal' ones
@bundle?.reporter.addReportData _B.okv(dep.type, dep.name()), @path # build a `{'local':['lodash']}`
# Actually converts the module to the target @build options, passing through ResourceConverters as needed.
# @returns promise -> undefined
convert: (@build) ->
step = null
When.sequence([
=>
l.deb 50, step = "\nRunning @adjust for '#{@path}'."
@adjust @build
=>
l.deb 50, step = "\n ResourceConverters runAt: 'beforeTemplate' for '#{@path}'."
@runResourceConverters (rc) -> rc.runAt is 'beforeTemplate'
=>
l.verbose step = "Converting with template '#{@build.template.name}' for module '#{@path}'."
l.deb("'#{@path}' adjusted module.info() = \n",
_.pick @info(), _.flatten [@keys_resolvedDependencies, 'parameters', 'kind', 'name', 'flags']) if l.deb 70
@moduleTemplate or= new ModuleGeneratorTemplates @
@converted = @moduleTemplate[@build.template.name]() # @todo: (3 3 3) pass template, not its name
=>
l.deb 50, step = "\n ResourceConverters runAt: 'afterTemplate' for '#{@path}'."
@runResourceConverters (rc) -> rc.runAt is 'afterTemplate'
=>
l.deb 50, step = "\nRunning optimize for '#{@path}'."
@optimize @build
=>
l.deb 50, step = "\n ResourceConverters runAt: 'afterOptimize' for '#{@path}'."
@runResourceConverters (rc) -> rc.runAt is 'afterOptimize'
=>
l.deb 70, step = "\n addReportData '#{@path}'."
@addReportData()
]).catch (err)=>
@reset()
@hasErrors = true
@bundle.handleError new UError "Error at `module.convert()`: step = `#{step}`", nested:err
# apply `optimize` (i.e minification) - uglify2 only
optimize: (@build) ->
if @build.template.name isnt 'combined'
if @build.optimize
if @build.optimize is 'uglify2'
l.verbose "Optimizing '#{@path}' with UglifyJS2..."
@UglifyJS2 or= require 'uglify-js'
(options = @build.uglify2 or {}).fromString = true
@converted = (@UglifyJS2.minify @converted, options).code
else
l.warn "Not using `build.optimize` with '#{@build.optimize}' - only 'uglify2' works for Modules."
@converted
Object.defineProperties @::,
nodeDeps: get: ->
if @isAllNodeRequires
@defineArrayDeps
else
# all deps with params
if not @parameters?.length
nds = []
else
nds = @defineArrayDeps?[0..@parameters?.length-1] or []
# plus those without params AND not present as require('depX') #todo: simplify in @adjust
if @defineArrayDeps
for remainingDep in @defineArrayDeps[@parameters?.length..@defineArrayDeps.length-1]
if not _.some((@ext_requireDeps or []), (rdep) -> rdep.isEqual remainingDep)
nds.push remainingDep
nds
path: get:-> upath.trimExt @srcFilename if @srcFilename # filename (bundleRelative) without extension eg `models/PersonModel`
factoryBody: get:->
@updateRequireLiteralASTs() #ensure our AST is up to date with deps
fb = @toCode @AST_factoryBody
fb = fb[1..fb.length-2].trim() if @kind is 'AMD'
fb
# 'body' / statements BEFORE define (coffeescript & family gencode `__extend`, `__slice` etc)
'preDefineIIFEBody': get:->
@updateRequireLiteralASTs() #ensure our AST is up to date with deps
@toCode @AST_preDefineIIFENodes if @AST_preDefineIIFENodes
toCode: (astCode=@AST_body, codegenOptions = @codegenOptions) ->
@updateRequireLiteralASTs() #ensure our AST is up to date with deps
toCode astCode, codegenOptions
module.exports = Module
_.extend module.exports.prototype, {l, _, _B}