Module: Sbuilder::ExtensionLoader_Deprecated_Step_Extensions

Included in:
ExtensionLoader
Defined in:
lib/sbuilder/extension_loader_deprecated_step_extensions.rb

Constant Summary collapse

@@validStepExtension_required = 
["interface" ]
@@validStepExtension_allowed = 
@@validStepExtension_required  + ["input", "bindExact", "inputs"]
@@validStepExtension_input = 
[ "input" ]

Instance Method Summary collapse

Instance Method Details

#addTemplateData(mustacheTemplateData, keys, indexes) ⇒ Object

ensure that templateData element in [‘keys’] and [‘indexes’] exists in ‘mustacheTemplateData’.



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
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 609

def addTemplateData( mustacheTemplateData, keys, indexes )
  
  templateData = mustacheTemplateData
  prev = templateData
  keys.each_with_index do |key,i|
    index = indexes[i]
    # puts "addTemplateData:  key=#{key}, #{i}, index #{index}"
    templateData = templateData['columns'].select{ |column| column[:parameter_name] == key }.first
    if templateData.nil? then
      templateData = initRecord( key )
      addColumn( prev, templateData )
      # puts "addTemplateData: added #{templateData} for key #{key} --> #{mustacheTemplateData}"
    else
      # puts "addTemplateData: exists #{templateData} for key #{key}"
    end
    
    prev = templateData
    
    # # puts "data1=#{data}"
    # if !index.nil? then
    #   templateData = templateData['rows'][index]
    #   # puts "data2=#{data}"
    # end
  end # iterate

  return templateData
end

#expandDefaults(interfaceParameters, defaultValue, templateData) ⇒ Object

add expanded parameters to ‘templateData’



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
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 289

def expandDefaults( interfaceParameters, defaultValue, templateData )
  
  # puts "\nexpandDefaults defaultValue=#{defaultValue} on '#{templateData}' missing from #{interfaceParameters}"
  # return unless templateData

  # array of 'parameter_name' fields found on templateData
  definedParameters = templateData && templateData['columns'] ?  templateData['columns'].map { |column| column[:parameter_name] } : []
  
  # select parameters, which are not defined on 'templateData'
  # (i.e. missing from 'definedParameters') append new entries in
  # 'templateData' with 'defaultValue' expanded
  
  parametersToBe( interfaceParameters ).select do |param|

    # puts "expandDefaults param=#{param} of #{param.class}"
    # select for expsion
    # if NOT already defined i.e. NOT in definedParameters
    # if CARDNIALITY defined (ie. paramter_dom object)
    
    !definedParameters.include?( param[:parameter_name] ) && !param[:cardinality].nil?
    
  end.each do |param|
    # one more added - modify comm
    templateData['columns'].last["_comma"] = ',' if templateData && templateData['columns'] && templateData['columns'].length > 0

    # puts  "added fied #{param[:parameter_name]}"
    # create default entry
    expadedElement = {
      :parameter_name => param[:parameter_name],
      "_comma" => '',
      "rows" => false,
      "columns" => false,
    }
    
    expadedElement = expandDefaultValue( expadedElement, defaultValue, param )
    # ensure that 'columns' array exists (espeically case when
    # only _default defined in step extension)
    templateData['columns'] = [] unless templateData && templateData['columns']
    templateData['columns'] << expadedElement
    
  end # apped new entries to 'templateData'

  templateData

end

#expandDefaultValue(expadedElement, defaultValue, param) ⇒ Object

update :domain_value (whewn ‘defaultValue’ is String), or :domain_element= #:domain_prefix#:domain_prefix“ otherwise



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
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 354

def expandDefaultValue( expadedElement, defaultValue, param )

  # Case 'String'
  return expadedElement.merge( { :domain_value => defaultValue, :domain_element => false }) if defaultValue.is_a?( String )

  # Case 'Interger'
  # puts "expandDefaultValue param=#{param}"
  if defaultValue.is_a?( Integer ) then
    raise ExtensionException.new  <<-EOS if  defaultValue > param[:cardinality]
      Cardinality of the default exceeds the cardinality of the parameter domain
        
         cardinality of default : #{defaultValue}
         cardinality on domain  : #{param[:cardinality]}
         name of parameter      : #{param[:parameter_name]}
         domain name            : #{param[:domain_name]}

    EOS
    return  expadedElement.merge( { :domain_element => getDomainElement( param, defaultValue ), :domain_value => false } )
  end

  # else - unknown value
  raise raise ExtensionException.new <<-EOS
       Unknown type #{defaultValue.class} for default #{defaultValue} value encountered.

              Exteding paramter #{param}
      EOS
