write_xlsx 0.0.3 → 0.0.4

data/lib/write_xlsx/package/app.rb

@@ -109,24 +109,19 @@ def write_scale_crop
       # Write the <HeadingPairs> element.
       #
       def write_heading_pairs
-          @writer.start_tag('HeadingPairs')
-
+        @writer.tag_elements('HeadingPairs') do
           write_vt_vector('variant', @heading_pairs)
-
-          @writer.end_tag('HeadingPairs')
+        end
       end
 
       #
       # Write the <TitlesOfParts> element.
       #
       def write_titles_of_parts
-        @writer.start_tag('TitlesOfParts')
-        parts_data = []
-        @part_names.each { |part_name| parts_data.push(['lpstr', part_name]) }
-
-        write_vt_vector('lpstr', parts_data)
-
-        @writer.end_tag('TitlesOfParts')
+        @writer.tag_elements('TitlesOfParts') do
+          parts_data = @part_names.collect { |part_name| ['lpstr', part_name] }
+          write_vt_vector('lpstr', parts_data)
+        end
       end
 
       #
@@ -140,15 +135,15 @@ def write_vt_vector(base_type, data)
           'baseType', base_type
         ]
 
-        @writer.start_tag('vt:vector', attributes)
-
-        data.each do |a|
-          @writer.start_tag('vt:variant') if base_type == 'variant'
-          write_vt_data(*a)
-          @writer.end_tag('vt:variant')   if base_type == 'variant'
+        @writer.tag_elements('vt:vector', attributes) do
+          data.each do |a|
+            if base_type == 'variant'
+              @writer.tag_elements('vt:variant') { write_vt_data(*a) }
+            else
+              write_vt_data(*a)
+            end
+          end
         end
-
-        @writer.end_tag('vt:vector')
       end
 
       #

data/lib/write_xlsx/package/comments.rb

@@ -211,20 +211,19 @@ def write_comments
       def write_authors(comment_data)
         author_count = 0
 
-        @writer.start_tag('authors')
-        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
-
-            # Write the author element.
-            write_author(author)
+        @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
+
+              # Write the author element.
+              write_author(author)
+            end
           end
         end
-
-        @writer.end_tag('authors')
       end
 
       #
@@ -238,9 +237,9 @@ def write_author(data)
       # Write the <commentList> element.
       #
       def write_comment_list(comment_data)
-        @writer.start_tag('commentList')
-        comment_data.each { |comment| write_comment(comment) }
-        @writer.end_tag( 'commentList' )
+        @writer.tag_elements('commentList') do
+          comment_data.each { |comment| write_comment(comment) }
+        end
       end
 
       #
@@ -253,36 +252,31 @@ def write_comment(comment)
         author_id = (@author_ids[comment.author] if comment.author) || 0
         attributes << 'authorId' << author_id
 
-        @writer.start_tag('comment', attributes)
-        write_text(comment.string)
-        @writer.end_tag('comment')
+        @writer.tag_elements('comment', attributes) do
+          write_text(comment.string)
+        end
       end
 
       #
       # Write the <text> element.
       #
       def write_text(text)
-        @writer.start_tag('text')
-
-        # Write the text r element.
-        write_text_r(text)
-
-        @writer.end_tag('text')
+        @writer.tag_elements('text') do
+          # Write the text r element.
+          write_text_r(text)
+        end
       end
 
       #
       # Write the <r> element.
       #
       def write_text_r(text)
-        @writer.start_tag('r')
-
-        # Write the rPr element.
-        write_r_pr
-
-        # Write the text r element.
-        write_text_t(text)
-
-        @writer.end_tag('r')
+        @writer.tag_elements('r') do
+          # Write the rPr element.
+          write_r_pr
+          # Write the text r element.
+          write_text_t(text)
+        end
       end
 
       #
@@ -300,21 +294,16 @@ def write_text_t(text)
       # Write the <rPr> element.
       #
       def write_r_pr
-        @writer.start_tag('rPr')
-
-        # Write the sz element.
-        write_sz
-
-        # Write the color element.
-        write_color
-
-        # Write the rFont element.
-        write_r_font
-
-        # Write the family element.
-        write_family
-
-        @writer.end_tag('rPr')
+        @writer.tag_elements('rPr') do
+          # Write the sz element.
+          write_sz
+          # Write the color element.
+          write_color
+          # Write the rFont element.
+          write_r_font
+          # Write the family element.
+          write_family
+        end
       end
 
       #

