jruby-poi 0.6.1 → 0.7.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'rspec'
+  gem 'ruby-debug'
+end

data/Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4-java)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  rspec
+  ruby-debug

data/README.markdown

@@ -1,4 +1,4 @@
-[jruby-poi](http://github.com/sdeming/jruby-poi)
+[jruby-poi](http://github.com/kameeoze/jruby-poi)
 =========
 
 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.
@@ -20,6 +20,7 @@ It's pretty simple really, create a POI::Workbook and access its sheets, rows, a
     # 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
@@ -40,6 +41,20 @@ It's pretty simple really, create a POI::Workbook and access its sheets, rows, a
     workbook.sheets['Sheet 1'][2][2]  # => 'C'
     workbook['Sheet 1'][2][2]         # => 'C'
 
+    # you can access a cell in 3D cell format too
+    workbook['Sheet 1!A1']            # => 4.0
+
+    # you can even refer to ranges of cells
+    workbook['Sheet 1!A1:A3']         # => [4.0, 3.0, 2.0]
+
+    # if cells E1 - E4 were a named range, you could refer to those cells by its name
+    # eg. if the cells were named "dates"...
+    workbook['dates']                 # => dates from E1 - E4
+
+    # to get the Cell instance, instead of its value, just use the Workbook#cell method
+    workbook.cell('dates')            # => cells that contain dates from E1 to E4
+    workbook['Sheet 1!A1:A3']         # => cells that contain 4.0, 3.0, and 2.0
+
 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

data/Rakefile

@@ -1,5 +1,6 @@
 begin
   require 'jeweler'
+  
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "jruby-poi"
     gemspec.summary = "Apache POI class library for jruby"
@@ -12,3 +13,24 @@ rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"
 end
 
+begin
+  require 'rspec/core/rake_task'
+  task :default => :spec
+
+  desc "Run all examples"
+  RSpec::Core::RakeTask.new do |t|
+    t.pattern = 'specs/**/*.rb'
+    t.rspec_opts = ['-c']
+  end
+
+  desc "Run all examples with RCov"
+  RSpec::Core::RakeTask.new(:coverage) do |t|
+    t.pattern = 'specs/**/*.rb'
+    t.rspec_opts = ['-c']
+    t.rcov = true
+    t.rcov_opts = ['--include', '/lib/', '--exclude', '/gems/,/^specs/,/^.eval.$/']
+  end
+rescue
+  puts $!.message
+  puts "RCov not available. Install it with: gem install rcov (--no-rdoc --no-ri)"
+end

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.7.1

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env jruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env jruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env jruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/rdebug

@@ -0,0 +1,16 @@
+#!/usr/bin/env jruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rdebug' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('ruby-debug', 'rdebug')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env jruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/jruby-poi.gemspec

@@ -1,72 +1,84 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{jruby-poi}
-  s.version = "0.6.1"
+  s.version = "0.7.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Scott Deming", "Jason Rogers"]
-  s.date = %q{2010-09-01}
+  s.date = %q{2011-03-27}
   s.description = %q{A rubyesque library for manipulating spreadsheets and other document types for jruby, using Apache POI.}
   s.email = ["sdeming@makefile.com", "jacaetevha@gmail.com"]
+  s.executables = ["autospec", "htmldiff", "ldiff", "rdebug", "rspec"]
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.markdown"
+    "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/area.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",
-     "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"
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "NOTICE",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "bin/autospec",
+    "bin/htmldiff",
+    "bin/ldiff",
+    "bin/rdebug",
+    "bin/rspec",
+    "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/area.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",
+    "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",
+    "specs/writing_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.rubygems_version = %q{1.6.0}
   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
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
     else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
   end
 end
 

data/lib/poi/workbook.rb

@@ -1,3 +1,19 @@
+module POI
+  AREA_REF = org.apache.poi.ss.util.AreaReference
+  CELL_REF = org.apache.poi.ss.util.CellReference
+  
+  def self.Facade(delegate, java_class)
+    cls = Class.new
+    java_class.java_class.java_instance_methods.select{|e| e.public?}.each do | method |
+      args = method.arity.times.collect{|i| "arg#{i}"}.join(", ")
+      method_name = method.name.gsub(/([A-Z])/){|e| "_#{e.downcase}"}
+      code = "def #{method_name}(#{args}); #{delegate}.#{method.name}(#{args}); end"
+      cls.class_eval(code, __FILE__, __LINE__)
+    end
+    cls
+  end
+end
+
 require File.join(JRUBY_POI_LIB_PATH, 'poi', 'workbook', 'area')
 require File.join(JRUBY_POI_LIB_PATH, 'poi', 'workbook', 'named_range')
 require File.join(JRUBY_POI_LIB_PATH, 'poi', 'workbook', 'workbook')

data/lib/poi/workbook/area.rb

@@ -5,20 +5,77 @@ module POI
     end
     
     def in workbook
+      if single_cell_reference?
+        ref = area.all_referenced_cells.first
+        return [workbook.single_cell ref]
+      end
+      
       begin
-        area.getAllReferencedCells.collect{|c| workbook.cell c.formatAsString}
+        by_column = {}
+        # refs = area.all_referenced_cells
+        # slices = refs.enum_slice(refs.length/15)
+        # slices.collect do |cell_refs|
+        #   Thread.start do
+        #     cell_refs.each do |cell_ref|
+        #       first = workbook.worksheets[cell_ref.sheet_name].first_row
+        #       last  = workbook.worksheets[cell_ref.sheet_name].last_row
+        #       next unless cell_ref.row >= first && cell_ref.row <= last
+        # 
+        #       # ref = POI::CELL_REF.new(c.format_as_string)
+        #       cell = workbook.single_cell cell_ref
+        #       (by_column[cell_ref.cell_ref_parts.collect.last] ||= []) << cell
+        #     end
+        #   end
+        # end.each {|t| t.join}
+
+        area.all_referenced_cells.each do |cell_ref|
+          first = workbook.worksheets[cell_ref.sheet_name].first_row
+          last  = workbook.worksheets[cell_ref.sheet_name].last_row
+          next unless cell_ref.row >= first && cell_ref.row <= last
+        
+          # ref = POI::CELL_REF.new(c.format_as_string)
+          cell = workbook.single_cell cell_ref
+          (by_column[cell_ref.cell_ref_parts.collect.last] ||= []) << cell
+        end
+                
+        by_column.each do |key, cells|
+          by_column[key] = cells.compact
+        end
+        
+        if by_column.length == 1
+          by_column.values.flatten
+        else
+          by_column
+        end
       rescue
         []
       end
     end
     
     def single_cell_reference?
-      @ref == area.getFirstCell.formatAsString
+      area.single_cell? #@ref == getFirstCell.formatAsString rescue false
     end
     
     private
       def area
-        @area ||= org.apache.poi.ss.util.AreaReference.new(@ref)
+        @area ||= new_area_reference
+      end
+      
+      def new_area_reference
+        begin
+          return POI::AREA_REF.new(@ref)
+        rescue
+          # not a valid reference, so proceed through to see if it's a column-based reference
+        end
+        sheet_parts = @ref.split('!')
+        area_parts  = sheet_parts.last.split(':')
+        area_start  = "#{sheet_parts.first}!#{area_parts.first}"
+        area_end    = area_parts.last
+        begin
+          POI::AREA_REF.getWholeColumn(area_start, area_end)
+        rescue
+          raise "could not determine area reference for #{@ref}: #{$!.message}"
+        end
       end
   end
 end

data/lib/poi/workbook/cell.rb

@@ -3,25 +3,27 @@ module POI
     include Enumerable
 
     def initialize(row)
-      @row = row
+      @row     = row
       @poi_row = row.poi_row
+      @cells   = {}
     end
 
     def [](index)
-      Cell.new(@poi_row.getCell(index))
+      @cells[index] ||= Cell.new(@poi_row.cell(index) || @poi_row.create_cell(index), @row)
     end
 
     def size
-      @poi_row.getPhysicalNumberOfCells
+      @poi_row.physical_number_of_cells
     end
 
     def each
-      it = @poi_row.cellIterator
-      yield Cell.new(it.next) while it.hasNext
+      it = @poi_row.cell_iterator
+      yield Cell.new(it.next, @row) while it.has_next
     end
   end
 
-  class Cell
+  class Cell < Facade(:poi_cell, org.apache.poi.ss.usermodel.Cell)
+    DATE_UTIL         = Java::org.apache.poi.ss.usermodel.DateUtil
     CELL              = Java::org.apache.poi.ss.usermodel.Cell
     CELL_VALUE        = Java::org.apache.poi.ss.usermodel.CellValue
     CELL_TYPE_BLANK   = CELL::CELL_TYPE_BLANK
@@ -31,19 +33,27 @@ module POI
     CELL_TYPE_NUMERIC = CELL::CELL_TYPE_NUMERIC
     CELL_TYPE_STRING  = CELL::CELL_TYPE_STRING
     
-    def initialize(cell)
+    def initialize(cell, row)
       @cell = cell
+      @row  = row
+    end
+    
+    def <=> other
+      return 1 if other.nil?
+      return self.index <=> other.index
     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
-      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))
+      if poi_cell.cell_type == CELL_TYPE_ERROR
+        error_value_from(poi_cell.error_cell_value)
+      elsif poi_cell.cell_type == CELL_TYPE_FORMULA && 
+            poi_cell.cached_formula_result_type == CELL_TYPE_ERROR
+            
+        # breaks Law of Demeter by reaching into the Row's Worksheet, but it makes sense to do in this case
+        value_of(@row.worksheet.workbook.formula_evaluator.evaluate(poi_cell))
       else
         nil
       end
