write_xlsx 0.89.0 → 1.01.0

data/lib/write_xlsx/sheets.rb

@@ -230,10 +230,20 @@ def check_valid_sheetname(name)
         raise 'Invalid character []:*?/\\ in worksheet name: ' + name
       end
 
+      # Check that sheetname doesn't start or end with an apostrophe.
+      if name =~ /^'/ || name =~ /'$/
+        raise "Worksheet name #{name} cannot start or end with an "
+      end
+
+      # Check that sheetname isn't a reserved word.
+      if name =~ /history/i
+        raise "Worksheet name cannot be Excel reserved word 'History'"
+      end
+
       # Check that the worksheet name doesn't already exist since this is a fatal
       # error in Excel 97. The check must also exclude case insensitive matches.
       unless is_sheetname_uniq?(name)
-        raise "Worksheet name '#{name}', with case ignored, is already used."
+        raise "apostropheWorksheet name '#{name}', with case ignored, is already used."
       end
     end
 

data/lib/write_xlsx/sparkline.rb

@@ -9,7 +9,7 @@ module Writexlsx
   # Used in conjunction with WriteXLSX.
   #
   # Copyright 2000-2012, John McNamara, jmcnamara@cpan.org
-  # Converted to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+  # Converted to ruby by Hideo NAKAMURA, nakamura.hideo@gmail.com
   #
   class Sparkline
     include Writexlsx::Utility

data/lib/write_xlsx/utility.rb

@@ -119,7 +119,7 @@ def check_dimensions(row, col)
     #            nil if the date is invalid.
     #
     def convert_date_time(date_time_string)       #:nodoc:
-      date_time = date_time_string.sub(/^\s+/, '').sub(/\s+$/, '').sub(/Z$/, '')
+      date_time = date_time_string.to_s.sub(/^\s+/, '').sub(/\s+$/, '').sub(/Z$/, '')
 
       # Check for invalid date char.
       return nil if date_time =~ /[^0-9T:\-\.Z]/
@@ -320,7 +320,7 @@ def check_parameter(params, valid_keys, method)
       invalids = params.keys - valid_keys
       unless invalids.empty?
         raise WriteXLSXOptionParameterError,
-          "Unknown parameter '#{invalids.join(', ')}' in #{method}."
+              "Unknown parameter '#{invalids.join(', ')}' in #{method}."
       end
       true
     end
@@ -361,6 +361,64 @@ def float_to_str(float)
       end
     end
 
+    #
+    # Convert user defined legend properties to the structure required internally.
+    #
+    def legend_properties(params)
+      legend = Writexlsx::Chart::Legend.new
+
+      legend.position      = params[:position] || 'right'
+      legend.delete_series = params[:delete_series]
+      legend.font          = convert_font_args(params[:font])
+
+      # Set the legend layout.
+      legend.layout = layout_properties(params[:layout])
+
+      # Turn off the legend.
+      if params[:none]
+        legend.position = 'none'
+      end
+
+      # Set the line properties for the legend.
+      line = line_properties(params[:line])
+
+      # Allow 'border' as a synonym for 'line'.
+      if params[:border]
+        line = line_properties(params[:border])
+      end
+
+      # Set the fill properties for the legend.
+      fill = fill_properties(params[:fill])
+
+      # Set the pattern properties for the legend.
+      pattern = pattern_properties(params[:pattern])
+
+      # Set the gradient fill properties for the legend.
+      gradient = gradient_properties(params[:gradient])
+
+      # Pattern fill overrides solid fill.
+      if pattern
+        fill = nil
+      end
+
+      # Gradient fill overrides solid and pattern fills.
+      if gradient
+        pattern = nil
+        fill    = nil
+      end
+
+      # Set the legend layout.
+      layout = layout_properties(params[:layout])
+
+      legend.line     = line
+      legend.fill     = fill
+      legend.pattern  = pattern
+      legend.gradient = gradient
+      legend.layout   = layout
+
+      @legend = legend
+    end
+
     #
     # Convert user defined layout properties to the format required internally.
     #
@@ -372,7 +430,7 @@ def layout_properties(args, is_text = false)
       # Check for valid properties.
       args.keys.each do |key|
         unless properties.include?(key.to_sym)
-            raise "Property '#{key}' not allowed in layout options\n"
+          raise "Property '#{key}' not allowed in layout options\n"
         end
       end
 
