caxlsx 3.2.0 → 3.4.0

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

@@ -1,66 +1,63 @@
-# encoding: UTF-8
-module Axlsx
-  # Table
-  # @note Worksheet#add_pivot_table is the recommended way to create tables for your worksheets.
-  # @see README for examples
-  class PivotTableCacheDefinition
-
-    include Axlsx::OptionsParser
-
-    # Creates a new PivotTable object
-    # @param [String] pivot_table The pivot table this cache definition is in
-    def initialize(pivot_table)
-      @pivot_table = pivot_table
-    end
-
-    # # The reference to the pivot table data
-    # # @return [PivotTable]
-    attr_reader :pivot_table
-
-    # The index of this chart in the workbooks charts collection
-    # @return [Integer]
-    def index
-      pivot_table.sheet.workbook.pivot_tables.index(pivot_table)
-    end
-
-    # The part name for this table
-    # @return [String]
-    def pn
-      "#{PIVOT_TABLE_CACHE_DEFINITION_PN % (index+1)}"
-    end
-
-    # The identifier for this cache
-    # @return [Integer]
-    def cache_id
-      index + 1
-    end
-
-    # The relationship id for this pivot table cache definition.
-    # @see Relationship#Id
-    # @return [String]
-    def rId
-      pivot_table.relationships.for(self).Id
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<?xml version="1.0" encoding="UTF-8"?>'
-      str << ('<pivotCacheDefinition xmlns="' << XML_NS << '" xmlns:r="' << XML_NS_R << '" invalid="1" refreshOnLoad="1" recordCount="0">')
-      str <<   '<cacheSource type="worksheet">'
-      str << (    '<worksheetSource ref="' << pivot_table.range << '" sheet="' << pivot_table.data_sheet.name << '"/>')
-      str <<   '</cacheSource>'
-      str << (  '<cacheFields count="' << pivot_table.header_cells_count.to_s << '">')
-      pivot_table.header_cells.each do |cell|
-        str << (  '<cacheField name="' << cell.clean_value << '" numFmtId="0">')
-        str <<     '<sharedItems count="0">'
-        str <<     '</sharedItems>'
-        str <<   '</cacheField>'
-      end
-      str <<   '</cacheFields>'
-      str << '</pivotCacheDefinition>'
-    end
-
-  end
-end
+module Axlsx
+  # Table
+  # @note Worksheet#add_pivot_table is the recommended way to create tables for your worksheets.
+  # @see README for examples
+  class PivotTableCacheDefinition
+    include Axlsx::OptionsParser
+
+    # Creates a new PivotTable object
+    # @param [String] pivot_table The pivot table this cache definition is in
+    def initialize(pivot_table)
+      @pivot_table = pivot_table
+    end
+
+    # # The reference to the pivot table data
+    # # @return [PivotTable]
+    attr_reader :pivot_table
+
+    # The index of this chart in the workbooks charts collection
+    # @return [Integer]
+    def index
+      pivot_table.sheet.workbook.pivot_tables.index(pivot_table)
+    end
+
+    # The part name for this table
+    # @return [String]
+    def pn
+      "#{PIVOT_TABLE_CACHE_DEFINITION_PN % (index + 1)}"
+    end
+
+    # The identifier for this cache
+    # @return [Integer]
+    def cache_id
+      index + 1
+    end
+
+    # The relationship id for this pivot table cache definition.
+    # @see Relationship#Id
+    # @return [String]
+    def rId
+      pivot_table.relationships.for(self).Id
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
+      str << ('<pivotCacheDefinition xmlns="' << XML_NS << '" xmlns:r="' << XML_NS_R << '" invalid="1" refreshOnLoad="1" recordCount="0">')
+      str << '<cacheSource type="worksheet">'
+      str << ('<worksheetSource ref="' << pivot_table.range << '" sheet="' << pivot_table.data_sheet.name << '"/>')
+      str << '</cacheSource>'
+      str << ('<cacheFields count="' << pivot_table.header_cells_count.to_s << '">')
+      pivot_table.header_cells.each do |cell|
+        str << ('<cacheField name="' << cell.clean_value << '" numFmtId="0">')
+        str <<     '<sharedItems count="0">'
+        str <<     '</sharedItems>'
+        str << '</cacheField>'
+      end
+      str << '</cacheFields>'
+      str << '</pivotCacheDefinition>'
+    end
+  end
+end

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

