jruby-poi 0.5.2 → 0.6.0

data/VERSION

@@ -1 +1 @@
-0.5.2
+0.6.0

data/jruby-poi.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jruby-poi}
-  s.version = "0.5.2"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Scott Deming", "Jason Rogers"]
@@ -36,6 +36,7 @@ Gem::Specification.new do |s|
      "lib/poi.rb",
      "lib/poi/workbook.rb",
      "lib/poi/workbook/cell.rb",
+     "lib/poi/workbook/named_range.rb",
      "lib/poi/workbook/row.rb",
      "lib/poi/workbook/workbook.rb",
      "lib/poi/workbook/worksheet.rb",

data/lib/poi/workbook/cell.rb

@@ -35,31 +35,53 @@ module POI
       @cell = cell
     end
     
+    # This is NOT an inexpensive operation. The purpose of this method is merely to get more information
+    # out of cell when one thinks the value returned is incorrect. It may have more value in development
+    # than in production.
     def error_value
-      @error_value
+      if poi_cell.getCellType == CELL_TYPE_ERROR
+        Java::org.apache.poi.hssf.record.formula.eval.ErrorEval.getText(poi_cell.getErrorCellValue)
+      elsif poi_cell.getCellType == CELL_TYPE_FORMULA && poi_cell.getCachedFormulaResultType == CELL_TYPE_ERROR
+        formula_evaluator = Java::org.apache.poi.xssf.usermodel.XSSFFormulaEvaluator.new poi_cell.sheet.workbook
+        value_of(formula_evaluator.evaluate(poi_cell))
+      else
+        nil
+      end
+    end
+    
+    # returns the formula for this Cell if it has one, otherwise nil
+    def formula_value
+      poi_cell.getCellType == CELL_TYPE_FORMULA ? poi_cell.getCellFormula : nil
     end
     
     def value
-      return nil if @cell.nil?
-      value_of(cell_value_for_type(@cell.getCellType))
+      return nil if poi_cell.nil?
+      value_of(cell_value_for_type(poi_cell.getCellType))
     end
     
     def comment
-      @cell.getCellComment
+      poi_cell.getCellComment
     end
 
     def index
-      @cell.getColumnIndex 
+      poi_cell.getColumnIndex 
     end    
 
+    # Get the String representation of this Cell's value.
+    #
+    # If this Cell is a formula you can pass a false to this method and
+    # get the formula instead of the String representation.
     def to_s(evaluate_formulas=true)
-      if @cell.getCellType == CELL_TYPE_FORMULA
-        evaluate_formulas ? value.to_s : @cell.getCellFormula
+      return '' if poi_cell.nil?
+
+      if poi_cell.getCellType == CELL_TYPE_FORMULA && evaluate_formulas == false
+        formula_value
       else
         value.to_s
       end
     end
 
+    # returns the underlying org.apache.poi.ss.usermodel.Cell
     def poi_cell
       @cell
     end
@@ -73,30 +95,30 @@ module POI
         when CELL_TYPE_BOOLEAN: cell_value.getBooleanValue
         when CELL_TYPE_ERROR: Java::org.apache.poi.hssf.record.formula.eval.ErrorEval.getText(cell_value.getErrorValue)
         when CELL_TYPE_NUMERIC
-          if Java::org.apache.poi.ss.usermodel.DateUtil.isCellDateFormatted @cell
+          if Java::org.apache.poi.ss.usermodel.DateUtil.isCellDateFormatted poi_cell
             Date.parse(Java::org.apache.poi.ss.usermodel.DateUtil.getJavaDate(cell_value.getNumberValue).to_s)
           else
             cell_value.getNumberValue
           end
         when CELL_TYPE_STRING: cell_value.getStringValue
         else
-          raise "unhandled cell type[#{@cell.getCellType}]"
+          raise "unhandled cell type[#{cell_value.getCellType}]"
         end
       end
       
       def cell_value_for_type(cell_type)
+        return nil if cell_type.nil?
         begin
           case cell_type
           when CELL_TYPE_BLANK: nil
