caxlsx 3.3.0 → 3.4.0

data/lib/axlsx/drawing/cat_axis.rb

@@ -1,12 +1,10 @@
-# encoding: UTF-8
 module Axlsx
-  #A CatAxis object defines a chart category axis
+  # A CatAxis object defines a chart category axis
   class CatAxis < Axis
-
     # Creates a new CatAxis object
     # @option options [Integer] tick_lbl_skip
     # @option options [Integer] tick_mark_skip
-    def initialize(options={})
+    def initialize(options = {})
       @tick_lbl_skip = 1
       @tick_mark_skip = 1
       self.auto = 1
@@ -78,8 +76,5 @@ module Axlsx
       str << ('<c:tickMarkSkip val="' << @tick_mark_skip.to_s << '"/>')
       str << '</c:catAx>'
     end
-
   end
-
-
 end

data/lib/axlsx/drawing/chart.rb

@@ -1,11 +1,8 @@
-# encoding: UTF-8
 module Axlsx
-
   # A Chart is the superclass for specific charts
   # @note Worksheet#add_chart is the recommended way to create charts for your worksheets.
   # @see README for examples
   class Chart
-
     include Axlsx::OptionsParser
     # Creates a new chart object
     # @param [GraphicalFrame] frame The frame that holds this chart.
@@ -16,10 +13,10 @@ module Axlsx
     # @option options [Array|String|Cell] end_at The X, Y coordinates defining the bottom right corner of the chart.
     # @option options [Boolean] plot_visible_only (true) Whether only data from visible cells should be plotted.
     # @option options [Boolean] rounded_corners (true) Whether the chart area shall have rounded corners.
-    def initialize(frame, options={})
+    def initialize(frame, options = {})
       @style = 18
       @view_3D = nil
-      @graphic_frame=frame
+      @graphic_frame = frame
       @graphic_frame.anchor.drawing.worksheet.workbook.charts << self
       @series = SimpleTypedList.new Series
       @show_legend = true
@@ -52,7 +49,7 @@ module Axlsx
     # @return [Series]
     attr_reader :series_type
 
-    #TODO data labels!
+    # TODO data labels!
     def d_lbls
       @d_lbls ||= DLbls.new(self.class)
     end
@@ -125,7 +122,7 @@ module Axlsx
     # The part name for this chart
     # @return [String]
     def pn
-      "#{CHART_PN % (index+1)}"
+      "#{CHART_PN % (index + 1)}"
     end
 
     # The title object for the chart.
@@ -181,7 +178,7 @@ module Axlsx
     # Adds a new series to the chart's series collection.
     # @return [Series]
     # @see Series
-    def add_series(options={})
+    def add_series(options = {})
       @series_type.new(self, options)
       @series.last
     end
@@ -275,7 +272,7 @@ module Axlsx
     # reference or cell to use in setting the start marker position.
     # @param [Integer] y The row
     # @return [Marker]
-    def start_at(x=0, y=0)
+    def start_at(x = 0, y = 0)
       @graphic_frame.anchor.start_at(x, y)
     end
 
@@ -286,14 +283,12 @@ module Axlsx
     # @param [Integer] y The row - default 10
     # @return [Marker]
     # @see start_at
-    def end_at(x=10, y=10)
+    def end_at(x = 10, y = 10)
       @graphic_frame.anchor.end_at(x, y)
     end
 
     # sets the view_3D object for the chart
     def view_3D=(v) DataTypeValidator.validate "#{self.class}.view_3D", View3D, v; @view_3D = v; end
     alias :view3D= :view_3D=
-
   end
-
 end

data/lib/axlsx/drawing/d_lbls.rb

@@ -2,15 +2,15 @@ module Axlsx
   # There are more elements in the dLbls spec that allow for
   # customizations and formatting. For now, I am just implementing the
   # basics.
-  #The DLbls class manages serialization of data labels
+  # The DLbls class manages serialization of data labels
   # showLeaderLines and leaderLines are not currently implemented
   class DLbls
-
     include Axlsx::Accessors
-    include Axlsx::OptionsParser 
+    include Axlsx::OptionsParser
     # creates a new DLbls object
-    def initialize(chart_type, options={})
+    def initialize(chart_type, options = {})
       raise ArgumentError, 'chart_type must inherit from Chart' unless [Chart, LineChart].include?(chart_type.superclass)
+
       @chart_type = chart_type
       initialize_defaults
       parse_options options
@@ -18,31 +18,31 @@ module Axlsx
 
     # These attributes are all boolean so I'm doing a bit of a hand
     # waving magic show to set up the attriubte accessors
