parse_decision 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44dd7989c8b375f3969f1fcab82d69b779be844e
+  data.tar.gz: a85f3fbb7cd654cea7f07fd697605ca9eae24583
+SHA512:
+  metadata.gz: f975f2e85859524dd6b1d31c25da927b0677d3ac6914fae5212a17cb1121b6abf5fc4bb00fdc868dc81e9272a6ae1ce12cfc60e36c267f95b865398d61cac2c0
+  data.tar.gz: 6e658f113693f199de98d02f99ed218d6b8124b584244e10019b2d4496cbed07bfc5e7a124754f8d3ac830d5bb3883f8dbc6db479e529da9e7c469d8cbb8511d

data/.gitignore

@@ -0,0 +1,17 @@
+# Files and directories that should be ignored
+
+# Specific files to ignore
+/buildgem
+/buildgem.cmd
+/pdconfig.yml
+
+# Dir to ignore
+pkg/
+test/data/output/
+test/data/output-webdecision/
+test/data/pdconfig.yml
+tmp/
+trace.log
+
+# Don't checkin Gemfile.lock
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'ktcommon', :git => 'ssh://git@bitbucket.org/ktechsystems/ktcommon.git'
+
+# Specify your gem's dependencies in test.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jeff McAffee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,71 @@
+# ParseDecision Documentation
+
+## Usage
+
+ParseDecision provides both a command line application and a rake task
+that is used to parse decision logs generated by the Commerce Velocity
+AMS application.
+
+### Rake Task Usage
+
+The rake task can be included in a rakefile by requiring parse_decision like so:
+
+    require 'parse_decision'
+
+and called as:
+
+    ParseDecisionTask.new.execute( logSrcPath, destDir )
+
+The parser will parse the decision log out to a destination directory. Each **product**
+within the log will be parsed into a separate file. The APP XML is also parsed to a
+separate file for each product.
+
+Both the product and the APP XML file names will be prefixed with the same number.
+The number indicates the order that the data was found within the decision log.
+
+A copy of the decision log (pre-parse) is also copied to the destination folder for
+archiving purposes.
+
+### Command Line Application
+
+Usage info can be retrieved from the application by calling it with the -h or --help
+options:
+
+    $ parse_decision --help
+
+
+## Notes
++ The decision log doesn't produce valid XML in many situations.
++ In the interest of preserving any data the log may contain, the resulting XML is **not** cleaned.
++ As a result of the previous notes, the parsed files are not guaranteed to be valid XML.
+
+## Version Control
+
+This repo includes submodules.
+
+To property initialize the repo, after cloning it, run
+
+    $ git submodule init
+    $ git submodule update
+
+After pulling in the submodules, you may want to configure git to ignore
+changes (dirty) in the submodules. This can be done by adding a `ignore = all`
+statement to each submodule section in `.gitmodules`
+
+    # Example:
+    [submodule "common"]
+        path = common
+        url = git@cerberus:/home/git/ams/common.git
+        ignore = all
+
+Be sure to commit your changes to `.gitmodules`.
+
+Submodules used in this repo:
+
++ none currently
+
+
+
+**Website:**    http://ktechsystems.com
+
+_Copyright (c) 2011, kTech Systems LLC. All rights reserved._

data/bin/parse_decision