data/lib/write_xlsx/package/core.rb

@@ -84,18 +84,14 @@ def write_cp_core_properties
       # Write the <dc:creator> element.
       #
       def write_dc_creator
-        data = @properties[:author] || ''
-
-        @writer.data_element('dc:creator', data)
+        write_base(:author, 'dc:creator', '')
       end
 
       #
       # Write the <cp:lastModifiedBy> element.
       #
       def write_cp_last_modified_by
-        data = @properties[:author] || ''
-
-        @writer.data_element('cp:lastModifiedBy', data)
+        write_base(:author, 'cp:lastModifiedBy', '')
       end
 
       #
@@ -130,66 +126,48 @@ def write_dcterms_modified
       # Write the <dc:title> element.
       #
       def write_dc_title
-        data = @properties[:title]
-
-        return unless data
-
-        @writer.data_element('dc:title', data)
+        write_base(:title, 'dc:title')
       end
 
       #
       # Write the <dc:subject> element.
       #
       def write_dc_subject
-        data = @properties[:subject]
-
-        return unless data
-
-        @writer.data_element('dc:subject', data)
+        write_base(:subject, 'dc:subject')
       end
 
       #
       # Write the <cp:keywords> element.
       #
       def write_cp_keywords
-        data = @properties[:keywords]
-
-        return unless data
-
-        @writer.data_element('cp:keywords', data)
+        write_base(:keywords, 'cp:keywords')
       end
 
       #
       # Write the <dc:description> element.
       #
       def write_dc_description
-        data = @properties[:comments]
-
-        return unless data
-
-        @writer.data_element('dc:description', data)
+        write_base(:comments, 'dc:description')
       end
 
       #
       # Write the <cp:category> element.
       #
       def write_cp_category
-        data = @properties[:category]
-
-        return unless data
-
-        @writer.data_element('cp:category', data)
+        write_base(:category, 'cp:category')
       end
 
       #
       # Write the <cp:contentStatus> element.
       #
       def write_cp_content_status
-        data = @properties[:status]
+        write_base(:status, 'cp:contentStatus')
+      end
 
+      def write_base(key, tag, default = nil)
+        data = @properties[key] || default
         return unless data
-
-        @writer.data_element('cp:contentStatus', data)
+        @writer.data_element(tag, data)
       end
     end
   end

data/lib/write_xlsx/package/packager.rb

@@ -120,31 +120,26 @@ def write_chartsheet_files
       # Write the chart files.
       #
       def write_chart_files
-        return if @workbook.charts.empty?
-
-        FileUtils.mkdir_p("#{@package_dir}/xl/charts")
-
-        index = 1
-        @workbook.charts.each do |chart|
-          chart.set_xml_writer("#{@package_dir}/xl/charts/chart#{index}.xml")
-          index += 1
-          chart.assemble_xml_file
-        end
+        write_chart_or_drawing_files(@workbook.charts, 'chart')
       end
 
       #
       # Write the drawing files.
       #
       def write_drawing_files
-        return if @workbook.drawings.empty?
+        write_chart_or_drawing_files(@workbook.drawings, 'drawing')
+      end
+
+      def write_chart_or_drawing_files(objects, filename)
+        return if objects.empty?
 
-        FileUtils.mkdir_p("#{@package_dir}/xl/drawings")
+        FileUtils.mkdir_p("#{@package_dir}/xl/#{filename}s")
 
         index = 1
-        @workbook.drawings.each do |drawing|
-          drawing.set_xml_writer("#{@package_dir}/xl/drawings/drawing#{index}.xml")
+        objects.each do |object|
+          object.set_xml_writer("#{@package_dir}/xl/#{filename}s/#{filename}#{index}.xml")
           index += 1
-          drawing.assemble_xml_file
+          object.assemble_xml_file
         end
       end
 

data/lib/write_xlsx/package/relationships.rb

@@ -71,11 +71,9 @@ def write_xml_declaration
       def write_relationships
         attributes = ['xmlns', Package_schema]
 
-        @writer.start_tag('Relationships', attributes)
-
-        @rels.each { |rel| write_relationship(*rel) }
-
-        @writer.end_tag('Relationships')
+        @writer.tag_elements('Relationships', attributes) do
+          @rels.each { |rel| write_relationship(*rel) }
+        end
       end
 
       #

data/lib/write_xlsx/package/shared_strings.rb

@@ -93,16 +93,14 @@ def write_si(string)
 
         attributes << 'xml:space' << 'preserve' if string =~ /^[ \t]/ || string =~ /[ \t]$/
 
