write_xlsx 1.09.3 → 1.09.5

data/lib/write_xlsx/format.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 require 'write_xlsx/utility'
 
 module Writexlsx
@@ -7,7 +8,7 @@ module Writexlsx
 
     attr_reader :xf_index, :dxf_index, :num_format                                                 # :nodoc:
     attr_reader :underline, :font_script, :size, :theme, :font, :font_family, :hyperlink, :xf_id   # :nodoc:
-    attr_reader :diag_type, :diag_color, :font_only, :color, :color_indexed                        # :nodoc:
+    attr_reader :diag_type, :diag_color, :font_only, :color_indexed                        # :nodoc:
     attr_reader :left, :left_color, :right, :right_color, :top, :top_color, :bottom, :bottom_color # :nodoc:
     attr_reader :font_scheme                                                                       # :nodoc:
     attr_accessor :num_format_index, :border_index, :font_index                                    # :nodoc:
@@ -23,7 +24,7 @@ module Writexlsx
       @xf_index       = nil
       @dxf_index      = nil
 
-      @num_format     = 'General'
+      @num_format = 'General'
       @num_format_index = 0
       @font_index     = 0
       @font           = 'Calibri'
@@ -90,11 +91,11 @@ module Writexlsx
     # Copy the attributes of another Format object.
     #
     def copy(other)
