caxlsx 3.3.0 → 4.0.0

data/lib/axlsx/drawing/line_chart.rb

@@ -1,6 +1,6 @@
-# encoding: UTF-8
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # The LineChart is a two dimentional line chart (who would have guessed?) that you can add to your worksheet.
   # @example Creating a chart
   #   # This example creates a line in a single sheet.
@@ -20,7 +20,6 @@ module Axlsx
   # @see Series
   # @see Package#serialize
   class LineChart < Chart
-
     # the category axis
     # @return [CatAxis]
     def cat_axis
@@ -35,7 +34,7 @@ module Axlsx
     end
     alias :valAxis :val_axis
 
-     # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
     # @return [Symbol]
     attr_reader :grouping
 
@@ -45,7 +44,7 @@ module Axlsx
     # @option options [Boolean] show_legend
     # @option options [Symbol] grouping
     # @see Chart
-    def initialize(frame, options={})
+    def initialize(frame, options = {})
       @vary_colors = false
       @grouping = :standard
       super(frame, options)
@@ -64,9 +63,9 @@ module Axlsx
     # chart based on the actual class type and not a fixed node name.
     # @return [String]
     def node_name
-      path = self.class.to_s
+      path = self.class.name
       if i = path.rindex('::')
-        path = path[(i+2)..-1]
+        path = path[(i + 2)..-1]
       end
       path[0] = path[0].chr.downcase
       path
@@ -75,16 +74,16 @@ 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:" << node_name << ">")
-        str << ('<c:grouping val="' << grouping.to_s << '"/>')
-        str << ('<c:varyColors val="' << vary_colors.to_s << '"/>')
+        str << "<c:" << node_name << ">"
+        str << '<c:grouping val="' << grouping.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
         yield if block_given?
-        axes.to_xml_string(str, :ids => true)
-        str << ("</c:" << node_name << ">")
+        axes.to_xml_string(str, ids: true)
+        str << "</c:" << node_name << ">"
         axes.to_xml_string(str)
       end
     end
@@ -93,7 +92,7 @@ module Axlsx
     # axis.
     # @return [Axes]
     def axes
-      @axes ||= Axes.new(:cat_axis => CatAxis, :val_axis => ValAxis)
+      @axes ||= Axes.new(cat_axis: CatAxis, val_axis: ValAxis)
     end
   end
 end

data/lib/axlsx/drawing/line_series.rb

@@ -1,11 +1,11 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 module Axlsx
   # A LineSeries defines the title, data and labels for line charts
   # @note The recommended way to manage series is to use Chart#add_series
   # @see Worksheet#add_chart
   # @see Chart#add_series
   class LineSeries < Series
-
     # The data for this series.
     # @return [ValAxisData]
     attr_reader :data
@@ -35,13 +35,13 @@ module Axlsx
     # @option options [Array, SimpleTypedList] data
     # @option options [Array, SimpleTypedList] labels
     # @param [Chart] chart
-    def initialize(chart, options={})
+    def initialize(chart, options = {})
       @show_marker = false
-      @marker_symbol = options[:marker_symbol] ? options[:marker_symbol] : :default
+      @marker_symbol = options[:marker_symbol] || :default
       @smooth = false
       @labels, @data = nil, nil
       super(chart, options)
-      @labels = AxDataSource.new(:data => options[:labels]) unless options[:labels].nil?
+      @labels = AxDataSource.new(data: options[:labels]) unless options[:labels].nil?
       @data = NumDataSource.new(options) unless options[:data].nil?
     end
 
@@ -52,34 +52,34 @@ module Axlsx
 
     # @see show_marker
     def show_marker=(v)
-      Axlsx::validate_boolean(v)
+      Axlsx.validate_boolean(v)
       @show_marker = v
     end
 
     # @see marker_symbol
     def marker_symbol=(v)
-      Axlsx::validate_marker_symbol(v)
+      Axlsx.validate_marker_symbol(v)
       @marker_symbol = v
     end
 
     # @see smooth
     def smooth=(v)
