write_xlsx 0.75.0 → 0.76.0

data/lib/write_xlsx/chartsheet.rb

@@ -35,25 +35,25 @@ module Writexlsx
 
       write_xml_declaration do
         # Write the root chartsheet element.
-        write_chartsheet
-        # Write the worksheet properties.
-        write_sheet_pr
-        # Write the sheet view properties.
-        write_sheet_views
-        # Write the sheetProtection element.
-        write_sheet_protection
-        # Write the printOptions element.
-        write_print_options
-        # Write the worksheet page_margins.
-        write_page_margins
-        # Write the worksheet page setup.
-        write_page_setup
-        # Write the headerFooter element.
-        write_header_footer
-        # Write the drawing element.
-        write_drawings
-        # Close the worksheet tag.
-        @writer.end_tag('chartsheet')
+        write_chartsheet do
+          # Write the worksheet properties.
+          write_sheet_pr
+          # Write the sheet view properties.
+          write_sheet_views
+          # Write the sheetProtection element.
+          write_sheet_protection
+          # Write the printOptions element.
+          write_print_options
+          # Write the worksheet page_margins.
+          write_page_margins
+          # Write the worksheet page setup.
+          write_page_setup
+          # Write the headerFooter element.
+          write_header_footer
+          # Write the drawing element.
+          write_drawings
+          # Close the worksheet tag.
+        end
       end
     end
 
@@ -180,7 +180,9 @@ module Writexlsx
                     ['xmlns:r', xmlns_r]
                    ]
 
-      @writer.start_tag('chartsheet', attributes)
+      @writer.tag_elements('chartsheet', attributes) do
+        yield
+      end
     end
 
     #

data/lib/write_xlsx/colors.rb

@@ -32,27 +32,21 @@ module Writexlsx
     # string into a number. Color range is 0..63 but we will restrict it
     # to 8..63 to comply with Gnumeric. Colors 0..7 are repeated in 8..15.
     #
-    def get_color(color = nil) # :nodoc:
-      if color.respond_to?(:to_int) && color.respond_to?(:+)
+    def color(color_code = nil) # :nodoc:
+      if color_code.respond_to?(:to_int) && color_code.respond_to?(:+)
         # the default color if arg is outside range,
-        if color < 0 || 63 < color
+        if color_code < 0 || 63 < color_code
           0x7FFF
         # or an index < 8 mapped into the correct range,
-        elsif color < 8
-          (color + 8).to_i
+        elsif color_code < 8
+          (color_code + 8).to_i
         # or an integer in the valid range
         else
-          color.to_i
-        end
-      elsif color.respond_to?(:to_sym)
-        color = color.downcase.to_sym if color.respond_to?(:to_str)
-        # or the color string converted to an integer,
-        if COLORS.has_key?(color)
-          COLORS[color]
-        # or the default color if string is unrecognised,
-        else
-          0x7FFF
+          color_code.to_i
         end
+      elsif color_code.respond_to?(:to_sym)
+        color_code = color_code.downcase.to_sym if color_code.respond_to?(:to_str)
+        COLORS[color_code] || 0x7FFF
       else
         0x7FFF
       end

data/lib/write_xlsx/drawing.rb

@@ -81,7 +81,7 @@ module Writexlsx
       attributes << [:editAs, 'oneCell'] if type == 2
 
       # Add attribute for shapes.
-      attributes << [:editAs, shape.edit_as] if shape && !shape.edit_as.nil?
+      attributes << [:editAs, shape.edit_as] if shape && shape.edit_as
 
       @writer.tag_elements('xdr:twoCellAnchor', attributes) do
         # Write the xdr:from element.
@@ -111,31 +111,29 @@ module Writexlsx
     # Write the <xdr:absoluteAnchor> element.
     #
     def write_absolute_anchor(index)
