write_xlsx 0.78.0 → 0.79.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97af755aa6f07672a642c569fa9916a0e18365d8
-  data.tar.gz: f3ca578778d1725fe6a7936e37d5586bdb834eba
+  metadata.gz: e671b68b1de5d627fc5e2306b17a157dd669ac0b
+  data.tar.gz: 9a33233b791e917331d2714bfa1212789ff7d515
 SHA512:
-  metadata.gz: 21399bff146d040567803600ed057b6b2e7eb5d49beee2a4744aefe19ef6987958d4152e050e1d0ee7ec58ad87454ece4bc90250f316f5bbdfb50b7f0a420bbb
-  data.tar.gz: 376f41e382cf9c8f88c35ee1dbe69a567c1189ec20e2b010d9cfa9ef39507abd5eb728893ee2aca931f6dffe5caef1aa23568ab3095fb1468e7208deeb76d0d4
+  metadata.gz: 2b218047dedb38eb475c41a3dda88d3eefca2d185ea34af3270f6d5ca9ebb884f1e81d3b8f893b16cbb84930fda41f28b2a62c926d2a58b9754c2c0e296204ce
+  data.tar.gz: d9ea75c34d0510b98d1a9a985fabbe3bcd62a73b8f31eba6b9d334313d1f94e29ffe6392dda2bc12cc84e1d4a778ace0e8ddff6afe530a5c5eb3661aeaa7ef07

data/Changes

@@ -1,4 +1,11 @@
 Change history of write_xlsx rubygem.
+2014-11-29 v0.79.0
+   Added option to add images to headers and footers.
+   Added option to not scale heaader/footer with page.
+   Fixed issue where non 96dpi images weren’t scaled properly in Excel.
+   Fix for issue where X axis title formula was overwritten by the
+   Y axis title.
+
 2014-11-22 v0.78.0
    Added Doughnut chart with set_rotation and set_hole_size methods.
    Added set_rotation method to Pie charts.

data/README.md

@@ -4,7 +4,7 @@
 
 gem to create a new file in the Excel 2007+ XLSX format, and you can use the
 same interface as writeexcel gem. write_xlsx is converted from Perl's module
