caxlsx 3.4.1 → 4.1.0

data/lib/axlsx/rels/relationship.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # A relationship defines a reference between package parts.
   # @note Packages automatically manage relationships.
@@ -41,7 +43,7 @@ module Axlsx
     end
 
     # The id of the relationship (eg. "rId123"). Most instances get their own unique id.
-    # However, some instances need to share the same id – see {#should_use_same_id_as?}
+    # However, some instances need to share the same id – see {#ids_cache_key}
     # for details.
     # @return [String]
     attr_reader :Id
@@ -90,20 +92,33 @@ module Axlsx
     end
 
     # @see Target
-    def Target=(v) Axlsx::validate_string v; @Target = v end
+    def Target=(v)
+      Axlsx.validate_string v
+      @Target = v
+    end
+
     # @see Type
-    def Type=(v) Axlsx::validate_relationship_type v; @Type = v end
+    def Type=(v)
+      Axlsx.validate_relationship_type v
+      @Type = v
+    end
 
     # @see TargetMode
-    def TargetMode=(v) RestrictionValidator.validate 'Relationship.TargetMode', [:External, :Internal], v; @TargetMode = v; end
+    def TargetMode=(v)
+      RestrictionValidator.validate 'Relationship.TargetMode', [:External, :Internal], v
+      @TargetMode = v
+    end
 
     # serialize relationship
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       h = Axlsx.instance_values_for(self).reject { |k, _| k == "source_obj" }
       str << '<Relationship '
-      str << (h.map { |key, value| '' << key.to_s << '="' << Axlsx::coder.encode(value.to_s) << '"' }.join(' '))
+      h.each_with_index do |key_value, index|
+        str << ' ' unless index.zero?
+        str << key_value.first.to_s << '="' << Axlsx.coder.encode(key_value.last.to_s) << '"'
+      end
       str << '/>'
     end
 

data/lib/axlsx/rels/relationships.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Axlsx
-  require 'axlsx/rels/relationship.rb'
+  require 'axlsx/rels/relationship'
 
   # Relationships are a collection of Relations that define how package parts are related.
   # @note The package automatically manages releationships.
   class Relationships < SimpleTypedList
     # Creates a new Relationships collection based on SimpleTypedList
     def initialize
-      super Relationship
+      super(Relationship)
     end
 
     # The relationship instance for the given source object, or nil if none exists.
@@ -19,9 +21,9 @@ module Axlsx
     # serialize relationships
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<?xml version="1.0" encoding="UTF-8"?>'
-      str << ('<Relationships xmlns="' << RELS_R << '">')
+      str << '<Relationships xmlns="' << RELS_R << '">'
       each { |rel| rel.to_xml_string(str) }
       str << '</Relationships>'
     end

data/lib/axlsx/stylesheet/border.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # This class details a border used in Office Open XML spreadsheet styles.
   class Border
@@ -41,20 +43,29 @@ module Axlsx
     attr_reader :prs
 
     # @see diagonalUp
-    def diagonal_up=(v) Axlsx::validate_boolean v; @diagonal_up = v end
+    def diagonal_up=(v)
+      Axlsx.validate_boolean v
+      @diagonal_up = v
+    end
     alias :diagonalUp= :diagonal_up=
 
     # @see diagonalDown
-    def diagonal_down=(v) Axlsx::validate_boolean v; @diagonal_down = v end
+    def diagonal_down=(v)
+      Axlsx.validate_boolean v
+      @diagonal_down = v
+    end
     alias :diagonalDown= :diagonal_down=
 
     # @see outline
-    def outline=(v) Axlsx::validate_boolean v; @outline = v end
+    def outline=(v)
+      Axlsx.validate_boolean v
+      @outline = v
+    end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<border '
       serialized_attributes str
       str << '>'

data/lib/axlsx/stylesheet/border_pr.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # A border part.
   class BorderPr
@@ -51,19 +53,30 @@ module Axlsx
     end
 
     # @see name