-      Axlsx::validate_boolean(v)
+      Axlsx.validate_boolean(v)
       @smooth = v
     end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       super(str) do
         if color
           str << '<c:spPr><a:solidFill>'
-          str << ('<a:srgbClr val="' << color << '"/>')
+          str << '<a:srgbClr val="' << color << '"/>'
           str << '</a:solidFill>'
           str << '<a:ln w="28800">'
           str << '<a:solidFill>'
-          str << ('<a:srgbClr val="' << color << '"/>')
+          str << '<a:srgbClr val="' << color << '"/>'
           str << '</a:solidFill>'
           str << '</a:ln>'
           str << '<a:round/>'
@@ -89,12 +89,12 @@ module Axlsx
         if !@show_marker
           str << '<c:marker><c:symbol val="none"/></c:marker>'
         elsif @marker_symbol != :default
-          str << '<c:marker><c:symbol val="' + @marker_symbol.to_s + '"/></c:marker>'
+          str << '<c:marker><c:symbol val="' << @marker_symbol.to_s << '"/></c:marker>'
         end
 
         @labels.to_xml_string(str) unless @labels.nil?
         @data.to_xml_string(str) unless @data.nil?
-        str << ('<c:smooth val="' << ((smooth) ? '1' : '0') << '"/>')
+        str << '<c:smooth val="' << (smooth ? '1' : '0') << '"/>'
       end
     end
 
@@ -105,6 +105,5 @@ module Axlsx
 
     # assigns the labels for this series
     def labels=(v) DataTypeValidator.validate "Series.labels", [AxDataSource], v; @labels = v; end
-
   end
 end

data/lib/axlsx/drawing/marker.rb

@@ -1,10 +1,10 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 module Axlsx
   # The Marker class defines a point in the worksheet that drawing anchors attach to.
   # @note The recommended way to manage markers is Worksheet#add_chart Markers are created for a two cell anchor based on the :start and :end options.
   # @see Worksheet#add_chart
   class Marker
-
     include Axlsx::OptionsParser
 
     # Creates a new Marker object
@@ -12,7 +12,7 @@ module Axlsx
     # @option options [Integer] colOff
     # @option options [Integer] row
     # @option options [Integer] rowOff
-    def initialize(options={})
+    def initialize(options = {})
       @col, @colOff, @row, @rowOff = 0, 0, 0, 0
       parse_options options
     end
@@ -33,21 +33,21 @@ module Axlsx
     # @return [Integer]
     attr_reader :rowOff
 
-     # @see col
-    def col=(v) Axlsx::validate_unsigned_int v; @col = v end
+    # @see col
+    def col=(v) Axlsx.validate_unsigned_int v; @col = v end
     # @see colOff
-    def colOff=(v) Axlsx::validate_int v; @colOff = v end
+    def colOff=(v) Axlsx.validate_int v; @colOff = v end
     # @see row
-    def row=(v) Axlsx::validate_unsigned_int v; @row = v end
+    def row=(v) Axlsx.validate_unsigned_int v; @row = v end
     # @see rowOff
-    def rowOff=(v) Axlsx::validate_int v; @rowOff = v end
+    def rowOff=(v) Axlsx.validate_int v; @rowOff = v end
 
     # shortcut to set the column, row position for this marker
     # @param col the column for the marker, a Cell object or a string reference like "B7"
     # or an Array.
     # @param row the row of the marker. This is ignored if the col parameter is a Cell or
     # String or Array.
-    def coord(col, row=0)
+    def coord(col, row = 0)
       coordinates = parse_coord_args(col, row)
       self.col = coordinates[0]
       self.row = coordinates[1]
@@ -56,18 +56,19 @@ module Axlsx
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       [:col, :colOff, :row, :rowOff].each do |k|
-        str << ('<xdr:' << k.to_s << '>' << self.send(k).to_s << '</xdr:' << k.to_s << '>')
+        str << '<xdr:' << k.to_s << '>' << send(k).to_s << '</xdr:' << k.to_s << '>'
       end
     end
