jruby-poi 0.1.0 → 0.4.0

data/.gitignore

@@ -6,3 +6,4 @@ nbproject
 tmp
 *.swp
 TAGS
+pkg

data/README.markdown

@@ -12,6 +12,7 @@ Contributors
 ============
 
 * [Scott Deming](http://github.com/sdeming)
+* [Jason Rogers](http://github.com/jacaetevha)
 
 Note on Patches/Pull Requests
 =============================

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.4.0

data/jruby-poi.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jruby-poi}
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Deming"]
+  s.date = %q{2010-08-27}
+  s.description = %q{A rubyesque library for manipulating spreadsheets and other document types for jruby, using Apache POI.}
+  s.email = %q{sdeming@makefile.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "NOTICE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "jruby-poi.gemspec",
+     "lib/ooxml-lib/dom4j-1.6.1.jar",
+     "lib/ooxml-lib/geronimo-stax-api_1.0_spec-1.0.jar",
+     "lib/ooxml-lib/xmlbeans-2.3.0.jar",
+     "lib/poi-3.6-20091214.jar",
+     "lib/poi-contrib-3.6-20091214.jar",
+     "lib/poi-examples-3.6-20091214.jar",
+     "lib/poi-ooxml-3.6-20091214.jar",
+     "lib/poi-ooxml-schemas-3.6-20091214.jar",
+     "lib/poi-scratchpad-3.6-20091214.jar",
+     "lib/poi.rb",
+     "lib/poi/workbook.rb",
+     "lib/poi/workbook/cell.rb",
+     "lib/poi/workbook/row.rb",
+     "lib/poi/workbook/workbook.rb",
+     "lib/poi/workbook/worksheet.rb",
+     "spec_debug.sh",
+     "specs/data/simple_with_picture.ods",
+     "specs/data/simple_with_picture.xls",
+     "specs/data/various_samples.xlsx",
+     "specs/io_spec.rb",
+     "specs/spec_helper.rb",
+     "specs/support/matchers/cell_matcher.rb",
+     "specs/workbook_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/sdeming/jruby-poi}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Apache POI class library for jruby}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/poi/workbook/cell.rb

@@ -22,21 +22,74 @@ module POI
   end
 
   class Cell
+    CELL              = Java::org.apache.poi.ss.usermodel.Cell
+    CELL_VALUE        = Java::org.apache.poi.ss.usermodel.CellValue
+    CELL_TYPE_BLANK   = CELL::CELL_TYPE_BLANK
+    CELL_TYPE_BOOLEAN = CELL::CELL_TYPE_BOOLEAN
+    CELL_TYPE_ERROR   = CELL::CELL_TYPE_ERROR
+    CELL_TYPE_FORMULA = CELL::CELL_TYPE_FORMULA
+    CELL_TYPE_NUMERIC = CELL::CELL_TYPE_NUMERIC
+    CELL_TYPE_STRING  = CELL::CELL_TYPE_STRING
+    
     def initialize(cell)
       @cell = cell
     end
+    
+    def value
+      value_of(cell_value_for_type(@cell.getCellType))
+    end
+    
+    def comment
+      @cell.getCellComment
+    end
 
     def index
       @cell.getColumnIndex 
     end    
 
-    def to_s
-      @cell.getStringCellValue
+    def to_s(evaluate_formulas=true)
+      if @cell.getCellType == CELL_TYPE_FORMULA
+        evaluate_formulas ? value.to_s : @cell.getCellFormula
+      else
+        value.to_s
+      end
     end
 
     def poi_cell
       @cell
     end
+    
+    private
+      def value_of(cell_value)
+        case cell_value.getCellType
+        when CELL_TYPE_BLANK: nil
+        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
+            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}]"
+        end
+      end
+      
+      def cell_value_for_type(cell_type)
+        case cell_type
+        when CELL_TYPE_BLANK: nil
+        when CELL_TYPE_BOOLEAN: CELL_VALUE.valueOf(@cell.getBooleanCellValue)
+        when CELL_TYPE_FORMULA
+          formula_evaluator = Java::org.apache.poi.xssf.usermodel.XSSFFormulaEvaluator.new @cell.sheet.workbook
+          formula_evaluator.evaluate @cell
+        when CELL_TYPE_STRING: CELL_VALUE.new(@cell.getStringCellValue)
+        when CELL_TYPE_ERROR, CELL_TYPE_NUMERIC: CELL_VALUE.new(@cell.getNumericCellValue)
+        else
+          raise "unhandled cell type[#{@cell.getCellType}]"
+        end
+      end
   end
 end
 