@@ -405,9 +463,9 @@ def pixels_to_points(vertices)
 
     def v_shape_attributes_base(id, z_index)
       [
-       ['id',          "_x0000_s#{id}"],
-       ['type',        type],
-       ['style',       (v_shape_style_base(z_index, vertices) + style_addition).join]
+        ['id',          "_x0000_s#{id}"],
+        ['type',        type],
+        ['style',       (v_shape_style_base(z_index, vertices) + style_addition).join]
       ]
     end
 
@@ -425,17 +483,17 @@ def v_shape_style_base(z_index, vertices)
 
     def shape_style_base(left_str, top_str, width_str, height_str, z_index_str)
       [
-       'position:absolute;',
-       'margin-left:',
-       left_str, 'pt;',
-       'margin-top:',
-       top_str, 'pt;',
-       'width:',
-       width_str, 'pt;',
-       'height:',
-       height_str, 'pt;',
-       'z-index:',
-       z_index_str, ';'
+        'position:absolute;',
+        'margin-left:',
+        left_str, 'pt;',
+        'margin-top:',
+        top_str, 'pt;',
+        'width:',
+        width_str, 'pt;',
+        'height:',
+        height_str, 'pt;',
+        'z-index:',
+        z_index_str, ';'
       ]
     end
 
@@ -500,10 +558,10 @@ def write_font(font)
       color   = '#000000'
 
       attributes = [
-                    ['face',  face],
-                    ['size',  size],
-                    ['color', color]
-                   ]
+        ['face',  face],
+        ['size',  size],
+        ['color', color]
+      ]
       @writer.data_element('font', caption, attributes)
     end
 
@@ -612,7 +670,7 @@ def pattern_properties(args) # :nodoc:
         'small_check'               => 'smCheck',
         'large_check'               => 'lgCheck',
         'outlined_diamond'          => 'openDmnd',
-        'solid_diamond'             => 'solidDmnd'        
+        'solid_diamond'             => 'solidDmnd'
       }
 
       # Check for valid types.
@@ -627,7 +685,7 @@ def pattern_properties(args) # :nodoc:
 
       pattern
     end
-    
+
     def line_fill_properties(params)
       return { :_defined => 0 } unless params
       ret = params.dup
@@ -690,22 +748,234 @@ def process_workbook_options(*params)
         [options.dup, default_format_properties.dup]
       end
     end
