bonio-axlsx 2.2.1

data/lib/schema/xml.xsd

@@ -0,0 +1,116 @@
+<?xml version='1.0'?>
+<xs:schema targetNamespace="http://www.w3.org/XML/1998/namespace" xmlns:xs="http://www.w3.org/2001/XMLSchema">
+
+ <xs:annotation>
+  <xs:documentation>
+   See http://www.w3.org/XML/1998/namespace.html and
+   http://www.w3.org/TR/REC-xml for information about this namespace.
+
+    This schema document describes the XML namespace, in a form
+    suitable for import by other schema documents.
+
+    Note that local names in this namespace are intended to be defined
+    only by the World Wide Web Consortium or its subgroups.  The
+    following names are currently defined in this namespace and should
+    not be used with conflicting semantics by any Working Group,
+    specification, or document instance:
+
+    base (as an attribute name): denotes an attribute whose value
+         provides a URI to be used as the base for interpreting any
+         relative URIs in the scope of the element on which it
+         appears; its value is inherited.  This name is reserved
+         by virtue of its definition in the XML Base specification.
+
+    lang (as an attribute name): denotes an attribute whose value
+         is a language code for the natural language of the content of
+         any element; its value is inherited.  This name is reserved
+         by virtue of its definition in the XML specification.
+
+    space (as an attribute name): denotes an attribute whose
+         value is a keyword indicating what whitespace processing
+         discipline is intended for the content of the element; its
+         value is inherited.  This name is reserved by virtue of its
+         definition in the XML specification.
+
+    Father (in any context at all): denotes Jon Bosak, the chair of
+         the original XML Working Group.  This name is reserved by
+         the following decision of the W3C XML Plenary and
+         XML Coordination groups:
+
+             In appreciation for his vision, leadership and dedication
+             the W3C XML Plenary on this 10th day of February, 2000
+             reserves for Jon Bosak in perpetuity the XML name
+             xml:Father
+  </xs:documentation>
+ </xs:annotation>
+
+ <xs:annotation>
+  <xs:documentation>This schema defines attributes and an attribute group
+        suitable for use by
+        schemas wishing to allow xml:base, xml:lang or xml:space attributes
+        on elements they define.
+
+        To enable this, such a schema must import this schema
+        for the XML namespace, e.g. as follows:
+        &lt;schema . . .>
+         . . .
+         &lt;import namespace="http://www.w3.org/XML/1998/namespace"
+                    schemaLocation="http://www.w3.org/2001/03/xml.xsd"/>
+
+        Subsequently, qualified reference to any of the attributes
+        or the group defined below will have the desired effect, e.g.
+
+        &lt;type . . .>
+         . . .
+         &lt;attributeGroup ref="xml:specialAttrs"/>
+
+         will define a type which will schema-validate an instance
+         element with any of those attributes</xs:documentation>
+ </xs:annotation>
+
+ <xs:annotation>
+  <xs:documentation>In keeping with the XML Schema WG's standard versioning
+   policy, this schema document will persist at
+   http://www.w3.org/2001/03/xml.xsd.
+   At the date of issue it can also be found at
+   http://www.w3.org/2001/xml.xsd.
+   The schema document at that URI may however change in the future,
+   in order to remain compatible with the latest version of XML Schema
+   itself.  In other words, if the XML Schema namespace changes, the version
+   of this document at
+   http://www.w3.org/2001/xml.xsd will change
+   accordingly; the version at
+   http://www.w3.org/2001/03/xml.xsd will not change.
+  </xs:documentation>
+ </xs:annotation>
+
+ <xs:attribute name="lang" type="xs:language">
+  <xs:annotation>
+   <xs:documentation>In due course, we should install the relevant ISO 2- and 3-letter
+         codes as the enumerated possible values . . .</xs:documentation>
+  </xs:annotation>
+ </xs:attribute>
+
+ <xs:attribute name="space" default="preserve">
+  <xs:simpleType>
+   <xs:restriction base="xs:NCName">
+    <xs:enumeration value="default"/>
+    <xs:enumeration value="preserve"/>
+   </xs:restriction>
+  </xs:simpleType>
+ </xs:attribute>
+
+ <xs:attribute name="base" type="xs:anyURI">
+  <xs:annotation>
+   <xs:documentation>See http://www.w3.org/TR/xmlbase/ for
+                     information about this attribute.</xs:documentation>
+  </xs:annotation>
+ </xs:attribute>
+
+ <xs:attributeGroup name="specialAttrs">
+  <xs:attribute ref="xml:base"/>
+  <xs:attribute ref="xml:lang"/>
+  <xs:attribute ref="xml:space"/>
+ </xs:attributeGroup>
+
+</xs:schema>