@@ -51,20 +61,40 @@ module POI
     
     # 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
+      poi_cell.cell_type == CELL_TYPE_FORMULA ? poi_cell.cell_formula : nil
     end
     
     def value
       return nil if poi_cell.nil?
-      value_of(cell_value_for_type(poi_cell.getCellType))
+      value_of(cell_value_for_type(poi_cell.cell_type))
     end
-    
+
+    def formula= new_value
+      poi_cell.cell_formula = new_value
+      @row.worksheet.workbook.on_formula_update self
+      self
+    end
+
+    def formula
+      poi_cell.cell_formula
+    end
+
+    def value= new_value
+      set_cell_value new_value
+      if new_value.nil?
+        @row.worksheet.workbook.on_delete self
+      else
+        @row.worksheet.workbook.on_update self
+      end
+      self
+    end
+
     def comment
-      poi_cell.getCellComment
+      poi_cell.cell_comment
     end
 
     def index
-      poi_cell.getColumnIndex 
+      poi_cell.column_index 
     end    
 
     # Get the String representation of this Cell's value.
@@ -74,7 +104,7 @@ module POI
     def to_s(evaluate_formulas=true)
       return '' if poi_cell.nil?
 
-      if poi_cell.getCellType == CELL_TYPE_FORMULA && evaluate_formulas == false
+      if poi_cell.cell_type == CELL_TYPE_FORMULA && evaluate_formulas == false
         formula_value
       else
         value.to_s