end

#expandStepInputForDefaults(interface, stepExtensionInputs) ⇒ Object

‘expandedInputs’ includes all ‘interaface’ fields (recurisively)



162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 162

def expandStepInputForDefaults( interface, stepExtensionInputs )

  # make a deeeep copy
  # puts( "expandStepInputForDefaults: stepExtensionInputs=#{stepExtensionInputs.to_yaml}\n\n" )
  expandedInputs  =  Marshal.load( Marshal.dump( stepExtensionInputs ))
  
  # recurse 'interface' and ensure that 'expandedInputs' structure
  # corresponds 'interface' structure
  expandStepInputForDefaultsRecursion( interface, expandedInputs )

  # puts( "expandStepInputForDefaults: expandedInputs=#{expandedInputs.to_yaml}\n\n" )      
  return expandedInputs
    
end

#expandStepInputForDefaultsRecursion(paramSet, stepExtensionInput) ⇒ Object

recurs ‘paramSet’ in synch with ‘stepExtensionDef’: for each non-leaf paramter (i.e. a a parameter referencing to an other paramset) ensure that ‘stepExtensionDef’ also this entry



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 180

def expandStepInputForDefaultsRecursion( paramSet, stepExtensionInput )

  @logger.debug( "#{__method__} paramSet=#{paramSet}, stepExtensionInput=#{stepExtensionInput}, stepExtensionInput.nil?=#{stepExtensionInput.nil?}" )

  # when no 'input' on 'step-extension'
  stepExtensionInput = {}  if stepExtensionInput.nil?
  
  paramSet.parameters.each do |parameter|
    if parameter.isReference && stepExtensionInput.is_a?( Hash ) then
      # add empty input parameter (if not defined) for records (ie. Hashe).
      # rows are not expanded (we do not know many we should add)
      # stepExtensionInput[parameter.name] = initRecord( parameter.name ) unless stepExtensionInput.has_key?( parameter.name )
      stepExtensionInput[parameter.name] = {} unless stepExtensionInput.has_key?( parameter.name )
      # recurse referenced 'paramSet' together with 'stepExtensionDef'
      expandStepInputForDefaultsRecursion( parameter.getResolvedReference, stepExtensionInput[parameter.name] )
    end
  end
end

#extendNumbering(mustacheTemplateData) ⇒ Hash

assign ‘_first’ element for hash within ‘mustacheTemplateData’

Parameters:

  • mustacheTemplateData (Hash)

Returns:

  • (Hash) —

    ‘mustacheTemplateData’ with record elements numbered



402
403
404
405
406
407
408
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 402

def extendNumbering( mustacheTemplateData )

  recurseHash( mustacheTemplateData ) do |h,k,v,i|
    v["_index"] = i
  end
  return mustacheTemplateData
end

#extendStep(stepExtensionDef) ⇒ Object

extend steps: recurse ‘stepExtensionDef’ and create a hash, which can passed to mustache templates



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 57

def extendStep( stepExtensionDef )
  @logger.info( "#{__method__} stepExtensionDef=#{stepExtensionDef}" )

  validateProperties( stepExtensionDef, @@validStepExtension_required, @@validStepExtension_allowed )

  # access paramSet for interface being extenedd && assert that it also exists
  interface = controller.getInterface( stepExtensionDef['interface'] )

  # create new param-set && configure it
  stepParamSet = controller.createParamSet( Sbuilder::Constants::PARAM_SET_STEPS )
  stepParamSet.setInterfaceReference( interface )
  stepParamSet.setBindExact( stepExtensionDef["bindExact"] )      

  # iterate stepParamSet['inputs']/stepParamSet['input'] to create
  # mustacheTemplateData & add use 'stepParamSet.addInput' add it
  # to 'stepParamSet'
  extendStep_Inputs( interface, stepParamSet, stepExtensionDef )

  # pass extension for controller - to delegate to model
  controller.extendStep( stepParamSet )      

end