data/test/benchmark.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby -s
+$:.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+require 'csv'
+require 'benchmark'
+Axlsx::trust_input = true
+row = []
+input = (32..126).to_a.pack('U*').chars.to_a
+20.times { row << input.shuffle.join}
+times = 3000
+Benchmark.bmbm(30) do |x|
+
+  x.report('axlsx_noautowidth') {
+    p = Axlsx::Package.new
+    p.workbook do |wb|
+      wb.add_worksheet do |sheet|
+        times.times do
+          sheet << row
+        end
+      end
+    end
+    p.use_autowidth = false
+    p.serialize("example_noautowidth.xlsx")
+  }
+
+  x.report('axlsx') {
+    p = Axlsx::Package.new
+    p.workbook do |wb|
+      wb.add_worksheet do |sheet|
+        times.times do
+          sheet << row
+        end
+      end
+    end
+    p.serialize("example_autowidth.xlsx")
+  }
+
+  x.report('axlsx_shared') {
+    p = Axlsx::Package.new
+    p.workbook do |wb|
+      wb.add_worksheet do |sheet|
+        times.times do
+          sheet << row
+        end
+      end
+    end
+    p.use_shared_strings = true
+    p.serialize("example_shared.xlsx")
+  }
+
+  x.report('axlsx_stream') {
+    p = Axlsx::Package.new
+    p.workbook do |wb|
+      wb.add_worksheet do |sheet|
+        times.times do
+          sheet << row
+        end
+      end
+    end
+    s = p.to_stream()
+    File.open('example_streamed.xlsx', 'w') { |f| f.write(s.read) }
+  }
+
+  x.report('csv') {
+    CSV.open("example.csv", "wb") do |csv|
+      times.times do
+        csv << row
+      end
+    end
+  }
+end
+File.delete("example.csv", "example_streamed.xlsx", "example_shared.xlsx", "example_autowidth.xlsx", "example_noautowidth.xlsx")

data/test/content_type/tc_content_type.rb

@@ -0,0 +1,76 @@
+# encoding: UTF-8
+require 'tc_helper.rb'
+
+class TestContentType < Test::Unit::TestCase
+  def setup
+    @package = Axlsx::Package.new
+    @doc = Nokogiri::XML(@package.send(:content_types).to_xml_string)
+  end
+
+  def test_valid_document
+    schema = Nokogiri::XML::Schema(File.open(Axlsx::CONTENT_TYPES_XSD))
+    assert(schema.validate(@doc).map{ |e| puts e.message; e.message }.empty?)
+  end
+
+  def test_pre_built_types
+
+    o_path = "//xmlns:Override[@ContentType='%s']"
+    d_path = "//xmlns:Default[@ContentType='%s']"
+
+    #default
+    assert_equal(@doc.xpath("//xmlns:Default").size, 2, "There should be 2 default types")
+
+    node = @doc.xpath(d_path % Axlsx::XML_CT).first
+    assert_equal(node["Extension"], "#{Axlsx::XML_EX}", "xml content type invalid")
+
+    node = @doc.xpath(d_path % Axlsx::RELS_CT).first
+    assert_equal(node["Extension"],"#{Axlsx::RELS_EX}", "relationships content type invalid")
+
+    #overrride
+    assert_equal(@doc.xpath("//xmlns:Override").size, 4, "There should be 4 Override types")
+
+    node = @doc.xpath(o_path % Axlsx::APP_CT).first
+    assert_equal(node["PartName"], "/#{Axlsx::APP_PN}", "App part name invalid")
+
+    node = @doc.xpath(o_path % Axlsx::CORE_CT).first
+    assert_equal(node["PartName"], "/#{Axlsx::CORE_PN}", "Core part name invalid")
+
+    node = @doc.xpath(o_path % Axlsx::STYLES_CT).first
+    assert_equal(node["PartName"], "/xl/#{Axlsx::STYLES_PN}", "Styles part name invalid")
+
+    node = @doc.xpath(o_path % Axlsx::WORKBOOK_CT).first
+    assert_equal(node["PartName"], "/#{Axlsx::WORKBOOK_PN}", "Workbook part invalid")
+  end
+
+  def test_should_get_worksheet_for_worksheets
+    o_path = "//xmlns:Override[@ContentType='%s']"
+
+    ws = @package.workbook.add_worksheet
+    doc = Nokogiri::XML(@package.send(:content_types).to_xml_string)
+    assert_equal(doc.xpath("//xmlns:Override").size, 5, "adding a worksheet should add another type")
+    assert_equal(doc.xpath(o_path % Axlsx::WORKSHEET_CT).last["PartName"], "/xl/#{ws.pn}", "Worksheet part invalid")
+
+    ws = @package.workbook.add_worksheet
+    doc = Nokogiri::XML(@package.send(:content_types).to_xml_string)
+    assert_equal(doc.xpath("//xmlns:Override").size, 6, "adding workship should add another type")
+    assert_equal(doc.xpath(o_path % Axlsx::WORKSHEET_CT).last["PartName"], "/xl/#{ws.pn}", "Worksheet part invalid")
+
+  end
+
+  def test_drawings_and_charts_need_content_types
+    o_path = "//xmlns:Override[@ContentType='%s']"
+    ws = @package.workbook.add_worksheet
+
+    c = ws.add_chart Axlsx::Pie3DChart
+    doc = Nokogiri::XML(@package.send(:content_types).to_xml_string)
+    assert_equal(doc.xpath("//xmlns:Override").size, 7, "expected 7 types got #{doc.css("Types Override").size}")
+    assert_equal(doc.xpath(o_path % Axlsx::DRAWING_CT).first["PartName"], "/xl/#{ws.drawing.pn}", "Drawing part name invlid")
+    assert_equal(doc.xpath(o_path % Axlsx::CHART_CT).last["PartName"], "/xl/#{c.pn}", "Chart part name invlid")
+
+    c = ws.add_chart Axlsx::Pie3DChart
+    doc = Nokogiri::XML(@package.send(:content_types).to_xml_string)
+    assert_equal(doc.xpath("//xmlns:Override").size, 8, "expected 7 types got #{doc.css("Types Override").size}")
+    assert_equal(doc.xpath(o_path % Axlsx::CHART_CT).last["PartName"], "/xl/#{c.pn}", "Chart part name invlid")
+  end
+
+end

