robust_excel_ole 0.3.4 → 0.3.5

data/examples/edit_sheets/example_copying.rb

@@ -0,0 +1,47 @@
+# example_copying.rb:
+# each named cell is to be copied into another sheet
+# unnamed cells shall not be copied
+# if a sheet does not contain any named cell, then the sheet shall not be copied
+
+require 'rubygems'
+#require 'robust_excel_ole'
+require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
+require "fileutils"
+
+include RobustExcelOle
+
+begin
+  dir = "C:/data"
+  workbook_name = 'another_workbook.xls'
+  ws = workbook_name.split(".")
+  base_name = ws[0,ws.length-1].join(".")
+  suffix = ws.last  
+  file_name = dir + "/" + workbook_name
+  extended_file_name = dir + "/" + base_name + "_copied" + "." + suffix
+  FileUtils.copy file_name, extended_file_name 
+
+  Book.unobtrusively(extended_file_name) do |book|  
+    book.extend Enumerable
+    sheet_names = book.map { |sheet| sheet.name }
+    
+    book.each do |sheet|
+      new_sheet = book.add_sheet 
+      contains_named_cells = false
+      sheet.each do |cell|
+        full_name = cell.Name.Name rescue nil
+        if full_name
+          sheet_name, short_name = full_name.split("!") 
+          cell_name = short_name ? short_name : sheet_name
+          contains_named_cells = true
+          new_sheet[cell.Row, cell.Column].Value = cell.Value
+          new_sheet.set_name(cell_name, cell.Row,cell.Column)
+        end
+      end
+      new_sheet.Delete() unless contains_named_cells
+    end
+    
+    sheet_names.each do |sheet_name|
+      book[sheet_name].Delete()
+    end
+  end
+end

data/examples/edit_sheets/example_expanding.rb

@@ -6,52 +6,43 @@
 # in addition to that, the cell B2 shall be named "name" and get the sheet name as its value 
 
 require 'rubygems'
-require 'robust_excel_ole'
+#require 'robust_excel_ole'
+require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
 require "fileutils"
 
 include RobustExcelOle
 
 begin
-  Excel.close_all
   dir = "C:/data"
   workbook_name = 'workbook_named_concat.xls'
-  base_name = workbook_name[0,workbook_name.rindex('.')]
-  suffix = workbook_name[workbook_name.rindex('.')+1,workbook_name.length]
+  ws = workbook_name.split(".")
+  base_name = ws[0,ws.length-1].join(".")
+  suffix = ws.last  
   file_name = dir + "/" + workbook_name
   extended_file_name = dir + "/" + base_name + "_expanded" + "." + suffix
-  book_orig = Book.open(file_name)
-  book_orig.save_as(extended_file_name, :if_exists => :overwrite) 
-  book_orig.close
-  sheet_names = []
+  FileUtils.copy file_name, extended_file_name 
+  
   Book.unobtrusively(extended_file_name) do |book|     
-    book.each do |sheet|
-      sheet_names << sheet.name
-    end
+    book.extend Enumerable
+    sheet_names = book.map { |sheet| sheet.name }
+
     book.Names.each do |excel_name|
       full_name = excel_name.Name
       sheet_name, short_name = full_name.split("!")
       sheet = excel_name.RefersToRange.Worksheet
-      sheet_name = short_name ? short_name : full_name
-      begin
-        sheet_new = book.add_sheet(sheet, :as => sheet_name)
-      rescue ExcelErrorSheet => msg
-        if msg.message == "sheet name already exists" 
-          sheet_new = book.add_sheet(sheet, :as => (sheet_name+sheet.name))
-        else 
-          puts msg.message
-        end
-      end
-      sheet_new.Names.Add("Name" => "name", "RefersTo" => "=" + "$B$2")
-      sheet_new[1,1].Value = sheet_name
+      sheet_name = short_name ? short_name : sheet_name
+      sheet_new = book.add_sheet sheet
       begin
         sheet_new.name = sheet_name
-      rescue
-        sheet_new.name = (sheet_name+sheet.name)
+      rescue ExcelErrorSheet => msg
+        sheet_new.name = sheet_name + sheet.name if msg.message == "sheet name already exists" 
       end
+      sheet_new.set_name("name", 2, 2)
+      sheet_new["name"] = sheet_name   
     end
+    
     sheet_names.each do |sheet_name|
       book[sheet_name].Delete()
     end
   end
-  Excel.close_all
 end

