robust_excel_ole 1.13 → 1.18

data/lib/robust_excel_ole/worksheet.rb

@@ -12,6 +12,7 @@ module RobustExcelOle
   class Worksheet < RangeOwners
 
     attr_reader :ole_worksheet
+    attr_reader :workbook
 
     def initialize(win32_worksheet)
       @ole_worksheet = win32_worksheet
@@ -27,12 +28,18 @@ module RobustExcelOle
     end
 
     def workbook
-      ole_workbook = self.Parent
-      saved_status = ole_workbook.Saved
-      ole_workbook.Saved = true unless saved_status
-      workbook = workbook_class.new(ole_workbook)
-      ole_workbook.Saved = saved_status
-      workbook
+      @workbook ||= begin
+        ole_workbook = self.Parent
+        saved_status = ole_workbook.Saved
+        ole_workbook.Saved = true unless saved_status
+        @workbook = workbook_class.new(ole_workbook)
+        ole_workbook.Saved = saved_status
+        @workbook
+      end
+    end
+
+    def excel
+      workbook.excel
     end
 
     # sheet name
@@ -40,7 +47,7 @@ module RobustExcelOle
     def name
       @ole_worksheet.Name
     rescue
-      raise WorksheetREOError, "name #{name.inspect} could not be determined"
+      raise WorksheetREOError, "name could not be determined"
     end
 
     # sets sheet name
@@ -64,7 +71,7 @@ module RobustExcelOle
         xy = "#{x}_#{y}"
         @cells = { }
         begin
-          @cells[xy] = RobustExcelOle::Cell.new(@ole_worksheet.Cells.Item(x, y))
+          @cells[xy] = RobustExcelOle::Cell.new(@ole_worksheet.Cells.Item(x, y), @worksheet)
         rescue
           raise RangeNotEvaluatable, "cannot read cell (#{x.inspect},#{y.inspect})"
         end
@@ -87,10 +94,7 @@ module RobustExcelOle
       else
         name, value = p1, p2
         begin
-          old_color_if_modified = workbook.color_if_modified
-          workbook.color_if_modified = 42  # aqua-marin
-          set_namevalue_glob(name, value)
-          workbook.color_if_modified = old_color_if_modified
+          set_namevalue_glob(name, value, :color => 42)
         rescue REOError
           begin
             workbook.set_namevalue_glob(name, value)
@@ -104,24 +108,34 @@ module RobustExcelOle
     # value of a cell, if row and column are given
     # @params row and column
     # @returns value of the cell
+    def cellval(x,y)
+      xy = "#{x}_#{y}"
+      begin
+        @ole_worksheet.Cells.Item(x, y).Value
+      rescue
+        raise RangeNotEvaluatable, "cannot read cell (#{p1.inspect},#{p2.inspect})"
+      end
+    end
+
+=begin
     def cellval(x,y)
       xy = "#{x}_#{y}"
       @cells = { }
       begin
-        @cells[xy] = RobustExcelOle::Cell.new(@ole_worksheet.Cells.Item(x, y))
+        @cells[xy] = RobustExcelOle::Cell.new(@ole_worksheet.Cells.Item(x, y), @worksheet)
         @cells[xy].Value
       rescue
         raise RangeNotEvaluatable, "cannot read cell (#{p1.inspect},#{p2.inspect})"
       end
     end
+=end
 
     # sets the value of a cell, if row, column and color of the cell are given
     # @params [Integer] x,y row and column
     # @option opts [Symbol] :color the color of the cell when set
     def set_cellval(x,y,value, opts = { }) # option opts is deprecated
       cell = @ole_worksheet.Cells.Item(x, y)
-      workbook.color_if_modified = opts[:color] unless opts[:color].nil?
-      cell.Interior.ColorIndex = workbook.color_if_modified unless workbook.color_if_modified.nil?
+      cell.Interior.ColorIndex = opts[:color] unless opts[:color].nil?
       cell.Value = value
     rescue # WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException
       raise RangeNotEvaluatable, "cannot assign value #{value.inspect} to cell (#{y.inspect},#{x.inspect})"
@@ -145,17 +159,31 @@ module RobustExcelOle
       end
     end
 