-          when CELL_TYPE_BOOLEAN: CELL_VALUE.valueOf(@cell.getBooleanCellValue)
-          when CELL_TYPE_FORMULA: cell_value_for_type(@cell.getCachedFormulaResultType)
-          when CELL_TYPE_STRING: CELL_VALUE.new(@cell.getStringCellValue)
-          when CELL_TYPE_ERROR, CELL_TYPE_NUMERIC: CELL_VALUE.new(@cell.getNumericCellValue)
+          when CELL_TYPE_BOOLEAN: CELL_VALUE.valueOf(poi_cell.getBooleanCellValue)
+          when CELL_TYPE_FORMULA: cell_value_for_type(poi_cell.getCachedFormulaResultType)
+          when CELL_TYPE_STRING: CELL_VALUE.new(poi_cell.getStringCellValue)
+          when CELL_TYPE_ERROR, CELL_TYPE_NUMERIC: CELL_VALUE.new(poi_cell.getNumericCellValue)
           else
-            raise "unhandled cell type[#{@cell.getCellType}]"
+            raise "unhandled cell type[#{poi_cell.getCellType}]"
           end
         rescue
-          @error_value = $!
           nil
         end
       end

data/lib/poi/workbook/named_range.rb

@@ -0,0 +1,45 @@
+class NamedRange
+  
+  # takes an instance of org.apache.poi.ss.usermodel.Name, and a POI::Workbook
+  def initialize name, workbook
+    @name = name
+    @workbook = workbook
+  end
+  
+  def name
+    @name.getNameName
+  end
+  
+  def sheet
+    @workbook[@name.getSheetName]
+  end
+  
+  def formula
+    @name.getRefersToFormula
+  end
+  
+  def cells
+    area_range? ? all_cells_from_area : @workbook.cell(formula)
+  end
+  
+  def values
+    cells.collect{|c| c.value}
+  end
+  
+  private
+    def area_range?
+      area.nil? == false
+    end
+    
+    def area
+      @area ||= begin
+        org.apache.poi.ss.util.AreaReference.new formula
+      rescue
+        nil
+      end
+    end
+    
+    def all_cells_from_area
+      area.getAllReferencedCells.collect{|c| @workbook.cell c.formatAsString}
+    end
+end

data/lib/poi/workbook/row.rb

@@ -27,7 +27,8 @@ module POI
     end
     
     def [](index)
-      Cell.new(@row.getCell(index))
+      return nil if poi_row.nil?
+      Cell.new(poi_row.getCell(index))
     end
 
     def cells
@@ -35,7 +36,8 @@ module POI
     end
 
     def index
-      @row.getRowNum
+      return nil if poi_row.nil?
+      poi_row.getRowNum
     end    
 
     def poi_row

data/lib/poi/workbook/workbook.rb

@@ -50,11 +50,46 @@ module POI
     end
 
     def worksheets
-      Worksheets.new(self)
+      @worksheets ||= Worksheets.new(self)
+    end
+    
+    def named_ranges
+      @named_ranges ||= (0...@workbook.getNumberOfNames).collect do | idx |
+        NamedRange.new @workbook.getNameAt(idx), self
+      end
     end
 
+    # sheet_index can be a Fixnum, referring to the 0-based sheet or
+    # a String which is the sheet name or a cell reference.
+    # 
+    # If a cell reference is passed the value of that cell is returned.
     def [](sheet_index)
-      worksheets[sheet_index]
+      begin
+        cell = cell(sheet_index)
+        Array === cell ? cell.collect{|e| e.value} : cell.value
+      rescue
+        answer = worksheets[sheet_index]
+        answer.poi_worksheet.nil? ? nil : answer
+      end
+    end
+
+    # takes a String in the form of a 3D cell reference and returns the Cell (eg. "Sheet 1!A1")
+    def cell reference
+      if named_range = named_ranges.detect{|e| e.name == reference}
+        cells = named_range.cells.compact
+        if cells.empty?
+          return nil
+        else
+          return cells.length == 1 ? cells.first : cells
+        end
+      end
+
+      ref = org.apache.poi.ss.util.CellReference.new(reference)
+      if ref.getSheetName.nil?
+        raise 'cell references at the workbook level must include a sheet reference (eg. Sheet1!A1)'
+      else
+        worksheets[ref.getSheetName][ref.getRow][ref.getCol]
+      end
     end
 
     def poi_workbook

data/lib/poi/workbook/worksheet.rb

@@ -39,8 +39,17 @@ module POI
       Rows.new(self)
     end
     
+    # Accepts a Fixnum or a String as the row_index
+    #
+    # row_index as Fixnum - returns the 0-based row
+    # row_index as String - assumes a cell reference within this sheet and returns the cell value for that reference
     def [](row_index)