-    # @note 
-    #   not all charts support all methods! 
+    # @note
+    #   not all charts support all methods!
     #   Bar3DChart and Line3DChart and ScatterChart do not support d_lbl_pos or show_leader_lines
-    #    
-    boolean_attr_accessor :show_legend_key, 
-                          :show_val, 
-                          :show_cat_name, 
-                          :show_ser_name, 
-                          :show_percent, 
-                          :show_bubble_size, 
+    #
+    boolean_attr_accessor :show_legend_key,
+                          :show_val,
+                          :show_cat_name,
+                          :show_ser_name,
+                          :show_percent,
+                          :show_bubble_size,
                           :show_leader_lines
 
     # Initialize all the values to false as Excel requires them to
     # explicitly be disabled or all will show.
     def initialize_defaults
-      [:show_legend_key, :show_val, :show_cat_name, 
-       :show_ser_name, :show_percent, :show_bubble_size, 
+      [:show_legend_key, :show_val, :show_cat_name,
+       :show_ser_name, :show_percent, :show_bubble_size,
        :show_leader_lines].each do |attr|
         self.send("#{attr}=", false)
       end
     end
 
-    # The chart type that is using this data lables instance. 
+    # The chart type that is using this data lables instance.
     # This affects the xml output as not all chart types support the
-    # same data label attributes. 
+    # same data label attributes.
     attr_reader :chart_type
 
     # The position of the data labels in the chart
@@ -50,6 +50,7 @@ module Axlsx
     # @return [Symbol]
     def d_lbl_pos
       return unless [Pie3DChart, LineChart].include? @chart_type
+
       @d_lbl_pos ||= :bestFit
     end
 
@@ -61,11 +62,11 @@ module Axlsx
     # @param [Symbol] label_position the postion you want to use.
     def d_lbl_pos=(label_position)
       return unless [Pie3DChart, LineChart].include? @chart_type
-      Axlsx::RestrictionValidator.validate 'DLbls#d_lbl_pos',  [:bestFit, :b, :ctr, :inBase, :inEnd, :l, :outEnd, :r, :t], label_position
+
+      Axlsx::RestrictionValidator.validate 'DLbls#d_lbl_pos', [:bestFit, :b, :ctr, :inBase, :inEnd, :l, :outEnd, :r, :t], label_position
       @d_lbl_pos = label_position
     end
 
-   
     # serializes the data labels
     # @return [String]
     def to_xml_string(str = '')
@@ -74,7 +75,8 @@ module Axlsx
       instance_vals = Axlsx.instance_values_for(self)
       %w(d_lbl_pos show_legend_key show_val show_cat_name show_ser_name show_percent show_bubble_size show_leader_lines).each do |key|
         next unless instance_vals.keys.include?(key) && instance_vals[key] != nil
-        str <<  "<c:#{Axlsx::camel(key, false)} val='#{instance_vals[key]}' />" 
+
+        str << "<c:#{Axlsx::camel(key, false)} val='#{instance_vals[key]}' />"
       end
       str << '</c:dLbls>'
     end
@@ -82,10 +84,9 @@ module Axlsx
     # nills out d_lbl_pos and show_leader_lines as these attributes, while valid in the spec actually chrash excel for any chart type other than pie charts.
     def validate_attributes_for_chart_type
       return if [Pie3DChart, LineChart].include? @chart_type
+
       @d_lbl_pos = nil
       @show_leader_lines = nil
     end
-
-
   end
 end

data/lib/axlsx/drawing/drawing.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 module Axlsx
   require 'axlsx/drawing/d_lbls.rb'
   require 'axlsx/drawing/title.rb'
@@ -58,7 +57,6 @@ module Axlsx
   # @see Chart
   # see examples/example.rb for an example of how to create a chart.
   class Drawing
-
     # The worksheet that owns the drawing
     # @return [Worksheet]
     attr_reader :worksheet
@@ -77,12 +75,11 @@ module Axlsx
       @anchors = SimpleTypedList.new [TwoCellAnchor, OneCellAnchor]
     end
 
-
     # Adds an image to the chart If th end_at option is specified we create a two cell anchor. By default we use a one cell anchor.
     # @note The recommended way to manage images is to use Worksheet.add_image. Please refer to that method for documentation.
     # @see Worksheet#add_image
     # @return [Pic]
-    def add_image(options={})
+    def add_image(options = {})
       if options[:end_at]
         TwoCellAnchor.new(self, options).add_pic(options)
       else
@@ -94,7 +91,7 @@ module Axlsx
     # Adds a chart to the drawing.
     # @note The recommended way to manage charts is to use Worksheet.add_chart. Please refer to that method for documentation.
     # @see Worksheet#add_chart
-    def add_chart(chart_type, options={})
+    def add_chart(chart_type, options = {})
       TwoCellAnchor.new(self, options)
       @anchors.last.add_chart(chart_type, options)
     end
@@ -129,14 +126,14 @@ module Axlsx
     # The part name for this drawing
     # @return [String]
     def pn
-      "#{DRAWING_PN % (index+1)}"
+      "#{DRAWING_PN % (index + 1)}"
     end
 
     # The relational part name for this drawing
     # #NOTE This should be rewritten to return an Axlsx::Relationship object.
     # @return [String]
     def rels_pn
-      "#{DRAWING_RELS_PN % (index+1)}"
+      "#{DRAWING_RELS_PN % (index + 1)}"
     end
 
     # A list of objects this drawing holds.
@@ -162,6 +159,5 @@ module Axlsx
       anchors.each { |anchor| anchor.to_xml_string(str) }
       str << '</xdr:wsDr>'
     end
-
   end
 end

data/lib/axlsx/drawing/graphic_frame.rb

@@ -1,10 +1,8 @@
-# encoding: UTF-8
 module Axlsx
   # A graphic frame defines a container for a chart object
   # @note The recommended way to manage charts is Worksheet#add_chart
   # @see Worksheet#add_chart
   class GraphicFrame
-
     # A reference to the chart object associated with this frame
     # @return [Chart]
     attr_reader :chart
@@ -49,6 +47,5 @@ module Axlsx
       str << '</a:graphic>'
       str << '</xdr:graphicFrame>'
     end
-
   end
 end

data/lib/axlsx/drawing/hyperlink.rb

@@ -1,14 +1,12 @@
-# encoding: UTF-8
 module Axlsx
   # a hyperlink object adds an action to an image when clicked so that when the image is clicked the link is fecthed.
   # @note using the hyperlink option when calling add_image on a drawing object is the recommended way to manage hyperlinks
   # @see {file:README} README
   class Hyperlink
-
     include Axlsx::SerializedAttributes
     include Axlsx::OptionsParser
 
-    #Creates a hyperlink object
+    # Creates a hyperlink object
     # parent must be a Pic for now, although I expect that other object support this tag and its cNvPr parent
     # @param [Pic] parent
     # @option options [String] tooltip message shown when hyperlinked object is hovered over with mouse.
@@ -19,7 +17,7 @@ module Axlsx
     # @option options [Boolean] endSnd terminate any sound events when processing this link
     # @option options [Boolean] history include this link in the list of visited links for the applications history.
     # @option options [Boolean] highlightClick indicate that the link has already been visited.
-    def initialize(parent, options={})
+    def initialize(parent, options = {})
       DataTypeValidator.validate "Hyperlink.parent", [Pic], parent
       @parent = parent
       parse_options options
@@ -40,7 +38,7 @@ module Axlsx
     alias :invalidUrl :invalid_url
     alias :invalidUrl= :invalid_url=
 
-    #An action to take when the link is clicked. The specification says "This can be used to specify a slide to be navigated to or a script of code to be run." but in most cases you will not need to do anything with this. MS does reserve a few interesting strings. @see http://msdn.microsoft.com/en-us/library/ff532419%28v=office.12%29.aspx
+    # An action to take when the link is clicked. The specification says "This can be used to specify a slide to be navigated to or a script of code to be run." but in most cases you will not need to do anything with this. MS does reserve a few interesting strings. @see http://msdn.microsoft.com/en-us/library/ff532419%28v=office.12%29.aspx
     # @return [String]
     attr_accessor :action
 
@@ -93,8 +91,7 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      serialized_tag 'a:hlinkClick', str, {:'r:id' => relationship.Id, :'xmlns:r' => XML_NS_R }
+      serialized_tag 'a:hlinkClick', str, { :'r:id' => relationship.Id, :'xmlns:r' => XML_NS_R }
     end
-
   end
 end

data/lib/axlsx/drawing/line_3D_chart.rb

@@ -1,6 +1,4 @@
-# encoding: UTF-8
 module Axlsx
-
   # The Line3DChart is a three 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 +18,6 @@ module Axlsx
   # @see Series
   # @see Package#serialize
   class Line3DChart < Axlsx::LineChart
-
     # space between bar or column clusters, as a percentage of the bar or column width.
     # @return [String]
     attr_reader :gap_depth
@@ -41,28 +38,27 @@ module Axlsx
     # @see Chart
     # @see lineChart
     # @see View3D
-    def initialize(frame, options={})
+    def initialize(frame, options = {})
       @gap_depth = nil
-      @view_3D = View3D.new({:r_ang_ax=>1}.merge(options))
+      @view_3D = View3D.new({ :r_ang_ax => 1 }.merge(options))
       super(frame, options)
       axes.add_axis :ser_axis, SerAxis
     end
 
-
     # @see gapDepth
     def gap_depth=(v)
       RegexValidator.validate "Line3DChart.gapWidth", GAP_AMOUNT_PERCENT, v
-      @gap_depth=(v)
+      @gap_depth = (v)
     end
     alias :gapDepth= :gap_depth=
 
-      # Serializes the object
-      # @param [String] str
-      # @return [String]
-      def to_xml_string(str = '')
-        super(str) do
-          str << ('<c:gapDepth val="' << @gap_depth.to_s << '"/>') unless @gap_depth.nil?
-        end
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        str << ('<c:gapDepth val="' << @gap_depth.to_s << '"/>') unless @gap_depth.nil?
       end
+    end
   end
 end

data/lib/axlsx/drawing/line_chart.rb

@@ -1,6 +1,4 @@
-# encoding: UTF-8
 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 +18,6 @@ module Axlsx
   # @see Series
   # @see Package#serialize
   class LineChart < Chart
-
     # the category axis
     # @return [CatAxis]
     def cat_axis
@@ -35,7 +32,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 +42,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)
@@ -66,7 +63,7 @@ module Axlsx
     def node_name
       path = self.class.to_s
       if i = path.rindex('::')
