caxlsx 3.3.0 → 4.0.0

data/lib/axlsx/drawing/series_title.rb

@@ -1,21 +1,21 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 module Axlsx
   # A series title is a Title with a slightly different serialization than chart titles.
   class SeriesTitle < Title
-
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
-      clean_value = Axlsx::trust_input ? @text.to_s : ::CGI.escapeHTML(Axlsx::sanitize(@text.to_s))
+    def to_xml_string(str = +'')
+      clean_value = Axlsx.trust_input ? @text.to_s : ::CGI.escapeHTML(Axlsx.sanitize(@text.to_s))
 
       str << '<c:tx>'
       str << '<c:strRef>'
-      str << ('<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>')
+      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:v>' << clean_value << '</c:v>'
       str << '</c:pt>'
       str << '</c:strCache>'
       str << '</c:strRef>'

data/lib/axlsx/drawing/str_data.rb

@@ -1,16 +1,15 @@
-# -*- coding: utf-8 -*-
-module Axlsx
+# frozen_string_literal: true
 
-  #This specifies the last string data used for a chart. (e.g. strLit and strCache)
+module Axlsx
+  # This specifies the last string data used for a chart. (e.g. strLit and strCache)
   # This class is extended for NumData to include the formatCode attribute required for numLit and numCache
   class StrData
-
     include Axlsx::OptionsParser
 
     # creates a new StrVal object
     # @option options [Array] :data
     # @option options [String] :tag_name
-    def initialize(options={})
+    def initialize(options = {})
       @tag_prefix = :str
       @type = StrVal
       @pt = SimpleTypedList.new(@type)
@@ -19,24 +18,22 @@ module Axlsx
 
     # Creates the val objects for this data set. I am not overly confident this is going to play nicely with time and data types.
     # @param [Array] values An array of cells or values.
-    def data=(values=[])
+    def data=(values = [])
       @tag_name = values.first.is_a?(Cell) ? :strCache : :strLit
       values.each do |value|
         v = value.is_a?(Cell) ? value.value : value
-        @pt << @type.new(:v => v)
+        @pt << @type.new(v: v)
       end
     end
 
     # serialize the object
-    def to_xml_string(str = "")
-      str << ('<c:' << @tag_name.to_s << '>')
-      str << ('<c:ptCount val="' << @pt.size.to_s << '"/>')
+    def to_xml_string(str = +'')
+      str << '<c:' << @tag_name.to_s << '>'
+      str << '<c:ptCount val="' << @pt.size.to_s << '"/>'
       @pt.each_with_index do |value, index|
         value.to_xml_string index, str
       end
-      str << ('</c:' << @tag_name.to_s << '>')
+      str << '</c:' << @tag_name.to_s << '>'
     end
-
   end
-
 end

data/lib/axlsx/drawing/str_val.rb

@@ -1,14 +1,13 @@
-# -*- coding: utf-8 -*-
-module Axlsx
+# frozen_string_literal: true
 
-  #This class specifies data for a particular data point.
+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={})
+    def initialize(options = {})
       @v = ""
       @idx = 0
       parse_options options
@@ -24,10 +23,10 @@ module Axlsx
     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>')
+    def to_xml_string(idx, str = +'')
+      Axlsx.validate_unsigned_int(idx)
+      unless 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

data/lib/axlsx/drawing/title.rb

@@ -1,8 +1,8 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 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
@@ -17,14 +17,14 @@ module Axlsx
 
     # 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="")
+    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
+      self.text_size = if title_size.to_s.empty?
+                         "1600"
+                       else
+                         title_size.to_s
+                       end
     end
 
     # @see text
@@ -32,7 +32,6 @@ module Axlsx
       DataTypeValidator.validate 'Title.text', String, v
       @text = v
       @cell = nil
-      v
     end
 
     # @see text_size
@@ -40,7 +39,6 @@ module Axlsx
       DataTypeValidator.validate 'Title.text_size', String, v
       @text_size = v
       @cell = nil