-        @writer.start_tag('si')
-
-        # Write any rich strings without further tags.
-        if string =~ %r{^<r>} && string =~ %r{</r>$}
-          @writer.io_write(string)
-        else
-          @writer.data_element('t', string, attributes)
+        @writer.tag_elements('si') do
+          # Write any rich strings without further tags.
+          if string =~ %r{^<r>} && string =~ %r{</r>$}
+            @writer.io_write(string)
+          else
+            @writer.data_element('t', string, attributes)
+          end
         end
-
-        @writer.end_tag('si')
       end
 
       def total_count

data/lib/write_xlsx/package/styles.rb

@@ -96,16 +96,14 @@ def write_num_fmts
 
         attributes = ['count', count]
 
-        @writer.start_tag('numFmts', attributes)
-
-        # Write the numFmts elements.
-        @xf_formats.each do |format|
-          # Ignore built-in number formats, i.e., < 164.
-          next unless format.num_format_index >= 164
-          write_num_fmt(format.num_format_index, format.num_format)
+        @writer.tag_elements('numFmts', attributes) do
+          # Write the numFmts elements.
+          @xf_formats.each do |format|
+            # Ignore built-in number formats, i.e., < 164.
+            next unless format.num_format_index >= 164
+            write_num_fmt(format.num_format_index, format.num_format)
+          end
         end
-
-        @writer.end_tag('numFmts')
       end
 
       #
@@ -172,64 +170,57 @@ def write_num_fmt(num_fmt_id, format_code)
       # Write the <fonts> element.
       #
       def write_fonts
-        count = @font_count
-
-        attributes = ['count', count]
-
-        @writer.start_tag('fonts', attributes)
-
-        # Write the font elements for format objects that have them.
-        @xf_formats.each { |format| write_font(format) unless format.has_font == 0 }
-
-        @writer.end_tag('fonts')
+        write_format_elements('fonts', @font_count) do
+          @xf_formats.each do |format|
+            write_font(format) if format.has_font?
+          end
+        end
       end
 
       #
       # Write the <font> element.
       #
       def write_font(format, dxf_format = nil)
-        @writer.start_tag('font')
-
-        # The condense and extend elements are mainly used in dxf formats.
-        write_condense unless format.font_condense == 0
-        write_extend   unless format.font_extend   == 0
-
-        @writer.empty_tag('b')       if format.bold?
-        @writer.empty_tag('i')       if format.italic?
-        @writer.empty_tag('strike')  if format.strikeout?
-        @writer.empty_tag('outline') if format.outline?
-        @writer.empty_tag('shadow')  if format.shadow?
-
-        # Handle the underline variants.
-        write_underline( format.underline ) if format.underline?
-
-        write_vert_align('superscript') if format.font_script == 1
-        write_vert_align('subscript')   if format.font_script == 2
-
-        @writer.empty_tag('sz', ['val', format.size]) if !dxf_format
-
-        theme = format.theme
-        if theme != 0
-          write_color('theme', theme)
-        elsif format.color_indexed != 0
-          write_color('indexed', format.color_indexed)
-        elsif format.color != 0
-          color = get_palette_color(format.color)
-          write_color('rgb', color)
-        elsif !dxf_format
-          write_color('theme', 1)
-        end
+        @writer.tag_elements('font') do
+          # The condense and extend elements are mainly used in dxf formats.
+          write_condense unless format.font_condense == 0
+          write_extend   unless format.font_extend   == 0
+
+          @writer.empty_tag('b')       if format.bold?
+          @writer.empty_tag('i')       if format.italic?
+          @writer.empty_tag('strike')  if format.strikeout?
+          @writer.empty_tag('outline') if format.outline?
+          @writer.empty_tag('shadow')  if format.shadow?
+
+          # Handle the underline variants.
+          write_underline( format.underline ) if format.underline?
+
+          write_vert_align('superscript') if format.font_script == 1
+          write_vert_align('subscript')   if format.font_script == 2
+
+          @writer.empty_tag('sz', ['val', format.size]) if !dxf_format
+
+          theme = format.theme
+          if theme != 0
+            write_color('theme', theme)
+          elsif format.color_indexed != 0
+            write_color('indexed', format.color_indexed)
+          elsif format.color != 0
+            color = get_palette_color(format.color)
+            write_color('rgb', color)
+          elsif !dxf_format
+            write_color('theme', 1)
+          end
 