+
+    #
+    # Convert user defined font values into private hash values.
+    #
+    def convert_font_args(params)
+      return unless params
+      font = params_to_font(params)
+
+      # Convert font size units.
+      font[:_size] *= 100 if font[:_size] && font[:_size] != 0
+
+      # Convert rotation into 60,000ths of a degree.
+      if ptrue?(font[:_rotation])
+        font[:_rotation] = 60_000 * font[:_rotation].to_i
+      end
+
+      font
+    end
+
+    def params_to_font(params)
+      {
+        :_name         => params[:name],
+        :_color        => params[:color],
+        :_size         => params[:size],
+        :_bold         => params[:bold],
+        :_italic       => params[:italic],
+        :_underline    => params[:underline],
+        :_pitch_family => params[:pitch_family],
+        :_charset      => params[:charset],
+        :_baseline     => params[:baseline] || 0,
+        :_rotation     => params[:rotation]
+      }
+    end
+
+    #
+    # Write the <c:txPr> element.
+    #
+    def write_tx_pr(is_y_axis, font) # :nodoc:
+      rotation = nil
+      if font && font[:_rotation]
+        rotation = font[:_rotation]
+      end
+      @writer.tag_elements('c:txPr') do
+        # Write the a:bodyPr element.
+        write_a_body_pr(rotation, is_y_axis)
+        # Write the a:lstStyle element.
+        write_a_lst_style
+        # Write the a:p element.
+        write_a_p_formula(font)
+      end
+    end
+
+    #
+    # Write the <a:bodyPr> element.
+    #
+    def write_a_body_pr(rot, is_y_axis = nil) # :nodoc:
+      rot = -5400000 if !rot && ptrue?(is_y_axis)
+      attributes = []
+      if rot
+        if rot == 16_200_000
+          # 270 deg/stacked angle.
+          attributes << ['rot',  0]
+          attributes << ['vert', 'wordArtVert']
+        elsif rot == 16_260_000
+          # 271 deg/stacked angle.
+          attributes << ['rot',  0]
+          attributes << ['vert', 'eaVert']
+        else
+          attributes << ['rot',  rot]
+          attributes << ['vert', 'horz']
+        end
+      end
+
+      @writer.empty_tag('a:bodyPr', attributes)
+    end
+
+    #
+    # Write the <a:lstStyle> element.
+    #
+    def write_a_lst_style # :nodoc:
+      @writer.empty_tag('a:lstStyle')
+    end
+
+    #
+    # Write the <a:p> element for formula titles.
+    #
+    def write_a_p_formula(font = nil) # :nodoc:
+      @writer.tag_elements('a:p') do
+        # Write the a:pPr element.
+        write_a_p_pr_formula(font)
+        # Write the a:endParaRPr element.
+        write_a_end_para_rpr
+      end
+    end
+
+    #
+    # Write the <a:pPr> element for formula titles.
+    #
+    def write_a_p_pr_formula(font) # :nodoc:
+      @writer.tag_elements('a:pPr') { write_a_def_rpr(font) }
+    end
+
+    #
+    # Write the <a:defRPr> element.
+    #
+    def write_a_def_rpr(font = nil) # :nodoc:
+      write_def_rpr_r_pr_common(
+        font,
+        get_font_style_attributes(font),
+        'a:defRPr'
+      )
+    end
+
+    def write_def_rpr_r_pr_common(font, style_attributes, tag)  # :nodoc:
+      latin_attributes = get_font_latin_attributes(font)
+      has_color = ptrue?(font) && ptrue?(font[:_color])
+
+      if !latin_attributes.empty? || has_color
+        @writer.tag_elements(tag, style_attributes) do
+          if has_color
+            write_a_solid_fill(:color => font[:_color])
+          end
+          if !latin_attributes.empty?
+            write_a_latin(latin_attributes)
+          end
+        end
+      else
+        @writer.empty_tag(tag, style_attributes)
+      end
+    end
+
+    #
+    # Get the font latin attributes from a font hash.
+    #
+    def get_font_latin_attributes(font)
+      return [] unless font
+
+      attributes = []
+      attributes << ['typeface', font[:_name]]            if ptrue?(font[:_name])
+      attributes << ['pitchFamily', font[:_pitch_family]] if font[:_pitch_family]
+      attributes << ['charset', font[:_charset]]          if font[:_charset]
+
+      attributes
+    end
+
+    #
+    # Write the <a:solidFill> element.
+    #
+    def write_a_solid_fill(fill) # :nodoc:
+      @writer.tag_elements('a:solidFill') do
+        if fill[:color]
+          # Write the a:srgbClr element.
+          write_a_srgb_clr(color(fill[:color]), fill[:transparency])
+        end
+      end
+    end
+
+    #
+    # Write the <a:srgbClr> element.
+    #
+    def write_a_srgb_clr(color, transparency = nil) # :nodoc:
+      tag        = 'a:srgbClr'
+      attributes = [ ['val', color] ]
+
+      if ptrue?(transparency)
+        @writer.tag_elements(tag, attributes) do
+          write_a_alpha(transparency)
+        end
+      else
+        @writer.empty_tag(tag, attributes)
+      end
+     end
+
+    #
+    # Convert the user specified colour index or string to a rgb colour.
+    #
+    def color(color_code) # :nodoc:
+      if color_code and color_code =~ /^#[0-9a-fA-F]{6}$/
+        # Convert a HTML style #RRGGBB color.
+        color_code.sub(/^#/, '').upcase
+      else
+        index = Format.color(color_code)
+        raise "Unknown color '#{color_code}' used in chart formatting." unless index
+        palette_color(index)
+      end
+    end
+
+    #
+    # Get the font style attributes from a font hash.
+    #
+    def get_font_style_attributes(font)
+      return [] unless font
+
+      attributes = []
+      attributes << ['sz', font[:_size]]      if ptrue?(font[:_size])
+      attributes << ['b',  font[:_bold]]      if font[:_bold]
+      attributes << ['i',  font[:_italic]]    if font[:_italic]
+      attributes << ['u',  'sng']             if font[:_underline]
+
+      # Turn off baseline when testing fonts that don't have it.
+      if font[:_baseline] != -1
+        attributes << ['baseline', font[:_baseline]]
+      end
+      attributes
+    end
+
+    #
+    # Write the <a:endParaRPr> element.
+    #
+    def write_a_end_para_rpr # :nodoc:
+      @writer.empty_tag('a:endParaRPr', [ ['lang', 'en-US'] ])
+    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
+    #
+    # 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 +1 @@
-WriteXLSX_VERSION = "0.89.0"
+WriteXLSX_VERSION = "1.01.0"

data/lib/write_xlsx/workbook.rb

@@ -44,11 +44,14 @@ class Workbook
     attr_reader :worksheets, :charts, :drawings  # :nodoc:
     attr_reader :named_ranges   # :nodoc:
     attr_reader :doc_properties  # :nodoc:
+    attr_reader :custom_properties # :nodoc:
     attr_reader :image_types, :images  # :nodoc:
     attr_reader :shared_strings  # :nodoc:
     attr_reader :vba_project  # :nodoc:
     attr_reader :excel2003_style # :nodoc:
     attr_reader :strings_to_urls # :nodoc:
+    attr_reader :default_url_format # :nodoc:
+
     #
     # A new Excel workbook is created using the +new+ constructor
     # which accepts either a filename or an IO object as a parameter.
@@ -114,13 +117,13 @@ def initialize(file, *option_params)
       @named_ranges        = []
       @custom_colors       = []
       @doc_properties      = {}
-      @local_time          = Time.now
+      @custom_properties   = []
       @optimization        = options[:optimization] || 0
       @x_window            = 240
       @y_window            = 15
       @window_width        = 16095
       @window_height       = 9660
-      @tab_ratio           = 500
+      @tab_ratio           = 600
       @excel2003_style     = options[:excel2003_style] || false
       @table_count         = 0
       @image_types         = {}
@@ -141,6 +144,10 @@ def initialize(file, *option_params)
       else
         add_format(default_formats.merge(:xf_index => 0))
       end
+
+      # Add a default URL format.
+      @default_url_format = add_format(:hyperlink => 1)
+
       set_color_palette
     end
 
@@ -203,6 +210,14 @@ def sheets(*args)
       end
     end
 
+    #
+    # Return a worksheet object in the workbook using the sheetname.
+    #
+    def worksheet_by_name(sheetname = nil)
+      sheets.select { |s| s.name == sheetname }.first
+    end
+    alias get_worksheet_by_name worksheet_by_name
+
     #
     # Set the date system: false = 1900 (the default), true = 1904
     #
@@ -750,6 +765,38 @@ def define_name(name, formula)
       @defined_names.push([ name, sheet_index, formula.sub(/^=/, '') ])
     end
 
+    #
+    # Set the workbook size.
+    #
+    def set_size(width = nil, height = nil)
+      if ptrue?(width)
+        # Convert to twips at 96 dpi.
+        @window_width = width.to_i * 1440 / 96
+      else
+        @window_width = 16095
+      end
+
+      if ptrue?(height)
+        # Convert to twips at 96 dpi.
+        @window_height = height.to_i * 1440 / 96
+      else
+        @window_height = 9660
+      end
+    end
+
+    #
+    # Set the ratio of space for worksheet tabs.
+    #
+    def set_tab_ratio(tab_ratio = nil)
+      return if !tab_ratio
+
+      if tab_ratio < 0 || tab_ratio > 100
+        raise "Tab ratio outside range: 0 <= zoom <= 100"
+      else
+        @tab_ratio = (tab_ratio * 10).to_i
+      end
+    end
+
     #
     # The set_properties method can be used to set the document properties
     # of the Excel file created by WriteXLSX. These properties are visible
@@ -806,11 +853,58 @@ def set_properties(params)
       end
 
       # Set the creation time unless specified by the user.
-      params[:created] = @local_time unless params.has_key?(:created)
+      params[:created] = @createtime unless params.has_key?(:created)
 
       @doc_properties = params.dup
     end
 
+    #
+    # Set a user defined custom document property.
+    #
+    def set_custom_property(name, value, type = nil)
+    # Valid types.
+      valid_type = {
+        'text'       => 1,
+        'date'       => 1,
+        'number'     => 1,
+        'number_int' => 1,
+        'bool'       => 1,
+      }
+
+      if !name || (type != 'bool' && !value)
+        raise "The name and value parameters must be defined in set_custom_property()"
+      end
+
+      # Determine the type for strings and numbers if it hasn't been specified.
+      if !ptrue?(type)
+        if value =~ /^\d+$/
+            type = 'number_int'
+        elsif value =~
+            /^([+-]?)(?=[0-9]|\.[0-9])[0-9]*(\.[0-9]*)?([Ee]([+-]?[0-9]+))?$/
+          type = 'number'
+        else
+          type = 'text'
+        end
+      end
+
+      # Check for valid validation types.
+      if !valid_type[type]
+        raise "Unknown custom type '$type' in set_custom_property()"
+      end
+
+      #  Check for strings longer than Excel's limit of 255 chars.
+      if type == 'text' && value.length > 255
+        raise "Length of text custom value '$value' exceeds Excel's limit of 255 in set_custom_property()"
+      end
+
+      if type == 'bool'
+        value = value ? 1 : 0
+      end
+
+      @custom_properties << [name, value, type]
+    end
+
+
     #
     # The add_vba_project method can be used to add macros or functions to an
     # WriteXLSX file using a binary VBA project file that has been extracted
@@ -869,6 +963,16 @@ def set_calc_mode(mode, calc_id = nil)
       @calc_id = calc_id if calc_id
     end
 
+    #
+    # Get the default url format used when a user defined format isn't specified
+    # with write_url(). The format is the hyperlink style defined by Excel for the
+    # default theme.
+    #
+    def default_url_format
+      @default_url_format
+    end
+    alias get_default_url_format default_url_format
+
     #
     # Change the RGB components of the elements in the colour palette.
     #
@@ -1217,7 +1321,7 @@ def write_workbook_view #:nodoc:
                     ['windowWidth',   @window_width],
                     ['windowHeight',  @window_height]
                    ]