-      v
     end
 
     # @see cell
@@ -48,7 +46,6 @@ module Axlsx
       DataTypeValidator.validate 'Title.text', Cell, v
       @cell = v
       @text = v.value.to_s
-      v
     end
 
     # Check if the title is empty.
@@ -62,38 +59,38 @@ module Axlsx
     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
+    # 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 = '')
+    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))
+        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: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: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 << '<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>'
@@ -102,6 +99,5 @@ module Axlsx
       str << '<c:overlay val="0"/>'
       str << '</c:title>'
     end
-
   end
 end

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -1,10 +1,10 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 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
@@ -32,10 +32,10 @@ module Axlsx
     # @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={})
+    def initialize(drawing, options = {})
       @drawing = drawing
       drawing.anchors << self
-      @from, @to =  Marker.new, Marker.new(:col => 5, :row=>10)
+      @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
@@ -48,7 +48,7 @@ module Axlsx
     # @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)
+    def start_at(x, y = nil)
       from.coord x, y
     end
 
@@ -56,7 +56,7 @@ module Axlsx
     # @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)
+    def end_at(x, y = nil)
       to.coord x, y
     end
 
@@ -68,7 +68,7 @@ module Axlsx
     end
 
     # Creates an image associated with this anchor.
-    def add_pic(options={})
+    def add_pic(options = {})
       @object = Pic.new(self, options)
     end
 
@@ -81,7 +81,7 @@ module Axlsx
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<xdr:twoCellAnchor>'
       str << '<xdr:from>'
       from.to_xml_string str

data/lib/axlsx/drawing/val_axis.rb

@@ -1,8 +1,8 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 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]
@@ -11,7 +11,7 @@ module Axlsx
 
     # Creates a new ValAxis object
     # @option options [Symbol] crosses_between
-    def initialize(options={})
+    def initialize(options = {})
       self.cross_between = :between
       super(options)
     end
@@ -26,12 +26,11 @@ module Axlsx
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<c:valAx>'
       super(str)
-      str << ('<c:crossBetween val="' << @cross_between.to_s << '"/>')
+      str << '<c:crossBetween val="' << @cross_between.to_s << '"/>'
       str << '</c:valAx>'
     end
-
   end
 end

data/lib/axlsx/drawing/view_3D.rb

@@ -1,8 +1,8 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 module Axlsx
   # 3D attributes for a chart.
   class View3D
-
     include Axlsx::OptionsParser
 
     # Creates a new View3D for charts
@@ -12,16 +12,16 @@ module Axlsx
     # @option options [String] depth_percent
     # @option options [Boolean] r_ang_ax
     # @option options [Integer] perspective
-    def initialize(options={})
-      @rot_x, @h_percent, @rot_y, @depth_percent, @r_ang_ax, @perspective  = nil, nil, nil, nil, nil, nil
+    def initialize(options = {})
+      @rot_x, @h_percent, @rot_y, @depth_percent, @r_ang_ax, @perspective = nil, nil, nil, nil, nil, nil
       parse_options options
     end
 
     # Validation for hPercent
