caxlsx 4.0.0 → 4.2.0

data/lib/axlsx/drawing/pie_3D_chart.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Axlsx
-  # The Pie3DChart is a three dimentional piechart (who would have guessed?) that you can add to your worksheet.
+  # The Pie3DChart is a three dimensional pie chart (who would have guessed?) that you can add to your worksheet.
   # @see Worksheet#add_chart
   # @see Chart#add_series
   # @see README for an example
@@ -22,7 +22,7 @@ module Axlsx
     # @see View3D
     def initialize(frame, options = {})
       @vary_colors = true
-      super(frame, options)
+      super
       @series_type = PieSeries
       @view_3D = View3D.new({ rot_x: 30, perspective: 30 }.merge(options))
       @d_lbls = nil
@@ -32,7 +32,7 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = +'')
-      super(str) do
+      super do
         str << '<c:pie3DChart>'
         str << '<c:varyColors val="' << vary_colors.to_s << '"/>'
         @series.each { |ser| ser.to_xml_string(str) }

data/lib/axlsx/drawing/pie_chart.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Axlsx
+  # The PieChart is a pie chart that you can add to your worksheet.
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  # @see README for an example
+  class PieChart < Chart
+    # Creates a new pie chart object
+    # @param [GraphicFrame] frame The workbook that owns this chart.
+    # @option options [Cell, String] title
+    # @option options [Boolean] show_legend
+    # @option options [Symbol] grouping
+    # @option options [String] gap_depth
+    # @see Chart
+    def initialize(frame, options = {})
+      @vary_colors = true
+      super
+      @series_type = PieSeries
+      @d_lbls = nil
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = +'')
+      super do
+        str << '<c:pieChart>'
+        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
+        str << '</c:pieChart>'
+      end
+    end
+  end
+end

data/lib/axlsx/drawing/pie_series.rb

@@ -30,22 +30,28 @@ module Axlsx
     def initialize(chart, options = {})
       @explosion = nil
       @colors = []
-      super(chart, options)
+      super
       self.labels = AxDataSource.new(data: options[:labels]) unless options[:labels].nil?
       self.data = NumDataSource.new(options) unless options[:data].nil?
     end
 
     # @see colors
-    def colors=(v) DataTypeValidator.validate "BarSeries.colors", [Array], v; @colors = v end
+    def colors=(v)
+      DataTypeValidator.validate "BarSeries.colors", [Array], v
+      @colors = v
+    end
 
     # @see explosion
-    def explosion=(v) Axlsx.validate_unsigned_int(v); @explosion = v; end
+    def explosion=(v)
+      Axlsx.validate_unsigned_int(v)
+      @explosion = v
+    end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = +'')
-      super(str) do
+      super do
         str << '<c:explosion val="' << @explosion.to_s << '"/>' unless @explosion.nil?
         colors.each_with_index do |c, index|
           str << '<c:dPt>'
@@ -63,9 +69,15 @@ module Axlsx
     private
 
     # assigns the data for this series
-    def data=(v) DataTypeValidator.validate "Series.data", [NumDataSource], v; @data = v; end
+    def data=(v)
+      DataTypeValidator.validate "Series.data", [NumDataSource], v
+      @data = v
+    end
 
     # assigns the labels for this series
-    def labels=(v) DataTypeValidator.validate "Series.labels", [AxDataSource], v; @labels = v; end
+    def labels=(v)
+      DataTypeValidator.validate "Series.labels", [AxDataSource], v
+      @labels = v
+    end
   end
 end

data/lib/axlsx/drawing/scaling.rb

@@ -35,14 +35,28 @@ module Axlsx
     attr_reader :min
 
     # @see logBase
-    def logBase=(v) DataTypeValidator.validate "Scaling.logBase", [Integer], v, ->(arg) { arg >= 2 && arg <= 1000 }; @logBase = v; end
+    def logBase=(v)
+      DataTypeValidator.validate "Scaling.logBase", [Integer], v, ->(arg) { arg >= 2 && arg <= 1000 }
+      @logBase = v
+    end
+
     # @see orientation
-    def orientation=(v) RestrictionValidator.validate "Scaling.orientation", [:minMax, :maxMin], v; @orientation = v; end
+    def orientation=(v)
+      RestrictionValidator.validate "Scaling.orientation", [:minMax, :maxMin], v
+      @orientation = v
+    end
+
     # @see max
-    def max=(v) DataTypeValidator.validate "Scaling.max", Float, v; @max = v; end
+    def max=(v)
+      DataTypeValidator.validate "Scaling.max", Float, v
+      @max = v
+    end
 
     # @see min