#extendStep_Input(interface, stepParamSet, stepExtensionDefInputs) ⇒ Object

expand one input to a mustache template



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 139

def extendStep_Input( interface, stepParamSet, stepExtensionDefInputs )

    # convert input paramters for the interface to datastructure, which
    # can passed to template rendering
    mustacheTemplateData = extendStepInputs( interface, stepExtensionDefInputs )

    # add missing sub-documents in 'stepExtensionDef'
    expandedStepExtensionDef = expandStepInputForDefaults(  interface, stepExtensionDefInputs )
    
    # add _default values for parameters not defined
    # NB: expandedStepExtensionDef = stepExtensionDef['input']
    mustacheTemplateData = extendStepDefaults( interface, expandedStepExtensionDef, mustacheTemplateData )

    # assign unique number to hash element in 'mustacheTemplateData'
    mustacheTemplateData = extendNumbering( mustacheTemplateData )        

    # added to stepParameterSet
    return mustacheTemplateData
  
end

#extendStep_Inputs(interface, stepParamSet, stepExtensionDef) ⇒ Object 



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
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 84

def extendStep_Inputs( interface, stepParamSet, stepExtensionDef )

  raise ExtensionException.new  <<-EOS if stepExtensionDef['input'] && stepExtensionDef['inputs'] 
  Property 'input' cannot be defined together with 'inputs' in #{stepExtensionDef.to_yaml}

  Use 

    inputs:
       - input: 
            ...
       - input: 
            ...

  or for a single input

    input:
       ....
  EOS

  raise ExtensionException.new  <<-EOS if stepExtensionDef['inputs'] && stepExtensionDef['bindExact'] != true
  Property 'inputs' cannot be defined unless 'bindExact' true.

  Error in in #{stepExtensionDef.to_yaml}

  EOS
  

  # process either 'inputs' or 'input'
  stepExtensionDefInputs = stepExtensionDef['inputs'] ? stepExtensionDef['inputs'] : [ { 'input' => stepExtensionDef['input'] } ]

  # loop
  stepExtensionDefInputs.each do |stepExtensionDefInput|

    # single case: create 'mustacheTemplateData' and add it to
    # 'stepParamSet'
    begin
      
      validateProperties( stepExtensionDefInput, @@validStepExtension_input  )
      
      mustacheTemplateData = extendStep_Input( interface, stepParamSet, stepExtensionDefInput['input'] )
      @logger.debug "#{__method__}, mustacheTemplateData=#{mustacheTemplateData.to_yaml}"
      stepParamSet.addInput( mustacheTemplateData )

    rescue ExtensionException => ee
      msg = "Error #{ee} caused by #{ee.backtrace.join("\n")} when extending interface '#{stepExtensionDef['interface']}'\n\n"
      @logger.error( "#{__method__} #{msg}" )
      raise ExtensionException.new( msg )
    end
    
  end #  iterate

end

#extendStepDefaults(interface, stepExtensionInputs, mustacheTemplateData) ⇒ Object

recurse ‘stepExtensionInputs’ and use it to set default values in ‘mustacheTemplateData’ structure.



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
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 205

def extendStepDefaults( interface, stepExtensionInputs, mustacheTemplateData )
  # puts "extendStepDefaults - starting"
  # recrurse 'stepExtensionInputs' and yield 'rows' && 'records'
  recurseStepDefaults( stepExtensionInputs ) do |type, keys, indexes, stepExtensionInput, defaultValues|
    # puts "type=#{type}, keys=#{keys}, indexes=#{indexes}, stepExtensionInput=#{stepExtensionInput}, defaultValues=#{defaultValues}"

    # configuration in model
    interfaceParameters = locateParameter( interface, keys )

    # what we have expanded so far - using 'stepExtensionInputs'
    templateData = locateTemplateData( mustacheTemplateData, keys, indexes )

    # default value is on the top of the stack
    # defaultValue = defaultValues.last 
    # defaultValue is the last non-nil value on stack 'defaultValues'
    defaultValue = defaultValues.reverse.find { |v| !v.nil? } 

    next unless defaultValue

    # create an entry in 'mustacheTemplateData' if path 'keys'/'indexes' no configuration
    # in 'step-extension' 'input'
    templateData = addTemplateData( mustacheTemplateData, keys, indexes ) unless templateData
    expandDefaults( interfaceParameters, defaultValue, templateData )          
    
    # case type
    # when "row"
    #   next unless defaultValue
    #   # access data row 'index'
    #   index = indexes.last
    #   # expandDefaults( interfaceParameters, defaultValue, templateData['rows'][index] )
    #   puts "row-expansion templateData=#{templateData}"
    #   expandDefaults( interfaceParameters, defaultValue, templateData )          
    # when "record"
    #   # possibly no default value defined
    #   next unless defaultValue
    #   expandDefaults( interfaceParameters, defaultValue, templateData )
    # else
    #   # should not happen
    #   raise "Unknown type #{type}"
    # end
  end
  # empty is returnet as boolean false
  mustacheTemplateData  = false if mustacheTemplateData  == {}
  
  mustacheTemplateData      
