xlsx_writer 0.3.2 → 0.4.0

data/lib/xlsx_writer/header_footer.rb

@@ -1,4 +1,4 @@
-module XlsxWriter
+class XlsxWriter
   class HeaderFooter
     attr_reader :header
     attr_reader :footer

data/lib/xlsx_writer/page_setup.rb

@@ -1,4 +1,4 @@
-module XlsxWriter
+class XlsxWriter
   class PageSetup
     DEFAULT = {
       :top            => 1.0,

data/lib/xlsx_writer/row.rb

@@ -1,36 +1,21 @@
-module XlsxWriter
+class XlsxWriter
   class Row
     attr_reader :sheet
     attr_reader :cells
-    attr_reader :width
+    attr_reader :y
     
-    def initialize(sheet, columns)
-      @width = {}
+    def initialize(sheet, raw_cells, y)
       @sheet = sheet
-      @cells = columns.map do |column|
-        Cell.new self, column
-      end
-    end
-    
-    def ndx
-      sheet.rows.index(self) + 1
-    end
-    
-    def length
-      cells.length
-    end
-    
-    def cell_width(x)
-      @width[x] ||= if (cell = cells[x])
-        cell.pixel_width
-      else
-        0
+      @y = y
+      @cells = []
+      raw_cells.each_with_index do |cell, x|
+        @cells << Cell.new(self, cell, x, y)
       end
     end
     
     def to_xml
       ary = []
-      ary << %{<row r="#{ndx}">}
+      ary << %{<row r="#{y}">}
       cells.each do |cell|
         ary << cell.to_xml
       end

data/lib/xlsx_writer/shared_strings.rb

@@ -0,0 +1,70 @@
+require 'digest/md5'
+
+class XlsxWriter
+  class SharedStrings
+    BUFSIZE = 131072 #128kb
+
+    attr_reader :document
+    attr_reader :path
+    attr_reader :indexes
+
+    def initialize(document)
+      @mutex = Mutex.new
+      @document = document
+      @indexes = {}
+      @path = File.join document.staging_dir, relative_path
+      FileUtils.mkdir_p File.dirname(path)
+      @strings_tmp_file_writer = File.open(strings_tmp_file_path, 'wb')
+    end
+
+    def relative_path
+      'xl/sharedstrings.xml'
+    end
+
+    def ndx(str)
+      @mutex.synchronize do
+        digest = Digest::MD5.digest str
+        unless ndx = indexes[digest]
+          ndx = indexes.length
+          indexes[digest] = ndx
+          @strings_tmp_file_writer.write %{<si><t>#{str.fast_xs}</t></si>}
+        end
+        ndx
+      end
+    end
+
+    def generated?
+      @generated == true
+    end
+
+    def generate
+      return if generated?
+      @mutex.synchronize do
+        return if generated?
+        @generated = true
+        @strings_tmp_file_writer.close
+        File.open(path, 'wb') do |f|
+          f.write <<-EOS
+<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
+<sst xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" count="#{indexes.length}" uniqueCount="#{indexes.length}">
+EOS
+          File.open(strings_tmp_file_path, 'rb') do |strings_tmp_file_reader|
+            buffer = ''
+            while strings_tmp_file_reader.read(BUFSIZE, buffer)
+              f.write buffer
+            end
+          end
+          f.write %{</sst>}
+        end
+        File.unlink strings_tmp_file_path
+      end
+    end
+
+    private
+
+    def strings_tmp_file_path
+      path + '.strings_tmp_file'
+    end
+
+  end
+end

data/lib/xlsx_writer/sheet.rb

@@ -0,0 +1,145 @@
+require 'fast_xs'
+
+class XlsxWriter
+  class Sheet
+    class << self
+      def excel_name(value)
+        str = value.to_s.dup
+        str.gsub! '/', ''   # remove forward slashes
+        str.gsub! /\s+/, '' # compress "inner" whitespace
+        str.strip!          # trim whitespace from ends
+        str.fast_xs
+      end
+    end
+
+    BUFSIZE = 131072 #128kb
+
+    attr_reader :document
+    attr_reader :name
+    attr_reader :ndx
+    attr_reader :autofilters
+    attr_reader :path
+    attr_reader :row_count
+    attr_reader :max_row_length
+    attr_reader :max_cell_pixel_width
+
+    # Freeze the pane under this top left cell
+    attr_accessor :freeze_top_left
+
+    def initialize(document, name, ndx)
+      @mutex = Mutex.new
+      @document = document
+      @ndx = ndx
+      @name = Sheet.excel_name name
+      @row_count = 0
+      @autofilters = []
+      @max_row_length = 1
+      @max_cell_pixel_width = Hash.new(Cell.pixel_width(5))
+      @path = ::File.join document.staging_dir, relative_path
+      ::FileUtils.mkdir_p ::File.dirname(path)
+      @rows_tmp_file_writer = ::File.open(rows_tmp_file_path, 'wb')
+    end
+
+    def generated?
+      @generated == true
+    end
+
+    def generate
+      return if generated?
+      @mutex.synchronize do
+        return if generated?
+        @generated = true
+        @rows_tmp_file_writer.close
+        File.open(path, 'wb') do |f|
+          f.write <<-EOS
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">
+EOS
+          if freeze_top_left
+            f.write <<-EOS
+<sheetViews>
+  <sheetView workbookViewId="0">
+    <pane ySplit="#{y_split}" topLeftCell="#{freeze_top_left}" activePane="topLeft" state="frozen"/>
+  </sheetView>
+</sheetViews>
+EOS
+          end
+          f.write %{<cols>}
+          (0..max_row_length-1).each do |x|
+            f.write %{<col min="#{x+1}" max="#{x+1}" width="#{max_cell_pixel_width[x]}" bestFit="1" customWidth="1" />}
+          end
+          f.write %{</cols>}
+          f.write %{<sheetData>}
+          File.open(rows_tmp_file_path, 'rb') do |rows_tmp_file_reader|
+            buffer = ''
+            while rows_tmp_file_reader.read(BUFSIZE, buffer)
+              f.write buffer
+            end
+          end
+          f.write %{</sheetData>}
+          autofilters.each { |autofilter| f.write autofilter.to_xml }
+          f.write document.page_setup.to_xml
+          f.write document.header_footer.to_xml
+          f.write %{</worksheet>}
+        end
+        File.unlink rows_tmp_file_path
+        converted = UnixUtils.unix2dos path
+        FileUtils.mv converted, path
+        SheetRels.new(document, self).generate
+      end
+    end
+    
+    def local_id
+      ndx - 1
+    end
+
+    # +1 because styles.xml occupies the first spot
+    def rid
+      "rId#{ndx + 1}"
+    end
+    
+    def relative_path
+      "xl/worksheets/sheet#{ndx}.xml"
+    end
+    
+    def absolute_path
+      "/#{relative_path}"
+    end
+
+    # specify range like "A1:C1"
+    def add_autofilter(range)
+      raise ::RuntimeError, "Can't add autofilter, already generated!" if generated?
+      autofilters << Autofilter.new(self, range)
+    end
+        
+    def add_row(cells)
+      raise ::RuntimeError, "Can't add row, already generated!" if generated?
+      @row_count += 1
+      row = Row.new self, cells, row_count
+      @rows_tmp_file_writer.write row.to_xml
+      if (l = row.cells.length) > max_row_length
+        @max_row_length = l
+      end
+      row.cells.each_with_index do |cell, x|
+        if (w = cell.pixel_width) > max_cell_pixel_width[x]
+          max_cell_pixel_width[x] = w
+        end
+      end
+      nil
+    end
+
+    private
+
+    def rows_tmp_file_path
+      path + '.rows_tmp_file'
+    end
+
+    def y_split
+      if freeze_top_left =~ /(\d+)$/
+        $1.to_i - 1
+      else
+        raise "freeze_top_left must be like 'A3', was #{freeze_top_left}"
+      end
+    end
+  end
+end

data/lib/xlsx_writer/version.rb

@@ -1,3 +1,3 @@
-module XlsxWriter
-  VERSION = '0.3.2'
+class XlsxWriter
+  VERSION = '0.4.0'
 end

data/lib/xlsx_writer/xml.rb

@@ -1,13 +1,21 @@
 require 'erb'
 require 'fileutils'
 
-module XlsxWriter
+class XlsxWriter
   class Xml
+    class << self
+      def auto
+        descendants.reject do |klass|
+          klass.const_defined?(:AUTO) and klass.const_get(:AUTO) == false
+        end
+      end
+    end
+    
     attr_reader :document
 
     def initialize(document)
+      @mutex = Mutex.new
       @document = document
-      @mutex = ::Mutex.new
     end
 
     def generate
@@ -36,7 +44,7 @@ module XlsxWriter
     end
         
     def template_path
-      ::File.expand_path "../generators/#{self.class.name.demodulize.underscore}.erb", __FILE__
+      ::File.expand_path "../xml/#{self.class.name.demodulize.underscore}.erb", __FILE__
     end
     
     def render

data/lib/xlsx_writer/{generators → xml}/app.rb

@@ -1,4 +1,4 @@
-module XlsxWriter
+class XlsxWriter
   class App < Xml
     def relative_path
       "docProps/app.xml"

data/lib/xlsx_writer/{generators → xml}/content_types.erb

@@ -11,4 +11,5 @@
   <Override PartName="<%= sheet.absolute_path %>" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml"/>
   <% end %>
   <Override PartName="/xl/styles.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml"/>
+  <Override PartName="/xl/sharedstrings.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml"/>
 </Types>

data/lib/xlsx_writer/{generators → xml}/content_types.rb

@@ -1,4 +1,4 @@
-module XlsxWriter
+class XlsxWriter
   class ContentTypes < Xml
     def relative_path
       "[Content_Types].xml"

data/lib/xlsx_writer/{generators → xml}/doc_props.rb

@@ -1,4 +1,4 @@
-module XlsxWriter
+class XlsxWriter
   class DocProps < Xml
     def relative_path
       "docProps/core.xml"

data/lib/xlsx_writer/{generators → xml}/image.rb

@@ -1,6 +1,6 @@
 require 'fileutils'
 
-module XlsxWriter
+class XlsxWriter
   class Image
     DEFAULT = {
       :croptop => 0,

data/lib/xlsx_writer/{generators → xml}/rels.rb

@@ -1,4 +1,4 @@
-module XlsxWriter
+class XlsxWriter
   class Rels < Xml
     def relative_path
       "_rels/.rels"

data/lib/xlsx_writer/{generators → xml}/sheet_rels.rb

@@ -1,4 +1,4 @@
-module XlsxWriter
+class XlsxWriter
   class SheetRels < Xml
 
     AUTO = false

data/lib/xlsx_writer/{generators → xml}/styles.rb

@@ -1,4 +1,4 @@
-module XlsxWriter
+class XlsxWriter
   class Styles < Xml
     def relative_path
       "xl/styles.xml"

data/lib/xlsx_writer/{generators → xml}/vml_drawing.rb

@@ -1,4 +1,4 @@
-module XlsxWriter
+class XlsxWriter
   class VmlDrawing < Xml
     def relative_path
       "xl/drawings/vmlDrawing1.vml"

data/lib/xlsx_writer/{generators → xml}/vml_drawing_rels.rb

@@ -1,4 +1,4 @@
-module XlsxWriter
+class XlsxWriter
   class VmlDrawingRels < Xml
     def relative_path
       "xl/drawings/_rels/vmlDrawing1.vml.rels"

data/lib/xlsx_writer/{generators → xml}/workbook.rb

@@ -1,4 +1,4 @@
-module XlsxWriter
+class XlsxWriter
   class Workbook < Xml
     def relative_path
       "xl/workbook.xml"

data/lib/xlsx_writer/{generators → xml}/workbook_rels.erb

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
+  <Relationship Id="rId0" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings" Target="sharedstrings.xml"/>
   <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" Target="/xl/styles.xml"/>
   <% document.sheets.each do |sheet| %>
   <Relationship Id="<%= sheet.rid %>" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet" Target="<%= sheet.absolute_path %>"/>

data/lib/xlsx_writer/{generators → xml}/workbook_rels.rb

@@ -1,4 +1,4 @@
-module XlsxWriter
+class XlsxWriter
   class WorkbookRels < Xml
     def relative_path
       "xl/_rels/workbook.xml.rels"

data/test/helper.rb

@@ -8,5 +8,7 @@ MiniTest::Unit.runner = MiniTest::SuiteRunner.new
 MiniTest::Unit.runner.reporters << MiniTest::Reporters::SpecReporter.new
 
 require 'remote_table'
+require 'bigdecimal'
+require 'decimal'
 
 require 'xlsx_writer'

data/test/test_xlsx_writer.rb

@@ -12,7 +12,7 @@ describe XlsxWriter do
       @sheet1.add_row(['negative', false])
     end
     after do
-      @doc.cleanup
+      @doc.try :cleanup
     end
     it "returns a path to an xlsx" do
       File.exist?(@doc.path).must_equal true
@@ -51,25 +51,26 @@ describe XlsxWriter do
   end
 
   describe "quiet booleans" do
-    before do
-      @doc = XlsxWriter::Document.new
-      @sheet1 = @doc.add_sheet("QuietBooleans")
-      @sheet1.add_row(['affirmative', 'negative'])
-      @sheet1.add_row([true, false])
-    end
-    after do
-      @doc.cleanup
-    end
     it "shows TRUE or FALSE for booleans by default" do
-      t = RemoteTable.new(@doc.path, :format => :xlsx)
+      doc = XlsxWriter::Document.new
+      sheet1 = doc.add_sheet("QuietBooleans")
+      sheet1.add_row(['affirmative', 'negative'])
+      sheet1.add_row([true, false])
+      t = RemoteTable.new(doc.path, :format => :xlsx)
       t[0]['affirmative'].must_equal 'TRUE'
       t[0]['negative'].must_equal 'FALSE'
+      doc.cleanup
     end
     it "shows TRUE or blank for false if quiet booleans is enabled" do
-      @doc.quiet_booleans!
-      t = RemoteTable.new(@doc.path, :format => :xlsx)
+      doc = XlsxWriter::Document.new
+      doc.quiet_booleans!
+      sheet1 = doc.add_sheet("QuietBooleans")
+      sheet1.add_row(['affirmative', 'negative'])
+      sheet1.add_row([true, false])
+      t = RemoteTable.new(doc.path, :format => :xlsx)
       t[0]['affirmative'].must_equal 'TRUE'
       t[0]['negative'].must_equal ''
+      doc.cleanup
     end
   end
 
@@ -81,7 +82,7 @@ describe XlsxWriter do
       @sheet1.add_row([3, 4])
     end
     after do
-      @doc.cleanup
+      @doc.try :cleanup
     end
     it "doesn't freeze by default" do
       dir = UnixUtils.unzip @doc.path
@@ -98,6 +99,32 @@ describe XlsxWriter do
     end
   end
 
+  describe "numeric types" do
+    before do
+      @reference = {
+        # 'Integer' => [1, '1'], - remote_table always converts to 1.0
+        'Float' => [1.2345, '1.2345'],
+        'Decimal' => [Decimal('6.789'), '6.789'],
+        'BigDecimal' => [::BigDecimal.new(9.876, 4), '9.876'],
+        'Rational' => [Rational(2, 3), '0.6666'],
+      }
+      @doc = XlsxWriter::Document.new
+      @sheet1 = @doc.add_sheet("Numbers")
+      @reference.each do |k, v|
+        @sheet1.add_row([k, v.first])
+      end
+    end
+    after do
+      @doc.try :cleanup
+    end
+    it "renders different numeric types into plain decimals" do
+      t = RemoteTable.new(@doc.path, :format => :xlsx, :headers => %w{ type number })
+      t.each do |row|
+        row['number'].to_s.first(6).must_equal @reference[row['type']].last, "for #{row['type']}"
+      end
+    end
+  end
+
   describe "example with autofilter, header image, and footer text" do
     before do
       @doc = XlsxWriter::Document.new
@@ -129,8 +156,8 @@ describe XlsxWriter do
       @unzipped = UnixUtils.unzip @doc.path
     end
     after do
-      @doc.cleanup
-      FileUtils.rm_rf @unzipped
+      @doc.try :cleanup
+      FileUtils.rm_rf @unzipped if @unzipped
     end
     it "has an autofilter" do
       File.read("#{@unzipped}/xl/worksheets/sheet1.xml").must_include %{<autoFilter ref="A1:F1" />}