write_xlsx 0.81.1 → 0.83.0

data/lib/write_xlsx/package/packager.rb

@@ -136,37 +136,25 @@ def write_shared_strings_file
       # Write the app.xml file.
       #
       def write_app_file
-        dir        = @package_dir
-        properties = @workbook.doc_properties
-        app        = Package::App.new
-
-        FileUtils.mkdir_p("#{@package_dir}/docProps")
+        app = Package::App.new(@workbook)
 
         # Add the Worksheet heading pairs.
-        app.add_heading_pair(['Worksheets', @workbook.worksheets.reject {|s| s.is_chartsheet?}.count])
-
+        app.add_worksheet_heading_pairs
         # Add the Chartsheet heading pairs.
-        app.add_heading_pair(['Charts', @workbook.chartsheet_count])
+        app.add_chartsheet_heading_pairs
 
         # Add the Worksheet parts.
-        @workbook.worksheets.reject { |sheet| sheet.is_chartsheet? }.
-          each { |sheet| app.add_part_name(sheet.name) }
-
+        app.add_worksheet_part_names
         # Add the Chartsheet parts.
-        @workbook.worksheets.select { |sheet| sheet.is_chartsheet? }.
-          each { |sheet| app.add_part_name(sheet.name) }
-
+        app.add_chartsheet_part_names
         # Add the Named Range heading pairs.
-        range_count = @workbook.named_ranges.size
-        if range_count != 0
-          app.add_heading_pair([ 'Named Ranges', range_count ])
-        end
-
+        app.add_named_range_heading_pairs
         # Add the Named Ranges parts.
-        @workbook.named_ranges.each { |named_range| app.add_part_name(named_range) }
+        app.add_named_ranges_parts
 
-        app.set_properties(properties)
+        app.set_properties(@workbook.doc_properties)
 
+        FileUtils.mkdir_p("#{@package_dir}/docProps")
         app.set_xml_writer("#{@package_dir}/docProps/app.xml")
         app.assemble_xml_file
       end
@@ -188,30 +176,18 @@ def write_core_file
       # Write the ContentTypes.xml file.
       #
       def write_content_types_file
-        content = Package::ContentTypes.new
-
-        content.add_image_types(@workbook.image_types)
-        @workbook.worksheets.reject { |sheet| sheet.is_chartsheet? }.
-          each_with_index do |sheet, index|
-          content.add_worksheet_name("sheet#{index+1}")
-        end
-        @workbook.worksheets.select { |sheet| sheet.is_chartsheet? }.
-          each_with_index do |sheet, index|
-          content.add_chartsheet_name("sheet#{index+1}")
-        end
-
-        (1 .. @workbook.charts.size).each { |i| content.add_chart_name("chart#{i}") }
-        (1 .. @workbook.drawings.size).each { |i| content.add_drawing_name("drawing#{i}") }
+        content = Package::ContentTypes.new(@workbook)
 
+        content.add_image_types
+        content.add_worksheet_names
+        content.add_chartsheet_names
+        content.add_chart_names
+        content.add_drawing_names
         content.add_vml_name if @workbook.num_vml_files > 0
-
-        (1 .. @table_count).each { |i| content.add_table_name("table#{i}") }
-
-        (1 .. @workbook.num_comment_files).each { |i| content.add_comment_name("comments#{i}") }
-
+        content.add_table_names(@table_count)
+        content.add_comment_names
         # Add the sharedString rel if there is string data in the workbook.
         content.add_shared_strings unless @workbook.shared_strings_empty?
-
         # Add vbaProject if present.
         content.add_vba_project if @workbook.vba_project
 

data/lib/write_xlsx/package/styles.rb

@@ -26,18 +26,7 @@ def set_xml_writer(filename)
 
       def assemble_xml_file
         write_xml_declaration do
-          write_style_sheet do
-            write_num_fmts
-            write_fonts
-            write_fills
-            write_borders
-            write_cell_style_xfs
-            write_cell_xfs
-            write_cell_styles
-            write_dxfs
-            write_table_styles
-            write_colors
-          end
+          write_style_sheet { write_style_sheet_base }
         end
       end
 
