caxlsx 3.4.1 → 4.1.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # Sheet formatting properties
   # <xsd:complexType name="CT_SheetFormatPr">
@@ -46,8 +48,10 @@ module Axlsx
     # serializes this object to an xml string
     # @param [String] str The string this objects serialization will be appended to
     # @return [String]
-    def to_xml_string(str = '')
-      str << "<sheetFormatPr #{serialized_attributes}/>"
+    def to_xml_string(str = +'')
+      str << '<sheetFormatPr '
+      serialized_attributes(str)
+      str << '/>'
     end
 
     private

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # The SheetPr class manages serialization of a worksheet's sheetPr element.
   class SheetPr
@@ -48,9 +50,11 @@ module Axlsx
     # Serialize the object
     # @param [String] str serialized output will be appended to this object if provided.
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       update_properties
-      str << "<sheetPr #{serialized_attributes}>"
+      str << '<sheetPr '
+      serialized_attributes(str)
+      str << '>'
       tab_color.to_xml_string(str, 'tabColor') if tab_color
       outline_pr.to_xml_string(str) if @outline_pr
       page_setup_pr.to_xml_string(str)
@@ -71,14 +75,14 @@ module Axlsx
 
     # @see tab_color
     def tab_color=(v)
-      @tab_color = Color.new(:rgb => v)
+      @tab_color = Color.new(rgb: v)
     end
 
     private
 
     def update_properties
       page_setup_pr.fit_to_page = worksheet.fit_to_page?
-      if worksheet.auto_filter.columns.size > 0
+      unless worksheet.auto_filter.columns.empty?
         self.filter_mode = 1
         self.enable_format_conditions_calculation = 1
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # The SheetProtection object manages worksheet protection options per sheet.
   class SheetProtection
@@ -65,7 +67,7 @@ module Axlsx
 
     # encodes password for protection locking
     def password=(v)
-      return if v == nil
+      return if v.nil?
 
       @password = create_password_hash(v)
     end
@@ -73,7 +75,7 @@ module Axlsx
     # Serialize the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       serialized_tag('sheetProtection', str)
     end
 
@@ -85,27 +87,27 @@ module Axlsx
       encoded_password = encode_password(password)
 
       password_as_hex = [encoded_password].pack("v")
-      password_as_string = password_as_hex.unpack("H*").first.upcase
+      password_as_string = password_as_hex.unpack1("H*").upcase
 
       password_as_string[2..3] + password_as_string[0..1]
     end
 
     # Encodes a given password
     # Based on the algorithm provided by Daniel Rentz of OpenOffice.
-    # http://www.openoffice.org/sc/excelfileformat.pdf, Revision 1.42, page 115 (21.05.2012)
+    # https://www.openoffice.org/sc/excelfileformat.pdf, Revision 1.42, page 115 (21.05.2012)
     # @return [String]
     def encode_password(password)
       i = 0
