xlsx_writer 0.2.2 → 0.3.0

data/CHANGELOG

@@ -1,3 +1,10 @@
+0.3.0 / 2012-07-10
+
+* Enhancements
+
+  * Allow "quiet booleans" in case you don't want FALSE everywhere
+  * Allow freezing pane after the first (header) row
+
 0.2.2 / 2012-07-04
 
 * Bug fixes

data/README.markdown

@@ -25,11 +25,21 @@ Features not present in simple_xlsx_writer:
 * header and footer, with support for images (.emf only) and page numbers
 * fits columns to text
 
+## Wishlist
+
+1. Optional shared string optimizer
+
 ## Example
 
     require 'xlsx_writer'
     
     doc = XlsxWriter::Document.new
+
+    # show TRUE for true but a blank cell instead of FALSE
+    doc.quiet_booleans!
+
+    # freeze pane underneath the first (header) row
+    doc.freeze!
     
     sheet1 = doc.add_sheet("People")
     

data/foo.rb

@@ -11,14 +11,15 @@ require 'xlsx_writer'
 
 @doc = XlsxWriter::Document.new
 
-# @sheet1 = @doc.add_sheet("Sheet1")
-# @sheet1.add_row(['a', 'a'])
-# @sheet1.add_row(['a', { :value => 'a', :faded => true, :type => :String }])
-# @sheet1.add_row(['a', 'a'])
-# # @sheet1.add_row(['foo', 'bar'])
-# @sheet1.add_autofilter 'A1:B1'
+@sheet1 = @doc.add_sheet("Sheet1")
+@sheet1.add_row(['a', 'a'])
+@sheet1.add_row(['a', { :value => 'a', :faded => true, :type => :String }])
+@sheet1.add_row(['a', 'a'])
+# @sheet1.add_row(['foo', 'bar'])
+@sheet1.add_autofilter 'A1:B1'
 
-@sheet2 = @doc.add_sheet("Sheet2")
+@doc.freeze!
+@sheet2 = @doc.add_sheet("Freeze")
 @sheet2.add_row(['a', 'a'])
 @sheet2.add_row(['false1', false])
 @sheet2.add_row(['false2', {:value => false, :type => :Boolean}])

data/lib/xlsx_writer/cell.rb

@@ -187,7 +187,7 @@ module XlsxWriter
     end
 
     def to_xml