-    def name=(v) RestrictionValidator.validate "BorderPr.name", [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal], v; @name = v end
+    def name=(v)
+      RestrictionValidator.validate "BorderPr.name", [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal], v
+      @name = v
+    end
+
     # @see color
-    def color=(v) DataTypeValidator.validate(:color, Color, v); @color = v end
+    def color=(v)
+      DataTypeValidator.validate(:color, Color, v)
+      @color = v
+    end
+
     # @see style
-    def style=(v) RestrictionValidator.validate "BorderPr.style", [:none, :thin, :medium, :dashed, :dotted, :thick, :double, :hair, :mediumDashed, :dashDot, :mediumDashDot, :dashDotDot, :mediumDashDotDot, :slantDashDot], v; @style = v end
+    def style=(v)
+      RestrictionValidator.validate "BorderPr.style", [:none, :thin, :medium, :dashed, :dotted, :thick, :double, :hair, :mediumDashed, :dashDot, :mediumDashDot, :dashDotDot, :mediumDashDotDot, :slantDashDot], v
+      @style = v
+    end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
-      str << ('<' << @name.to_s << ' style="' << @style.to_s << '">')
+    def to_xml_string(str = +'')
+      str << '<' << @name.to_s << ' style="' << @style.to_s << '">'
       @color.to_xml_string(str) if @color.is_a?(Color)
-      str << ('</' << @name.to_s << '>')
+      str << '</' << @name.to_s << '>'
     end
   end
 end

data/lib/axlsx/stylesheet/cell_alignment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # CellAlignment stores information about the cell alignment of a style Xf Object.
   # @note Using Styles#add_style is the recommended way to manage cell alignment.
@@ -84,40 +86,69 @@ module Axlsx
     alias :readingOrder :reading_order
 
     # @see horizontal
-    def horizontal=(v) Axlsx::validate_horizontal_alignment v; @horizontal = v end
+    def horizontal=(v)
+      Axlsx.validate_horizontal_alignment v
+      @horizontal = v
+    end
+
     # @see vertical
-    def vertical=(v) Axlsx::validate_vertical_alignment v; @vertical = v end
+    def vertical=(v)
+      Axlsx.validate_vertical_alignment v
+      @vertical = v
+    end
+
     # @see textRotation
-    def text_rotation=(v) Axlsx::validate_unsigned_int v; @text_rotation = v end
+    def text_rotation=(v)
+      Axlsx.validate_unsigned_int v
+      @text_rotation = v
+    end
     alias :textRotation= :text_rotation=
 
     # @see wrapText
-    def wrap_text=(v) Axlsx::validate_boolean v; @wrap_text = v end
+    def wrap_text=(v)
+      Axlsx.validate_boolean v
+      @wrap_text = v
+    end
     alias :wrapText= :wrap_text=
 
     # @see indent
-    def indent=(v) Axlsx::validate_unsigned_int v; @indent = v end
+    def indent=(v)
+      Axlsx.validate_unsigned_int v
+      @indent = v
+    end
 
     # @see relativeIndent
-    def relative_indent=(v) Axlsx::validate_int v; @relative_indent = v end
+    def relative_indent=(v)
+      Axlsx.validate_int v
+      @relative_indent = v
+    end
     alias :relativeIndent= :relative_indent=
 
     # @see justifyLastLine
-    def justify_last_line=(v) Axlsx::validate_boolean v; @justify_last_line = v end
+    def justify_last_line=(v)
+      Axlsx.validate_boolean v
+      @justify_last_line = v
+    end
     alias :justifyLastLine= :justify_last_line=
 
     # @see shrinkToFit
-    def shrink_to_fit=(v) Axlsx::validate_boolean v; @shrink_to_fit = v end
+    def shrink_to_fit=(v)
+      Axlsx.validate_boolean v
+      @shrink_to_fit = v
+    end
     alias :shrinkToFit= :shrink_to_fit=
 
     # @see readingOrder
-    def reading_order=(v) Axlsx::validate_unsigned_int v; @reading_order = v end
+    def reading_order=(v)
+      Axlsx.validate_unsigned_int v
+      @reading_order = v
+    end
     alias :readingOrder= :reading_order=
 
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       serialized_tag('alignment', str)
     end
   end