-      @writer.start_tag('xdr:absoluteAnchor')
+      @writer.tag_elements('xdr:absoluteAnchor') do
+        # Different co-ordinates for horizonatal (= 0) and vertical (= 1).
+        if !ptrue?(@orientation)
 
-      # Different co-ordinates for horizonatal (= 0) and vertical (= 1).
-      if !ptrue?(@orientation)
+          # Write the xdr:pos element.
+          write_pos(0, 0)
 
-        # Write the xdr:pos element.
-        write_pos(0, 0)
-
-        # Write the xdr:ext element.
-        write_ext(9308969, 6078325)
-      else
-        # Write the xdr:pos element.
-        write_pos(0, -47625)
-
-        # Write the xdr:ext element.
-        write_ext(6162675, 6124575)
-      end
+          # Write the xdr:ext element.
+          write_ext(9308969, 6078325)
+        else
+          # Write the xdr:pos element.
+          write_pos(0, -47625)
 
-      # Write the xdr:graphicFrame element.
-      write_graphic_frame(index)
+          # Write the xdr:ext element.
+          write_ext(6162675, 6124575)
+        end
 
-      # Write the xdr:clientData element.
-      write_client_data
+        # Write the xdr:graphicFrame element.
+        write_graphic_frame(index)
 
-      @writer.end_tag('xdr:absoluteAnchor')
+        # Write the xdr:clientData element.
+        write_client_data
+      end
     end
 
       #
@@ -246,7 +244,7 @@ module Writexlsx
     # Write the <xdr:nvGraphicFramePr> element.
     #
     def write_nv_graphic_frame_pr(index, name = nil)
-      name = "Chart #{index}" if name.nil? || name.empty?
+      name = "Chart #{index}" unless ptrue?(name)
 
       @writer.tag_elements('xdr:nvGraphicFramePr') do
         # Write the xdr:cNvPr element.
@@ -400,7 +398,7 @@ module Writexlsx
           write_nv_cxn_sp_pr(index, shape)
 
           # Write the xdr:spPr element.
-          write_xdr_sp_pr(index, col_absolute, row_absolute, width, height, shape)
+          write_xdr_sp_pr(col_absolute, row_absolute, width, height, shape)
         end
       else
         # Add attribute for shapes.
@@ -414,11 +412,11 @@ module Writexlsx
           write_nv_sp_pr(index, shape)
 
           # Write the xdr:spPr element.
-          write_xdr_sp_pr(index, col_absolute, row_absolute, width, height, shape)
+          write_xdr_sp_pr(col_absolute, row_absolute, width, height, shape)
 
           # Write the xdr:txBody element.
           if shape.text != 0
-            write_txBody(col_absolute, row_absolute, width, height, shape)
+            write_tx_body(shape)
           end
         end
       end
@@ -585,7 +583,7 @@ module Writexlsx
     #
     # Write the <xdr:spPr> element for shapes.
     #
-    def write_xdr_sp_pr(index, col_absolute, row_absolute, width, height, shape)
+    def write_xdr_sp_pr(col_absolute, row_absolute, width, height, shape)
       attributes = [ ['bwMode', 'auto'] ]
 
       @writer.tag_elements('xdr:spPr', attributes) do
@@ -748,7 +746,7 @@ module Writexlsx
     #
     # Write the <xdr:txBody> element.
     #