data/examples/edit_sheets/example_naming.rb

@@ -4,29 +4,32 @@
 # the new workbook's name is extended by the suffix "_named"
 
 require 'rubygems'
-require 'robust_excel_ole'
+#require 'robust_excel_ole'
+require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
 require "fileutils"
 
 include RobustExcelOle
 
 begin
-  Excel.close_all
   dir = "C:/data"
   workbook_name = 'workbook.xls'
-  base_name = workbook_name[0,workbook_name.rindex('.')]
-  suffix = workbook_name[workbook_name.rindex('.')+1,workbook_name.length]
+  ws = workbook_name.split(".")
+  base_name = ws[0,ws.length-1].join(".")
+  suffix = ws.last  
+  #base_name = File.basename(workbook_name, ".xls*")
+  #workbook_name =~ /^(.*)\.[^.]$/; base_name = $1
+  #base_name = workbook_name.sub(/^.*(\.[^.])$/; '')
+  #base_name = workbook_name[0,workbook_name.rindex('.')]
+  #suffix = workbook_name[workbook_name.rindex('.')+1,workbook_name.length]
   file_name = dir + "/" + workbook_name
   extended_file_name = dir + "/" + base_name + "_named" + "." + suffix
-  book_orig = Book.open(file_name)
-  book_orig.save_as(extended_file_name, :if_exists => :overwrite) 
-  book_orig.close
+  FileUtils.copy file_name, extended_file_name 
+
   Book.unobtrusively(extended_file_name) do |book|     
     book.each do |sheet|
       sheet.each do |cell_orig|
         contents = cell_orig.Value
-        if contents && contents.class == String
-          sheet.Names.Add("Name" => contents, "RefersTo" => "=" + cell_orig.Address) 
-        end
+        sheet.set_name(contents, cell_orig.Row, cell_orig.Column) if contents && contents.is_a?(String)
       end
     end
   end

data/examples/edit_sheets/example_ranges.rb

@@ -15,8 +15,8 @@ begin
   File.delete simple_save_file rescue nil
   book = Book.open(simple_file)      # open a book
   sheet = book['Sheet1']             # access a sheet via the name
-  row_r = sheet.row_range(0)         # access the whole range of the first row
-  col_r = sheet.col_range(0, 0..1)   # access the first two cells of the range of the first column
+  row_r = sheet.row_range(1)         # access the whole range of the first row
+  col_r = sheet.col_range(1, 1..2)   # access the first two cells of the range of the first column
   cell = col_r[0]                    # access the first cell of these cells 
   puts "row range of 1st row: #{row_r.values}"                     # puts the values of the first row
   puts "1st and 2nd cell of the 1st column : #{col_r.values}"      # and the first two cells of the first column

data/examples/edit_sheets/example_saving.rb

@@ -2,27 +2,25 @@
 # save the sheets of a book as separate workbooks
 
 require 'rubygems'
-require 'robust_excel_ole'
+#require 'robust_excel_ole'
+require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
 require "fileutils"
 
 include RobustExcelOle
 
 begin
-  Excel.close_all
+  
   dir = "C:/data"
-  workbook_name = 'workbook.xls'
-  base_name = workbook_name[0,workbook_name.rindex('.')]
-  suffix = workbook_name[workbook_name.rindex('.')+1,workbook_name.length]
+  workbook_name = 'workbook_named.xls'
+  ws = workbook_name.split(".")
+  base_name = ws[0,ws.length-1].join(".")
+  suffix = ws.last  
   file_name = dir + "/" + workbook_name
+
   Book.unobtrusively(file_name) do |book_orig| 
     book_orig.each do |sheet_orig|
       file_sheet_name = dir + "/" + base_name + "_" + sheet_orig.name + "." + suffix
       Excel.current.generate_workbook(file_sheet_name)
-    end
-  end
-  Book.unobtrusively(file_name) do |book_orig| 
-    book_orig.each do |sheet_orig|
-      file_sheet_name = dir + "/" + base_name + "_" + sheet_orig.name + "." + suffix
       # delete all existing sheets, and add the sheet    
       book = Book.open(file_sheet_name)
       book.add_sheet sheet_orig
@@ -33,12 +31,8 @@ begin
       # alternative: delete all other sheets
       #book = Book.open(file_sheet_name, :force_excel => :new, :visible => true)
       #book.each do |sheet|
-      #  p "sheet.Name: #{sheet.Name}"
       #  book[sheet.Name].Delete() unless sheet.Name == sheet_orig.Name
       #end
