caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/drawing/str_val.rb

@@ -1,34 +1,31 @@
-# -*- coding: utf-8 -*-
-module Axlsx
-
-  #This class specifies data for a particular data point.
-  class StrVal
-
-    include Axlsx::OptionsParser
-
-    # creates a new StrVal object
-    # @option options [String] v
-    def initialize(options={})
-      @v = ""
-      @idx = 0
-      parse_options options
-    end
-
-    # a string value.
-    # @return [String]
-    attr_reader :v
-
-    # @see v
-    def v=(v)
-      @v = v.to_s
-    end
-
-    # serialize the object
-    def to_xml_string(idx, str = "")
-      Axlsx::validate_unsigned_int(idx)
-      if !v.to_s.empty?
-        str << ('<c:pt idx="' << idx.to_s << '"><c:v>' << ::CGI.escapeHTML(v.to_s) << '</c:v></c:pt>')
-      end
-    end
-  end
-end
+module Axlsx
+  # This class specifies data for a particular data point.
+  class StrVal
+    include Axlsx::OptionsParser
+
+    # creates a new StrVal object
+    # @option options [String] v
+    def initialize(options = {})
+      @v = ""
+      @idx = 0
+      parse_options options
+    end
+
+    # a string value.
+    # @return [String]
+    attr_reader :v
+
+    # @see v
+    def v=(v)
+      @v = v.to_s
+    end
+
+    # serialize the object
+    def to_xml_string(idx, str = "")
+      Axlsx::validate_unsigned_int(idx)
+      if !v.to_s.empty?
+        str << ('<c:pt idx="' << idx.to_s << '"><c:v>' << ::CGI.escapeHTML(v.to_s) << '</c:v></c:pt>')
+      end
+    end
+  end
+end

data/lib/axlsx/drawing/title.rb