-        path = path[(i+2)..-1]
+        path = path[(i + 2)..-1]
       end
       path[0] = path[0].chr.downcase
       path

data/lib/axlsx/drawing/line_series.rb

@@ -1,11 +1,9 @@
-# encoding: UTF-8
 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,7 +33,7 @@ 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
       @smooth = false
@@ -105,6 +103,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,8 @@
-# encoding: UTF-8
 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 +10,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,7 +31,7 @@ module Axlsx
     # @return [Integer]
     attr_reader :rowOff
 
-     # @see col
+    # @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
@@ -47,7 +45,7 @@ module Axlsx
     # 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]
@@ -61,11 +59,12 @@ module Axlsx
         str << ('<xdr:' << k.to_s << '>' << self.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)
       end
@@ -77,8 +76,5 @@ module Axlsx
       end
       [x, y]
     end
-
-
   end
-
 end

data/lib/axlsx/drawing/num_data.rb

@@ -1,16 +1,13 @@
-# -*- coding: utf-8 -*-
 module Axlsx
-
-  #This class specifies data for a particular data point. It is used for both numCache and numLit object
+  # 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,7 +19,7 @@ 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)
@@ -31,7 +28,7 @@ module Axlsx
     end
 
     # @see format_code
-    def format_code=(v='General')
+    def format_code=(v = 'General')
       Axlsx::validate_string(v)
       @format_code = v
     end