-      reserve = [
-        :xf_index,
-        :dxf_index,
-        :xdf_format_indices,
-        :palette
+      reserve = %i[
+        xf_index
+        dxf_index
+        xdf_format_indices
+        palette
       ]
       (instance_variables - reserve).each do |v|
         instance_variable_set(v, other.instance_variable_get(v))
@@ -113,6 +114,7 @@ module Writexlsx
     #
     def set_format_properties(*properties)   # :nodoc:
       return if properties.empty?
+
       properties.each do |property|
         property.each do |key, value|
           # Strip leading "-" from Tk style properties e.g. "-color" => 'red'.
@@ -157,22 +159,22 @@ module Writexlsx
 
       continuous = 'centerContinuous'
 
-      align << ['horizontal', 'left']        if @text_h_align == 1
-      align << ['horizontal', 'center']      if @text_h_align == 2
-      align << ['horizontal', 'right']       if @text_h_align == 3
-      align << ['horizontal', 'fill']        if @text_h_align == 4
-      align << ['horizontal', 'justify']     if @text_h_align == 5
+      align << %w[horizontal left]        if @text_h_align == 1
+      align << %w[horizontal center]      if @text_h_align == 2
+      align << %w[horizontal right]       if @text_h_align == 3
+      align << %w[horizontal fill]        if @text_h_align == 4
+      align << %w[horizontal justify]     if @text_h_align == 5
       align << ['horizontal', continuous]    if @text_h_align == 6
-      align << ['horizontal', 'distributed'] if @text_h_align == 7
+      align << %w[horizontal distributed] if @text_h_align == 7
 
       align << ['justifyLastLine', 1] if @just_distrib != 0
 
       # Property 'vertical' => 'bottom' is a default. It sets applyAlignment
       # without an alignment sub-element.
-      align << ['vertical', 'top']         if @text_v_align == 1
-      align << ['vertical', 'center']      if @text_v_align == 2
-      align << ['vertical', 'justify']     if @text_v_align == 4
-      align << ['vertical', 'distributed'] if @text_v_align == 5
+      align << %w[vertical top]         if @text_v_align == 1
+      align << %w[vertical center]      if @text_v_align == 2
+      align << %w[vertical justify]     if @text_v_align == 4
+      align << %w[vertical distributed] if @text_v_align == 5
 
       align << ['indent',       @indent]   if @indent   != 0
       align << ['textRotation', @rotation] if @rotation != 0
@@ -183,7 +185,7 @@ module Writexlsx
       align << ['readingOrder', 1] if @reading_order == 1
       align << ['readingOrder', 2] if @reading_order == 2
 
-      return changed, align
+      [changed, align]
     end
 
     #
@@ -307,7 +309,6 @@ module Writexlsx
     # to 8..63 to comply with Gnumeric. Colors 0..7 are repeated in 8..15.
     #
     def self.color(color_code)
-
       colors = Colors::COLORS
 
       # Return the default color if nil,
@@ -330,7 +331,7 @@ module Writexlsx
         return 0x00 if color_code > 63
 
         # or an integer in the valid range
-        return color_code
+        color_code
       end
     end
 
@@ -355,7 +356,7 @@ module Writexlsx
       set_text_h_align(7) if location == 'equal_space'        # S::PE.
       set_text_h_align(7) if location == 'justify_distributed'
 
-      @just_distrib =   1 if location == 'justify_distributed'
+      @just_distrib = 1 if location == 'justify_distributed'
 
       set_text_v_align(1) if location == 'top'
       set_text_v_align(2) if location == 'vcentre'
@@ -377,7 +378,7 @@ module Writexlsx
     #
     # Implements the Excel5 style "merge".
     #
-    def set_center_across(flag = 1)
+    def set_center_across(_flag = 1)
       set_text_h_align(6)
     end
 
@@ -386,7 +387,7 @@ module Writexlsx
     # called "center_across" and not "merge".
     # This is now deprecated. Use set_center_across() or better merge_range().
     #
-    def set_merge(merge = 1)
+    def set_merge(_merge = 1)
       set_text_h_align(6)
     end
 
@@ -475,15 +476,15 @@ module Writexlsx
       method =~ /set_(\w+)/ or raise "Unknown method: #{method}\n"
 
       # Match the attribute, i.e. "@xxx_yyy".
-      attribute = "@#{$1}"
+      attribute = "@#{::Regexp.last_match(1)}"
 
       # Check that the attribute exists
       # ........
-      if method =~ /set\w+color$/    # for "set_property_color" methods
-        value = color(args[0])
-      else                            # for "set_xxx" methods
-        value = args[0] || 1
-      end
+      value = if method =~ /set\w+color$/    # for "set_property_color" methods
+                color(args[0])
+              else                            # for "set_xxx" methods
+                args[0] || 1
+              end
 
       instance_variable_set(attribute, value)
     end
@@ -565,10 +566,10 @@ module Writexlsx
     end
 
     def [](attr)
-      self.instance_variable_get("@#{attr}")
+      instance_variable_get("@#{attr}")
     end
 
-    def write_font(writer, worksheet, dxf_format = nil) #:nodoc:
+    def write_font(writer, worksheet, dxf_format = nil) # :nodoc:
       writer.tag_elements('font') do
         # The condense and extend elements are mainly used in dxf formats.
         write_condense(writer) if ptrue?(@font_condense)
@@ -576,7 +577,7 @@ module Writexlsx
 
         write_font_shapes(writer)
 
-        writer.empty_tag('sz', [ ['val', size] ]) unless dxf_format
+        writer.empty_tag('sz', [['val', size]]) unless dxf_format
 
         if theme == -1
         # Ignore for excel2003_style
@@ -592,16 +593,16 @@ module Writexlsx
         end
 
         unless ptrue?(dxf_format)
-          writer.empty_tag('name', [ ['val', @font] ])
+          writer.empty_tag('name', [['val', @font]])
           write_font_family_scheme(writer)
         end
       end
     end
 
-    def write_font_rpr(writer, worksheet) #:nodoc:
+    def write_font_rpr(writer, worksheet) # :nodoc:
       writer.tag_elements('rPr') do
         write_font_shapes(writer)
-        writer.empty_tag('sz', [ ['val', size] ])
+        writer.empty_tag('sz', [['val', size]])
 
         if ptrue?(theme)
           write_color(writer, 'theme', theme)
@@ -612,7 +613,7 @@ module Writexlsx
           write_color(writer, 'theme', 1)
         end
 
-        writer.empty_tag('rFont', [ ['val', @font] ])
+        writer.empty_tag('rFont', [['val', @font]])
         write_font_family_scheme(writer)
       end
     end
@@ -635,10 +636,10 @@ module Writexlsx
     def xf_attributes
       attributes = [
         ['numFmtId', num_format_index],
-        ['fontId'  , font_index],
-        ['fillId'  , fill_index],
+        ['fontId', font_index],
+        ['fillId', fill_index],
         ['borderId', border_index],
-        ['xfId'    , xf_id]
+        ['xfId', xf_id]
       ]
       attributes << ['applyNumberFormat', 1] if num_format_index > 0
       # Add applyFont attribute if XF format uses a font element.
@@ -649,12 +650,10 @@ module Writexlsx
       attributes << ['applyBorder', 1] if border_index > 0
 
       # Check if XF format has alignment properties set.
-      apply_align, align = get_align_properties
+      apply_align, _align = get_align_properties
       # We can also have applyAlignment without a sub-element.
       attributes << ['applyAlignment', 1] if apply_align || ptrue?(@hyperlink)
-      if get_protection_properties || ptrue?(hyperlink)
-        attributes << ['applyProtection', 1]
-      end
+      attributes << ['applyProtection', 1] if get_protection_properties || ptrue?(hyperlink)
 
       attributes
     end
@@ -676,17 +675,11 @@ module Writexlsx
     end
 
     def write_font_family_scheme(writer)
-      if ptrue?(@font_family)
-        writer.empty_tag('family', [ ['val', @font_family] ])
-      end
+      writer.empty_tag('family', [['val', @font_family]]) if ptrue?(@font_family)
 
-      if ptrue?(@font_charset)
-        writer.empty_tag('charset', [ ['val', @font_charset] ])
-      end
+      writer.empty_tag('charset', [['val', @font_charset]]) if ptrue?(@font_charset)
 
-      if @font == 'Calibri' && !ptrue?(@hyperlink)
-        writer.empty_tag('scheme', [ ['val', @font_scheme] ])
-      end
+      writer.empty_tag('scheme', [['val', @font_scheme]]) if @font == 'Calibri' && !ptrue?(@hyperlink)
     end
 
     #
@@ -704,11 +697,11 @@ module Writexlsx
       # Handle the underline variants.
       case underline
       when 2
-        [ [val, 'double'] ]
+        [[val, 'double']]
       when 33
-        [ [val, 'singleAccounting'] ]
+        [[val, 'singleAccounting']]
       when 34
-        [ [val, 'doubleAccounting'] ]
+        [[val, 'doubleAccounting']]
       else
         []
       end
@@ -717,22 +710,22 @@ module Writexlsx
     #
     # Write the <vertAlign> font sub-element.
     #
-    def write_vert_align(writer, val) #:nodoc:
-      writer.empty_tag('vertAlign', [ ['val', val] ])
+    def write_vert_align(writer, val) # :nodoc:
+      writer.empty_tag('vertAlign', [['val', val]])
     end
 
     #
     # Write the <condense> element.
     #
     def write_condense(writer)
-      writer.empty_tag('condense', [ ['val', 0] ])
+      writer.empty_tag('condense', [['val', 0]])
     end
 
     #
     # Write the <extend> element.
     #
     def write_extend(writer)
-      writer.empty_tag('extend', [ ['val', 0] ])
+      writer.empty_tag('extend', [['val', 0]])
     end
   end
 end

data/lib/write_xlsx/formats.rb

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+
 require 'write_xlsx/package/xml_writer_simple'
 
 module Writexlsx

data/lib/write_xlsx/gradient.rb

@@ -25,9 +25,7 @@ module Writexlsx
 
         # Check the positions are in the correct range.
         args[:positions].each do |pos|
-          if pos < 0 || pos > 100
-            raise "Gradient position '#{pos} must be in range 0 <= pos <= 100"
-          end
+          raise "Gradient position '#{pos} must be in range 0 <= pos <= 100" if pos < 0 || pos > 100
         end
         gradient[:positions] = args[:positions]
       else
@@ -48,9 +46,8 @@ module Writexlsx
       if args[:angle]
         angle = args[:angle]
 
-        if angle < 0 || angle > 359.9
-          raise "Gradient angle '#{angle} must be in range 0 <= pos < 360"
-        end
+        raise "Gradient angle '#{angle} must be in range 0 <= pos < 360" if angle < 0 || angle > 359.9
+
         gradient[:angle] = angle
       else
         gradient[:angle] = 90
@@ -60,9 +57,8 @@ module Writexlsx
       if args[:type]
         type = args[:type]
 
-        unless types[type]
-          raise "Unknow gradient type '#{type}'"
-        end
+        raise "Unknow gradient type '#{type}'" unless types[type]
+
         gradient[:type] = types[type]
       else
         gradient[:type] = 'linear'

data/lib/write_xlsx/package/app.rb

@@ -1,11 +1,11 @@
 # -*- coding: utf-8 -*-
+
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
 
 module Writexlsx
   module Package
     class App
-
       include Writexlsx::Utility
       attr_writer :doc_security
 
@@ -45,7 +45,7 @@ module Writexlsx
         add_heading_pair(
           [
             'Worksheets',
-            @workbook.worksheets.reject {|s| s.is_chartsheet?}.count
+            @workbook.worksheets.reject { |s| s.is_chartsheet? }.count
           ]
         )
       end
@@ -55,15 +55,15 @@ module Writexlsx
       end
 
       def add_worksheet_part_names
-        @workbook.worksheets.
-          reject { |sheet| sheet.is_chartsheet? }.
-          each   { |sheet| add_part_name(sheet.name) }
+        @workbook.worksheets
+                 .reject { |sheet| sheet.is_chartsheet? }
+                 .each   { |sheet| add_part_name(sheet.name) }
       end
 
       def add_chartsheet_part_names
-        @workbook.worksheets.
-          select { |sheet| sheet.is_chartsheet? }.
-          each   { |sheet| add_part_name(sheet.name) }
+        @workbook.worksheets
+                 .select { |sheet| sheet.is_chartsheet? }
+                 .each   { |sheet| add_part_name(sheet.name) }
       end
 
       def add_part_name(part_name)
@@ -73,9 +73,7 @@ module Writexlsx
       def add_named_range_heading_pairs
         range_count = @workbook.named_ranges.size
 
-        if range_count != 0
-          add_heading_pair([ 'Named Ranges', range_count ])
-        end
+        add_heading_pair(['Named Ranges', range_count]) if range_count != 0
       end
 
       def add_named_ranges_parts
@@ -100,16 +98,14 @@ module Writexlsx
       #
       # Write the <Properties> element.
       #
-      def write_properties
-        tag = 'Properties'
-
-        schema   = 'http://schemas.openxmlformats.org/officeDocument/2006/'
+      def write_properties(&block)
+        schema = 'http://schemas.openxmlformats.org/officeDocument/2006/'
         attributes = [
           ['xmlns',     "#{schema}extended-properties"],
           ['xmlns:vt',  "#{schema}docPropsVTypes"]
         ]
 
-        @writer.tag_elements('Properties', attributes) { yield }
+        @writer.tag_elements('Properties', attributes, &block)
       end
 
       #

data/lib/write_xlsx/package/button.rb

@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
+
 require 'write_xlsx/utility'
 
 module Writexlsx
   module Package
-
     class Button
       include Writexlsx::Utility
 
@@ -61,7 +61,7 @@ module Writexlsx
       def write_rotation_lock
         attributes = [
           ['v:ext',    'edit'],
-          ['rotation', 't']
+          %w[rotation t]
         ]
         @writer.empty_tag('o:lock', attributes)
       end
@@ -85,7 +85,7 @@ module Writexlsx
       # Write the <x:ClientData> element.
       #
       def write_client_data
-        attributes = [ ['ObjectType', 'Button'] ]
+        attributes = [%w[ObjectType Button]]
 
         @writer.tag_elements('x:ClientData', attributes) do
           # Write the x:Anchor element.

data/lib/write_xlsx/package/comments.rb

@@ -1,11 +1,11 @@
 # -*- coding: utf-8 -*-
+
 require 'write_xlsx/format'
 require 'write_xlsx/package/xml_writer_simple'
 require 'write_xlsx/utility'
 
 module Writexlsx
   module Package
-
     class Comment
       include Writexlsx::Utility
 
@@ -21,9 +21,10 @@ module Writexlsx
         options ||= {}
         @workbook    = workbook
         @worksheet   = worksheet
-        @row, @col   = row, col
+        @row = row
+        @col = col
         options_parse(row, col, options)
-        @string      = string[0, STR_MAX]
+        @string = string[0, STR_MAX]
         @start_row   ||= default_start_row(row)
         @start_col   ||= default_start_col(col)
         @visible     = options[:visible]
@@ -31,8 +32,8 @@ module Writexlsx
         @y_offset    = options[:y_offset] || default_y_offset(row)
         @x_scale     = options[:x_scale]  || 1
         @y_scale     = options[:y_scale]  || 1
-        @width       = (0.5 + (options[:width]  || DEFAULT_WIDTH)  * @x_scale).to_i
-        @height      = (0.5 + (options[:height] || DEFAULT_HEIGHT) * @y_scale).to_i
+        @width       = (0.5 + ((options[:width]  || DEFAULT_WIDTH)  * @x_scale)).to_i
+        @height      = (0.5 + ((options[:height] || DEFAULT_HEIGHT) * @y_scale)).to_i
         @vertices    = @worksheet.position_object_pixels(
           @start_col, @start_row, @x_offset, @y_offset,
           @width, @height
@@ -56,9 +57,7 @@ module Writexlsx
       # from long format, ffcc00 to short format fc0 used by VML.
       def rgb_color(rgb)
         result = sprintf("%02x%02x%02x", *rgb)
-        if result =~ /^([0-9a-f])\1([0-9a-f])\2([0-9a-f])\3$/
-          result = "#{$1}#{$2}#{$3}"
-        end
+        result = "#{::Regexp.last_match(1)}#{::Regexp.last_match(2)}#{::Regexp.last_match(3)}" if result =~ /^([0-9a-f])\1([0-9a-f])\2([0-9a-f])\3$/
         result
       end
 
@@ -164,9 +163,9 @@ module Writexlsx
       #
       def write_shadow
         attributes = [
-          ['on',       't'],
-          ['color',    'black'],
-          ['obscured', 't']
+          %w[on t],
+          %w[color black],
+          %w[obscured t]
         ]
 
         @writer.empty_tag('v:shadow', attributes)
@@ -191,7 +190,7 @@ module Writexlsx
       #
       def write_client_data
         attributes = [
-          ['ObjectType', 'Note']
+          %w[ObjectType Note]
         ]
 
         @writer.tag_elements('x:ClientData', attributes) do
@@ -210,9 +209,7 @@ module Writexlsx
         end
       end
 
-      def writer=(w)
-        @writer = w
-      end
+      attr_writer :writer
 
       def font_name
         @font
@@ -227,7 +224,7 @@ module Writexlsx
         @start_row, @start_col = if @start_cell
                                    substitute_cellref(@start_cell)
                                  else
-                                   [ options[:start_row], options[:start_col] ]
+                                   [options[:start_row], options[:start_col]]
                                  end
         @visible     = options[:visible]
         @x_offset    = options[:x_offset]       || default_x_offset(col)
@@ -237,13 +234,12 @@ module Writexlsx
         @font        = options[:font]           || 'Tahoma'
         @font_size   = options[:font_size]      || 8
         @font_family = options[:font_family]    || 2
-        @width       = (0.5 + (options[:width]  || DEFAULT_WIDTH)  * @x_scale).to_i
-        @height      = (0.5 + (options[:height] || DEFAULT_HEIGHT) * @y_scale).to_i
+        @width       = (0.5 + ((options[:width]  || DEFAULT_WIDTH)  * @x_scale)).to_i
+        @height      = (0.5 + ((options[:height] || DEFAULT_HEIGHT) * @y_scale)).to_i
       end
     end
 
     class Comments
-
       include Writexlsx::Utility
 
       def initialize(worksheet)
@@ -312,7 +308,6 @@ module Writexlsx
 
       private
 
-
       def comments_visible?
         @worksheet.comments_visible?
       end
@@ -320,10 +315,10 @@ module Writexlsx
       #
       # Write the <comments> element.
       #
-      def write_comments
-        attributes = [ ['xmlns', XMLWriterSimple::XMLNS] ]
+      def write_comments(&block)
+        attributes = [['xmlns', XMLWriterSimple::XMLNS]]
 
-        @writer.tag_elements('comments', attributes) { yield }
+        @writer.tag_elements('comments', attributes, &block)
       end
 
       #
@@ -335,14 +330,14 @@ module Writexlsx
         @writer.tag_elements('authors') do
           comment_data.each do |comment|
             author = comment.author || ''
-            if author && !@author_ids[author]
-              # Store the author id.
-              @author_ids[author] = author_count
-              author_count += 1
+            next unless author && !@author_ids[author]
 
-              # Write the author element.
-              write_author(author)
-            end
+            # Store the author id.
+            @author_ids[author] = author_count
+            author_count += 1
+
+            # Write the author element.
+            write_author(author)
           end
         end
       end
@@ -367,8 +362,8 @@ module Writexlsx
       # Write the <comment> element.
       #
       def write_comment(comment)
-        ref       = xl_rowcol_to_cell( comment.row, comment.col )
-        attributes = [ ['ref', ref] ]
+        ref = xl_rowcol_to_cell(comment.row, comment.col)
+        attributes = [['ref', ref]]
 
         author_id = (@author_ids[comment.author] if comment.author) || 0
         attributes << ['authorId', author_id]
@@ -432,7 +427,7 @@ module Writexlsx
       # Write the <sz> element.
       #
       def write_sz(val)
-        attributes = [ ['val', val] ]
+        attributes = [['val', val]]
 
         @writer.empty_tag('sz', attributes)
       end
@@ -441,14 +436,14 @@ module Writexlsx
       # Write the <color> element.
       #
       def write_color
-        @writer.empty_tag('color', [ ['indexed', 81] ])
+        @writer.empty_tag('color', [['indexed', 81]])
       end
 
       #
       # Write the <rFont> element.
       #
       def write_r_font(val)
-        attributes = [ ['val', val] ]
+        attributes = [['val', val]]
 
         @writer.empty_tag('rFont', attributes)
       end
@@ -457,7 +452,7 @@ module Writexlsx
       # Write the <family> element.
       #
       def write_family(val)
-        attributes = [ ['val', val] ]
+        attributes = [['val', val]]
 
         @writer.empty_tag('family', attributes)
       end