data/lib/axlsx/stylesheet/cell_protection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # CellProtection stores information about locking or hiding cells in spreadsheet.
   # @note Using Styles#add_style is the recommended way to manage cell protection.
@@ -24,14 +26,21 @@ module Axlsx
     end
 
     # @see hidden
-    def hidden=(v) Axlsx::validate_boolean v; @hidden = v end
+    def hidden=(v)
+      Axlsx.validate_boolean v
+      @hidden = v
+    end
+
     # @see locked
-    def locked=(v) Axlsx::validate_boolean v; @locked = v end
+    def locked=(v)
+      Axlsx.validate_boolean v
+      @locked = v
+    end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       serialized_tag('protection', str)
     end
   end

data/lib/axlsx/stylesheet/cell_style.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # CellStyle defines named styles that reference defined formatting records and can be used in your worksheet.
   # @note Using Styles#add_style is the recommended way to manage cell styling.
@@ -37,7 +39,7 @@ module Axlsx
     # @return [Integer]
     attr_reader :iLevel
 
-    # Determines if this named style should show in the list of styles when using excel
+    # Determines if this named style should show in the list of styles when using Excel
     # @return [Boolean]
     attr_reader :hidden
 
@@ -46,22 +48,45 @@ module Axlsx
     attr_reader :customBuiltin
 
     # @see name
-    def name=(v) Axlsx::validate_string v; @name = v end
+    def name=(v)
+      Axlsx.validate_string v
+      @name = v
+    end
+
     # @see xfId
-    def xfId=(v) Axlsx::validate_unsigned_int v; @xfId = v end
+    def xfId=(v)
+      Axlsx.validate_unsigned_int v
+      @xfId = v
+    end
+
     # @see builtinId
-    def builtinId=(v) Axlsx::validate_unsigned_int v; @builtinId = v end
+    def builtinId=(v)
+      Axlsx.validate_unsigned_int v
+      @builtinId = v
+    end
+
     # @see iLivel
-    def iLevel=(v) Axlsx::validate_unsigned_int v; @iLevel = v end
+    def iLevel=(v)
+      Axlsx.validate_unsigned_int v
+      @iLevel = v
+    end
+
     # @see hidden
-    def hidden=(v) Axlsx::validate_boolean v; @hidden = v end
+    def hidden=(v)
+      Axlsx.validate_boolean v
+      @hidden = v
+    end
+
     # @see customBuiltin
-    def customBuiltin=(v) Axlsx::validate_boolean v; @customBuiltin = v end
+    def customBuiltin=(v)
+      Axlsx.validate_boolean v
+      @customBuiltin = v
+    end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       serialized_tag('cellStyle', str)
     end
   end

data/lib/axlsx/stylesheet/color.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # The color class represents a color used for borders, fills an fonts
   class Color
@@ -45,21 +47,27 @@ module Axlsx
     attr_reader :tint
 
     # @see auto
-    def auto=(v) Axlsx::validate_boolean v; @auto = v end
+    def auto=(v)
+      Axlsx.validate_boolean v
+      @auto = v
+    end
 
     # @see color
     def rgb=(v)
-      Axlsx::validate_string(v)
+      Axlsx.validate_string(v)
       v = v.upcase
-      v = v * 3 if v.size == 2
+      v *= 3 if v.size == 2
       v = v.rjust(8, 'FF')
-      raise ArgumentError, "Invalid color rgb value: #{v}." unless v.match(/[0-9A-F]{8}/)
+      raise ArgumentError, "Invalid color rgb value: #{v}." unless /[0-9A-F]{8}/.match?(v)
 
       @rgb = v
     end
 
     # @see tint
-    def tint=(v) Axlsx::validate_float v; @tint = v end
+    def tint=(v)
+      Axlsx.validate_float v
+      @tint = v
+    end
 
     # This version does not support themes
     # def theme=(v) Axlsx::validate_unsigned_integer v; @theme = v end