-      if value.nil? or (value.is_a?(String) and value.empty?)
+      if value.nil? or (value.is_a?(String) and value.empty?) or (value == false and quiet_booleans?)
         %{<c r="#{excel_column_letter}#{row.ndx}" s="0" t="inlineStr" />}
       elsif excel_type == :inlineStr
         %{<c r="#{excel_column_letter}#{row.ndx}" s="#{excel_style_number}" t="#{excel_type}"><is><t>#{excel_value}</t></is></c>}
@@ -195,10 +195,17 @@ module XlsxWriter
         %{<c r="#{excel_column_letter}#{row.ndx}" s="#{excel_style_number}" t="#{excel_type}"><v>#{excel_value}</v></c>}
       end
     end
-    
+
     # 0 -> A (zero based!)
     def excel_column_letter
       Cell.excel_column_letter row.cells.index(self)
     end
+
+    private
+
+    def quiet_booleans?
+      return @quiet_booleans if defined?(@quiet_booleans)
+      @quiet_booleans = row.sheet.document.quiet_booleans?
+    end
   end
 end

data/lib/xlsx_writer/document.rb

@@ -28,6 +28,24 @@ module XlsxWriter
       @header_footer = HeaderFooter.new
       @mutex = ::Mutex.new
     end
+
+    # Instead of TRUE or FALSE, show TRUE and blank if false
+    def quiet_booleans!
+      @quiet_booleans = true
+    end
+
+    def quiet_booleans?
+      @quiet_booleans == true
+    end
+
+    # Freeze the pane under the first (header) row
+    def freeze!
+      @freeze_pane = true
+    end
+
+    def freeze?
+      @freeze_pane == true
+    end
     
     def add_sheet(name)
       raise ::RuntimeError, "Can't add sheet, already generated!" if generated?

data/lib/xlsx_writer/generators/sheet.rb

@@ -81,22 +81,31 @@ module XlsxWriter
     
     # not using ERB to save memory
     def to_file(f)
-      f.puts <<-EOS
+      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">
-<cols>
 EOS
+      if document.freeze?
+        f.write <<-EOS
+<sheetViews>
+  <sheetView workbookViewId="0">
+    <pane ySplit="1" topLeftCell="A2" activePane="bottomLeft" state="frozen"/>
+  </sheetView>
+</sheetViews>
+EOS
+      end
+      f.write %{<cols>}
       (0..max_length-1).each do |x|
-        f.puts %{<col min="#{x+1}" max="#{x+1}" width="#{max_cell_width(x)}" bestFit="1" customWidth="1" />}
+        f.write %{<col min="#{x+1}" max="#{x+1}" width="#{max_cell_width(x)}" bestFit="1" customWidth="1" />}
       end
-      f.puts %{</cols>}
-      f.puts %{<sheetData>}
-      rows.each { |row| f.puts row.to_xml }
-      f.puts %{</sheetData>}
-      autofilters.each { |autofilter| f.puts autofilter.to_xml }
-      f.puts document.page_setup.to_xml
-      f.puts document.header_footer.to_xml
-      f.puts %{</worksheet>}
+      f.write %{</cols>}
+      f.write %{<sheetData>}
+      rows.each { |row| f.write row.to_xml }
+      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
     
     def max_length

data/lib/xlsx_writer/version.rb

@@ -1,3 +1,3 @@
 module XlsxWriter
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/test/test_xlsx_writer.rb

@@ -8,6 +8,8 @@ describe XlsxWriter do
       @sheet1 = @doc.add_sheet("People")
       @sheet1.add_row(['header1', 'header2'])
       @sheet1.add_row(['hello', 'world'])
+      @sheet1.add_row(['affirmative', true])
+      @sheet1.add_row(['negative', false])
     end
     after do
       @doc.cleanup
@@ -17,7 +19,7 @@ describe XlsxWriter do
       File.extname(@doc.path).must_equal '.xlsx'
     end
     it "is a readable xlsx" do
-      RemoteTable.new("file://#{@doc.path}", :format => :xlsx).rows.first.must_equal('header1' => 'hello', 'header2' => 'world')
+      RemoteTable.new(@doc.path, :format => :xlsx).rows.first.must_equal('header1' => 'hello', 'header2' => 'world')
     end
     it "only generates once" do
       @doc.generate
@@ -48,6 +50,52 @@ describe XlsxWriter do
     end
   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)
+      t[0]['affirmative'].must_equal 'TRUE'
+      t[0]['negative'].must_equal 'FALSE'
+    end
+    it "shows TRUE or blank for false if quiet booleans is enabled" do
+      @doc.quiet_booleans!
+      t = RemoteTable.new(@doc.path, :format => :xlsx)
+      t[0]['affirmative'].must_equal 'TRUE'
+      t[0]['negative'].must_equal ''
+    end
+  end
+
+  describe "freeze pane under first (header) row" do
+    before do
+      @doc = XlsxWriter::Document.new
+      @sheet1 = @doc.add_sheet("Freeze")
+      @sheet1.add_row([1, 2])
+      @sheet1.add_row([3, 4])
+    end
+    after do
+      @doc.cleanup
+    end
+    it "doesn't freeze by default" do
+      dir = UnixUtils.unzip @doc.path
+      File.read("#{dir}/xl/worksheets/sheet1.xml").wont_include 'pane'
+      FileUtils.rm_rf dir
+    end
+    it "shows TRUE or blank for false if quiet booleans is enabled" do
+      @doc.freeze!
+      dir = UnixUtils.unzip @doc.path
+      File.read("#{dir}/xl/worksheets/sheet1.xml").must_include 'pane'
+      FileUtils.rm_rf dir
+    end
+  end
+
   describe "example with autofilter, header image, and footer text" do
     before do
       @doc = XlsxWriter::Document.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xlsx_writer
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-04 00:00:00.000000000 Z
+date: 2012-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport