ppmtogdl 0.1.2

data/lib/ppmtogdl/gdldocbuilder.rb

@@ -0,0 +1,140 @@
+###############################################################################
+# File::    gdldocbuilder.rb
+# Purpose:: GdlDocBuilder class is a builder object for building GDL
+#           source documents.
+#
+# Author::    Jeff McAffee 04/30/2015
+#
+##############################################################################
+
+require 'xmlutils/ruleparser'
+require 'xmlutils/lineparser'
+
+module PpmToGdl
+  class GdlDocBuilder
+
+    attr_accessor :options
+    attr_accessor :context
+
+  #-------------------------------------------------------------------------------------------------------------#
+  # initialize - CTor
+  #
+  # options - Document builder options
+  #
+  #------------------------------------------------------------------------------------------------------------#
+    def initialize(options)
+    $LOG.debug "GdlDocBuilder::initialize( #{options} )"
+      @options  = options
+      @context  = PpmContext.new
+      @context.setOptions(@options)
+    end # initialize
+
+  #-------------------------------------------------------------------------------------------------------------#
+  # createDocument - create a GDL document from an XML document
+  #
+  # srcPath - XML source file
+  # rootDor - root directory
+  #
+  #------------------------------------------------------------------------------------------------------------#
+    def createDocument(srcPath)
+    $LOG.debug "GdlDocBuilder::createDocument( #{srcPath} )"
+
+      # Setup context object builder
+      ctxBuilder = ContextParser.new(@context)
+      ctxBuilder.setFlag(@options)
+
+      statusMsg "Creating context based on src file [ #{srcPath} ]."
+
+      ctxBuilder.parse(srcPath)
+
+      printMetrics(@context)
+=begin
+    statusMsg "Parsing external variable definitions."
+
+    parseExternalVarDefs(@context)
+
+
+
+    statusMsg "Parsing rule data (#{ctxBuilder.context.rules.size.to_s} rules)."
+
+    ruleBuilder = RuleParser.new(@context)
+    ruleBuilder.setFlag(@options)
+
+    @context.rules.each do |key, rule|
+      rule.src = ruleBuilder.parse(rule.xml)
+      print "."
+    end # rules.each
+    puts
+=end
+
+  #   ctxBuilder.dumpResults
+
+      # Create output file and output src.
+      statusMsg "Generating document."
+
+      gdlDoc = GdlDoc.new(srcPath, @context)
+      gdlDoc.setOptions(@options)
+
+      genFile = gdlDoc.generate
+
+      statusMsg "Document created: #{genFile}"
+
+      #genFile = gdlDoc.generateRenameList
+
+      #statusMsg "Rename list document created: #{genFile}"
+
+    end # createDocument
+
+  #-------------------------------------------------------------------------------------------------------------#
+  # statusMsg - output a status message
+  #
+  # msg - Message to output
+  #
+  #------------------------------------------------------------------------------------------------------------#
+    def statusMsg(msg)
+
+      puts
+      puts "-} #{msg}"
+      puts
+
+    end # statusMsg
+
+  #-------------------------------------------------------------------------------------------------------------#
+  # printMetrics - Print context metrics
+  #
+  # ctx - Context to generate metrics from
+  #
+  #------------------------------------------------------------------------------------------------------------#
+    def printMetrics(ctx)
+    $LOG.debug "GdlDocBuilder::printMetrics()"
+      puts "        PPM count: #{ctx.ppms.size.to_s}"
+
+    end # printMetrics
+
+  #-------------------------------------------------------------------------------------------------------------#
+  # parseExternalVarDefs - parse predefined GDL variable definition files.
+  #
+  # ctx - context containing variables to update
+  #
+  #------------------------------------------------------------------------------------------------------------#
+    def parseExternalVarDefs(ctx)
+=begin
+    vp = LineParser.new                     # Parse externally defined GDL variable definition files.
+    vp.parse("R:/common/inc/DPMs.gdl")      # TODO: Allow external var def files to be defined in a config file.
+    vp.parse("R:/common/inc/DSMs.gdl")
+    vp.parse("R:/common/inc/PPMs.gdl")
+
+    vp.dumpResults if $DEBUG
+
+    puts "Searching for external PPM definitions." if $DEBUG
+    ctx.ppms.each do |key, val|
+      if (vp.ppms.has_key?(key))
+        ctx.ppms[key] = vp.ppms[key]
+        puts "Found match: #{key}" if $DEBUG
+      end # if vp.ppms
+    end # do
+=end
+    end # parseExternalVarDefs
+  end # class GdlDocBuilder
+end # module PpmToGdl
+

data/lib/ppmtogdl/ppmcontext.rb

