axlsx 1.3.5 → 1.3.6

data/lib/axlsx/drawing/vml_shape.rb

@@ -4,95 +4,35 @@ module Axlsx
   class VmlShape
 
     include Axlsx::OptionsParser
+    include Axlsx::Accessors
 
     # Creates a new VmlShape
-    # @option options [Integer|String] left_column
-    # @option options [Integer|String] left_offset
-    # @option options [Integer|String] top_row
-    # @option options [Integer|String] top_offset
-    # @option options [Integer|String] right_column
-    # @option options [Integer|String] right_offset
-    # @option options [Integer|String] bottom_row
-    # @option options [Integer|String] bottom_offset
+    # @option options [Integer] row
+    # @option options [Integer] column
+    # @option options [Integer] left_column
+    # @option options [Integer] left_offset
+    # @option options [Integer] top_row
+    # @option options [Integer] top_offset
+    # @option options [Integer] right_column
+    # @option options [Integer] right_offset
+    # @option options [Integer] bottom_row
+    # @option options [Integer] bottom_offset
     def initialize(options={})
       @row = @column = @left_column = @top_row = @right_column = @bottom_row = 0
       @left_offset = 15
       @top_offset = 2
       @right_offset = 50
       @bottom_offset = 5
+      @visible = true
       @id = (0...8).map{65.+(rand(25)).chr}.join
       parse_options options
       yield self if block_given?
     end
 
-    # The row anchor position for this shape determined by the comment's ref value
-    # @return [Integer]
-    attr_reader :row
+    unsigned_int_attr_accessor :row, :column, :left_column, :left_offset, :top_row, :top_offset,
+                               :right_column, :right_offset, :bottom_row, :bottom_offset
 
-    # The column anchor position for this shape determined by the comment's ref value
-    # @return [Integer]
-    attr_reader :column
-
-    # The left column for this shape
-    # @return [Integer]
-    attr_reader :left_column
-
-    # The left offset for this shape
-    # @return [Integer]
-    attr_reader :left_offset
-
-    # The top row for this shape
-    # @return [Integer]
-    attr_reader :top_row
-
-    # The top offset for this shape
-    # @return [Integer]
-    attr_reader :top_offset
-
-    # The right column for this shape
-    # @return [Integer]
-    attr_reader :right_column
-
-    # The right offset for this shape
-    # @return [Integer]
-    attr_reader :right_offset
-
-    # The botttom row for this shape
-    # @return [Integer]
-    attr_reader :bottom_row
-
-    # The bottom offset for this shape
-    # @return [Integer]
-    attr_reader :bottom_offset
-
-     # @see column
-    def column=(v); Axlsx::validate_integerish(v); @column = v.to_i end
- 
-    # @see row
-    def row=(v); Axlsx::validate_integerish(v); @row = v.to_i end
-    # @see left_column
-    def left_column=(v); Axlsx::validate_integerish(v); @left_column = v.to_i end
-
-    # @see left_offset
-    def left_offset=(v); Axlsx::validate_integerish(v); @left_offset = v.to_i end
-
-    # @see top_row
-    def top_row=(v); Axlsx::validate_integerish(v); @top_row = v.to_i end
-
-    # @see top_offset
-    def top_offset=(v); Axlsx::validate_integerish(v); @top_offset = v.to_i end
-
-    # @see right_column
-    def right_column=(v); Axlsx::validate_integerish(v); @right_column = v.to_i end
-
-    # @see right_offset
-    def right_offset=(v); Axlsx::validate_integerish(v); @right_offset = v.to_i end
-
-    # @see bottom_row
-    def bottom_row=(v); Axlsx::validate_integerish(v); @bottom_row = v.to_i end
-
-    # @see bottom_offset
-    def bottom_offset=(v); Axlsx::validate_integerish(v); @bottom_offset = v.to_i end
+    boolean_attr_accessor :visible
 
     # serialize the shape to a string
     # @param [String] str
@@ -100,7 +40,8 @@ module Axlsx
     def to_xml_string(str ='')
 str << <<SHAME_ON_YOU
 