+
     private
 
     # handles multiple inputs for setting the position of a marker
     # @see Chart#start_at
-    def parse_coord_args(x, y=0)
+    def parse_coord_args(x, y = 0)
       if x.is_a?(String)
-        x, y = *Axlsx::name_to_indices(x)
+        x, y = *Axlsx.name_to_indices(x)
       end
       if x.is_a?(Cell)
         x, y = *x.pos
@@ -77,8 +78,5 @@ module Axlsx
       end
       [x, y]
     end
-
-
   end
-
 end

data/lib/axlsx/drawing/num_data.rb

@@ -1,16 +1,15 @@
-# -*- coding: utf-8 -*-
-module Axlsx
+# frozen_string_literal: true
 
-  #This class specifies data for a particular data point. It is used for both numCache and numLit object
+module Axlsx
+  # This class specifies data for a particular data point. It is used for both numCache and numLit object
   class NumData
-
     include Axlsx::OptionsParser
 
     # creates a new NumVal object
     # @option options [String] formatCode
     # @option options [Array] :data
     # @see StrData
-    def initialize(options={})
+    def initialize(options = {})
       @format_code = "General"
       @pt = SimpleTypedList.new NumVal
       parse_options options
@@ -22,31 +21,29 @@ 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) ? :numCache : :numLit
       values.each do |value|
         value = value.is_formula? ? 0 : value.value if value.is_a?(Cell)
-        @pt << NumVal.new(:v => value)
+        @pt << NumVal.new(v: value)
       end
     end
 
     # @see format_code
-    def format_code=(v='General')
-      Axlsx::validate_string(v)
+    def format_code=(v = 'General')
+      Axlsx.validate_string(v)
       @format_code = v
     end
 
     # serialize the object
-    def to_xml_string(str = "")
-      str << ('<c:' << @tag_name.to_s << '>')
-      str << ('<c:formatCode>' << format_code.to_s << '</c:formatCode>')
-      str << ('<c:ptCount val="' << @pt.size.to_s << '"/>')
+    def to_xml_string(str = +'')
+      str << '<c:' << @tag_name.to_s << '>'
+      str << '<c:formatCode>' << format_code.to_s << '</c:formatCode>'
+      str << '<c:ptCount val="' << @pt.size.to_s << '"/>'
       @pt.each_with_index do |num_val, index|
         num_val.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/num_data_source.rb

@@ -1,14 +1,14 @@
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # A numeric data source for use by charts.
   class NumDataSource
-
     include Axlsx::OptionsParser
 
     # creates a new NumDataSource object
     # @option options [Array] data An array of Cells or Numeric objects
     # @option options [Symbol] tag_name see tag_name
-    def initialize(options={})
+    def initialize(options = {})
       # override these three in child classes
       @data_type ||= NumData
       @tag_name ||= :val
@@ -17,12 +17,11 @@ module Axlsx
       @f = nil
       @data = @data_type.new(options)
       if options[:data] && options[:data].first.is_a?(Cell)
-        @f = Axlsx::cell_range(options[:data])
+        @f = Axlsx.cell_range(options[:data])
       end
       parse_options options
     end
 
-
     # The tag name to use when serializing this data source.
     # Only items defined in allowed_tag_names are allowed
     # @return [Symbol]
@@ -36,7 +35,7 @@ module Axlsx
       [:yVal, :val, :bubbleSize]
     end
 
-     # sets the tag name for this data source
+    # sets the tag name for this data source
     # @param [Symbol] v One of the allowed_tag_names
     def tag_name=(v)
       Axlsx::RestrictionValidator.validate "#{self.class.name}.tag_name", self.class.allowed_tag_names, v
@@ -45,18 +44,17 @@ module Axlsx
 
     # serialize the object
     # @param [String] str
-    def to_xml_string(str="")
-      str << ('<c:' << tag_name.to_s << '>')
+    def to_xml_string(str = +'')
+      str << '<c:' << tag_name.to_s << '>'
       if @f
