caxlsx 3.3.0 → 4.0.0

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

@@ -1,9 +1,8 @@
-# encoding: UTF-8
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # The Col class defines column attributes for columns in sheets.
   class Col
-
     # Maximum column width limit in MS Excel is 255 characters
     # https://support.microsoft.com/en-us/office/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
     MAX_WIDTH = 255
@@ -19,7 +18,7 @@ module Axlsx
     # @option options [Boolean] phonetic see Col#phonetic
     # @option options [Integer] style see Col#style
     # @option options [Numeric] width see Col#width
-    def initialize(min, max, options={})
+    def initialize(min, max, options = {})
       Axlsx.validate_unsigned_int(max)
       Axlsx.validate_unsigned_int(min)
       @min = min
@@ -89,7 +88,8 @@ module Axlsx
     # @see Col#outline
     def outline_level=(v)
       Axlsx.validate_unsigned_numeric(v)
-      raise ArgumentError, 'outlineLevel must be between 0 and 7' unless 0 <= v && v <= 7
+      raise ArgumentError, 'outlineLevel must be between 0 and 7' unless v >= 0 && v <= 7
+
       @outline_level = v
     end
     alias :outlineLevel= :outline_level=
@@ -106,15 +106,15 @@ module Axlsx
       @style = v
     end
 
-   # @see Col#width
+    # @see Col#width
     def width=(v)
       # Removing this validation make a 10% difference in performance
       # as it is called EVERY TIME A CELL IS ADDED - the proper solution
       # is to only set this if a calculated value is greated than the
       # current @width value.
       # TODO!!!
-      #Axlsx.validate_unsigned_numeric(v) unless v == nil
-      @custom_width = @best_fit = v != nil
+      # Axlsx.validate_unsigned_numeric(v) unless v == nil
+      @custom_width = @best_fit = !v.nil?
       @width = v.nil? ? v : [v, MAX_WIDTH].min
     end
 
@@ -137,9 +137,8 @@ module Axlsx
     # Serialize this columns data to an xml string
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       serialized_tag('col', str)
     end
-
   end
 end

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

@@ -1,10 +1,10 @@
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # A collection of Brake objects.
-  # Please do not use this class directly. Instead use 
+  # Please do not use this class directly. Instead use
   # Worksheet#add_break
   class ColBreaks < SimpleTypedList
-
     # Instantiates a new list restricted to Break types
     def initialize
       super Break
@@ -12,11 +12,11 @@ module Axlsx
 
     # A column break specific helper for adding a break.
     # @param [Hash] options A list of options to pass into the Break object
-    # The max and man options are fixed, however any other valid option for 
+    # The max and man options are fixed, however any other valid option for
     # Break will be passed to the created break object.
     # @see Break
     def add_break(options)
-      self << Break.new(options.merge(:max => 1048575, :man => true))
+      self << Break.new(options.merge(max: 1048575, man: true))
       last
     end
 
@@ -25,9 +25,10 @@ module Axlsx
     # <colBreaks count="1" manualBreakCount="1">
     # <brk id="3" max="1048575" man="1"/>
     # </colBreaks>
-    def to_xml_string(str='')
+    def to_xml_string(str = +'')
       return if empty?
-      str << ('<colBreaks count="' << size.to_s << '" manualBreakCount="' << size.to_s << '">')
+
+      str << '<colBreaks count="' << size.to_s << '" manualBreakCount="' << size.to_s << '">'
       each { |brk| brk.to_xml_string(str) }
       str << '</colBreaks>'
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # Conditional Format Rule color scale object
   # Describes a gradated color scale in this conditional formatting rule.
@@ -6,14 +8,12 @@ module Axlsx
   # @see Worksheet#add_conditional_formatting
   # @see ConditionalFormattingRule#initialize
   class ColorScale
-
     class << self
-
       # These are the default conditional formatting value objects
       # that define a two tone color gradient.
       def default_cfvos
-        [{:type => :min, :val => 0, :color => 'FFFF7128'},
-         {:type => :max, :val => 0, :color => 'FFFFEF9C'}]
+        [{ type: :min, val: 0, color: 'FFFF7128' },
+         { type: :max, val: 0, color: 'FFFFEF9C' }]
       end
 
       # A builder for two tone color gradient
@@ -22,18 +22,18 @@ module Axlsx
       #   color_scale = Axlsx::ColorScale.two_tone
       # @see examples/example.rb conditional formatting examples.
       def two_tone
-        self.new
+        new
       end
 
       # A builder for three tone color gradient
       # @example
       #   #this creates a three tone color scale