+    def each_value
+      @ole_worksheet.UsedRange.Value.each do |row_values|
+        yield row_values
+      end
+    end
+
+    def each_value_with_index(offset = 0)
+      i = offset
+      @ole_worksheet.UsedRange.Value.each do |row_values|
+        yield row_values, i
+        i += 1
+      end
+    end
+
     def each_row(offset = 0)
       offset += 1
       1.upto(@end_row) do |row|
         next if row < offset
-        yield RobustExcelOle::Range.new(@ole_worksheet.Range(@ole_worksheet.Cells(row, 1), @ole_worksheet.Cells(row, @end_column)))
+        yield RobustExcelOle::Range.new(@ole_worksheet.Range(@ole_worksheet.Cells(row, 1), @ole_worksheet.Cells(row, @end_column)), self)
       end
     end
 
     def each_row_with_index(offset = 0)
       each_row(offset) do |row_range|
-        yield RobustExcelOle::Range.new(row_range), (row_range.Row - 1 - offset)
+        yield RobustExcelOle::Range.new(row_range, self), (row_range.Row - 1 - offset)
       end
     end
 
@@ -163,24 +191,24 @@ module RobustExcelOle
       offset += 1
       1.upto(@end_column) do |column|
         next if column < offset
-        yield RobustExcelOle::Range.new(@ole_worksheet.Range(@ole_worksheet.Cells(1, column), @ole_worksheet.Cells(@end_row, column)))
+        yield RobustExcelOle::Range.new(@ole_worksheet.Range(@ole_worksheet.Cells(1, column), @ole_worksheet.Cells(@end_row, column)), self)
       end
     end
 
     def each_column_with_index(offset = 0)
       each_column(offset) do |column_range|
-        yield RobustExcelOle::Range.new(column_range), (column_range.Column - 1 - offset)
+        yield RobustExcelOle::Range.new(column_range, self), (column_range.Column - 1 - offset)
       end
     end
 
     def row_range(row, integer_range = nil)
       integer_range ||= 1..@end_column
-      RobustExcelOle::Range.new(@ole_worksheet.Range(@ole_worksheet.Cells(row, integer_range.min), @ole_worksheet.Cells(row, integer_range.max)))
+      RobustExcelOle::Range.new(@ole_worksheet.Range(@ole_worksheet.Cells(row, integer_range.min), @ole_worksheet.Cells(row, integer_range.max)), self)
     end
 
     def col_range(col, integer_range = nil)
       integer_range ||= 1..@end_row
-      RobustExcelOle::Range.new(@ole_worksheet.Range(@ole_worksheet.Cells(integer_range.min, col), @ole_worksheet.Cells(integer_range.max, col)))
+      RobustExcelOle::Range.new(@ole_worksheet.Range(@ole_worksheet.Cells(integer_range.min, col), @ole_worksheet.Cells(integer_range.max, col)), self)
     end
 
     def == other_worksheet
@@ -206,8 +234,7 @@ module RobustExcelOle
 
     # @private
     def to_s    
-      '#<Worksheet: ' + name.to_s + ">"
-      #'#<Worksheet: ' + ('not alive ' unless workbook.alive?).to_s + name.to_s + " #{File.basename(workbook.stored_filename)} >"
+      '#<Worksheet: ' + (workbook.nil? ? 'not alive ' : (name + ' ' + File.basename(workbook.stored_filename)).to_s) + ">"
     end
 
     # @private
@@ -217,10 +244,9 @@ module RobustExcelOle
 
   private
 
-    # @private
     def method_missing(name, *args)
       if name.to_s[0,1] =~ /[A-Z]/
-        if JRUBY_BUG_ERRORMESSAGE 
+        if ::ERRORMESSAGE_JRUBY_BUG 
           begin
             @ole_worksheet.send(name, *args)
           rescue Java::OrgRacobCom::ComFailException 

data/robust_excel_ole.gemspec

@@ -35,4 +35,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.add_development_dependency "rspec", '>= 2.6.0'
   s.required_ruby_version = '>= 1.8.6'
+  s.extensions << 'extconf.rb'
 end

data/spec/address_tool_spec.rb