-    def write_txBody(col_absolute, row_absolute, width, height, shape)
+    def write_tx_body(shape)
       attributes = [
                     [:vertOverflow, "clip"],
                     [:wrap,         "square"],
@@ -797,7 +795,7 @@ module Writexlsx
             @writer.tag_elements('a:rPr', attributes) do
               color = shape.format[:color]
               if color
-                color = shape.get_palette_color(color)
+                color = shape.palette_color(color)
                 color = color.sub(/^FF/, '')  # Remove leading FF from rgb for shape color.
               else
                 color = '000000'

data/lib/write_xlsx/format.rb

@@ -464,8 +464,8 @@ module Writexlsx
       end
     end
 
-    def get_color(color)
-      Format.get_color(color)
+    def color(color_code)
+      Format.color(color_code)
     end
 
     #
@@ -473,31 +473,31 @@ module Writexlsx
     # string into a number. Color range is 0..63 but we will restrict it
     # to 8..63 to comply with Gnumeric. Colors 0..7 are repeated in 8..15.
     #
-    def self.get_color(color)
+    def self.color(color_code)
 
       colors = Colors::COLORS
 
-      if color.respond_to?(:to_str)
+      if color_code.respond_to?(:to_str)
         # Return RGB style colors for processing later.
-        return color if color =~ /^#[0-9A-F]{6}$/i
+        return color_code if color_code =~ /^#[0-9A-F]{6}$/i
 
         # Return the default color if undef,
-        return 0x00 unless color
+        return 0x00 unless color_code
 
         # or the color string converted to an integer,
-        return colors[color.downcase.to_sym] if colors[color.downcase.to_sym]
+        return colors[color_code.downcase.to_sym] if colors[color_code.downcase.to_sym]
 
         # or the default color if string is unrecognised,
-        return 0x00 if color =~ /\D/
+        return 0x00 if color_code =~ /\D/
       else
         # or an index < 8 mapped into the correct range,
-        return color + 8 if color < 8
+        return color_code + 8 if color_code < 8
 
         # or the default color if arg is outside range,
-        return 0x00 if color > 63
+        return 0x00 if color_code > 63
 
         # or an integer in the valid range
-        return color
+        return color_code
       end
     end
 
@@ -647,9 +647,9 @@ module Writexlsx
       # Check that the attribute exists
       # ........
       if method =~ /set\w+color$/    # for "set_property_color" methods
-        value = get_color(args[0])
+        value = color(args[0])
       else                            # for "set_xxx" methods
-        value = args[0].nil? ? 1 : args[0]
+        value = args[0] || 1
       end
 
       instance_variable_set(attribute, value)
@@ -750,7 +750,7 @@ module Writexlsx
         elsif ptrue?(@color_indexed)
           write_color(writer, 'indexed', @color_indexed)
         elsif ptrue?(@color)
-          color = worksheet.get_palette_color(@color)
+          color = worksheet.palette_color(@color)
           write_color(writer, 'rgb', color)
         elsif !ptrue?(dxf_format)
           write_color(writer, 'theme', 1)
@@ -771,7 +771,7 @@ module Writexlsx
         if ptrue?(theme)
           write_color(writer, 'theme', theme)
         elsif ptrue?(@color)
-          color = worksheet.get_palette_color(@color)
+          color = worksheet.palette_color(@color)
           write_color(writer, 'rgb', color)
         else
           write_color(writer, 'theme', 1)

data/lib/write_xlsx/package/comments.rb

@@ -47,7 +47,7 @@ module Writexlsx
       end
 
       def backgrount_color(color)
-        color_id = Format.get_color(color)
+        color_id = Format.color(color)
 
         if color_id == 0
           @color = '#ffffe1'

data/lib/write_xlsx/package/conditional_format.rb

@@ -247,8 +247,8 @@ module Writexlsx
           @param[:min_color] ||= '#FF7128'
           @param[:max_color] ||= '#FFEF9C'
 
-          @param[:max_color] = get_palette_color( @param[:max_color] )
-          @param[:min_color] = get_palette_color( @param[:min_color] )
+          @param[:max_color] = palette_color( @param[:max_color] )
+          @param[:min_color] = palette_color( @param[:min_color] )
         when '3_color_scale'
           @param[:type] = 'colorScale'
 
@@ -265,9 +265,9 @@ module Writexlsx
           @param[:mid_color] ||= '#FFEB84'
           @param[:max_color] ||= '#63BE7B'
 
-          @param[:max_color] = get_palette_color(@param[:max_color])
-          @param[:mid_color] = get_palette_color(@param[:mid_color])
-          @param[:min_color] = get_palette_color(@param[:min_color])
+          @param[:max_color] = palette_color(@param[:max_color])
+          @param[:mid_color] = palette_color(@param[:mid_color])
+          @param[:min_color] = palette_color(@param[:min_color])
         when 'dataBar'
           # Color scales don't use any additional formatting.
           @param[:format] = nil
@@ -278,12 +278,12 @@ module Writexlsx
           @param[:max_value] ||= 0
           @param[:bar_color] ||= '#638EC6'
 
-          @param[:bar_color] = get_palette_color(@param[:bar_color])
+          @param[:bar_color] = palette_color(@param[:bar_color])
         end
       end
 
-      def get_palette_color(index)
-        @worksheet.get_palette_color(index)
+      def palette_color(index)
+        @worksheet.palette_color(index)
       end
 
       def range_start_cell_for_conditional_formatting(*args)  # :nodoc:

data/lib/write_xlsx/package/relationships.rb

@@ -32,20 +32,14 @@ module Writexlsx
       # Add container relationship to XLSX .rels xml files.
       #
       def add_document_relationship(type, target)
-        type   = Document_schema + type
-        target = target
-
-        @rels.push([type, target])
+        @rels.push([Document_schema + type, target])
       end
 
       #
       # Add container relationship to XLSX .rels xml files.
       #
       def add_package_relationship(type, target)
-        type   = Package_schema + type
-        target = target
-
-        @rels.push([type, target])
+        @rels.push([Package_schema + type, target])
       end
 
       #
@@ -53,19 +47,14 @@ module Writexlsx
       #
       def add_ms_package_relationship(type, target)
         schema = 'http://schemas.microsoft.com/office/2006/relationships'
-        type = schema + type
-
-        @rels.push([type, target])
+        @rels.push([schema + type, target])
       end
 
       #
       # Add worksheet relationship to sheet.rels xml files.
       #
       def add_worksheet_relationship(type, target, target_mode = nil)
-        type   = Document_schema + type
-        target = target
-
-        @rels.push([type, target, target_mode])
+        @rels.push([Document_schema + type, target, target_mode])
       end
 
       private

data/lib/write_xlsx/package/styles.rb

@@ -59,19 +59,12 @@ module Writexlsx
       # Convert from an Excel internal colour index to a XML style #RRGGBB index
       # based on the default or user defined values in the Workbook palette.
       #
-      def get_palette_color(index)
-        palette = @palette
-
-        # Handle colours in #XXXXXX RGB format.
-        return "FF#{$1.upcase}" if index =~ /^#([0-9A-F]{6})$/i
-
-        # Adjust the colour index.
-        index -= 8
-
-        # Palette is passed in from the Workbook class.
-        rgb = @palette[index]
-
-        sprintf("FF%02X%02X%02X", *rgb[0, 3])
+      def palette_color(index)
+      if index =~ /^#([0-9A-F]{6})$/i
+        "FF#{$1.upcase}"
+      else
+        "FF#{super(index)}"
+      end
       end
 
       #
@@ -261,12 +254,12 @@ module Writexlsx
 
           @writer.tag_elements('patternFill', attributes) do
             if fg_color && fg_color != 0
-              fg_color = get_palette_color(fg_color)
+              fg_color = palette_color(fg_color)
               @writer.empty_tag('fgColor', [ ['rgb', fg_color] ])
             end
 
             if bg_color && bg_color != 0
-              bg_color = get_palette_color(bg_color)
+              bg_color = palette_color(bg_color)
               @writer.empty_tag('bgColor', [ ['rgb', bg_color] ])
             else
               @writer.empty_tag('bgColor', [ ['indexed', 64] ]) if !dxf_format
@@ -364,7 +357,7 @@ module Writexlsx
 
         @writer.tag_elements(type, attributes) do
           if color != 0
-            color = get_palette_color(color)
+            color = palette_color(color)
             @writer.empty_tag('color', [ ['rgb', color] ])
           else
             @writer.empty_tag('color', [ ['auto', 1] ])

data/lib/write_xlsx/shape.rb

@@ -11,6 +11,7 @@ module Writexlsx
   # Converted to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
   #
   class Shape
+    include Writexlsx::Utility
 
     attr_reader :edit_as, :type, :drawing
     attr_reader :tx_box, :fill, :line, :format
@@ -145,21 +146,6 @@ module Writexlsx
       @adjustments = *args
     end
 
-    #
-    # Convert from an Excel internal colour index to a XML style #RRGGBB index
-    # based on the default or user defined values in the Workbook palette.
-    # Note: This version doesn't add an alpha channel.
-    #
-    def get_palette_color(index)
-      # Adjust the colour index.
-      idx = index - 8
-
-      # Palette is passed in from the Workbook class.
-      rgb = @palette[idx]
-
-      sprintf("%02X%02X%02X", *rgb)
-    end
-
     #
     # Calculate the vertices that define the position of a shape object within
     # the worksheet in EMUs.  Save the vertices with the object.

data/lib/write_xlsx/sparkline.rb

@@ -100,7 +100,7 @@ module Writexlsx
 
       # Override the style colours with user defined colors.
       [:series_color, :negative_color, :markers_color, :first_color, :last_color, :high_color, :low_color].each do |user_color|
-        set_spark_color(user_color, ptrue?(param[user_color]) ? ws.get_palette_color(param[user_color]) : nil)
+        set_spark_color(user_color, ptrue?(param[user_color]) ? ws.palette_color(param[user_color]) : nil)
       end
     end
 

data/lib/write_xlsx/utility.rb

@@ -344,6 +344,29 @@ module Writexlsx
       end
     end
 
+    #
+    # Convert user defined layout properties to the format required internally.
+    #
+    def layout_properties(args, is_text = false)
+      return unless ptrue?(args)
+
+      properties = is_text ? [:x, :y] : [:x, :y, :width, :height]
+
+      # Check for valid properties.
+      allowable = Hash.new
+      allowable[properties.size] = nil
+
+      # Set the layout properties
+      layout = Hash.new
+      properties.each do |property|
+        value = args[property]
+        # Convert to the format used by Excel for easier testing.
+        layout[property] = sprintf("%.17g", value)
+      end
+
+      layout
+    end
+
     #
     # Convert vertices from pixels to points.
     #
@@ -488,9 +511,28 @@ module Writexlsx
     # Convert user defined line properties to the structure required internally.
     #
     def line_properties(line) # :nodoc:
-      return { :_defined => 0 } unless line
+      line_fill_properties(line) do
+        value_or_raise(dash_types, line[:dash_type], 'dash type')
+      end
+    end
+
+    #
+    # Convert user defined fill properties to the structure required internally.
+    #
+    def fill_properties(fill) # :nodoc:
+      line_fill_properties(fill)
+    end
 
-      dash_types = {
+    def line_fill_properties(params)
+      return { :_defined => 0 } unless params
+      ret = params.dup
+      ret[:dash_type] = yield if block_given? && ret[:dash_type]
+      ret[:_defined] = 1
+      ret
+    end
+
+    def dash_types
+      {
         :solid               => 'solid',
         :round_dot           => 'sysDot',
         :square_dot          => 'sysDash',
@@ -503,22 +545,36 @@ module Writexlsx
         :system_dash_dot     => 'sysDashDot',
         :system_dash_dot_dot => 'sysDashDotDot'
       }
-
-      # Check the dash type.
-      dash_type = line[:dash_type]
-
-      if dash_type
-        line[:dash_type] = value_or_raise(dash_types, dash_type, 'dash type')
-      end
-
-      line[:_defined] = 1
-
-      line
     end
 
     def value_or_raise(hash, key, msg)
       raise "Unknown #{msg} '#{key}'" unless hash[key.to_sym]
       hash[key.to_sym]
     end
+
+    def palette_color(index)
+      # Adjust the colour index.
+      idx = index - 8
+
+      rgb = @palette[idx]
+      sprintf("%02X%02X%02X", *rgb)
+    end
+  end
+
+  module WriteDPtPoint
+      #
+      # Write an individual <c:dPt> element. Override the parent method to add
+      # markers.
+      #
+      def write_d_pt_point(index, point)
+        @writer.tag_elements('c:dPt') do
+          # Write the c:idx element.
+          write_idx(index)
+          @writer.tag_elements('c:marker') do
+            # Write the c:spPr element.
+            write_sp_pr(point)
+          end
+        end
+      end
   end
 end

data/lib/write_xlsx/version.rb

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

data/lib/write_xlsx/workbook.rb

@@ -9,10 +9,11 @@ require 'write_xlsx/format'
 require 'write_xlsx/shape'
 require 'write_xlsx/utility'
 require 'write_xlsx/chart'
+ruby_18 { require 'write_xlsx/zip_file_utils' }
+ruby_19 { require 'zip' }
 require 'tmpdir'
 require 'tempfile'
 require 'digest/md5'
-require 'zip'
 
 module Writexlsx
 
@@ -873,7 +874,7 @@ module Writexlsx
     #
     def set_custom_color(index, red = 0, green = 0, blue = 0)
       # Match a HTML #xxyyzz style parameter
-      if !red.nil? && red =~ /^#(\w\w)(\w\w)(\w\w)/
+      if red =~ /^#(\w\w)(\w\w)(\w\w)/
         red   = $1.hex
         green = $2.hex
         blue  = $3.hex
@@ -1164,7 +1165,7 @@ module Writexlsx
     end
 
     def write_defined_names #:nodoc:
-      return if @defined_names.nil? || @defined_names.empty?
+      return unless ptrue?(@defined_names)
       @writer.tag_elements('definedNames') do
         @defined_names.each { |defined_name| write_defined_name(defined_name) }
       end
@@ -1232,10 +1233,13 @@ module Writexlsx
       packager = nil
 
       # Store the xlsx component files with the temp dir name removed.
-      # See https://github.com/randym/axlsx
-      Zip::OutputStream.open(@filename) do |zip|
-        write_parts(zip)
-      end
+      ruby_19 do
+        # See https://github.com/randym/axlsx
+        Zip::OutputStream.open(@filename) do |zip|
+          write_parts(zip)
+        end
+      end ||
+      ruby_18 { ZipFileUtils.zip("#{@tempdir}", @filename) }
 
       IO.copy_stream(@filename, @fileobj) if @fileobj
       Writexlsx::Utility.delete_files(@tempdir)
@@ -1563,6 +1567,14 @@ module Writexlsx
           # Skip if we couldn't parse the formula.
           next unless sheetname
 
+          # Handle non-contiguous ranges: (Sheet1!$A$1:$A$2,Sheet1!$A$4:$A$5).
+          # We don't try to parse the ranges. We just return an empty list.
+          if sheetname =~ /^\([^,]+,/
+            chart.formula_data[id] = []
+            seen_ranges[range] = []
+            next
+          end
+
           # Raise if the name is unknown since it indicates a user error in
           # a chart series formula.
           unless worksheets[sheetname]

data/lib/write_xlsx/worksheet/cell_data.rb

@@ -117,7 +117,7 @@ module Writexlsx
     end
 
     class BlankCellData < CellData # :nodoc:
-      def initialize(worksheet, row, col, index, xf)
+      def initialize(worksheet, row, col, xf)
         @worksheet = worksheet
         @row, @col, @xf = row, col, xf
       end