@@ -1,24 +1,23 @@
-module Axlsx
-
-  # A simple, self serializing class for storing pivot tables
-  class PivotTables < SimpleTypedList
-
-    # creates a new Tables object
-    def initialize(worksheet)
-      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
-      super PivotTable
-      @worksheet = worksheet
-    end
-
-    # The worksheet that owns this collection of pivot tables
-    # @return [Worksheet]
-    attr_reader :worksheet
-
-    # returns the relationships required by this collection
-    def relationships
-      return [] if empty?
-      map{ |pivot_table| Relationship.new(pivot_table, PIVOT_TABLE_R, "../#{pivot_table.pn}") }
-    end
-  end
-
-end
+module Axlsx
+  # A simple, self serializing class for storing pivot tables
+  class PivotTables < SimpleTypedList
+    # creates a new Tables object
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+
+      super PivotTable
+      @worksheet = worksheet
+    end
+
+    # The worksheet that owns this collection of pivot tables
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # returns the relationships required by this collection
+    def relationships
+      return [] if empty?
+
+      map { |pivot_table| Relationship.new(pivot_table, PIVOT_TABLE_R, "../#{pivot_table.pn}") }
+    end
+  end
+end

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

@@ -1,39 +1,38 @@
-module Axlsx
-  # Options for printing a worksheet. All options are boolean and false by default.
-  #
-  # @note The recommended way to manage print options is via Worksheet#print_options
-  # @see Worksheet#print_options
-  # @see Worksheet#initialize
-  class PrintOptions
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-    include Axlsx::Accessors
-    # Creates a new PrintOptions object
-    # @option options [Boolean] grid_lines Whether grid lines should be printed
-    # @option options [Boolean] headings Whether row and column headings should be printed
-    # @option options [Boolean] horizontal_centered Whether the content should be centered horizontally
-    # @option options [Boolean] vertical_centered  Whether the content should be centered vertically
-    def initialize(options = {})
-      @grid_lines = @headings = @horizontal_centered = @vertical_centered = false
-      set(options)
-    end
-
-    serializable_attributes :grid_lines, :headings, :horizontal_centered, :vertical_centered
-    boolean_attr_accessor :grid_lines, :headings, :horizontal_centered, :vertical_centered
-
-    # Set some or all options at once.
-    # @param [Hash] options The options to set (possible keys are :grid_lines, :headings, :horizontal_centered, and :vertical_centered).
-    def set(options)
-      parse_options options
-    end
-
-    # Serializes the page options element.
-    # @note As all attributes default to "false" according to the xml schema definition, the generated xml includes only those attributes that are set to true.
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      serialized_tag 'printOptions', str
-    end
-  end
-end
+module Axlsx
+  # Options for printing a worksheet. All options are boolean and false by default.
+  #
+  # @note The recommended way to manage print options is via Worksheet#print_options
+  # @see Worksheet#print_options
+  # @see Worksheet#initialize
+  class PrintOptions
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    include Axlsx::Accessors
+    # Creates a new PrintOptions object
+    # @option options [Boolean] grid_lines Whether grid lines should be printed
+    # @option options [Boolean] headings Whether row and column headings should be printed
+    # @option options [Boolean] horizontal_centered Whether the content should be centered horizontally
+    # @option options [Boolean] vertical_centered  Whether the content should be centered vertically
+    def initialize(options = {})
+      @grid_lines = @headings = @horizontal_centered = @vertical_centered = false
+      set(options)
+    end
+
+    serializable_attributes :grid_lines, :headings, :horizontal_centered, :vertical_centered
+    boolean_attr_accessor :grid_lines, :headings, :horizontal_centered, :vertical_centered
+
+    # Set some or all options at once.
+    # @param [Hash] options The options to set (possible keys are :grid_lines, :headings, :horizontal_centered, and :vertical_centered).
+    def set(options)
+      parse_options options
+    end
+
+    # Serializes the page options element.
+    # @note As all attributes default to "false" according to the xml schema definition, the generated xml includes only those attributes that are set to true.
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      serialized_tag 'printOptions', str
+    end
+  end
+end

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