@@ -0,0 +1,175 @@
+# -*- coding: utf-8 -*-
+
+require File.join(File.dirname(__FILE__), './spec_helper')
+require File.expand_path( '../../lib/robust_excel_ole/base', __FILE__)
+
+$VERBOSE = nil
+
+include General
+include RobustExcelOle
+
+module RobustExcelOle
+
+  describe AddressTool do
+
+    before(:all) do
+      excel = Excel.new(:reuse => true)
+      open_books = excel == nil ? 0 : excel.Workbooks.Count
+      puts "*** open books *** : #{open_books}" if open_books > 0
+      Excel.kill_all
+      @dir = create_tmpdir
+      @simple_file = @dir + '/workbook.xls'
+      @workbook = Workbook.open(@simple_file)
+      @address_tool = @workbook.excel.address_tool
+    end
+
+    after(:all) do
+      @workbook.close
+    end
+
+    it "should transform relative r1c1-reference into r1c1-format" do
+      @address_tool.as_r1c1("Z1S[2]:Z[-1]S4").should == "Z1S(2):Z(-1)S4"
+      @address_tool.as_r1c1("Z[1]S2:Z3S[4]").should == "Z(1)S2:Z3S(4)"
+      @address_tool.as_r1c1("Z1S[2]").should == "Z1S(2)"
+      @address_tool.as_r1c1("Z[-1]S4").should == "Z(-1)S4"
+      @address_tool.as_r1c1("Z[3]").should == "Z(3)"
+      @address_tool.as_r1c1("S[-2]").should == "S(-2)"
+    end
+
+    # test for 1.8.6
+    it "should transform relative integer_ranges-format into r1c1-format" do
+      @address_tool.as_r1c1([1..2,[3]..4]).should == "Z1S(3):Z2S4"
+      @address_tool.as_r1c1([[1]..2,3..4]).should == "Z(1)S3:Z2S4"
+      @address_tool.as_r1c1([[1]..2,nil]).should == "Z(1):Z2"
+      @address_tool.as_r1c1([nil,[1]..2]).should == "S(1):S2"
+      @address_tool.as_r1c1([nil,[1]]).should == "S(1):S(1)"
+    end
+
+    it "should transform relative integer_ranges-format into r1c1-format" do
+      @address_tool.as_r1c1([1..[-2],[3]..4]).should == "Z1S(3):Z(-2)S4"
+      @address_tool.as_r1c1([[1]..2,3..[4]]).should == "Z(1)S3:Z2S(4)"
+      @address_tool.as_r1c1([1..[-2],nil]).should == "Z1:Z(-2)"
+      @address_tool.as_r1c1([nil,[-1]..2]).should == "S(-1):S2"
+      @address_tool.as_r1c1([[3]..[3],nil]).should == "Z(3):Z(3)"
+      @address_tool.as_r1c1([nil,[-2]..[-2]]).should == "S(-2):S(-2)"
+      @address_tool.as_r1c1([[3],nil]).should == "Z(3):Z(3)"
+    end
+
+    it "should transform relative r1c1-format into r1c1-format" do
+      @address_tool.as_integer_ranges("Z1S[2]:Z[3]S4").should == [1..[3],[2]..4]
+      @address_tool.as_integer_ranges("Z[1]S2:Z3S[4]").should == [[1]..3,2..[4]]
+      @address_tool.as_integer_ranges("Z1S[2]").should == [1..1,[2]..[2]]
+      @address_tool.as_integer_ranges("Z[3]S4").should == [[3]..[3],4..4]
+    end
+
+    it "should transform a1-format" do
+      @address_tool.as_a1("A2").should == "A2"
+      @address_tool.as_r1c1("A2").should == "Z2S1:Z2S1"
+      @address_tool.as_integer_ranges("A2").should == [2..2,1..1]
+    end
+
+    it "should transform several-letter-a1-format" do
+      @address_tool.as_a1("ABO15").should == "ABO15"
+      @address_tool.as_r1c1("ABO15").should == "Z15S743:Z15S743"
+      @address_tool.as_integer_ranges("ABO15").should == [15..15,743..743]
+    end
+
+    it "should transform complex a1-format" do
+      @address_tool.as_a1("A2:B3").should == "A2:B3"
+      @address_tool.as_r1c1("A2:B3").should == "Z2S1:Z3S2"
+      @address_tool.as_integer_ranges("A2:B3").should == [2..3,1..2]
+      @address_tool.as_a1("S1:DP2").should == "S1:DP2"
+      @address_tool.as_r1c1("S1:DP2").should == "Z1S19:Z2S120"
+      @address_tool.as_integer_ranges("S1:DP2").should == [1..2,19..120]
+    end
+
+    it "should transform infinite a1-format" do
+      @address_tool.as_a1("A:B").should == "A:B"
+      @address_tool.as_r1c1("A:B").should == "S1:S2"
+      @address_tool.as_integer_ranges("A:B").should == [nil,1..2]
+      @address_tool.as_a1("1:3").should == "1:3"
+      @address_tool.as_r1c1("1:3").should == "Z1:Z3"
+      @address_tool.as_integer_ranges("1:3").should == [1..3,nil]
+      @address_tool.as_a1("B").should == "B"
+      @address_tool.as_r1c1("B").should == "S2:S2"
+      @address_tool.as_integer_ranges("B").should == [nil,2..2]
+      @address_tool.as_a1("3").should == "3"
+      @address_tool.as_r1c1("3").should == "Z3:Z3"
+      @address_tool.as_integer_ranges("3").should == [3..3,nil]
+    end
+
+    it "should transform r1c1-format" do
+      @address_tool.as_r1c1("Z2S1").should == "Z2S1"
+      @address_tool.as_integer_ranges("Z2S1").should == [2..2,1..1]
+      expect{
+        @address_tool.as_a1("Z2S1")
+      }.to raise_error(NotImplementedREOError)
+    end
+
+    it "should transform complex r1c1-format" do
+      @address_tool.as_r1c1("Z2S1:Z3S2").should == "Z2S1:Z3S2"
+      @address_tool.as_integer_ranges("Z2S1:Z3S2").should == [2..3,1..2]
+    end
+
+    it "should transform as_integer_ranges format" do
+      @address_tool.as_integer_ranges([2..2,1..1]).should == [2..2,1..1]
+      @address_tool.as_r1c1([2..2,1..1]).should == "Z2S1:Z2S1"
+      expect{
+        @address_tool.as_a1([2..2,1..1])
+      }.to raise_error(NotImplementedREOError)
+    end
+
+    it "should transform simple as_integer_ranges format" do
+      @address_tool.as_integer_ranges([2,1]).should == [2..2,1..1]
+      @address_tool.as_r1c1([2,1]).should == "Z2S1:Z2S1"
+    end
+
+    it "should transform complex as_integer_ranges format" do
+      @address_tool.as_integer_ranges([2,"A"]).should == [2..2,1..1]
+      @address_tool.as_r1c1([2,"A"]).should == "Z2S1:Z2S1"
+      @address_tool.as_integer_ranges([2,"A".."B"]).should == [2..2,1..2]
+      @address_tool.as_r1c1([2,"A".."B"]).should == "Z2S1:Z2S2"
+      @address_tool.as_integer_ranges([1..2,"C"]).should == [1..2,3..3]
+      @address_tool.as_r1c1([1..2,"C"]).should == "Z1S3:Z2S3"
+      @address_tool.as_integer_ranges([1..2,"C".."E"]).should == [1..2,3..5]
+      @address_tool.as_r1c1([1..2,"C".."E"]).should == "Z1S3:Z2S5"
+      @address_tool.as_integer_ranges([2,3..5]).should == [2..2,3..5]
+      @address_tool.as_r1c1([2,3..5]).should == "Z2S3:Z2S5"
+      @address_tool.as_integer_ranges([1..2,3..5]).should == [1..2,3..5]
+      @address_tool.as_r1c1([1..2,3..5]).should == "Z1S3:Z2S5"
+    end
+
+    it "should transform infinite as_integer_ranges format" do
+      @address_tool.as_integer_ranges([nil,1..2]).should == [nil,1..2]
+      @address_tool.as_r1c1([nil,1..2]).should == "S1:S2"
+      @address_tool.as_integer_ranges([1..3,nil]).should == [1..3,nil]
+      @address_tool.as_r1c1([1..3,nil]).should == "Z1:Z3"
+      @address_tool.as_integer_ranges([nil,2]).should == [nil,2..2]
+      @address_tool.as_r1c1([nil,2]).should == "S2:S2"
+      @address_tool.as_integer_ranges([3,nil]).should == [3..3,nil]
+      @address_tool.as_r1c1([3,nil]).should == "Z3:Z3"
+    end
+  
+    it "should raise an error" do
+      expect{
+        @address_tool.as_a1("1A")
+      }.to raise_error(AddressInvalid, /format not correct/)
+      expect{
+        @address_tool.as_r1c1("A1B")
+      }.to raise_error(AddressInvalid, /format not correct/)
+      #expect{
+      #  @address_tool.as_integer_ranges(["A".."B","C".."D"])
+      #}.to raise_error(AddressInvalid, /format not correct/)
+      #expect{
+      #  @address_tool.as_integer_ranges(["A".."B",1..2])
+      #}.to raise_error(AddressInvalid, /format not correct/)
+      #expect{
+      #  @address_tool.as_integer_ranges(["A".."B",nil])
+      #}.to raise_error(AddressInvalid, /format not correct/)
+      expect{
+        @address_tool.as_integer_ranges(["A",1,2])
+      }.to raise_error(AddressInvalid, /more than two components/)
+    end
+
+  end
+end