data/lib/poi/workbook/row.rb

@@ -25,6 +25,10 @@ module POI
     def initialize(row)
       @row = row
     end
+    
+    def [](index)
+      Cell.new(@row.getCell(index))
+    end
 
     def cells
       Cells.new(self)

data/lib/poi/workbook/workbook.rb

@@ -1,24 +1,35 @@
+require 'tmpdir'
+require 'stringio'
+
 module POI
   class Workbook
-    def self.open(filename)
-      raise Exception, "FileNotFound" unless File.exists? filename
-      instance = self.new(filename)
-
+    def self.open(filename_or_stream)
+      name, stream = if filename_or_stream.kind_of?(java.io.InputStream)
+        [File.join(Dir.tmpdir, "spreadsheet.xlsx"), filename_or_stream]
+      elsif filename_or_stream.kind_of?(IO) || StringIO === filename_or_stream || filename_or_stream.respond_to?(:read)
+        # NOTE: the String.unpack here can be very inefficient
+        [File.join(Dir.tmpdir, "spreadsheet.xlsx"), java.io.ByteArrayInputStream.new(filename_or_stream.read.unpack('c*').to_java(:byte))]
+      else
+        raise Exception, "FileNotFound" unless File.exists?( filename_or_stream )
+        [filename_or_stream, java.io.FileInputStream.new(filename_or_stream)]
+      end
+      instance = self.new(name, stream)
       if block_given?
         result = yield instance
         return result 
       end
-
       instance
     end
+    
+    attr_reader :filename
 
-    def initialize(filename)
+    def initialize(filename, io_stream)
       @filename = filename
-      @workbook = org.apache.poi.ss.usermodel.WorkbookFactory.create(java.io.FileInputStream.new(filename))
+      @workbook = org.apache.poi.ss.usermodel.WorkbookFactory.create(io_stream)
     end
 
     def save
-      @workbook.write(java.io.FileOutputStream.new(@filename))
+      save_as(@filename)
     end
 
     def save_as(filename)

data/spec_debug.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+#set -x
+RUBY_DIR=$(dirname $(which ruby))/..
+RUBYGEMS_DIR=${RUBY_DIR}/lib/ruby/gems/1.8/gems
+
+GEM_COLUMNIZE=$(ls -1d $RUBYGEMS_DIR/columnize*/lib | head -1 | /usr/bin/ruby -e 'print File.expand_path($stdin.read)')
+GEM_RUBY_DEBUG_BASE=$(ls -1d $RUBYGEMS_DIR/ruby-debug-base-*/lib | head -1 | /usr/bin/ruby -e 'print File.expand_path($stdin.read)')
+GEM_RUBY_DEBUG_CLI=$(ls -1d $RUBYGEMS_DIR/ruby-debug-*/cli | head -1 | /usr/bin/ruby -e 'print File.expand_path($stdin.read)')
+GEM_SOURCES=$(ls -1d $RUBYGEMS_DIR/sources-*/lib | head -1 | /usr/bin/ruby -e 'print File.expand_path($stdin.read)')
+
+runner="ruby --client \
+-I${GEM_COLUMNIZE} \
+-I${GEM_RUBY_DEBUG_BASE} \
+-I${GEM_RUBY_DEBUG_CLI} \
+-I${GEM_SOURCES} \
+-rubygems -S"
+
+cmd="spec -c --debugger $*"
+#cmd="irb"
+
+$runner $cmd