@@ -1,47 +1,46 @@
-module Axlsx
-  # The Protected Range class represents a set of cells in the worksheet
-  # @note the recommended way to manage protected ranges with via Worksheet#protect_range
-  # @see Worksheet#protect_range
-  class ProtectedRange
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-
-   # Initializes a new protected range object
-    # @option [String] sqref The cell range reference to protect. This can be an absolute or a relateve range however, it only applies to the current sheet.
-    # @option [String] name An optional name for the protected name.
-    def initialize(options={})
-      parse_options options
-      yield self if block_given?
-    end
-
-    serializable_attributes :sqref, :name
-    # The reference for the protected range
-    # @return [String]
-    attr_reader :sqref
-
-    # The name of the protected range
-    # @return [String]
-    attr_reader :name
-
-    # @see sqref
-    def sqref=(v)
-      Axlsx.validate_string(v)
-      @sqref = v
-    end
-
-    # @see name
-    def name=(v)
-      Axlsx.validate_string(v)
-      @name = v
-    end
-
-    # serializes the proteted range
-    # @param [String] str if this string object is provided we append
-    # our output to that object. Use this - it helps limit the number of
-    # objects created during serialization
-    def to_xml_string(str="")
-      serialized_tag 'protectedRange', str
-    end 
-  end
-end
+module Axlsx
+  # The Protected Range class represents a set of cells in the worksheet
+  # @note the recommended way to manage protected ranges with via Worksheet#protect_range
+  # @see Worksheet#protect_range
+  class ProtectedRange
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Initializes a new protected range object
+    # @option [String] sqref The cell range reference to protect. This can be an absolute or a relateve range however, it only applies to the current sheet.
+    # @option [String] name An optional name for the protected name.
+    def initialize(options = {})
+      parse_options options
+      yield self if block_given?
+    end
+
+    serializable_attributes :sqref, :name
+    # The reference for the protected range
+    # @return [String]
+    attr_reader :sqref
+
+    # The name of the protected range
+    # @return [String]
+    attr_reader :name
+
+    # @see sqref
+    def sqref=(v)
+      Axlsx.validate_string(v)
+      @sqref = v
+    end
+
+    # @see name
+    def name=(v)
+      Axlsx.validate_string(v)
+      @name = v
+    end
+
+    # serializes the proteted range
+    # @param [String] str if this string object is provided we append
+    # our output to that object. Use this - it helps limit the number of
+    # objects created during serialization
+    def to_xml_string(str = "")
+      serialized_tag 'protectedRange', str
+    end
+  end
+end

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

@@ -1,37 +1,37 @@
-module Axlsx
-
-  # A self serializing collection of ranges that should be protected in
-  # the worksheet
-  class ProtectedRanges < SimpleTypedList
-
-    attr_reader :worksheet
-
-    def initialize(worksheet)
-      raise ArgumentError, 'You must provide a worksheet' unless worksheet.is_a?(Worksheet)
-      super ProtectedRange
-      @worksheet = worksheet
-    end
-
-    # Adds a protected range
-    # @param [Array|String] cells A string range reference or array of cells that will be protected
-    def add_range(cells)
-     sqref = if cells.is_a?(String)
-               cells
-             elsif cells.is_a?(SimpleTypedList) || cells.is_a?(Array)
-               Axlsx::cell_range(cells, false)
-             end
-     self << ProtectedRange.new(:sqref => sqref, :name => "Range#{size}")
-     last
-    end
-
-    # Serializes the protected ranges
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      return if empty?
-      str << '<protectedRanges>'
-      each { |range| range.to_xml_string(str) }
-      str << '</protectedRanges>'
-    end
-  end
-end
+module Axlsx
+  # A self serializing collection of ranges that should be protected in
+  # the worksheet
+  class ProtectedRanges < SimpleTypedList
+    attr_reader :worksheet
+
+    def initialize(worksheet)
+      raise ArgumentError, 'You must provide a worksheet' unless worksheet.is_a?(Worksheet)
+
+      super ProtectedRange
+      @worksheet = worksheet
+    end
+
+    # Adds a protected range
+    # @param [Array|String] cells A string range reference or array of cells that will be protected
+    def add_range(cells)
+      sqref = if cells.is_a?(String)
+                cells
+              elsif cells.is_a?(SimpleTypedList) || cells.is_a?(Array)
+                Axlsx::cell_range(cells, false)
+              end
+      self << ProtectedRange.new(:sqref => sqref, :name => "Range#{size}")
+      last
+    end
+
+    # Serializes the protected ranges
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      return if empty?
+
+      str << '<protectedRanges>'
+      each { |range| range.to_xml_string(str) }
+      str << '</protectedRanges>'
+    end
+  end
+end

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