data/test/content_type/tc_default.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+require 'tc_helper.rb'
+
+class TestDefault < Test::Unit::TestCase
+
+  def test_content_type_restriction
+    assert_raise(ArgumentError, "raises argument error if invlalid ContentType is") { Axlsx::Default.new :ContentType=>"asdf" }
+  end
+
+  def test_to_xml_string
+    type = Axlsx::Default.new :Extension=>"xml", :ContentType=>Axlsx::XML_CT
+    doc = Nokogiri::XML(type.to_xml_string)
+    assert_equal(doc.xpath("Default[@ContentType='#{Axlsx::XML_CT}']").size, 1)
+    assert_equal(doc.xpath("Default[@Extension='xml']").size, 1)
+  end
+end

data/test/content_type/tc_override.rb

@@ -0,0 +1,14 @@
+require 'tc_helper.rb'
+class TestOverride < Test::Unit::TestCase
+
+  def test_content_type_restriction
+    assert_raise(ArgumentError, "requires known content type") { Axlsx::Override.new :ContentType=>"asdf" }
+  end
+
+  def test_to_xml
+    type = Axlsx::Override.new :PartName=>"somechart.xml", :ContentType=>Axlsx::CHART_CT
+    doc = Nokogiri::XML(type.to_xml_string)
+    assert_equal(doc.xpath("Override[@ContentType='#{Axlsx::CHART_CT}']").size, 1)
+    assert_equal(doc.xpath("Override[@PartName='somechart.xml']").size, 1)
+  end
+end

data/test/doc_props/tc_app.rb

@@ -0,0 +1,43 @@
+require 'tc_helper.rb'
+
+class TestApp < Test::Unit::TestCase
+  def setup
+    options = {
+      :'Template' => 'Foo.xlt',
+      :'Manager' => 'Penny',
+      :'Company' => "Bob's Repair",
+      :'Pages' => 1,
+      :'Words' => 2,
+      :'Characters' => 7,
+      :'PresentationFormat' => 'any',
+      :'Lines' => 1,
+      :'Paragraphs' => 1,
+      :'Slides' => 4,
+      :'Notes' => 1,
+      :'TotalTime' => 2,
+      :'HidddenSlides' => 3,
+      :'MMClips' => 10,
+      :'ScaleCrop' => true,
+      :'LinksUpToDate' => true,
+      :'CharactersWithSpaces' => 9,
+      :'SharedDoc' => false,
+      :'HyperlinkBase' => 'foo',
+      :'HyperlInksChanged' => false, 
+      :'Application' => 'axlsx',
+      :'AppVersion' => '1.1.5',
+      :'DocSecurity' => 0
+      }
+
+    @app = Axlsx::App.new options
+
+  end
+  def test_valid_document
+    schema = Nokogiri::XML::Schema(File.open(Axlsx::APP_XSD))
+    doc = Nokogiri::XML(@app.to_xml_string)
+    errors = []
+    schema.validate(doc).each do |error|
+      errors << error
+    end
+    assert_equal(errors.size, 0, "app.xml invalid" + errors.map{ |e| e.message }.to_s)
+  end
+end

