robust_excel_ole 0.2.0.8 → 0.2.1

data/examples/print_cells/example_print_cells.rb

@@ -0,0 +1,43 @@
+# example 1: open a book, print the cells, rows, and columns of a sheet
+
+require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
+
+require File.join(File.dirname(__FILE__), '../../spec/spec_helper')
+
+require "fileutils"
+
+include RobustExcelOle
+
+ExcelApp.close_all
+begin
+  #dir = 'C:/'
+  dir = create_tmpdir
+  simple_file = dir + 'simple.xls'
+  simple_save_file = dir + 'simple_save.xls'
+  File.delete simple_save_file rescue nil
+  book = Book.open(simple_file)
+  sheet = book[0]
+  cell = sheet[0,0]
+  i = 0
+  sheet.each do |cell|
+  	i = i + 1
+  	puts "#{i}. cell: #{cell.value}"
+  end
+  i = 0
+  sheet.each_row do |row|
+  	i = i + 1
+  	puts "#{i}. row: #{row.value}"
+  end
+  i = 0
+  sheet.each_column do |column|
+  i = i + 1
+  	puts "#{i}. column: #{column.value}"
+  end
+  sheet[0,0] = "complex"
+  book.save
+  book.close
+ensure
+  ExcelApp.close_all
+end
+
+  

data/examples/save_sheets/example_save_sheets.rb

@@ -0,0 +1,30 @@
+# example 11: save the sheets of a book as separate books
+
+require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
+
+require "fileutils"
+
+include RobustExcelOle
+
+ExcelApp.close_all
+begin
+  dir = 'C:/'
+  file_name = dir + 'book_with_blank.xls'
+  book = Book.open(file_name)                   # open a book
+  ExcelApp.reuse.Visible = true     # make Excel visible 
+  # 1. Bücher erstmal speichern, um sie öffnen zu können
+  i = 0
+  book.each do |sheet|
+    i = i + 1
+    puts "#{i}. sheet:"
+    file_name_sheet = file_name + "_sheet#{i}.xls"
+    puts "file_name_sheet: #{file_name_sheet}"
+    book.save_as(file_name_sheet) 
+  end
+  # generate empty book
+  # book_sheet = ExcelApp.Workbooks.Add
+  
+ ensure                                                              
+  ExcelApp.close_all                              # close workbooks, quit Excel application
+ end
+

data/lib/robust_excel_ole/book.rb

@@ -12,23 +12,24 @@ module RobustExcelOle
       # opens a book.
       # 
       # options: 
-      #  :reuse         (boolean)  use an already open Excel-application (default: true)
-      #  :read_only     (boolean)  open in read-only mode                (default: false)
-      #  :displayalerts (boolean)  allow display alerts in Excel         (default: false)
-      #  :visible       (boolean)  make visibe in Excel                  (default: false)
+      #  :read_only     open in read-only mode          (default: false)
       #  :if_unsaved    if an unsaved book with the same name is open, then
-      #                 :raise   -> raise an exception                   (default)
+      #                 :raise   -> raise an exception (default)
       #                 :forget  -> close the unsaved book, open the new book             
       #                 :accept  -> let the unsaved book open                  
       #                 :excel   -> give control to excel
       #                 :new_app -> open the new book in a new excel application
-      #  :if_blocking_other   if a book with the same name in a different path is open, then
-      #                  :raise   -> raise an exception                  (default)             
-      #                  :forget  -> close the old book, open the new book
-      #                  :save_and_close -> save the old book, close it, open the new book
-      #                  :close_or_raise -> close the old book and open the new book, if the old book is saved
-      #                                     raise an exception otherwise
-      #                  :new_app -> open the new book in a new excel application
+      #  :if_obstructed   if a book with the same name in a different path is open, then
+      #                  :raise          -> raise an exception (default)             
+      #                  :forget         -> close the old book, open the new book
+      #                  :save           -> save the old book, close it, open the new book
+      #                  :close_if_saved -> close the old book and open the new book, if the old book is saved
+      #                                       raise an exception otherwise
+      #                  :new_app        -> open the new book in a new excel application
+      #  :reuse         use a running Excel-application (default: true)
+      #  :excel_app     an Excel application            (default: nil) 
+      #  :displayalerts allow display alerts in Excel   (default: false)
+      #  :visible       make visibe in Excel            (default: false)
       def open(file, options={ :reuse => true}, &block)
         new(file, options, &block)
       end