-      #sleep 3
-      #book.save_as(file_sheet_name, :if_exists => :overwrite)
-      #book.close
     end
   end
 end

data/examples/open_save_close/example_control_to_excel.rb

@@ -15,7 +15,7 @@ begin
   book.excel.visible = true                   # make current Excel visible 
   sleep 1
   sheet = book[0]                                                        # access a sheet
-  sheet[0,0] = sheet[0,0].Value == "simple" ? "complex" : "simple"       # change a cell
+  sheet[1,1] = sheet[1,1].Value == "simple" ? "complex" : "simple"       # change a cell
   sleep 1
   begin
     new_book = Book.open(file_name, :if_unsaved => :alert) # open another book with the same file name 

data/examples/open_save_close/example_if_obstructed_closeifsaved.rb

@@ -15,8 +15,8 @@ begin
   book = Book.open(file_name, :visible => true)  # open a book, make Excel visible
   sleep 1
   sheet = book[0]
-  first_cell = sheet[0,0].Value                                   # access a sheet
-  sheet[0,0] = first_cell == "simple" ? "complex" : "simple"      # change a cell
+  first_cell = sheet[1,1].Value                                   # access a sheet
+  sheet[1,1] = first_cell == "simple" ? "complex" : "simple"      # change a cell
   sleep 1
   begin
     new_book = Book.open(other_file_name, :if_obstructed => :close_if_saved) # raises an exception since the file is not saved
@@ -27,7 +27,7 @@ begin
   new_book = Book.open(file_name, :if_obstructed => :close_if_saved)  # open the new book, close the saved book    
   sleep 1
   new_sheet = new_book[0]
-  new_first_cell = new_sheet[0,0].Value
+  new_first_cell = new_sheet[1,1].Value
   puts "the old book was saved" unless new_first_cell == first_cell 
   new_book.close                                 # close the books                  
 ensure

data/examples/open_save_close/example_if_obstructed_save.rb

@@ -15,15 +15,15 @@ begin
   book = Book.open(file_name, :visible => true)  # open a book, make Excel visible
   sleep 1
   sheet = book[0]
-  first_cell = sheet[0,0].value                                   # access a sheet
-  sheet[0,0] = first_cell == "simple" ? "complex" : "simple"      # change a cell
+  first_cell = sheet[1,1].value                                   # access a sheet
+  sheet[1,1] = first_cell == "simple" ? "complex" : "simple"      # change a cell
   sleep 1
   new_book = Book.open(other_file_name, :if_obstructed => :save)  # open a book with the same file name in a different path
   sleep 1                                                         #save the old book, close it, before
   old_book = Book.open(file_name, :if_obstructed => :forget ,:visible => true) # open the old book    
   sleep 1
   old_sheet = old_book[0]
-  old_first_cell = old_sheet[0,0].value
+  old_first_cell = old_sheet[1,1].value
   puts "the old book was saved" unless old_first_cell == first_cell 
   new_book.close                                 # close the books                      
   old_book.close

data/examples/open_save_close/example_if_unsaved_accept.rb

@@ -13,7 +13,7 @@ begin
   file_name = dir + 'workbook.xls' 
   book = Book.open(file_name)                      # open a book 
   sheet = book[0]                                                  # access a sheet
-  sheet[0,0] = sheet[0,0].value == "simple" ? "complex" : "simple" # change a cell
+  sheet[1,1] = sheet[1,1].value == "simple" ? "complex" : "simple" # change a cell
   begin
     new_book = Book.open(file_name)                # open another book with the same file name
   rescue ExcelErrorOpen => msg                     # by default: raises an exception:

data/examples/open_save_close/example_if_unsaved_forget.rb

@@ -15,17 +15,17 @@ begin
   book.excel.visible = true                        # make current Excel visible 
   sleep 1
   sheet = book[0]                                            # access a sheet
-  first_cell = sheet[0,0].value
-  sheet[0,0] = first_cell == "simple" ? "complex" : "simple" # change a cell
+  first_cell = sheet[1,1].value
+  sheet[1,1] = first_cell == "simple" ? "complex" : "simple" # change a cell
   sleep 1
   new_book = Book.open(file_name, :if_unsaved => :forget) # open another book with the same file name 
                                                           # and close the unsaved book without saving it
   sheet_new_book = new_book[0]