-      chars = password.split(//)
+      chars = password.chars
       count = chars.size
 
       chars.collect! do |char|
         i += 1
-        char     = char.unpack('c')[0] << i # ord << i
+        char     = char.unpack1('c') << i # ord << i
         low_15   = char & 0x7fff
-        high_15  = char & 0x7fff << 15
-        high_15  = high_15 >> 15
-        char     = low_15 | high_15
+        high_15  = char & (0x7fff << 15)
+        high_15 >>= 15
+        low_15 | high_15
       end
 
       encoded_password = 0x0000

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # View options for a worksheet.
   #
@@ -31,8 +33,8 @@ module Axlsx
     def initialize(options = {})
       # defaults
       @color_id = @top_left_cell = @pane = nil
-      @right_to_left = @show_formulas = @show_outline_symbols = @show_white_space = @tab_selected = @window_protection = false
-      @default_grid_color = @show_grid_lines = @show_row_col_headers = @show_ruler = @show_zeros = true
+      @right_to_left = @show_formulas = @show_white_space = @tab_selected = @window_protection = false
+      @default_grid_color = @show_grid_lines = @show_row_col_headers = @show_ruler = @show_zeros = @show_outline_symbols = true
       @zoom_scale = 100
       @zoom_scale_normal = @zoom_scale_page_layout_view = @zoom_scale_sheet_layout_view = @workbook_view_id = 0
       @selections = {}
@@ -48,7 +50,7 @@ module Axlsx
                             :view, :top_left_cell, :color_id, :zoom_scale
 
     # instance values that must be serialized as their own elements - e.g. not attributes.
-    CHILD_ELEMENTS = [:pane, :selections]
+    CHILD_ELEMENTS = [:pane, :selections].freeze
 
     # The pane object for the sheet view
     # @return [Pane]
@@ -156,47 +158,68 @@ module Axlsx
     # param [Hash] options
     # return [Selection]
     def add_selection(pane, options = {})
-      @selections[pane] = Selection.new(options.merge(:pane => pane))
+      @selections[pane] = Selection.new(options.merge(pane: pane))
     end
 
     # @see color_id
-    def color_id=(v); Axlsx::validate_unsigned_int(v); @color_id = v end
+    def color_id=(v)
+      Axlsx.validate_unsigned_int(v)
+      @color_id = v
+    end
 
     # @see top_left_cell
     def top_left_cell=(v)
-      cell = (v.class == Axlsx::Cell ? v.r_abs : v)
-      Axlsx::validate_string(cell)
+      cell = (v.instance_of?(Axlsx::Cell) ? v.r_abs : v)
+      Axlsx.validate_string(cell)
       @top_left_cell = cell
     end
 
     # @see view
-    def view=(v); Axlsx::validate_sheet_view_type(v); @view = v end
+    def view=(v)
+      Axlsx.validate_sheet_view_type(v)
+      @view = v
+    end
 
     # @see workbook_view_id
-    def workbook_view_id=(v); Axlsx::validate_unsigned_int(v); @workbook_view_id = v end
+    def workbook_view_id=(v)
+      Axlsx.validate_unsigned_int(v)
+      @workbook_view_id = v
+    end
 
     # @see zoom_scale
-    def zoom_scale=(v); Axlsx::validate_scale_0_10_400(v); @zoom_scale = v end
+    def zoom_scale=(v)
+      Axlsx.validate_scale_0_10_400(v)
+      @zoom_scale = v
+    end
 
     # @see zoom_scale_normal
-    def zoom_scale_normal=(v); Axlsx::validate_scale_0_10_400(v); @zoom_scale_normal = v end
+    def zoom_scale_normal=(v)
+      Axlsx.validate_scale_0_10_400(v)
+      @zoom_scale_normal = v
+    end
 
     # @see zoom_scale_page_layout_view
-    def zoom_scale_page_layout_view=(v); Axlsx::validate_scale_0_10_400(v); @zoom_scale_page_layout_view = v end
+    def zoom_scale_page_layout_view=(v)
+      Axlsx.validate_scale_0_10_400(v)
+      @zoom_scale_page_layout_view = v
+    end
 
     # @see zoom_scale_sheet_layout_view
-    def zoom_scale_sheet_layout_view=(v); Axlsx::validate_scale_0_10_400(v); @zoom_scale_sheet_layout_view = v end
+    def zoom_scale_sheet_layout_view=(v)
+      Axlsx.validate_scale_0_10_400(v)
+      @zoom_scale_sheet_layout_view = v
+    end
 
     # Serializes the data validation
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<sheetViews>'
       str << '<sheetView '
       serialized_attributes str
       str << '>'
       @pane.to_xml_string(str) if @pane
-      @selections.each do |key, selection|
+      @selections.each_value do |selection|
         selection.to_xml_string(str)
       end
       str << '</sheetView>'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # Table
   # @note Worksheet#add_table is the recommended way to create tables for your worksheets.
@@ -42,7 +44,7 @@ module Axlsx
     # The part name for this table
     # @return [String]
     def pn
-      "#{TABLE_PN % (index + 1)}"
+      format(TABLE_PN, index + 1)
     end
 
     # The relationship id for this table.
@@ -71,14 +73,14 @@ module Axlsx
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<?xml version="1.0" encoding="UTF-8"?>'
-      str << ('<table xmlns="' << XML_NS << '" id="' << (index + 1).to_s << '" name="' << @name << '" displayName="' << @name.gsub(/\s/, '_') << '" ')
-      str << ('ref="' << @ref << '" totalsRowShown="0">')
-      str << ('<autoFilter ref="' << @ref << '"/>')
-      str << ('<tableColumns count="' << header_cells.length.to_s << '">')
+      str << '<table xmlns="' << XML_NS << '" id="' << (index + 1).to_s << '" name="' << @name << '" displayName="' << @name.gsub(/\s/, '_') << '" '
+      str << 'ref="' << @ref << '" totalsRowShown="0">'
+      str << '<autoFilter ref="' << @ref << '"/>'
+      str << '<tableColumns count="' << header_cells.length.to_s << '">'
       header_cells.each_with_index do |cell, index|
-        str << ('<tableColumn id ="' << (index + 1).to_s << '" name="' << cell.clean_value << '"/>')
+        str << '<tableColumn id ="' << (index + 1).to_s << '" name="' << cell.clean_value << '"/>'
       end
       str << '</tableColumns>'
       table_style_info.to_xml_string(str)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # The table style info class manages style attributes for defined tables in
   # a worksheet
@@ -32,7 +34,7 @@ module Axlsx
     # explicitly be disabled or all will show.
     def initialize_defaults
       %w(show_first_column show_last_column show_row_stripes show_column_stripes).each do |attr|
-        self.send("#{attr}=", 0)
+        send(:"#{attr}=", 0)
       end
     end
 
@@ -41,7 +43,7 @@ module Axlsx
 
     # seralizes this object to an xml string
     # @param [String] str the string to contact this objects serialization to.
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       serialized_tag('tableStyleInfo', str)
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # A simple, self serializing class for storing tables
   class Tables < SimpleTypedList
@@ -5,7 +7,7 @@ module Axlsx
     def initialize(worksheet)
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
 
-      super Table
+      super(Table)
       @worksheet = worksheet
     end
 
@@ -23,7 +25,7 @@ module Axlsx
     # renders the tables xml
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = "")
+    def to_xml_string(str = +'')
       return if empty?
 
       str << "<tableParts count='#{size}'>"

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "border_creator"
 
 module Axlsx
