caxlsx 3.4.1 → 4.0.0

data/lib/axlsx/drawing/scatter_chart.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # The ScatterChart allows you to insert a scatter chart into your worksheet
   # @see Worksheet#add_chart
@@ -47,14 +49,14 @@ module Axlsx
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       super(str) do
         str << '<c:scatterChart>'
-        str << ('<c:scatterStyle val="' << scatter_style.to_s << '"/>')
-        str << ('<c:varyColors val="' << vary_colors.to_s << '"/>')
+        str << '<c:scatterStyle val="' << scatter_style.to_s << '"/>'
+        str << '<c:varyColors val="' << vary_colors.to_s << '"/>'
         @series.each { |ser| ser.to_xml_string(str) }
         d_lbls.to_xml_string(str) if @d_lbls
-        axes.to_xml_string(str, :ids => true)
+        axes.to_xml_string(str, ids: true)
         str << '</c:scatterChart>'
         axes.to_xml_string(str)
       end
@@ -65,7 +67,7 @@ module Axlsx
     # a y_val_axis
     # @return [Axes]
     def axes
-      @axes ||= Axes.new(:x_val_axis => ValAxis, :y_val_axis => ValAxis)
+      @axes ||= Axes.new(x_val_axis: ValAxis, y_val_axis: ValAxis)
     end
   end
 end

data/lib/axlsx/drawing/scatter_series.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # A ScatterSeries defines the x and y position of data in the chart
   # @note The recommended way to manage series is to use Chart#add_series
@@ -41,7 +43,7 @@ module Axlsx
         @smooth = [:smooth, :smoothMarker].include?(chart.scatter_style)
       else
         # Set smoothing according to the option provided
-        Axlsx::validate_boolean(options[:smooth])
+        Axlsx.validate_boolean(options[:smooth])
         @smooth = options[:smooth]
       end
       @ln_width = options[:ln_width] unless options[:ln_width].nil?
@@ -49,8 +51,8 @@ module Axlsx
       @marker_symbol = :default
 
       super(chart, options)
-      @xData = AxDataSource.new(:tag_name => :xVal, :data => options[:xData]) unless options[:xData].nil?
-      @yData = NumDataSource.new({ :tag_name => :yVal, :data => options[:yData] }) unless options[:yData].nil?
+      @xData = AxDataSource.new(tag_name: :xVal, data: options[:xData]) unless options[:xData].nil?
+      @yData = NumDataSource.new({ tag_name: :yVal, data: options[:yData] }) unless options[:yData].nil?
     end
 
     # @see color
@@ -60,7 +62,7 @@ module Axlsx
 
     # @see smooth
     def smooth=(v)
-      Axlsx::validate_boolean(v)
+      Axlsx.validate_boolean(v)
       @smooth = v
     end
 
@@ -71,29 +73,29 @@ module Axlsx
 
     # @see marker_symbol
     def marker_symbol=(v)
-      Axlsx::validate_marker_symbol(v)
+      Axlsx.validate_marker_symbol(v)
       @marker_symbol = v
     end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       super(str) do
         # needs to override the super color here to push in ln/and something else!
         if color
           str << '<c:spPr><a:solidFill>'
-          str << ('<a:srgbClr val="' << color << '"/>')
+          str << '<a:srgbClr val="' << color << '"/>'
           str << '</a:solidFill>'
           str << '<a:ln><a:solidFill>'
-          str << ('<a:srgbClr val="' << color << '"/></a:solidFill></a:ln>')
+          str << '<a:srgbClr val="' << color << '"/></a:solidFill></a:ln>'
           str << '</c:spPr>'
           str << '<c:marker>'
           str << '<c:spPr><a:solidFill>'
-          str << ('<a:srgbClr val="' << color << '"/>')
+          str << '<a:srgbClr val="' << color << '"/>'
           str << '</a:solidFill>'
           str << '<a:ln><a:solidFill>'
-          str << ('<a:srgbClr val="' << color << '"/></a:solidFill></a:ln>')
+          str << '<a:srgbClr val="' << color << '"/></a:solidFill></a:ln>'
           str << '</c:spPr>'
           str << marker_symbol_xml
           str << '</c:marker>'
@@ -108,7 +110,7 @@ module Axlsx
         end
         @xData.to_xml_string(str) unless @xData.nil?
         @yData.to_xml_string(str) unless @yData.nil?
-        str << ('<c:smooth val="' << ((smooth) ? '1' : '0') << '"/>')
+        str << '<c:smooth val="' << (smooth ? '1' : '0') << '"/>'
       end
       str
     end
@@ -119,7 +121,7 @@ module Axlsx
       if !@show_marker
         '<c:symbol val="none"/>'
       elsif @marker_symbol != :default
-        '<c:symbol val="' + @marker_symbol.to_s + '"/>'
+        +'<c:symbol val="' << @marker_symbol.to_s << '"/>'
       end.to_s
     end
   end

data/lib/axlsx/drawing/ser_axis.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # A SerAxis object defines a series axis
   class SerAxis < Axis
@@ -20,21 +22,21 @@ module Axlsx
     end
 
     # @see tickLblSkip