-[Excel::Writer::XLSX-0.78](https://github.com/jmcnamara/excel-writer-xlsx) .
+[Excel::Writer::XLSX-0.79](https://github.com/jmcnamara/excel-writer-xlsx) .
 
 ## Description
 

data/examples/chart_pie.rb

@@ -60,7 +60,7 @@ worksheet.insert_chart('C2', chart1, 25, 10)
 # Create an example Pie chart like above.
 chart2 = workbook.add_chart(:type => 'pie', :embedded => 1)
 
-# Configure the series and add user defined segment colours.
+# Configure the series.
 chart2.add_series(
                   :name       => 'Pie sales data',
                   :categories => '=Sheet1!$A$2:$A$4',

data/lib/write_xlsx/drawing.rb

@@ -86,7 +86,7 @@ module Writexlsx
       @writer.tag_elements('xdr:twoCellAnchor', attributes) do
         # Write the xdr:from element.
         write_from(col_from, row_from, col_from_offset, row_from_offset)
-        # Write the xdr:from element.
+        # Write the xdr:to element.
         write_to(col_to, row_to, col_to_offset, row_to_offset)
 
         if type == 1

data/lib/write_xlsx/package/vml.rb

@@ -16,30 +16,42 @@ module Writexlsx
         @writer.set_xml_writer(filename)
       end
 
-      def assemble_xml_file(worksheet)
+      def assemble_xml_file(
+                            data_id, vml_shape_id, comments_data,
+                            buttons_data, header_images_data = []
+                            )
         return unless @writer
 
         write_xml_namespace do
           # Write the o:shapelayout element.
-          write_shapelayout(worksheet.vml_data_id)
+          write_shapelayout(data_id)
 
           z_index = 1
-          vml_shape_id = worksheet.vml_shape_id
-          unless worksheet.buttons_data.empty?
+          unless buttons_data.empty?
             vml_shape_id, z_index =
               write_shape_type_and_shape(
-                                         worksheet.buttons_data,
+                                         buttons_data,
                                          vml_shape_id, z_index) do
               write_button_shapetype
             end
           end
-          unless worksheet.sorted_comments.empty?
+          unless comments_data.empty?
             write_shape_type_and_shape(
-                                       worksheet.sorted_comments,
+                                       comments_data,
                                        vml_shape_id, z_index) do
               write_comment_shapetype
             end
           end
+          unless header_images_data.empty?
+            write_image_shapetype
+            index = 1
+            header_images_data.each do |image|
+              # Write the v:shape element.
+              vml_shape_id += 1
+              write_image_shape(vml_shape_id, index, image)
+              index += 1
+            end
+          end
         end
         @writer.crlf
         @writer.close
@@ -144,6 +156,43 @@ module Writexlsx
         end
       end
 
+      #
+      # Write the <v:shapetype> element.
+      #
+      def write_image_shapetype
+        id               = '_x0000_t75'
+        coordsize        = '21600,21600'
+        spt              = 75
+        o_preferrelative = 't'
+        path             = 'm@4@5l@4@11@9@11@9@5xe'
+        filled           = 'f'
+        stroked          = 'f'
+
+        attributes = [
+                      ['id',               id],
+                      ['coordsize',        coordsize],
+                      ['o:spt',            spt],
+                      ['o:preferrelative', o_preferrelative],
+                      ['path',             path],
+                      ['filled',           filled],
+                      ['stroked',          stroked]
+                     ]
+
+        @writer.tag_elements('v:shapetype', attributes) do
+          # Write the v:stroke element.
+          write_stroke
+
+          # Write the v:formulas element.
+          write_formulas
+
+          # Write the v:path element.
+          write_image_path
+
+          # Write the o:lock element.
+          write_aspect_ratio_lock
+        end
+      end
+
       #
       # Write the <v:path> element.
       #
@@ -158,6 +207,23 @@ module Writexlsx
         @writer.empty_tag('v:path', attributes)
       end
 
+      #
+      # Write the <v:path> element.
+      #
+      def write_image_path
+        extrusionok     = 'f'
+        gradientshapeok = 't'
+        connecttype     = 'rect'
+
+        attributes = [
+                      ['o:extrusionok',   extrusionok],
+                      ['gradientshapeok', gradientshapeok],
+                      ['o:connecttype',   connecttype]
+                     ]
+
+        @writer.empty_tag('v:path', attributes)
+      end
+
       #
       # Write the <o:lock> element.
       #
@@ -168,6 +234,127 @@ module Writexlsx
                      ]
         @writer.empty_tag('o:lock', attributes)
       end
+
+      #
+      # Write the <o:lock> element.
+      #
+      def write_rotation_lock
+        attributes = [
+                      ['v:ext',    'edit'],
+                      ['rotation', 't']
+                     ]
+        @writer.empty_tag('o:lock', attributes)
+      end
+
+      #
+      # Write the <o:lock> element.
+      #
+      def write_aspect_ratio_lock
+        ext         = 'edit'
+        aspectratio = 't'
+
+        attributes = [
+                      ['v:ext',       ext],
+                      ['aspectratio', aspectratio]
+                     ]
+
+        @writer.empty_tag('o:lock', attributes)
+      end
+
+      #
+      # Write the <v:shape> element.
+      #
+      def write_image_shape(id, index, image_data)
+        type       = '#_x0000_t75'
+
+        # Set the shape index.
+        shape_index = "_x0000_s#{id}"
+
+        # Get the image parameters
+        width    = image_data[0]
+        height   = image_data[1]
+        name     = image_data[2]
+        position = image_data[3]
+        x_dpi    = image_data[4]
+        y_dpi    = image_data[5]
+
+        # Scale the height/width by the resolution, relative to 72dpi.
+        width  = width  * 72.0 / x_dpi
+        height = height * 72.0 / y_dpi
+
+        # Excel uses a rounding based around 72 and 96 dpi.
+        width  = 72/96.0 * (width  * 96/72.0 + 0.25).to_i
+        height = 72/96.0 * (height * 96/72.0 + 0.25).to_i
+
+        if (width - width.to_i).abs < 0.1
+          width = width.to_i
+        end
+        if (height - height.to_i).abs < 0.1
+          height = height.to_i
+        end
+
+        style = [
+                 "position:absolute", "margin-left:0", "margin-top:0",
+                 "width:#{width}pt", "height:#{height}pt",
+                 "z-index:#{index}"
+                ].join(';')
+        attributes = [
+                      ['id',     position],
+                      ['o:spid', "_x0000_s#{id}"],
+                      ['type',   type],
+                      ['style',  style]
+                     ]
+
+        @writer.tag_elements('v:shape', attributes) do
+          # Write the v:imagedata element.
+          write_imagedata(index, name)
+
+          # Write the o:lock element.
+          write_rotation_lock
+        end
+      end
+
+      #
+      # Write the <v:imagedata> element.
+      #
+      def write_imagedata(index, o_title)
+        attributes = [
+                      ['o:relid', "rId#{index}"],
+                      ['o:title', o_title]
+                     ]
+
+        @writer.empty_tag('v:imagedata', attributes)
+      end
+
+      #
+      # Write the <v:formulas> element.
+      #
+      def write_formulas
+        @writer.tag_elements('v:formulas') do
+          # Write the v:f elements.
+          write_f('if lineDrawn pixelLineWidth 0')
+          write_f('sum @0 1 0')
+          write_f('sum 0 0 @1')
+          write_f('prod @2 1 2')
+          write_f('prod @3 21600 pixelWidth')
+          write_f('prod @3 21600 pixelHeight')
+          write_f('sum @0 0 1')
+          write_f('prod @6 1 2')
+          write_f('prod @7 21600 pixelWidth')
+          write_f('sum @8 21600 0')
+          write_f('prod @7 21600 pixelHeight')
+          write_f('sum @10 21600 0')
+        end
+      end
+
+      #
+      # Write the <v:f> element.
+      #
+      def write_f(eqn)
+        attributes = [ ['eqn', eqn] ]
+
+        @writer.empty_tag('v:f', attributes)
+      end
     end
   end
 end

data/lib/write_xlsx/sheets.rb

@@ -58,13 +58,30 @@ module Writexlsx
 
     def write_vml_files(package_dir)
       dir = "#{package_dir}/xl/drawings"
-      self.select { |sheet| sheet.has_vml? }.
-        each_with_index do |sheet, index|
+      index = 1
+      self.each do |sheet|
+        next if !sheet.has_vml? and !sheet.has_header_vml?
         FileUtils.mkdir_p(dir)
 
-        vml = Package::Vml.new
-        vml.set_xml_writer("#{dir}/vmlDrawing#{index+1}.vml")
-        vml.assemble_xml_file(sheet)
+        if sheet.has_vml?
+          vml = Package::Vml.new
+          vml.set_xml_writer("#{dir}/vmlDrawing#{index}.vml")
+          vml.assemble_xml_file(
+                                sheet.vml_data_id, sheet.vml_shape_id,
+                                sheet.sorted_comments, sheet.buttons_data
+                                )
+          index += 1
+        end
+        if sheet.has_header_vml?
+          vml = Package::Vml.new
+          vml.set_xml_writer("#{dir}/vmlDrawing#{index}.vml")
+          vml.assemble_xml_file(
+                                sheet.vml_header_id, sheet.vml_header_id * 1024,
+                                [], [], sheet.header_images_data
+                                )
+          write_vml_drawing_rels_files(package_dir, sheet, index)
+          index += 1
+        end
       end
     end
 
@@ -125,6 +142,22 @@ module Writexlsx
       end
     end
 
+    def write_vml_drawing_rels_files(package_dir, worksheet, index)
+      # Create the drawing .rels dir.
+      dir = "#{package_dir}/xl/drawings/_rels"
+      FileUtils.mkdir_p(dir)
+
+      rels = Package::Relationships.new
+
+      worksheet.vml_drawing_links.each do |drawing_data|
+        rels.add_document_relationship(*drawing_data)
+      end
+
+      # Create the .rels file such as /xl/drawings/_rels/vmlDrawing1.vml.rels.
+      rels.set_xml_writer("#{dir}/vmlDrawing#{index}.vml.rels")
+      rels.assemble_xml_file
+    end
+
     def write_worksheet_rels_files(package_dir)
       write_sheet_rels_files_base(worksheets, "#{package_dir}/xl/worksheets/_rels",
                             'sheet')

data/lib/write_xlsx/version.rb

@@ -1,5 +1,5 @@
 require 'write_xlsx/workbook'
 
 class WriteXLSX < Writexlsx::Workbook
-  VERSION = "0.78.0"
+  VERSION = "0.79.0"
 end

data/lib/write_xlsx/workbook.rb

@@ -985,7 +985,7 @@ module Writexlsx
     end
 
     def num_vml_files
-      @worksheets.select { |sheet| sheet.has_vml? }.count
+      @worksheets.select { |sheet| sheet.has_vml? || sheet.has_header_vml? }.count
     end
 
     def num_comment_files
@@ -1534,18 +1534,32 @@ module Writexlsx
       comment_id     = 0
       vml_drawing_id = 0
       vml_data_id    = 1
+      vml_header_id  = 0
       vml_shape_id   = 1024
+      comment_files  = 0
 
-      @worksheets.select { |sheet| sheet.has_vml? }.each do |sheet|
-        comment_id += 1 if sheet.has_comments?
-        vml_drawing_id += 1
+      @worksheets.each do |sheet|
+        next if !sheet.has_vml? && !sheet.has_header_vml?
+        if sheet.has_vml?
+          if sheet.has_comments?
+            comment_files += 1
+            comment_id    += 1
+          end
+          vml_drawing_id += 1
 
-        sheet.prepare_vml_objects(vml_data_id, vml_shape_id,
-                                  vml_drawing_id, comment_id)
+          sheet.prepare_vml_objects(vml_data_id, vml_shape_id,
+                                    vml_drawing_id, comment_id)
 
-        # Each VML file should start with a shape id incremented by 1024.
-        vml_data_id  +=    1 * ( 1 + sheet.num_comments_block )
-        vml_shape_id += 1024 * ( 1 + sheet.num_comments_block )
+          # Each VML file should start with a shape id incremented by 1024.
+          vml_data_id  +=    1 * ( 1 + sheet.num_comments_block )
+          vml_shape_id += 1024 * ( 1 + sheet.num_comments_block )
+        end
+
+        if sheet.has_header_vml?
+          vml_header_id  += 1
+          vml_drawing_id += 1
+          sheet.prepare_header_vml_objects(vml_header_id, vml_drawing_id)
+        end
       end
 
       add_font_format_for_cell_comments if num_comment_files > 0
@@ -1730,27 +1744,69 @@ module Writexlsx
         chart_count = sheet.charts.size
         image_count = sheet.images.size
         shape_count = sheet.shapes.size
-        next if chart_count + image_count + shape_count == 0
+        header_image_count = sheet.header_images.size
+        footer_image_count = sheet.footer_images.size
+        has_drawing = false
 
-        drawing_id += 1
+        # Check that some image or drawing needs to be processed.
+        next if chart_count + image_count + shape_count + header_image_count + footer_image_count == 0
 
+        # Don't increase the drawing_id header/footer images.
+        if chart_count + image_count + shape_count > 0
+          drawing_id += 1
+          has_drawing = true
+        end
+
+        # Prepare the worksheet charts.
         sheet.charts.each_with_index do |chart, index|
           chart_ref_id += 1
           sheet.prepare_chart(index, chart_ref_id, drawing_id)
         end
 
+        # Prepare the worksheet images.
         sheet.images.each_with_index do |image, index|
-          image_id, type, width, height, name = get_image_properties(image[2])
+          type, width, height, name, x_dpi, y_dpi = get_image_properties(image[2])
           image_ref_id += 1
-          sheet.prepare_image(index, image_ref_id, drawing_id, width, height, name, type)
+          sheet.prepare_image(index, image_ref_id, drawing_id, width, height, name, type, x_dpi, y_dpi)
         end
 
+        # Prepare the worksheet shapes.
         sheet.shapes.each_with_index do |shape, index|
           sheet.prepare_shape(index, drawing_id)
         end
 
-        drawing = sheet.drawing
-        @drawings << drawing
+        # Prepare the header images.
+        header_image_count.times do |index|
+          filename = sheet.header_images[index][0]
+          position = sheet.header_images[index][1]
+
+          type, width, height, name, x_dpi, y_dpi =
+            get_image_properties(filename)
+
+          image_ref_id += 1
+
+          sheet.prepare_header_image(image_ref_id, width, height,
+                                     name, type, position, x_dpi, y_dpi)
+        end
+
+        # Prepare the footer images.
+        footer_image_count.times do |index|
+          filename = sheet.footer_images[index][0]
+          position = sheet.footer_images[index][1]
+
+          type, width, height, name, x_dpi, y_dpi =
+            get_image_properties(filename)
+
+          image_ref_id += 1
+
+          sheet.prepare_header_image(image_ref_id, width, height,
+                                     name, type, position, x_dpi, y_dpi)
+        end
+
+        if has_drawing
+          drawing = sheet.drawing
+          @drawings << drawing
+        end
       end
 
       # Sort the workbook charts references into the order that the were
@@ -1766,41 +1822,32 @@ module Writexlsx
     # any duplicates.
     #
     def get_image_properties(filename)
-      previous_images = []
-      images_seen = {}
-      image_id = 1;
-      if images_seen[filename]
-        # We've processed this file already.
-        index = images_seen[filename] - 1
+      # Note the image_id, and previous_images mechanism isn't currently used.
+      x_dpi = 96
+      y_dpi = 96
+
+      # Open the image file and import the data.
+      data = File.binread(filename)
+      if data.unpack('x A3')[0] == 'PNG'
+        # Test for PNGs.
+        type, width, height, x_dpi, y_dpi = process_png(data)
+        @image_types[:png] = 1
+      elsif data.unpack('n')[0] == 0xFFD8
+        # Test for JPEG files.
+        type, width, height, x_dpi, y_dpi = process_jpg(data, filename)
+        @image_types[:jpeg] = 1
+      elsif data.unpack('A2')[0] == 'BM'
+        # Test for BMPs.
+        type, width, height = process_bmp(data, filename)
+        @image_types[:bmp] = 1
       else
-        # Open the image file and import the data.
-        data = File.binread(filename)
-        if data.unpack('x A3')[0] == 'PNG'
-          # Test for PNGs.
-          type, width, height = process_png(data)
-          @image_types[:png] = 1
-        elsif data.unpack('n')[0] == 0xFFD8
-          # Test for JPEG files.
-          type, width, height = process_jpg(data, filename)
-          @image_types[:jpeg] = 1
-        elsif data.unpack('A2')[0] == 'BM'
-          # Test for BMPs.
-          type, width, height = process_bmp(data, filename)
-          @image_types[:bmp] = 1
-        else
-          # TODO. Add Image::Size to support other types.
-          raise "Unsupported image format for file: #{filename}\n"
-        end
-
-        @images << [filename, type]
-
-        # Also store new data for use in duplicate images.
-        previous_images << [image_id, type, width, height]
-        images_seen[filename] = image_id
-        image_id += 1
+        # TODO. Add Image::Size to support other types.
+        raise "Unsupported image format for file: #{filename}\n"
       end
 
-      [image_id, type, width, height, File.basename(filename)]
+      @images << [filename, type]
+
+      [type, width, height, File.basename(filename), x_dpi, y_dpi]
     end
 
     #
@@ -1808,27 +1855,75 @@ module Writexlsx
     #
     def process_png(data)
       type   = 'png'
-      width  = data[16, 4].unpack("N")[0]
-      height = data[20, 4].unpack("N")[0]
+      width  = 0
+      height = 0
+      x_dip  = 96
+      y_dpi  = 96
 
-      [type, width, height]
+      offset = 8
+      data_length = data.size
+
+      # Search through the image data to read the height and width in th the
+      # IHDR element. Also read the DPI in the pHYs element.
+      while offset < data_length
+
+        length = data[offset + 0, 4].unpack("N")[0]
+        png_type   = data[offset + 4, 4].unpack("A4")[0]
+
+        case png_type
+        when "IHDR"
+          width  = data[offset +  8, 4].unpack("N")[0]
+          height = data[offset + 12, 4].unpack("N")[0]
+        when "pHYs"
+          x_ppu = data[offset +  8, 4].unpack("N")[0]
+          y_ppu = data[offset + 12, 4].unpack("N")[0]
+          units = data[offset + 16, 1].unpack("C")[0]
+
+          if units == 1
+            x_dpi = x_ppu * 0.0254
+            y_dpi = y_ppu * 0.0254
+          end
+        end
+
+        offset = offset + length + 12
+
+        break if png_type == "IEND"
+      end
+      raise "#{filename}: no size data found in png image.\n" unless height
+
+      [type, width, height, x_dpi, y_dpi]
     end
 
     def process_jpg(data, filename)
       type     = 'jpeg'
+      x_dpi    = 96
+      y_dpi    = 96
+
       offset = 2
       data_length = data.bytesize
 
-      # Search through the image data to find the 0xFFC0 marker. The height and
-      # width are contained in the data for that sub element.
+      # Search through the image data to read the height and width in the
+      # 0xFFC0/C2 element. Also read the DPI in the 0xFFE0 element.
       while offset < data_length
-        marker  = data[offset,   2].unpack("n")[0]
+        marker  = data[offset+0, 2].unpack("n")[0]
         length  = data[offset+2, 2].unpack("n")[0]
 
         if marker == 0xFFC0 || marker == 0xFFC2
           height = data[offset+5, 2].unpack("n")[0]
           width  = data[offset+7, 2].unpack("n")[0]
-          break
+        end
+        if marker == 0xFFE0
+          units     = data[offset + 11, 1].unpack("C")[0]
+          x_density = data[offset + 12, 2].unpack("n")[0]
+          y_density = data[offset + 14, 2].unpack("n")[0]
+
+          if units == 1
+            x_dpi = x_density
+            y_dpi = y_density
+          elsif units == 2
+            x_dpi = x_density * 2.54
+            y_dpi = y_density * 2.54
+          end
         end
 
         offset += length + 2
@@ -1836,7 +1931,7 @@ module Writexlsx
       end
 
       raise "#{filename}: no size data found in jpeg image.\n" unless height
-      [type, width, height]
+      [type, width, height, x_dpi, y_dpi]
     end
 
     # Extract width and height information from a BMP file.

data/lib/write_xlsx/worksheet/page_setup.rb

@@ -12,7 +12,7 @@ module Writexlsx
       attr_accessor :fit_page, :fit_width, :fit_height, :page_setup_changed   # :nodoc:
       attr_writer :across                                                   # :nodoc:
       attr_accessor :orientation, :print_options_changed  # :nodoc:
-      attr_accessor :header, :footer, :header_footer_changed, :header_footer_aligns
+      attr_accessor :header, :footer, :header_footer_changed, :header_footer_aligns, :header_footer_scales
       attr_writer :page_start
 
       def initialize # :nodoc:
@@ -34,6 +34,8 @@ module Writexlsx
         @page_setup_changed = false
         @across = false
         @orientation = true
+        @header_footer_aligns = true
+        @header_footer_scales = true
       end
 
       def paper=(paper_size)
@@ -139,7 +141,8 @@ module Writexlsx
       def write_header_footer(writer, excel2003_style) #:nodoc:
         tag = 'headerFooter'
         attributes = []
-        attributes << ['alignWithMargins', 0] if @header_footer_aligns
+        attributes << ['scaleWithDoc', 0]     unless ptrue?(@header_footer_scales)
+        attributes << ['alignWithMargins', 0] unless ptrue?(@header_footer_aligns)
 
         if @header_footer_changed
           writer.tag_elements(tag, attributes) do