@@ -0,0 +1,81 @@
+###############################################################################
+# File::    ppmcontext.rb
+# Purpose:: PpmContext class holds ppm variable definitions
+#
+# Author::    Jeff McAffee 04/30/2015
+#
+##############################################################################
+
+module PpmToGdl
+  class PpmContext
+
+    attr_accessor :ppms
+    attr_accessor :options
+
+    def initialize()
+    $LOG.debug "PpmContext::initialize()"
+      @ppms     = Hash.new
+    end # initialize
+
+    def setOptions(options)
+      $LOG.debug "PpmContext::setOptions( #{options} )"
+      @options = options
+    end
+
+    # Generate a valid guideline (GDL) ID
+    # inname:: name to convert
+    def createValidName(inname)
+    $LOG.debug "PpmContext::createValidName( #{inname}  )"
+      outname = inname.gsub(/[\s\/\\?*#+]/,'')        # Remove illegal chars (replace with underscore).
+      outname.gsub!(/_+/,"_")                         # Replace consecutive uscores with single uscore.
+      outname.gsub!(/\./,"-")                         # Replace period with dash.
+      outname.gsub!(/[\(\)\$]/,"")                    # Remove L & R Parens, dollar signs.
+      outname.gsub!(/\%/,"Perc")                      # Replace '%' with Perc.
+
+      outname
+    end
+
+    def isPpmVar(var)
+      isPpm = false
+
+      case var.varType
+        when 'app'
+          isPpm = true
+
+        when 'crd'
+          isPpm = true
+
+        when 'prd'
+          isPpm = true
+
+      end # case
+
+      isPpm
+    end # isPpmVar
+
+    # Dump all PPM variables
+    def dumpPpms()
+    $LOG.debug "PpmContext::dumpPpms()"
+      79.times {print "="}
+      puts
+      puts "PPM DUMP".center(80)
+      79.times {print "="}
+      puts
+
+      if(@ppms.length > 0)
+        ppms = @ppms.sort
+        ppms.each do |key, ppm|
+          puts "#{ppm.name}\t(#{ppm.alias})"
+        end
+
+      else
+        puts "No PPM variables to dump."
+      end
+
+      puts ""
+    end # dumpppms
+  end # class PpmContext
+end # module PpmToGdl
+
+
+

data/lib/ppmtogdl/ppmcontextobjs.rb

@@ -0,0 +1,78 @@
+##############################################################################
+# File::    ppmcontextobjs.rb
+# Purpose:: PrimaryParameter context objects
+#
+# Author::    Jeff McAffee 04/30/2015
+#
+##############################################################################
+
+module PpmToGdl
+  ##########################################################################
+  # MPpm class describes a PPM object
+  class MPpm
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :alias
+    attr_accessor :varType         # Type attribute - What portion of decision log value comes from: valid values "PRD, CRP, APM
+    attr_accessor :dataType        # DataType attribute -numeric, text, money, etc.
+    attr_accessor :customer
+    attr_accessor :verbose
+
+    def initialize(name, attributes, verbose=false)
+    $LOG.debug "Ppm::initialize( #{name}, #{attributes} )"
+
+      @verbose  = verbose
+      @name     = name
+      @alias    = attributes["Name"]
+      @varType  = attributes["Type"]
+      #@dataType = "UNKNOWN"
+      @dataType = attributes["Datatype"] #if (attributes.has_key?("Datatype"))
+
+      @customer  = attributes["Customer"]
+
+      if(@verbose)
+        attributes.each do |k, v|
+          puts "Attrib[ #{k} ]: #{v}"
+        end
+      end
+
+      case @varType
+        when 'APM'
+          @varType = "app"
+
+        when 'CRP'
+          @varType = "crd"
+
+        when 'PRD'
+          @varType = "prd"
+      end # varType
+
+      case @dataType
+        when 'Boolean'
+          @dataType = "boolean"
+
+        when 'Date'
+          @dataType = "date"
+
+        when 'Money'
+          @dataType = "money"
+
+        when 'Numeric'
+          @dataType = "numeric"
+
+        when 'Percentage'
+          @dataType = "percentage"
+
+        when 'Text'
+          @dataType = "text"
+
+        when 'DateTime'
+          @dataType = "datetime"
+
+      end # dataType
+    end # initialize
+  end # class Ppm
+end # module PpmToGdl
+
+

data/lib/ppmtogdl/ppmtogdlcfg.rb

@@ -0,0 +1,47 @@
+##############################################################################
+# File:: ppmtogdlcfg.rb
+# Purpose:: PpmToGdl configuration file reader/writer class.
+#
+# Author::    Jeff McAffee 03/07/2010
+# Copyright:: Copyright (c) 2010, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'ktcommon/ktcfg'
+
+module PpmToGdl
+  class PpmToGdlCfg < KtCfg::CfgFile
+
+    attr_accessor :cfg
+
+    def initialize(rootDir=nil)
+      $LOG.debug "PpmToGdlCfg::initialize"
+      super
+      @cfg = {}
+
+      setDefaults()
+    end
+
+    def setDefaults
+      $LOG.debug "PpmToGdlCfg::setDefaults"
+      app_path = ENV["LOCALAPPDATA"]
+      app_path ||= ENV["HOME"]
+      @cfg[:appPath] = File.rubypath(File.join(app_path, "ppmtogdl"))
+    end
+
+    # Load the YAML configuration file.
+    # returns:: a hash containing configuration info.
+    def load
+      $LOG.debug "PpmToGdlCfg::load"
+      @cfg = read("ppmtogdlcfg.yml")
+    rescue
+      # Nothing to read. Leave the defaults.
+    end
+
+    # Save the @cfg hash to a YAML file.
+    def save
+      $LOG.debug "PpmToGdlCfg::save"
+      write("ppmtogdlcfg.yml", @cfg)
+    end
+  end # class PpmToGdlCfg
+end # module PpmToGdl

data/lib/ppmtogdl/ppmtogdlcontroller.rb

@@ -0,0 +1,80 @@
+##############################################################################
+# File:: ppmtogdlcontroller.rb
+# Purpose:: Main Controller object for PpmToGdl utility
+#
+# Author::    Jeff McAffee 03/07/2010
+# Copyright:: Copyright (c) 2010, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'ktcommon/ktpath'
+require 'ktcommon/ktcmdline'
+
+module PpmToGdl
+  class PpmToGdlController
+
+    attr_reader   :verbose
+    attr_reader   :customer
+    attr_reader   :srcPath
+    attr_reader   :destPath
+
+    def initialize()
+      $LOG.debug "PpmToGdlController::initialize"
+      @cfg = PpmToGdlCfg.new.load
+      @verbose = false
+      @customer = ""
+      @srcPath = ""
+      @destPath = ""
+    end
+
+    def customer=( customer )
+      @customer = customer
+    end
+
+
+    def verbose=( verbose )
+      return unless (verbose == true || verbose == false)
+      @verbose = verbose
+    end
+
+
+    def doSomething()
+      $LOG.debug "PpmToGdlController::doSomething"
+      options = {}
+      options["customer"] = @customer   # FIXME: I think these should be symbols now, not strings.
+      options["verbose"]  = @verbose
+
+      destFile = ""
+      destFile = File.basename(@destPath) unless File.directory?(@destPath)
+      if(!destFile.empty?)
+        options[:destfile] = destFile
+      end
+      destDir  = @destPath
+      destDir  = File.dirname(@destPath) unless File.directory?(@destPath)
+      if(destDir.length() < 1)
+        destDir = Dir.getwd()
+      end
+      options[:destdir] = destDir
+
+      docBuilder = GdlDocBuilder.new(options)
+      docBuilder.createDocument(@srcPath)
+    end
+
+
+    def setFilenames(arg)
+      $LOG.debug "PpmToGdlController::setFilenames( #{arg} )"
+      @srcPath  = arg[0]
+      @destPath = arg[1]
+
+      @srcPath  = File.rubypath(@srcPath)
+      @destPath = File.rubypath(@destPath)
+    end
+
+
+    def noCmdLineArg()
+      $LOG.debug "PpmToGdlController::noCmdLineArg"
+      #exit "Should never reach here."
+    end
+  end # class PpmToGdlController
+end # module PpmToGdl
+

data/lib/ppmtogdl/ppmtogdltask.rb

@@ -0,0 +1,29 @@
+##############################################################################
+# File:: ppmtogdltask.rb
+# Purpose:: Rake Task for running the application
+#
+# Author::    Jeff McAffee 03/07/2010
+# Copyright:: Copyright (c) 2010, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'ppmtogdl'
+
+include PpmToGdl
+
+class PpmToGdlTask
+
+  def execute(customer, srcPath, destPath, verbose=false)
+    filenames = [srcPath, destPath]
+    raise "Missing source file path." unless (! srcPath.nil? && !srcPath.empty?)
+    raise "Missing destination file path." unless (! destPath.nil? && !destPath.empty?)
+
+    app = PpmToGdlController.new
+    app.customer = customer
+    app.setFilenames(filenames)
+    app.verbose = verbose
+    app.doSomething()
+  end
+end # class PpmToGdlTask
+
+