framework_gem 0.1.0

data/lib/dsllib/common/utils/excel_module.rb

@@ -0,0 +1,890 @@
+module Excel_module
+
+#	
+#	module Excel_module
+#	
+#	Author: Bill Fleet, Time Warner Cable
+#	Copyright @2013, Time Warner Cable, All rights reserved.
+#	Version: 1.0
+#	Revision Date: March 27, 2013
+#	
+#	
+	
+	
+	require 'rubygems'
+	gem 'rubyzip'
+	require 'zip/zip.rb'
+	
+	# constants (used for styles)
+	BOLD = 1
+	UNDERLINE = 2
+	BOLD_UNDERLINE = 3
+	TITLE = 4
+	
+	#
+	# WorksheetObject
+	#
+	# the worksheet data object. contains all methods for writing data and formats to the worksheet
+	# 
+	class WorksheetObject
+		
+		@cellArray = Array.new()
+		@columnFormats = Array.new()
+		@rowFormats = Array.new()
+			
+		#
+		# Cell - Inner class to hold cell info
+		#
+		class Cell
+			@address = ''	# simple address like 'A3' or 'Q10'
+			@value = ''		# the value
+			@type = ''		# either 'num', 'text', or 'formula'
+			@format = ''	# the named format
+			
+			# short form init
+			def initialize(addressIn = '', valueIn = '', typeIn = '', formatIn = '')
+				@address = addressIn
+				@value = valueIn
+				@type = typeIn
+				@format = formatIn
+			end
+			
+			#getters
+			def address() return @address end
+			def value() return @value end
+			def type() return @type end
+			def format() return @format end
+				
+			#setters
+			def setAddress(addressIn) @address = addressIn end
+			def setValue(valueIn) @value = valueIn end
+			def setType(typeIn) @type = typeIn end
+			def setFormat(formatIn) @format = formatIn end
+
+		end
+		
+		#
+		# Format - Inner class for rows and columns
+		#
+		class Format
+			@id = 0
+			@size = 0
+			@style = 0
+			@hidden = 0
+			
+			#short form init
+			def initialize(idIn = '', sizeIn = '', styleIn = '', hiddenIn = '')
+    			@id = idIn
+    			@size = sizeIn
+    			@style = styleIn
+    			@hidden = hiddenIn
+			end
+			
+			# getters
+			def id() return @id end
+			def size() return @size end
+			def style() return @style end
+			def hidden() return @hidden end
+
+			# setters
+			def setId(idIn) @id = idIn end
+			def setSize(sizeIn) @size = sizeIn end
+			def setStyle(styleIn) @style = styleIn end
+			def setHidden(hiddenIn) @hidden = hiddenIn end
+				
+		end
+		
+		#
+		# initialize - called when newing up the WorksheetObject
+		#
+		def initialize()
+			@cellArray = Array.new()
+			@columnFormats = Array.new()
+			@rowFormats = Array.new()
+		end
+		
+		#
+		# findCell - given a cell address, returns the cell. If none already exists, creates a new one
+		#
+		def findCell(addressIn)
+			# look for the cell with this address
+			if @cellArray != nil && @cellArray.length > 0
+    			for thisCell in @cellArray
+    				if thisCell.address == addressIn
+    					# the cell existed, return it
+    					return thisCell
+    				end
+    			end
+			end
+			
+			#if we couldn't find it, new one up and hand it back
+			thisCell = Cell.new()
+			thisCell.setAddress(addressIn)
+			return thisCell
+		end
+		
+		#
+		# putCell - given a cell, pushes it into the array. if it already exists in the array, replaces it with the new one
+		#
+		def putCell(cellIn)
+			# look for the cell with this address
+			if @cellArray != nil && @cellArray.length > 0
+    			for thisCell in @cellArray
+    				if thisCell.address == cellIn.address
+    					# the cell was found, replace it with the new one
+    					thisCell = cellIn
+    					return
+    				end
+    			end
+			end
+			
+			# the cell was not found, so push it onto the end
+			@cellArray.push(cellIn)
+		end
+		
+		#
+		# getCellRow - given a cell address ('G23'), returns the numeric portion ('23') (as a string)
+		#
+		def getCellRow(cellAddress)
+			# address is an alpha and a number, separate them
+			# alpha = cellAddress[/[a-zA-Z]*/]
+			number = cellAddress[/[0-9]+/]
+			return number
+		end
+		
+		#
+		# getCellColumn - given a cell address ('G23'), returns the alpha portion ('G')
+		#
+		def getCellColumn(cellAddress)
+			# address is an alpha and a number, separate them
+			alpha = cellAddress[/[a-zA-Z]*/]
+			# number = cellAddress[/[0-9]+/]
+			return alpha
+		end
+		
+		#
+		# getColumnCells - given a cell address ('G23'), returns array of cells in column
+		#
+		def getColumnCells(cellAddress)
+			theseCells = Array.new()
+			thisColumn = getCellColumn(cellAddress)
+			for thisCell in @cellArray
+				thatColumn = getCellColumn(thisCell.address)
+				if thisColumn == thatColumn
+					theseCells.push(thisCell)
+				end
+			end
+			
+			return theseCells
+		end
+		
+		#
+		# findFormat - given a cell address and a format array, finds any existing format object and returns it.
+		# if no format object was found, creates a new one.
+		#
+		def findFormat(addressIn, formatArray)
+
+			# look for the format by address 
+			for thisFormat in formatArray
+				if thisFormat.id == addressIn
+					# the format was found, return it
+					return thisFormat
+				end
+			end
+			# the format was not found, return a new one
+			thisFormat = Format.new()
+			thisFormat.setId(addressIn)
+			return thisFormat
+		end
+		
+		#
+		# putFormat - pushes the format object into the given format array. if already exists, replaces it
+		#
+		def putFormat(formatIn, formatArray)
+
+			# look for the format in the array
+			for thisFormat in formatArray
+				if thisFormat.id == formatIn.id
+					# the format was found, replace it
+					thisFormat = formatIn
+					return
+				end
+			end
+			# the format was not found, push it onto the array
+			formatArray.push(formatIn)
+		end
+		
+		#
+		# getAlphaNumber - given a cell address, returns the column number as a numeric value
+		#
+		def getAlphaNumber(addressIn)
+			
+			# get the column alpha value
+			alpha = getCellColumn(addressIn)
+			# the alpha should be a 1- or 2-character value. if not, quit
+			if alpha.length() < 1 || alpha.length() > 2
+				return 0
+			end
+			value = 0
+			#walk through the alpha and add up the values
+			alpha.each_byte {|charcode|
+				value = value * 26
+				value = value + charcode - 64
+			}
+			return value
+		end
+		
+		#
+		# setCellData - puts the given value into the specified cell
+		#
+		def setCellData(cellAddress, valueIn='')
+
+			# get the cell
+			thisCell = findCell(cellAddress)
+			
+			# figure out the data type from its content and set it
+			value = valueIn.to_s
+			if value.length > 0
+    			if value =~ /^[-+]?([0-9]*\.[0-9]+|[0-9]+)$/
+    				# if it's only numbers
+    				thisCell.setType('num')
+    			else
+    				# otherwise it's text - formula or text?
+    				if value =~ /^\=/
+    					thisCell.setType('formula')
+    				else
+    					thisCell.setType('text')
+    				end
+    			end
+			else
+				thisCell.setType('text')
+			end
+			
+			# set the value and return
+			thisCell.setValue(value)
+			putCell(thisCell)
+		end
+			
+		#
+		# setCellFormat - sets the specified cell to the named format
+		#
+		def setCellFormat(cellAddress, formatNameIn)
+			thisCell = findCell(cellAddress)
+			thisCell.setFormat(formatNameIn)
+			putCell(thisCell)
+		end
+		
+		#
+		# getNextColAddress - given a cell address, returns the cell address one column to the right
+		#
+		def getNextColAddress(cellAddress)
+			# address is an alpha and a number, separate them
+			alpha = getCellColumn(cellAddress) 
+			number = getCellRow(cellAddress)
+			
+			# assuming that succ will increment the alpha correctly
+			return alpha.succ + number
+		end
+		
+		#
+		# getNextRowAddress - given a cell address, returns the cell address one row down
+		#
+		def getNextRowAddress(cellAddress)
+			# address is an alpha and a number, separate them
+			alpha = getCellColumn(cellAddress) 
+			number = getCellRow(cellAddress)
+			
+			# assuming that succ will increment the number correctly
+			return alpha + number.succ
+		end
+		
+		#
+		# setRowData - sets a row of data values, starting at the given cell address
+		#
+		def setRowData(startingCellAddress, rowDataArray)
+			# start with the current address
+			cellAddress = startingCellAddress
+			# walk through the array of values
+			rowDataArray.each {|thisValue|
+				# set each cell value
+				setCellData(cellAddress, thisValue)
+				# increment the cell address
+				cellAddress = getNextColAddress(cellAddress)
+			}
+		end
+		
+		#
+		# setRowFormat - sets a row of cell formats, starting at the given cell address, for the given number of cells
+		#
+		def setRowFormat(startingCellAddress, numOfCells, formatNameIn)
+			# start with the current address
+			cellAddress = startingCellAddress
+			# walk through the cells to format
+			(0..numOfCells).each {|i|
+				# set each cell value
+				setCellFormat(cellAddress, formatNameIn)
+				# increment the cell address
+				cellAddress = getNextColAddress(cellAddress)
+			}
+		end
+		
+		#
+		# setColumnData - sets a column of data values, starting with the given cell address
+		#
+		def setColumnData(startingCellAddress, colDataArray)
+			# start with the current address
+			cellAddress = startingCellAddress
+			# walk through the array of values
+			colDataArray.each {|thisValue|
+				# set each cell value
+				setCellData(cellAddress, thisValue)
+				# increment the cell address
+				cellAddress = getNextRowAddress(cellAddress)
+			}
+		end
+		
+		#
+		# setColumnFormat - sets a column of cell formats, sarting at the given cell address, for the given number of cells
+		#
+		def setColumnFormat(startingCellAddress, numOfCells, formatNameIn)
+			# start with the current address
+			cellAddress = startingCellAddress
+			# walk through the cells to format
+			(0..numOfCells).each {|i|
+				# set each cell value
+				setCellFormat(cellAddress, formatNameIn)
+				# increment the cell address
+				cellAddress = getNextColAddress(cellAddress)
+			}
+		end
+		
+		#
+		# setColumnWidth - sets the width for the column the given cell address is in
+		#
+		def setColumnWidth(cellAddressIn, widthIn)
+			# address is an alpha and a number, separate them
+			alpha = getCellColumn(cellAddressIn)
+
+			thisFormat = findFormat(alpha, @columnFormats)
+			thisFormat.setSize(widthIn)
+			putFormat(thisFormat, @columnFormats)
+		end
+		
+		#
+		# setColumnHidden - hides the column the given cell address is in 
+		#
+		def setColumnHidden(cellAddressIn, hiddenIn)
+			# address is an alpha and a number, separate them
+			alpha = getCellColumn(cellAddressIn)
+
+			thisFormat = findFormat(alpha, @columnFormats)
+			thisFormat.setHidden(hiddenIn)
+			putFormat(thisFormat, @columnFormats)
+		end
+		
+		#
+		# getColDefs - produces the XML snippet defining the column formats in the final worksheet output
+		#
+		def getColDefs()
+			# use theseFormats as a countdown holder, but get the data from @columnFormats
+			theseFormats = Array.new(@columnFormats)
+			# set starter values
+			defsOut = ''
+			columnNumber = 1
+			
+			# loop until the data is gone
+			until theseFormats.length == 0 do 
+				widthStr = ''
+				styleStr = ''
+				hiddenStr = ''
+				# walk through the formats, looking for each column in turn
+    			for thisFormat in @columnFormats
+    				# match the column number
+    				if theseFormats.include?(thisFormat) && getAlphaNumber(thisFormat.id) == columnNumber
+    					# found the column format, write its values
+    					if thisFormat.size != ''
+    						widthStr = " width=\"#{thisFormat.size}\" customWidth=\"1\""
+    					end
+    					if thisFormat.style != ''
+    						styleStr = " style=\"#{thisFormat.style}\""
+    					end
+    					if thisFormat.hidden != ''
+    						hiddenStr = " hidden=\"1\""
+    					end
+    					# add the column string to the defsOut
+    					defsOut << "<col min=\"#{columnNumber}\" max=\"#{columnNumber}\"#{widthStr}#{styleStr}#{hiddenStr}/>\n"
+    					# remove the format from the countdown list
+    					theseFormats.delete(thisFormat)
+    					break
+    				end
+    			end
+    			# next column
+    			columnNumber = columnNumber + 1
+			end
+			return defsOut
+		end
+		
+		#
+		# getRowData - produces the XML segment describing the row and cell values and individual formats in the final worksheet output
+		#
+		def getRowData()
+			# use theseCells as a countdown holder, but get the data from @cellArray
+			theseCells = Array.new(@cellArray)
+			# set starter values
+			rowsOut = ''
+			rowNumber = 1
+			
+			# loop until the data is gone
+			until theseCells.length == 0 do 
+				thisRowOut = ''
+				# walk through the cells
+    			for thisCell in @cellArray
+					cellStr = ''
+					formatStr = ''
+					thisRowNumber = getCellRow(thisCell.address).to_i
+					# match the row number
+    				if theseCells.include?(thisCell) && thisRowNumber == rowNumber
+    					# found a cell in the row, decide its format and type
+						if thisCell.format != ''
+							formatStr = " s=\"#{thisCell.format}\""
+						end
+    					if thisCell.type == 'text'
+    						cellStr = "<c r=\"#{thisCell.address}\" t=\"inlineStr\"#{formatStr}><is><t>#{thisCell.value}</t></is></c>\n"
+    					elsif thisCell.type == 'formula'
+    						cellStr = "<c r=\"#{thisCell.address}\"#{formatStr}><f>#{thisCell.value}</f></c>\n"
+    					else	#it's numeric
+    						cellStr = "<c r=\"#{thisCell.address}\"#{formatStr}><v>#{thisCell.value}</v></c>\n"
+    					end
+    					# add the cell to the row and delete the cell
+    					thisRowOut << cellStr
+						theseCells.delete(thisCell)
+    					#break
+    				end
+    			end
+    			if thisRowOut != ''
+    				# the row had cells in it, write them out
+    				rowsOut << "<row r=\"#{rowNumber}\">\n#{thisRowOut}</row>\n"
+    			end
+    			# advance row number
+				rowNumber = rowNumber + 1
+			end
+			return rowsOut
+		end
+		
+	end
+	
+	#
+	# Inner_file
+	#
+	# basic form for files zipped into an Excel framework
+	
+	class Inner_file
+		
+		# basic expected values
+		@filename = ''
+		@path = ''
+		@content = ''
+		
+		# getFilename - getter for filename
+		def getFilename()
+			return @filename
+		end
+		
+		# setFilename - setter for filename
+		def setFilename(newFilename)
+			@filename = newFilename
+		end
+		
+		# getPath - getter for path
+		def getPath()
+			return @path
+		end
+		
+		# getPath - setter for path
+		def setPath(newPath)
+			@path = newPath
+		end
+		
+		# getContent - getter for content
+		def getContent()
+			return @content
+		end
+		
+		# setContent - setter for content
+		def setContent(new_content)
+			@content = new_content
+		end
+		
+		# initialize - basic init
+		def initialize()
+			puts @path + @filename
+		end
+		
+		# to_s - override for to_s
+		def to_s()
+			out_string = "#{@path}#{@filename}\n----\n#{@content}\n----"
+			return out_string
+		end
+	end
+	
+	#
+	# Content_types
+	#
+	# maps out the content types for most of the inner files of an .xslx doc (static)
+	
+	class Content_types < Inner_file
+		def initialize()
+    		@filename = '[Content_Types].xml'
+    		@path = ''
+    		@content = <<-CONTENT
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types">
+  <Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/>
+  <Override PartName="/workbook.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml"/>
+  <Override PartName="/worksheet.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml"/>
+  <Override PartName="/styles.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml" />
+</Types>
+    		CONTENT
+		end
+	end
+	
+	#
+	# Rels
+	# 
+	# pointer to app and core docs (static)
+	
+	class Rels < Inner_file
+		def initialize()
+    		@filename = '.rels'
+    		@path = '_rels/'
+    		@content = <<-RELS
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
+  <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="workbook.xml"/>
+</Relationships>
+			RELS
+		end
+	end
+	
+
+	
+	#
+	# App
+	#
+	# identifies the application type and the worksheet name (static)
+	
+	class App < Inner_file
+		def initialize()
+    		@filename = 'app.xml'
+    		@path = 'docProps/'
+    		@content = <<-APP
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<Properties xmlns="http://schemas.openxmlformats.org/officeDocument/2006/extended-properties" xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes">
+<Application>Microsoft Excel</Application>
+<DocSecurity>0</DocSecurity>
+<ScaleCrop>false</ScaleCrop>
+<HeadingPairs>
+	<vt:vector size="2" baseType="variant">
+		<vt:variant><vt:lpstr>Worksheets</vt:lpstr></vt:variant>
+		<vt:variant><vt:i4>1</vt:i4></vt:variant>
+	</vt:vector>
+</HeadingPairs>
+<TitlesOfParts>
+	<vt:vector size="1" baseType="lpstr">
+		<vt:lpstr>Data</vt:lpstr>
+	</vt:vector>
+</TitlesOfParts>
+<LinksUpToDate>false</LinksUpToDate>
+<SharedDoc>false</SharedDoc>
+<HyperlinksChanged>false</HyperlinksChanged>
+<AppVersion>14.0300</AppVersion>
+</Properties>
+			APP
+		end
+	end
+	
+	#
+	# Core
+	#
+	# defines the creator/modifier names and dates (static except for date)
+	
+	class Core < Inner_file
+		def initialize(date_time = Time.now.to_s())
+    		@filename = 'core.xml'
+    		@path = 'docProps/'
+    		@content = <<-CORE
+<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>
+<cp:coreProperties xmlns:cp=\"http://schemas.openxmlformats.org/package/2006/metadata/core-properties\" xmlns:dc=\"http://purl.org/dc/elements/1.1/\" xmlns:dcterms=\"http://purl.org/dc/terms/\" xmlns:dcmitype=\"http://purl.org/dc/dcmitype/\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
+	<dc:creator>TMC</dc:creator>
+	<cp:lastModifiedBy>TMC</cp:lastModifiedBy>
+	<dcterms:created xsi:type=\"dcterms:W3CDTF\">#{date_time}</dcterms:created>
+	<dcterms:modified xsi:type=\"dcterms:W3CDTF\">#{date_time}</dcterms:modified>
+</cp:coreProperties>
+			CORE
+		end
+	end
+	
+	#
+	# CalcChain
+	#
+	# defines the start of calculations (static, possibly dynamic if sheet cannot figure itself out)
+	
+	class CalcChain < Inner_file
+		def initialize()
+			@filename = 'calcChain.xml'
+			@path = 'xl/'
+			@content = <<-CALCCHAIN
+<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>
+<calcChain xmlns=\"http://schemas.openxmlformats.org/spreadsheetml/2006/main\">
+</calcChain>
+			CALCCHAIN
+		end
+	end
+	
+	#
+	# SharedStrings
+	#
+	# defines the various string bits used as labels and headers for the spreadsheet
+	# static for now, unless we abandon inlineString labels
+	
+	class SharedStrings < Inner_file
+		def initialize()
+			@filename = 'sharedStrings.xml'
+			@path = 'xl/'
+			@content = <<-SHAREDSTRINGS
+<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>
+<sst xmlns=\"http://schemas.openxmlformats.org/spreadsheetml/2006/main\" count=\"0\" uniqueCount=\"0\"></sst>
+			SHAREDSTRINGS
+		end
+	end
+	
+	#
+	# Workbook
+	#
+	# defines the worksheet and initial view (static)
+	
+	class Workbook < Inner_file
+		def initialize()
+			@filename = 'workbook.xml'
+			@path = ''
+			@content = <<-WKBOOK
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<workbook xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">
+  <sheets>
+    <sheet name="Data" sheetId="1" r:id="rId1"/>
+  </sheets>
+</workbook>
+			WKBOOK
+		end
+	end
+	
+	#
+	# WorkbookXmlRels
+	#
+	# defines the rId pointer to the worksheet (static)
+	
+	class WorkbookXmlRels < Inner_file
+		def initialize()
+			@filename ='workbook.xml.rels'
+			@path = '_rels/'
+			@content = <<-WKXRELS
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
+  <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet" Target="/worksheet.xml"/>
+  <Relationship Id="rId2" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" Target="/styles.xml" /> 
+</Relationships>
+			WKXRELS
+		end
+	end
+  
+	
+	#
+	# Styles
+	#
+	# defines the usable styles in the doc (static)
+	# for now, just the most basic styles will be used
+	
+	class Styles < Inner_file
+		def initialize()
+			@filename = 'styles.xml'
+			@path = ''
+			@content = <<-STYLES
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<styleSheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">
+  <fonts count="3">
+    <font />
+    <font><b /></font>
+    <font><b /><sz val="18" /></font>
+  </fonts>
+  <fills count="1">
+    <fill />
+  </fills>
+  <borders count="1">
+    <border />
+	<border><left /><right /><top /><bottom style="thin"><color rgb="FF000000"/></bottom><diagonal/></border>
+  </borders>
+  <cellStyleXfs count="1">
+    <xf />
+  </cellStyleXfs>
+  <cellXfs count="5">
+    <xf />
+    <xf fontId="1" />
+    <xf borderId="1" />
+    <xf fontId="1" borderId="1" />
+    <xf fontId="2" />
+  </cellXfs>
+</styleSheet>
+			STYLES
+		end
+	end
+	
+	#
+	# Worksheet
+	#
+	# the actual worksheet data file. initialize with worksheet object
+	
+	class Worksheet < Inner_file
+		def initialize(wkSheetObj)
+			colDefs = wkSheetObj.getColDefs()
+			rowData = wkSheetObj.getRowData()
+		
+			@filename = 'worksheet.xml'
+			@path = ''
+			@content = <<-WKSHEET
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">
+<cols>
+#{colDefs}</cols>
+<sheetData>
+#{rowData}</sheetData>
+</worksheet>
+			WKSHEET
+		end
+	end
+	
+	#
+	# file_to_zip
+	#
+	# public method to push a file into the supplied zip file
+	
+	def Excel_module.file_to_zip(thisXfile, thisInnerFile)
+		thisEntry = thisInnerFile.getPath() + thisInnerFile.getFilename()
+		#check to see if the entry exists already
+		if thisXfile.find_entry(thisEntry) != nil
+			# if it exists, remove it first
+			thisXfile.remove(thisEntry)
+		end
+		# write the entry
+		thisXfile.get_output_stream(thisEntry) {|xf| xf.puts(thisInnerFile.getContent())}
+	
+		return thisXfile
+	end
+	
+	#
+	# write_xslx
+	#
+	# public method to write a spreadsheet xslx doc, given a completed WorksheetObject
+	    
+	def Excel_module.write_xslx(workSheetObj, location)
+		Zip::ZipFile.open(location, true ) {|xfile|
+			
+			#file Content_types              
+			thisFile = Excel_module::Content_types.new()
+			xfile = file_to_zip(xfile, thisFile)
+				
+			#file Rels
+			thisFile = Excel_module::Rels.new()
+			xfile = file_to_zip(xfile, thisFile)
+				
+			#file Workbook
+			thisFile = Excel_module::Workbook.new()
+			xfile = file_to_zip(xfile, thisFile)
+			
+			#file WorkbookXmlRels
+			thisFile = Excel_module::WorkbookXmlRels.new()
+			xfile = file_to_zip(xfile, thisFile)
+			
+			#file Styles
+			thisFile = Excel_module::Styles.new()
+			xfile = file_to_zip(xfile, thisFile)
+			
+			#file Worksheet
+			thisFile = Excel_module::Worksheet.new(workSheetObj)
+			xfile = file_to_zip(xfile, thisFile)
+			
+			#close it
+			xfile.close()
+			
+			puts location + ' written to disk.'
+		}
+	end
+	
+	#
+	# send_email
+	#
+	# public method to send Excel doc as email attachment
+	
+    def Excel_module.send_email(workSheetObj, smtpObj, sender, recipient, 
+    							local_file = 'report.xslx',
+    							subject = 'Sending Attachment', 
+    							body_text = 'This is an automatically generated document. Please do not response to this message.'
+    							)
+    	
+    	# write the file 
+    	write_xslx(workSheetObj, local_file)
+    	
+    	# read the file and encode it into base64 format
+    	file_content = File.read(local_file)
+    	file_content_encoded = [file_content].pack("m")   # base64
+    	separator = 'LINE_SEPARATOR'	# unique string to separate multipart parts
+    	
+    	# define the headers
+    	part_one = <<HEADERS
+From: #{sender}
+To: #{recipient}
+Subject: #{subject}
+MIME-Version: 1.0
+Content-Type: multipart/mixed; boundary=#{separator}
+--#{separator}
+HEADERS
+
+    	# define the message part
+    	part_two = <<MAIN_BODY
+Content-Type: text/plain
+Content-Transfer-Encoding: 8bit
+
+#{body_text}
+--#{separator}
+MAIN_BODY
+	
+    	# define the attachment part
+    	part_three = <<ATTACHMENT
+Content-Type: multipart/mixed; name="#{local_file}"
+Content-Transfer-Encoding:base64
+Content-Disposition: attachment; filename="#{local_file}"
+
+#{file_content_encoded}
+--#{separator}--
+ATTACHMENT
+
+    	begin
+
+			smtpObj.sendmail(
+				part_one + part_two + part_three,
+					"test.server@twcable.com",
+					recipient
+
+
+				)
+    	rescue Exception => e
+    		puts "Exception occurred during mail send: #{e}"
+    	end
+    	begin
+    		File::delete(local_file)
+    	rescue Exception => e
+    		puts "Exception during file delete: #{e}"
+    	end
+    	puts "Message sent."
+    end
+
+end