data/test/doc_props/tc_core.rb

@@ -0,0 +1,42 @@
+require 'tc_helper.rb'
+
+class TestCore < Test::Unit::TestCase
+
+  def setup
+    @core = Axlsx::Core.new
+    # could still see some false positives if the second changes between the next two calls
+    @time = Time.now.strftime('%Y-%m-%dT%H:%M:%SZ')
+    @doc = Nokogiri::XML(@core.to_xml_string)
+  end
+
+  def test_valid_document
+    schema = Nokogiri::XML::Schema(File.open(Axlsx::CORE_XSD))
+    errors = []
+    schema.validate(@doc).each do |error|
+      puts error.message
+      errors << error
+    end
+    assert_equal(errors.size, 0, "core.xml Invalid" + errors.map{ |e| e.message }.to_s)
+  end
+
+  def test_populates_created
+    assert_equal(@doc.xpath('//dcterms:created').text, @time, "dcterms:created incorrect")
+  end
+
+  def test_created_as_option
+    time = Time.utc(2013, 1, 1, 12, 00)
+    c = Axlsx::Core.new :created => time
+    doc = Nokogiri::XML(c.to_xml_string)
+    assert_equal(doc.xpath('//dcterms:created').text, time.xmlschema, "dcterms:created incorrect")
+  end
+
+  def test_populates_default_name
+    assert_equal(@doc.xpath('//dc:creator').text, "axlsx", "Default name not populated")
+  end
+
+  def test_creator_as_option
+    c = Axlsx::Core.new :creator => "some guy"
+    doc = Nokogiri::XML(c.to_xml_string)
+    assert(doc.xpath('//dc:creator').text == "some guy")
+  end
+end

data/test/drawing/tc_axes.rb

@@ -0,0 +1,8 @@
+require 'tc_helper.rb'
+
+class TestAxes < Test::Unit::TestCase
+  def test_constructor_requires_cat_axis_first
+    assert_raise(ArgumentError) { Axlsx::Axes.new(:val_axis => Axlsx::ValAxis, :cat_axis => Axlsx::CatAxis) }
+    assert_nothing_raised { Axlsx::Axes.new(:cat_axis => Axlsx::CatAxis, :val_axis => Axlsx::ValAxis) }
+  end
+end

data/test/drawing/tc_axis.rb