-<v:shape id="#{@id}" type="#_x0000_t202" fillcolor="#ffffa1 [80]" o:insetmode="auto">
+<v:shape id="#{@id}" type="#_x0000_t202" fillcolor="#ffffa1 [80]" o:insetmode="auto"
+  style="visibility:#{@visible ? 'visible' : 'hidden'}">
   <v:fill color2="#ffffa1 [80]"/>
   <v:shadow on="t" obscured="t"/>
   <v:path o:connecttype="none"/>
@@ -115,7 +56,7 @@ str << <<SHAME_ON_YOU
    <x:AutoFill>False</x:AutoFill>
    <x:Row>#{row}</x:Row>
    <x:Column>#{column}</x:Column>
-   <x:Visible/>
+   #{@visible ? '<x:Visible/>' : ''}
   </x:ClientData>
  </v:shape>
 SHAME_ON_YOU

data/lib/axlsx/util/serialized_attributes.rb

@@ -59,7 +59,6 @@ module Axlsx
     # break the xml and 1.8.7 does not support ordered hashes.
     # @param [String] str The string instance to which serialized data is appended
     # @param [Array] additional_attributes An array of additional attribute names.
-    # @param [Proc] block A which will be called with the value for each element.
     # @return [String] The serialized output.
     def serialized_element_attributes(str='', additional_attributes=[], &block)
       attrs = self.class.xml_element_attributes + additional_attributes

data/lib/axlsx/version.rb

@@ -1,5 +1,5 @@
 module Axlsx
 
   # The current version
-  VERSION = "1.3.5"
+  VERSION = "1.3.6"
 end

data/lib/axlsx/workbook/worksheet/comment.rb

@@ -4,35 +4,33 @@ module Axlsx
   class Comment
 
     include Axlsx::OptionsParser
+    include Axlsx::Accessors
 
     # Creates a new comment object
-    # @param [Comments] comments
+    # @param [Comments] comments The comment collection this comment belongs to
     # @param [Hash] options
     # @option [String] author the author of the comment
     # @option [String] text The text for the comment
+    # @option [String] ref The refence (e.g. 'A3' where this comment will be anchored.
+    # @option [Boolean] visible This controls the visiblity of the associated vml_shape.
     def initialize(comments, options={})
       raise ArgumentError, "A comment needs a parent comments object" unless comments.is_a?(Comments)
+      @visible = true
       @comments = comments
       parse_options options
       yield self if block_given?
     end
 
-    # The text to render
-    # @return [String]
-    attr_reader :text
-
-    # The author of this comment
-    # @see Comments
-    # @return [String]
-    attr_reader :author
+    string_attr_accessor :text, :author
+    boolean_attr_accessor :visible
 
-    # The owning Comments object
+      # The owning Comments object
     # @return [Comments]
     attr_reader :comments
 
 
     # The string based cell position reference (e.g. 'A1') that determines the positioning of this comment
-    # @return [String]
+    # @return [String|Cell]
     attr_reader :ref
 
     # TODO
@@ -60,17 +58,6 @@ module Axlsx
       @ref = v.r if v.is_a?(Cell)
     end
 
-    # @see text
-    def text=(v)
-      Axlsx::validate_string(v)
-      @text = v
-    end
-
-    # @see author
-    def author=(v)
-      @author = v
-    end
-
     # serialize the object
     # @param [String] str
     # @return [String]
@@ -93,7 +80,7 @@ module Axlsx
     # by default, all columns are 5 columns wide and 5 rows high
     def initialize_vml_shape
       pos = Axlsx::name_to_indices(ref)
-      @vml_shape = VmlShape.new(:row => pos[1], :column => pos[0]) do |vml|
+      @vml_shape = VmlShape.new(:row => pos[1], :column => pos[0], :visible => @visible) do |vml|
         vml.left_column = vml.column
         vml.right_column = vml.column + 2 
         vml.top_row = vml.row

data/lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb

@@ -25,7 +25,7 @@ module Axlsx
     # @option options [Integer] stdDev The number of standard deviations above or below the average to match
     # @option options [Boolean] stopIfTrue Stop evaluating rules after this rule matches
     # @option options [Symbol]  timePeriod The time period in a date occuring... rule
