winexcel 0.0.1

data/features/support/common.rb

@@ -0,0 +1,37 @@
+module CommonHelpers
+  def get_command_output
+    strip_color_codes(File.read(@stdout)).chomp
+  end
+
+  def strip_color_codes(text)
+    text.gsub(/\e\[\d+m/, '')
+  end
+
+  def in_tmp_folder(&block)
+    FileUtils.chdir(@tmp_root, &block)
+  end
+
+  def in_project_folder(&block)
+    project_folder = @active_project_folder || @tmp_root
+    FileUtils.chdir(project_folder, &block)
+  end
+
+  def in_home_folder(&block)
+    FileUtils.chdir(@home_path, &block)
+  end
+
+  def force_local_lib_override(project_name = @project_name)
+    rakefile = File.read(File.join(project_name, 'Rakefile'))
+    File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
+      f << "$:.unshift('#{@lib_path}')\n"
+      f << rakefile
+    end
+  end
+
+  def setup_active_project_folder project_name
+    @active_project_folder = File.join(@tmp_root, project_name)
+    @project_name = project_name
+  end
+end
+
+World(CommonHelpers)

data/features/support/env.rb

@@ -0,0 +1,14 @@
+$:.unshift(File.expand_path(File.dirname(__FILE__) + "/../../lib"))
+require 'winexcel.rb'
+require 'bundler/setup'
+
+Before do
+  @tmp_root = File.dirname(__FILE__) + "/../../tmp"
+  @home_path = File.expand_path(File.join(@tmp_root, "home"))
+  @lib_path = File.expand_path(File.dirname(__FILE__) + "/../../lib")
+  FileUtils.rm_rf @tmp_root
+  FileUtils.mkdir_p @home_path
+  ENV['HOME'] = @home_path
+  ENV['CUCUMBER_RUNNING'] = 'yes'
+end
+

data/features/support/matchers.rb

@@ -0,0 +1,9 @@
+module Matchers
+  RSpec::Matchers.define :contain do |expected_text|
+    match do |text|
+      text.index expected_text
+    end
+  end
+end
+
+World(Matchers)

data/lib/winexcel.rb

@@ -0,0 +1,12 @@
+module WinExcel
+
+  require 'winexcel/core_ext/object'
+  require 'winexcel/core_ext/ordered_hash'
+  require 'fileutils'
+  require 'winexcel/fileutils_ext/create_dir_if_missing'
+  require 'winexcel/fileutils_ext/backup_file'
+
+  require 'winexcel/excel/xl_file_format'
+  require 'winexcel/version'
+  require 'winexcel/excel_file'
+end

data/lib/winexcel/core_ext/object.rb

@@ -0,0 +1,34 @@
+class Object
+  # Returns true if the object is nil or empty. It works on most popular objects
+  # like hashes, arrays and strings. Main purpose is to avoid double checking statements
+  # (and to eliminate bugs caused by single checking) like in code below:
+  #     if some_obj == nil or some_obj.empty?
+  #       # do something
+  #     end
+  # Remarks: When this funcion is applied to a String, false is returned when
+  #          the string contains white space characters only.
+  def unempty?
+    if [nil, [], {}].include?(self) or (self.kind_of?(String) and self.strip == '')
+      return false
+    else
+      return true
+    end
+  end
+
+  def in?(arr)
+    return true if arr.unempty? and arr.include?(self)
+  end
+
+  def has?(obj)
+    if [nil].include?(self)
+      return false
+    else
+      return self.include?(obj)
+    end
+  end
+
+  def eq?(obj)
+    return self.to_s.upcase == obj.to_s.upcase
+  end
+
+end

data/lib/winexcel/core_ext/ordered_hash.rb

@@ -0,0 +1,100 @@
+module WinExcel
+  module CoreExt #:nodoc:
+
+    if RUBY_VERSION >= '1.9'
+      class OrderedHash < ::Hash
+      end
+    else
+      # This class is based on the Ruby 1.9 ordered hashes.
+      #
+      # It keeps the semantics and most of the efficiency of normal hashes
+      # while also keeping track of the order in which elements were set.
+      #
+      class OrderedHash #:nodoc:
+        include Enumerable
+
+        Node = Struct.new(:key, :value, :next, :prev)
+
+        def initialize
+          @hash = {}
+        end
+
+        def [](key)
+          @hash[key] && @hash[key].value
+        end
+
+        def []=(key, value)
+          if node = @hash[key]
+            node.value = value
+          else
+            node = Node.new(key, value)
+
+            if @first.nil?
+              @first = @last = node
+            else
+              node.prev = @last
+              @last.next = node
+              @last = node
+            end
+          end
+
+          @hash[key] = node
+          value
+        end
+
+        def delete(key)
+          if node = @hash[key]
+            prev_node = node.prev
+            next_node = node.next
+
+            next_node.prev = prev_node if next_node
+            prev_node.next = next_node if prev_node
+
+            @first = next_node if @first == node
+            @last = prev_node if @last == node
+
+            value = node.value
+          end
+
+          @hash.delete(key)
+          value
+        end
+
+        def keys
+          self.map { |k, v| k }
+        end
+
+        def values
+          self.map { |k, v| v }
+        end
+
+        def each
+          return unless @first
+          yield [@first.key, @first.value]
+          node = @first
+          yield [node.key, node.value] while node = node.next
+          self
+        end
+
+        def merge(other)
+          hash = self.class.new
+
+          self.each do |key, value|
+            hash[key] = value
+          end
+
+          other.each do |key, value|
+            hash[key] = value
+          end
+
+          hash
+        end
+
+        def empty?
+          @hash.empty?
+        end
+      end
+    end
+
+  end
+end

data/lib/winexcel/excel/xl_file_format.rb

@@ -0,0 +1,74 @@
+module WinExcel
+  module Excel
+    APPLICATION_NAME = 'Excel.Application'
+    LOAD_ALL_CONSTANTS = false # for performance reasons it's been disabled
+
+    #
+    # XlFileFormat is much more faster replacement for LOAD_ALL_CONSTANTS
+    #
+    module XlFileFormat
+      #   Excel::XlFileFormat::
+
+      #	Name = Value 	# Description
+      XlAddIn = 18 # Microsoft Excel 97-2003 Add-In
+      XlAddIn8 = 18 # Microsoft Excel 97-2003 Add-In
+      XlCSV = 6 # CSV
+      XlCSVMac = 22 # Macintosh CSV
+      XlCSVMSDOS = 24 # MSDOS CSV
+      XlCSVWindows = 23 # Windows CSV
+      XlCurrentPlatformText = -4158 # Current Platform Text
+      XlDBF2 = 7 # DBF2
+      XlDBF3 = 8 # DBF3
+      XlDBF4 = 11 # DBF4
+      XlDIF = 9 # DIF
+      XlExcel12 = 50 # Excel12
+      XlExcel2 = 16 # Excel2
+      XlExcel2FarEast = 27 # Excel2 FarEast
+      XlExcel3 = 29 # Excel3
+      XlExcel4 = 33 # Excel4
+      XlExcel4Workbook = 35 # Excel4 Workbook
+      XlExcel5 = 39 # Excel5
+      XlExcel7 = 39 # Excel7
+      XlExcel8 = 56 # Excel8
+      XlExcel9795 = 43 # Excel9795
+      XlHtml = 44 # HTML format
+      XlIntlAddIn = 26 # International Add-In
+      XlIntlMacro = 25 # International Macro
+      XlOpenDocumentSpreadsheet = 60 # OpenDocument Spreadsheet
+      XlOpenXMLAddIn = 55 # Open XML Add-In
+      XlOpenXMLTemplate = 54 # Open XML Template
+      XlOpenXMLTemplateMacroEnabled = 53 # Open XML Template Macro Enabled
+      XlOpenXMLWorkbook = 51 # Open XML Workbook
+      XlOpenXMLWorkbookMacroEnabled = 52 # Open XML Workbook Macro Enabled
+      XlSYLK = 2 # SYLK
+      XlTemplate = 17 # Template
+      XlTemplate8 = 17 # Template 8
+      XlTextMac = 19 # Macintosh Text
+      XlTextMSDOS = 21 # MSDOS Text
+      XlTextPrinter = 36 # Printer Text
+      XlTextWindows = 20 # Windows Text
+      XlUnicodeText = 42 # Unicode Text
+      XlWebArchive = 45 # Web Archive
+      XlWJ2WD1 = 14 # WJ2WD1
+      XlWJ3 = 40 # WJ3
+      XlWJ3FJ3 = 41 # WJ3FJ3
+      XlWK1 = 5 # WK1
+      XlWK1ALL = 31 # WK1ALL
+      XlWK1FMT = 30 # WK1FMT
+      XlWK3 = 15 # WK3
+      XlWK3FM3 = 32 # WK3FM3
+      XlWK4 = 38 # WK4
+      XlWKS = 4 # Worksheet
+      XlWorkbookDefault = 51 # Workbook default
+      XlWorkbookNormal = -4143 # Workbook normal
+      XlWorks2FarEast = 28 # Works2 FarEast
+      XlWQ1 = 34 # WQ1
+      XlXMLSpreadsheet = 46 # XML Spreadsheet
+    end
+
+    # not yet implemented
+    RunModes = {}
+    RunModes[:open_new_in_isolated_excel] = :open_new_in_isolated_excel
+    RunModes[:find_in_existing_not_isolated_workbooks] = :find_in_existing_not_isolated_workbooks
+  end
+end

data/lib/winexcel/excel_file.rb

@@ -0,0 +1,255 @@
+# excel_file.rb
+#
+#     File based on Xls.rb being part of 'wwatf' project
+#     Copyright (C) 2010-2011 Sobieraj Kamil <ksob@dslowl.com>.
+#
+# This file is published under New BSD License
+# You can redistribute and/or 
+# modify it under the terms of the New BSD License.
+#
+# New BSD License claims:
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#      this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#      this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# 3. Neither the name of Zend Technologies USA, Inc. nor the names of its
+#      contributors may be used to endorse or promote products derived from this
+#      software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+require 'logger'
+require 'win32ole'
+
+require 'rubygems'
+if RUBY_VERSION >= '1.9'
+  require 'win32olerot'
+else
+  require 'winexcel/win32olerot_ext/win32olerot'
+end
+
+require 'winexcel/excel_file/write_2D_array'
+require 'winexcel/excel_file/common_methods'
+require 'winexcel/excel_file/other_methods'
+
+# Excel interface class.
+# This class provides many simple methods for using Excel spreadsheets.
+#
+# Inner working:
+# If the File is already open in excel, data is read from the open file 
+# and left open after the call to the close/finalize method.
+# If the file is not open, It will be opened in the background 
+# and closed when the close/finalize method is called.
+#
+# For examples look at the examples folder as well as Cucumber/RSpec 
+# files in features and spec directories
+#
+# Information for developers:
+#   It is helpful to use COM/Win32OLE tracking tool like "oakland ActiveX Inspector"
+#   to clearly see what Excel instances are beeing created
+#
+module WinExcel
+
+  class ExcelFile
+    # Singleton Class to store Excel Constant Variables
+    class ExcelConst;
+    end
+
+    attr_accessor :excel
+    attr_accessor :workbook
+    attr_accessor :records
+    attr_accessor :fileName
+
+    @@automationInstance = nil
+
+    XlsAutomationSecurity = 3 # msoAutomationSecurityForceDisable
+    XlsDisplayAlerts = false
+    XlsVisible = false
+    XlsScreenUpdating = false
+    XlsInteractive = false
+
+    def setSettings excel
+      excel.Application.AutomationSecurity = XlsAutomationSecurity
+      excel.DisplayAlerts = XlsDisplayAlerts
+      excel.Visible = XlsVisible
+      excel.ScreenUpdating = XlsScreenUpdating
+      excel.Interactive = XlsInteractive
+    end
+
+    #
+    # initilize creates an ExcelFile instance for a given .xls file.
+    # If the File is already open in excel, data is read from the open file and left open after the call to the close/finalize method.
+    # If the file is not open, It will be opened in the background and closed when the close/finalize method is called.
+    #
+    # For examples look at the end of the file as well as Cucumber/RSpec files
+    #
+    # Information for developers:
+    #   It is helpful to use Win32OLE tracking tool like "oakland ActiveX Inspector"
+    #   to clearly see what Excel instances are beeing created
+    #
+    def initialize(file, debug = false, template = nil)
+      @excelOpen=false
+      @connectedToOpenWorkBook=false
+      @log = Logger.new(STDERR)
+      @log.level = Logger::WARN
+      @log.level = Logger::DEBUG if debug
+
+      if not @@automationInstance
+        ExcelFile.killExcelAutomationProcesses
+      end
+
+      connectToOpenWorkbook = lambda {
+          # open existing file in a traditional way connecting to running Excel instance
+        workbookObj = WIN32OLE.connect(file)
+        @excel = workbookObj.Application
+        @excelOpen = true
+        basename = File.basename(file)
+        @workbook = @excel.Workbooks(basename)
+        @connectedToOpenWorkBook=true
+        @log.info(self.class) { "Attached to open Workbook: #{basename}" }
+      }
+
+      openAutomationInstance = lambda {
+        if not @@automationInstance
+          @@automationInstance = WIN32OLE::new(Excel::APPLICATION_NAME)
+          setSettings @@automationInstance
+          @log.info(self.class) { "Excel Automation Instance Created" }
+        end
+        @excel = @@automationInstance
+      }
+
+      makeFileFromTemplateAndOpen = lambda {
+          # copy the template on place of the file (that's been just moved)
+        openAutomationInstance.call
+        @workbook = @@automationInstance.Workbooks.Add(template)
+        @workbook.SaveAs(file.gsub("/", "\\"), Excel::XlFileFormat::XlWorkbookNormal)
+        @log.info(self.class) { "File: '#{file}' created from template '#{template}'." }
+      }
+
+      openFileInAutomationInstance = lambda {
+          # create isolated Excel and open that workbook/file inside of it
+        openAutomationInstance.call
+        @excelOpen = true
+        begin
+          basename = File.basename(file)
+          @workbook = @excel.Workbooks(basename)
+          @log.info(self.class) { "Attached to open Workbook: '#{basename}'." }
+        rescue
+          if File.exists?(file)
+            @workbook = @excel.Workbooks.Open(file)
+            @log.info(self.class) { "File: '#{file}' opened." }
+          else
+            raise "File: '#{file}' does not exist."
+          end
+        end
+      }
+
+      # check in ROT if workbook is open if so use WIN32OLE::connect(file) otherwise open in isolation
+      rot = WIN32OLE::RunningObjectTable.new
+      if rot.nil? then
+        throw 'Cannot access WIN32OLE::RunningObjectTable'
+      end
+      begin
+        isFileRunning = rot.is_running?(file)
+        if isFileRunning and template
+          connectToOpenWorkbook.call
+
+          # save file, close it and move to backup
+          save
+          sleep 1
+          @workbook.close
+          while rot.is_running?(file) do
+            sleep 1
+          end
+          @excel.quit
+          @excel = nil
+          GC.start
+          FileUtils.moveFileToBackupDir file
+          @log.info(self.class) { "File: #{file} successfully saved, closed and moved to BACKUP folder." }
+
+          makeFileFromTemplateAndOpen.call
+        elsif isFileRunning and not template
+          connectToOpenWorkbook.call
+        elsif not isFileRunning and template
+          makeFileFromTemplateAndOpen.call
+        elsif not isFileRunning and not template
+          openFileInAutomationInstance.call
+        end
+      rescue
+        @log.error(self.class) { "Error attaching: wasFileOpenedByUser: #{@connectedToOpenWorkBook}, file: #{file}, error: #{$!}" }
+        raise
+      end
+
+      @records = {}
+
+      if Excel::LOAD_ALL_CONSTANTS
+        # Get the standard set of Excel constants
+        WIN32OLE.const_load(@excel, ExcelConst) if ExcelConst.constants == []
+      end
+    end
+
+    def self.killExcelAutomationProcesses
+      begin
+        wmi = WIN32OLE.connect("winmgmts://")
+        processes = wmi.ExecQuery("select * from win32_process where commandline like '%excel.exe\"% /automation %'")
+        processes.each do |process|
+          Process.kill('KILL', process.ProcessID)
+        end
+      rescue
+      end
+    end
+
+    # not used
+    # do not work yet
+    def self.killInvisibleExcelProcesses
+      2.times do
+        excelObj = WIN32OLE::connect(Excel::APPLICATION_NAME)
+        if not excelObj.Visible
+          finalize(excelObj)
+        end
+      end
+    end
+
+    def self.finalize()
+      if not @@automationInstance.nil?
+        begin
+          @@automationInstance.Workbooks.each do |wb|
+            begin
+              wb.Close(false)
+            rescue
+            end
+            wb = nil
+          end
+          GC.start
+          sleep(3)
+        rescue
+        end
+        @@automationInstance.quit
+        sleep 1
+        @@automationInstance = nil
+        GC.start
+        sleep(3)
+      end
+    end
+
+
+  end
+
+end