Class: Sbuilder::ExtensionLoader

Inherits:
Object
  • Object
show all
Includes:
Utils::MyLogger
Defined in:
lib/sbuilder/extension_loader.rb

Constant Summary collapse

PROGNAME =

mixer

"ExtensionLoader"
@@extensionDefProperties = 
['domain-extension', 'interface-extension', 'step-extension']
@@extensionDoaminProperties = 
['domain', 'cardinality']
@@extensionValuesProperties = 
['domain', 'values']
@@validStepExtension_required = 
["interface" ]
@@validStepExtension_allowed = 
@@validStepExtension_required  + ["input", "bindExact", "inputs"]
@@validStepExtension_input = 
[ "input" ]

Constants included from Utils::MyLogger

Utils::MyLogger::LOGFILE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils::MyLogger

#getLogger, #logfile

Constructor Details

#initialize(options = {}) ⇒ ExtensionLoader

constructore



27
28
29
30
31
 
# File 'lib/sbuilder/extension_loader.rb', line 27

def initialize( options = {} )
  @logger = getLogger( PROGNAME, options )
  @logger.debug( "#{__method__} initialized" )
  self
end

Instance Attribute Details

#controller ⇒ Object

get sets when load starts



5
6
7
 
# File 'lib/sbuilder/extension_loader.rb', line 5

def controller
  @controller
end

Instance Method Details

#addTemplateData(mustacheTemplateData, keys, indexes) ⇒ Object

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



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

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

#doLoad(fileUri) ⇒ Object 



51
52
53
54
55
56
 
# File 'lib/sbuilder/extension_loader.rb', line 51

def doLoad( fileUri )
  
  yaml = Sbuilder::Utils::NetIo.read_lines( fileUri )
  domains_hash = YAML.load( yaml )
  loadExtensions( domains_hash )
end

#expandDefaults(interfaceParameters, defaultValue, templateData) ⇒ Object

add expanded parameters to ‘templateData’



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

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



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

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)



242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/sbuilder/extension_loader.rb', line 242

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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/sbuilder/extension_loader.rb', line 260

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( model ), stepExtensionInput[parameter.name] )
    end
  end
end

#extendDomainWithCardinality(domainDef) ⇒ Object

extend one domain with cardinality



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/sbuilder/extension_loader.rb', line 118

def extendDomainWithCardinality( domainDef )
  @logger.info( "#{__method__} domainDef=#{domainDef}" )
  validateProperties( domainDef, @@extensionDoaminProperties )

  # create & configure
  domain = factory.createDomain( Sbuilder::Constants::TYPE_CARDINALITY_DOMAIN )
  domain.setName( domainDef['domain'] )
  domain.setCardinality( domainDef['cardinality'] )      

  # pass to model via controller      
  controller.extendDomain( domain )
end

#extendDomainWithValues(domainDef) ⇒ Object

extend one domain with cardinality



102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/sbuilder/extension_loader.rb', line 102

def extendDomainWithValues( domainDef )
  @logger.info( "#{__method__} domainDef=#{domainDef}" )
  validateProperties( domainDef, @@extensionValuesProperties )

  # create & configure
  domain = factory.createDomain( Sbuilder::Constants::TYPE_VALUE_DOMAIN )
  domain.setName( domainDef['domain'] )
  domainDef['values'].each { |value| domain.addValue( value  ) }

  # pass to model via controller
  controller.extendDomain( domain )      
  
end

#extendInterface(interfaceExtensionDef) ⇒ Object

extend interface



133
134
135
136
 
# File 'lib/sbuilder/extension_loader.rb', line 133

def extendInterface( interfaceExtensionDef )
  @logger.info( "#{__method__} interfaceExtensionDef=#{interfaceExtensionDef}" )
  controller.extendInterface( interfaceExtensionDef )
end

#extendNumbering(mustacheTemplateData) ⇒ Hash

assign ‘_first’ element for hash within ‘mustacheTemplateData’

Parameters:

  • mustacheTemplateData (Hash)

Returns:

  • (Hash) —

    ‘mustacheTemplateData’ with record elements numbered



480
481
482
483
484
485
486
 
# File 'lib/sbuilder/extension_loader.rb', line 480

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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/sbuilder/extension_loader.rb', line 142

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/sbuilder/extension_loader.rb', line 219

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 



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

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'] )
      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.



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

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



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

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

#factory ⇒ Object 



39
40
41
 
# File 'lib/sbuilder/extension_loader.rb', line 39

def factory
  controller.factory
end

#getDomainElement(param, defaultValue) ⇒ Object

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



465
466
467
468
469
470
471
 
# File 'lib/sbuilder/extension_loader.rb', line 465

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 



460
461
462
463
464
 
# File 'lib/sbuilder/extension_loader.rb', line 460

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

#load(filePath, controller) ⇒ Object

load



45
46
47
48
49
 
# File 'lib/sbuilder/extension_loader.rb', line 45

def load( filePath, controller )
  @logger.info( "#{__method__} filePath=#{filePath}" )
  @controller = controller
  doLoad( filePath )
end

#loadExtensions(extensionsArr) ⇒ Object

iterate domains



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

def loadExtensions( extensionsArr )
  extensionsArr && extensionsArr.each do |extensionDef|
    raise ExtensionException.new  "Invalid extension definition #{extensionDef}"  unless (extensionDef.keys.length == 1)
    validateProperties( extensionDef, [], @@extensionDefProperties )
    key = extensionDef.keys.first
    case key
    when 'domain-extension'
      extensionDef[key].each do |domainDef|
        if !domainDef['cardinality'].nil? then
          extendDomainWithCardinality( domainDef )
        else
          extendDomainWithValues( domainDef )
        end
      end
    when 'interface-extension'
      extensionDef[key].each do |interfaceExtesionDef|
        extendInterface( interfaceExtesionDef )
      end
    when 'step-extension'
      extensionDef[key].each do |stepExtensionDef|
        extendStep( stepExtensionDef )
      end
    else
      raise ExtensionException.new "Unknown extension type #{key} in #{extensionDef}"
    end
  end
end

#locateParameter(interface, keys) ⇒ Object

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



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/sbuilder/extension_loader.rb', line 668

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
    }
    @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’.



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/sbuilder/extension_loader.rb', line 716

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

#model ⇒ Object

model - is found using contorller



35
36
37
 
# File 'lib/sbuilder/extension_loader.rb', line 35

def model
  controller.model
end

#parametersToBe(interfaceParameters) ⇒ Object

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



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

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).



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/sbuilder/extension_loader.rb', line 491

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



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

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



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

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