-    # @option options [String] formula The formula to match against in i.e. an equal rule
+    # @option options [String] formula The formula to match against in i.e. an equal rule. Use a [minimum, maximum] array for cellIs between/notBetween conditionals.
     def initialize(options={})
       @color_scale = @data_bar = @icon_set = @formula = nil
       parse_options options
@@ -36,6 +36,8 @@ module Axlsx
                             :stopIfTrue, :timePeriod
 
     # Formula
+    # The formula or value to match against (e.g. 5 with an operator of :greaterThan to specify cell_value > 5).
+    # If the operator is :between or :notBetween, use an array to specify [minimum, maximum]
     # @return [String]
     attr_reader :formula
 
@@ -180,7 +182,7 @@ module Axlsx
     # @see timePeriod
     def timePeriod=(v); Axlsx::validate_time_period_type(v); @timePeriod = v end
     # @see formula
-    def formula=(v); Axlsx::validate_string(v); @formula = v end
+    def formula=(v); [*v].each {|x| Axlsx::validate_string(x) }; @formula = v end
 
     # @see color_scale
     def color_scale=(v)
@@ -208,7 +210,7 @@ module Axlsx
       str << '<cfRule '
       serialized_attributes str
       str << '>'
-      str << '<formula>' << self.formula << '</formula>' if @formula
+      str << '<formula>' << [*self.formula].join('</formula><formula>') << '</formula>' if @formula
       @color_scale.to_xml_string(str) if @color_scale && @type == :colorScale
       @data_bar.to_xml_string(str) if @data_bar && @type == :dataBar
       @icon_set.to_xml_string(str) if @icon_set && @type == :iconSet

data/test/benchmark.rb

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby -s
-# -*- coding: utf-8 -*-
 $:.unshift "#{File.dirname(__FILE__)}/../lib"
 require 'axlsx'
 require 'csv'

data/test/drawing/tc_axis.rb

@@ -2,25 +2,22 @@ require 'tc_helper.rb'
 
 class TestAxis < Test::Unit::TestCase
   def setup
-    
-    @axis = Axlsx::Axis.new 12345, 54321, :gridlines => false, :title => 'Foo'
+    @axis = Axlsx::Axis.new :gridlines => false, :title => 'Foo'
   end
 
-  def teardown
-  end
 
   def test_initialization
-    assert_equal(@axis.axPos, :b, "axis position default incorrect")
-    assert_equal(@axis.tickLblPos, :nextTo, "tick label position default incorrect")
-    assert_equal(@axis.tickLblPos, :nextTo, "tick label position default incorrect")
+    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_raise(ArgumentError) { Axlsx::Axis.new( -1234, 'abcd') }
     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)) 
@@ -35,15 +32,15 @@ class TestAxis < Test::Unit::TestCase
       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.valAxis.title = sheet['A1']
-        assert_equal('battle victories', chart.valAxis.title.text)  
+        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.axPos = :nowhere }
-    assert_nothing_raised("accepts valid axis position") { @axis.axPos = :r }
+    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
@@ -55,13 +52,13 @@ class TestAxis < Test::Unit::TestCase
   end
 
   def test_tick_label_position
-    assert_raise(ArgumentError, "requires valid tick label position") { @axis.tickLblPos = :nowhere }
-    assert_nothing_raised("accepts valid tick label position") { @axis.tickLblPos = :high }
+    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 = 1 }
-    assert_nothing_raised("accepts valid format code") { @axis.tickLblPos = :high }
+    assert_raise(ArgumentError, "requires valid format code") { @axis.format_code = :high }
+    assert_nothing_raised("accepts valid format code") { @axis.format_code = "00.##"  }
   end
 
   def test_crosses
@@ -75,12 +72,13 @@ class TestAxis < Test::Unit::TestCase
   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.crossAx.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

data/test/drawing/tc_cat_axis.rb

@@ -2,15 +2,15 @@ require 'tc_helper.rb'
 
 class TestCatAxis < Test::Unit::TestCase
   def setup
-    @axis = Axlsx::CatAxis.new 12345, 54321
+    @axis = Axlsx::CatAxis.new
   end
   def teardown
   end
 
   def test_initialization
     assert_equal(@axis.auto, 1, "axis auto default incorrect")