-  if (not book.alive?) && new_book.alive? && sheet_new_book[0,0].value == first_cell then # check whether the unsaved book 
+  if (not book.alive?) && new_book.alive? && sheet_new_book[1,1].value == first_cell then # check whether the unsaved book 
     puts "open with :if_unsaved => :forget : the unsaved book is closed and not saved."     # is closed and was not saved
   end
   sleep 1
-  sheet_new_book[0,0] = sheet_new_book[0,0].value == "simple" ? "complex" : "simple" # change a cell
+  sheet_new_book[1,1] = sheet_new_book[1,1].value == "simple" ? "complex" : "simple" # change a cell
   # open another book in a new Excel application, and make Excel visible, leaving the unsaved book open
   another_book = Book.open(file_name, :if_unsaved => :new_excel, :visible => true)  
   sleep 3                                                                  # leaving the unsaved book open  

data/examples/open_save_close/example_if_unsaved_forget_more.rb

@@ -15,21 +15,21 @@ begin
   book.excel.visible = true                        # make current Excel visible 
   sleep
   sheet = book[0]                                            # access a sheet
-  first_cell = sheet[0,0].value
-  sheet[0,0] = first_cell == "simple" ? "complex" : "simple" # change a cell
+  first_cell = sheet[1,1].value
+  sheet[1,1] = first_cell == "simple" ? "complex" : "simple" # change a cell
   sleep 1
   new_book = Book.open(file_name, :if_unsaved => :new_excel, :visible => true) # open another book with the same file name in a new Excel
   sheet_new_book = new_book[0]
-  if (not book.alive?) && new_book.alive? && sheet_new_book[0,0].value == first_cell then # check whether the unsaved book 
+  if (not book.alive?) && new_book.alive? && sheet_new_book[1,1].value == first_cell then # check whether the unsaved book 
     puts "open with :if_unsaved => :forget : the unsaved book is closed and not saved."     # is closed and was not saved
   end
   sleep 1
-  sheet_new_book[0,0] = sheet_new_book[0,0].value == "simple" ? "complex" : "simple" # change a cell
+  sheet_new_book[1,1] = sheet_new_book[1,1].value == "simple" ? "complex" : "simple" # change a cell
   # open another book in the running Excel application, and make Excel visible, closing the unsaved book
   another_book = Book.open(file_name, :if_unsaved => :forget, :visible => true)  
   sleep 1
   sheet_another_book = another_book[0]
-  sheet_another_book[0,0] = sheet_another_book[0,0].value == "simple" ? "complex" : "simple" # change a cell                                                                   
+  sheet_another_book[1,1] = sheet_another_book[1,1].value == "simple" ? "complex" : "simple" # change a cell                                                                   
   another_book.close(:if_unsaved => :forget )           # close the last book without saving it.                      
   book.close(:if_unsaved => :save)                      # close the first book and save it before
 ensure

data/examples/open_save_close/example_read_only.rb

@@ -14,7 +14,7 @@ begin
   book = Book.open(file_name, :read_only => true, :visible => true) # open a book with read_only and make Excel visible
   sheet = book[0]                                     			        # access a sheet
   sleep 1     
-  sheet[0,0] = sheet[0,0].value == "simple" ? "complex" : "simple" # change a cell
+  sheet[1,1] = sheet[1,1].value == "simple" ? "complex" : "simple" # change a cell
   sleep 1
   begin
     book.save                                         # simple save. 

data/examples/open_save_close/example_rename_cells.rb

@@ -14,12 +14,10 @@ begin
   book = Book.open(file_name)                                # open a book.  default:  :read_only => false
   book.excel.visible = true                                          # make current Excel visible
   sheet = book[0]
-  #sheet.Names.Add("Wert","$A$1"
-
   workbook = book.workbook
   fullname = workbook.Fullname
   puts "fullname: #{fullname}"  
-  workbook.Names.Add("a_name", "=$A$1")   # rename cell A1 to "a_name"
+  sheet.add_name(1,1,"a_name")   # rename cell A1 to "a_name"
   number = workbook.Names.Count
   puts "number of name objects :#{number}"
   name_object = workbook.Names("a_name")
@@ -48,17 +46,7 @@ begin
   new_name_object.Visible = false
   puts "visible: #{new_name_object.Visible}"
   sleep 2
-
-  # to do:
-  # read, write contents of the cell (under the old name)
-  # read, write contents in the cell under the new name
-
-  #sheet.Cells
-  # sheet[0,0].value
-  # Worksheets("sheet1").Cells
-
   new_name_object.Delete