@@ -1,97 +1,104 @@
-# encoding: UTF-8
-module Axlsx
-  # A Title stores information about the title of a chart
-  class Title
-
-    # The text to be shown. Setting this property directly with a string will remove the cell reference.
-    # @return [String]
-    attr_reader :text
-
-    # Text size property
-    # @return [String]
-    attr_reader :text_size
-
-    # The cell that holds the text for the title. Setting this property will automatically update the text attribute.
-    # @return [Cell]
-    attr_reader :cell
-
-    # Creates a new Title object
-    # @param [String, Cell] title The cell or string to be used for the chart's title
-    def initialize(title="", title_size="")
-      self.cell = title if title.is_a?(Cell)
-      self.text = title.to_s unless title.is_a?(Cell)
-      if title_size.to_s.empty?
-        self.text_size = "1600"
-      else
-        self.text_size = title_size.to_s
-      end
-    end
-
-    # @see text
-    def text=(v)
-      DataTypeValidator.validate 'Title.text', String, v
-      @text = v
-      @cell = nil
-      v
-    end
-
-    # @see text_size
-    def text_size=(v)
-      DataTypeValidator.validate 'Title.text_size', String, v
-      @text_size = v
-      @cell = nil
-      v
-    end
-
-    # @see cell
-    def cell=(v)
-      DataTypeValidator.validate 'Title.text', Cell, v
-      @cell = v
-      @text = v.value.to_s
-      v
-    end
-
-    # Not implemented at this time.
-    #def layout=(v) DataTypeValidator.validate 'Title.layout', Layout, v; @layout = v; end
-    #def overlay=(v) Axlsx::validate_boolean v; @overlay=v; end
-    #def spPr=(v) DataTypeValidator.validate 'Title.spPr', SpPr, v; @spPr = v; end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<c:title>'
-      unless @text.empty?
-        clean_value = Axlsx::trust_input ? @text.to_s : ::CGI.escapeHTML(Axlsx::sanitize(@text.to_s))
-        str << '<c:tx>'
-        if @cell.is_a?(Cell)
-          str << '<c:strRef>'
-          str << ('<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>')
-          str << '<c:strCache>'
-          str << '<c:ptCount val="1"/>'
-          str << '<c:pt idx="0">'
-          str << ('<c:v>' << clean_value << '</c:v>')
-          str << '</c:pt>'
-          str << '</c:strCache>'
-          str << '</c:strRef>'
-        else
-          str << '<c:rich>'
-            str << '<a:bodyPr/>'
-            str << '<a:lstStyle/>'
-            str << '<a:p>'
-              str << '<a:r>'
-                str << ('<a:rPr sz="' << @text_size.to_s << '"/>')
-                str << ('<a:t>' << clean_value << '</a:t>')
-              str << '</a:r>'
-            str << '</a:p>'
-          str << '</c:rich>'
-        end
-        str << '</c:tx>'
-      end
-      str << '<c:layout/>'
-      str << '<c:overlay val="0"/>'
-      str << '</c:title>'
-    end
-
-  end
-end
+module Axlsx
+  # A Title stores information about the title of a chart
+  class Title
+    # The text to be shown. Setting this property directly with a string will remove the cell reference.
+    # @return [String]
+    attr_reader :text
+
+    # Text size property
+    # @return [String]
+    attr_reader :text_size
+
+    # The cell that holds the text for the title. Setting this property will automatically update the text attribute.
+    # @return [Cell]
+    attr_reader :cell
+
+    # Creates a new Title object
+    # @param [String, Cell] title The cell or string to be used for the chart's title
+    def initialize(title = "", title_size = "")
+      self.cell = title if title.is_a?(Cell)
+      self.text = title.to_s unless title.is_a?(Cell)
+      if title_size.to_s.empty?
+        self.text_size = "1600"
+      else
+        self.text_size = title_size.to_s
+      end
+    end
+
+    # @see text
+    def text=(v)
+      DataTypeValidator.validate 'Title.text', String, v
+      @text = v
+      @cell = nil
+      v
+    end
+
+    # @see text_size
+    def text_size=(v)
+      DataTypeValidator.validate 'Title.text_size', String, v
+      @text_size = v
+      @cell = nil
+      v
+    end
+
+    # @see cell
+    def cell=(v)
+      DataTypeValidator.validate 'Title.text', Cell, v
+      @cell = v
+      @text = v.value.to_s
+      v
+    end
+
+    # Check if the title is empty.
+    #
+    # A title is considered empty if it is an empty string. If the title references a cell it is *not* empty,
+    # even if the referenced cell is blank (because the cell’s value could still change later).
+    #
+    # @return [Boolean]
+    def empty?
+      @text.empty? && @cell.nil?
+    end
+
+    # Not implemented at this time.
+    # def layout=(v) DataTypeValidator.validate 'Title.layout', Layout, v; @layout = v; end
+    # def overlay=(v) Axlsx::validate_boolean v; @overlay=v; end
+    # def spPr=(v) DataTypeValidator.validate 'Title.spPr', SpPr, v; @spPr = v; end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:title>'
+      unless empty?
+        clean_value = Axlsx::trust_input ? @text.to_s : ::CGI.escapeHTML(Axlsx::sanitize(@text.to_s))
+        str << '<c:tx>'
+        if @cell.is_a?(Cell)
+          str << '<c:strRef>'
+          str << ('<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>')
+          str << '<c:strCache>'
+          str << '<c:ptCount val="1"/>'
+          str << '<c:pt idx="0">'
+          str << ('<c:v>' << clean_value << '</c:v>')
+          str << '</c:pt>'
+          str << '</c:strCache>'
+          str << '</c:strRef>'
+        else
+          str << '<c:rich>'
+          str << '<a:bodyPr/>'
+          str << '<a:lstStyle/>'
+          str << '<a:p>'
+          str << '<a:r>'
+          str << ('<a:rPr sz="' << @text_size.to_s << '"/>')
+          str << ('<a:t>' << clean_value << '</a:t>')
+          str << '</a:r>'
+          str << '</a:p>'
+          str << '</c:rich>'
+        end
+        str << '</c:tx>'
+      end
+      str << '<c:layout/>'
+      str << '<c:overlay val="0"/>'
+      str << '</c:title>'
+    end
+  end
+end

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -1,97 +1,95 @@
-# encoding: UTF-8
-module Axlsx
-  # This class details the anchor points for drawings.
-  # @note The recommended way to manage drawings and charts is Worksheet#add_chart. Anchors are specified by the :start_at and :end_at options to that method.
-  # @see Worksheet#add_chart
-  class TwoCellAnchor
-
-    include Axlsx::OptionsParser
-
-    # A marker that defines the from cell anchor. The default from column and row are 0 and 0 respectively
-    # @return [Marker]
-    attr_reader :from
-    # A marker that returns the to cell anchor. The default to column and row are 5 and 10 respectively
-    # @return [Marker]
-    attr_reader :to
-
-    # The frame for your chart
-    # @note this will be discontinued in version 2.0 please use object
-    # @return [GraphicFrame]
-    # attr_reader :graphic_frame
-
-    # The object this anchor hosts
-    # @return [Pic, GraphicFrame]
-    attr_reader :object
-
-    # The drawing that holds this anchor
-    # @return [Drawing]
-    attr_reader :drawing
-
-    # Creates a new TwoCellAnchor object
-    # c.start_at 5, 9
-    # @param [Drawing] drawing
-    # @option options [Array] :start_at the col, row to start at THIS IS DOCUMENTED BUT NOT IMPLEMENTED HERE!
-    # @option options [Array] :end_at the col, row to end at
-    def initialize(drawing, options={})
-      @drawing = drawing
-      drawing.anchors << self
-      @from, @to =  Marker.new, Marker.new(:col => 5, :row=>10)
-      parse_options options
-
-      # bit of a hack to work around the fact that the coords for start at and end at
-      # are passed in as an array when specified in intialization options - however
-      start_at(*options[:start_at]) if options[:start_at]
-      end_at(*options[:end_at]) if options[:end_at]
-    end
-
-    # sets the col, row attributes for the from marker.
-    # @note The recommended way to set the start position for graphical
-    # objects is directly thru the object.
-    # @see Chart#start_at
-    def start_at(x, y=nil)
-      from.coord x, y
-    end
-
-    # sets the col, row attributes for the to marker
-    # @note the recommended way to set the to position for graphical
-    # objects is directly thru the object
-    # @see Char#end_at
-    def end_at(x, y=nil)
-      to.coord x, y
-    end
-
-    # Creates a graphic frame and chart object associated with this anchor
-    # @return [Chart]
-    def add_chart(chart_type, options)
-      @object = GraphicFrame.new(self, chart_type, options)
-      @object.chart
-    end
-
-    # Creates an image associated with this anchor.
-    def add_pic(options={})
-      @object = Pic.new(self, options)
-    end
-
-    # The index of this anchor in the drawing
-    # @return [Integer]
-    def index
-      @drawing.anchors.index(self)
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<xdr:twoCellAnchor>'
-      str << '<xdr:from>'
-      from.to_xml_string str
-      str << '</xdr:from>'
-      str << '<xdr:to>'
-      to.to_xml_string str
-      str << '</xdr:to>'
-      object.to_xml_string(str)
-      str << '<xdr:clientData/>'
-      str << '</xdr:twoCellAnchor>'
-    end
-  end
-end
+module Axlsx
+  # This class details the anchor points for drawings.
+  # @note The recommended way to manage drawings and charts is Worksheet#add_chart. Anchors are specified by the :start_at and :end_at options to that method.
+  # @see Worksheet#add_chart
+  class TwoCellAnchor
+    include Axlsx::OptionsParser
+
+    # A marker that defines the from cell anchor. The default from column and row are 0 and 0 respectively
+    # @return [Marker]
+    attr_reader :from
+    # A marker that returns the to cell anchor. The default to column and row are 5 and 10 respectively
+    # @return [Marker]
+    attr_reader :to
+
+    # The frame for your chart
+    # @note this will be discontinued in version 2.0 please use object
+    # @return [GraphicFrame]
+    # attr_reader :graphic_frame
+
+    # The object this anchor hosts
+    # @return [Pic, GraphicFrame]
+    attr_reader :object
+
+    # The drawing that holds this anchor
+    # @return [Drawing]
+    attr_reader :drawing
+
+    # Creates a new TwoCellAnchor object
+    # c.start_at 5, 9
+    # @param [Drawing] drawing
+    # @option options [Array] :start_at the col, row to start at THIS IS DOCUMENTED BUT NOT IMPLEMENTED HERE!
+    # @option options [Array] :end_at the col, row to end at
+    def initialize(drawing, options = {})
+      @drawing = drawing
+      drawing.anchors << self
+      @from, @to =  Marker.new, Marker.new(:col => 5, :row => 10)
+      parse_options options
+
+      # bit of a hack to work around the fact that the coords for start at and end at
+      # are passed in as an array when specified in intialization options - however
+      start_at(*options[:start_at]) if options[:start_at]
+      end_at(*options[:end_at]) if options[:end_at]
+    end
+
+    # sets the col, row attributes for the from marker.
+    # @note The recommended way to set the start position for graphical
+    # objects is directly thru the object.
+    # @see Chart#start_at
+    def start_at(x, y = nil)
+      from.coord x, y
+    end
+
+    # sets the col, row attributes for the to marker
+    # @note the recommended way to set the to position for graphical
+    # objects is directly thru the object
+    # @see Char#end_at
+    def end_at(x, y = nil)
+      to.coord x, y
+    end
+
+    # Creates a graphic frame and chart object associated with this anchor
+    # @return [Chart]
+    def add_chart(chart_type, options)
+      @object = GraphicFrame.new(self, chart_type, options)
+      @object.chart
+    end
+
+    # Creates an image associated with this anchor.
+    def add_pic(options = {})
+      @object = Pic.new(self, options)
+    end
+
+    # The index of this anchor in the drawing
+    # @return [Integer]
+    def index
+      @drawing.anchors.index(self)
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<xdr:twoCellAnchor>'
+      str << '<xdr:from>'
+      from.to_xml_string str
+      str << '</xdr:from>'
+      str << '<xdr:to>'
+      to.to_xml_string str
+      str << '</xdr:to>'
+      object.to_xml_string(str)
+      str << '<xdr:clientData/>'
+      str << '</xdr:twoCellAnchor>'
+    end
+  end
+end