data/specs/spec_helper.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'poi'))
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
 
 class TestDataFile
   def self.expand_path(name)

data/specs/support/matchers/cell_matcher.rb

@@ -0,0 +1,17 @@
+Spec::Matchers.define :equal_at_cell do |expected, row, col|
+  match do |actual|
+    actual == expected
+  end
+
+  failure_message_for_should do |actual|
+    "expected #{actual} to equal #{expected} (row:#{row}, cell:#{col})"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected #{actual} not to equal #{expected} (row:#{row}, cell:#{col})"
+  end
+
+  description do
+    "to equal #{expected}"
+  end
+end

data/specs/workbook_spec.rb

@@ -1,35 +1,52 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'date'
+require 'stringio'
 
 describe POI::Workbook do
   it "should open a workbook and allow access to its worksheets" do
-    name = TestDataFile.expand_path("simple_with_picture.xlsx")
+    name = TestDataFile.expand_path("various_samples.xlsx")
     book = POI::Workbook.open(name)
+    book.worksheets.size.should == 4
+    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.filename.should =~ /spreadsheet.xlsx$/
+  end
 
-    book.worksheets.size.should == 3
+  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.filename.should =~ /spreadsheet.xlsx$/
   end
 end
 
 describe POI::Worksheets do
   it "should allow indexing worksheets by ordinal" do
-    name = TestDataFile.expand_path("simple_with_picture.xlsx")
+    name = TestDataFile.expand_path("various_samples.xlsx")
     book = POI::Workbook.open(name)
 
-    book.worksheets[0].name.should == "Sheet1"
-    book.worksheets[1].name.should == "Sheet2"
-    book.worksheets[2].name.should == "Sheet3"
+    book.worksheets[0].name.should == "text & pic"
+    book.worksheets[1].name.should == "numbers"
+    book.worksheets[2].name.should == "dates"
+    book.worksheets[3].name.should == "bools & errors"
   end
 
   it "should allow indexing worksheets by name" do
-    name = TestDataFile.expand_path("simple_with_picture.xlsx")
+    name = TestDataFile.expand_path("various_samples.xlsx")
     book = POI::Workbook.open(name)
 
-    book.worksheets["Sheet1"].name.should == "Sheet1"
-    book.worksheets["Sheet2"].name.should == "Sheet2"
-    book.worksheets["Sheet3"].name.should == "Sheet3"
+    book.worksheets["text & pic"].name.should == "text & pic"
+    book.worksheets["numbers"].name.should == "numbers"
+    book.worksheets["dates"].name.should == "dates"
   end
 
   it "should be enumerable" do
-    name = TestDataFile.expand_path("simple_with_picture.xlsx")
+    name = TestDataFile.expand_path("various_samples.xlsx")
     book = POI::Workbook.open(name)
     book.worksheets.should be_kind_of Enumerable
 
@@ -37,32 +54,43 @@ describe POI::Worksheets do
       sheet.should be_kind_of POI::Worksheet
     end
 
-    book.worksheets.size.should == 3
-    book.worksheets.collect.size.should == 3
+    book.worksheets.size.should == 4
+    book.worksheets.collect.size.should == 4
   end
 end
 
 describe POI::Rows do
   it "should be enumerable" do
-    name = TestDataFile.expand_path("simple_with_picture.xlsx")
+    name = TestDataFile.expand_path("various_samples.xlsx")
     book = POI::Workbook.open(name)
-    sheet = book.worksheets["Sheet1"]
+    sheet = book.worksheets["text & pic"]
     sheet.rows.should be_kind_of Enumerable
     
     sheet.rows.each do |row|
       row.should be_kind_of POI::Row
     end
 