@@ -0,0 +1,126 @@
+#!/usr/bin/env ruby
+##############################################################################
+# File:: parse_decision.rb
+# Purpose:: Utility to ...
+# 
+# Author::    Jeff McAffee 03/12/2010
+# Copyright:: Copyright (c) 2010, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'parse_decision'
+require 'user-choices'
+
+
+class ParseDecisionApp < UserChoices::Command
+    include UserChoices
+
+    
+    def initialize()
+        super
+        @controller = ParseDecision::Controller.new
+    end
+    
+    
+    def add_sources(builder)
+        builder.add_source(CommandLineSource, :usage,
+                            "Usage: #{File.basename($0)} [options] [OUTPUT_DIR]",
+                            "\n\tParseDecision is used to break decision log files out into their parts.",
+                            "\tOUTPUT_DIR [optional] Dir to place generated files.")
+    end # def add_sources
+    
+    
+    def add_choices(builder)
+        # Arguments
+        #builder.add_choice(:cmdArg, :length=>1) { |command_line|   # Use length to REQUIRE args.
+        builder.add_choice(:cmdArg) { |command_line|
+            command_line.uses_arglist
+        }
+        
+        # Switches
+        #builder.add_choice(:aswitch, :type=>:boolean, :default=>false) { |command_line|
+        #    command_line.uses_switch("-a", "--aswitch",
+        #                            "Switch description.")
+        #}
+
+        builder.add_choice(:logging, :type=>:boolean, :default=>false) { |command_line|
+            command_line.uses_switch("--logging",
+                                    "Turn logging to file on/off.")
+        }
+        
+        builder.add_choice(:reset, :type=>:boolean, :default=>false) { |command_line|
+            command_line.uses_switch("-r", "--reset",
+                                    "Reset config file to defaults.")
+        }
+        
+        builder.add_choice(:verbose, :type=>:boolean, :default=>false) { |command_line|
+            command_line.uses_switch("-v", "--verbose",
+                                    "Lots of output.")
+        }
+        
+        builder.add_choice(:version, :type=>:boolean, :default=>false) { |command_line|
+            command_line.uses_switch("--version",
+                                    "Application version.")
+        }
+        
+        builder.add_choice(:which, :type=>:boolean, :default=>false) { |command_line|
+            command_line.uses_switch("--which",
+                                    "Display the Application's location.\n")
+        }
+        
+        # Options
+        builder.add_choice(:file, :type=>:string) { |command_line|
+            command_line.uses_option("-f", "--file ARG",
+                                    "Name of decision file","(default: 2.decision.txt)")
+        }
+        
+        builder.add_choice(:outdir, :type=>:string) { |command_line|
+            command_line.uses_option("-o", "--outdir ARG",
+                                    "Dir to place generated files in.", "(Will be created if it doesn't exist)")
+        }
+        
+        builder.add_choice(:srcdir, :type=>:string) { |command_line|
+            command_line.uses_option("-s", "--srcdir ARG",
+                                    "Dir of src decision file.")
+        }
+        
+    end # def add_choices
+    
+    
+    # Execute the ParseDecision application.
+    # This method is called automatically when 'parse_decision(.rb)' is executed from the command line.
+    def execute
+      $LOG.debug "ParseDecisionApp::execute"
+
+	  options = @user_choices
+      if(!options[:logging])
+		options[:logging] = false
+      end
+      
+      if(@user_choices[:which])
+        puts "Location: #{$0}"
+        return
+      end
+      
+      @controller.setOptions(options)
+	  
+	  if(@user_choices[:cmdArg].empty?) # If no cmd line arg...
+        if( !@controller.noCmdLineArg() )
+			return
+		end
+      else
+		  if( !@controller.executeWithCmdLineArg(@user_choices[:cmdArg]) )
+			return
+		  end
+	  end
+      
+      @controller.execute()
+    end # def execute
+        
+    
+end # class ParseDecisionApp
+
+
+#if $0 == __FILE__
+    ParseDecisionApp.new.execute
+#end    

data/lib/parse_decision/config.rb

@@ -0,0 +1,90 @@
+##############################################################################
+# File:: config.rb
+# Purpose:: ParseDecision configuration file reader/writer class.
+#
+# Author::    Jeff McAffee 03/12/2010
+# Copyright:: Copyright (c) 2010, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'ktcommon/ktcfg'
+require 'parse_decision/version'
+
+##############################################################################
+# Everything is contained in module ParseDecision
+module ParseDecision
+
+  ##########################################################################
+  # Controller class handles interactions bewteen the view (cmdline script)
+  # and the model (Tool).
+  class Config < KtCfg::CfgFile
+
+    attr_accessor :cfg
+
+    def initialize(rootDir=nil)
+      $LOG.debug "Config::initialize"
+      super
+      @cfg = {}
+
+      setDefaults()
+    end
+
+    def setDefaults
+      $LOG.debug "Config::setDefaults"
+
+      # Blow away the existing cfg hash
+      @cfg = {}
+
+      # Notes about APPDATA paths:
+      # Local app data should be used when an app's data is too
+      # big to move around. Or is specific to the machine running
+      # the application.
+      #
+      # Roaming app data files could be pushed to a server (in a
+      # domain environment) and downloaded onto a different work
+      # station.
+      #
+      # LocalLow is used for data that must be sandboxed. Currently
+      # it is only used by IE for addons and storing data from
+      # untrusted sources (as far as I know).
+      #
+
+
+      #appDataPath  = ENV["APPDATA"]          # APPDATA returns AppData\Roaming on Vista/W7
+      appDataPath   = ENV["LOCALAPPDATA"]       # LOCALAPPDATA returns AppData\Local on Vista/W7
+      appDataPath   ||= ENV["HOME"]
+      @cfg[:appPath]  = File.rubypath(File.join(appDataPath, "parse_decision"))
+      @cfg[:version]  = ParseDecision::VERSION
+      @cfg[:file]   = "2.decision.txt"
+      @cfg[:logging]  = false
+    end
+
+    # Load the YAML configuration file.
+    # returns:: a hash containing configuration info.
+    def load
+      $LOG.debug "Config::load"
+
+      filepath = cfgFilePath("pdconfig.yml")
+      if(!File.exists?( filepath ))   # TODO: This needs to be moved into KtCfg.
+        $LOG.debug "Config file does not exist. Returning default config obj."
+        return @cfg
+      end
+
+      @cfg = read("pdconfig.yml")
+    end
+
+    # Save the @cfg hash to a YAML file.
+    def save(cfg=nil)
+      $LOG.debug "Config::save( cfg )"
+      if( nil != cfg )
+        @cfg = cfg
+      end
+      write("pdconfig.yml", @cfg)
+    end
+
+    def addKeyValue(key, value)
+      $LOG.debug "Config::addKeyValue( #{key.to_s}, #{value} )"
+      @cfg[key] = value
+    end
+  end # class Config
+end # module ParseDecision