-      #   color_scale = Axlsx::ColorScale.three_tone 
+      #   color_scale = Axlsx::ColorScale.three_tone
       # @see examples/example.rb conditional formatting examples.
       def three_tone
-        self.new({:type => :min, :val => 0, :color => 'FFF8696B'},
-                 {:type => :percent, :val => '50', :color => 'FFFFEB84'},
-                 {:type => :max, :val => 0, :color => 'FF63BE7B'})
+        new({ type: :min, val: 0, color: 'FFF8696B' },
+            { type: :percent, val: '50', color: 'FFFFEB84' },
+            { type: :max, val: 0, color: 'FF63BE7B' })
       end
     end
     # A simple typed list of cfvos
@@ -67,17 +67,16 @@ module Axlsx
     # @option [Symbol] type The type of cfvo you to add
     # @option [Any] val The value of the cfvo to add
     # @option [String] The rgb color for the cfvo
-    def add(options={})
-      value_objects << Cfvo.new(:type => options[:type] || :min, :val => options[:val] || 0)
-      colors << Color.new(:rgb => options[:color] || "FF000000")
-      {:cfvo => value_objects.last, :color => colors.last}
+    def add(options = {})
+      value_objects << Cfvo.new(type: options[:type] || :min, val: options[:val] || 0)
+      colors << Color.new(rgb: options[:color] || "FF000000")
+      { cfvo: value_objects.last, color: colors.last }
     end
 
-
     # removes the cfvo and color pair at the index specified.
     # @param [Integer] index The index of the cfvo and color object to delete
     # @note you cannot remove the first two cfvo and color pairs
-    def delete_at(index=2)
+    def delete_at(index = 2)
       value_objects.delete_at index
       colors.delete_at index
     end
@@ -85,7 +84,7 @@ module Axlsx
     # Serialize this color_scale object data to an xml string
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<colorScale>'
       value_objects.to_xml_string(str)
       colors.each { |color| color.to_xml_string(str) }
@@ -93,6 +92,7 @@ module Axlsx
     end
 
     private
+
     # There has got to be cleaner way of merging these arrays.
     def initialize_default_cfvos(user_cfvos)
       defaults = self.class.default_cfvos

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

@@ -1,11 +1,12 @@
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # The cols class manages the col object used to manage column widths.
   # This is where the magic happens with autowidth
   class Cols < SimpleTypedList
-
     def initialize(worksheet)
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+
       super Col
       @worksheet = worksheet
     end
@@ -13,11 +14,12 @@ module Axlsx
     # Serialize the Cols object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
-     return if empty?
-     str << '<cols>'
-     each { |item| item.to_xml_string(str) }
-     str << '</cols>'
+    def to_xml_string(str = +'')
+      return if empty?
+
+      str << '<cols>'
+      each { |item| item.to_xml_string(str) }
+      str << '</cols>'
     end
   end
 end

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

@@ -1,8 +1,8 @@
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # A comment is the text data for a comment
   class Comment
-
     include Axlsx::OptionsParser
     include Axlsx::Accessors
 
@@ -13,8 +13,9 @@ module Axlsx
     # @option [String] text The text for the comment
     # @option [String] ref The refence (e.g. 'A3' where this comment will be anchored.
     # @option [Boolean] visible This controls the visiblity of the associated vml_shape.
-    def initialize(comments, options={})
+    def initialize(comments, options = {})
       raise ArgumentError, "A comment needs a parent comments object" unless comments.is_a?(Comments)
+
       @visible = true
       @comments = comments
       parse_options options
@@ -60,17 +61,17 @@ module Axlsx
     # serialize the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = "")
+    def to_xml_string(str = +'')
       author = @comments.authors[author_index]
-      str << ('<comment ref="' << ref << '" authorId="' << author_index.to_s << '">')
+      str << '<comment ref="' << ref << '" authorId="' << author_index.to_s << '">'
       str << '<text>'
       unless author.to_s == ""
         str << '<r><rPr><b/><color indexed="81"/></rPr>'
-        str << ("<t>" << ::CGI.escapeHTML(author.to_s) << ":\n</t></r>")
+        str << "<t>" << ::CGI.escapeHTML(author.to_s) << ":\n</t></r>"
       end
       str << '<r>'
       str << '<rPr><color indexed="81"/></rPr>'
-      str << ('<t>' << ::CGI.escapeHTML(text) << '</t></r></text>')
+      str << '<t>' << ::CGI.escapeHTML(text) << '</t></r></text>'
       str << '</comment>'
     end
 