-      if @tab_ratio != 500
+      if @tab_ratio != 600
         attributes << ['tabRatio', @tab_ratio]
       end
       if @firstsheet > 0
@@ -1421,9 +1525,17 @@ def prepare_num_formats #:nodoc:
         # string but would evaluate to zero.
         #
         if num_format.to_s =~ /^\d+$/ && num_format.to_s !~ /^0+\d/
+          # Number format '0' is indexed as 1 in Excel.
+          if num_format == 0
+            num_format = 1
+          end
           # Index to a built-in number format.
           format.num_format_index = num_format
           next
+        elsif num_format.to_s == 'General'
+          # The 'General' format has an number format index of 0.
+          format.num_format_index = 0
+          next
         end
 
         if num_formats[num_format]
@@ -1812,7 +1924,7 @@ def prepare_drawings #:nodoc:
         shape_count = sheet.shapes.size
         header_image_count = sheet.header_images.size
         footer_image_count = sheet.footer_images.size
-        has_drawing = false
+        has_drawings = false
 
         # 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
@@ -1820,7 +1932,7 @@ def prepare_drawings #:nodoc:
         # Don't increase the drawing_id header/footer images.
         if chart_count + image_count + shape_count > 0
           drawing_id += 1
-          has_drawing = true
+          has_drawings = true
         end
 
         # Prepare the worksheet charts.