-    sheet.rows.size.should == 6
-    sheet.rows.collect.size.should == 6
+    sheet.rows.size.should == 7
+    sheet.rows.collect.size.should == 7
   end
 end
 
 describe POI::Cells do
+  before :each do
+    @name = TestDataFile.expand_path("various_samples.xlsx")
+    @book = POI::Workbook.open(@name)
+  end
+
+  def book
+    @book
+  end
+
+  def name
+    @name
+  end
+  
   it "should be enumerable" do
-    name = TestDataFile.expand_path("simple_with_picture.xlsx")
-    book = POI::Workbook.open(name)
-    sheet = book.worksheets["Sheet1"]
+    sheet = book.worksheets["text & pic"]
     rows = sheet.rows
     cells = rows[0].cells
 
@@ -71,18 +99,125 @@ describe POI::Cells do
     cells.collect.size.should == 1
   end
 
+  it "should provide dates for date cells" do
+    sheet = book.worksheets["dates"]
+    rows = sheet.rows
+    
+    dates_by_column = [
+      (Date.parse('2010-02-28')..Date.parse('2010-03-14')),
+      (Date.parse('2010-03-14')..Date.parse('2010-03-28')),
+      (Date.parse('2010-03-28')..Date.parse('2010-04-11'))]
+    (0..2).each do |col|
+      dates_by_column[col].each_with_index do |date, index|
+        row = index + 1
+        rows[row][col].value.should equal_at_cell(date, row, col)
+      end
+    end
+  end
+
+  it "should provide numbers for numeric cells" do
+    sheet = book.worksheets["numbers"]
+    rows = sheet.rows
+    
+    (1..15).each do |number|
+      row = number
+      rows[row][0].value.should equal_at_cell(number,            row, 0)
+      rows[row][1].value.should equal_at_cell(number ** 2,       row, 1)
+      rows[row][2].value.should equal_at_cell(number ** 3,       row, 2)
+      rows[row][3].value.should equal_at_cell(Math.sqrt(number), row, 3)
+    end
+    
+    rows[9][0].to_s.should == '9.0'
+    rows[9][1].to_s.should == '81.0'
+    rows[9][2].to_s.should == '729.0'
+    rows[9][3].to_s.should == '3.0'
+  end
+
+  it "should provide error text for error cells" do
+    sheet = book.worksheets["bools & errors"]
+    rows = sheet.rows
+
+    rows[6][0].value.should == '~CIRCULAR~REF~'
+    rows[7][0].value.should == '#DIV/0!'
+    rows[8][0].value.should == '#N/A'
+    rows[9][0].value.should == '#NAME?'
+    rows[10][0].value.should == '#NULL!'
+    rows[11][0].value.should == '#NUM!'
+    rows[12][0].value.should == '#REF!'
+    rows[13][0].value.should == '#VALUE!'
+    lambda{ rows[14][0].value }.should raise_error(Java::java.lang.RuntimeException)
+    
+    rows[6][0].to_s.should == '~CIRCULAR~REF~'
+    rows[7][0].to_s.should == '#DIV/0!'
+    rows[8][0].to_s.should == '#N/A'
+    rows[9][0].to_s.should == '#NAME?'
+    rows[10][0].to_s.should == '#NULL!'
+    rows[11][0].to_s.should == '#NUM!'
+    rows[12][0].to_s.should == '#REF!'
+    rows[13][0].to_s.should == '#VALUE!'
+    lambda{ rows[14][0].to_s }.should raise_error(Java::java.lang.RuntimeException)
+  end
+
+  it "should provide booleans for boolean cells" do
+    sheet = book.worksheets["bools & errors"]
+    rows = sheet.rows
+    rows[1][0].value.should == false
+    rows[1][0].to_s.should == 'false'
+    
+    rows[1][1].value.should == false
+    rows[1][1].to_s.should == 'false'
+    
+    rows[2][0].value.should == true
+    rows[2][0].to_s.should == 'true'
+    
+    rows[2][1].value.should == true
+    rows[2][1].to_s.should == 'true'
+  end
+
   it "should provide the cell value as a string" do