@@ -79,12 +80,12 @@ module Axlsx
     # initialize the vml shape based on this comment's ref/position in the worksheet.
     # by default, all columns are 5 columns wide and 5 rows high
     def initialize_vml_shape
-      pos = Axlsx::name_to_indices(ref)
-      @vml_shape = VmlShape.new(:row => pos[1], :column => pos[0], :visible => @visible) do |vml|
+      pos = Axlsx.name_to_indices(ref)
+      @vml_shape = VmlShape.new(row: pos[1], column: pos[0], visible: @visible) do |vml|
         vml.left_column = vml.column
-        vml.right_column = vml.column + 2 
+        vml.right_column = vml.column + 2
         vml.top_row = vml.row
-         vml.bottom_row = vml.row + 4
+        vml.bottom_row = vml.row + 4
       end
     end
   end

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

@@ -1,9 +1,8 @@
-# -*- coding: utf-8 -*-
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # Comments is a collection of Comment objects for a worksheet
   class Comments < SimpleTypedList
-
     # the vml_drawing that holds the shapes for comments
     # @return [VmlDrawing]
     attr_reader :vml_drawing
@@ -21,13 +20,14 @@ module Axlsx
     # The part name for this object
     # @return [String]
     def pn
-      "#{COMMENT_PN % (index+1)}"
+      format(COMMENT_PN, index + 1)
     end
 
     # Creates a new Comments object
     # @param [Worksheet] worksheet The sheet that these comments belong to.
     def initialize(worksheet)
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+
       super(Comment)
       @worksheet = worksheet
       @vml_drawing = VmlDrawing.new(self)
@@ -38,10 +38,11 @@ module Axlsx
     # @option options [String] author The name of the author for this comment
     # @option options [String] text The text for this comment
     # @option options [Stirng|Cell] ref The cell that this comment is attached to.
-    def add_comment(options={})
+    def add_comment(options = {})
       raise ArgumentError, "Comment require an author" unless options[:author]
       raise ArgumentError, "Comment requires text" unless options[:text]
       raise ArgumentError, "Comment requires ref" unless options[:ref]
+
       self << Comment.new(self, options)
       yield last if block_given?
       last
@@ -63,20 +64,17 @@ module Axlsx
     # serialize 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 << ('<comments xmlns="' << XML_NS << '"><authors>')
-      authors.each do  |author|
-        str << ('<author>' << author.to_s << '</author>')
+      str << '<comments xmlns="' << XML_NS << '"><authors>'
+      authors.each do |author|
+        str << '<author>' << author.to_s << '</author>'
       end
       str << '</authors><commentList>'
       each do |comment|
         comment.to_xml_string str
       end
       str << '</commentList></comments>'
-
     end
-
   end
-
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # Conditional formatting allows styling of ranges based on functions
   #
@@ -5,13 +7,12 @@ module Axlsx
   # @see Worksheet#add_conditional_formatting
   # @see ConditionalFormattingRule
   class ConditionalFormatting
+    include Axlsx::OptionsParser
 
-   include Axlsx::OptionsParser
-   
     # Creates a new {ConditionalFormatting} object
     # @option options [Array] rules The rules to apply
     # @option options [String] sqref The range to apply the rules to
-    def initialize(options={})
+    def initialize(options = {})
       @rules = []
       parse_options options
     end
@@ -28,7 +29,7 @@ module Axlsx
     # @return [Array]
     attr_reader :rules
 
-     # Add Conditional Formatting Rules to this object. Rules can either
+    # Add Conditional Formatting Rules to this object. Rules can either
     # be already created {ConditionalFormattingRule} elements or
     # hashes of options for automatic creation.  If rules is a hash
     # instead of an array, assume only one rule being added.
@@ -62,7 +63,7 @@ module Axlsx
     # @see rules
     def rules=(v); @rules = v end
     # @see sqref
-    def sqref=(v); Axlsx::validate_string(v); @sqref = v end
+    def sqref=(v); Axlsx.validate_string(v); @sqref = v end
 
     # Serializes the conditional formatting element
     # @example Conditional Formatting XML looks like:
@@ -73,9 +74,12 @@ module Axlsx
     #    </conditionalFormatting>
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
-      str << ('<conditionalFormatting sqref="' << sqref << '">')
-      str << rules.collect{ |rule| rule.to_xml_string }.join(' ')
+    def to_xml_string(str = +'')
+      str << '<conditionalFormatting sqref="' << sqref << '">'
+      rules.each_with_index do |rule, index|
+        str << ' ' unless index.zero?
+        rule.to_xml_string(str)
+      end
       str << '</conditionalFormatting>'
     end
   end

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

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 module Axlsx
   # Conditional formatting rules specify formulas whose evaluations
   # format cells