@@ -1869,9 +1981,9 @@ def prepare_drawings #:nodoc:
                                      name, type, position, x_dpi, y_dpi)
         end
 
-        if has_drawing
-          drawing = sheet.drawing
-          @drawings << drawing
+        if has_drawings
+          drawings = sheet.drawings
+          @drawings << drawings
         end
       end
 
@@ -1914,6 +2026,10 @@ def get_image_properties(filename)
 
       @images << [filename, type]
 
+      # Set a default dpi for images with 0 dpi.
+      x_dpi = 96 if x_dpi == 0
+      y_dpi = 96 if y_dpi == 0
+
       [type, width, height, File.basename(filename), x_dpi, y_dpi]
     end
 
@@ -1969,16 +2085,20 @@ def process_jpg(data, filename)
       offset = 2
       data_length = data.bytesize
 
-      # Search through the image data to read the height and width in the
-      # 0xFFC0/C2 element. Also read the DPI in the 0xFFE0 element.
+      # Search through the image data to read the JPEG markers.
       while offset < data_length
         marker  = data[offset+0, 2].unpack("n")[0]
         length  = data[offset+2, 2].unpack("n")[0]
 
-        if marker == 0xFFC0 || marker == 0xFFC2
+        # Read the height and width in the 0xFFCn elements
+        # (Except C4, C8 and CC which aren't SOF markers).
+        if (marker & 0xFFF0) == 0xFFC0 &&
+           marker != 0xFFC4 && marker != 0xFFCC
           height = data[offset+5, 2].unpack("n")[0]
           width  = data[offset+7, 2].unpack("n")[0]
         end
+
+        # Read the DPI in the 0xFFE0 element.
         if marker == 0xFFE0
           units     = data[offset + 11, 1].unpack("C")[0]
           x_density = data[offset + 12, 2].unpack("n")[0]