@@ -46,7 +43,5 @@ module Axlsx
       end
       str << ('</c:' << @tag_name.to_s << '>')
     end
-
   end
-
 end

data/lib/axlsx/drawing/num_data_source.rb

@@ -1,14 +1,12 @@
 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
@@ -22,7 +20,6 @@ module Axlsx
       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 +33,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,7 +42,7 @@ module Axlsx
 
     # serialize the object
     # @param [String] str
-    def to_xml_string(str="")
+    def to_xml_string(str = "")
       str << ('<c:' << tag_name.to_s << '>')
       if @f
         str << ('<c:' << @ref_tag_name.to_s << '>')
@@ -59,4 +56,3 @@ module Axlsx
     end
   end
 end
-

data/lib/axlsx/drawing/num_val.rb

@@ -1,9 +1,6 @@
-# -*- coding: utf-8 -*-
 module Axlsx
-
-  #This class specifies data for a particular data point.
+  # 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,7 +9,7 @@ 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

data/lib/axlsx/drawing/one_cell_anchor.rb

@@ -1,11 +1,9 @@
-# encoding: UTF-8
 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 +14,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,9 +52,10 @@ 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
@@ -92,8 +91,7 @@ module Axlsx
     def ext
       cy = @height * 914400 / 96
       cx = @width * 914400 / 96
-      {:cy=>cy, :cx=>cx}
+      { :cy => cy, :cx => cx }
     end
-
   end
 end