@@ -33,7 +35,7 @@ module Axlsx
     # @param [Hash] options Options passed in from the initializer
     def initialize_page_options(options)
       @page_margins = PageMargins.new options[:page_margins] if options[:page_margins]
-      @page_setup = PageSetup.new options[:page_setup]  if options[:page_setup]
+      @page_setup = PageSetup.new options[:page_setup] if options[:page_setup]
       @print_options = PrintOptions.new options[:print_options] if options[:print_options]
       @header_footer = HeaderFooter.new options[:header_footer] if options[:header_footer]
       @row_breaks = RowBreaks.new
@@ -43,7 +45,7 @@ module Axlsx
     # The name of the worksheet
     # @return [String]
     def name
-      @name ||= "Sheet" + (index + 1).to_s
+      @name ||= "Sheet#{index + 1}"
     end
 
     # Whether to treat values starting with an equals sign as formulas or as literal strings.
@@ -63,7 +65,7 @@ module Axlsx
     # Specifies the visible state of this sheet. Allowed states are
     # :visible, :hidden or :very_hidden. The default value is :visible.
     #
-    # Worksheets in the :hidden state can be shown using the sheet formatting properties in excel.
+    # Worksheets in the :hidden state can be shown using the sheet formatting properties in Excel.
     # :very_hidden sheets should be inaccessible to end users.
     # @param [Symbol] sheet_state The visible state for this sheet.
     def state=(sheet_state)
@@ -171,7 +173,7 @@ module Axlsx
       @rows.transpose(&block)
     end
 
-    # A range that excel will apply an auto-filter to "A1:B3"
+    # A range that Excel will apply an auto-filter to "A1:B3"
     # This will turn filtering on for the cells in the range.
     # The first row is considered the header, while subsequent rows are considered to be data.
     # @return String