@@ -7,7 +8,6 @@ module Axlsx
   # @see Worksheet#add_conditional_formatting
   # @see ConditionalFormattingRule#initialize
   class ConditionalFormattingRule
-
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
 
@@ -26,7 +26,7 @@ module Axlsx
     # @option options [Boolean] stopIfTrue Stop evaluating rules after this rule matches
     # @option options [Symbol]  timePeriod The time period in a date occuring... rule
     # @option options [String] formula The formula to match against in i.e. an equal rule. Use a [minimum, maximum] array for cellIs between/notBetween conditionals.
-    def initialize(options={})
+    def initialize(options = {})
       @color_scale = @data_bar = @icon_set = @formula = nil
       parse_options options
     end
@@ -133,7 +133,6 @@ module Axlsx
     # thisMonth, lastMonth, nextMonth, thisWeek, lastWeek, nextWeek
     attr_reader :timePeriod
 
-
     # colorScale (Color Scale)
     # The color scale to apply to this conditional formatting
     # @return [ColorScale]
@@ -156,33 +155,33 @@ module Axlsx
     end
 
     # @see type
-    def type=(v); Axlsx::validate_conditional_formatting_type(v); @type = v end
+    def type=(v); Axlsx.validate_conditional_formatting_type(v); @type = v end
     # @see aboveAverage
-    def aboveAverage=(v); Axlsx::validate_boolean(v); @aboveAverage = v end
+    def aboveAverage=(v); Axlsx.validate_boolean(v); @aboveAverage = v end
     # @see bottom
-    def bottom=(v); Axlsx::validate_boolean(v); @bottom = v end
+    def bottom=(v); Axlsx.validate_boolean(v); @bottom = v end
     # @see dxfId
-    def dxfId=(v); Axlsx::validate_unsigned_numeric(v); @dxfId = v end
+    def dxfId=(v); Axlsx.validate_unsigned_numeric(v); @dxfId = v end
     # @see equalAverage
-    def equalAverage=(v); Axlsx::validate_boolean(v); @equalAverage = v end
+    def equalAverage=(v); Axlsx.validate_boolean(v); @equalAverage = v end
     # @see priority
-    def priority=(v); Axlsx::validate_unsigned_numeric(v); @priority = v end
+    def priority=(v); Axlsx.validate_unsigned_numeric(v); @priority = v end
     # @see operator
-    def operator=(v); Axlsx::validate_conditional_formatting_operator(v); @operator = v end
+    def operator=(v); Axlsx.validate_conditional_formatting_operator(v); @operator = v end
     # @see text
-    def text=(v); Axlsx::validate_string(v); @text = v end
+    def text=(v); Axlsx.validate_string(v); @text = v end
     # @see percent
-    def percent=(v); Axlsx::validate_boolean(v); @percent = v end
+    def percent=(v); Axlsx.validate_boolean(v); @percent = v end
     # @see rank
-    def rank=(v); Axlsx::validate_unsigned_numeric(v); @rank = v end
+    def rank=(v); Axlsx.validate_unsigned_numeric(v); @rank = v end
     # @see stdDev
-    def stdDev=(v); Axlsx::validate_unsigned_numeric(v); @stdDev = v end
+    def stdDev=(v); Axlsx.validate_unsigned_numeric(v); @stdDev = v end
     # @see stopIfTrue
-    def stopIfTrue=(v); Axlsx::validate_boolean(v); @stopIfTrue = v end
+    def stopIfTrue=(v); Axlsx.validate_boolean(v); @stopIfTrue = v end
     # @see timePeriod
-    def timePeriod=(v); Axlsx::validate_time_period_type(v); @timePeriod = v end
+    def timePeriod=(v); Axlsx.validate_time_period_type(v); @timePeriod = v end
     # @see formula
-    def formula=(v); [*v].each {|x| Axlsx::validate_string(x) }; @formula = [*v].map { |form| ::CGI.escapeHTML(form) } end
+    def formula=(v); [*v].each { |x| Axlsx.validate_string(x) }; @formula = [*v].map { |form| ::CGI.escapeHTML(form) } end
 
     # @see color_scale
     def color_scale=(v)
@@ -202,15 +201,14 @@ module Axlsx
       @icon_set = v
     end
 