-      rows[row_index]
+      if Fixnum === row_index
+        rows[row_index]
+      else
+        ref = org.apache.poi.ss.util.CellReference.new(row_index)
+        rows[ref.getRow][ref.getCol].value
+      end
     end
 
     def poi_worksheet

data/lib/poi/workbook.rb

@@ -1,3 +1,4 @@
+require File.join(JRUBY_POI_LIB_PATH, 'poi', 'workbook', 'named_range')
 require File.join(JRUBY_POI_LIB_PATH, 'poi', 'workbook', 'workbook')
 require File.join(JRUBY_POI_LIB_PATH, 'poi', 'workbook', 'worksheet')
 require File.join(JRUBY_POI_LIB_PATH, 'poi', 'workbook', 'row')

data/specs/workbook_spec.rb

@@ -6,23 +6,81 @@ describe POI::Workbook do
   it "should open a workbook and allow access to its worksheets" do
     name = TestDataFile.expand_path("various_samples.xlsx")
     book = POI::Workbook.open(name)
-    book.worksheets.size.should == 4
+    book.worksheets.size.should == 5
     book.filename.should == name
   end
 
   it "should be able to create a Workbook from an IO object" do
     content = StringIO.new(open(TestDataFile.expand_path("various_samples.xlsx"), 'rb'){|f| f.read})
     book = POI::Workbook.open(content)
-    book.worksheets.size.should == 4
+    book.worksheets.size.should == 5
     book.filename.should =~ /spreadsheet.xlsx$/
   end
 
   it "should be able to create a Workbook from a Java input stream" do
     content = java.io.FileInputStream.new(TestDataFile.expand_path("various_samples.xlsx"))
     book = POI::Workbook.open(content)
-    book.worksheets.size.should == 4
+    book.worksheets.size.should == 5
     book.filename.should =~ /spreadsheet.xlsx$/
   end
+  
+  it "should return cells by reference" do
+    name = TestDataFile.expand_path("various_samples.xlsx")
+    book = POI::Workbook.open(name)
+
+    book.cell("numbers!A1").value.should == 'NUM'
+    book.cell("numbers!A2").to_s.should == '1.0'
+    book.cell("numbers!A3").to_s.should == '2.0'
+    book.cell("numbers!A4").to_s.should == '3.0'
+    
+    book.cell("numbers!A10").to_s.should == '9.0'
+    book.cell("numbers!B10").to_s.should == '81.0'
+    book.cell("numbers!C10").to_s.should == '729.0'
+    book.cell("numbers!D10").to_s.should == '3.0'
+
+    book.cell("text & pic!A10").value.should == 'This is an Excel XLSX workbook.'
+    book.cell("bools & errors!B3").value.should == true
+    book.cell("high refs!AM619").value.should == 'This is some text'
+    book.cell("high refs!AO624").value.should == 24.0
+    book.cell("high refs!AP631").value.should == 13.0
+
+    book.cell(%Q{'text & pic'!A10}).value.should == 'This is an Excel XLSX workbook.'
+    book.cell(%Q{'bools & errors'!B3}).value.should == true
+    book.cell(%Q{'high refs'!AM619}).value.should == 'This is some text'
+    book.cell(%Q{'high refs'!AO624}).value.should == 24.0
+    book.cell(%Q{'high refs'!AP631}).value.should == 13.0
+  end
+  
+  it "should handle named cell ranges" do
+    name = TestDataFile.expand_path("various_samples.xlsx")
+    book = POI::Workbook.open(name)
+
+    book.named_ranges.length.should == 3
+    book.named_ranges.collect{|e| e.name}.should == %w{four_times_six NAMES nums}
+    book.named_ranges.collect{|e| e.sheet.name}.should == ['high refs', 'bools & errors', 'high refs']
+    book.named_ranges.collect{|e| e.formula}.should == ["'high refs'!$AO$624", "'bools & errors'!$D$2:$D$11", "'high refs'!$AP$619:$AP$631"]
+    book['four_times_six'].should == 24.0
+    book['nums'].should == (1..13).collect{|e| e * 1.0}
+    
+    # NAMES is a range of empty cells
+    book['NAMES'].should == [nil, nil, nil, nil, nil, nil, nil]
+    book.cell('NAMES').each do | cell |
+      cell.value.should be_nil
+      cell.poi_cell.should be_nil
+      cell.to_s.should be_empty
+    end
+  end
+  
+  it "should return cell values by reference" do
+    name = TestDataFile.expand_path("various_samples.xlsx")
+    book = POI::Workbook.open(name)
+
+    book['text & pic!A10'].should == 'This is an Excel XLSX workbook.'
+    book['bools & errors!B3'].should == true
+    book['high refs!AM619'].should == 'This is some text'
+    book['high refs!AO624'].should == 24.0
+    book['high refs!AP631'].should == 13.0
+  end
 end
 
 describe POI::Worksheets do