@@ -70,8 +78,8 @@ module Axlsx
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '', tag_name = 'color')
-      serialized_tag('' + tag_name + '', str)
+    def to_xml_string(str = +'', tag_name = 'color')
+      serialized_tag(tag_name.to_s, str)
     end
   end
 end

data/lib/axlsx/stylesheet/dxf.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # The Dxf class defines an incremental formatting record for use in Styles. The recommended way to manage styles for your workbook is with Styles#add_style
   # @see Styles#add_style
@@ -6,7 +8,7 @@ module Axlsx
 
     # The order in which the child elements is put in the XML seems to
     # be important for Excel
-    CHILD_ELEMENTS = [:font, :numFmt, :fill, :alignment, :border, :protection]
+    CHILD_ELEMENTS = [:font, :numFmt, :fill, :alignment, :border, :protection].freeze
     # does not support extList (ExtensionList)
 
     # The cell alignment for this style
@@ -47,27 +49,50 @@ module Axlsx
     end
 
     # @see Dxf#alignment
-    def alignment=(v) DataTypeValidator.validate "Dxf.alignment", CellAlignment, v; @alignment = v end
+    def alignment=(v)
+      DataTypeValidator.validate "Dxf.alignment", CellAlignment, v
+      @alignment = v
+    end
+
     # @see protection
-    def protection=(v) DataTypeValidator.validate "Dxf.protection", CellProtection, v; @protection = v end
+    def protection=(v)
+      DataTypeValidator.validate "Dxf.protection", CellProtection, v
+      @protection = v
+    end
+
     # @see numFmt
-    def numFmt=(v) DataTypeValidator.validate "Dxf.numFmt", NumFmt, v; @numFmt = v end
+    def numFmt=(v)
+      DataTypeValidator.validate "Dxf.numFmt", NumFmt, v
+      @numFmt = v
+    end
+
     # @see font
-    def font=(v) DataTypeValidator.validate "Dxf.font", Font, v; @font = v end
+    def font=(v)
+      DataTypeValidator.validate "Dxf.font", Font, v
+      @font = v
+    end
+
     # @see border
-    def border=(v) DataTypeValidator.validate "Dxf.border", Border, v; @border = v end
+    def border=(v)
+      DataTypeValidator.validate "Dxf.border", Border, v
+      @border = v
+    end
+
     # @see fill
-    def fill=(v) DataTypeValidator.validate "Dxf.fill", Fill, v; @fill = v end
+    def fill=(v)
+      DataTypeValidator.validate "Dxf.fill", Fill, v
+      @fill = v
+    end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<dxf>'
       # Dxf elements have no attributes. All of the instance variables
       # are child elements.
       CHILD_ELEMENTS.each do |element|
-        self.send(element).to_xml_string(str) if self.send(element)
+        send(element).to_xml_string(str) if send(element)
       end
       str << '</dxf>'
     end

data/lib/axlsx/stylesheet/fill.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # The Fill is a formatting object that manages the background color, and pattern for cells.
   # @note The recommended way to manage styles in your workbook is to use Styles#add_style.
@@ -19,13 +21,16 @@ module Axlsx
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<fill>'
       @fill_type.to_xml_string(str)
       str << '</fill>'
     end
 
     # @see fill_type
-    def fill_type=(v) DataTypeValidator.validate "Fill.fill_type", [PatternFill, GradientFill], v; @fill_type = v; end
+    def fill_type=(v)
+      DataTypeValidator.validate "Fill.fill_type", [PatternFill, GradientFill], v
+      @fill_type = v
+    end
   end
 end

data/lib/axlsx/stylesheet/font.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # The Font class details a font instance for use in styling cells.
   # @note The recommended way to manage fonts, and other styles is Styles#add_style
@@ -110,46 +112,92 @@ module Axlsx
     attr_reader :sz
 
     # @see name
-    def name=(v) Axlsx::validate_string v; @name = v end
+    def name=(v)
+      Axlsx.validate_string v
+      @name = v
+    end
+
     # @see charset
-    def charset=(v) Axlsx::validate_unsigned_int v; @charset = v end
+    def charset=(v)
+      Axlsx.validate_unsigned_int v
+      @charset = v
+    end
+
     # @see family