@@ -86,23 +116,26 @@ module POI
       @cell
     end
     
+    def style= a_style
+      set_cell_style a_style
+    end
+    
+    def style! options
+      self.style = @row.worksheet.workbook.create_style(options)
+    end
+    
     private
       def value_of(cell_value)
         return nil if cell_value.nil?
         
-        case cell_value.getCellType
+        case cell_value.cell_type
         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 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
+        when CELL_TYPE_BOOLEAN: cell_value.boolean_value
+        when CELL_TYPE_ERROR: error_value_from(cell_value.error_value)
+        when CELL_TYPE_NUMERIC: numeric_value_from(cell_value)
+        when CELL_TYPE_STRING: cell_value.string_value
         else
-          raise "unhandled cell type[#{cell_value.getCellType}]"
+          raise "unhandled cell type[#{cell_value.cell_type}]"
         end
       end
       
@@ -111,17 +144,33 @@ module POI
         begin
           case cell_type
           when CELL_TYPE_BLANK: nil
-          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)
+          when CELL_TYPE_BOOLEAN: CELL_VALUE.value_of(poi_cell.boolean_cell_value)
+          when CELL_TYPE_FORMULA: cell_value_for_type(poi_cell.cached_formula_result_type)
+          when CELL_TYPE_STRING: CELL_VALUE.new(poi_cell.string_cell_value)
+          when CELL_TYPE_ERROR, CELL_TYPE_NUMERIC: CELL_VALUE.new(poi_cell.numeric_cell_value)
           else
-            raise "unhandled cell type[#{poi_cell.getCellType}]"
+            raise "unhandled cell type[#{poi_cell.cell_type}]"
           end
         rescue
           nil
         end
       end
+      
+      def error_value_from(cell_value)
+        org.apache.poi.ss.usermodel.ErrorConstants.text(cell_value)
+      end
+      
+      def formula_evaluator_for(workbook)
+        workbook.creation_helper.create_formula_evaluator
+      end
+      
+      def numeric_value_from(cell_value)
+        if DATE_UTIL.cell_date_formatted(poi_cell)
+          Date.parse(DATE_UTIL.get_java_date(cell_value.number_value).to_s)
+        else
+          cell_value.number_value
+        end
+      end
   end
 end