-    def tick_lbl_skip=(v) Axlsx::validate_unsigned_int(v); @tick_lbl_skip = v; end
+    def tick_lbl_skip=(v) Axlsx.validate_unsigned_int(v); @tick_lbl_skip = v; end
     alias :tickLblSkip= :tick_lbl_skip=
 
     # @see tickMarkSkip
-    def tick_mark_skip=(v) Axlsx::validate_unsigned_int(v); @tick_mark_skip = v; end
+    def tick_mark_skip=(v) Axlsx.validate_unsigned_int(v); @tick_mark_skip = v; end
     alias :tickMarkSkip= :tick_mark_skip=
 
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<c:serAx>'
       super(str)
-      str << ('<c:tickLblSkip val="' << @tick_lbl_skip.to_s << '"/>') unless @tick_lbl_skip.nil?
-      str << ('<c:tickMarkSkip val="' << @tick_mark_skip.to_s << '"/>') unless @tick_mark_skip.nil?
+      str << '<c:tickLblSkip val="' << @tick_lbl_skip.to_s << '"/>' unless @tick_lbl_skip.nil?
+      str << '<c:tickMarkSkip val="' << @tick_mark_skip.to_s << '"/>' unless @tick_mark_skip.nil?
       str << '</c:serAx>'
     end
   end

data/lib/axlsx/drawing/series.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # A Series defines the common series attributes and is the super class for all concrete series types.
   # @note The recommended way to manage series is to use Chart#add_series
@@ -38,7 +40,7 @@ module Axlsx
     end
 
     # @see order
-    def order=(v) Axlsx::validate_unsigned_int(v); @order = v; end
+    def order=(v) Axlsx.validate_unsigned_int(v); @order = v; end
 
     # @see title
     def title=(v)
@@ -55,10 +57,10 @@ module Axlsx
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<c:ser>'
-      str << ('<c:idx val="' << index.to_s << '"/>')
-      str << ('<c:order val="' << (order || index).to_s << '"/>')
+      str << '<c:idx val="' << index.to_s << '"/>'
+      str << '<c:order val="' << (order || index).to_s << '"/>'
       title.to_xml_string(str) unless title.nil?
       yield if block_given?
       str << '</c:ser>'

data/lib/axlsx/drawing/series_title.rb

@@ -1,19 +1,21 @@
+# 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,3 +1,5 @@
+# frozen_string_literal: true
+
 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
@@ -20,18 +22,18 @@ module Axlsx
       @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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # This class specifies data for a particular data point.
   class StrVal
@@ -21,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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # A Title stores information about the title of a chart
   class Title
@@ -18,11 +20,11 @@ module Axlsx
     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
@@ -30,7 +32,6 @@ module Axlsx
       DataTypeValidator.validate 'Title.text', String, v
       @text = v
       @cell = nil
-      v
     end
 
     # @see text_size
@@ -38,7 +39,6 @@ module Axlsx
       DataTypeValidator.validate 'Title.text_size', String, v
       @text_size = v
       @cell = nil
-      v
     end
 
     # @see cell
@@ -46,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.
@@ -67,18 +66,18 @@ module Axlsx
     # 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>'
@@ -88,8 +87,8 @@ module Axlsx
           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:rPr sz="' << @text_size.to_s << '"/>'
+          str << '<a:t>' << clean_value << '</a:t>'
           str << '</a:r>'
           str << '</a:p>'
           str << '</c:rich>'

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -1,3 +1,5 @@
+# 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.
@@ -33,7 +35,7 @@ module Axlsx
     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
@@ -79,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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # the ValAxis class defines a chart value axis.
   class ValAxis < Axis
@@ -24,10 +26,10 @@ 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

data/lib/axlsx/drawing/view_3D.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # 3D attributes for a chart.
   class View3D
@@ -16,10 +18,10 @@ module Axlsx
     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
@@ -80,7 +82,7 @@ module Axlsx
     alias :depthPercent= :depth_percent=
 
     # @see r_ang_ax
-    def r_ang_ax=(v) Axlsx::validate_boolean(v); @r_ang_ax = v; end
+    def r_ang_ax=(v) Axlsx.validate_boolean(v); @r_ang_ax = v; end
     alias :rAngAx= :r_ang_ax=
 
     # @see perspective
@@ -94,7 +96,7 @@ module Axlsx
     # 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')
@@ -104,12 +106,12 @@ module Axlsx
 
     private
 
-    # Note: move this to Axlsx module if we find the smae pattern elsewhere.
+    # 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
+      return "" if val.nil?
 
-      "<%s:%s val='%s'/>" % [namespace, Axlsx::camel(name, false), val]
+      format("<%s:%s val='%s'/>", namespace, Axlsx.camel(name, false), val)
     end
   end
 end

data/lib/axlsx/drawing/vml_drawing.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Axlsx
-  # a vml drawing used for comments in excel.
+  # 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
@@ -12,26 +14,26 @@ module Axlsx
     # 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

data/lib/axlsx/drawing/vml_shape.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # A VmlShape is used to position and render a comment.
   class VmlShape
@@ -22,7 +24,7 @@ module Axlsx
       @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
@@ -35,29 +37,29 @@ module Axlsx
     # serialize the shape to a string
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
-      str << <<SHAME_ON_YOU
+    def to_xml_string(str = +'')
+      str << <<~XML
 
-<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>
+        <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>
-SHAME_ON_YOU
+          <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