@@ -38,31 +39,33 @@ module RobustExcelOle
     def initialize(file, opts={ }, &block)
       @options = {
         :reuse => true,
+        :excel_app => nil,
         :read_only => false,
         :if_unsaved => :raise,
-        :if_blocking_other => :raise
+        :if_obstructed => :raise
       }.merge(opts)
       excel_app_options = {:reuse => true}.merge(opts).delete_if{|k,v| 
-        k== :read_only || k== :if_unsaved || k == :if_blocking_other}
+        k== :read_only || k== :if_unsaved || k == :if_obstructed}
       if not File.exist?(file)
         raise ExcelErrorOpen, "file #{file} not found"
       end
-      @excel_app = ExcelApp.new(excel_app_options)     # :nodoc:
+      @excel_app = @options[:excel_app] ? @options[:excel_app] : ExcelApp.new(excel_app_options)  
       workbooks = @excel_app.Workbooks
       @workbook = workbooks.Item(File.basename(file)) rescue nil
       if @workbook then
-        blocked_by_other_book = (File.basename(file) == File.basename(@workbook.Fullname)) && 
-                                (not (absolute_path(file) == @workbook.Fullname))
-        if blocked_by_other_book then
-          case @options[:if_blocking_other]
+        obstructed_by_other_book = (File.basename(file) == File.basename(@workbook.Fullname)) && 
+                                   (not (absolute_path(file) == @workbook.Fullname))
+        if obstructed_by_other_book then
+          # @workbook is not the desired workbook
+          case @options[:if_obstructed]
           when :raise
             raise ExcelErrorOpen, "blocked by a book with the same name in a different path"
           when :forget
             @workbook.Close
-          when :save_and_close
+          when :save
             save unless @workbook.Saved
             @workbook.Close
-          when :close_or_raise
+          when :close_if_saved
             if (not @workbook.Saved) then
               raise ExcelErrorOpen, "book with the same name in a different path is unsaved"
             else 
@@ -73,10 +76,10 @@ module RobustExcelOle
             @excel_app = ExcelApp.new(excel_app_options)
             @workbook = nil
           else
-            raise ExcelErrorOpen, ":if_blocking_other: invalid option"
+            raise ExcelErrorOpen, ":if_obstructed: invalid option"
           end
         else
-          # book open, not saved, not blocked by other book
+          # book open, not saved, not obstructed by an other book
           if (not @workbook.Saved) then
             #p "book not saved"
             case @options[:if_unsaved]
@@ -221,13 +224,19 @@ module RobustExcelOle
         case opts[:if_exists]
         when :overwrite
           # if a book is open with the name of file, then raise error
-          open_workbook = ExcelApp.reuse_if_possible.Workbooks(basename) rescue nil
-          #workbook_file = @excel_app.Workbooks(basename) rescue nil
-          if open_workbook == nil then
+          # bräuchte alle Excel-Applikationen.
+          # mit ExcelApp.reuse bzw. running_app bzw. connect bekomme ich nur die 1. Excel-Applikation
+          #open_workbook = ExcelApp.reuse.Workbooks(basename) rescue nil
+          begin
             File.delete(file) 
-          else
+          rescue 
             raise ExcelErrorSave, "book is open and used in Excel"
           end
+          #if open_workbook == nil then
+          #  File.delete(file) 
+          #else
+          #  raise ExcelErrorSave, "book is open and used in Excel"
+          #end
         when :excel 
           old_displayalerts = @excel_app.DisplayAlerts  # :nodoc:
           @excel_app.DisplayAlerts = true  # :nodoc:

data/lib/robust_excel_ole/excel_app.rb

@@ -46,6 +46,7 @@ module RobustExcelOle
       Process.kill("KILL", pid)
     end
 
+    # frees all OLE objects in the object space
     def self.free_all_ole_objects
       anz_objekte = 0
       ObjectSpace.each_object(WIN32OLE) do |o|
@@ -96,24 +97,23 @@ module RobustExcelOle
       new(:reuse => false)
     end
 
-    # uses a running Excel application, if such an application exists
+    # uses a running Excel application (connects), if such an Excel application exists
     # creates a new one, otherwise 
-    def self.reuse_if_possible
+    def self.reuse
       new(:reuse => true)
     end
 
     # returns an Excel application  
-    #
     # options:
