winexcel 0.0.1

data/lib/winexcel/excel_file/write_2D_array.rb

@@ -0,0 +1,169 @@
+# 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'
+
+module WinExcel
+
+  class ExcelFile
+
+    #writes out the 2D Array *data* starting at the specified range *myRange* on the specified sheet
+    def write2DArray(data, myRange, sheet = nil)
+      @log.info("write2DArray(data='...',myRange='#{myRange}', sheet = '#{sheet})'")
+      worksheet = getWorksheet(sheet)
+      #get the actual excel range object
+      myRange = worksheet.Range(myRange)
+
+      # first check if there is any color information in the data
+      isAdditionalInfo = false
+      (0..data.length-1).each do |row|
+        (0..data[row].length-1).each do |col|
+          colorIdx = -1
+          colorLen = -1
+          begin
+            if /\A<<COLOUR=([A-Z]+)>>/.match(data[row][col])
+              colorLen = /\A<<COLOUR=([A-Z]+)>>/.match(data[row][col])[1].length
+              case /\A<<COLOUR=([A-Z]+)>>/.match(data[row][col])[1]
+                when 'BLACK'
+                  colorIdx = 1
+                when 'RED'
+                  colorIdx = 3
+                when 'YELLOW'
+                  colorIdx = 6
+                when 'GREEN'
+                  colorIdx = 10
+              end
+            end
+            if colorIdx > -1 or data[row][col] =~ /^=HYPERLINK/
+              isAdditionalInfo = true
+              break
+            end
+          rescue
+          end
+        end
+        if isAdditionalInfo == true
+          break
+        end
+      end
+
+      if not isAdditionalInfo
+        # find maximum row length (or column quantity) for the 'data' array,
+        # it would be column quantity of 2D array if we would put the 'data' array into one
+        maxWidth = 0
+        maxCellLength = 0
+        data.each do |row|
+          maxWidth = row.length if maxWidth < row.length
+          row.each do |cell|
+            maxCellLength = cell.to_s.length if cell and maxCellLength < cell.to_s.length
+          end
+        end
+        data.collect do |row|
+          while row.length < maxWidth
+            if not row.kind_of? Array
+              row = []
+            end
+            row << ''
+          end
+        end
+        if maxCellLength < 8204
+          myRange.Resize(data.length, maxWidth).Value = data if data and data.length > 0
+        else
+          (0..data.length-1).each do |row|
+            (0..data[row].length-1).each do |col|
+              myRange.Offset(row, col).value = data[row][col]
+            end
+          end
+        end
+      else
+        (0..data.length-1).each do |row|
+          (0..data[row].length-1).each do |col|
+            #puts data[row][col]
+
+            colorIdx = -1
+            colorLen = -1
+            begin
+              if /\A<<COLOUR=([A-Z]+)>>/.match(data[row][col])
+                colorLen = /\A<<COLOUR=([A-Z]+)>>/.match(data[row][col])[1].length
+                case /\A<<COLOUR=([A-Z]+)>>/.match(data[row][col])[1]
+                  when 'BLACK'
+                    colorIdx = 1
+                  when 'RED'
+                    colorIdx = 3
+                  when 'YELLOW'
+                    colorIdx = 6
+                  when 'GREEN'
+                    colorIdx = 10
+                end
+              end
+            rescue
+            end
+
+            #TODO: Excel bottleneck - it needs some deley here
+            #sleep(0.1)
+
+            val = ''
+            if colorIdx > -1 then
+              myRange.Offset(row, col).Interior.ColorIndex = colorIdx
+              beg = '<<COLOUR=>>'.length + colorLen
+              val = data[row][col][beg..data[row][col].length]
+            else
+              val = data[row][col]
+            end
+
+            begin
+              myRange.Offset(row, col).value = val
+            rescue
+              if val =~ /^=HYPERLINK/
+                if val[',']
+                  val.gsub!(',', ';')
+                elsif val[';']
+                  val.gsub!(';', ',')
+                end
+
+                myRange.Offset(row, col).value = val
+              end
+            end
+
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/winexcel/fileutils_ext/backup_file.rb

@@ -0,0 +1,25 @@
+require 'fileutils'
+
+module FileUtils
+
+  def self.moveFileToBackupDir(sourceFile, backupDir=nil)
+    fileDir = File.dirname(sourceFile)
+    fileName = File.basename(sourceFile)
+    backupDir = fileDir + '/BACKUP/' if not backupDir
+    targetFileName = fileName
+    targetFile = ''
+    i = 0
+    begin
+      targetFile = backupDir + targetFileName
+      raise if File.exist?(targetFile)
+    rescue
+      i = i + 1
+      targetFileName = fileName[0..fileName.length-File.extname(fileName).length-1] + "_#{i}" + File.extname(fileName)
+      retry
+    end
+    createDirIfMissing File.dirname(targetFile)
+    FileUtils.mv(sourceFile, targetFile)
+  end
+
+end
+