data/spec/{reo_common_spec.rb → base_spec.rb}

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 require File.join(File.dirname(__FILE__), './spec_helper')
-require File.expand_path( '../../lib/robust_excel_ole/reo_common', __FILE__)
+require File.expand_path( '../../lib/robust_excel_ole/base', __FILE__)
 
 $VERBOSE = nil
 
@@ -10,7 +10,7 @@ include RobustExcelOle
 
 module RobustExcelOle
 
-  describe REOCommon do
+  describe Base do
 
     before(:all) do
       excel = Excel.new(:reuse => true)
@@ -40,12 +40,12 @@ module RobustExcelOle
 
       it "should put some number" do
         a = 4
-        REOCommon::trace "some text #{a}"
+        Base::trace "some text #{a}"
       end
 
       it "should put another text" do
         b = Workbook.open(@simple_file)
-        REOCommon::trace "book: #{b}"
+        Base::trace "book: #{b}"
       end
     end
 
@@ -63,7 +63,7 @@ module RobustExcelOle
           ["ActiveCell", "ActiveSheet", "ActiveWorkbook", "Application",  "Calculate", "Cells", "Columns",
             "DisplayAlerts", "Evaluate", "Hwnd", "Name", "Names", "Quit", "Range", "Ready", "Save", 
             "Sheets", "UserName", "Value", "Visible", "Workbooks", "Worksheets"]