-
   sleep 2
   book.close(:if_unsaved => :forget)                        # close the book
 

data/examples/open_save_close/example_simple.rb

@@ -16,7 +16,7 @@ begin
   book.excel.visible = true                                  # make current Excel visible
   sheet = book[0]                                            # access a sheet
   sleep 1     
-  sheet[0,0] = sheet[0,0].value == "simple" ? "complex" : "simple"  # change a cell
+  sheet[1,1] = sheet[1,1].value == "simple" ? "complex" : "simple"  # change a cell
   sleep 1
   book.save                                                  # simple save
   begin

data/examples/open_save_close/example_unobtrusively.rb

@@ -12,14 +12,14 @@ begin
   simple_file = dir + 'workbook.xls'
   book = Book.open(simple_file, :visible => true)  # open a book, make Excel visible
   old_sheet = book[0]
-  p "1st cell: #{old_sheet[0,0].value}"
+  p "1st cell: #{old_sheet[1,1].value}"
   sleep 2
   Book.unobtrusively(simple_file) do |book|   # modify the book and keep its status unchanged
     sheet = book[0]
-    sheet[0,0] = sheet[0,0].value == "simple" ? "complex" : "simple"
+    sheet[1,1] = sheet[1,1].value == "simple" ? "complex" : "simple"
   end
   new_sheet = book[0]
-  p "1st cell: #{new_sheet[0,0].value}"
+  p "1st cell: #{new_sheet[1,1].value}"
   p "book saved" if book.Saved
   book.close                                 # close the book                      
 ensure

data/lib/robust_excel_ole.rb

@@ -1,6 +1,6 @@
 require "win32ole"
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/excel')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/book_store')
+require File.join(File.dirname(__FILE__), 'robust_excel_ole/bookstore')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/book')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/sheet')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/cell')
@@ -9,6 +9,8 @@ require File.join(File.dirname(__FILE__), 'robust_excel_ole/cygwin') if RUBY_PLA
 #+#require "robust_excel_ole/version"
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/version')
 
+REO = RobustExcelOle
+
 module RobustExcelOle
 
   def absolute_path(file)
@@ -24,8 +26,85 @@ module RobustExcelOle
 
   module_function :absolute_path, :canonize
 
-
   class VBAMethodMissingError < RuntimeError  # :nodoc: #
   end
 
 end
+
+class Object
+  def excel
+    raise ExcelErrorOpen, "provided instance is neither an Excel nor a Book"
+  end
+
+end
+
+class ::String
+  def / path_part
+    if empty?
+      path_part
+    else
+      begin 
+        File.join self, path_part
+      rescue TypeError
+        raise "Only strings can be parts of paths (given: #{path_part.inspect} of class #{path_part.class})"
+      end
+    end
+  end
+
+  # taken from http://apidock.com/rails/ActiveSupport/Inflector/underscore
+  def underscore
+    word = gsub('::', '/')
+    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
+  end
+
+  # taken from http://apidock.com/rails/ActiveSupport/Inflector/constantize
+  # File activesupport/lib/active_support/inflector/methods.rb, line 226
+  def constantize #(camel_cased_word)
+    names = self.split('::')
+
+    # Trigger a builtin NameError exception including the ill-formed constant in the message.
+    Object.const_get(self) if names.empty?
+
+    # Remove the first blank element in case of '::ClassName' notation.
+    names.shift if names.size > 1 && names.first.empty?
+
+    names.inject(Object) do |constant, name|
+      if constant == Object
+        constant.const_get(name)
+      else
+        candidate = constant.const_get(name)
+        next candidate if constant.const_defined?(name)
+        next candidate unless Object.const_defined?(name)
+
+        # Go down the ancestors to check it it's owned
+        # directly before we reach Object or the end of ancestors.
+        constant = constant.ancestors.inject do |const, ancestor|
+          break const    if ancestor == Object
+          break ancestor if ancestor.const_defined?(name)
+          const
+        end
+
+        # owner is in Object, so raise
+        constant.const_get(name)
+      end
+    end
+  end
+end
+
+# taken from http://api.rubyonrails.org/v2.3.8/classes/ActiveSupport/CoreExtensions/Module.html#M000806
+class Module
+  def parent_name
+    unless defined? @parent_name
+      @parent_name = name =~ /::[^:]+\Z/ ? $`.freeze : nil
+    end
+    @parent_name
+  end
+  def parent
+    parent_name ? parent_name.constantize : Object
+  end
+end
+