@@ -185,7 +187,7 @@ module Axlsx
     # @return Boolean
     # @see #page_setup
     def fit_to_page?
-      return false unless Axlsx.instance_values_for(self).keys.include?('page_setup')
+      return false unless Axlsx.instance_values_for(self).key?('page_setup')
 
       page_setup.fit_to_page?
     end
@@ -325,7 +327,7 @@ module Axlsx
     # @param [String] name
     def name=(name)
       validate_sheet_name name
-      @name = Axlsx::coder.encode(name)
+      @name = Axlsx.coder.encode(name)
     end
 
     # The auto filter range for the worksheet
@@ -343,13 +345,13 @@ module Axlsx
     # The part name of this worksheet
     # @return [String]
     def pn
-      "#{WORKSHEET_PN % (index + 1)}"
+      format(WORKSHEET_PN, index + 1)
     end
 
     # The relationship part name of this worksheet
     # @return [String]
     def rels_pn
-      "#{WORKSHEET_RELS_PN % (index + 1)}"
+      format(WORKSHEET_RELS_PN, index + 1)
     end
 
     # The relationship id of this worksheet.
@@ -427,7 +429,6 @@ module Axlsx
     #    Allowing user generated data to be interpreted as formulas can be dangerous
     #   (see https://www.owasp.org/index.php/CSV_Injection for details).
     def add_row(values = [], options = {})
-      options[:escape_formulas] = escape_formulas if options[:escape_formulas].nil?
       row = Row.new(self, values, options)
       update_column_info row, options.delete(:widths)
       yield row if block_given?
@@ -447,7 +448,7 @@ module Axlsx
     # @see ConditionalFormattingRule#initialize
     # @see file:examples/example_conditional_formatting.rb
     def add_conditional_formatting(cells, rules)
-      cf = ConditionalFormatting.new(:sqref => cells)
+      cf = ConditionalFormatting.new(sqref: cells)
       cf.add_rules rules
       conditional_formattings << cf
       conditional_formattings
@@ -518,7 +519,7 @@ module Axlsx
     end
 
     # Adds a page break (row break) to the worksheet
-    # @param cell A Cell object or excel style string reference indicating where the break
+    # @param cell A Cell object or Excel style string reference indicating where the break
     # should be added to the sheet.
     # @example
     #   ws.add_page_break("A4")
@@ -530,9 +531,9 @@ module Axlsx
                                   cell.pos
                                 end
       if column_index > 0
-        col_breaks.add_break(:id => column_index)
+        col_breaks.add_break(id: column_index)
       end
-      row_breaks.add_break(:id => row_index)
+      row_breaks.add_break(id: row_index)
     end
 
     # This is a helper method that Lets you specify a fixed width for multiple columns in a worksheet in one go.
@@ -544,13 +545,26 @@ module Axlsx
     # @param [Integer|Float|nil] widths
     def column_widths(*widths)
       widths.each_with_index do |value, index|
-        next if value == nil
+        next if value.nil?
 
-        Axlsx::validate_unsigned_numeric(value) unless value == nil
+        Axlsx.validate_unsigned_numeric(value) unless value.nil?
         find_or_create_column_info(index).width = value
       end
     end
 
+    # This is a helper method that lets you specify a default style for multiple columns in a worksheet in one go.
+    # This style will be applied for all not-yet-defined cells in a column.
+    # Note that you must call column_styles BEFORE adding data, otherwise the styles will not be set successfully for new cells.
+    # @param [Integer] styles the cellXfs indexes
+    def column_styles(*styles)
+      styles.each_with_index do |style, index|
+        next if style.nil?
+
+        Axlsx.validate_unsigned_int(style)
+        find_or_create_column_info(index).style = style
+      end
+    end
+
     # Set the style for cells in a specific column
     # @param [Integer] index the index of the column
     # @param [Integer] style the cellXfs index
@@ -580,10 +594,10 @@ module Axlsx
     end
 
     # Set the style for cells in a specific column