-    def min=(v) DataTypeValidator.validate "Scaling.min", Float, v; @min = v; end
+    def min=(v)
+      DataTypeValidator.validate "Scaling.min", Float, v
+      @min = v
+    end
 
     # Serializes the object
     # @param [String] str

data/lib/axlsx/drawing/scatter_chart.rb

@@ -33,7 +33,7 @@ module Axlsx
       @vary_colors = 0
       @scatter_style = :lineMarker
 
-      super(frame, options)
+      super
       @series_type = ScatterSeries
       @d_lbls = nil
       parse_options options
@@ -50,7 +50,7 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = +'')
-      super(str) do
+      super do
         str << '<c:scatterChart>'
         str << '<c:scatterStyle val="' << scatter_style.to_s << '"/>'
         str << '<c:varyColors val="' << vary_colors.to_s << '"/>'

data/lib/axlsx/drawing/scatter_series.rb

@@ -50,7 +50,7 @@ module Axlsx
       @show_marker = [:lineMarker, :marker, :smoothMarker].include?(chart.scatter_style)
       @marker_symbol = :default
 
-      super(chart, options)
+      super
       @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
@@ -81,7 +81,7 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = +'')
-      super(str) do
+      super do
         # needs to override the super color here to push in ln/and something else!
         if color
           str << '<c:spPr><a:solidFill>'

data/lib/axlsx/drawing/ser_axis.rb

@@ -3,7 +3,7 @@
 module Axlsx
   # A SerAxis object defines a series axis
   class SerAxis < Axis
-    # The number of tick lables to skip between labels
+    # The number of tick labels to skip between labels
     # @return [Integer]
     attr_reader :tick_lbl_skip
     alias :tickLblSkip :tick_lbl_skip
@@ -18,15 +18,21 @@ module Axlsx
     # @option options [Integer] tick_mark_skip
     def initialize(options = {})
       @tick_lbl_skip, @tick_mark_skip = 1, 1
-      super(options)
+      super
     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
@@ -34,7 +40,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = +'')
       str << '<c:serAx>'
-      super(str)
+      super
       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>'

data/lib/axlsx/drawing/series.rb

@@ -40,7 +40,10 @@ 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)
@@ -52,7 +55,10 @@ module Axlsx
     private
 
     # assigns the chart for this series
-    def chart=(v) DataTypeValidator.validate "Series.chart", Chart, v; @chart = v; end
+    def chart=(v)
+      DataTypeValidator.validate "Series.chart", Chart, v
+      @chart = v
+    end
 
     # Serializes the object
     # @param [String] str

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -39,7 +39,7 @@ module Axlsx
       parse_options options
 
       # bit of a hack to work around the fact that the coords for start at and end at
-      # are passed in as an array when specified in intialization options - however
+      # are passed in as an array when specified in initialization options - however
       start_at(*options[:start_at]) if options[:start_at]
       end_at(*options[:end_at]) if options[:end_at]
     end

data/lib/axlsx/drawing/val_axis.rb

@@ -13,7 +13,7 @@ module Axlsx
     # @option options [Symbol] crosses_between
     def initialize(options = {})
       self.cross_between = :between
-      super(options)
+      super
     end
 
     # @see cross_between
@@ -28,7 +28,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = +'')
       str << '<c:valAx>'
-      super(str)
+      super
       str << '<c:crossBetween val="' << @cross_between.to_s << '"/>'
       str << '</c:valAx>'
     end

data/lib/axlsx/drawing/view_3D.rb

@@ -78,11 +78,17 @@ module Axlsx
     alias :rotY= :rot_y=
 
     # @see depth_percent
-    def depth_percent=(v) RegexValidator.validate "#{self.class}.depth_percent", DEPTH_PERCENT_REGEX, v; @depth_percent = v; end
+    def depth_percent=(v)
+      RegexValidator.validate "#{self.class}.depth_percent", DEPTH_PERCENT_REGEX, v
+      @depth_percent = v
+    end
     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

data/lib/axlsx/package.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Axlsx
-  # Package is responsible for managing all the bits and peices that Open Office XML requires to make a valid
+  # Package is responsible for managing all the bits and pieces that Open Office XML requires to make a valid
   # xlsx document including validation and serialization.
   class Package
     include Axlsx::OptionsParser
@@ -55,11 +55,11 @@ module Axlsx
     # @raise ArgumentError if workbook parameter is not a Workbook instance.
     # @note As there are multiple ways to instantiate a workbook for the package,
     #   here are a few examples:
-    #     # assign directly during package instanciation
+    #     # assign directly during package instantiation
     #     wb = Package.new(:workbook => Workbook.new).workbook
     #
     #     # get a fresh workbook automatically from the package
-    #     wb = Pacakge.new().workbook
+    #     wb = Package.new().workbook
     #     #     # set the workbook after creating the package
     #     wb = Package.new().workbook = Workbook.new
     def workbook
@@ -69,7 +69,10 @@ module Axlsx
     end
 
     # @see workbook
-    def workbook=(workbook) DataTypeValidator.validate :Package_workbook, Workbook, workbook; @workbook = workbook; end
+    def workbook=(workbook)
+      DataTypeValidator.validate :Package_workbook, Workbook, workbook
+      @workbook = workbook
+    end
 
     # Serialize your workbook to disk as an xlsx document.
     #
@@ -204,7 +207,7 @@ module Axlsx
     # Note: {Core#created} also defaults to the current time – so to generate identical axlsx packages you have
     # to set this explicitly, too (eg. with `Package.new(created_at: Time.local(2013, 1, 1))`).
     #
-    # @param part A hash describing a part of this pacakge (see {#parts})
+    # @param part A hash describing a part of this package (see {#parts})
     # @return [Zip::Entry]
     def zip_entry_for_part(part)
       timestamp = Zip::DOSTime.at(@core.created.to_i)
@@ -270,7 +273,7 @@ module Axlsx
       ]
     end
 
-    # Performs xsd validation for a signle document
+    # Performs xsd validation for a single document
     #
     # @param [String] schema path to the xsd schema to be used in validation.
     # @param [String] doc The xml text to be validated
@@ -279,11 +282,8 @@ module Axlsx
     def validate_single_doc(schema, doc)
       schema = Nokogiri::XML::Schema(File.open(schema))
       doc = Nokogiri::XML(doc)
-      errors = []
-      schema.validate(doc).each do |error|
-        errors << error
-      end
-      errors
+
+      schema.validate(doc)
     end
 
     # Appends override objects for drawings, charts, and sheets as they exist in your workbook to the default content types.

data/lib/axlsx/rels/relationship.rb

@@ -15,7 +15,7 @@ module Axlsx
       #
       # This should be called before serializing a package (see {Package#serialize} and
       # {Package#to_stream}) to make sure that serialization is idempotent (i.e.
-      # Relationship instances are generated with the same IDs everytime the package
+      # Relationship instances are generated with the same IDs every time the package
       # is serialized).
       def initialize_ids_cache
         Thread.current[:axlsx_relationship_ids_cache] = {}
@@ -92,12 +92,22 @@ 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
@@ -106,7 +116,7 @@ module Axlsx
       h = Axlsx.instance_values_for(self).reject { |k, _| k == "source_obj" }
       str << '<Relationship '
       h.each_with_index do |key_value, index|
-        str << ' ' unless index.zero?
+        str << ' ' unless index == 0
         str << key_value.first.to_s << '="' << Axlsx.coder.encode(key_value.last.to_s) << '"'
       end
       str << '/>'

data/lib/axlsx/rels/relationships.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Axlsx
-  require 'axlsx/rels/relationship'
+  require_relative 'relationship'
 
   # Relationships are a collection of Relations that define how package parts are related.
-  # @note The package automatically manages releationships.
+  # @note The package automatically manages relationships.
   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.

data/lib/axlsx/stylesheet/border.rb

@@ -43,15 +43,24 @@ 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

data/lib/axlsx/stylesheet/border_pr.rb

@@ -7,7 +7,7 @@ module Axlsx
     # @return [Color] The color of this border part.
     attr_reader :color
 
-    # @return [Symbol] The syle of this border part.
+    # @return [Symbol] The style of this border part.
     # @note
     #  The following are allowed
     #   :none
@@ -53,11 +53,22 @@ 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

data/lib/axlsx/stylesheet/cell_alignment.rb

@@ -25,7 +25,7 @@ module Axlsx
 
     # The horizontal alignment of the cell.
     # @note
-    #  The horizontal cell alignement style must be one of
+    #  The horizontal cell alignment style must be one of
     #   :general
     #   :left
     #   :center
@@ -86,34 +86,63 @@ 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

data/lib/axlsx/stylesheet/cell_protection.rb

@@ -26,9 +26,16 @@ 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

data/lib/axlsx/stylesheet/cell_style.rb

@@ -8,7 +8,7 @@ module Axlsx
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
 
-    # Creats a new CellStyle object
+    # Creates a new CellStyle object
     # @option options [String] name
     # @option options [Integer] xfId
     # @option options [Integer] buildinId
@@ -48,17 +48,40 @@ 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