end

#extendStepInputs(interface, stepExtensionInputs) ⇒ Object

recurse ‘stepExtensionInputs’ configuration and create a hash structure, which can be passed to mustache template



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
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 434

def extendStepInputs( interface, stepExtensionInputs )
  @logger.debug( "#{__method__} stepExtensionInputs=#{stepExtensionInputs}" )

  # recursion uses this as a stack
  subDocumentStack = []
  subDocumentStack.push( {} )


  stepExtensionInputs && recurseStepInputs(  stepExtensionInputs ) do |act,keys,domainElement,row|
    # puts "#{act}, keys=#{keys},domainElement=#{domainElement}, #{row}"
    
    # uses path  [keys] in 'interface' to locate parameter to extend
    extededParameter = locateParameter( interface, keys )
    parameterName = keys.last
    next if parameterName[0] == "_"

    case act
    when "="
      @logger.debug( "#{__method__} extededParameter=#{extededParameter.name}, extededParameter.resolvedDomain=#{extededParameter.resolvedDomain}" )
       input = {
        :parameter_name => parameterName,
        :domain_element => getDomainElement2(extededParameter, domainElement),
        "rows" => false,
        "columns" => false,
        "_comma" => ','
      }
      # create new parameter && add it to the paramSet
      raise ExtensionException.new  <<-EOS if domainElement.is_a?( Integer ) && extededParameter.resolvedDomain.cardinality < domainElement 
      The cardinality on step exceeds the cardinality of the parameter domain
         
          Name of parameter  : #{extededParameter.name}
          Name of parameter domain  : #{extededParameter.resolvedDomain.name}
          Cardinality of the parameter domain : #{extededParameter.resolvedDomain.cardinality}
          Cardinality defined: #{domainElement}

      EOS

      subDocumentStack.last["columns"] = [] unless subDocumentStack.last["columns"]          
      subDocumentStack.last["columns"] << input
    when "["
      input = initRecord( parameterName )
      # {
      #   :parameter_name => parameterName,
      #   "rows" => false,
      #   "columns" => false,
      # }
      subDocumentStack.last["columns"] = [] unless subDocumentStack.last["columns"]          
      subDocumentStack.last["columns"] << input
      subDocumentStack.push( input )
    when "]"
      # end of sub-record
      input = subDocumentStack.pop
      # last element has no comma
      input['columns'].last["_comma"] = '' if input['columns']
    when "<<"
      if row == 0 then
        # start of array processing = start of row
        input = initRecord( parameterName )
        # {
        #   :parameter_name => parameterName,
        #   "rows" => false,
        #   "columns" => false,
        # }
        subDocumentStack.push( addColumn( subDocumentStack.last, input ))
                                                   
        # subDocumentStack.last["columns"] = [] unless subDocumentStack.last["columns"]
        # subDocumentStack.last["columns"] << input
        # subDocumentStack.push( input )          
      else
        # start a new row in an array
        input = {
          "rows" => false,
          "columns" => false,
          "_comma" => ",",              
        }
        subDocumentStack.push( input )                      
      end
      
    when ">>"
      if row == 0 then
        # end of array 
        input  = subDocumentStack.pop
        input['rows'].last["_comma"] = '' if input['rows']                        
        input['columns'].last["_comma"] = '' if input['columns']            

      else
        input = subDocumentStack.pop
        input['rows'].last["_comma"] = '' if input['rows']                        
        input['columns'].last["_comma"] = '' if input['columns']            
        # puts "subDocumentStack=#{subDocumentStack}"
        subDocumentStack.last["rows"] = [] unless subDocumentStack.last["rows"]
        subDocumentStack.last["rows"] << input
      end
    else
      raise "Unknown act #{act}"
    end
  end

  raise "subDocumentStack should have been empty #{subDocumentStack}" unless subDocumentStack.length == 1
  ret = subDocumentStack.first

  # last element has no _comma always 
  ret['columns'].last["_comma"] = '' if ret['columns']
  
  @logger.info( "#{__method__} return=#{ret}" )
  return ret
  