@@ -1,55 +1,53 @@
-module Axlsx
-
-  # A simple, self serializing class for storing TextRuns
-  class RichText < SimpleTypedList
-
-    # creates a new RichText collection
-    # @param [String] text -optional The text to use in creating the first RichTextRun
-    # @param [Object] options -optional The options to use in creating the first RichTextRun
-    # @yield [RichText] self
-    def initialize(text = nil, options={})
-      super(RichTextRun)
-      add_run(text, options) unless text.nil?
-      yield self if block_given?
-    end
-
-    # The cell that owns this RichText collection
-    attr_reader :cell
-
-    # Assign the cell for this RichText collection
-    # @param [Cell] cell The cell which all RichTextRuns in the collection will belong to
-    def cell=(cell)
-      @cell = cell
-      each { |run| run.cell = cell }
-    end
-
-    # Calculates the longest autowidth of the RichTextRuns in this collection
-    # @return [Number]
-    def autowidth
-      widtharray = [0] # Are arrays the best way of solving this problem?
-      each { |run| run.autowidth(widtharray) }
-      widtharray.max
-    end
-
-    # Creates and adds a RichTextRun to this collectino
-    # @param [String] text The text to use in creating a new RichTextRun
-    # @param [Object] options The options to use in creating the new RichTextRun
-    def add_run(text, options={})
-      self << RichTextRun.new(text, options)
-    end
-
-    # The RichTextRuns we own
-    # @return [RichText]
-    def runs
-      self
-    end
-
-    # renders the RichTextRuns in this collection
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str='')
-      each{ |run| run.to_xml_string(str) }
-      str
-    end
-  end
-end
+module Axlsx
+  # A simple, self serializing class for storing TextRuns
+  class RichText < SimpleTypedList
+    # creates a new RichText collection
+    # @param [String] text -optional The text to use in creating the first RichTextRun
+    # @param [Object] options -optional The options to use in creating the first RichTextRun
+    # @yield [RichText] self
+    def initialize(text = nil, options = {})
+      super(RichTextRun)
+      add_run(text, options) unless text.nil?
+      yield self if block_given?
+    end
+
+    # The cell that owns this RichText collection
+    attr_reader :cell
+
+    # Assign the cell for this RichText collection
+    # @param [Cell] cell The cell which all RichTextRuns in the collection will belong to
+    def cell=(cell)
+      @cell = cell
+      each { |run| run.cell = cell }
+    end
+
+    # Calculates the longest autowidth of the RichTextRuns in this collection
+    # @return [Number]
+    def autowidth
+      widtharray = [0] # Are arrays the best way of solving this problem?
+      each { |run| run.autowidth(widtharray) }
+      widtharray.max
+    end
+
+    # Creates and adds a RichTextRun to this collectino
+    # @param [String] text The text to use in creating a new RichTextRun
+    # @param [Object] options The options to use in creating the new RichTextRun
+    def add_run(text, options = {})
+      self << RichTextRun.new(text, options)
+    end
+
+    # The RichTextRuns we own
+    # @return [RichText]
+    def runs
+      self
+    end
+
+    # renders the RichTextRuns in this collection
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      each { |run| run.to_xml_string(str) }
+      str
+    end
+  end
+end