-    def family=(v) Axlsx::validate_unsigned_int v; @family = v end
+    def family=(v)
+      Axlsx.validate_unsigned_int v
+      @family = v
+    end
+
     # @see b
-    def b=(v) Axlsx::validate_boolean v; @b = v end
+    def b=(v)
+      Axlsx.validate_boolean v
+      @b = v
+    end
+
     # @see i
-    def i=(v) Axlsx::validate_boolean v; @i = v end
+    def i=(v)
+      Axlsx.validate_boolean v
+      @i = v
+    end
 
     # @see u
     def u=(v)
-      v = :single if (v == true || v == 1 || v == :true || v == 'true')
-      v = :none if (v == false || v == 0 || v == :false || v == 'false')
-      Axlsx::validate_cell_u v
+      v = :single if v == true || v == 1 || v == :true || v == 'true'
+      v = :none if v == false || v == 0 || v == :false || v == 'false'
+      Axlsx.validate_cell_u v
       @u = v
     end
 
     # @see strike
-    def strike=(v) Axlsx::validate_boolean v; @strike = v end
+    def strike=(v)
+      Axlsx.validate_boolean v
+      @strike = v
+    end
+
     # @see outline
-    def outline=(v) Axlsx::validate_boolean v; @outline = v end
+    def outline=(v)
+      Axlsx.validate_boolean v
+      @outline = v
+    end
+
     # @see shadow
-    def shadow=(v) Axlsx::validate_boolean v; @shadow = v end
+    def shadow=(v)
+      Axlsx.validate_boolean v
+      @shadow = v
+    end
+
     # @see condense
-    def condense=(v) Axlsx::validate_boolean v; @condense = v end
+    def condense=(v)
+      Axlsx.validate_boolean v
+      @condense = v
+    end
+
     # @see extend
-    def extend=(v) Axlsx::validate_boolean v; @extend = v end
+    def extend=(v)
+      Axlsx.validate_boolean v
+      @extend = v
+    end
+
     # @see color
-    def color=(v) DataTypeValidator.validate "Font.color", Color, v; @color = v end
+    def color=(v)
+      DataTypeValidator.validate "Font.color", Color, v
+      @color = v
+    end
+
     # @see sz
-    def sz=(v) Axlsx::validate_unsigned_int v; @sz = v end
+    def sz=(v)
+      Axlsx.validate_unsigned_int v
+      @sz = v
+    end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<font>'
       Axlsx.instance_values_for(self).each do |k, v|
-        v.is_a?(Color) ? v.to_xml_string(str) : (str << ('<' << k.to_s << ' val="' << Axlsx.booleanize(v).to_s << '"/>'))
+        v.is_a?(Color) ? v.to_xml_string(str) : (str << '<' << k.to_s << ' val="' << Axlsx.booleanize(v).to_s << '"/>')
       end
       str << '</font>'
     end

data/lib/axlsx/stylesheet/gradient_fill.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # A GradientFill defines the color and positioning for gradiant cell fill.
   # @see Open Office XML Part 1 §18.8.24
@@ -53,10 +55,16 @@ module Axlsx
     attr_reader :stop
 
     # @see type
-    def type=(v) Axlsx::validate_gradient_type v; @type = v end
+    def type=(v)
+      Axlsx.validate_gradient_type v
+      @type = v
+    end
 
     # @see degree
-    def degree=(v) Axlsx::validate_float v; @degree = v end
+    def degree=(v)
+      Axlsx.validate_float v
+      @degree = v
+    end
 
     # @see left
     def left=(v)
@@ -84,13 +92,13 @@ module Axlsx
 
     # validates that the value provided is between 0.0 and 1.0
     def validate_format_percentage(name, value)
-      DataTypeValidator.validate name, Float, value, lambda { |arg| arg >= 0.0 && arg <= 1.0 }
+      DataTypeValidator.validate name, Float, value, ->(arg) { arg >= 0.0 && arg <= 1.0 }
     end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<gradientFill '
       serialized_attributes str
       str << '>'