data/lib/axlsx/drawing/val_axis.rb

@@ -1,37 +1,34 @@
-# encoding: UTF-8
-module Axlsx
-  # the ValAxis class defines a chart value axis.
-  class ValAxis < Axis
-
-    # This element specifies how the value axis crosses the category axis.
-    # must be one of [:between, :midCat]
-    # @return [Symbol]
-    attr_reader :cross_between
-    alias :crossBetween :cross_between
-
-    # Creates a new ValAxis object
-    # @option options [Symbol] crosses_between
-    def initialize(options={})
-      self.cross_between = :between
-      super(options)
-    end
-
-    # @see cross_between
-    def cross_between=(v)
-      RestrictionValidator.validate "ValAxis.cross_between", [:between, :midCat], v
-      @cross_between = v
-    end
-    alias :crossBetween= :cross_between=
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<c:valAx>'
-      super(str)
-      str << ('<c:crossBetween val="' << @cross_between.to_s << '"/>')
-      str << '</c:valAx>'
-    end
-
-  end
-end
+module Axlsx
+  # the ValAxis class defines a chart value axis.
+  class ValAxis < Axis
+    # This element specifies how the value axis crosses the category axis.
+    # must be one of [:between, :midCat]
+    # @return [Symbol]
+    attr_reader :cross_between
+    alias :crossBetween :cross_between
+
+    # Creates a new ValAxis object
+    # @option options [Symbol] crosses_between
+    def initialize(options = {})
+      self.cross_between = :between
+      super(options)
+    end
+
+    # @see cross_between
+    def cross_between=(v)
+      RestrictionValidator.validate "ValAxis.cross_between", [:between, :midCat], v
+      @cross_between = v
+    end
+    alias :crossBetween= :cross_between=
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:valAx>'
+      super(str)
+      str << ('<c:crossBetween val="' << @cross_between.to_s << '"/>')
+      str << '</c:valAx>'
+    end
+  end
+end