@@ -54,8 +112,19 @@ describe POI::Worksheets do
       sheet.should be_kind_of POI::Worksheet
     end
 
-    book.worksheets.size.should == 4
-    book.worksheets.collect.size.should == 4
+    book.worksheets.size.should == 5
+    book.worksheets.collect.size.should == 5
+  end
+  
+  it "returns cells when passing a cell reference" do
+    name = TestDataFile.expand_path("various_samples.xlsx")
+    book = POI::Workbook.open(name)
+    book['dates']['A2'].should == Date.parse('2010-02-28')
+    book['dates']['a2'].should == Date.parse('2010-02-28')
+    book['dates']['B2'].should == Date.parse('2010-03-14')
+    book['dates']['b2'].should == Date.parse('2010-03-14')
+    book['dates']['C2'].should == Date.parse('2010-03-28')
+    book['dates']['c2'].should == Date.parse('2010-03-28')
   end
 end
 
@@ -133,7 +202,6 @@ describe POI::Cells do
     rows[9][3].to_s.should == '3.0'
   end
 
-
   it "should handle array access from the workbook down to cells" do
     book[1][9][0].to_s.should == '9.0'
     book[1][9][1].to_s.should == '81.0'
@@ -153,26 +221,26 @@ describe POI::Cells do
     rows[6][0].value.should == 0.0 #'~CIRCULAR~REF~'
     rows[6][0].error_value.should be_nil
 
-    rows[7][0].value.should be_nil #'#DIV/0!'
-    rows[7][0].error_value.should == 'java.lang.NumberFormatException: For input string: "#N/A"'
+    rows[7][0].value.should be_nil
+    rows[7][0].error_value.should == '#DIV/0!'
 
-    rows[8][0].value.should be_nil #'#N/A'
-    rows[8][0].error_value.should == 'java.lang.NumberFormatException: For input string: "#N/A"'
+    rows[8][0].value.should be_nil
+    rows[8][0].error_value.should == '#N/A'
 
-    rows[9][0].value.should be_nil #'#NAME?'
-    rows[9][0].error_value.should == 'java.lang.NumberFormatException: For input string: "#N/A"'
+    rows[9][0].value.should be_nil
+    rows[9][0].error_value.should == '#NAME?'
 
-    rows[10][0].value.should be_nil #'#NULL!'
-    rows[10][0].error_value.should == 'java.lang.NumberFormatException: For input string: "#N/A"'
+    rows[10][0].value.should be_nil
+    rows[10][0].error_value.should == '#NULL!'
 
-    rows[11][0].value.should be_nil #'#NUM!'
-    rows[11][0].error_value.should == 'java.lang.NumberFormatException: For input string: "#N/A"'
+    rows[11][0].value.should be_nil
+    rows[11][0].error_value.should == '#NUM!'
 
-    rows[12][0].value.should be_nil #'#REF!'
-    rows[12][0].error_value.should == 'java.lang.NumberFormatException: For input string: "#N/A"'
+    rows[12][0].value.should be_nil
+    rows[12][0].error_value.should == '#REF!'
 
-    rows[13][0].value.should be_nil #'#VALUE!'
-    rows[13][0].error_value.should == 'java.lang.NumberFormatException: For input string: "#N/A"'
+    rows[13][0].value.should be_nil
+    rows[13][0].error_value.should == '#VALUE!'
 
     lambda{ rows[14][0].value }.should_not raise_error(Java::java.lang.RuntimeException)
     

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
     - 0
-    - 5
-    - 2
-  version: 0.5.2
+    - 6
+    - 0
+  version: 0.6.0
 platform: ruby
 authors: 
   - Scott Deming
@@ -50,6 +50,7 @@ files:
   - lib/poi.rb
   - lib/poi/workbook.rb
   - lib/poi/workbook/cell.rb
+  - lib/poi/workbook/named_range.rb
   - lib/poi/workbook/row.rb
   - lib/poi/workbook/workbook.rb
   - lib/poi/workbook/worksheet.rb