data/lib/winexcel/fileutils_ext/create_dir_if_missing.rb

@@ -0,0 +1,18 @@
+require 'fileutils'
+
+module FileUtils
+
+# recursively create directories of a path given as argument
+# accepts absolute paths as well as relative ones
+#
+  def self.createDirIfMissing(dir)
+    if dir.unempty?
+      unless File.directory?(dir)
+        createDirIfMissing(File.dirname(dir))
+        Dir.mkdir(dir)
+      end
+    end
+  end
+
+end
+

data/lib/winexcel/version.rb

@@ -0,0 +1,3 @@
+module WinExcel
+  VERSION = "0.0.1"
+end

data/tasks/cucumber.rake

@@ -0,0 +1,23 @@
+begin
+  namespace :cucumber do
+    require 'cucumber/rake/task'
+    Cucumber::Rake::Task.new(:wip, 'Run features that are being worked on') do |t|
+      t.cucumber_opts = "--tags @wip"
+    end
+    Cucumber::Rake::Task.new(:ok, 'Run features that should be working') do |t|
+      t.cucumber_opts = "--tags ~@wip"
+    end
+    task :all => [:ok, :wip]
+  end
+
+  desc 'Alias for cucumber:ok'
+  task :cucumber => 'cucumber:ok'
+rescue LoadError
+  task :cucumber do
+    abort "Cucumber is not available. In order to run features, you must: gem install cucumber"
+  end
+end
+
+desc 'Alias for cucumber'
+task :features => 'cucumber'
+

data/tasks/rspec.rake

@@ -0,0 +1,9 @@
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  task :spec do
+    abort "RSpec is not available. In order to run spec, you must: gem install rspec"
+  end
+end
+

data/winexcel.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "winexcel/version"
+
+Gem::Specification.new do |s|
+  s.name        = "winexcel"
+  s.version     = WinExcel::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kamil Sobieraj"]
+  s.email       = ["ksob@rubyforge.org"]
+  s.homepage    = ""
+  s.summary     = %q{Access MS Excel from Ruby via Excel COM/Win32OLE interface}
+  s.description = %q{Makes it possible to access MS Excel from Ruby via Excel COM/Win32OLE interface. Enables to read and write from/to Excel files with the use of Excel's API. Requires MS Excel application to be installed.}
+
+  s.rubyforge_project = "winexcel"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency('win32olerot')
+  s.add_development_dependency("rake", ["~> 0.8.7"])
+  s.add_development_dependency("cucumber", ["~> 0.10.2"])
+  s.add_development_dependency("rspec", ["~> 2.5.0"])
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification 
+name: winexcel
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kamil Sobieraj
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-05 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: win32olerot
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 10
+        - 2
+        version: 0.10.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id004
+description: Makes it possible to access MS Excel from Ruby via Excel COM/Win32OLE interface. Enables to read and write from/to Excel files with the use of Excel's API. Requires MS Excel application to be installed.
+email: 
+- ksob@rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- examples/basic.rb
+- examples/extended.rb
+- examples/fixtures/a.xls
+- examples/fixtures/b.xlsx
+- examples/fixtures/template.xls
+- examples/my_basic_file.xls
+- examples/my_extended_file.xls
+- features/connect_to_open_excel_file.feature
+- features/create_excel_file_from_template_and_open.feature
+- features/fixtures/a.xls
+- features/fixtures/b.xlsx
+- features/open_excel_file.feature
+- features/step_definitions/excel_file_steps.rb
+- features/support/common.rb
+- features/support/env.rb
+- features/support/matchers.rb
+- lib/winexcel.rb
+- lib/winexcel/core_ext/object.rb
+- lib/winexcel/core_ext/ordered_hash.rb
+- lib/winexcel/excel/xl_file_format.rb
+- lib/winexcel/excel_file.rb
+- lib/winexcel/excel_file/common_methods.rb
+- lib/winexcel/excel_file/other_methods.rb
+- lib/winexcel/excel_file/write_2D_array.rb
+- lib/winexcel/fileutils_ext/backup_file.rb
+- lib/winexcel/fileutils_ext/create_dir_if_missing.rb
+- lib/winexcel/version.rb
+- lib/winexcel/win32olerot_ext/win32olerot.so
+- tasks/cucumber.rake
+- tasks/rspec.rake
+- winexcel.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: winexcel
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Access MS Excel from Ruby via Excel COM/Win32OLE interface
+test_files: []
+