-    #  :reuse         (boolean)  use an already running Excel application  (default: true)
-    #  :displayalerts (boolean)  allow display alerts in Excel             (default: false)
-    #  :visible       (boolean)  make visible in Excel                     (default: false)
+    #  :reuse          use an already running Excel application (default: true)
+    #  :displayalerts  allow display alerts in Excel            (default: false)
+    #  :visible        make visible in Excel                    (default: false)
     def self.new(options= {})
       options = {:reuse => true}.merge(options)
 
       ole_app = nil
       if options[:reuse] then
-        ole_app = running_app
+        ole_app = options[:excel_app] ? options[:excel_app] : running_app
         if ole_app
           ole_app.DisplayAlerts = options[:displayalerts] unless options[:displayalerts]==nil
           ole_app.Visible = options[:visible] unless options[:visible]==nil

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "0.2.0.8"
+  VERSION = "0.2.1"
 end

data/robust_excel_ole.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "wdm", '>= 0.0.3'
   s.add_development_dependency "win32console", '>= 1.3.2'
   s.add_development_dependency "guard-rspec", '>= 2.1.1'
+  s.required_ruby_version = '>= 1.8.6'
 end

data/spec/book_spec.rb

@@ -65,7 +65,7 @@ describe RobustExcelOle::Book do
       end
     end
 
-    context "with excel_app" do
+    context "with attr_reader excel_app" do
       before do
         @new_book = RobustExcelOle::Book.open(@simple_file)
       end
@@ -79,6 +79,29 @@ describe RobustExcelOle::Book do
       end
     end
 
+    context "with :excel_app" do
+      it "should reuse the given excel application of the book" do
+        book1 = RobustExcelOle::Book.open(@simple_file, :reuse => false)
+        excel_app1 = book1.excel_app
+        book2 = RobustExcelOle::Book.open(@simple_file, :reuse => false)
+        excel_app2 = book2.excel_app
+        excel_app2.should_not == excel_app1
+        book3 = RobustExcelOle::Book.open(@simple_file)
+        excel_app3 = book3.excel_app
+        book4 = RobustExcelOle::Book.open(@simple_file, :excel_app => excel_app2)
+        excel_app4 = book4.excel_app
+        excel_app3.should == excel_app1
+        excel_app4.should == excel_app2
+        excel_app4.class.should == RobustExcelOle::ExcelApp
+        excel_app4.should be_a RobustExcelOle::ExcelApp
+        book1.close
+        book2.close
+        book3.close
+        book4.close
+      end
+    end
+
+
     context "with :read_only" do
       it "should be able to save, if :read_only => false" do
         book = RobustExcelOle::Book.open(@simple_file, :read_only => false)
@@ -186,7 +209,7 @@ describe RobustExcelOle::Book do
             }.to_not raise_error
           @book.should be_alive
           @new_book.should be_alive
-          @new_book.filename.should == @book.filename
+          @new_book.should == @book
         end
 
         it "should open book and close old book, if :if_unsaved is :forget" do
@@ -267,62 +290,62 @@ describe RobustExcelOle::Book do
         @new_book.close rescue nil
       end
 
-      it "should raise an error, if :if_blocking_other is :raise" do
+      it "should raise an error, if :if_obstructed is :raise" do
         expect {
-          @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :raise)
+          @new_book = RobustExcelOle::Book.open(@simple_file, :if_obstructed => :raise)
         }.to raise_error(ExcelErrorOpen, "blocked by a book with the same name in a different path")
       end
 
-      it "should close the other book and open the new book, if :if_blocking_other is :forget" do
-        @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :forget)
+      it "should close the other book and open the new book, if :if_obstructed is :forget" do
+        @new_book = RobustExcelOle::Book.open(@simple_file, :if_obstructed => :forget)
         @book.should_not be_alive
         @new_book.should be_alive
         @new_book.filename.downcase.should == @simple_file.downcase
       end
 
-      it "should save the old book, close it, and open the new book, if :if_blocking_other is :save_and_close" do
-        @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :save_and_close)
+      it "should save the old book, close it, and open the new book, if :if_obstructed is :save" do
+        @new_book = RobustExcelOle::Book.open(@simple_file, :if_obstructed => :save)
         @book.should_not be_alive
         @new_book.should be_alive
         @new_book.filename.downcase.should == @simple_file.downcase
-        new_book = RobustExcelOle::Book.open(@simple_file)
-        new_book.workbook.Worksheets.Count.should ==  @sheet_count
-        new_book.close
+        old_book = RobustExcelOle::Book.open(@simple_file_other_path, :if_obstructed => :forget)
+        old_book.workbook.Worksheets.Count.should ==  @sheet_count + 1
+        old_book.close
       end
 
       it "should raise an error, if the old book is unsaved, and close the old book and open the new book, 
