jruby-poi 0.4.0 → 0.5.0

data/README.markdown

@@ -1,13 +1,53 @@
 jruby-poi
 =========
 
-This little gem provides an alternative interface to the Apache POI java library, for jruby.
+This little gem provides an alternative interface to the Apache POI java library, for JRuby. For now the API is targeted at wrapping spreadsheets. We may expand this in the future.
 
-INSTALL:
-========
+INSTALL
+=======
 
 * gem install jruby-poi
 
+USAGE
+=====
+It's pretty simple really, create a POI::Workbook and access its sheets, rows, and cells. You can read from the spreadsheet, save it (as the filename with which you created or as a new spreadsheet via Workbook#save_as).
+
+    require 'poi'
+
+    # given an Excel spreadsheet whose first sheet (Sheet 1) has this data:
+    #    A  B  C  D  E        
+    # 1  4     A     2010-01-04
+    # 2  3     B     =DATE(YEAR($E$1), MONTH($E$1), A2)
+    # 3  2     C     =DATE(YEAR($E$1), MONTH($E$1), A3)
+    # 4  1     D     =DATE(YEAR($E$1), MONTH($E$1), A4)
+    workbook = POI::Workbook.open('spreadsheet.xlsx')
+    sheet = workbook.worksheets["Sheet 1"]
+    rows  = sheet.rows
+  
+    # get a cell's value -- returns the value as its proper type, evaluating formulas if need be
+    rows[0][0].value # => 4.0
+    rows[0][1].value # => nil
+    rows[0][2].value # => 'A'
+    rows[0][3].value # => nil
+    rows[0][4].value # => 2010-01-04 as a Date instance
+    rows[1][4].value # => 2010-01-03 as a Date instance
+    rows[2][4].value # => 2010-01-02 as a Date instance
+    rows[3][4].value # => 2010-01-01 as a Date instance
+    
+    # you can access a cell in array style as well... these snippets are all equivalent
+    workbook.sheets[0][2][2]          # => 'C'
+    workbook[0][2][2]                 # => 'C'
+    workbook.sheets['Sheet 1'][2][2]  # => 'C'
+    workbook['Sheet 1'][2][2]         # => 'C'
+
+There's a formatted version of this code [here](http://gist.github.com/557607), but Github doesn't allow embedding script tags in Markdown. Go figure!
+
+TODO
+====
+* fix reading ODS files -- we have a broken spec for this in io_spec.rb
+* add APIs for updating cells in a spreadsheet
+* create API for non-spreadsheet files
+
 Contributors
 ============
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/jruby-poi.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jruby-poi}
-  s.version = "0.4.0"
+  s.version = "0.5.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.date = %q{2010-08-30}
   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 = [
@@ -42,9 +42,12 @@ Gem::Specification.new do |s|
      "spec_debug.sh",
      "specs/data/simple_with_picture.ods",
      "specs/data/simple_with_picture.xls",
+     "specs/data/spreadsheet.ods",
      "specs/data/various_samples.xlsx",
      "specs/io_spec.rb",
      "specs/spec_helper.rb",
+     "specs/support/java/jrubypoi/MockOutputStream.java",
+     "specs/support/java/support.jar",
      "specs/support/matchers/cell_matcher.rb",
      "specs/workbook_spec.rb"
   ]

data/lib/poi/workbook/cell.rb

@@ -36,6 +36,7 @@ module POI
     end
     
     def value
+      return nil if @cell.nil?
       value_of(cell_value_for_type(@cell.getCellType))
     end
     
@@ -61,6 +62,8 @@ module POI
     
     private
       def value_of(cell_value)
+        return nil if cell_value.nil?
+        
         case cell_value.getCellType
         when CELL_TYPE_BLANK: nil
         when CELL_TYPE_BOOLEAN: cell_value.getBooleanValue

data/lib/poi/workbook/workbook.rb

@@ -7,7 +7,7 @@ module POI
       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
+        # NOTE: the String.unpack here can be very inefficient on large files
         [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 )
@@ -33,7 +33,16 @@ module POI
     end
 
     def save_as(filename)
-      @workbook.write(java.io.FileOutputStream.new(filename))
+      output = output_stream filename
+      begin
+        @workbook.write(output)
+      ensure
+        output.close
+      end
+    end
+    
+    def output_stream name
+      java.io.FileOutputStream.new(name)
     end
 
     def close
@@ -44,6 +53,10 @@ module POI
       Worksheets.new(self)
     end
 
+    def [](sheet_index)
+      worksheets[sheet_index]
+    end
+
     def poi_workbook
       @workbook
     end

data/lib/poi/workbook/worksheet.rb

@@ -38,6 +38,10 @@ module POI
     def rows
       Rows.new(self)
     end
+    
+    def [](row_index)
+      rows[row_index]
+    end
 
     def poi_worksheet
       @worksheet

data/specs/io_spec.rb