-        str << ('<c:' << @ref_tag_name.to_s << '>')
-        str << ('<c:f>' << @f.to_s << '</c:f>')
+        str << '<c:' << @ref_tag_name.to_s << '>'
+        str << '<c:f>' << @f.to_s << '</c:f>'
       end
       @data.to_xml_string str
       if @f
-        str << ('</c:' << @ref_tag_name.to_s << '>')
+        str << '</c:' << @ref_tag_name.to_s << '>'
       end
-      str << ('</c:' << tag_name.to_s << '>')
+      str << '</c:' << tag_name.to_s << '>'
     end
   end
 end
-

data/lib/axlsx/drawing/num_val.rb

@@ -1,9 +1,8 @@
-# -*- 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 NumVal < StrVal
-
     # A string representing the format code to apply.
     # For more information see see the SpreadsheetML numFmt element's (§18.8.30) formatCode attribute.
     # @return [String]
@@ -12,22 +11,22 @@ module Axlsx
     # creates a new NumVal object
     # @option options [String] formatCode
     # @option options [Integer] v
-    def initialize(options={})
+    def initialize(options = {})
       @format_code = "General"
       super(options)
     end
 
     # @see format_code
     def format_code=(v)
-      Axlsx::validate_string(v)
+      Axlsx.validate_string(v)
       @format_code = v
     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 << '" formatCode="' << format_code << '"><c:v>' << 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 << '" formatCode="' << format_code << '"><c:v>' << v.to_s << '</c:v></c:pt>'
       end
     end
   end

data/lib/axlsx/drawing/one_cell_anchor.rb

@@ -1,11 +1,11 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 module Axlsx
   # This class details a single cell anchor for drawings.
   # @note The recommended way to manage drawings, images and charts is Worksheet#add_chart or Worksheet#add_image.
   # @see Worksheet#add_chart
   # @see Worksheet#add_image
   class OneCellAnchor
-
     include Axlsx::OptionsParser
 
     # Creates a new OneCellAnchor object and an Pic associated with it.
@@ -16,7 +16,7 @@ module Axlsx
     # @option options [String] image_src the file location of the image you will render
     # @option options [String] name the name attribute for the rendered image
     # @option options [String] descr the description of the image rendered
-    def initialize(drawing, options={})
+    def initialize(drawing, options = {})
       @drawing = drawing
       @width = 0
       @height = 0
@@ -54,15 +54,16 @@ module Axlsx
     # We just 'figure it out' for you.
     # @param [Array, String, Cell, Integer] x Accepts many inputs for defining the starting position of the cell.
     # @param [Integer] y When x is an integer, this value is used for the row index at which the anchor starts.
-    def start_at(x, y=0)
+    def start_at(x, y = 0)
       from.coord x, y
     end
+
     #
     # @see height
-    def height=(v) Axlsx::validate_unsigned_int(v); @height = v; end
+    def height=(v) Axlsx.validate_unsigned_int(v); @height = v; end
 
     # @see width
-    def width=(v) Axlsx::validate_unsigned_int(v); @width = v; end
+    def width=(v) Axlsx.validate_unsigned_int(v); @width = v; end
 
     # The index of this anchor in the drawing
     # @return [Integer]
@@ -73,12 +74,12 @@ module Axlsx
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<xdr:oneCellAnchor>'
       str << '<xdr:from>'
       from.to_xml_string(str)
       str << '</xdr:from>'
-      str << ('<xdr:ext cx="' << ext[:cx].to_s << '" cy="' << ext[:cy].to_s << '"/>')
+      str << '<xdr:ext cx="' << ext[:cx].to_s << '" cy="' << ext[:cy].to_s << '"/>'
       @object.to_xml_string(str)
       str << '<xdr:clientData/>'
       str << '</xdr:oneCellAnchor>'
@@ -92,8 +93,7 @@ module Axlsx
     def ext
       cy = @height * 914400 / 96
       cx = @width * 914400 / 96
-      {:cy=>cy, :cx=>cx}
+      { cy: cy, cx: cx }
     end
-
   end
 end