-    assert_equal(@axis.lblAlgn, :ctr, "label align default incorrect")
-    assert_equal(@axis.lblOffset, "100", "label offset default incorrect")
+    assert_equal(@axis.lbl_algn, :ctr, "label align default incorrect")
+    assert_equal(@axis.lbl_offset, "100", "label offset default incorrect")
   end
 
   def test_auto
@@ -18,14 +18,14 @@ class TestCatAxis < Test::Unit::TestCase
     assert_nothing_raised("accepts valid auto") { @axis.auto = false }
   end
 
-  def test_lblAlgn
-    assert_raise(ArgumentError, "requires valid label alignment") { @axis.lblAlgn = :nowhere }
-    assert_nothing_raised("accepts valid label alignment") { @axis.lblAlgn = :r }
+  def test_lbl_algn
+    assert_raise(ArgumentError, "requires valid label alignment") { @axis.lbl_algn = :nowhere }
+    assert_nothing_raised("accepts valid label alignment") { @axis.lbl_algn = :r }
   end
 
-  def test_lblOffset
-    assert_raise(ArgumentError, "requires valid label offset") { @axis.lblOffset = 'foo' }
-    assert_nothing_raised("accepts valid label offset") { @axis.lblOffset = "20" }
+  def test_lbl_offset
+    assert_raise(ArgumentError, "requires valid label offset") { @axis.lbl_offset = 'foo' }
+    assert_nothing_raised("accepts valid label offset") { @axis.lbl_offset = "20" }
   end
 
 end

data/test/drawing/tc_line_chart.rb

@@ -0,0 +1,39 @@
+require 'tc_helper.rb'
+
+class TestLineChart < Test::Unit::TestCase
+
+  def setup
+    @p = Axlsx::Package.new
+    ws = @p.workbook.add_worksheet
+    @row = ws.add_row ["one", 1, Time.now]
+    @chart = ws.add_chart Axlsx::LineChart, :title => "fishery"
+  end
+
+  def teardown
+  end
+
+  def test_initialization
+    assert_equal(@chart.grouping, :standard, "grouping defualt incorrect")
+    assert_equal(@chart.series_type, Axlsx::LineSeries, "series type incorrect")
+    assert(@chart.cat_axis.is_a?(Axlsx::CatAxis), "category axis not created")
+    assert(@chart.val_axis.is_a?(Axlsx::ValAxis), "value access not created")
+  end
+
+ def test_grouping
+   assert_raise(ArgumentError, "require valid grouping") { @chart.grouping = :inverted }
+   assert_nothing_raised("allow valid grouping") { @chart.grouping = :stacked }
+   assert(@chart.grouping == :stacked)
+ end
+
+  def test_to_xml
+    schema = Nokogiri::XML::Schema(File.open(Axlsx::DRAWING_XSD))
+    doc = Nokogiri::XML(@chart.to_xml_string)
+    errors = []
+    schema.validate(doc).each do |error|
+      errors.push error
+      puts error.message
+    end
+    assert(errors.empty?, "error free validation")
+  end
+
+end

data/test/drawing/tc_line_series.rb

@@ -6,7 +6,7 @@ class TestLineSeries < Test::Unit::TestCase
     p = Axlsx::Package.new
     @ws = p.workbook.add_worksheet :name=>"hmmm"
     chart = @ws.add_chart Axlsx::Line3DChart, :title => "fishery"
-    @series = chart.add_series :data=>[0,1,2], :labels=>["zero", "one", "two"], :title=>"bob", :color => "#FF0000"
+    @series = chart.add_series :data=>[0,1,2], :labels=>["zero", "one", "two"], :title=>"bob", :color => "#FF0000", :show_marker => true
   end
 
   def test_initialize
@@ -15,10 +15,16 @@ class TestLineSeries < Test::Unit::TestCase
     assert_equal(@series.data.class, Axlsx::NumDataSource)
 
   end
-  
+
+  def test_show_marker
+    assert_equal(true, @series.show_marker)
+    @series.show_marker = false
+    assert_equal(false, @series.show_marker)
+  end  
   def test_to_xml_string
     doc = Nokogiri::XML(@series.to_xml_string)
     assert(doc.xpath("//srgbClr[@val='#{@series.color}']"))
+    assert(doc.xpath("//marker"))
   end
   #TODO serialization testing
 end