-        if !dxf_format
-          @writer.empty_tag('name',   ['val', format.font])
-          @writer.empty_tag('family', ['val', format.font_family])
+          if !dxf_format
+            @writer.empty_tag('name',   ['val', format.font])
+            @writer.empty_tag('family', ['val', format.font_family])
 
-          if format.font == 'Calibri' && format.hyperlink == 0
-            @writer.empty_tag('scheme', ['val', format.font_scheme])
+            if format.font == 'Calibri' && format.hyperlink == 0
+              @writer.empty_tag('scheme', ['val', format.font_scheme])
+            end
           end
         end
-
-        @writer.end_tag('font')
       end
 
       #
@@ -259,27 +250,25 @@ def write_fills
 
         attributes = ['count', count]
 
-        @writer.start_tag('fills', attributes)
+        @writer.tag_elements('fills', attributes) do
+          # Write the default fill element.
+          write_default_fill('none')
+          write_default_fill('gray125')
 
-        # 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) unless format.has_fill == 0
+          # Write the fill elements for format objects that have them.
+          @xf_formats.each do |format|
+            write_fill(format) if format.has_fill?
+          end
         end
-
-        @writer.end_tag( 'fills' )
       end
 
       #
       # Write the <fill> element for the default fills.
       #
       def write_default_fill(pattern_type)
-        @writer.start_tag('fill')
-        @writer.empty_tag('patternFill', ['patternType', pattern_type])
-        @writer.end_tag('fill')
+        @writer.tag_elements('fill') do
+          @writer.empty_tag('patternFill', ['patternType', pattern_type])
+        end
       end
 
       #
@@ -312,47 +301,48 @@ def write_fill(format, dxf_format = nil)
           gray0625
         )
 
-        @writer.start_tag('fill' )
-
-        # The "none" pattern is handled differently for dxf formats.
-        if dxf_format && format.pattern <= 1
-          @writer.start_tag('patternFill')
-        else
-          @writer.start_tag('patternFill', ['patternType', patterns[format.pattern]])
-        end
-
-        unless fg_color == 0
-          fg_color = get_palette_color(fg_color)
-          @writer.empty_tag('fgColor', ['rgb', fg_color])
-        end
+        @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
+            unless fg_color == 0
+              fg_color = get_palette_color(fg_color)
+              @writer.empty_tag('fgColor', ['rgb', fg_color])
+            end
 
-        if bg_color != 0
-          bg_color = get_palette_color(bg_color)
-          @writer.empty_tag('bgColor', ['rgb', bg_color])
-        else
-          @writer.empty_tag('bgColor', ['indexed', 64]) if !dxf_format
+            if bg_color != 0
+              bg_color = get_palette_color(bg_color)
+              @writer.empty_tag('bgColor', ['rgb', bg_color])
+            else
+              @writer.empty_tag('bgColor', ['indexed', 64]) if !dxf_format
+            end
+          end
         end
-
-        @writer.end_tag('patternFill')
-        @writer.end_tag('fill')
       end
 
       #
       # Write the <borders> element.
       #
       def write_borders
-        count = @border_count
+        write_format_elements('borders', @border_count) do
+          @xf_formats.each do |format|
+            write_border(format) if format.has_border?
+          end
+        end
+      end
 
+      def write_format_elements(elements, count)
         attributes = ['count', count]
 
-        @writer.start_tag('borders', attributes)
-
-        # Write the border elements for format objects that have them.
-        @xf_formats.each do |format|
-          write_border(format) unless format.has_border == 0
+        @writer.tag_elements(elements, attributes) do
+          # Write the border elements for format objects that have them.
+          yield
         end
-
-        @writer.end_tag('borders')
       end
 
       #
@@ -375,25 +365,23 @@ def write_border(format, dxf_format = nil)
         format.diag_border = 1 if format.diag_type != 0 && format.diag_border == 0
 
         # Write the start border tag.
-        @writer.start_tag('border', attributes)
-
-        # 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
+        @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
 
-        if dxf_format
-          write_sub_border('vertical')
-          write_sub_border('horizontal')
+          if dxf_format
+            write_sub_border('vertical')
+            write_sub_border('horizontal')
+          end
         end
-
-        @writer.end_tag('border')
       end
 
       #
@@ -424,16 +412,14 @@ def write_sub_border(type, style = 0, color = nil)
 
         attributes = [:style, border_styles[style]]
 