-    name = TestDataFile.expand_path("simple_with_picture.xlsx")
-    book = POI::Workbook.open(name)
-    sheet = book.worksheets["Sheet1"]
+    sheet = book.worksheets["text & pic"]
+    rows = sheet.rows
+
+    rows[0][0].value.should == "This"
+    rows[1][0].value.should == "is"
+    rows[2][0].value.should == "an"
+    rows[3][0].value.should == "Excel"
+    rows[4][0].value.should == "XLSX"
+    rows[5][0].value.should == "workbook"
+    rows[9][0].value.should == 'This is an Excel XLSX workbook.'
+    
+
+    rows[0][0].to_s.should == "This"
+    rows[1][0].to_s.should == "is"
+    rows[2][0].to_s.should == "an"
+    rows[3][0].to_s.should == "Excel"
+    rows[4][0].to_s.should == "XLSX"
+    rows[5][0].to_s.should == "workbook"
+    rows[9][0].to_s.should == 'This is an Excel XLSX workbook.'
+  end
+  
+  it "should provide formulas instead of string-ified values" do
+    sheet = book.worksheets["numbers"]
     rows = sheet.rows
 
-    rows[0].cells[0].to_s.should == "This"
-    rows[1].cells[0].to_s.should == "is"
-    rows[2].cells[0].to_s.should == "an"
-    rows[3].cells[0].to_s.should == "Excel"
-    rows[4].cells[0].to_s.should == "XLSX"
-    rows[5].cells[0].to_s.should == "workbook"
+    (1..15).each do |number|
+      row = number
+      rows[row][0].to_s(false).should == "#{number}.0"
+      rows[row][1].to_s(false).should == "A#{row + 1}*A#{row + 1}"
+      rows[row][2].to_s(false).should == "B#{row + 1}*A#{row + 1}"
+      rows[row][3].to_s(false).should == "SQRT(A#{row + 1})"
+    end
+
+    sheet = book.worksheets["bools & errors"]
+    rows = sheet.rows
+    rows[1][0].to_s(false).should == '1=2'
+    rows[1][1].to_s(false).should == 'FALSE'
+    rows[2][0].to_s(false).should == '1=1'
+    rows[2][1].to_s(false).should == 'TRUE'
+    rows[14][0].to_s(false).should == 'foobar(1)'
+    
+    sheet = book.worksheets["text & pic"]
+    sheet.rows[9][0].to_s(false).should == 'CONCATENATE(A1," ", A2," ", A3," ", A4," ", A5," ", A6,".")'
   end
 end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
     - 0
-    - 1
+    - 4
     - 0
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors: 
   - Scott Deming
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-27 00:00:00 -04:00
+date: 2010-08-27 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -34,6 +34,7 @@ files:
   - README.markdown
   - Rakefile
   - VERSION
+  - jruby-poi.gemspec
   - lib/ooxml-lib/dom4j-1.6.1.jar
   - lib/ooxml-lib/geronimo-stax-api_1.0_spec-1.0.jar
   - lib/ooxml-lib/xmlbeans-2.3.0.jar
@@ -49,11 +50,13 @@ files:
   - lib/poi/workbook/row.rb
   - lib/poi/workbook/workbook.rb
   - lib/poi/workbook/worksheet.rb
+  - spec_debug.sh
   - specs/data/simple_with_picture.ods
   - specs/data/simple_with_picture.xls
-  - specs/data/simple_with_picture.xlsx
+  - specs/data/various_samples.xlsx
   - specs/io_spec.rb
   - specs/spec_helper.rb
+  - specs/support/matchers/cell_matcher.rb
   - specs/workbook_spec.rb
 has_rdoc: true
 homepage: http://github.com/sdeming/jruby-poi