-    H_PERCENT_REGEX = /0*(([5-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)/
+    H_PERCENT_REGEX = /0*(([5-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)/.freeze
 
     # validation for depthPercent
-    DEPTH_PERCENT_REGEX = /0*(([2-9][0-9])|([1-9][0-9][0-9])|(1[0-9][0-9][0-9])|2000)/
+    DEPTH_PERCENT_REGEX = /0*(([2-9][0-9])|([1-9][0-9][0-9])|(1[0-9][0-9][0-9])|2000)/.freeze
 
     # x rotation for the chart
     # must be between -90 and 90
@@ -63,40 +63,40 @@ module Axlsx
     end
     alias :rotX= :rot_x=
 
-      # @see h_percent
-      def h_percent=(v)
-        RegexValidator.validate "#{self.class}.h_percent", H_PERCENT_REGEX, v
-        @h_percent = v
-      end
+    # @see h_percent
+    def h_percent=(v)
+      RegexValidator.validate "#{self.class}.h_percent", H_PERCENT_REGEX, v
+      @h_percent = v
+    end
     alias :hPercent= :h_percent=
 
-      # @see rot_y
-      def rot_y=(v) 
-        RangeValidator.validate "View3D.rot_y", 0, 360, v
-        @rot_y = v
-      end
+    # @see rot_y
+    def rot_y=(v)
+      RangeValidator.validate "View3D.rot_y", 0, 360, v
+      @rot_y = v
+    end
     alias :rotY= :rot_y=
 
-      # @see depth_percent
-      def depth_percent=(v) RegexValidator.validate "#{self.class}.depth_percent", DEPTH_PERCENT_REGEX, v; @depth_percent = v; end
+    # @see depth_percent
+    def depth_percent=(v) RegexValidator.validate "#{self.class}.depth_percent", DEPTH_PERCENT_REGEX, v; @depth_percent = v; end
     alias :depthPercent= :depth_percent=
 
-      # @see r_ang_ax
-      def r_ang_ax=(v) Axlsx::validate_boolean(v); @r_ang_ax = v; end
+    # @see r_ang_ax
+    def r_ang_ax=(v) Axlsx.validate_boolean(v); @r_ang_ax = v; end
     alias :rAngAx= :r_ang_ax=
 
-      # @see perspective
-      def perspective=(v)
-        RangeValidator.validate "View3D.perspective", 0, 240, v
-        @perspective = v
-      end
+    # @see perspective
+    def perspective=(v)
+      RangeValidator.validate "View3D.perspective", 0, 240, v
+      @perspective = v
+    end
 
     # DataTypeValidator.validate "#{self.class}.perspective", [Integer], v, lambda {|arg| arg >= 0 && arg <= 240 }; @perspective = v; end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<c:view3D>'
       %w(rot_x h_percent rot_y depth_percent r_ang_ax perspective).each do |key|
         str << element_for_attribute(key, 'c')
@@ -105,11 +105,13 @@ module Axlsx
     end
 
     private
-    # Note: move this to Axlsx module if we find the smae pattern elsewhere.
-    def element_for_attribute(name, namespace='')
+
+    # NOTE: move this to Axlsx module if we find the same pattern elsewhere.
+    def element_for_attribute(name, namespace = '')
       val = Axlsx.instance_values_for(self)[name]
-      return "" if val == nil
-      "<%s:%s val='%s'/>" % [namespace, Axlsx::camel(name, false), val]
+      return "" if val.nil?
+
+      format("<%s:%s val='%s'/>", namespace, Axlsx.camel(name, false), val)
     end
   end
 end

data/lib/axlsx/drawing/vml_drawing.rb

@@ -1,42 +1,41 @@
-module Axlsx
+# frozen_string_literal: true
 
-  # a vml drawing used for comments in excel.
+module Axlsx
+  # a vml drawing used for comments in Excel.
   class VmlDrawing
-
     # creates a new Vml Drawing object.
     # @param [Comments] comments the comments object this drawing is associated with
     def initialize(comments)
       raise ArgumentError, "you must provide a comments object" unless comments.is_a?(Comments)
+
       @comments = comments
     end
 
     # The part name for this vml drawing
     # @return [String]
     def pn
-      "#{VML_DRAWING_PN}" % (@comments.worksheet.index + 1)
+      format(VML_DRAWING_PN, @comments.worksheet.index + 1)
     end
 
     # serialize the vml_drawing to xml.
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
-      str << <<BAD_PROGRAMMER
-<xml xmlns:v="urn:schemas-microsoft-com:vml"
- xmlns:o="urn:schemas-microsoft-com:office:office"
- xmlns:x="urn:schemas-microsoft-com:office:excel">
- <o:shapelayout v:ext="edit">
-  <o:idmap v:ext="edit" data="#{@comments.worksheet.index+1}"/>
- </o:shapelayout>
- <v:shapetype id="_x0000_t202" coordsize="21600,21600" o:spt="202"
-  path="m0,0l0,21600,21600,21600,21600,0xe">
-  <v:stroke joinstyle="miter"/>
-  <v:path gradientshapeok="t" o:connecttype="rect"/>
- </v:shapetype>
-BAD_PROGRAMMER
+    def to_xml_string(str = +'')
+      str << <<~XML
+        <xml xmlns:v="urn:schemas-microsoft-com:vml"
+         xmlns:o="urn:schemas-microsoft-com:office:office"
+         xmlns:x="urn:schemas-microsoft-com:office:excel">
+         <o:shapelayout v:ext="edit">
+          <o:idmap v:ext="edit" data="#{@comments.worksheet.index + 1}"/>
+         </o:shapelayout>
+         <v:shapetype id="_x0000_t202" coordsize="21600,21600" o:spt="202"
+          path="m0,0l0,21600,21600,21600,21600,0xe">
+          <v:stroke joinstyle="miter"/>
+          <v:path gradientshapeok="t" o:connecttype="rect"/>
+         </v:shapetype>
+      XML
       @comments.each { |comment| comment.vml_shape.to_xml_string str }
       str << "</xml>"
-
     end
-
   end
 end

data/lib/axlsx/drawing/vml_shape.rb

@@ -1,8 +1,8 @@
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # A VmlShape is used to position and render a comment.
   class VmlShape
-
     include Axlsx::OptionsParser
     include Axlsx::Accessors
 
@@ -17,14 +17,14 @@ module Axlsx
     # @option options [Integer] right_offset
     # @option options [Integer] bottom_row
     # @option options [Integer] bottom_offset
-    def initialize(options={})
+    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
+      @id = Array.new(8) { rand(65..89).chr }.join
       parse_options options
       yield self if block_given?
     end
@@ -37,30 +37,29 @@ module Axlsx
     # serialize the shape to a string
     # @param [String] str
     # @return [String]
-    def to_xml_string(str ='')
-str << <<SHAME_ON_YOU
-
-<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"/>
-  <v:textbox style='mso-fit-text-with-word-wrap:t'>
-   <div style='text-align:left'></div>
-  </v:textbox>
+    def to_xml_string(str = +'')
+      str << <<~XML
 
-  <x:ClientData ObjectType="Note">
-   <x:MoveWithCells/>
-   <x:SizeWithCells/>
-   <x:Anchor>#{left_column}, #{left_offset}, #{top_row}, #{top_offset}, #{right_column}, #{right_offset}, #{bottom_row}, #{bottom_offset}</x:Anchor>
-   <x:AutoFill>False</x:AutoFill>
-   <x:Row>#{row}</x:Row>
-   <x:Column>#{column}</x:Column>
-   #{@visible ? '<x:Visible/>' : ''}
-  </x:ClientData>
- </v:shape>
-SHAME_ON_YOU
+        <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"/>
+          <v:textbox style='mso-fit-text-with-word-wrap:t'>
+           <div style='text-align:left'></div>
+          </v:textbox>
 
+          <x:ClientData ObjectType="Note">
+           <x:MoveWithCells/>
+           <x:SizeWithCells/>
+           <x:Anchor>#{left_column}, #{left_offset}, #{top_row}, #{top_offset}, #{right_column}, #{right_offset}, #{bottom_row}, #{bottom_offset}</x:Anchor>
+           <x:AutoFill>False</x:AutoFill>
+           <x:Row>#{row}</x:Row>
+           <x:Column>#{column}</x:Column>
+           #{@visible ? '<x:Visible/>' : ''}
+          </x:ClientData>
+         </v:shape>
+      XML
     end
   end
 end