Class: GdlTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/xmlutils/gdltemplate.rb

Overview

class GdlTemplate

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ GdlTemplate

Returns a new instance of GdlTemplate.



21
22
23
 
# File 'lib/xmlutils/gdltemplate.rb', line 21

def initialize()
  @maxWidth = 75
end

Instance Attribute Details

#maxWidth ⇒ Object

Returns the value of attribute maxWidth.



19
20
21
 
# File 'lib/xmlutils/gdltemplate.rb', line 19

def maxWidth
  @maxWidth
end

Instance Method Details

#cleanMsgText(txt) ⇒ Object

————————————————————————————————————-# cleanMsgText - msg text to clean. Converts double quotes to single quotes.

returns cleaned text

————————————————————————————————————#



320
321
322
323
324
 
# File 'lib/xmlutils/gdltemplate.rb', line 320

def cleanMsgText(txt)
  clean = txt.gsub(/["]/,"'")

  clean
end

#dpm(dataType, varName, varAlias) ⇒ Object

————————————————————————————————————-# dpm - generate a GDL version of a DPM definition based on DPM XML element

var - XML element to generate output for

————————————————————————————————————#



191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/xmlutils/gdltemplate.rb', line 191

def dpm(dataType, varName, varAlias)
  lead = " ".ljust(16)
dpm = "dpm".ljust(4)
dt = dataType.ljust(12)
  vn = varName.ljust(48)

  out = "\#{lead}\#{dpm}\#{dt}\#{vn}\"\#{varAlias}\";\n"

  out                                               # Return generated output

end

#dsm(dataType, varName, varAlias) ⇒ Object

————————————————————————————————————-# dsm - generate a GDL version of a DSM definition based on DSM XML element

var - XML element to generate output for

————————————————————————————————————#



169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/xmlutils/gdltemplate.rb', line 169

def dsm(dataType, varName, varAlias)
  dsn = "decision".ljust(16)
dpm = "dpm".ljust(4)
dt = dataType.ljust(12)
  vn = varName.ljust(48)

  out = "\#{dsn}\#{dpm}\#{dt}\#{vn}\"\#{varAlias}\";\n"

  out                                               # Return generated output

end

#fileHeader(fname, curDate, misc = "") ⇒ Object

————————————————————————————————————-# fileHeader - generate file header

fname - file name to place on header curDate - a date string

returns - File header text

————————————————————————————————————#



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/xmlutils/gdltemplate.rb', line 37

def fileHeader(fname, curDate, misc="")
  fname = File.basename(fname, ".gdl")
  header = "/* **************************************************************************\n * File: \#{fname}.gdl\n *\n * Guideline source generated \#{curDate}\n * \#{misc}\n *\n * *************************************************************************/\n\n\n"

  return header
end

#guideline(ctx) ⇒ Object

————————————————————————————————————-# guideline - output collected variables to file

ofile - output file handle

————————————————————————————————————#



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

def guideline(ctx)
  gdlout  = ""
  reflist = ""
  return gdlout if( ctx.guideline.nil? )

  if( ! ctx.guideline.items.nil? )
    ctx.guideline.items.each do |item|
      rname = "UNKNOWN"
      if (item[0] == 'rule')
        rname = ctx.rules[item[1]].name
      elsif (item[0] == 'ruleset')
        rname = ctx.rulesets[item[1]].name
      end # if item


      reflist += reference(item[0], rname)

    end # items.each

  end

gdlout = "/* ==========================================================================\n * \#{ctx.guideline.name}\n *\n * ID:         \#{ctx.guideline.id}\n * Version:    \#{ctx.guideline.version}\n * Start Date: \#{ctx.guideline.startDate}\n *\n */\nguideline(\"\#{ctx.guideline.name}\")\n\n\#{reflist}\n\nend // guideline \#{ctx.guideline.name}\n"

  return gdlout

end

#lookup(lkupName, xParamName, yParamName) ⇒ Object

————————————————————————————————————-# lookup - output lookup reference

returns lookup reference source

————————————————————————————————————#



479
480
481
482
483
484
485
486
 
# File 'lib/xmlutils/gdltemplate.rb', line 479

def lookup(lkupName, xParamName, yParamName)


  refout = 'lookup("' + "#{lkupName}" + '", ' + "#{xParamName}, #{yParamName})"

  return refout

end

#msg(msgObj) ⇒ Object

————————————————————————————————————-# msg - output a message

returns message source

————————————————————————————————————#



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
 
# File 'lib/xmlutils/gdltemplate.rb', line 335

def msg(msgObj)

  raise "Bad argument" if (nil == msgObj)

  isCondition = false
  isException = false

  msgTxt  = cleanMsgText(msgObj.msg)
  msgTag  = "message"
  msgType = ""
                                            # Determine message type

  case msgObj.type
    when 'Condition'
      isCondition = true
      msgTag  = "condition"

    when 'Exceptions'
      msgType += "exception"
      isException = true

    when 'Observation'
      msgType += "observation"

    when 'Findings'
      msgType += "findings"

    when 'Credit'
      msgType += "credit"

  end # case msgObj.type



  if (isCondition)                          # Handle condition messages


    case msgObj.category                    # Handle condition message category type

      when '1'
        msgType += "asset"

      when '2'
        msgType += "credit"

      when '3'
        msgType += "income"

      when '4'
        msgType += "property"

      when '5'
        msgType += "purchase"

      when '6'
        msgType += "title"

      else
        msgType += " asset"

    end # case category




    case msgObj.priorTo                     # Handle condition message priorTo type

      when '1'
        msgType += ", docs"

      when '2'
        msgType += ", funding"

      when '3'
        msgType += ", approval"

      else
        msgType += ", docs"

    end # case priorTo


  end # if isCondition





  msgout = "      \#{msgTag}(\#{msgType}, \"\#{msgTxt}\");\n"

  return msgout

end

#multiLineComment(comment, header = "") ⇒ Object

————————————————————————————————————-# multiLineComment - generate a multi line comment block

comment - comment text

returns - multi line comment block

————————————————————————————————————#



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/xmlutils/gdltemplate.rb', line 97

def multiLineComment(comment, header = "")
  bar     = ""
  hdrBar  = ""

                                  # 3: 3 misc chars (/* )

  width = (@maxWidth - 3)

  width.times do
    bar += "*"
  end

  if (header.length > 0)          # Generate a formatted header if it exists.

    hdrWidth = (@maxWidth - 6 - header.length) / 2

    hdrWidth.times do
      hdrBar += " "
    end # times

  end # if header


  output = "\n\n\n\n/* \#{bar}\n\#{hdrBar}-- \#{header} --\#{hdrBar}\n\n\#{comment}\n\n\#{bar} */\n\n\n\n\n"

  output

end

#ppm(dataType, ppmType, varName, varAlias) ⇒ Object

————————————————————————————————————-# ppm - generate a PPM definition

var - XML element to generate output for

————————————————————————————————————#



148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/xmlutils/gdltemplate.rb', line 148

def ppm(dataType, ppmType, varName, varAlias)
  dt = dataType.ljust(12)
  pt = ppmType.ljust(12)
  vn = varName.ljust(48)
  va = varAlias
  out = "ppm \#{dt}\#{pt}\#{vn}\"\#{va}\";\n"

  out                                               # Return generated output

end

#reference(refType, refName) ⇒ Object

————————————————————————————————————-# reference - output rule/set reference

returns rule/set reference source

————————————————————————————————————#



301
302
303
304
305
306
307
308
309
 
# File 'lib/xmlutils/gdltemplate.rb', line 301

def reference(refType, refName)

  refout = "  \#{refType}  \#{refName}();\n"

  return refout

end

#rule(rule) ⇒ Object

————————————————————————————————————-# rule - output a rule

ofile - output file handle

————————————————————————————————————#



213
214
215
216
217
218
 
# File 'lib/xmlutils/gdltemplate.rb', line 213

def rule(rule)

  # Rule output is generated in GdlDoc.visitRule()

  return rule.src

end

#rulelist(ruleset, ctx) ⇒ Object

————————————————————————————————————-# rulelist - output ruleset’s rule ref list

returns ruleset rule list source

————————————————————————————————————#



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/xmlutils/gdltemplate.rb', line 278

def rulelist(ruleset, ctx)

  outlist = ""

  ruleset.rules.each do |ralias|
    rname = ctx.rules[ralias].name
    outlist += reference("rule", rname)

  end # rules.each


  return outlist

end

#ruleset(ruleset, ctx) ⇒ Object

————————————————————————————————————-# ruleset - output collected variables to file

ofile - output file handle

————————————————————————————————————#



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
 
# File 'lib/xmlutils/gdltemplate.rb', line 229

def ruleset(ruleset, ctx)
  rulelist = rulelist(ruleset, ctx)

  cmtSuffix = ""
  ruleParams = "#{ruleset.execType}"      # Build the ruleset parameter list.


  if (ruleset.type == "PL")
    ruleParams += ", PL"
    cmtSuffix += "(PowerLookup)"
  end # if ruleset.type


  aliasStmt = ""                          # Don't create an alias statement if it is not needed.


  if (ruleset.name != ruleset.alias)
    aliasStmt = "alias(ruleset, \#{ruleset.name}, \"\#{ruleset.alias}\");\n"
  end # if ruleset.name...



  out = "\#{aliasStmt}\n/* ==========================================================================\n * \#{ruleset.name} \#{cmtSuffix}\n *\n *\n */\nruleset \#{ruleset.name}(\#{ruleParams})\n\#{rulelist}\nend // ruleset \#{ruleset.name}(\#{ruleParams})\n\n\n\n\n"

  return out

end

#sectionComment(sectionName) ⇒ Object

————————————————————————————————————-# sectionComment - generate definition header

headerType - Header type (ex: DSM)

returns - definition header text

————————————————————————————————————#



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/xmlutils/gdltemplate.rb', line 64

def sectionComment(sectionName)
  txt = sectionName.strip
  bar = ""
                                  # 6: 5 misc chars (// ) plus 1

  width = (@maxWidth - 6 - txt.length) / 2
  width.times do
    bar += "+"
  end

  header = "\n\n\n\n// \#{bar} \#{txt} \#{bar}\n\n"

  header

end