-    # @param [String|Array] cell references
+    # @param [String|Array] cell_refs Cell references
     # @param [Hash] styles
     def add_style(cell_refs, *styles)
-      if !cell_refs.is_a?(Array)
+      unless cell_refs.is_a?(Array)
         cell_refs = [cell_refs]
       end
 
@@ -601,8 +615,8 @@ module Axlsx
     end
 
     # Set the style for cells in a specific column
-    # @param [String|Array] cell references
-    # @param [Hash|Array|Symbol] border options
+    # @param [String|Array] cell_refs Cell references
+    # @param [Hash|Array|Symbol] options border options
     def add_border(cell_refs, options = nil)
       if options.is_a?(Hash)
         border_edges = options[:edges]
@@ -612,7 +626,7 @@ module Axlsx
         border_edges = options
       end
 
-      if !cell_refs.is_a?(Array)
+      unless cell_refs.is_a?(Array)
         cell_refs = [cell_refs]
       end
 
@@ -626,18 +640,18 @@ module Axlsx
     end
 
     # Returns a sheet node serialization for this sheet in the workbook.
-    def to_sheet_node_xml_string(str = '')
+    def to_sheet_node_xml_string(str = +'')
       add_autofilter_defined_name_to_workbook
       str << '<sheet '
       serialized_attributes str
-      str << ('name="' << name << '" ')
-      str << ('r:id="' << rId << '"></sheet>')
+      str << 'name="' << name << '" '
+      str << 'r:id="' << rId << '"></sheet>'
     end
 
     # Serializes the worksheet object to an xml string
     # This intentionally does not use nokogiri for performance reasons
     # @return [String]
-    def to_xml_string str = ''
+    def to_xml_string(str = +'')
       add_autofilter_defined_name_to_workbook
       auto_filter.apply if auto_filter.range
       str << '<?xml version="1.0" encoding="UTF-8"?>'
@@ -660,7 +674,7 @@ module Axlsx
       r
     end
 
-    # Returns the cell or cells defined using excel style A1:B3 references.
+    # Returns the cell or cells defined using Excel style A1:B3 references.
     # @param [String|Integer] cell_def the string defining the cell or range of cells, or the rownumber
     # @return [Cell, Array]
     def [](cell_def)
@@ -672,11 +686,11 @@ module Axlsx
         parts.first
       else
         if parts.size > 2
-          raise ArgumentError, (ERR_CELL_REFERENCE_INVALID % cell_def)
+          raise ArgumentError, format(ERR_CELL_REFERENCE_INVALID, cell_def)
         elsif parts.first.nil?
-          raise ArgumentError, (ERR_CELL_REFERENCE_MISSING_CELL % [cell_def.split(":").first, cell_def])
+          raise ArgumentError, format(ERR_CELL_REFERENCE_MISSING_CELL, cell_def.split(":").first, cell_def)
         elsif parts.last.nil?
-          raise ArgumentError, (ERR_CELL_REFERENCE_MISSING_CELL % [cell_def.split(":").last, cell_def])
+          raise ArgumentError, format(ERR_CELL_REFERENCE_MISSING_CELL, cell_def.split(":").last, cell_def)
         end
 
         range(*parts)
@@ -687,12 +701,12 @@ module Axlsx
     # @param [String] name The cell or cell range to return. "A1" will return the first cell of the first row.
     # @return [Cell]
     def name_to_cell(name)
-      col_index, row_index = *Axlsx::name_to_indices(name)
+      col_index, row_index = *Axlsx.name_to_indices(name)
 
       r = rows[row_index]
 
       if r
-        return r[col_index]
+        r[col_index]
       end
     end
 
@@ -710,7 +724,7 @@ module Axlsx
     # @note The XLSX format does not support worksheet-specific styles. Even when using this method
     #     you're still working with the single global {Axlsx::Styles} object in the workbook.
     def styles
-      @styles ||= self.workbook.styles
+      @styles ||= workbook.styles
     end
 
     # shortcut level to specify the outline level for a series of rows