@@ -71,9 +60,7 @@ def palette_color(index)
       # Write the <styleSheet> element.
       #
       def write_style_sheet
-        xmlns = 'http://schemas.openxmlformats.org/spreadsheetml/2006/main'
-
-        attributes = [ ['xmlns', xmlns] ]
+        attributes = [ ['xmlns', XMLWriterSimple::XMLNS] ]
 
         @writer.tag_elements('styleSheet', attributes) { yield }
       end
@@ -98,57 +85,51 @@ def write_num_fmts
         end
       end
 
+      FORMAT_CODES = {
+        0  => 'General',
+        1  => '0',
+        2  => '0.00',
+        3  => '#,##0',
+        4  => '#,##0.00',
+        5  => '($#,##0_);($#,##0)',
+        6  => '($#,##0_);[Red]($#,##0)',
+        7  => '($#,##0.00_);($#,##0.00)',
+        8  => '($#,##0.00_);[Red]($#,##0.00)',
+        9  => '0%',
+        10 => '0.00%',
+        11 => '0.00E+00',
+        12 => '# ?/?',
+        13 => '# ??/??',
+        14 => 'm/d/yy',
+        15 => 'd-mmm-yy',
+        16 => 'd-mmm',
+        17 => 'mmm-yy',
+        18 => 'h:mm AM/PM',
+        19 => 'h:mm:ss AM/PM',
+        20 => 'h:mm',
+        21 => 'h:mm:ss',
+        22 => 'm/d/yy h:mm',
+        37 => '(#,##0_);(#,##0)',
+        38 => '(#,##0_);[Red](#,##0)',
+        39 => '(#,##0.00_);(#,##0.00)',
+        40 => '(#,##0.00_);[Red](#,##0.00)',
+        41 => '_(* #,##0_);_(* (#,##0);_(* "-"_);_(@_)',
+        42 => '_($* #,##0_);_($* (#,##0);_($* "-"_);_(@_)',
+        43 => '_(* #,##0.00_);_(* (#,##0.00);_(* "-"??_);_(@_)',
+        44 => '_($* #,##0.00_);_($* (#,##0.00);_($* "-"??_);_(@_)',
+        45 => 'mm:ss',
+        46 => '[h]:mm:ss',
+        47 => 'mm:ss.0',
+        48 => '##0.0E+0',
+        49 => '@'
+      }
+
       #
       # Write the <numFmt> element.
       #
       def write_num_fmt(num_fmt_id, format_code)
-        format_codes = {
-          0  => 'General',
-          1  => '0',
-          2  => '0.00',
-          3  => '#,##0',
-          4  => '#,##0.00',
-          5  => '($#,##0_);($#,##0)',
-          6  => '($#,##0_);[Red]($#,##0)',
-          7  => '($#,##0.00_);($#,##0.00)',
-          8  => '($#,##0.00_);[Red]($#,##0.00)',
-          9  => '0%',
-          10 => '0.00%',
-          11 => '0.00E+00',
-          12 => '# ?/?',
-          13 => '# ??/??',
-          14 => 'm/d/yy',
-          15 => 'd-mmm-yy',
-          16 => 'd-mmm',
-          17 => 'mmm-yy',
-          18 => 'h:mm AM/PM',
-          19 => 'h:mm:ss AM/PM',
-          20 => 'h:mm',
-          21 => 'h:mm:ss',
-          22 => 'm/d/yy h:mm',
-          37 => '(#,##0_);(#,##0)',
-          38 => '(#,##0_);[Red](#,##0)',
-          39 => '(#,##0.00_);(#,##0.00)',
-          40 => '(#,##0.00_);[Red](#,##0.00)',
-          41 => '_(* #,##0_);_(* (#,##0);_(* "-"_);_(@_)',
-          42 => '_($* #,##0_);_($* (#,##0);_($* "-"_);_(@_)',
-          43 => '_(* #,##0.00_);_(* (#,##0.00);_(* "-"??_);_(@_)',
-          44 => '_($* #,##0.00_);_($* (#,##0.00);_($* "-"??_);_(@_)',
-          45 => 'mm:ss',
-          46 => '[h]:mm:ss',
-          47 => 'mm:ss.0',
-          48 => '##0.0E+0',
-          49 => '@'
-        }
-
         # Set the format code for built-in number formats.