end

#getDomainElement(param, defaultValue) ⇒ Object

“#Sbuilder::ExtensionLoader_Deprecated_Step_Extensions.extededParameterextededParameter.resolvedDomainextededParameter.resolvedDomain.name_#domainElement”



387
388
389
390
391
392
393
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 387

def getDomainElement( param, defaultValue )
  # ret = "#{param[:domain_prefix]}#{defaultValue}"
  ret = model.getDomain(param[:domain_name]).domain_entry( defaultValue )
  # puts( "getDomainElement: param=#{param}, defaultValue=#{defaultValue} --> #{ret}" )
  return ret

end

#getDomainElement2(extededParameter, domainElement) ⇒ Object 



382
383
384
385
386
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 382

def getDomainElement2( extededParameter, domainElement )
  # puts( "extededParameter=#{extededParameter}, domainElement=#{domainElement}" )
  return extededParameter.resolvedDomain.domain_entry( domainElement )
  # "#{extededParameter.resolvedDomain.name}_#{domainElement}"
end

#locateParameter(interface, keys) ⇒ Object

uses path [keys] in ‘interface’ to locate parameter



590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 590

def locateParameter( interface, keys )
  extededParameter = interface
  if keys.any?
    extededParameter = keys.inject(interface) { |p,key|
      # _default paramtes not real parameters
      next if key == "_default"
      p = p.locateParameter( key )
      # resolve in model context - possible for paramter_ref
      # p = p.getResolvedReference( controller.model ) if p.respond_to?( :getResolvedReference )
      p = p.getResolvedReference if p.respond_to?( :getResolvedReference )          
      p
    }
    @logger.debug( "#{__method__} keys #{keys}->extededParameter=#{extededParameter}" )
  end
  return extededParameter
end

#locateTemplateData(mustacheTemplateData, keys, indexes) ⇒ Object

uses path in [keys] and [‘indexes’] to locate data ‘mustacheTemplateData’.



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
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 639

def locateTemplateData( mustacheTemplateData, keys, indexes )
  ret = mustacheTemplateData
  i = 0
  if keys.any?
    ret = keys.inject(ret) { |data,key|
      index = indexes[i]
      i += 1
      # puts "\n\nindex=#{index} of #{indexes}, i=#{i}, key=#{key} on '#{data}'"
      break unless data
      data = data['columns'].select{ |column| column[:parameter_name] == key }.first
      # puts "data1=#{data}"
      if !index.nil? then
        data = data['rows'][index]
        # puts "data2=#{data}"
      end
      
      # if index.nil? then
      # else
      #   data = data['rows'][index]['columns'].select{ |column| column[:parameter_name] == key }.first            
      # end
      data
    }
  end
  return ret
end

#parametersToBe(interfaceParameters) ⇒ Object

retrurn array of hashes(:parameter_name, :cardinality, :domain_prefix) on an interface parameters



337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 337

def parametersToBe( interfaceParameters )
  @logger.debug( "#{__method__} interfaceParameters=#{interfaceParameters}" )
  parameters = interfaceParameters.parameters.map do |parameter|
    # puts "parameter=#{parameter}"
    {
      :parameter_name => parameter.name,
      :cardinality => parameter.respond_to?( :resolvedDomain) ? parameter.resolvedDomain.cardinality : nil,
      # :domain_prefix => parameter.respond_to?( :resolvedDomain) ? parameter.resolvedDomain.domain_prefix : nil,
      :domain_name => parameter.respond_to?( :resolvedDomain) ? parameter.resolvedDomain.domain_name : nil,
    }

  end
  return parameters
end

#recurseHash(hash, &block) ⇒ Object

recurse hash, and yield ‘hash’, ‘key’, ‘value’, ‘index’ for each entry within the hash structure, which is_a?(Hash).



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 413