@@ -752,15 +766,15 @@ module Axlsx
     def validate_sheet_name(name)
       DataTypeValidator.validate :worksheet_name, String, name
       # ignore first character (BOM) after encoding to utf16 because Excel does so, too.
-      raise ArgumentError, (ERR_SHEET_NAME_EMPTY) if name.empty?
+      raise ArgumentError, ERR_SHEET_NAME_EMPTY if name.empty?
 
       character_length = name.encode("utf-16")[1..-1].encode("utf-16").bytesize / 2
-      raise ArgumentError, (ERR_SHEET_NAME_TOO_LONG % name) if character_length > WORKSHEET_MAX_NAME_LENGTH
-      raise ArgumentError, (ERR_SHEET_NAME_CHARACTER_FORBIDDEN % name) if WORKSHEET_NAME_FORBIDDEN_CHARS.any? { |char| name.include? char }
+      raise ArgumentError, format(ERR_SHEET_NAME_TOO_LONG, name) if character_length > WORKSHEET_MAX_NAME_LENGTH
+      raise ArgumentError, format(ERR_SHEET_NAME_CHARACTER_FORBIDDEN, name) if WORKSHEET_NAME_FORBIDDEN_CHARS.any? { |char| name.include? char }
 
-      name = Axlsx::coder.encode(name)
-      sheet_names = @workbook.worksheets.reject { |s| s == self }.map { |s| s.name }
-      raise ArgumentError, (ERR_DUPLICATE_SHEET_NAME % name) if sheet_names.include?(name)
+      name = Axlsx.coder.encode(name)
+      sheet_names = @workbook.worksheets.reject { |s| s == self }.map(&:name)
+      raise ArgumentError, format(ERR_DUPLICATE_SHEET_NAME, name) if sheet_names.include?(name)
     end
 
     def serializable_parts
@@ -832,7 +846,10 @@ module Axlsx
       @worksheet_comments ||= WorksheetComments.new self
     end
 
-    def workbook=(v) DataTypeValidator.validate "Worksheet.workbook", Workbook, v; @workbook = v; end
+    def workbook=(v)
+      DataTypeValidator.validate "Worksheet.workbook", Workbook, v
+      @workbook = v
+    end
 
     def update_column_info(cells, widths = nil)
       cells.each_with_index do |cell, index|
@@ -849,7 +866,7 @@ module Axlsx
     end
 
     def add_autofilter_defined_name_to_workbook
-      return if !auto_filter.range
+      return unless auto_filter.range
 
       workbook.add_defined_name auto_filter.defined_name, name: '_xlnm._FilterDatabase', local_sheet_id: index, hidden: 1
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # A wraper class for comments that defines its on worksheet
   # serailization
@@ -35,7 +37,7 @@ module Axlsx
 
     # Helper method to tell us if there are comments in the comments collection
     # @return [Boolean]
-    def has_comments?
+    def has_comments? # rubocop:disable Naming/PredicateName
       !comments.empty?
     end
 
@@ -49,7 +51,7 @@ module Axlsx
     # Seraalize the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       return unless has_comments?
 
       str << "<legacyDrawing r:id='#{drawing_rId}' />"

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # This is a utility class for serialing the drawing node in a
   # worksheet. Drawing objects have their own serialization that exports
@@ -13,8 +15,12 @@ module Axlsx
       @drawing = nil
     end
 
+    # The worksheet that owns the drawing
+    # @return [Worksheet]
     attr_reader :worksheet
 
+    # The drawing object
+    # @return [Drawing]
     attr_reader :drawing
 
     # adds a chart to the drawing object
@@ -36,7 +42,7 @@ module Axlsx
 
     # helper method to tell us if the drawing has something in it or not
     # @return [Boolean]
-    def has_drawing?
+    def has_drawing? # rubocop:disable Naming/PredicateName
       @drawing.is_a? Drawing
     end
 
@@ -50,7 +56,7 @@ module Axlsx
 
     # Serialize the drawing for the worksheet
     # @param [String] str
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       return unless has_drawing?
 
       str << "<drawing r:id='#{relationship.Id}'/>"