@@ -1,8 +1,28 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe POI::Workbook do
+  before :each do
+    @mock_output_stream = nil
+    class POI::Workbook
+      def mock_output_stream name
+        @mock_output_stream ||= Java::jrubypoi.MockOutputStream.new name
+        @mock_output_stream
+      end
+
+      alias_method :original_output_stream, :output_stream unless method_defined?(:original_output_stream)
+      alias_method :output_stream, :mock_output_stream
+    end
+  end
+
+  after :each do
+    @mock_output_stream = nil
+    class POI::Workbook
+      alias_method :output_stream, :original_output_stream
+    end
+  end
+
   it "should read an xlsx file" do 
-    name = TestDataFile.expand_path("simple_with_picture.xlsx")
+    name = TestDataFile.expand_path("various_samples.xlsx")
     book = nil
     lambda { book = POI::Workbook.open(name) }.should_not raise_exception
     book.should be_kind_of POI::Workbook
@@ -16,35 +36,34 @@ describe POI::Workbook do
   end
 
   it "should read an ods file" do 
-    pending "get a valid, non excel produced ods file" do
-      name = TestDataFile.expand_path("simple_with_picture.ods")
-      book = nil
-      lambda { book = POI::Workbook.open(name) }.should_not raise_exception
-      book.should be_kind_of POI::Workbook
-    end
+    name = TestDataFile.expand_path("spreadsheet.ods")
+    book = nil
+    lambda { book = POI::Workbook.open(name) }.should_not raise_exception
+    book.should be_kind_of POI::Workbook
   end
 
   it "should write an open workbook" do
-    name = TestDataFile.expand_path("simple_with_picture.xlsx")
+    name = TestDataFile.expand_path("various_samples.xlsx")
     POI::Workbook.open(name) do |book|
       lambda { book.save }.should_not raise_exception
+      verify_mock_output_stream book.instance_variable_get("@mock_output_stream"), name
     end
   end
 
   it "should write an open workbook to a new file" do
-    pending "write to a temp directory to avoid git polution" do
-      name = TestDataFile.expand_path("simple_with_picture.xlsx")
-      new_name = TestDataFile.expand_path("saved-as.xlsx")
+    name = TestDataFile.expand_path("various_samples.xlsx")
+    new_name = TestDataFile.expand_path("saved-as.xlsx")
 
-      POI::Workbook.open(name) do |book|
-        lambda { book.save_as(new_name) }.should_not raise_exception
-      end
-      
-      book = nil
-      lambda { book = POI::Workbook.open(new_name) }.should_not raise_exception
-      book.should be_kind_of POI::Workbook
-      
-      File.exists?(new_name).should == true
+    POI::Workbook.open(name) do |book|
+      @mock_output_stream.should be_nil
+      lambda { book.save_as(new_name) }.should_not raise_exception
+      verify_mock_output_stream book.instance_variable_get("@mock_output_stream"), new_name
     end
   end
+  
+  def verify_mock_output_stream mock_output_stream, name
+    mock_output_stream.should_not be_nil
+    name.should == mock_output_stream.name
+    true.should == mock_output_stream.write_called
+  end
 end

data/specs/spec_helper.rb

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

data/specs/support/java/jrubypoi/MockOutputStream.java

@@ -0,0 +1,24 @@
+package jrubypoi;
+import java.io.*;
+
+public class MockOutputStream extends OutputStream {
+  public String name;
+  public boolean write_called;
+  
+  public MockOutputStream(String name) {
+    this.name = name;
+    this.write_called = false;
+  }
+  
+  public void write(int b) throws IOException {
+    this.write_called = true;
+  }
+
+  public void write(byte[] b) throws IOException {
+    this.write_called = true;
+  }
+
+  public void write(byte[] b, int offset, int length) throws IOException {
+    this.write_called = true;
+  }
+}

data/specs/workbook_spec.rb

@@ -133,6 +133,19 @@ 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'
+    book[1][9][2].to_s.should == '729.0'
+    book[1][9][3].to_s.should == '3.0'
+
+    book["numbers"][9][0].to_s.should == '9.0'
+    book["numbers"][9][1].to_s.should == '81.0'
+    book["numbers"][9][2].to_s.should == '729.0'
+    book["numbers"][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
@@ -219,5 +232,11 @@ describe POI::Cells do
     sheet = book.worksheets["text & pic"]
     sheet.rows[9][0].to_s(false).should == 'CONCATENATE(A1," ", A2," ", A3," ", A4," ", A5," ", A6,".")'
   end
+  
+  it "should handle getting values out of 'non-existent' cells" do
+    sheet = book.worksheets["bools & errors"]
+    sheet.rows[14][2].value.should be_nil
+  end
+
 end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
     - 0
-    - 4
+    - 5
     - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
   - Scott Deming
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-27 00:00:00 -04:00
+date: 2010-08-30 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -53,9 +53,12 @@ files:
   - spec_debug.sh
   - specs/data/simple_with_picture.ods
   - specs/data/simple_with_picture.xls
+  - specs/data/spreadsheet.ods
   - specs/data/various_samples.xlsx
   - specs/io_spec.rb
   - specs/spec_helper.rb
+  - specs/support/java/jrubypoi/MockOutputStream.java
+  - specs/support/java/support.jar
   - specs/support/matchers/cell_matcher.rb
   - specs/workbook_spec.rb
 has_rdoc: true