-        @writer.start_tag(type, attributes)
-
-        if color != 0
-          color = get_palette_color(color)
-          @writer.empty_tag('color', ['rgb', color])
-        else
-          @writer.empty_tag('color', ['auto', 1])
+        @writer.tag_elements(type, attributes) do
+          if color != 0
+            color = get_palette_color(color)
+            @writer.empty_tag('color', ['rgb', color])
+          else
+            @writer.empty_tag('color', ['auto', 1])
+          end
         end
-
-        @writer.end_tag(type)
       end
 
       #
@@ -444,12 +430,10 @@ def write_cell_style_xfs
 
         attributes = ['count', count]
 
-        @writer.start_tag('cellStyleXfs', attributes)
-
-        # Write the style_xf element.
-        write_style_xf
-
-        @writer.end_tag('cellStyleXfs')
+        @writer.tag_elements('cellStyleXfs', attributes) do
+          # Write the style_xf element.
+          write_style_xf
+        end
       end
 
       #
@@ -466,12 +450,10 @@ def write_cell_xfs
 
         attributes = ['count', formats.size]
 
-        @writer.start_tag('cellXfs', attributes)
-
-        # Write the xf elements.
-        formats.each { |format| write_xf(format) }
-
-        @writer.end_tag('cellXfs')
+        @writer.tag_elements('cellXfs', attributes) do
+          # Write the xf elements.
+          formats.each { |format| write_xf(format) }
+        end
       end
 
       #
@@ -540,10 +522,10 @@ def write_xf(format)
 
         # Write XF with sub-elements if required.
         if has_align || has_protect
-          @writer.start_tag('xf', attributes)
-          @writer.empty_tag('alignment',  align)      if has_align
-          @writer.empty_tag('protection', protection) if has_protect
-          @writer.end_tag('xf')
+          @writer.tag_elements('xf', attributes) do
+            @writer.empty_tag('alignment',  align)      if has_align
+            @writer.empty_tag('protection', protection) if has_protect
+          end
         else
           @writer.empty_tag('xf', attributes)
         end
@@ -557,12 +539,10 @@ def write_cell_styles
 
         attributes = ['count', count]
 
-        @writer.start_tag('cellStyles', attributes)
-
-        # Write the cellStyle element.
-        write_cell_style
-
-        @writer.end_tag('cellStyles')
+        @writer.tag_elements('cellStyles', attributes) do
+          # Write the cellStyle element.
+          write_cell_style
+        end
       end
 
       #
@@ -593,23 +573,21 @@ def write_dxfs
         attributes = ['count', count]
 
         if !formats.empty?
-          @writer.start_tag('dxfs', attributes)
-
-          # Write the font elements for format objects that have them.
-          @dxf_formats.each do |format|
-            @writer.start_tag('dxf')
-            write_font(format, 1) unless format.has_dxf_font == 0
-
-            if format.num_format_index != 0
-              write_num_fmt(format.num_format_index, format.num_format)
+          @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
+                write_font(format, 1) if format.has_dxf_font?
+
+                if format.num_format_index != 0
+                  write_num_fmt(format.num_format_index, format.num_format)
+                end
+
+                write_fill(format, 1)    if format.has_dxf_fill?
+                write_border(format, 1)  if format.has_dxf_border?
+              end
             end
-
-            write_fill(format, 1)    if format.has_dxf_fill   != 0
-            write_border(format, 1)  if format.has_dxf_border != 0
-            @writer.end_tag('dxf')
           end
-
-          @writer.end_tag('dxfs')
         else
           @writer.empty_tag('dxfs', attributes)
         end
@@ -640,9 +618,9 @@ def write_colors
 
         return if @custom_colors.empty?
 
-        @writer.start_tag( 'colors' )
-        write_mru_colors(@custom_colors)
-        @writer.end_tag('colors')
+        @writer.tag_elements( 'colors' ) do
+          write_mru_colors(@custom_colors)
+        end
       end
 
       #
@@ -655,14 +633,12 @@ def write_mru_colors(*args)
         count = custom_colors.size
         custom_colors = custom_colors[-10, 10] if count > 10
 
-        @writer.start_tag('mruColors')
-
-        # Write the custom colors in reverse order.
-        @custom_colors.reverse.each do |color|
-          write_color('rgb', color)
+        @writer.tag_elements('mruColors') do
+          # Write the custom colors in reverse order.
+          @custom_colors.reverse.each do |color|
+            write_color('rgb', color)
+          end
         end
-
-        @writer.end_tag('mruColors')
       end
 
       def write_xml_declaration