-
     # Serializes the conditional formatting rule
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<cfRule '
       serialized_attributes str
       str << '>'
-      str << ('<formula>' << [*self.formula].join('</formula><formula>') << '</formula>') if @formula
+      str << '<formula>' << [*formula].join('</formula><formula>') << '</formula>' if @formula
       @color_scale.to_xml_string(str) if @color_scale && @type == :colorScale
       @data_bar.to_xml_string(str) if @data_bar && @type == :dataBar
       @icon_set.to_xml_string(str) if @icon_set && @type == :iconSet

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

@@ -1,11 +1,12 @@
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # A simple, self serializing class for storing conditional formattings
   class ConditionalFormattings < SimpleTypedList
-
     # creates a new Tables object
     def initialize(worksheet)
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+
       super ConditionalFormatting
       @worksheet = worksheet
     end
@@ -15,11 +16,10 @@ module Axlsx
     attr_reader :worksheet
 
     # serialize the conditional formattings
-    def to_xml_string(str = "")
+    def to_xml_string(str = +'')
       return if empty?
+
       each { |item| item.to_xml_string(str) }
     end
   end
-
 end
-

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # Conditional Format Rule data bar object
   # Describes a data bar conditional formatting rule.
@@ -6,15 +8,14 @@ module Axlsx
   # @see Worksheet#add_conditional_formatting
   # @see ConditionalFormattingRule#initialize
   class DataBar
-
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
 
     class << self
       # This differs from ColorScale. There must be exactly two cfvos one color
       def default_cfvos
-        [{:type => :min, :val => "0"},
-         {:type => :max, :val => "0"}]
+        [{ type: :min, val: "0" },
+         { type: :max, val: "0" }]
       end
     end
 
@@ -37,7 +38,7 @@ module Axlsx
     serializable_attributes :min_length, :max_length, :show_value
 
     # instance values that must be serialized as their own elements - e.g. not attributes.
-    CHILD_ELEMENTS = [:value_objects, :color]
+    CHILD_ELEMENTS = [:value_objects, :color].freeze
 
     # minLength attribute
     # The minimum length of the data bar, as a percentage of the cell width.
@@ -71,7 +72,7 @@ module Axlsx
     # the color object used in the data bar formatting
     # @return [Color]
     def color
-      @color ||= Color.new :rgb => "FF0000FF"
+      @color ||= Color.new rgb: "FF0000FF"
     end
 
     # @see minLength
@@ -81,35 +82,34 @@ module Axlsx
     end
     alias :minLength= :min_length=
 
-      # @see maxLength
-      def max_length=(v)
-        Axlsx.validate_unsigned_int(v)
-        @max_length = v
-      end
+    # @see maxLength
+    def max_length=(v)
+      Axlsx.validate_unsigned_int(v)
+      @max_length = v
+    end
     alias :maxLength= :max_length=
 
-      # @see showValue
-      def show_value=(v)
-        Axlsx.validate_boolean(v)
-        @show_value = v
-      end
+    # @see showValue
+    def show_value=(v)
+      Axlsx.validate_boolean(v)
+      @show_value = v
+    end
     alias :showValue= :show_value=
 
-      # Sets the color for the data bars.
-      # @param [Color|String] v The color object, or rgb string value to apply
-      def color=(v)
-        @color = v if v.is_a? Color
-        self.color.rgb = v if v.is_a? String
-        @color
-      end
+    # Sets the color for the data bars.
+    # @param [Color|String] v The color object, or rgb string value to apply
+    def color=(v)
+      @color = v if v.is_a? Color
+      color.rgb = v if v.is_a? String
+    end
 
     # Serialize this object to an xml string
     # @param [String] str
     # @return [String]
-    def to_xml_string(str="")
+    def to_xml_string(str = +'')
       serialized_tag('dataBar', str) do
         value_objects.to_xml_string(str)
-        self.color.to_xml_string(str)
+        color.to_xml_string(str)
       end
     end
 
@@ -117,13 +117,12 @@ module Axlsx
 
     def initialize_cfvos(cfvos)
       self.class.default_cfvos.each_with_index.map do |default, index|
-        if index < cfvos.size
-          value_objects << Cfvo.new(default.merge(cfvos[index]))
-        else
-          value_objects << Cfvo.new(default)
-        end
+        value_objects << if index < cfvos.size
+                           Cfvo.new(default.merge(cfvos[index]))
+                         else
+                           Cfvo.new(default)
+                         end
       end
     end
-
   end
 end