caxlsx 3.3.0 → 3.4.0

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

@@ -6,14 +6,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
@@ -28,12 +26,12 @@ module Axlsx
       # 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'})
+        self.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 +65,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={})
+    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}
+      { :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
@@ -93,6 +90,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,10 @@
 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
@@ -14,10 +13,11 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-     return if empty?
-     str << '<cols>'
-     each { |item| item.to_xml_string(str) }
-     str << '</cols>'
+      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,6 @@
 module Axlsx
-
   # A comment is the text data for a comment
   class Comment
-
     include Axlsx::OptionsParser
     include Axlsx::Accessors
 
@@ -13,8 +11,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
@@ -82,9 +81,9 @@ module Axlsx
       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,6 @@
-# -*- coding: utf-8 -*-
 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 +18,14 @@ module Axlsx
     # The part name for this object
     # @return [String]
     def pn
-      "#{COMMENT_PN % (index+1)}"
+      "#{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 +36,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,10 +62,10 @@ 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|
+      authors.each do |author|
         str << ('<author>' << author.to_s << '</author>')
       end
       str << '</authors><commentList>'
@@ -74,9 +73,6 @@ module Axlsx
         comment.to_xml_string str
       end
       str << '</commentList></comments>'
-
     end
-
   end
-
 end

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

@@ -5,13 +5,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 +27,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.
@@ -75,7 +74,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << ('<conditionalFormatting sqref="' << sqref << '">')
-      str << rules.collect{ |rule| rule.to_xml_string }.join(' ')
+      str << rules.collect { |rule| rule.to_xml_string }.join(' ')
       str << '</conditionalFormatting>'
     end
   end

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

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 module Axlsx
   # Conditional formatting rules specify formulas whose evaluations
   # format cells
@@ -7,7 +6,6 @@ module Axlsx
   # @see Worksheet#add_conditional_formatting
   # @see ConditionalFormattingRule#initialize
   class ConditionalFormattingRule
-
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
 
@@ -26,7 +24,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 +131,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]
@@ -182,7 +179,7 @@ module Axlsx
     # @see timePeriod
     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,7 +199,6 @@ module Axlsx
       @icon_set = v
     end
 
-
     # Serializes the conditional formatting rule
     # @param [String] str
     # @return [String]

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

@@ -1,11 +1,10 @@
 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
@@ -17,9 +16,8 @@ module Axlsx
     # serialize the conditional formattings
     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

@@ -6,15 +6,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
 
@@ -81,32 +80,32 @@ 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
+      self.color.rgb = v if v.is_a? String
+      @color
+    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)
@@ -124,6 +123,5 @@ module Axlsx
         end
       end
     end
-
   end
 end

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

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 module Axlsx
   # Data validation allows the validation of cell data
   #
@@ -23,7 +22,7 @@ module Axlsx
     # @option options [Boolean] showInputMessage - A boolean value indicating whether to display the input prompt message.
     # @option options [String] sqref - Range over which data validation is applied, in "A1:B2" format.
     # @option options [Symbol] type - The type of data validation.
-    def initialize(options={})
+    def initialize(options = {})
       # defaults
       @formula1 = @formula2 = @error = @errorTitle = @operator = @prompt = @promptTitle = @sqref = nil
       @allowBlank = @showErrorMessage = true
@@ -176,7 +175,6 @@ module Axlsx
     # default none
     attr_reader :type
 
-
     # @see formula1
     def formula1=(v); Axlsx::validate_string(v); @formula1 = v end
 
@@ -246,9 +244,10 @@ module Axlsx
       str << '</dataValidation>'
     end
 
-  private
+    private
+
     def get_valid_attributes
-      attributes = [:allowBlank, :error, :errorStyle, :errorTitle, :prompt, :promptTitle, :showErrorMessage, :showInputMessage, :sqref, :type ]
+      attributes = [:allowBlank, :error, :errorStyle, :errorTitle, :prompt, :promptTitle, :showErrorMessage, :showInputMessage, :sqref, :type]
 
       if [:whole, :decimal, :data, :time, :date, :textLength].include?(@type)
         attributes << [:operator, :formula1]

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

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

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

@@ -1,10 +1,8 @@
-# encoding: UTF-8
 require "date"
 
 module Axlsx
   # The DateTimeConverter class converts both data and time types to their apprpriate excel serializations
   class DateTimeConverter
-
     # The date_to_serial method converts Date objects to the equivelant excel serialized forms
     # @param [Date] date the date to be serialized
     # @return [Numeric]
@@ -24,7 +22,7 @@ module Axlsx
       epoch1904 = -2082844800.0 # Time.utc(1904, 1, 1).to_i
       seconds_per_day = 86400.0 # 60*60*24
       epoch = Axlsx::Workbook::date1904 ? epoch1904 : epoch1900