@@ -0,0 +1,112 @@
+require 'tc_helper.rb'
+
+class TestAxis < Test::Unit::TestCase
+  def setup
+    @axis = Axlsx::Axis.new :gridlines => false, :title => 'Foo'
+  end
+
+
+  def test_initialization
+    assert_equal(@axis.ax_pos, :b, "axis position default incorrect")
+    assert_equal(@axis.tick_lbl_pos, :nextTo, "tick label position default incorrect")
+    assert_equal(@axis.tick_lbl_pos, :nextTo, "tick label position default incorrect")
+    assert_equal(@axis.crosses, :autoZero, "tick label position default incorrect")
+    assert(@axis.scaling.is_a?(Axlsx::Scaling) && @axis.scaling.orientation == :minMax, "scaling default incorrect")
+    assert_equal('Foo', @axis.title.text)
+  end
+
+  def test_color
+    @axis.color = "00FF00"
+    @axis.cross_axis = Axlsx::CatAxis.new
+    str  = '<?xml version="1.0" encoding="UTF-8"?>'
+    str << '<c:chartSpace xmlns:c="' << Axlsx::XML_NS_C << '" xmlns:a="' << Axlsx::XML_NS_A << '">'
+    doc = Nokogiri::XML(@axis.to_xml_string(str)) 
+    assert(doc.xpath("//a:srgbClr[@val='00FF00']"))
+  end
+
+  def test_cell_based_axis_title
+    p = Axlsx::Package.new
+    p.workbook.add_worksheet(:name=>'foosheet') do |sheet|
+      sheet.add_row ['battle victories']
+      sheet.add_row ['bird', 1, 2, 1]
+      sheet.add_row ['cat', 7, 9, 10]
+      sheet.add_chart(Axlsx::Line3DChart) do |chart|
+        chart.add_series :data => sheet['B2:D2'], :labels => sheet['B1']
+        chart.val_axis.title = sheet['A1']
+        assert_equal('battle victories', chart.val_axis.title.text)
+      end
+    end
+  end
+
+  def test_axis_position
+    assert_raise(ArgumentError, "requires valid axis position") { @axis.ax_pos = :nowhere }
+    assert_nothing_raised("accepts valid axis position") { @axis.ax_pos = :r }
+  end
+
+  def test_label_rotation
+    assert_raise(ArgumentError, "requires valid angle") { @axis.label_rotation = :nowhere }
+    assert_raise(ArgumentError, "requires valid angle") { @axis.label_rotation = 91 }
+    assert_raise(ArgumentError, "requires valid angle") { @axis.label_rotation = -91 }
+    assert_nothing_raised("accepts valid angle") { @axis.label_rotation = 45 }
+    assert_equal(@axis.label_rotation, 45 * 60000)
+  end
+
+  def test_tick_label_position
+    assert_raise(ArgumentError, "requires valid tick label position") { @axis.tick_lbl_pos = :nowhere }
+    assert_nothing_raised("accepts valid tick label position") { @axis.tick_lbl_pos = :high }
+  end
+
+  def test_format_code
+    assert_raise(ArgumentError, "requires valid format code") { @axis.format_code = :high }
+    assert_nothing_raised("accepts valid format code") { @axis.format_code = "00.##"  }
+  end
+
+  def create_chart_with_formatting(format_string=nil)
+    p = Axlsx::Package.new
+    p.workbook.add_worksheet(:name => "Formatting Test") do |sheet|
+      sheet.add_row(['test', 20])
+      sheet.add_chart(Axlsx::Bar3DChart, :start_at => [0,5], :end_at => [10, 20], :title => "Test Formatting") do |chart|
+        chart.add_series :data => sheet["B1:B1"], :labels => sheet["A1:A1"]
+        chart.val_axis.format_code = format_string if format_string
+        doc = Nokogiri::XML(chart.to_xml_string)
+        yield doc
+      end
+    end
+  end
+
+  def test_format_code_resets_source_linked
+    create_chart_with_formatting("#,##0.00") do |doc|
+      assert_equal(doc.xpath("//c:valAx/c:numFmt[@formatCode='#,##0.00']").size, 1)
+      assert_equal(doc.xpath("//c:valAx/c:numFmt[@sourceLinked='0']").size, 1)
+    end
+  end
+
+  def test_no_format_code_keeps_source_linked
+    create_chart_with_formatting do |doc|
+      assert_equal(doc.xpath("//c:valAx/c:numFmt[@formatCode='General']").size, 1)
+      assert_equal(doc.xpath("//c:valAx/c:numFmt[@sourceLinked='1']").size, 1)
+    end
+  end
+
+  def test_crosses
+    assert_raise(ArgumentError, "requires valid crosses") { @axis.crosses = 1 }
+    assert_nothing_raised("accepts valid crosses") { @axis.crosses = :min }
+  end
+
+  def test_gridlines
+    assert_raise(ArgumentError, "requires valid gridlines") { @axis.gridlines = 'alice' }
+    assert_nothing_raised("accepts valid crosses") { @axis.gridlines = false }
+  end
+  
+  def test_to_xml_string
+    @axis.cross_axis = Axlsx::CatAxis.new
+    str  = '<?xml version="1.0" encoding="UTF-8"?>'
+    str << '<c:chartSpace xmlns:c="' << Axlsx::XML_NS_C << '" xmlns:a="' << Axlsx::XML_NS_A << '">'
+    doc = Nokogiri::XML(@axis.to_xml_string(str)) 
+    assert(doc.xpath('//a:noFill'))
+    assert(doc.xpath("//c:crosses[@val='#{@axis.crosses.to_s}']"))
+    assert(doc.xpath("//c:crossAx[@val='#{@axis.cross_axis.to_s}']"))
+    assert(doc.xpath("//a:bodyPr[@rot='#{@axis.label_rotation.to_s}']"))
+    assert(doc.xpath("//a:t[text()='Foo']"))
+  end
+end