data/lib/parse_decision/controller.rb

@@ -0,0 +1,142 @@
+##############################################################################
+# File:: controller.rb
+# Purpose:: Main Controller object for ParseDecision utility
+# 
+# Author::    Jeff McAffee 03/12/2010
+# Copyright:: Copyright (c) 2010, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'ktcommon/ktpath'
+require 'ktcommon/ktcmdline'
+
+##############################################################################
+# Everything is contained in Module	ParseDecision
+module ParseDecision
+	  
+	##########################################################################
+	# Controller class handles interactions bewteen the view (cmdline script)
+	# and the model (Tool).
+	class Controller
+
+	  def initialize()
+		$LOG.debug "Controller::initialize"
+		@cfg = Config.new.load
+		@cfg = Config.new.load
+		@model = Parser.new
+	  end
+	  
+		
+	  # Save the current config values and start the parse.
+	  def execute()
+		$LOG.debug "Controller::execute"
+		
+		# Save current cfg
+		Config.new.save( @cfg )
+		@model.parseCfg( @cfg )
+	  end
+		  
+	  # Set switches with values from a hash. This should only be
+	  # called from +setOptions+.
+	  def setSwitches(options={})
+		$LOG.debug "Controller::setSwitches( options={} )"
+		
+		if(options.length)
+			options.each do |opt, arg|
+				case opt 
+					when :logging
+						cfgCtrl = Config.new
+						cfgCtrl.load
+						cfgCtrl.addKeyValue(:logging, arg)
+						cfgCtrl.save
+					
+					when :reset
+						cfgCtrl = Config.new
+						cfgCtrl.save
+					
+					when :verbose
+						# Set verbose flag
+						@cfg[:verbose] = true
+					
+					when :version
+						# Print the version and exit.
+						verStr1 = "#{ParseDecision::APPNAME} v#{@model.version}"
+						verStr2 = "#{ParseDecision::COPYRIGHT}"
+						puts verStr1
+						puts verStr2
+						puts
+						exit
+						
+					else
+						# Don't know what you want but I don't recognize it.
+					
+				end # case opt
+			end # options.each
+		end # if more than 1 option
+	  end
+	  private :setSwitches  
+	  
+	  # Set all options and switches with values from a hash.
+	  def setOptions(options={})
+		$LOG.debug "Controller::setOptions( options={} )"
+		
+		setSwitches(options)
+		
+		if(options.length)
+			options.each do |opt, arg|
+				case opt 
+					when :file
+						# Set cfg decision file name
+						@cfg[:file] = arg
+					
+					when :outdir
+						# Set context output dir
+						@cfg[:outdir] = arg
+					
+					when :srcdir
+						# Set context src dir
+						@cfg[:srcdir] = arg
+						
+					else
+						# Don't know what you want but I don't recognize it.
+					
+				end
+			end # options.each
+		
+			cfgCtrl = Config.new
+			cfgCtrl.load
+			cfgCtrl.cfg.merge!(@cfg)
+			cfgCtrl.save
+		end # if more than 1 option
+	  end
+		  
+	  
+	  # Command line arg will be used as the +outdir+.
+	  def executeWithCmdLineArg(arg)
+		$LOG.debug "Controller::executeWithCmdLineArg( #{arg} )"
+		@cfg[:outdir] = arg
+		return true # if ok to continue, false to exit app.
+	  end
+		  
+	  
+	  # Make sure +outdir+ has been set.
+	  # Returns true as long as outdir is set one way or the other.
+	  def noCmdLineArg()
+		$LOG.debug "Controller::noCmdLineArg"
+		if( @cfg.key?(:outdir) && !@cfg[:outdir].empty? )
+			return true # if ok to continue, false to exit app.
+		end
+		
+		puts "Missing output directory argument."
+		puts
+		puts "The outdir needs to be set at least one time."
+		puts "Use the -o option or supply the output directory path on the command line."
+		puts "Use -h for help."
+		return false # to exit app.
+	  end
+		  
+	  
+	end # class Controller
+
+
+end # module ParseDecision

data/lib/parse_decision/parsedecisiontask.rb

@@ -0,0 +1,31 @@
+##############################################################################
+# File:: parsedecisiontask.rb
+# Purpose:: Rake Task for running the application
+# 
+# Author::    Jeff McAffee 04/16/2010
+# Copyright:: Copyright (c) 2010, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'parse_decision'
+class ParseDecisionTask
+
+	def execute(logSrcPath, destDir, verbose=false)
+		
+		dsnFile = File.basename(logSrcPath)
+		dsnDir	= File.dirname(logSrcPath)
+		
+		app = ParseDecision::Controller.new
+		
+		options = {	:reset => true, 			# Set switches
+					:verbose => verbose,
+					:file => dsnFile,			# Set options
+					:srcdir => dsnDir,
+					:outdir => destDir, }
+					
+		app.setOptions( options )
+		app.execute()
+	end
+end # class ParseDecisionTask
+
+