-      (time.utc_offset + time.to_f - epoch)/seconds_per_day
+      (time.utc_offset + time.to_f - epoch) / seconds_per_day
     end
   end
 end

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

@@ -1,10 +1,8 @@
 module Axlsx
-
   # This class manages the dimensions for a worksheet.
-  # While this node is optional in the specification some readers like 
+  # While this node is optional in the specification some readers like
   # LibraOffice require this node to render the sheet
   class Dimension
-
     # the default value for the first cell in the dimension
     # @return [String]
     def self.default_first
@@ -22,6 +20,7 @@ module Axlsx
     # to.
     def initialize(worksheet)
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+
       @worksheet = worksheet
     end
 
@@ -31,12 +30,13 @@ module Axlsx
     # @return [String]
     def sqref
       "#{first_cell_reference}:#{last_cell_reference}"
-    end 
+    end
 
     # serialize the object
     # @return [String]
     def to_xml_string(str = '')
       return if worksheet.rows.empty?
+
       str << "<dimension ref=\"%s\"></dimension>" % sqref
     end
 
@@ -58,6 +58,7 @@ module Axlsx
     # @return [String]
     def dimension_reference(cell, default)
       return default unless cell.respond_to?(:r)
+
       cell.r
     end
   end

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

@@ -9,7 +9,6 @@ module Axlsx
   # @note The recommended way of managing header/footers is via Worksheet#header_footer
   # @see Worksheet#initialize
   class HeaderFooter
-
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
     include Axlsx::Accessors

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

@@ -6,7 +6,6 @@ module Axlsx
   # @see Worksheet#add_conditional_formatting
   # @see ConditionalFormattingRule#initialize
   class IconSet
-
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
 
@@ -47,7 +46,7 @@ module Axlsx
     # @return [Boolean]
     attr_reader :showValue
 
-      # @see iconSet
+    # @see iconSet
     def iconSet=(v); Axlsx::validate_icon_set(v); @iconSet = v end
 
     # @see showValue
@@ -62,7 +61,7 @@ module Axlsx
     # Serialize this object to an xml string
     # @param [String] str
     # @return [String]
-    def to_xml_string(str="")
+    def to_xml_string(str = "")
       serialized_tag('iconSet', str) do
         @value_objects.each { |cfvo| cfvo.to_xml_string(str) }
       end

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

@@ -1,12 +1,11 @@
 module Axlsx
-
   # A simple list of merged cells
   class MergedCells < SimpleTypedList
-
     # creates a new MergedCells object
     # @param [Worksheet] worksheet
     def initialize(worksheet)
       raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
+
       super String
     end
 
@@ -16,12 +15,12 @@ module Axlsx
     # range like 'A1:C1'
     def add(cells)
       self << if cells.is_a?(String)
-                 cells
-               elsif cells.is_a?(Array)
-                 Axlsx::cell_range(cells, false)
-               elsif cells.is_a?(Row)
-                 Axlsx::cell_range(cells, false)
-               end
+                cells
+              elsif cells.is_a?(Array)
+                Axlsx::cell_range(cells, false)
+              elsif cells.is_a?(Row)
+                Axlsx::cell_range(cells, false)
+              end
     end
 
     # serialize the object
@@ -29,6 +28,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       return if empty?
+
       str << "<mergeCells count='#{size}'>"
       each { |merged_cell| str << "<mergeCell ref='#{merged_cell}'></mergeCell>" }
       str << '</mergeCells>'

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

@@ -1,5 +1,4 @@
 module Axlsx
-
   # The OutlinePr class manages serialization of a worksheet's outlinePr element, which provides various
   # options to control outlining.
   class OutlinePr

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

@@ -9,7 +9,6 @@ module Axlsx
   # @see Worksheet#page_margins
   # @see Worksheet#initialize
   class PageMargins
-
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
 
@@ -20,7 +19,7 @@ module Axlsx
     # @option options [Numeric] top The top margin in inches
     # @option options [Numeric] header The header margin in inches
     # @option options [Numeric] footer The footer margin in inches
-    def initialize(options={})
+    def initialize(options = {})
       # Default values taken from MS Excel for Mac 2011
       @left = @right = DEFAULT_LEFT_RIGHT
       @top = @bottom = DEFAULT_TOP_BOTTOM
@@ -68,6 +67,7 @@ module Axlsx
     def set(margins)
       margins.select do |k, v|
         next unless [:left, :right, :top, :bottom, :header, :footer].include? k
+
         send("#{k}=", v)
       end
     end

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

@@ -1,9 +1,7 @@
 module Axlsx
-
   # Page setup properties of the worksheet
   # This class name is not a typo, its spec.
   class PageSetUpPr
-
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
 
@@ -37,7 +35,7 @@ module Axlsx
     end
 
     # serialize to xml
-    def to_xml_string(str='')
+    def to_xml_string(str = '')
       str << ('<pageSetUpPr ' << serialized_attributes << '/>')
     end
   end