def recurseHash( hash, &block )

  hash && hash.each_with_index do |(k,v),index|
    if  v.is_a?( Hash )  then
      yield  hash, k, v, index
      recurseHash( v, &block)
    elsif v.is_a?( Array )  then
      v.each_with_index do |array_element,i|
        if array_element.is_a?(Hash)
          yield  hash, k, array_element, i 
          recurseHash( array_element, &block)
        end
      end
    end
  end
end

#recurseStepDefaults(stepExtensionInputs, keys = [], indexes = [], defaultValues = nil, &block) ⇒ Object

recurse ‘stepExtensionInputs’ and yield

  • record|row, [keys], parameterDef



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
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 254

def recurseStepDefaults( stepExtensionInputs, keys=[], indexes=[], defaultValues=nil, &block )
  # puts "recurseStepDefaults(enter) stepExtensionInputs=#{stepExtensionInputs}" 
  return unless stepExtensionInputs
  # init defaultValues
  defaultValues = [ stepExtensionInputs["_default"] ] unless defaultValues
  if !keys.any? then
    # puts "recurseStepDefaults(init) #{stepExtensionInputs}"
    yield "record", keys, indexes, stepExtensionInputs, defaultValues
  end
  stepExtensionInputs.each do |parameterName, parameterDef|
    if parameterDef.is_a?( Array ) then
      parameterDef.each.with_index do |parameterDefRow,index|
        defaultValues.push( parameterDefRow["_default"] )
        # puts "recurseStepDefaults:(array) resolved-defaultValues=#{defaultValues} index=#{index},  for parameterDefRow=#{parameterDefRow}"
        yield "row", keys + [parameterName], indexes + [index], parameterDefRow, defaultValues
        recurseStepDefaults( parameterDefRow, keys + [parameterName], indexes + [index], defaultValues, &block)
        defaultValues.pop            
      end
    elsif parameterDef.is_a?( Hash ) then
      defaultValues.push( parameterDef["_default"] )
      # puts "recurseStepDefaults:(hash): resolved-defaultValues=#{defaultValues} keys=#{keys},  for parameterDef=#{parameterDef}"          
      yield "record", keys + [parameterName], indexes + [nil], parameterDef, defaultValues
      recurseStepDefaults( parameterDef, keys + [parameterName], indexes + [nil], defaultValues, &block)
      defaultValues.pop
    else
      # puts "recurseStepDefaults:(else): resolved-defaultValues=#{defaultValues} keys=#{keys},  for parameterDef=#{parameterDef}"                    
      # leaf entry
    end

  end

end

#recurseStepInputs(stepExtensionInputs, keys = [], row = 0, &block) ⇒ Object

Recurse ‘stepExtensionInputs’ (i.e. hash under key ‘step-extension’ ). During recursion yield:

: reference parameter, domainElement

[ : starts hash ] : end hash << : array >> : end array



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
 
# File 'lib/sbuilder/extension_loader_deprecated_step_extensions.rb', line 550

def recurseStepInputs( stepExtensionInputs, keys=[], row=0, &block )
  stepExtensionInputs.each do |parameterName, parameterDef|
    begin 
      if parameterDef.is_a?( Array ) then
        yield "<<", keys + [parameterName], nil, 0
        parameterDef.each.with_index do |parameterDefRow,index|
          yield "<<", keys + [parameterName], nil, index+1
          recurseStepInputs( parameterDefRow, keys + [parameterName], index+1, &block )
          yield ">>", keys + [parameterName], nil, index+1
        end
        yield ">>", keys + [parameterName], nil, 0
        
      elsif parameterDef.is_a?( Hash ) then
        yield "[", keys + [parameterName], nil, row          
        recurseStepInputs( parameterDef, keys + [parameterName], row, &block  )
        yield "]", keys + [parameterName], nil, row          
      else
        # do not process "meta fields" e.g '_default'
        yield "=", keys + [parameterName], parameterDef, row
      end
    rescue SbuilderException => e
      msg = <<-EOS.gsub( /^\s*/, '' )
      Error:

      #{e.message}  


      when processing parameter #{parameterName} with definition:

      #{parameterDef.to_yaml}

      EOS
      @logger.error( "#{__method__} #{msg}" )
      raise Sbuilder::LoaderException.new, msg, e.backtrace
    end
  end
end