-        @excel_methods = ["alive?", "workbook_class", "close", "displayalerts", "recreate", "visible", "with_displayalerts"] 
+        @excel_methods = ["alive?", "workbook_class", "close", "properties", "recreate", "with_displayalerts"] 
       end
 
       after do
@@ -82,43 +82,28 @@ module RobustExcelOle
 
     end
 
-    describe "Object methods" do
-
-      before do
-        @book = Workbook.open(@simple_file)
-        @sheet = @book.sheet(1)
-      end
-
-      before do
-        @book.close
-      end
-
-      it "should raise an error when asking excel of a sheet" do
-        expect{
-          @sheet.excel
-          }.to raise_error(TypeREOError, "receiver instance is neither an Excel nor a Workbook")
-      end
+    describe "misc" do
 
-    end
+      it "should" do
 
-    describe "misc" do
+        LOG_TO_STDOUT = true
+        Base::trace "foo"
 
-      LOG_TO_STDOUT = true
-      REOCommon::trace "foo"
+        LOG_TO_STDOUT = false
+        Base::trace "foo"
 
-      LOG_TO_STDOUT = false
-      REOCommon::trace "foo"
+        REO_LOG_DIR = ""
+        Base::trace "foo"
 
-      REO_LOG_DIR = ""
-      REOCommon::trace "foo"
+        #REO_LOG_DIR = "C:"
+        #Base::trace "foo"
 
-      REO_LOG_DIR = "C:"
-      REOCommon::trace "foo"
+        Base::tr1 "foo"
 
-      REOCommon::tr1 "foo"
+        h = {:a => {:c => 4}, :b => 2}
+        Base::puts_hash(h)
 
-      h = {:a => {:c => 4}, :b => 2}
-      REOCommon::puts_hash(h)
+      end
  
     end
   end