-        if num_fmt_id < 164
-          if format_codes[num_fmt_id]
-            format_code = format_codes[num_fmt_id]
-          else
-            format_code = 'General'
-          end
-        end
+        format_code = FORMAT_CODES[num_fmt_id] || 'General' if num_fmt_id < 164
 
         attributes = [
           ['numFmtId',   num_fmt_id],
@@ -163,9 +144,13 @@ def write_num_fmt(num_fmt_id, format_code)
       #
       def write_fonts
         write_format_elements('fonts', @font_count) do
-          @xf_formats.each do |format|
-            format.write_font(@writer, self) if format.has_font?
-          end
+          write_font_base
+        end
+      end
+
+      def write_font_base
+        @xf_formats.each do |format|
+          format.write_font(@writer, self) if format.has_font?
         end
       end
 
@@ -182,19 +167,21 @@ def write_color(name, value)
       # Write the <fills> element.
       #
       def write_fills
-        count = @fill_count
-
-        attributes = [ ['count', count] ]
+        attributes = [ ['count', @fill_count] ]
 
         @writer.tag_elements('fills', attributes) do
-          # Write the default fill element.
-          write_default_fill('none')
-          write_default_fill('gray125')
+          write_fills_base
+        end
+      end
 
-          # Write the fill elements for format objects that have them.
-          @xf_formats.each do |format|
-            write_fill(format) if format.has_fill?
-          end
+      def write_fills_base
+        # Write the default fill element.
+        write_default_fill('none')
+        write_default_fill('gray125')
+
+        # Write the fill elements for format objects that have them.
+        @xf_formats.each do |format|
+          write_fill(format) if format.has_fill?
         end
       end
 
@@ -207,11 +194,65 @@ def write_default_fill(pattern_type)
         end
       end
 
+      PATTERNS = %w(
+        none
+        solid
+        mediumGray
+        darkGray
+        lightGray
+        darkHorizontal
+        darkVertical
+        darkDown
+        darkUp
+        darkGrid
+        darkTrellis
+        lightHorizontal
+        lightVertical
+        lightDown
+        lightUp
+        lightGrid
+        lightTrellis
+        gray125
+        gray0625
+      )
+
       #
       # Write the <fill> element.
       #
       def write_fill(format, dxf_format = nil)
-        pattern    = format.pattern
+        @writer.tag_elements('fill' ) do
+          write_fill_base(format, dxf_format)
+        end
+      end
+
+      def write_fill_base(format, dxf_format)
+        # The "none" pattern is handled differently for dxf formats.
+        if dxf_format && format.pattern <= 1
+          attributes = []
+        else
+          attributes = [ ['patternType', PATTERNS[format.pattern]] ]
+        end
+
+        @writer.tag_elements('patternFill', attributes) do
+          write_pattern_fill(format, dxf_format)
+        end
+      end
+
+      def write_pattern_fill(format, dxf_format)
+        bg_color, fg_color = bg_and_fg_color(format, dxf_format)
+
+        if fg_color && fg_color != 0
+          @writer.empty_tag('fgColor', [ ['rgb', palette_color(fg_color)] ])
+        end
+
+        if bg_color && bg_color != 0
+          @writer.empty_tag('bgColor', [ ['rgb', palette_color(bg_color)] ])
+        else
+          @writer.empty_tag('bgColor', [ ['indexed', 64] ]) if !dxf_format
+        end
+      end
+
+      def bg_and_fg_color(format, dxf_format)
         bg_color   = format.bg_color
         fg_color   = format.fg_color
 
@@ -222,50 +263,7 @@ def write_fill(format, dxf_format = nil)
           fg_color = format.dxf_fg_color
         end
 
-        patterns = %w(
-          none
-          solid
-          mediumGray
-          darkGray
-          lightGray
-          darkHorizontal
-          darkVertical
-          darkDown
-          darkUp
-          darkGrid
-          darkTrellis
-          lightHorizontal
-          lightVertical
-          lightDown
-          lightUp
-          lightGrid
-          lightTrellis
-          gray125
-          gray0625
-        )
-
-        @writer.tag_elements('fill' ) do
-          # The "none" pattern is handled differently for dxf formats.
-          if dxf_format && format.pattern <= 1
-            attributes = []
-          else
-            attributes = [ ['patternType', patterns[format.pattern]] ]
-          end
-
-          @writer.tag_elements('patternFill', attributes) do
-            if fg_color && fg_color != 0
-              fg_color = palette_color(fg_color)
-              @writer.empty_tag('fgColor', [ ['rgb', fg_color] ])
-            end
-
-            if bg_color && bg_color != 0
-              bg_color = palette_color(bg_color)
-              @writer.empty_tag('bgColor', [ ['rgb', bg_color] ])
-            else
-              @writer.empty_tag('bgColor', [ ['indexed', 64] ]) if !dxf_format
-            end
-          end
-        end
+        [bg_color, fg_color]
       end
 
       #
@@ -273,9 +271,13 @@ def write_fill(format, dxf_format = nil)
       #
       def write_borders
         write_format_elements('borders', @border_count) do
-          @xf_formats.each do |format|
-            write_border(format) if format.has_border?
-          end
+          write_borders_base
+        end
+      end
+
+      def write_borders_base
+        @xf_formats.each do |format|
+          write_border(format) if format.has_border?
         end
       end
 
@@ -292,41 +294,52 @@ def write_format_elements(elements, count)
       # Write the <border> element.
       #
       def write_border(format, dxf_format = nil)
-        attributes = []
-
-        # Diagonal borders add attributes to the <border> element.
-        if format.diag_type == 1
-          attributes << ['diagonalUp',   1]
-        elsif format.diag_type == 2
-          attributes << ['diagonalDown', 1]
-        elsif format.diag_type == 3
-          attributes << ['diagonalUp',   1]
-          attributes << ['diagonalDown', 1]
+        # Write the start border tag.
+        @writer.tag_elements('border', format.border_attributes) do
+          write_border_base(format, dxf_format)
         end
+      end
 
-        # Ensure that a default diag border is set if the diag type is set.
-        format.diag_border = 1 if format.diag_type != 0 && format.diag_border == 0
+      def write_border_base(format, dxf_format)
+        # Write the <border> sub elements.
+        write_border_sub_elements(format)
 
-        # Write the start border tag.
-        @writer.tag_elements('border', attributes) do
-          # Write the <border> sub elements.
-          write_sub_border('left',   format.left,   format.left_color)
-          write_sub_border('right',  format.right,  format.right_color)
-          write_sub_border('top',    format.top,    format.top_color)
-          write_sub_border('bottom', format.bottom, format.bottom_color)
-
-          # Condition DXF formats don't allow diagonal borders
-          if !dxf_format
-            write_sub_border('diagonal', format.diag_border, format.diag_color)
-          end
+        # Condition DXF formats don't allow diagonal borders
+        if dxf_format
+          write_sub_border('vertical')
+          write_sub_border('horizontal')
+        else
+          # Ensure that a default diag border is set if the diag type is set.
+          format.diag_border = 1 if format.diag_type != 0 && format.diag_border == 0
 
-          if dxf_format
-            write_sub_border('vertical')
-            write_sub_border('horizontal')
-          end
+          write_sub_border('diagonal', format.diag_border, format.diag_color)
         end
       end
 
+      def write_border_sub_elements(format)
+        write_sub_border('left',   format.left,   format.left_color)
+        write_sub_border('right',  format.right,  format.right_color)
+        write_sub_border('top',    format.top,    format.top_color)
+        write_sub_border('bottom', format.bottom, format.bottom_color)
+      end
+
+      BORDER_STYLES = %w(
+        none
+        thin
+        medium
+        dashed
+        dotted
+        thick
+        double
+        hair
+        mediumDashed
+        dashDot
+        mediumDashDot
+        dashDotDot
+        mediumDashDotDot
+        slantDashDot
+      )
+
       #
       # Write the <border> sub elements such as <right>, <top>, etc.
       #
@@ -336,24 +349,7 @@ def write_sub_border(type, style = 0, color = nil)
           return
         end
 
-        border_styles = %w(
-          none
-          thin
-          medium
-          dashed
-          dotted
-          thick
-          double
-          hair
-          mediumDashed
-          dashDot
-          mediumDashDot
-          dashDotDot
-          mediumDashDotDot
-          slantDashDot
-        )
-
-        attributes = [ [:style, border_styles[style]] ]
+        attributes = [ [:style, BORDER_STYLES[style]] ]
 
         @writer.tag_elements(type, attributes) do
           if color != 0
@@ -401,16 +397,11 @@ def write_cell_xfs
       # Write the style <xf> element.
       #
       def write_style_xf
-        num_fmt_id = 0
-        font_id    = 0
-        fill_id    = 0
-        border_id  = 0
-
         attributes = [
-          ['numFmtId', num_fmt_id],
-          ['fontId',   font_id],
-          ['fillId',   fill_id],
-          ['borderId', border_id]
+          ['numFmtId', 0],
+          ['fontId',   0],
+          ['fillId',   0],
+          ['borderId', 0]
         ]
 
         @writer.empty_tag('xf', attributes)
@@ -418,57 +409,40 @@ def write_style_xf
 
       private
 
+      def write_style_sheet_base
+        write_num_fmts
+        write_fonts
+        write_fills
+        write_borders
+        write_cell_style_xfs
+        write_cell_xfs
+        write_cell_styles
+        write_dxfs
+        write_table_styles
+        write_colors
+      end
+
       #
       # Write the <xf> element.
       #
       def write_xf(format)
-        has_align   = false
-        has_protect = false
-
-        attributes = [
-            ['numFmtId', format.num_format_index],
-            ['fontId'  , format.font_index],
-            ['fillId'  , format.fill_index],
-            ['borderId', format.border_index],
-            ['xfId'    , 0]
-        ]
-
-        attributes << ['applyNumberFormat', 1] if format.num_format_index > 0
-
-        # Add applyFont attribute if XF format uses a font element.
-        attributes << ['applyFont', 1] if format.font_index > 0
-
-        # Add applyFill attribute if XF format uses a fill element.
-        attributes << ['applyFill', 1] if format.fill_index > 0
-
-        # Add applyBorder attribute if XF format uses a border element.
-        attributes << ['applyBorder', 1] if format.border_index > 0
-
         # Check if XF format has alignment properties set.
         apply_align, align = format.get_align_properties
 
-        # Check if an alignment sub-element should be written.
-        has_align = true if apply_align && !align.empty?
-
-        # We can also have applyAlignment without a sub-element.
-        attributes << ['applyAlignment', 1] if apply_align
-
         # Check for cell protection properties.
         protection = format.get_protection_properties
 
-        if protection
-          attributes << ['applyProtection', 1]
-          has_protect = true
-        end
+        # Check if an alignment sub-element should be written.
+        has_align = apply_align && !align.empty?
 
         # Write XF with sub-elements if required.
-        if has_align || has_protect
-          @writer.tag_elements('xf', attributes) do
+        if has_align || protection
+          @writer.tag_elements('xf', format.xf_attributes) do
             @writer.empty_tag('alignment',  align)      if has_align
-            @writer.empty_tag('protection', protection) if has_protect
+            @writer.empty_tag('protection', protection) if protection
           end
         else
-          @writer.empty_tag('xf', attributes)
+          @writer.empty_tag('xf', format.xf_attributes)
         end
       end
 
@@ -488,14 +462,10 @@ def write_cell_styles
       # Write the <cellStyle> element.
       #
       def write_cell_style
-        name       = 'Normal'
-        xf_id      = 0
-        builtin_id = 0
-
         attributes = [
-            ['name',      name],
-            ['xfId',      xf_id],
-            ['builtinId', builtin_id]
+            ['name',      'Normal'],
+            ['xfId',      0],
+            ['builtinId', 0]
         ]
 
         @writer.empty_tag('cellStyle', attributes)
@@ -505,30 +475,30 @@ def write_cell_style
       # Write the <dxfs> element.
       #
       def write_dxfs
-        formats = @dxf_formats
-
-        count = formats.size
+        attributes = [ ['count', @dxf_formats.count] ]
 
-        attributes = [ ['count', count] ]
-
-        if !formats.empty?
+        if @dxf_formats.empty?
+          @writer.empty_tag('dxfs', attributes)
+        else
           @writer.tag_elements('dxfs', attributes) do
             # Write the font elements for format objects that have them.
             @dxf_formats.each do |format|
-              @writer.tag_elements('dxf') do
-                format.write_font(@writer, self, 1) if format.has_dxf_font?
+              write_dxf(format)
+            end
+          end
+        end
+      end
 
-                if format.num_format_index != 0
-                  write_num_fmt(format.num_format_index, format.num_format)
-                end
+      def write_dxf(format)
+        @writer.tag_elements('dxf') do
+          format.write_font(@writer, self, 1) if format.has_dxf_font?
 
-                write_fill(format, 1)    if format.has_dxf_fill?
-                write_border(format, 1)  if format.has_dxf_border?
-              end
-            end
+          if format.num_format_index != 0
+            write_num_fmt(format.num_format_index, format.num_format)
           end
-        else
-          @writer.empty_tag('dxfs', attributes)
+
+          write_fill(format, 1)    if format.has_dxf_fill?
+          write_border(format, 1)  if format.has_dxf_border?
         end
       end
 
@@ -536,14 +506,10 @@ def write_dxfs
       # Write the <tableStyles> element.
       #
       def write_table_styles
-        count               = 0
-        default_table_style = 'TableStyleMedium9'
-        default_pivot_style = 'PivotStyleLight16'
-
         attributes = [
-            ['count',             count],
-            ['defaultTableStyle', default_table_style],
-            ['defaultPivotStyle', default_pivot_style]
+            ['count',             0],
+            ['defaultTableStyle', 'TableStyleMedium9'],
+            ['defaultPivotStyle', 'PivotStyleLight16']
         ]
 
         @writer.empty_tag('tableStyles', attributes)
@@ -553,8 +519,6 @@ def write_table_styles
       # Write the <colors> element.
       #
       def write_colors
-        custom_colors = @custom_colors
-
         return if @custom_colors.empty?
 
         @writer.tag_elements( 'colors' ) do
@@ -565,16 +529,15 @@ def write_colors
       #
       # Write the <mruColors> element for the most recently used colours.
       #
-      def write_mru_colors(*args)
-        custom_colors = args
-
+      def write_mru_colors(custom_colors)
         # Limit the mruColors to the last 10.
         count = custom_colors.size
+        # array[-10, 10] returns array which contains last 10 items.
         custom_colors = custom_colors[-10, 10] if count > 10
 
         @writer.tag_elements('mruColors') do
           # Write the custom colors in reverse order.
-          @custom_colors.reverse.each do |color|
+          custom_colors.reverse.each do |color|
             write_color('rgb', color)
           end
         end
@@ -584,9 +547,7 @@ def write_mru_colors(*args)
       # Write the <condense> element.
       #
       def write_condense
-        val  = 0
-
-        attributes = [ ['val', val] ]
+        attributes = [ ['val', 0] ]
 
         @writer.empty_tag('condense', attributes)
       end
@@ -595,9 +556,7 @@ def write_condense
       # Write the <extend> element.
       #
       def write_extend
-        val  = 0
-
-        attributes = [ ['val', val] ]
+        attributes = [ ['val', 0] ]
 
         @writer.empty_tag('extend', attributes)
       end