-          if :if_blocking_other is :close_or_raise" do
+          if :if_obstructed is :close_if_saved" do
         expect{
-          @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :close_or_raise)
+          @new_book = RobustExcelOle::Book.open(@simple_file, :if_obstructed => :close_if_saved)
         }.to raise_error(ExcelErrorOpen, "book with the same name in a different path is unsaved")
         @book.save
-        @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :close_or_raise)
+        @new_book = RobustExcelOle::Book.open(@simple_file, :if_obstructed => :close_if_saved)
         @book.should_not be_alive
         @new_book.should be_alive
         @new_book.filename.downcase.should == @simple_file.downcase
-        new_book = RobustExcelOle::Book.open(@simple_file_other_path, :if_blocking_other => :forget)
-        new_book.workbook.Worksheets.Count.should ==  @sheet_count + 1
-        new_book.close
+        old_book = RobustExcelOle::Book.open(@simple_file_other_path, :if_obstructed => :forget)
+        old_book.workbook.Worksheets.Count.should ==  @sheet_count + 1
+        old_book.close
       end
 
-      it "should open the book in a new excel application, if :if_blocking_other is :new_app" do
-        @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :new_app)
+      it "should open the book in a new excel application, if :if_obstructed is :new_app" do
+        @new_book = RobustExcelOle::Book.open(@simple_file, :if_obstructed => :new_app)
         @book.should be_alive
         @new_book.should be_alive
         @new_book.filename.should_not == @book.filename
         @new_book.excel_app.should_not == @book.excel_app
       end
 
-      it "should raise an error, if :if_blocking_other is default" do
+      it "should raise an error, if :if_obstructed is default" do
         expect {
           @new_book = RobustExcelOle::Book.open(@simple_file)
         }.to raise_error(ExcelErrorOpen, "blocked by a book with the same name in a different path")
       end
 
-      it "should raise an error, if :if_blocking_other is invalid option" do
+      it "should raise an error, if :if_obstructed is invalid option" do
         expect {
-          @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :invalid_option)
-        }.to raise_error(ExcelErrorOpen, ":if_blocking_other: invalid option")
+          @new_book = RobustExcelOle::Book.open(@simple_file, :if_obstructed => :invalid_option)
+        }.to raise_error(ExcelErrorOpen, ":if_obstructed: invalid option")
       end
 
     end

data/spec/excel_app_spec.rb

@@ -7,16 +7,6 @@ $VERBOSE = nil
 module RobustExcelOle
 
   describe ExcelApp do
-    before do
-      @dir = create_tmpdir
-      @simple_file = @dir + '/simple.xls'
-    end
-
-    after do
-      rm_tmp(@dir)
-    end
-
-    save_path = "C:" + "/" + "simple_save.xls"
 
     context "app creation" do
       after do
@@ -68,7 +58,7 @@ module RobustExcelOle
       end
 
       it "should reuse existing app" do
-        app2 = ExcelApp.reuse_if_possible
+        app2 = ExcelApp.reuse
         #puts "@app1 #{@app1.Hwnd}"
         #puts "app2  #{app2.Hwnd}"
         app2.Hwnd.should == @app1.Hwnd
@@ -114,7 +104,7 @@ module RobustExcelOle
       end
 
       it "should be true with two identical excel applications" do
-        app2 = ExcelApp.reuse_if_possible
+        app2 = ExcelApp.reuse
         app2.should == @app1
       end
 
@@ -131,6 +121,28 @@ module RobustExcelOle
 
     end
 
+
+    context "with :excel_app" do
+
+      before do
+        ExcelApp.close_all
+      end
+
+      after (:each) do
+        ExcelApp.close_all
+      end
+
+      it "should reuse in given excel app" do
+        app1 = ExcelApp.new(:reuse => false)
+        app2 = ExcelApp.new(:reuse => false)
+        app3 = ExcelApp.new(:excel_app => app1)
+        app4 = ExcelApp.new(:excel_app => app2)
+        app3.should == app1
+        app4.should == app2
+      end
+
+    end
+
     context "with Visible and DisplayAlerts" do
 
       before do

data/version.rb

@@ -1,5 +1 @@
-require 'lib/robust_excel_ole/verson'
-
-module RobustExcelOle
-  VERSION = "0.2.0"
-end
+require File.expand_path('../lib/robust_excel_ole/version', __FILE__)